chore: move testing to use application dist instead of shadow jar

Author: simschla

.idea/misc.xml

@@ -0,0 +1 @@
+21

.java-version

@@ -5,7 +5,6 @@ import org.gradle.plugins.ide.eclipse.model.EclipseWtp
 plugins {
 	id 'buildlogic.picocli-conventions'
 	id 'buildlogic.java-special-tests-conventions'
-	id 'buildlogic.jar-shadow-conventions'
 	id 'buildlogic.spotless-json-conventions'
 }
 
@@ -41,25 +40,30 @@ application {
 	archivesBaseName = 'spotless-cli'
 }
 
-gradle.taskGraph.whenReady { TaskExecutionGraph graph ->
-	//	println "Graph: " + graph.allTasks*.name
-	if (graph.hasTask(':app:nativeCompile') || graph.hasTask(':app:metadataCopy') || graph.hasTask(':app:shadowJar')) {
-		// enable graalvm agent using property here instead of command line `-Pagent=standard`
-		// this collects information about reflective access and resources used by the application (e.g. GJF)
-		project.ext.agent = 'standard'
-	}
-}
-
 tasks.withType(Test).configureEach {
 	if (it.name == 'test' || it.name == 'testNpm' || it.name == 'testSeparateJvm') {
 		it.systemProperty 'spotless.cli.inSameThread', 'true' //mark tests
 	}
 	if (it.name == 'testCliProcess' || it.name == 'testCliProcessNpm') {
-		it.dependsOn('shadowJar')
-		it.systemProperty 'spotless.cli.shadowJar', tasks.shadowJar.archiveFile.get().asFile
+		def taskInstallDist = tasks.named('installDist', org.gradle.api.tasks.Sync)
+		it.dependsOn(taskInstallDist) //ensure the CLI is built before running tests
+		it.systemProperty 'spotless.cli.processLauncher', processLauncherPathIninstallDist(taskInstallDist.get()) //pass the path to the CLI launcher
+
+		def toolchains = project.extensions.getByType(JavaToolchainService)
+		def launcher   = toolchains.launcherFor(java.toolchain).get()
+		def javaHome = launcher.metadata.installationPath.asFile
+
+		it.systemProperty 'spotless.cli.processLauncher.javaHome', javaHome.absolutePath //pass the path to the JDK to use
 	}
 }
 
+def processLauncherPathIninstallDist(org.gradle.api.tasks.Sync installDistTask) {
+	def binaryPath = installDistTask.destinationDir.absolutePath + "/bin/spotless"
+	def suffix = System.getProperty("os.name").toLowerCase().contains("windows") ? ".bat" : ""
+	println("Using spotless CLI launcher at: " + binaryPath + suffix)
+	return binaryPath + suffix
+}
+
 tasks.register("generateUsage", GenerateUsagePropertiesTask) {
 	it.outputDir.set(layout.buildDirectory.dir("generated-usages").get().asFile)
 }

app/build.gradle

@@ -17,7 +17,6 @@ repositories {
 }
 
 dependencies {
-	implementation 'com.gradleup.shadow:shadow-gradle-plugin:8.3.6'
 	implementation libs.bundles.spotless.libs
 	implementation libs.spotless.plugin.gradle
 }

build-logic/build.gradle

@@ -1,4 +1,4 @@
-
+// TODO: remove this completely once we fully migrate to JReleaser java-binary for packaging
 File releaseBinariesRootDir = rootProject.file(project.findProperty('releaseBinariesRootDir') ?: 'app/build/release-binaries')
 def releaseBinariesSubdirectories = [] as List<File>
 File releaseBinariesZipDir = rootProject.file('app/build/prepared-release-zips')

build-logic/src/main/groovy/buildlogic.jar-shadow-conventions.gradle

