Add spotless check for groovy tests (#4471)

Signed-off-by: ZhangJian He <[email protected]>
apache · Jul 26, 2024 · e5c418e · e5c418e
1 parent d92bd20
commit e5c418e
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 47 deletions.
diff --git a/.github/workflows/bk-ci.yml b/.github/workflows/bk-ci.yml
@@ -84,7 +84,7 @@ jobs:
         if: steps.check_changes.outputs.docs_only != 'true'
         run: |
           mvn -T 1C -B -nsu clean install -Ddistributedlog -DskipTests
-          mvn -T 1C -B -nsu apache-rat:check checkstyle:check spotbugs:check package -Ddistributedlog -DskipTests
+          mvn -T 1C -B -nsu apache-rat:check checkstyle:check spotbugs:check spotless:check package -Ddistributedlog -DskipTests
 
       - name: Check license files
         if: steps.check_changes.outputs.docs_only != 'true'

diff --git a/pom.xml b/pom.xml
@@ -171,6 +171,7 @@
     <slf4j.version>2.0.12</slf4j.version>
     <snakeyaml.version>2.0</snakeyaml.version>
     <spotbugs-annotations.version>4.6.0</spotbugs-annotations.version>
+    <spotless.version>2.43.0</spotless.version>
     <javax-annotations-api.version>1.3.2</javax-annotations-api.version>
     <testcontainers.version>1.19.4</testcontainers.version>
     <vertx.version>4.5.7</vertx.version>
@@ -1140,6 +1141,21 @@
         <artifactId>exec-maven-plugin</artifactId>
         <version>${exec-maven-plugin.version}</version>
       </plugin>
+      <plugin>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
+        <version>${spotless.version}</version>
+        <configuration>
+          <groovy>
+            <includes>
+              <include>src/main/groovy/**/*.groovy</include>
+              <include>src/test/groovy/**/*.groovy</include>
+            </includes>
+            <importOrder/>
+            <removeSemicolons/>
+          </groovy>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
   <profiles>

diff --git a/...c/test/groovy/org/apache/bookkeeper/tests/backwardcompat/AbstractClientFencingTest.groovy b/...c/test/groovy/org/apache/bookkeeper/tests/backwardcompat/AbstractClientFencingTest.groovy
@@ -85,7 +85,7 @@ abstract class AbstractClientFencingTest {
             }
             ledger2.close()
         } catch(Throwable tt) {
-            throw new RuntimeException("Got exception with oldClientVersion: " + oldClientVersion + " and fencingVersion: " + fencingVersion, tt);
+            throw new RuntimeException("Got exception with oldClientVersion: " + oldClientVersion + " and fencingVersion: " + fencingVersion, tt)
         } finally {
             oldBK.close()
             oldCL.close()

diff --git a/...ts/src/test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatOldClients.groovy b/...ts/src/test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatOldClients.groovy
@@ -18,14 +18,11 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
-
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
 import org.apache.bookkeeper.tests.integration.utils.ThreadReaper
-
 import org.jboss.arquillian.junit.Arquillian
 import org.jboss.arquillian.test.api.ArquillianResource
-
 import org.junit.Assert
 import org.junit.Before
 import org.junit.Test
@@ -108,11 +105,11 @@ class TestCompatOldClients {
             try {
                 def ledger1 = readBK.openLedger(ledger0.getId(), readCL.digestType("CRC32"), PASSWD)
                 if (expectFail) {
-                    Assert.fail("For older versions Openledger call is expected to fail with ZKException, writerVersion: " + writeVersion + ", readerVersion: " + readerVersion);
+                    Assert.fail("For older versions Openledger call is expected to fail with ZKException, writerVersion: " + writeVersion + ", readerVersion: " + readerVersion)
                 }
             } catch (Exception exc) {
                 if (!expectFail) {
-                    Assert.fail("For older versions Openledger call is expected to work, writerVersion: " + writeVersion + ", readerVersion: " + readerVersion);
+                    Assert.fail("For older versions Openledger call is expected to work, writerVersion: " + writeVersion + ", readerVersion: " + readerVersion)
                 }
                 Assert.assertEquals(exc.getClass().getName(),
                                 "org.apache.bookkeeper.client.BKException\$ZKException")

diff --git a/...ovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatHierarchicalLedgerManager.groovy b/...ovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatHierarchicalLedgerManager.groovy
@@ -18,17 +18,13 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
-
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
-
 import org.jboss.arquillian.junit.Arquillian
 import org.jboss.arquillian.test.api.ArquillianResource
-
 import org.junit.Assert
 import org.junit.Test
 import org.junit.runner.RunWith
-
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 

diff --git a/...y/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgradeWithHostnameBookieId.groovy b/...y/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgradeWithHostnameBookieId.groovy
@@ -18,17 +18,13 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
-
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
-
 import org.jboss.arquillian.junit.Arquillian
 import org.jboss.arquillian.test.api.ArquillianResource
-
 import org.junit.Assert
 import org.junit.Test
 import org.junit.runner.RunWith
-
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 

diff --git a/...che/bookkeeper/tests/backwardcompat/TestCompatUpgradeOldServerInClusterWithCookies.groovy b/...che/bookkeeper/tests/backwardcompat/TestCompatUpgradeOldServerInClusterWithCookies.groovy
@@ -18,17 +18,13 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
-
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
-
 import org.jboss.arquillian.junit.Arquillian
 import org.jboss.arquillian.test.api.ArquillianResource
-
 import org.junit.Assert
 import org.junit.Test
 import org.junit.runner.RunWith
-
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 

diff --git a/...est/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatRecoveryNoPassword.groovy b/...est/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatRecoveryNoPassword.groovy
@@ -18,34 +18,28 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
-
 import io.netty.buffer.ByteBuf
-import org.apache.bookkeeper.net.BookieId
-
 import java.util.concurrent.CountDownLatch
 import java.util.concurrent.TimeUnit
 import java.util.concurrent.atomic.AtomicLong
-
 import org.apache.bookkeeper.client.BKException
 import org.apache.bookkeeper.client.BookKeeper
 import org.apache.bookkeeper.client.BookKeeperAdmin
 import org.apache.bookkeeper.client.LedgerHandle
 import org.apache.bookkeeper.client.api.LedgerMetadata
 import org.apache.bookkeeper.conf.ClientConfiguration
+import org.apache.bookkeeper.net.BookieId
 import org.apache.bookkeeper.net.BookieSocketAddress
 import org.apache.bookkeeper.proto.BookieProtocol
 import org.apache.bookkeeper.proto.BookkeeperInternalCallbacks.ReadEntryCallback
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.DockerUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
-
 import org.jboss.arquillian.junit.Arquillian
 import org.jboss.arquillian.test.api.ArquillianResource
-
 import org.junit.Assert
 import org.junit.Test
 import org.junit.runner.RunWith
-
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 
@@ -62,8 +56,8 @@ class TestCompatRecoveryNoPassword {
     }
 
     private static class ReplicationVerificationCallback implements ReadEntryCallback {
-        final CountDownLatch latch;
-        final AtomicLong numSuccess;
+        final CountDownLatch latch
+        final AtomicLong numSuccess
 
         ReplicationVerificationCallback(int numRequests) {
             latch = new CountDownLatch(numRequests)
@@ -84,10 +78,10 @@ class TestCompatRecoveryNoPassword {
 
         long await() throws InterruptedException {
             if (!latch.await(60, TimeUnit.SECONDS)) {
-                LOG.warn("Didn't get all responses in verification");
-                return 0;
+                LOG.warn("Didn't get all responses in verification")
+                return 0
             } else {
-                return numSuccess.get();
+                return numSuccess.get()
             }
         }
     }
@@ -122,15 +116,15 @@ class TestCompatRecoveryNoPassword {
                 }
             }
 
-            long numSuccess = cb.await();
+            long numSuccess = cb.await()
             if (numSuccess < expectedSuccess) {
                 LOG.warn("Fragment not fully replicated ledgerId = {} startEntryId = {}"
                          + " endEntryId = {} expectedSuccess = {} gotSuccess = {}",
-                         lh.getId(), startEntryId, endEntryId, expectedSuccess, numSuccess);
-                return false;
+                         lh.getId(), startEntryId, endEntryId, expectedSuccess, numSuccess)
+                return false
             }
         }
-        return true;
+        return true
     }
 
     /**
@@ -203,7 +197,7 @@ class TestCompatRecoveryNoPassword {
             } catch (BKException bke) {
                 // correct behaviour
             } finally {
-                bka.close();
+                bka.close()
             }
 
             adminConf.setBookieRecoveryDigestType(BookKeeper.DigestType.CRC32)
@@ -216,7 +210,7 @@ class TestCompatRecoveryNoPassword {
             } catch (BKException bke) {
                 // correct behaviour
             } finally {
-                bka.close();
+                bka.close()
             }
 
             // Check that entries are still missing

diff --git a/...src/test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgradeDirect.groovy b/...src/test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgradeDirect.groovy
@@ -18,13 +18,10 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
-
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
-
 import org.jboss.arquillian.junit.Arquillian
 import org.jboss.arquillian.test.api.ArquillianResource
-
 import org.junit.Assert
 import org.junit.Test
 import org.junit.runner.RunWith

diff --git a/.../test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgradeDowngrade.groovy b/.../test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgradeDowngrade.groovy
@@ -18,6 +18,7 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
+import java.util.concurrent.TimeUnit
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
 import org.jboss.arquillian.junit.Arquillian
@@ -32,8 +33,6 @@ import org.junit.runners.MethodSorters
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 
-import java.util.concurrent.TimeUnit
-
 /**
  * Sequentially upgrade bookies with different versions and check compatibility.
  * Uses DbLedgerStorage/RocksDB.

diff --git a/...grade/src/test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgrade.groovy b/...grade/src/test/groovy/org/apache/bookkeeper/tests/backwardcompat/TestCompatUpgrade.groovy
@@ -18,19 +18,15 @@
 package org.apache.bookkeeper.tests.backwardcompat
 
 import com.github.dockerjava.api.DockerClient
-
 import org.apache.bookkeeper.tests.integration.utils.BookKeeperClusterUtils
 import org.apache.bookkeeper.tests.integration.utils.MavenClassLoader
-
 import org.jboss.arquillian.junit.Arquillian
 import org.jboss.arquillian.test.api.ArquillianResource
-
 import org.junit.Assert
 import org.junit.FixMethodOrder
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
-
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 
@@ -85,7 +81,7 @@ class TestCompatUpgrade {
                 }
             } catch (Exception e) {
                 if (!clientCompatBroken) {
-                    throw e;
+                    throw e
                 }
             }