Add rewrite support for errorprone.refasterrules.FileRulesRecipes

Author: Vincent Potucek

.github/actions/run-gradle/action.yml

@@ -74,7 +74,7 @@ runs:
       shell: bash
       id: run-tests
       env:
-        TIMEOUT_MINUTES: ${{ inputs.timeout-minutes}}
+        TIMEOUT_MINUTES: ${{ inputs.timeout-minutes }}
         TEST_CATALOG: ${{ inputs.test-catalog-path }}
         TEST_TASK: ${{ inputs.test-task }}
         TEST_RETRIES: ${{ inputs.test-retries }}
@@ -86,7 +86,7 @@ runs:
       run: |
         set +e
         ./.github/scripts/thread-dump.sh &
-        timeout ${TIMEOUT_MINUTES}m ./gradlew --build-cache --continue --no-scan \
+        timeout ${TIMEOUT_MINUTES}m ./gradlew $TEST_TASK --build-cache --continue --no-scan \
         -PtestLoggingEvents=started,passed,skipped,failed \
         -PmaxParallelForks=4 \
         -PmaxTestRetries=$TEST_RETRIES -PmaxTestRetryFailures=10 \
@@ -97,7 +97,6 @@ runs:
         -Pkafka.cluster.test.repeat=$TEST_REPEAT \
         -Pkafka.test.verbose=$TEST_VERBOSE \
         -PcommitId=xxxxxxxxxxxxxxxx \
-        $TEST_TASK
         exitcode="$?"
         echo "exitcode=$exitcode" >> $GITHUB_OUTPUT
     - name: Archive build scan (${{ inputs.test-task }})
@@ -108,3 +107,27 @@ runs:
         path: ~/.gradle/build-scan-data
         compression-level: 9
         if-no-files-found: ignore
+    - name: Run spotlessCheck (${{ inputs.test-task }})
+      shell: bash
+      id: run-spotlessCheck
+      env:
+        TIMEOUT_MINUTES: ${{ inputs.timeout-minutes }}
+      run: |
+        set +e
+        ./.github/scripts/thread-dump.sh &
+        timeout ${TIMEOUT_MINUTES}m ./gradlew spotlessCheck --build-cache --continue --no-scan \
+        -PmaxParallelForks=4 \
+        exitcode="$?"
+        echo "exitcode=$exitcode" >> $GITHUB_OUTPUT
+    - name: Run rewriteDryRun (${{ inputs.test-task }})
+      shell: bash
+      id: run-rewriteDryRun
+      env:
+        TIMEOUT_MINUTES: ${{ inputs.timeout-minutes }}
+      run: |
+        set +e
+        ./.github/scripts/thread-dump.sh &
+        timeout ${TIMEOUT_MINUTES}m ./gradlew rewriteDryRun --build-cache --continue --no-scan \
+        -PmaxParallelForks=4 \
+        exitcode="$?"
+        echo "exitcode=$exitcode" >> $GITHUB_OUTPUT

.github/workflows/build.yml

@@ -220,7 +220,7 @@ jobs:
         uses: ./.github/actions/run-gradle
         with:
           test-task: test
-          timeout-minutes: 180  # 3 hours
+          timeout-minutes: 240  # 4 H (test & spotless & rewrite)
           test-catalog-path: ${{ steps.load-test-catalog.outputs.download-path }}/combined-test-catalog.txt
           build-scan-artifact-name: build-scan-${{ env.job-variation }}
           run-new-tests: ${{ matrix.run-new }}

README.md

@@ -201,7 +201,17 @@ For experiments (or regression testing purposes) add `-PcheckstyleVersion=X.y.z`
 #### Spotless ####
 The import order is a part of static check. please call `spotlessApply` to optimize the imports of Java codes before filing pull request.
 
