Apply code formatting and upgrade spotless tooling

cowwoc · cowwoc · commit 68303248ced8 · 2025-10-29T14:02:54.000-04:00
- Upgrade spotless-maven-plugin from 2.44.5 to 3.0.0 - Upgrade palantir-java-format from 2.56.0 to 2.81.0 for Java 25 support - Run mvn spotless:apply to format code Addresses review feedback on PR #395.
diff --git a/pom.xml b/pom.xml
@@ -64,6 +64,7 @@ under the License.
     <minimalMavenBuildVersion>3.9.0</minimalMavenBuildVersion>
     <minimalJavaBuildVersion>11</minimalJavaBuildVersion>
     <classWorldsVersion>2.6.0</classWorldsVersion>
+    <version.spotless-maven-plugin>3.0.0</version.spotless-maven-plugin>
 
     <!-- default maven version, will be overridden by maven3 profile -->
     <mavenVersion>4.0.0-alpha-8</mavenVersion>
@@ -427,6 +428,17 @@ under the License.
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
+        <configuration>
+          <java>
+            <palantirJavaFormat>
+              <version>2.81.0</version>
+            </palantirJavaFormat>
+          </java>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 
diff --git a/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java b/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java
@@ -178,13 +178,13 @@ public void execute(
                 } else {
                     // Validation-time events must exist for cache storage
                     // If they don't exist, this indicates a bug in the capture logic
-                    if (result.getValidationTimeEvents() == null || result.getValidationTimeEvents().isEmpty()) {
+                    if (result.getValidationTimeEvents() == null
+                            || result.getValidationTimeEvents().isEmpty()) {
                         throw new AssertionError(
                                 "Validation-time properties not captured for project " + projectName
                                         + ". This is a bug - validation-time capture should always succeed when saving to cache.");
                     }
-                    LOGGER.debug(
-                            "Using validation-time properties for cache storage (consistent lifecycle point)");
+                    LOGGER.debug("Using validation-time properties for cache storage (consistent lifecycle point)");
                     cacheController.save(result, mojoExecutions, result.getValidationTimeEvents());
                 }
             }
