chore: porting over graal and picocli configuration

Author: simschla

app/build.gradle

@@ -5,8 +5,9 @@
  */
 
 plugins {
-	id 'buildlogic.java-application-conventions'
+	id 'buildlogic.picocli-conventions'
 	id 'buildlogic.java-special-tests-conventions'
+	id 'buildlogic.java-graalvm-conventions'
 }
 
 dependencies {
@@ -15,11 +16,37 @@ dependencies {
 	testImplementation project(':testlib')
 	implementation libs.bundles.spotless.libs
 
-	implementation libs.picocli
-	annotationProcessor libs.picocli.codegen
+	implementation libs.bundles.native.includes
 }
 
 application {
-	// Define the main class for the application.
-	mainClass = 'org.example.app.App'
+	mainClass = 'com.diffplug.spotless.cli.SpotlessCLI'
+	applicationName = 'spotless'
+	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.outputs.dir(nativeCompileMetaDir)
+		if (project.hasProperty('agent')) {
+			it.inputs.property('agent', project.property('agent')) // make sure to re-run tests if agent changes
+		}
+	}
+	if (it.name == 'testCliProcess' || it.name == 'testCliProcessNpm') {
+		it.dependsOn('shadowJar')
+		it.systemProperty 'spotless.cli.shadowJar', tasks.shadowJar.archiveFile.get().asFile
+	}
+	if (it.name == 'testCliNative' || it.name == 'testCliNativeNpm') {
+		it.dependsOn('nativeCompile')
+		it.systemProperty 'spotless.cli.nativeImage', tasks.nativeCompile.outputFile.get().asFile
+	}
 }

build-logic/build.gradle

@@ -16,6 +16,10 @@ repositories {
 	mavenCentral()
 }
 
+dependencies {
+	implementation 'com.gradleup.shadow:shadow-gradle-plugin:8.3.6'
+}
+
 spotless {
 	encoding 'UTF-8'
 

build-logic/settings.gradle

@@ -7,8 +7,10 @@
 plugins {
 	// https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md
 	id 'com.diffplug.spotless' version '7.0.2' apply false
-}
 
+	// https://github.com/GradleUp/shadow/releases
+	id 'com.gradleup.shadow' version '8.3.6' apply false
+}
 
 dependencyResolutionManagement {
 	// Reuse version catalog from the main build.

build-logic/src/main/groovy/buildlogic.changelog-conventions.gradle

@@ -2,7 +2,8 @@ plugins {
 	id 'com.diffplug.spotless-changelog'
 }
 
-
 spotlessChangelog {
 	appendDashSnapshotUnless_dashPrelease=true
 }
+
+version = spotlessChangelog.versionNext

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

@@ -0,0 +1,3 @@
+plugins {
+	id 'com.gradleup.shadow'
+}

build-logic/src/main/groovy/buildlogic.java-common-conventions.gradle

@@ -35,7 +35,7 @@ testing {
 		// Configure the built-in test suite
 		test {
 			// Use JUnit Jupiter test framework
-			useJUnitJupiter('5.11.1')
+			useJUnitJupiter(libs.versions.junit)
 		}
 	}
 }

build-logic/src/main/groovy/buildlogic.java-graalvm-conventions.gradle

@@ -0,0 +1,72 @@
+plugins {
+	id 'java'
+	id 'org.graalvm.buildtools.native'
+	id 'buildlogic.jar-shadow-conventions'
+}
+
+
+def nativeCompileMetaDir = project.layout.buildDirectory.dir('nativeCompile/src/main/resources/native-image/' + project.group + '/' + project.name)
+
+// use tasks 'nativeCompile' and 'nativeRun' to compile and run the native image
+graalvmNative {
+	agent {
+		enabled = !project.hasProperty('skipGraalAgent') // we would love to make this dynamic, but it's not possible
+		defaultMode = "standard"
+		metadataCopy {
+			inputTaskNames.add('test')
+			inputTaskNames.add('testNpm')
+			mergeWithExisting = false
+			outputDirectories.add(nativeCompileMetaDir.get().asFile.path)
+		}
+		tasksToInstrumentPredicate = new java.util.function.Predicate<Task>() {
+					@Override
+					boolean test(Task task) {
+						//						if (project.hasProperty('agent')) {
+						println ("Instrumenting task: " + task.name + " " + task.name == 'test' + "proj: " + task.project.hasProperty('agent'))
+						return task.name == 'test' || task.name == 'testNpm'
+						//						}
+						//						return false
+					}
+				}
+	}
+	binaries {
+		main {
+			imageName = 'spotless'
+			mainClass = 'com.diffplug.spotless.cli.SpotlessCLI'
+			sharedLibrary = false
+			useFatJar = true // use shadowJar as input to have same classpath
+
+			// optimizations, see https://www.graalvm.org/latest/reference-manual/native-image/optimizations-and-performance/
+			//buildArgs.add('-O3') // on production builds
+
+			// the following options are required for GJF
+			// see: <https://github.com/google/google-java-format/issues/894#issuecomment-1430408909>
+			buildArgs.add('-J--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED')
+			buildArgs.add('-J--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED')
+			buildArgs.add('-J--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED')
+			buildArgs.add('-J--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED')
+			buildArgs.add('-J--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED')
+
+			buildArgs.add('--initialize-at-build-time=com.sun.tools.javac.file.Locations')
+
+			buildArgs.add('-H:IncludeResourceBundles=com.sun.tools.javac.resources.compiler')
+			buildArgs.add('-H:IncludeResourceBundles=com.sun.tools.javac.resources.javac')
+		}
+	}
+}
+
+tasks.named('metadataCopy') {
+	dependsOn('test', 'testNpm')
+}
+
+tasks.named('nativeCompile') {
+	dependsOn('shadowJar')
+	classpathJar = tasks.shadowJar.archiveFile.get().asFile
+}
+
+tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) {
+	dependsOn('metadataCopy') // produces graalvm agent info
+	from(nativeCompileMetaDir.get().asFile.path) {
+		into('META-INF/native-image/' + project.group + '/' + project.name)
+	}
+}

