PoC: Add rewrite support for errorprone.refasterrules

Author: Vincent Potucek

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

@@ -66,15 +66,10 @@ runs:
   using: "composite"
   steps:
     - name: Run JUnit Tests (${{ inputs.test-task }})
-      # Gradle flags
-      # --build-cache:  Let Gradle restore the build cache
-      # --no-scan:      Don't attempt to publish the scan yet. We want to archive it first.
-      # --continue:     Keep running even if a test fails
-      # -PcommitId      Prevent the Git SHA being written into the jar files (which breaks caching)
       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 +81,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 +92,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 }})

.github/workflows/build.yml

@@ -121,7 +121,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           persist-credentials: false
-          ref: ${{ github.sha }}  # this is the default, just being explicit.
+          ref: ${{ github.sha }} # this is the default, just being explicit.
       - name: Setup Python
         uses: ./.github/actions/setup-python
       - name: Setup Gradle
@@ -134,13 +134,8 @@ jobs:
       - name: Compile and validate
         env:
           SCAN_ARG: ${{ inputs.is-public-fork && '--no-scan' || '--scan' }}
-        # Gradle flags
-        # --build-cache:  Let Gradle restore the build cache
-        # --info:         For now, we'll generate lots of logs while setting up the GH Actions
-        # --scan:         Publish the build scan. This will only work on PRs from apache/kafka and trunk
-        # --no-scan:      For public fork PRs, we won't attempt to publish the scan
         run: |
-          ./gradlew --build-cache --info $SCAN_ARG check releaseTarGz -x test
+          ./gradlew check rewriteDryRun --build-cache --info $SCAN_ARG releaseTarGz
       - name: Archive check reports
         if: always()
         uses: actions/upload-artifact@v4

README.md

@@ -201,13 +201,23 @@ 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.
 You can run spotbugs using:
 
-    ./gradlew spotbugsMain spotbugsTest -x test
+    ./gradlew spotbugsMain spotbugsTest
 
 The spotbugs warnings will be found in `reports/spotbugs/main.html` and `reports/spotbugs/test.html` files in the subproject build
 directories.  Use -PxmlSpotBugsReport=true to generate an XML report instead of an HTML one.

build.gradle

@@ -13,6 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import com.github.spotbugs.snom.SpotBugsTask
 import org.ajoberstar.grgit.Grgit
 import java.nio.charset.StandardCharsets
 
@@ -29,20 +30,28 @@ buildscript {
 }
 
 plugins {
-  id 'com.github.ben-manes.versions' version '0.48.0'
-  id 'idea'
-  id 'jacoco'
-  id 'java-library'
-  id 'org.owasp.dependencycheck' version '8.2.1'
-  id 'org.nosphere.apache.rat' version "0.8.1"
+  // active
+  id "com.github.ben-manes.versions" version "0.48.0"
+  id "idea"
   id "io.swagger.core.v3.swagger-gradle-plugin" version "${swaggerVersion}"
+  id "jacoco"
+  id "java-library"
+  id "org.nosphere.apache.rat" version "0.8.1"
+  id "org.owasp.dependencycheck" version "8.2.1"
+  // passive
+  id "com.diffplug.spotless" version "7.2.1" apply false
+    id "org.openrewrite.rewrite" version "7.12.1" apply false
 
-  id "com.github.spotbugs" version '6.0.25' apply false
-  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 "com.github.spotbugs" version "6.0.25" apply false
+  id "com.gradleup.shadow" version "8.3.6" apply false
+  id "org.scoverage" version "8.0.3" apply false
 }
 