diff --git a/src/main/java/org/apache/maven/buildcache/CacheResult.java b/src/main/java/org/apache/maven/buildcache/CacheResult.java
@@ -36,7 +36,11 @@ public class CacheResult {
     private final CacheContext context;
     private final Map<String, MojoExecutionEvent> validationTimeEvents;
 
-    private CacheResult(RestoreStatus status, Build build, CacheContext context, Map<String, MojoExecutionEvent> validationTimeEvents) {
+    private CacheResult(
+            RestoreStatus status,
+            Build build,
+            CacheContext context,
+            Map<String, MojoExecutionEvent> validationTimeEvents) {
         this.status = requireNonNull(status);
         this.build = build;
         this.context = context;
@@ -63,7 +67,8 @@ public static CacheResult failure(Build build, CacheContext context) {
         return new CacheResult(RestoreStatus.FAILURE, build, context, null);
     }
 
-    public static CacheResult failure(Build build, CacheContext context, Map<String, MojoExecutionEvent> validationTimeEvents) {
+    public static CacheResult failure(
+            Build build, CacheContext context, Map<String, MojoExecutionEvent> validationTimeEvents) {
         requireNonNull(build);
         requireNonNull(context);
         return new CacheResult(RestoreStatus.FAILURE, build, context, validationTimeEvents);
@@ -75,7 +80,8 @@ public static CacheResult success(Build build, CacheContext context) {
         return new CacheResult(RestoreStatus.SUCCESS, build, context, null);
     }
 
-    public static CacheResult success(Build build, CacheContext context, Map<String, MojoExecutionEvent> validationTimeEvents) {
+    public static CacheResult success(
+            Build build, CacheContext context, Map<String, MojoExecutionEvent> validationTimeEvents) {
         requireNonNull(build);
         requireNonNull(context);
         return new CacheResult(RestoreStatus.SUCCESS, build, context, validationTimeEvents);
@@ -87,7 +93,8 @@ public static CacheResult partialSuccess(Build build, CacheContext context) {
         return new CacheResult(RestoreStatus.PARTIAL, build, context, null);
     }
 
-    public static CacheResult partialSuccess(Build build, CacheContext context, Map<String, MojoExecutionEvent> validationTimeEvents) {
+    public static CacheResult partialSuccess(
+            Build build, CacheContext context, Map<String, MojoExecutionEvent> validationTimeEvents) {
         requireNonNull(build);
         requireNonNull(context);
         return new CacheResult(RestoreStatus.PARTIAL, build, context, validationTimeEvents);
diff --git a/src/test/java/org/apache/maven/buildcache/its/ExplicitModuleVersionTest.java b/src/test/java/org/apache/maven/buildcache/its/ExplicitModuleVersionTest.java
@@ -61,8 +61,7 @@ void testExplicitModuleVersionCacheRestoration(Verifier verifier) throws Verific
 
         // Verify compilation succeeded
         verifier.verifyFilePresent("target/classes/module-info.class");
-        verifier.verifyFilePresent(
-                "target/classes/org/apache/maven/caching/test/explicit/ExplicitVersionModule.class");
+        verifier.verifyFilePresent("target/classes/org/apache/maven/caching/test/explicit/ExplicitVersionModule.class");
 
         // Second build - should restore from cache
         verifier.setLogFileName("../log-build-2.txt");
@@ -79,7 +78,6 @@ void testExplicitModuleVersionCacheRestoration(Verifier verifier) throws Verific
 
         // Verify output files were restored from cache
         verifier.verifyFilePresent("target/classes/module-info.class");
-        verifier.verifyFilePresent(
-                "target/classes/org/apache/maven/caching/test/explicit/ExplicitVersionModule.class");
+        verifier.verifyFilePresent("target/classes/org/apache/maven/caching/test/explicit/ExplicitVersionModule.class");
     }
 }
diff --git a/src/test/java/org/apache/maven/buildcache/its/Maven4JpmsModuleTest.java b/src/test/java/org/apache/maven/buildcache/its/Maven4JpmsModuleTest.java
@@ -66,8 +66,7 @@ void testMaven4JpmsModuleCacheRestoration(Verifier verifier) throws Verification
 
         // Verify compilation succeeded
         verifier.verifyFilePresent("target/classes/module-info.class");
-        verifier.verifyFilePresent(
-                "target/classes/org/apache/maven/caching/test/maven4/HelloMaven4.class");
+        verifier.verifyFilePresent("target/classes/org/apache/maven/caching/test/maven4/HelloMaven4.class");
 
         // Second build - should restore from cache WITHOUT invalidation
         // This is the critical test: validation-time properties should match stored properties
@@ -85,7 +84,6 @@ void testMaven4JpmsModuleCacheRestoration(Verifier verifier) throws Verification
 
         // Verify output files were restored from cache
         verifier.verifyFilePresent("target/classes/module-info.class");
-        verifier.verifyFilePresent(
-                "target/classes/org/apache/maven/caching/test/maven4/HelloMaven4.class");
+        verifier.verifyFilePresent("target/classes/org/apache/maven/caching/test/maven4/HelloMaven4.class");
     }
 }
diff --git a/src/test/java/org/apache/maven/buildcache/its/MultiModuleJpmsTest.java b/src/test/java/org/apache/maven/buildcache/its/MultiModuleJpmsTest.java
@@ -59,12 +59,10 @@ void testMultiModuleJpmsCacheRestoration(Verifier verifier) throws VerificationE
 
         // Verify compilation succeeded for module-a (JPMS)
         verifier.verifyFilePresent("module-a/target/classes/module-info.class");
-        verifier.verifyFilePresent(
-                "module-a/target/classes/org/apache/maven/caching/test/multi/modulea/ModuleA.class");
+        verifier.verifyFilePresent("module-a/target/classes/org/apache/maven/caching/test/multi/modulea/ModuleA.class");
 
         // Verify compilation succeeded for module-b (non-JPMS)
-        verifier.verifyFilePresent(
-                "module-b/target/classes/org/apache/maven/caching/test/multi/moduleb/ModuleB.class");
+        verifier.verifyFilePresent("module-b/target/classes/org/apache/maven/caching/test/multi/moduleb/ModuleB.class");
 
         // Second build - should restore all modules from cache
         verifier.setLogFileName("../log-build-2.txt");
@@ -83,11 +81,9 @@ void testMultiModuleJpmsCacheRestoration(Verifier verifier) throws VerificationE
 
         // Verify output files were restored from cache for module-a
         verifier.verifyFilePresent("module-a/target/classes/module-info.class");
-        verifier.verifyFilePresent(
-                "module-a/target/classes/org/apache/maven/caching/test/multi/modulea/ModuleA.class");
+        verifier.verifyFilePresent("module-a/target/classes/org/apache/maven/caching/test/multi/modulea/ModuleA.class");
 
         // Verify output files were restored from cache for module-b
-        verifier.verifyFilePresent(
-                "module-b/target/classes/org/apache/maven/caching/test/multi/moduleb/ModuleB.class");
+        verifier.verifyFilePresent("module-b/target/classes/org/apache/maven/caching/test/multi/moduleb/ModuleB.class");
     }
 }
diff --git a/src/test/java/org/apache/maven/buildcache/its/NonJpmsProjectTest.java b/src/test/java/org/apache/maven/buildcache/its/NonJpmsProjectTest.java
@@ -59,8 +59,7 @@ void testNonJpmsProjectCacheRestoration(Verifier verifier) throws VerificationEx
         verifier.verifyErrorFreeLog();
 
         // Verify compilation succeeded
-        verifier.verifyFilePresent(
-                "target/classes/org/apache/maven/caching/test/nonjpms/RegularJavaClass.class");
+        verifier.verifyFilePresent("target/classes/org/apache/maven/caching/test/nonjpms/RegularJavaClass.class");
 
         // Second build - should restore from cache
         verifier.setLogFileName("../log-build-2.txt");
@@ -76,7 +75,6 @@ void testNonJpmsProjectCacheRestoration(Verifier verifier) throws VerificationEx
         verifier.verifyTextInLog("Skipping plugin execution (cached): compiler:compile");
 
         // Verify output files were restored from cache
-        verifier.verifyFilePresent(
-                "target/classes/org/apache/maven/caching/test/nonjpms/RegularJavaClass.class");
+        verifier.verifyFilePresent("target/classes/org/apache/maven/caching/test/nonjpms/RegularJavaClass.class");
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -178,13 +178,13 @@ public void execute(`
`178`	`178`	`} else {`
`179`	`179`	`// Validation-time events must exist for cache storage`
`180`	`180`	`// If they don't exist, this indicates a bug in the capture logic`
`181`		`- if (result.getValidationTimeEvents() == null \|\| result.getValidationTimeEvents().isEmpty()) {`
	`181`	`+ if (result.getValidationTimeEvents() == null`
	`182`	`+ \|\| result.getValidationTimeEvents().isEmpty()) {`
`182`	`183`	`throw new AssertionError(`
`183`	`184`	`"Validation-time properties not captured for project " + projectName`
`184`	`185`	`+ ". This is a bug - validation-time capture should always succeed when saving to cache.");`
`185`	`186`	`}`
`186`		`- LOGGER.debug(`
`187`		`- "Using validation-time properties for cache storage (consistent lifecycle point)");`
	`187`	`+ LOGGER.debug("Using validation-time properties for cache storage (consistent lifecycle point)");`
`188`	`188`	`cacheController.save(result, mojoExecutions, result.getValidationTimeEvents());`
`189`	`189`	`}`
`190`	`190`	`}`