build-logic/src/main/groovy/buildlogic.java-special-tests-conventions.gradle

@@ -1,32 +1,33 @@
 plugins {
-    id 'java'
-    id 'com.adarshr.test-logger'
+	id 'java'
+	id 'com.adarshr.test-logger'
 }
 
 // See com.diffplug.spotless.tag package for available JUnit 5 @Tag annotations
 def special = [
-        'cliProcess',
-        'cliProcessNpm',
-        'cliNative',
-        'cliNativeNpm'
+	'npm',
+	'cliProcess',
+	'cliProcessNpm',
+	'cliNative',
+	'cliNativeNpm'
 ]
 
 tasks.named('test').configure {
-    useJUnitPlatform {
-        excludeTags special as String[]
-    }
+	useJUnitPlatform {
+		excludeTags special as String[]
+	}
 }
 
 special.forEach { tag ->
-    tasks.register("test${tag.capitalize()}", Test) {
-        useJUnitPlatform { includeTags tag }
-    }
+	tasks.register("test${tag.capitalize()}", Test) {
+		useJUnitPlatform { includeTags tag }
+	}
 }
 
 tasks.register('testAll') {
-    dependsOn tasks.matching { it.name.startsWith('test') && it.name != 'testAll' }
+	dependsOn tasks.matching { it.name.startsWith('test') && it.name != 'testAll' }
 }
 
 tasks.withType(Test).configureEach {
-    testLogging.showStandardStreams = true
-}
+	testLogging.showStandardStreams = true
+}

build-logic/src/main/groovy/buildlogic.picocli-conventions.gradle

@@ -0,0 +1,43 @@
+plugins {
+	id 'buildlogic.java-application-conventions'
+}
+
+dependencies {
+	implementation libs.picocli
+	annotationProcessor libs.picocli.codegen
+}
+
+compileJava {
+	// options for picocli codegen
+	// https://github.com/remkop/picocli/tree/main/picocli-codegen#222-other-options
+	options.compilerArgs += [
+		"-Aproject=${project.group}/${project.name}",
+		"-Aother.resource.bundles=application",
+		// patterns require double-escaping (one escape is removed by groovy, the other one is needed in the resulting json file)
+		"-Aother.resource.patterns=.*\\\\.properties,.*\\\\.json,.*\\\\.js"
+	]
+}
+
+tasks.withType(ProcessResources).configureEach(new ApplicationPropertiesProcessResourcesAction(project.version))
+
+class ApplicationPropertiesProcessResourcesAction implements Action<ProcessResources> {
+
+	private final String cliVersion
+
+	ApplicationPropertiesProcessResourcesAction(String cliVersion) {
+		this.cliVersion = cliVersion
+	}
+
+	@Override
+	void execute(ProcessResources processResources) {
+		def localCliVersion = cliVersion // prevent issues with decorated closure
+		processResources.filesMatching("application.properties") {
+			filter(
+					org.apache.tools.ant.filters.ReplaceTokens,
+					tokens: [
+						'cli.version': localCliVersion
+					]
+					)
+		}
+	}
+}

gradle/libs.versions.toml

@@ -6,6 +6,7 @@ annotations = "26.0.2"
 assertj-core = "3.27.3"
 durian = "1.2.0"
 junit = "5.8.1"
+native-include-googleJavaFormat = "1.24.0"
 picocli = "4.7.6"
 spotless-lib = "3.0.2-SNAPSHOT"
 
@@ -17,6 +18,7 @@ durian-io = { module = "com.diffplug.durian:durian-io", version.ref = "durian" }
 durian-collect = { module = "com.diffplug.durian:durian-collect", version.ref = "durian" }
 junit-jupiter-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" }
 junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit" }
+native-include-googleJavaFormat = { module = "com.google.googlejavaformat:google-java-format", version.ref = "native-include-googleJavaFormat" }
 picocli = { module = "info.picocli:picocli", version.ref = "picocli" }
 picocli-codegen = { module = "info.picocli:picocli-codegen", version.ref = "picocli" }
 spotless-lib = { module = "com.diffplug.spotless:spotless-lib", version.ref = "spotless-lib" }
@@ -25,3 +27,6 @@ spotless-lib-extra = { module = "com.diffplug.spotless:spotless-lib-extra", vers
 [bundles]
 spotless-libs = ["spotless-lib", "spotless-lib-extra"]
 durian-libs = ["durian-core", "durian-io", "durian-collect"]
+native-includes = [
+    "native-include-googleJavaFormat"
+]