@@ -26,15 +26,12 @@
 
 @EnabledIf("testEnvIsMatching")
 public abstract class CLIIntegrationHarness extends ResourceHarness {
-    protected static final String SYSPROP_CLI_NATIVE =
-            SpotlessCLIRunnerInNativeExternalProcess.SPOTLESS_CLI_NATIVE_IMAGE_SYSPROP;
-    protected static final String SYSPROP_CLI_SHADOW_JAR =
-            SpotlessCLIRunnerInExternalJavaProcess.SPOTLESS_CLI_SHADOW_JAR_SYSPROP;
+    protected static final String SPOTLESS_CLI_PROCESS_LAUNCHER =
+            SpotlessCLIRunnerInExternalJavaProcess.SPOTLESS_CLI_PROCESS_LAUNCHER;
     protected static final String SYSPROP_CLI_IN_SAME_THREAD =
             SpotlessCLIRunnerInSameThread.SPOTLESS_CLI_IN_SAME_THREAD;
 
-    protected static final Set<String> SYS_PROPS =
-            Set.of(SYSPROP_CLI_NATIVE, SYSPROP_CLI_SHADOW_JAR, SYSPROP_CLI_IN_SAME_THREAD);
+    protected static final Set<String> SYS_PROPS = Set.of(SPOTLESS_CLI_PROCESS_LAUNCHER, SYSPROP_CLI_IN_SAME_THREAD);
 
     /**
      * Each test gets its own temp folder, and we create a gradle
@@ -60,10 +57,7 @@ protected SpotlessCLIRunner cliRunner() {
     }
 
     protected SpotlessCLIRunner createRunnerBasedOnSysprop() {
-        if (System.getProperties().containsKey(SYSPROP_CLI_NATIVE)) {
-            return SpotlessCLIRunner.createNative();
-        }
-        if (System.getProperties().containsKey(SYSPROP_CLI_SHADOW_JAR)) {
+        if (System.getProperties().containsKey(SPOTLESS_CLI_PROCESS_LAUNCHER)) {
             return SpotlessCLIRunner.createExternalProcess();
         }
         if (System.getProperties().containsKey(SYSPROP_CLI_IN_SAME_THREAD)) {
@@ -77,7 +71,7 @@ static boolean testEnvIsMatching() {
     }
 
     protected static boolean isInExternalProcess() {
-        return Stream.of(SYSPROP_CLI_NATIVE, SYSPROP_CLI_SHADOW_JAR)
+        return Stream.of(SPOTLESS_CLI_PROCESS_LAUNCHER)
                 .anyMatch(p -> System.getProperties().containsKey(p));
     }
 

build-logic/src/main/groovy/buildlogic.release-prepare-packages-conventions.gradle

@@ -15,47 +15,82 @@
  */
 package com.diffplug.spotless.cli;
 
+import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
+import java.util.Optional;
 
 import com.diffplug.spotless.ProcessRunner;
 import com.diffplug.spotless.ThrowingEx;
 
 public class SpotlessCLIRunnerInExternalJavaProcess extends SpotlessCLIRunner {
 
-    static final String SPOTLESS_CLI_SHADOW_JAR_SYSPROP = "spotless.cli.shadowJar";
+    static final String SPOTLESS_CLI_PROCESS_LAUNCHER = "spotless.cli.processLauncher";
+    static final String SPOTLESS_CLI_PROCESS_LAUNCHER_JAVA_HOME = "spotless.cli.processLauncher.javaHome"; // optional
 
     public SpotlessCLIRunnerInExternalJavaProcess() {
         super();
-        if (System.getProperty(SPOTLESS_CLI_SHADOW_JAR_SYSPROP) == null) {
+        if (System.getProperty(SPOTLESS_CLI_PROCESS_LAUNCHER) == null) {
             throw new IllegalStateException(
-                    "spotless.cli.shadowJar system property must be set to the path of the shadow jar");
+                    SPOTLESS_CLI_PROCESS_LAUNCHER + " system property must be set to the path of the launcher");
         }
     }
 
     protected Result executeCommand(List<String> args) {
         try (ProcessRunner runner = new ProcessRunner()) {
 
             ProcessRunner.Result pResult =
-                    ThrowingEx.get(() -> runner.exec(workingDir(), System.getenv(), null, processArgs(args)));
+                    ThrowingEx.get(() -> runner.exec(workingDir(), envWithCurrentJava(), null, processArgs(args)));
 
             return new Result(pResult.exitCode(), null, pResult.stdOutUtf8(), pResult.stdErrUtf8());
         }
     }
 
     private List<String> processArgs(List<String> args) {
         List<String> processArgs = new ArrayList<>();
-        processArgs.add(currentJavaExecutable());
-        processArgs.add("-jar");
-        String jarPath = System.getProperty(SPOTLESS_CLI_SHADOW_JAR_SYSPROP);
-        processArgs.add(jarPath);
-
-        //		processArgs.add(SpotlessCLI.class.getProtectionDomain().getCodeSource().getLocation().getPath());
-
+        processArgs.add(System.getProperty(SPOTLESS_CLI_PROCESS_LAUNCHER));
         processArgs.addAll(args);
         return processArgs;
     }
 
+    private Map<String, String> envWithCurrentJava() {
+        // put current java
+        Map<String, String> env = new LinkedHashMap<>(System.getenv());
+
+        // Override JAVA_HOME if specified via sysprop or use current java
+        Optional<String> javaHomeOpt = javaHomeFromSyspropOrCurrent();
+        javaHomeOpt.ifPresentOrElse(javaHome -> env.put("JAVA_HOME", javaHome), () -> env.remove("JAVA_HOME"));
+
+        // Prepend current java bin to PATH
+        String currentJavaBin = currentJavaExecutable();
+        if (!"java".equals(currentJavaBin)) {
+            String currentJavaDir = Path.of(currentJavaBin).getParent().toString();
+            String currentPath = env.get("PATH");
+            if (currentPath == null || currentPath.isEmpty()) {
+                currentPath = currentJavaDir;
+            } else {
+                currentPath = currentJavaDir + System.getProperty("path.separator") + currentPath;
+            }
+            env.put("PATH", currentPath);
+        }
+        return env;
+    }
+
+    private Optional<String> javaHomeFromSyspropOrCurrent() {
+        String javaHome = System.getProperty(SPOTLESS_CLI_PROCESS_LAUNCHER_JAVA_HOME);
+        if (javaHome != null && !javaHome.isEmpty()) {
+            return Optional.of(javaHome);
+        }
+        String currentJavaBin = currentJavaExecutable();
+        if ("java".equals(currentJavaBin)) {
+            return Optional.empty(); // unset
+        }
+
+        return Optional.of(Path.of(currentJavaBin).getParent().getParent().toString());
+    }
+
     private String currentJavaExecutable() {
         return ProcessHandle.current().info().command().orElse("java");
     }