Split checkStyle from precommit into spotless job (#22203)

apache · Jul 11, 2022 · 3d8db78 · 3d8db78
1 parent 262f2b7
commit 3d8db78
Show file tree

Hide file tree

Showing 20 changed files with 50 additions and 27 deletions.
diff --git a/.test-infra/jenkins/job_PostCommit_Java_Examples_Dataflow_V2_Java11.groovy b/.test-infra/jenkins/job_PostCommit_Java_Examples_Dataflow_V2_Java11.groovy
@@ -42,6 +42,7 @@ PostcommitJobBuilder.postCommitJob('beam_PostCommit_Java_Examples_Dataflow_V2_ja
           // overloading the machines.
           commonJobProperties.setGradleSwitches(delegate, 3 * Runtime.runtime.availableProcessors())
           switches '-PdisableSpotlessCheck=true'
+          switches '-PdisableCheckStyle=true'
           switches '-PcompileAndRunTestsWithJava11'
           switches '-PskipCheckerFramework'
           switches "-Pjava11Home=${commonJobProperties.JAVA_11_HOME}"

diff --git a/.test-infra/jenkins/job_PostCommit_Java_Examples_Dataflow_V2_Java17.groovy b/.test-infra/jenkins/job_PostCommit_Java_Examples_Dataflow_V2_Java17.groovy
@@ -42,6 +42,7 @@ PostcommitJobBuilder.postCommitJob('beam_PostCommit_Java_Examples_Dataflow_V2_ja
           // overloading the machines.
           commonJobProperties.setGradleSwitches(delegate, 3 * Runtime.runtime.availableProcessors())
           switches '-PdisableSpotlessCheck=true'
+          switches '-PdisableCheckStyle=true'
           switches '-PcompileAndRunTestsWithJava17'
           switches '-PskipCheckerFramework'
           switches "-Pjava17Home=${commonJobProperties.JAVA_17_HOME}"

diff --git a/.test-infra/jenkins/job_PreCommit_Java.groovy b/.test-infra/jenkins/job_PreCommit_Java.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java',
     gradleTask: ':javaPreCommit',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     timeoutMins: 180,
     triggerPathPatterns: [
@@ -45,9 +46,6 @@ builder.build {
       tools {
         errorProne()
         java()
-        checkStyle {
-          pattern('**/build/reports/checkstyle/*.xml')
-        }
         spotBugs {
           pattern('**/build/reports/spotbugs/*.xml')
         }

diff --git a/.test-infra/jenkins/job_PreCommit_Java_AWS2_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_AWS2_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_Amazon-Web-Services2_IO_Direct',
     gradleTask: 'sdks:java:io:amazon-web-services2:integrationTest',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^sdks/java/io/amazon-web-services2/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_Java_AWS_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_AWS_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_Amazon-Web-Services_IO_Direct',
     gradleTask: ':sdks:java:io:amazon-web-services:integrationTest',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^sdks/java/io/amazon-web-services/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_Java_Debezium_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_Debezium_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_Debezium_IO_Direct',
     gradleTask: ':sdks:java:io:debezium:integrationTest',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^sdks/java/io/debezium/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_Java_Examples_Dataflow.groovy b/.test-infra/jenkins/job_PreCommit_Java_Examples_Dataflow.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_Examples_Dataflow',
     gradleTask: ':javaExamplesDataflowPreCommit',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^model/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_Java_Examples_Dataflow_Java11.groovy b/.test-infra/jenkins/job_PreCommit_Java_Examples_Dataflow_Java11.groovy
@@ -25,6 +25,7 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     gradleTask: ':clean',
     gradleSwitches: [
       '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true',
       '-PskipCheckerFramework' // Gradle itself is running under JDK8 so plugin configures wrong for JDK11
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
@@ -47,6 +48,7 @@ builder.build {
       rootBuildScriptDir(properties.checkoutDir)
       tasks 'javaExamplesDataflowPreCommit'
       switches '-PdisableSpotlessCheck=true'
+      switches '-PdisableCheckStyle=true'
       switches '-PskipCheckerFramework' // Gradle itself is running under JDK8 so plugin configures wrong for JDK11
       switches '-PcompileAndRunTestsWithJava11'
       switches "-Pjava11Home=${properties.JAVA_11_HOME}"

diff --git a/.test-infra/jenkins/job_PreCommit_Java_GCP_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_GCP_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_GCP_IO_Direct',
     gradleTask: ':sdks:java:io:google-cloud-platform:postCommit',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     timeoutMins: 120,
     triggerPathPatterns: [

diff --git a/.test-infra/jenkins/job_PreCommit_Java_JDBC_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_JDBC_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_JDBC_IO_Direct',
     gradleTask: ':sdks:java:io:jdbc:integrationTest',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^sdks/java/io/jdbc/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_Java_Kafka_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_Kafka_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_Kafka_IO_Direct',
     gradleTask: ':sdks:java:io:kafka:kafkaVersionsCompatibilityTest',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^sdks/java/io/kafka/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_Java_Kinesis_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_Kinesis_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_Kinesis_IO_Direct',
     gradleTask: ':sdks:java:io:kinesis:integrationTest',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^sdks/java/io/kinesis/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_Java_Neo4j_IO_Direct.groovy b/.test-infra/jenkins/job_PreCommit_Java_Neo4j_IO_Direct.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'Java_Neo4j_IO_Direct',
     gradleTask: ':sdks:java:io:neo4j:integrationTest',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
       '^sdks/java/io/neo4j/.*$',

diff --git a/.test-infra/jenkins/job_PreCommit_SQL.groovy b/.test-infra/jenkins/job_PreCommit_SQL.groovy
@@ -23,7 +23,8 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     nameBase: 'SQL',
     gradleTask: ':sqlPreCommit',
     gradleSwitches: [
-      '-PdisableSpotlessCheck=true'
+      '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true'
     ], // spotless checked in job_PreCommit_Spotless
     triggerPathPatterns: [
       '^sdks/java/extensions/sql.*$',
@@ -35,10 +36,6 @@ builder.build {
     recordIssues {
       tools {
         errorProne()
-        java()
-        checkStyle {
-          pattern('**/build/reports/checkstyle/*.xml')
-        }
         spotBugs {
           pattern('**/build/reports/spotbugs/*.xml')
         }

diff --git a/.test-infra/jenkins/job_PreCommit_SQL_Java11.groovy b/.test-infra/jenkins/job_PreCommit_SQL_Java11.groovy
@@ -25,6 +25,7 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     gradleTask: ':sqlPreCommit',
     gradleSwitches: [
       '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true',
       '-PcompileAndRunTestsWithJava11',
       '-PskipCheckerFramework',
       // Gradle itself is running under JDK8 so plugin configures wrong for JDK11
@@ -41,9 +42,6 @@ builder.build {
       tools {
         errorProne()
         java()
-        checkStyle {
-          pattern('**/build/reports/checkstyle/*.xml')
-        }
         spotBugs {
           pattern('**/build/reports/spotbugs/*.xml')
         }

diff --git a/.test-infra/jenkins/job_PreCommit_SQL_Java17.groovy b/.test-infra/jenkins/job_PreCommit_SQL_Java17.groovy
@@ -25,6 +25,7 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     gradleTask: ':sqlPreCommit',
     gradleSwitches: [
       '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true',
       '-PcompileAndRunTestsWithJava17',
       '-PskipCheckerFramework',
       // Gradle itself is running under JDK8 so plugin configures wrong for JDK17
@@ -40,9 +41,6 @@ builder.build {
     recordIssues {
       tools {
         java()
-        checkStyle {
-          pattern('**/build/reports/checkstyle/*.xml')
-        }
         spotBugs {
           pattern('**/build/reports/spotbugs/*.xml')
         }

diff --git a/.test-infra/jenkins/job_PreCommit_Spotless.groovy b/.test-infra/jenkins/job_PreCommit_Spotless.groovy
@@ -21,7 +21,7 @@ import PrecommitJobBuilder
 PrecommitJobBuilder builder = new PrecommitJobBuilder(
     scope: this,
     nameBase: 'Spotless',
-    gradleTask: 'spotlessCheck',
+    gradleTask: 'spotlessCheck checkStyleMain checkStyleTest',
     triggerPathPatterns: [
       '^buildSrc/.*$',
       '^sdks/java/.*$',
@@ -31,4 +31,15 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
       '^.test-infra/jenkins/.*$',
     ]
     )
-builder.build()
+builder.build {
+  publishers {
+    recordIssues {
+      tools {
+        checkStyle {
+          pattern('**/build/reports/checkstyle/*.xml')
+        }
+      }
+      enabledForFailure(true)
+    }
+  }
+}
diff --git a/.test-infra/jenkins/job_Precommit_Java_Examples_Dataflow_Java17.groovy b/.test-infra/jenkins/job_Precommit_Java_Examples_Dataflow_Java17.groovy
@@ -25,6 +25,7 @@ PrecommitJobBuilder builder = new PrecommitJobBuilder(
     gradleTask: ':clean',
     gradleSwitches: [
       '-PdisableSpotlessCheck=true',
+      '-PdisableCheckStyle=true',
       '-PskipCheckerFramework' // Gradle itself is running under JDK8 so plugin configures wrong for JDK17
     ], // spotless checked in separate pre-commit
     triggerPathPatterns: [
@@ -47,6 +48,7 @@ builder.build {
       rootBuildScriptDir(properties.checkoutDir)
       tasks 'javaExamplesDataflowPreCommit'
       switches '-PdisableSpotlessCheck=true'
+      switches '-PdisableCheckStyle=true'
       switches '-PskipCheckerFramework' // Gradle itself is running under JDK8 so plugin configures wrong for JDK17
       switches '-PcompileAndRunTestsWithJava17'
       switches "-Pjava17Home=${properties.JAVA_17_HOME}"

diff --git a/.test-infra/jenkins/job_sonarqube_report.groovy b/.test-infra/jenkins/job_sonarqube_report.groovy
@@ -45,7 +45,7 @@ job('beam_sonarqube_report') {
       tasks("sonarqube")
       switches("--continue")
       switches("-PdisableSpotlessCheck=true")
-
+      switches("-PdisableCheckStyle=true")
       // disable parallelization to avoid output collisions
       switches("--no-parallel")
     }

diff --git a/buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy b/buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy
@@ -1079,6 +1079,12 @@ class BeamModulePlugin implements Plugin<Project> {
         maxErrors = 0
       }
       project.checkstyle { toolVersion = "8.23" }
+      // CheckStyle can be removed from the 'check' task by passing -PdisableCheckStyle=true on the Gradle
+      // command-line. This is useful for pre-commit which runs checkStyle separately.
+      def disableCheckStyle = project.hasProperty('disableCheckStyle') &&
+          project.disableCheckStyle == 'true'
+      project.checkstyleMain.enabled = !disableCheckStyle
+      project.checkstyleTest.enabled = !disableCheckStyle
 
       // Configures javadoc plugin and ensure check runs javadoc.
       project.tasks.withType(Javadoc) {