Improve Checkstyle Performance (Azure#26266)

alzimmermsft · web-flow · commit 8c56c203ca87 · 2022-01-04T13:42:18.000-08:00
Improve Checkstyle Performance
diff --git a/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml b/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml
diff --git a/sdk/anomalydetector/azure-ai-anomalydetector/pom.xml b/sdk/anomalydetector/azure-ai-anomalydetector/pom.xml
@@ -32,6 +32,8 @@
   <properties>
     <!-- Anomaly detector temporarily skipping code coverage until tests are added -->
     <jacoco.skip>true</jacoco.skip>
+    <!-- TODO: (https://github.com/Azure/azure-sdk-for-java/issues/18279) -->
+    <checkstyle.skip>true</checkstyle.skip>
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
diff --git a/sdk/appconfiguration/azure-spring-cloud-feature-management-web/pom.xml b/sdk/appconfiguration/azure-spring-cloud-feature-management-web/pom.xml
@@ -16,6 +16,7 @@
   <description>Adds Feature Management into Spring Web</description>
 
   <properties>
+    <checkstyle.skip>true</checkstyle.skip>
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
diff --git a/sdk/appconfiguration/azure-spring-cloud-feature-management/pom.xml b/sdk/appconfiguration/azure-spring-cloud-feature-management/pom.xml
@@ -16,6 +16,7 @@
   <description>Adds Feature Management into Spring</description>
 
   <properties>
+    <checkstyle.skip>true</checkstyle.skip>
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
diff --git a/sdk/core/azure-core-serializer-avro-apache/pom.xml b/sdk/core/azure-core-serializer-avro-apache/pom.xml
@@ -52,6 +52,7 @@
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
+    <checkstyle.excludes>**/generatedtestsources/**/*.java</checkstyle.excludes>
   </properties>
 
   <developers>
diff --git a/sdk/core/azure-core-serializer-avro-jackson/pom.xml b/sdk/core/azure-core-serializer-avro-jackson/pom.xml
@@ -49,6 +49,7 @@
       --add-exports com.azure.core.serializer.avro.jackson/com.azure.core.serializer.avro.jackson.generatedtestsources=com.fasterxml.jackson.databind
       --add-opens com.azure.core.serializer.avro.jackson/com.azure.core.serializer.avro.jackson=ALL-UNNAMED
     </javaModulesSurefireArgLine>
+    <checkstyle.excludes>**/generatedtestsources/**/*.java</checkstyle.excludes>
   </properties>
 
   <developers>
diff --git a/sdk/cosmos/azure-cosmos/pom.xml b/sdk/cosmos/azure-cosmos/pom.xml
@@ -56,6 +56,12 @@ Licensed under the MIT License.
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
+
+    <!-- Prevents Checkstyle validating implementation files. -->
+    <checkstyle.excludes>**/implementation/**/*.java</checkstyle.excludes>
+
+    <!-- Prevents Checkstyle validating test source files. -->
+    <checkstyle.includeTestSourceDirectory>false</checkstyle.includeTestSourceDirectory>
   </properties>
 
   <dependencies>
diff --git a/sdk/deviceupdate/azure-iot-deviceupdate/pom.xml b/sdk/deviceupdate/azure-iot-deviceupdate/pom.xml
@@ -28,6 +28,8 @@
   </scm>
 
   <properties>
+    <!-- TODO: (https://github.com/Azure/azure-sdk-for-java/issues/18279) -->
+    <checkstyle.skip>true</checkstyle.skip>
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
diff --git a/sdk/digitaltwins/azure-digitaltwins-core/pom.xml b/sdk/digitaltwins/azure-digitaltwins-core/pom.xml
@@ -42,6 +42,9 @@
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
+
+    <!-- TODO: (https://github.com/Azure/azure-sdk-for-java/issues/18279) -->
+    <checkstyle.excludes>**/implementation/**/*.java</checkstyle.excludes>
   </properties>
 
   <dependencies>
diff --git a/sdk/monitor/azure-monitor-opentelemetry-exporter/pom.xml b/sdk/monitor/azure-monitor-opentelemetry-exporter/pom.xml
@@ -40,6 +40,7 @@
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
+    <checkstyle.excludes>**/implementation/**/*.java</checkstyle.excludes>
   </properties>
 
   <dependencies>
diff --git a/sdk/monitor/azure-monitor-query/pom.xml b/sdk/monitor/azure-monitor-query/pom.xml
@@ -35,6 +35,7 @@
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
+    <checkstyle.excludes>**/implementation/**/*.java</checkstyle.excludes>
   </properties>
   <dependencies>
     <dependency>
diff --git a/sdk/parents/azure-client-sdk-parent/pom.xml b/sdk/parents/azure-client-sdk-parent/pom.xml
@@ -153,6 +153,12 @@
     <checkstyle.failOnViolation>true</checkstyle.failOnViolation>
     <checkstyle.failsOnError>true</checkstyle.failsOnError>
 
+    <!-- This property configures a regex of source files to exclude from Checkstyle. -->
+    <checkstyle.excludes></checkstyle.excludes>
+
+    <!-- This property configures whether test source files are included in Checkstyle. Default is true. -->
+    <checkstyle.includeTestSourceDirectory>true</checkstyle.includeTestSourceDirectory>
+
     <!-- The following properties configure the spotbugs-maven-plugin. -->
     <!-- This property configures whether the spotbugs-maven-plugin should be used. -->
     <spotbugs.skip>false</spotbugs.skip>
@@ -550,10 +556,11 @@
             <configLocation>${project.basedir}/${relative.path.to.eng.folder}/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle.xml</configLocation>
             <suppressionsLocation>${project.basedir}/${relative.path.to.eng.folder}/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml</suppressionsLocation>
             <headerLocation>${project.basedir}/${relative.path.to.eng.folder}/eng/code-quality-reports/src/main/resources/checkstyle/java.header</headerLocation>
+            <excludes>${checkstyle.excludes}</excludes>
             <propertyExpansion>samedir=</propertyExpansion>
             <encoding>UTF-8</encoding>
             <consoleOutput>true</consoleOutput>
-            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <includeTestSourceDirectory>${checkstyle.includeTestSourceDirectory}</includeTestSourceDirectory>
             <linkXRef>true</linkXRef>
             <failsOnError>${checkstyle.failsOnError}</failsOnError>
             <failOnViolation>${checkstyle.failOnViolation}</failOnViolation>
diff --git a/sdk/quantum/azure-quantum-jobs/pom.xml b/sdk/quantum/azure-quantum-jobs/pom.xml
@@ -33,8 +33,9 @@
   </scm>
 
    <properties>
-    <!-- require minimal code coverage until tests are added -->
-    <jacoco.min.linecoverage>0.10</jacoco.min.linecoverage>
+     <!-- require minimal code coverage until tests are added -->
+     <jacoco.min.linecoverage>0.10</jacoco.min.linecoverage>
+     <checkstyle.skip>true</checkstyle.skip>
      <codesnippet.skip>false</codesnippet.skip>
      <javadocDoclet></javadocDoclet>
      <javadocDocletOptions></javadocDocletOptions>
diff --git a/sdk/schemaregistry/azure-data-schemaregistry/pom.xml b/sdk/schemaregistry/azure-data-schemaregistry/pom.xml
@@ -44,6 +44,7 @@
     <codesnippet.skip>false</codesnippet.skip>
     <javadocDoclet></javadocDoclet>
     <javadocDocletOptions></javadocDocletOptions>
+    <checkstyle.excludes>**/implementation/**/*.java</checkstyle.excludes>
   </properties>
 
   <dependencies>
