Use Spotless for code formatting

Spotless is widely used opinionated Java code formatter. It will also fix incorrect formatting using `./gradlew spotlessApply`, avoiding the need for contributors to manually correct any formatting violations flagged by Checkstyle. Formatting rules defined by Checkstyle that would otherwise cause conflicts with the formatting applied by Spotless are removed. This change also updates the Gradle version to 8.10.2. Signed-off-by: Mark S. Lewis <[email protected]>
hyperledger · Oct 23, 2024 · c9e89ef · c9e89ef
1 parent 33f3ba8
commit c9e89ef
Show file tree

Hide file tree

Showing 207 changed files with 3,119 additions and 3,631 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -33,7 +33,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '11'
+          java-version: 11
       - uses: gradle/actions/setup-gradle@v4
       - name: Push to registry ${{ matrix.publish_target }}
         run: |
@@ -65,7 +65,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '11'
+          java-version: 11
       - uses: gradle/actions/setup-gradle@v4
       - name: Build the dependencies needed for the image
         run: ./gradlew :fabric-chaincode-docker:copyAllDeps

diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@
 **/bin/
 /build/
 build/*
+settings-gradle.lockfile
 
 _cfg
 repository

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -28,7 +28,7 @@ We use our own forks and [Github Flow](https://guides.github.com/introduction/fl
 
 ## Coding Style
 
-Please to try to be consistent with the rest of the code and conform to checkstyle rules where they are provided.
+Please to try to be consistent with the rest of the code and conform to checkstyle rules where they are provided. [Spotless](https://github.com/diffplug/spotless) is used to enforce code formatting. You can run `./gradlew spotlessApply` to apply the mandated code formatting to the codebase before submitting changes to avoid failing the build with formatting violations.
 
 ## Code of Conduct Guidelines <a name="conduct"></a>
 

diff --git a/build.gradle b/build.gradle
@@ -6,12 +6,13 @@
 
 plugins {
     id "com.github.ben-manes.versions" version "0.51.0"
+    id "com.diffplug.spotless" version "6.25.0"
 }
 
 version = '2.5.5'
 
 
-// If the nightly property is set, then this is the scheduled main 
+// If the nightly property is set, then this is the scheduled main
 // build - and we should publish this to artifactory
 //
 // Use the .dev.<number> format to match Maven convention
@@ -23,16 +24,27 @@ if (properties.containsKey('NIGHTLY')) {
 }
 
 allprojects {
+    apply plugin: "com.diffplug.spotless"
+
     repositories {
         mavenCentral()
         maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
         maven { url "https://www.jitpack.io" }
     }
+
+    spotless {
+        format 'misc', {
+            target '*.gradle', '.gitattributes', '.gitignore'
+            trimTrailingWhitespace()
+            indentWithSpaces()
+            endWithNewline()
+        }
+    }
 }
 
 subprojects {
     apply plugin: 'java'
-    apply plugin: 'maven-publish'
+    apply plugin: "maven-publish"
 
     group = 'org.hyperledger.fabric-chaincode-java'
     version = rootProject.version
@@ -64,6 +76,13 @@ subprojects {
         useJUnitPlatform()
     }
 
+    spotless {
+        java {
+            removeUnusedImports()
+            palantirJavaFormat('2.50.0').formatJavadoc(true)
+            formatAnnotations()
+        }
+    }
 }
 
 task printVersionName() {

diff --git a/ci/checkstyle/checkstyle.xml b/ci/checkstyle/checkstyle.xml
@@ -41,20 +41,8 @@
     <module name="AvoidStarImport"/>
     <module name="IllegalImport"/>
     <module name="RedundantImport"/>
-    <module name="UnusedImports">
-      <property name="processJavadoc" value="false"/>
-    </module>
     <module name="MethodLength"/>
     <module name="ParameterNumber"/>
-    <module name="GenericWhitespace"/>
-    <module name="MethodParamPad"/>
-    <module name="NoWhitespaceAfter"/>
-    <module name="NoWhitespaceBefore"/>
-    <module name="OperatorWrap"/>
-    <module name="ParenPad"/>
-    <module name="TypecastParenPad"/>
-    <module name="WhitespaceAfter"/>
-    <module name="WhitespaceAround"/>
     <module name="ModifierOrder"/>
     <module name="RedundantModifier"/>
     <module name="AvoidNestedBlocks"/>
@@ -108,11 +96,6 @@
   <module name="NewlineAtEndOfFile"/>
   <module name="Translation"/>
   <module name="FileLength"/>
-  <module name="LineLength">
-    <property name="fileExtensions" value="java"/>
-    <property name="ignorePattern" value="^ +\* +"/>
-    <property name="max" value="160"/>
-  </module>
   <module name="FileTabCharacter"/>
   <module name="RegexpSingleline">
     <property name="format" value="\s+$"/>

diff --git a/fabric-chaincode-docker/build.gradle b/fabric-chaincode-docker/build.gradle
@@ -67,4 +67,3 @@ task buildImage(type: DockerBuildImage) {
     inputDir = project.file('Dockerfile').parentFile
     images = ['hyperledger/fabric-javaenv', 'hyperledger/fabric-javaenv:2.5', 'hyperledger/fabric-javaenv:amd64-2.5.5', 'hyperledger/fabric-javaenv:amd64-latest']
 }
-
diff --git a/fabric-chaincode-integration-test/build.gradle b/fabric-chaincode-integration-test/build.gradle
@@ -8,15 +8,15 @@ dependencies {
  test {
     // Always run tests, even when nothing changed.
     dependsOn 'cleanTest'
-    
+
     // Show test results.
     testLogging {
         events "passed", "skipped", "failed"
         showExceptions true
         showCauses true
         showStandardStreams true
         exceptionFormat "full"
-        
+
     }
  }
 

diff --git a/fabric-chaincode-integration-test/chaincodebootstrap.gradle b/fabric-chaincode-integration-test/chaincodebootstrap.gradle
@@ -9,4 +9,4 @@ allprojects {
             }
         }
     }
-}
+}
diff --git a/...test/java/org/hyperleder/fabric/shim/integration/contractinstall/ContractInstallTest.java b/...test/java/org/hyperleder/fabric/shim/integration/contractinstall/ContractInstallTest.java
@@ -5,40 +5,35 @@
 */
 package org.hyperleder.fabric.shim.integration.contractinstall;
 