+apply from: "$rootDir/gradle/.qa/checkstyle.gradle"
+apply from: "$rootDir/gradle/.qa/rewrite.gradle"
+apply from: "$rootDir/gradle/.qa/spotbugs.gradle"
+apply from: "$rootDir/gradle/.qa/spotless.gradle"
+
 ext {
   gradleVersion = versions.gradle
   minClientJavaVersion = 11
@@ -157,7 +166,7 @@ ext {
     libs.log4j2Api,
     libs.log4j2Core
   ]
-  
+
 }
 
 allprojects {
@@ -312,8 +321,6 @@ subprojects {
   task allDepInsight(type: DependencyInsightReportTask) {showingAllVariants = false} doLast {}
 
   apply plugin: 'java-library'
-  apply plugin: 'checkstyle'
-  apply plugin: "com.github.spotbugs"
 
   // We use the shadow plugin for the jmh-benchmarks module and the `-all` jar can get pretty large, so
   // don't publish it
@@ -749,32 +756,7 @@ subprojects {
     }
   }
 
-  checkstyle {
-    configDirectory = rootProject.layout.projectDirectory.dir("checkstyle")
-    configProperties = checkstyleConfigProperties("import-control.xml")
-    toolVersion = versions.checkstyle
-  }
-
-  configure(checkstyleMain) {
-    group = 'Verification'
-    description = 'Run checkstyle on all main Java sources'
-  }
-
-  configure(checkstyleTest) {
-    group = 'Verification'
-    description = 'Run checkstyle on all test Java sources'
-  }
-
-  test.dependsOn('checkstyleMain', 'checkstyleTest')
-
-  spotbugs {
-    toolVersion = versions.spotbugs
-    excludeFilter = file("$rootDir/gradle/spotbugs-exclude.xml")
-    ignoreFailures = false
-  }
-  test.dependsOn('spotbugsMain')
-
-  tasks.withType(com.github.spotbugs.snom.SpotBugsTask).configureEach {
+  tasks.withType(SpotBugsTask).configureEach { // move to spotbugs.gradle
     reports.configure {
       // Continue supporting `xmlFindBugsReport` for compatibility
       xml.enabled(project.hasProperty('xmlSpotBugsReport') || project.hasProperty('xmlFindBugsReport'))
@@ -816,20 +798,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 ->
-  taskGraph.getAllTasks().findAll { it.name.contains('spotbugsScoverage') || it.name.contains('spotbugsTest') }.each { task ->
-    task.enabled = false
-  }
 }
 
 def fineTuneEclipseClasspathFile(eclipse, project) {
@@ -2812,14 +2780,6 @@ project(':streams:streams-scala') {
     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') {

clients/src/main/java/org/apache/kafka/clients/ClusterConnectionStates.java

@@ -555,6 +555,7 @@ private void clearAddresses() {
             addresses = Collections.emptyList();
         }
 
+        @Override
         public String toString() {
             return "NodeConnectionState(" +
                 "state=" + state + ", " +

clients/src/main/java/org/apache/kafka/clients/admin/AlterConfigsOptions.java

@@ -32,6 +32,7 @@ public class AlterConfigsOptions extends AbstractOptions<AlterConfigsOptions> {
      *
      */
     // This method is retained to keep binary compatibility with 0.11
+    @Override
     public AlterConfigsOptions timeoutMs(Integer timeoutMs) {
         this.timeoutMs = timeoutMs;
         return this;

clients/src/main/java/org/apache/kafka/clients/admin/ConfigEntry.java

@@ -154,9 +154,9 @@ public boolean equals(Object o) {
                 Objects.equals(this.value, that.value) &&
                 this.isSensitive == that.isSensitive &&
                 this.isReadOnly == that.isReadOnly &&
-                Objects.equals(this.source, that.source) &&
+            this.source == that.source &&
                 Objects.equals(this.synonyms, that.synonyms) &&
-                Objects.equals(this.type, that.type) &&
+            this.type == that.type &&
                 Objects.equals(this.documentation, that.documentation);
     }
 

clients/src/main/java/org/apache/kafka/clients/admin/CreateAclsOptions.java

@@ -30,6 +30,7 @@ public class CreateAclsOptions extends AbstractOptions<CreateAclsOptions> {
      *
      */
     // This method is retained to keep binary compatibility with 0.11
+    @Override
     public CreateAclsOptions timeoutMs(Integer timeoutMs) {
         this.timeoutMs = timeoutMs;
         return this;

clients/src/main/java/org/apache/kafka/clients/admin/CreateTopicsOptions.java

@@ -33,6 +33,7 @@ public class CreateTopicsOptions extends AbstractOptions<CreateTopicsOptions> {
      *
      */
     // This method is retained to keep binary compatibility with 0.11
+    @Override
     public CreateTopicsOptions timeoutMs(Integer timeoutMs) {
         this.timeoutMs = timeoutMs;
         return this;

clients/src/main/java/org/apache/kafka/clients/admin/DeleteAclsOptions.java

@@ -30,6 +30,7 @@ public class DeleteAclsOptions extends AbstractOptions<DeleteAclsOptions> {
      *
      */
     // This method is retained to keep binary compatibility with 0.11
+    @Override
     public DeleteAclsOptions timeoutMs(Integer timeoutMs) {
         this.timeoutMs = timeoutMs;
         return this;