-    ./gradlew spotlessApply
+`./gradlew spotlessApply`
+
+#### Rewrite
+The build system incorporates [Moderne](https://moderne.io/) rewrite capabilities for automated code transformations.
+
+- **Convention** (e.g., JUnit's naming rules)
+- **Refactor** safely (e.g., rename methods, migrate APIs)
+- **Modernize** (e.g., Java 8 → Java 17 features)
+- **Patterns** (e.g., replace `Vector` with `ArrayList`)
+
+`./gradlew rewriteRun`
 
 #### Spotbugs ####
 Spotbugs uses static analysis to look for bugs in the code.

build.gradle

@@ -41,6 +41,58 @@ plugins {
   id 'org.scoverage' version '8.0.3' apply false
   id 'com.gradleup.shadow' version '8.3.6' apply false
   id 'com.diffplug.spotless' version "6.25.0"
+  id "org.openrewrite.rewrite" version "7.12.1"
+}
+
+spotless {
+  java {
+    targetExclude('**/generated/**/*.java','**/generated-test/**/*.java')
+    importOrder('kafka', 'org.apache.kafka', 'com', 'net', 'org', 'java', 'javax', '', '\\#')
+    //licenseHeaderFile("$rootDir/checkstyle/java.header", 'package') todo apply me
+  }
+  scala {
+    scalafmt("$versions.scalafmt").configFile("$rootDir/checkstyle/.scalafmt.conf").scalaMajorVersion(versions.baseScala)
+    //licenseHeaderFile("$rootDir/checkstyle/java.header", 'package') todo apply me
+  }
+}
+
+rewrite {
+  activeRecipe(
+          "org.openrewrite.java.RemoveUnusedImports",
+          "org.openrewrite.staticanalysis.NoFinalizer",
+          "org.openrewrite.staticanalysis.RemoveUnusedLocalVariables",
+          "org.openrewrite.staticanalysis.RemoveUnusedPrivateFields",
+          "tech.picnic.errorprone.refasterrules.FileRulesRecipes",
+          //"org.openrewrite.gradle.GradleBestPractices",
+          //"org.openrewrite.java.format.RemoveTrailingWhitespace",
+          //"org.openrewrite.java.migrate.UpgradeToJava17",
+          //"org.openrewrite.java.recipes.JavaRecipeBestPractices",
+          //"org.openrewrite.java.recipes.RecipeNullabilityBestPractices",
+          //"org.openrewrite.java.recipes.RecipeTestingBestPractices",
+          //"org.openrewrite.staticanalysis.CodeCleanup",
+          //"org.openrewrite.staticanalysis.EqualsAvoidsNull",
+          //"org.openrewrite.staticanalysis.JavaApiBestPractices",
+          //"org.openrewrite.staticanalysis.MissingOverrideAnnotation",
+          //"org.openrewrite.staticanalysis.ModifierOrder",
+          //"org.openrewrite.staticanalysis.RemoveCallsToSystemGc",
+          //"org.openrewrite.staticanalysis.RemoveUnneededAssertion",
+          //"org.openrewrite.staticanalysis.RemoveUnusedPrivateMethods",
+          //"org.openrewrite.staticanalysis.StringLiteralEquality",
+          //"org.openrewrite.staticanalysis.UnnecessaryParentheses",
+          //"org.openrewrite.staticanalysis.UnnecessaryThrows",
+          //"org.openrewrite.text.EndOfLineAtEndOfFile",
+          //"tech.picnic.errorprone.refasterrules.CollectionRulesRecipes",
+          //"tech.picnic.errorprone.refasterrules.NullRulesRecipes",
+          //"tech.picnic.errorprone.refasterrules.StreamRulesRecipes",
+          //"tech.picnic.errorprone.refasterrules.StringRulesRecipes",
+  )
+  exportDatatables = true
+  exclusions.add("**.GarbageCollectedMemoryPoolTest.java")
+  failOnDryRunResults = true
+}
+
+dependencies {
+  rewrite("org.openrewrite.recipe:rewrite-third-party:0.24.3", "org.openrewrite.recipe:rewrite-static-analysis:2.13.0")
 }
 
 ext {
@@ -157,7 +209,7 @@ ext {
     libs.log4j2Api,
     libs.log4j2Core
   ]
-  
+
 }
 
 allprojects {
@@ -551,7 +603,7 @@ subprojects {
         maxFailures = userMaxTestRetryFailures
       }
     }
-    
+
     finalizedBy("copyTestXml")
   }
 
@@ -816,14 +868,6 @@ subprojects {
     skipProjects = [ ":jmh-benchmarks", ":trogdor" ]
     skipConfigurations = [ "zinc" ]
   }
-  apply plugin: 'com.diffplug.spotless'
-  spotless {
-    java {
-      targetExclude('**/generated/**/*.java','**/generated-test/**/*.java')
-      importOrder('kafka', 'org.apache.kafka', 'com', 'net', 'org', 'java', 'javax', '', '\\#')
-      removeUnusedImports()
-    }
-  }
 }
 
 gradle.taskGraph.whenReady { taskGraph ->
@@ -2811,15 +2855,6 @@ project(':streams:streams-scala') {
   jar {
     dependsOn 'copyDependantLibs'
   }
-
-  apply plugin: 'com.diffplug.spotless'
-  spotless {
-    scala {
-      target '**/*.scala'
-      scalafmt("$versions.scalafmt").configFile('../../checkstyle/.scalafmt.conf').scalaMajorVersion(versions.baseScala)
-      licenseHeaderFile '../../checkstyle/java.header', 'package'
-    }
-  }
 }
 
 project(':streams:integration-tests') {