-import static org.hamcrest.core.StringContains.containsString;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.StringContains.containsString;
 
 import org.hyperleder.fabric.shim.integration.util.FabricState;
 import org.hyperleder.fabric.shim.integration.util.InvokeHelper;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
-/**
- * Basic Java Chaincode Test
- *
- */
+/** Basic Java Chaincode Test */
 public class ContractInstallTest {
 
-   @BeforeAll
+    @BeforeAll
     public static void setUp() throws Exception {
         FabricState.getState().start();
-
     }
 
-   @Test
-    public void TestInstall(){
+    @Test
+    public void TestInstall() {
 
-        InvokeHelper helper = InvokeHelper.newHelper("baregradlecc","sachannel");        
+        InvokeHelper helper = InvokeHelper.newHelper("baregradlecc", "sachannel");
         String text = helper.invoke("org1", "whoami");
         assertThat(text, containsString("BareGradle"));
-        
-        helper = InvokeHelper.newHelper("baremaven","sachannel");        
+
+        helper = InvokeHelper.newHelper("baremaven", "sachannel");
         text = helper.invoke("org1", "whoami");
         assertThat(text, containsString("BareMaven"));
-        
-        helper = InvokeHelper.newHelper("wrappermaven","sachannel");        
+
+        helper = InvokeHelper.newHelper("wrappermaven", "sachannel");
         text = helper.invoke("org1", "whoami");
-        assertThat(text, containsString("WrapperMaven"));        
+        assertThat(text, containsString("WrapperMaven"));
     }
-
-}
+}
diff --git a/...c/test/java/org/hyperleder/fabric/shim/integration/ledgertests/LedgerIntegrationTest.java b/...c/test/java/org/hyperleder/fabric/shim/integration/ledgertests/LedgerIntegrationTest.java
@@ -4,34 +4,29 @@
 SPDX-License-Identifier: Apache-2.0
 */
 package org.hyperleder.fabric.shim.integration.ledgertests;
-import static org.hamcrest.core.StringContains.containsString;
+
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.StringContains.containsString;
 
 import org.hyperleder.fabric.shim.integration.util.FabricState;
 import org.hyperleder.fabric.shim.integration.util.InvokeHelper;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
-/**
- * Basic Java Chaincode Test
- *
- */
+/** Basic Java Chaincode Test */
 public class LedgerIntegrationTest {
 
-   @BeforeAll
+    @BeforeAll
     public static void setUp() throws Exception {
 
-
         FabricState.getState().start();
     }
 
-   @Test
-    public void TestLedgers(){
-        InvokeHelper helper = InvokeHelper.newHelper("ledgercc","sachannel");
-        
+    @Test
+    public void TestLedgers() {
+        InvokeHelper helper = InvokeHelper.newHelper("ledgercc", "sachannel");
+
         String text = helper.invoke("org1", "accessLedgers");
         assertThat(text, containsString("success"));
-
     }
-
 }
diff --git a/...t/src/test/java/org/hyperleder/fabric/shim/integration/shimtests/SACCIntegrationTest.java b/...t/src/test/java/org/hyperleder/fabric/shim/integration/shimtests/SACCIntegrationTest.java
@@ -4,43 +4,39 @@
 SPDX-License-Identifier: Apache-2.0
 */
 package org.hyperleder.fabric.shim.integration.shimtests;
-import static org.hamcrest.core.StringContains.containsString;
+
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.StringContains.containsString;
 
 import org.hyperleder.fabric.shim.integration.util.FabricState;
 import org.hyperleder.fabric.shim.integration.util.InvokeHelper;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
-/**
- * Basic Java Chaincode Test
- *
- */
+/** Basic Java Chaincode Test */
 public class SACCIntegrationTest {
 
     @BeforeAll
     public static void setUp() throws Exception {
-        FabricState.getState().start();       
-
+        FabricState.getState().start();
     }
 
-   @Test
-    public void TestLedger(){
+    @Test
+    public void TestLedger() {
 
         InvokeHelper helper = InvokeHelper.newHelper("shimcc", "sachannel");
         String text = helper.invoke("org1", "putBulkStates");
         assertThat(text, containsString("success"));
-        
-        text = helper.invoke("org1", "getByRange","key120","key170");
+
+        text = helper.invoke("org1", "getByRange", "key120", "key170");
         assertThat(text, containsString("50"));
 
-        text = helper.invoke("org1", "getByRangePaged","key120","key170","10","");
+        text = helper.invoke("org1", "getByRangePaged", "key120", "key170", "10", "");
         System.out.println(text);
         assertThat(text, containsString("key130"));
 
         text = helper.invoke("org1", "getMetricsProviderName");
         System.out.println(text);
         assertThat(text, containsString("org.hyperledger.fabric.metrics.impl.DefaultProvider"));
     }
-
 }
diff --git a/.../src/test/java/org/hyperleder/fabric/shim/integration/shimtests/SBECCIntegrationTest.java b/.../src/test/java/org/hyperleder/fabric/shim/integration/shimtests/SBECCIntegrationTest.java
@@ -5,9 +5,9 @@
 */
 package org.hyperleder.fabric.shim.integration.shimtests;
 
-import static org.hamcrest.core.StringContains.containsString;
-import static org.hamcrest.Matchers.not; 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.not;
+import static org.hamcrest.core.StringContains.containsString;
 
 import org.hyperleder.fabric.shim.integration.util.FabricState;
 import org.hyperleder.fabric.shim.integration.util.InvokeHelper;
@@ -19,8 +19,6 @@ public class SBECCIntegrationTest {
     @BeforeAll
     public static void setUp() throws Exception {
         FabricState.getState().start();
-
-
     }
 
     @Test
@@ -61,7 +59,6 @@ public void RunSBE_pub_setget() {
         assertThat(text, containsString("org2MSP"));
         assertThat(text, containsString("org1MSP"));
 
-
         text = helper.invoke("org1", "EndorsementCC:setval", mode, "val3");
         assertThat(text, containsString("success"));
 
@@ -85,10 +82,9 @@ public void RunSBE_pub_setget() {
         assertThat(text, containsString("success"));
         text = helper.invoke("org1", "EndorsementCC:recordExists", mode);
         assertThat(text, containsString("false"));
-
     }
 
-   @Test
+    @Test
     public void RunSBE_priv() {
         final String mode = "priv";
 
@@ -126,7 +122,6 @@ public void RunSBE_priv() {
         text = helper.invoke("org1", "EndorsementCC:listorgs", mode);
         assertThat(text, containsString("org2MSP"));
         assertThat(text, containsString("org1MSP"));
-
 
         text = helper.invoke("org1", "EndorsementCC:setval", mode, "val3");
         assertThat(text, containsString("success"));
@@ -151,7 +146,5 @@ public void RunSBE_priv() {
         assertThat(text, containsString("success"));
         text = helper.invoke("org1", "EndorsementCC:recordExists", mode);
         assertThat(text, containsString("false"));
-
     }
-
 }