Implement extract and list-layers command

Adds a new jarmode called 'tools'. This provides two commands,
'extract' and 'list-layers'. list-layers is the same as list from
the layertools.

extract is able to extract the JAR in four different modes:

- CDS compatible extraction with libraries in a lib folder and a runner
.jar
- CDS compatible as above, but with layers
- Launcher based
- Launcher based with layers. This is essentially the same as extract
  from the layertools

The commands in layertools have been deprecated in favor of the commands
in 'tools'.

This also changes the behavior of layers.enabled from the Gradle and
Maven plugin: before this commit, layers.enabled prevents the inclusion
of the layer index file as well as the layertools JAR.
After this commit, layers.enabled only prevents the inclusion of the
layer index file.

layer.includeLayerTools have been deprecated in favor of includeTools,
and the layertools JAR has been renamed to tools.

Closes gh-38276

Author: mhalbritter

settings.gradle

@@ -57,7 +57,7 @@ include "spring-boot-project:spring-boot-tools:spring-boot-configuration-metadat
 include "spring-boot-project:spring-boot-tools:spring-boot-configuration-processor"
 include "spring-boot-project:spring-boot-tools:spring-boot-gradle-plugin"
 include "spring-boot-project:spring-boot-tools:spring-boot-gradle-test-support"
-include "spring-boot-project:spring-boot-tools:spring-boot-jarmode-layertools"
+include "spring-boot-project:spring-boot-tools:spring-boot-jarmode-tools"
 include "spring-boot-project:spring-boot-tools:spring-boot-loader"
 include "spring-boot-project:spring-boot-tools:spring-boot-loader-classic"
 include "spring-boot-project:spring-boot-tools:spring-boot-loader-tools"

spring-boot-project/spring-boot-dependencies/build.gradle

@@ -1612,7 +1612,7 @@ bom {
 				"spring-boot-configuration-processor",
 				"spring-boot-devtools",
 				"spring-boot-docker-compose",
-				"spring-boot-jarmode-layertools",
+				"spring-boot-jarmode-tools",
 				"spring-boot-loader",
 				"spring-boot-loader-classic",
 				"spring-boot-loader-tools",

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootArchive.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,6 +39,7 @@
  * A Spring Boot "fat" archive task.
  *
  * @author Andy Wilkinson
+ * @author Moritz Halbritter
  * @since 2.0.0
  */
 public interface BootArchive extends Task {
@@ -144,4 +145,13 @@ public interface BootArchive extends Task {
 	@Optional
 	Property<LoaderImplementation> getLoaderImplementation();
 
+	/**
+	 * Returns whether the JAR tools should be included as a dependency in the layered
+	 * archive.
+	 * @return whether the JAR tools should be included
+	 * @since 3.3.0
+	 */
+	@Input
+	Property<Boolean> getIncludeTools();
+
 }

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootArchiveSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -129,7 +129,7 @@ CopyAction createCopyAction(Jar jar, ResolvedDependencies resolvedDependencies,
 
 	CopyAction createCopyAction(Jar jar, ResolvedDependencies resolvedDependencies,
 			LoaderImplementation loaderImplementation, boolean supportsSignatureFile, LayerResolver layerResolver,
-			String layerToolsLocation) {
+			String jarmodeToolsLocation) {
 		File output = jar.getArchiveFile().get().getAsFile();
 		Manifest manifest = jar.getManifest();
 		boolean preserveFileTimestamps = jar.isPreserveFileTimestamps();
@@ -143,7 +143,7 @@ CopyAction createCopyAction(Jar jar, ResolvedDependencies resolvedDependencies,
 		Function<FileCopyDetails, ZipCompression> compressionResolver = this.compressionResolver;
 		String encoding = jar.getMetadataCharset();
 		CopyAction action = new BootZipCopyAction(output, manifest, preserveFileTimestamps, dirMode, fileMode,
-				includeDefaultLoader, layerToolsLocation, requiresUnpack, exclusions, launchScript, librarySpec,
+				includeDefaultLoader, jarmodeToolsLocation, requiresUnpack, exclusions, launchScript, librarySpec,
 				compressionResolver, encoding, resolvedDependencies, supportsSignatureFile, layerResolver,
 				loaderImplementation);
 		return jar.isReproducibleFileOrder() ? new ReproducibleOrderingCopyAction(action) : action;

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootJar.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -88,6 +88,7 @@ public BootJar() {
 		this.projectName = project.provider(project::getName);
 		this.projectVersion = project.provider(project::getVersion);
 		this.resolvedDependencies = new ResolvedDependencies(project);
+		getIncludeTools().convention(true);
 	}
 
 	private void configureBootInfSpec(CopySpec bootInfSpec) {
@@ -144,13 +145,21 @@ private boolean isLayeredDisabled() {
 	@Override
 	protected CopyAction createCopyAction() {
 		LoaderImplementation loaderImplementation = getLoaderImplementation().getOrElse(LoaderImplementation.DEFAULT);
+		LayerResolver layerResolver = null;
 		if (!isLayeredDisabled()) {
-			LayerResolver layerResolver = new LayerResolver(this.resolvedDependencies, this.layered, this::isLibrary);
-			String layerToolsLocation = this.layered.getIncludeLayerTools().get() ? LIB_DIRECTORY : null;
-			return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, true,
-					layerResolver, layerToolsLocation);
+			layerResolver = new LayerResolver(this.resolvedDependencies, this.layered, this::isLibrary);
 		}
-		return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, true);
+		String jarmodeToolsLocation = isIncludeJarmodeTools() ? LIB_DIRECTORY : null;
+		return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, true, layerResolver,
+				jarmodeToolsLocation);
+	}
+
+	@SuppressWarnings("removal")
+	private boolean isIncludeJarmodeTools() {
+		if (!this.getIncludeTools().get()) {
+			return false;
+		}
+		return this.layered.getIncludeLayerTools().get();
 	}
 
 	@Override

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootWar.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -87,6 +87,7 @@ public BootWar() {
 		this.projectName = project.provider(project::getName);
 		this.projectVersion = project.provider(project::getVersion);
 		this.resolvedDependencies = new ResolvedDependencies(project);
+		getIncludeTools().convention(true);
 	}
 
 	private Object getProvidedLibFiles() {
@@ -118,13 +119,21 @@ private boolean isLayeredDisabled() {
 	@Override
 	protected CopyAction createCopyAction() {
 		LoaderImplementation loaderImplementation = getLoaderImplementation().getOrElse(LoaderImplementation.DEFAULT);
+		LayerResolver layerResolver = null;
 		if (!isLayeredDisabled()) {
-			LayerResolver layerResolver = new LayerResolver(this.resolvedDependencies, this.layered, this::isLibrary);
-			String layerToolsLocation = this.layered.getIncludeLayerTools().get() ? LIB_DIRECTORY : null;
-			return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, false,
-					layerResolver, layerToolsLocation);
+			layerResolver = new LayerResolver(this.resolvedDependencies, this.layered, this::isLibrary);
 		}
-		return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, false);
+		String jarmodeToolsLocation = isIncludeJarmodeTools() ? LIB_DIRECTORY : null;
+		return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, false,
+				layerResolver, jarmodeToolsLocation);
+	}
+
+	@SuppressWarnings("removal")
+	private boolean isIncludeJarmodeTools() {
+		if (!this.getIncludeTools().get()) {
+			return false;
+		}
+		return this.layered.getIncludeLayerTools().get();
 	}
 
 	@Override

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootZipCopyAction.java

@@ -96,7 +96,7 @@ class BootZipCopyAction implements CopyAction {
 
 	private final boolean includeDefaultLoader;
 
-	private final String layerToolsLocation;
+	private final String jarmodeToolsLocation;
 
 	private final Spec<FileTreeElement> requiresUnpack;
 
@@ -119,7 +119,7 @@ class BootZipCopyAction implements CopyAction {
 	private final LoaderImplementation loaderImplementation;
 
 	BootZipCopyAction(File output, Manifest manifest, boolean preserveFileTimestamps, Integer dirMode, Integer fileMode,
-			boolean includeDefaultLoader, String layerToolsLocation, Spec<FileTreeElement> requiresUnpack,
+			boolean includeDefaultLoader, String jarmodeToolsLocation, Spec<FileTreeElement> requiresUnpack,
 			Spec<FileTreeElement> exclusions, LaunchScriptConfiguration launchScript, Spec<FileCopyDetails> librarySpec,
 			Function<FileCopyDetails, ZipCompression> compressionResolver, String encoding,
 			ResolvedDependencies resolvedDependencies, boolean supportsSignatureFile, LayerResolver layerResolver,
@@ -130,7 +130,7 @@ class BootZipCopyAction implements CopyAction {
 		this.dirMode = dirMode;
 		this.fileMode = fileMode;
 		this.includeDefaultLoader = includeDefaultLoader;
-		this.layerToolsLocation = layerToolsLocation;
+		this.jarmodeToolsLocation = jarmodeToolsLocation;
 		this.requiresUnpack = requiresUnpack;
 		this.exclusions = exclusions;
 		this.launchScript = launchScript;
@@ -342,8 +342,8 @@ private boolean isInMetaInf(FileCopyDetails details) {
 		}
 
 		private void writeJarToolsIfNecessary() throws IOException {
-			if (BootZipCopyAction.this.layerToolsLocation != null) {
-				writeJarModeLibrary(BootZipCopyAction.this.layerToolsLocation, JarModeLibrary.LAYER_TOOLS);
+			if (BootZipCopyAction.this.jarmodeToolsLocation != null) {
+				writeJarModeLibrary(BootZipCopyAction.this.jarmodeToolsLocation, JarModeLibrary.TOOLS);
 			}
 		}
 

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/LayeredSpec.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,8 +72,10 @@ public LayeredSpec(ObjectFactory objects) {
 	 * archive.
 	 * @return whether the layer tools should be included
 	 * @since 3.0.0
+	 * @deprecated since 3.3.0 for removal in 3.5.0 in favor of {@code includeTools}.
 	 */
 	@Input
+	@Deprecated(since = "3.3.0", forRemoval = true)
 	public abstract Property<Boolean> getIncludeLayerTools();
 
 	/**

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/AbstractBootArchiveIntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -66,6 +66,7 @@
  * @author Andy Wilkinson
  * @author Madhura Bhave
  * @author Scott Frederick
+ * @author Moritz Halbritter
  */
 abstract class AbstractBootArchiveIntegrationTests {
 
@@ -332,6 +333,18 @@ void notUpToDateWhenBuiltWithLayerToolsAndThenWithoutLayerTools() {
 			.getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 	}
 
+	@TestTemplate
+	void notUpToDateWhenBuiltWithToolsAndThenWithoutTools() {
+		assertThat(this.gradleBuild.scriptProperty("includeTools", "")
+			.build(this.taskName)
+			.task(":" + this.taskName)
+			.getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
+		assertThat(this.gradleBuild.scriptProperty("includeTools", "includeTools = false")
+			.build(this.taskName)
+			.task(":" + this.taskName)
+			.getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
+	}
+
 	@TestTemplate
 	void layersWithCustomSourceSet() {
 		assertThat(this.gradleBuild.build(this.taskName).task(":" + this.taskName).getOutcome())
@@ -345,7 +358,7 @@ void implicitLayers() throws IOException {
 		assertThat(this.gradleBuild.build(this.taskName).task(":" + this.taskName).getOutcome())
 			.isEqualTo(TaskOutcome.SUCCESS);
 		Map<String, List<String>> indexedLayers;
-		String layerToolsJar = this.libPath + JarModeLibrary.LAYER_TOOLS.getName();
+		String layerToolsJar = this.libPath + JarModeLibrary.TOOLS.getName();
 		try (JarFile jarFile = new JarFile(new File(this.gradleBuild.getProjectDir(), "build/libs").listFiles()[0])) {
 			assertThat(jarFile.getEntry(layerToolsJar)).isNotNull();
 			assertThat(jarFile.getEntry(this.libPath + "commons-lang3-3.9.jar")).isNotNull();
@@ -397,7 +410,7 @@ void multiModuleImplicitLayers() throws IOException {
 		assertThat(this.gradleBuild.build(this.taskName).task(":" + this.taskName).getOutcome())
 			.isEqualTo(TaskOutcome.SUCCESS);
 		Map<String, List<String>> indexedLayers;
-		String layerToolsJar = this.libPath + JarModeLibrary.LAYER_TOOLS.getName();
+		String layerToolsJar = this.libPath + JarModeLibrary.TOOLS.getName();
 		try (JarFile jarFile = new JarFile(new File(this.gradleBuild.getProjectDir(), "build/libs").listFiles()[0])) {
 			assertThat(jarFile.getEntry(layerToolsJar)).isNotNull();
 			assertThat(jarFile.getEntry(this.libPath + "alpha-1.2.3.jar")).isNotNull();
@@ -443,7 +456,7 @@ void customLayers() throws IOException {
 		BuildResult build = this.gradleBuild.build(this.taskName);
 		assertThat(build.task(":" + this.taskName).getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 		Map<String, List<String>> indexedLayers;
-		String layerToolsJar = this.libPath + JarModeLibrary.LAYER_TOOLS.getName();
+		String layerToolsJar = this.libPath + JarModeLibrary.TOOLS.getName();
 		try (JarFile jarFile = new JarFile(new File(this.gradleBuild.getProjectDir(), "build/libs").listFiles()[0])) {
 			assertThat(jarFile.getEntry(layerToolsJar)).isNotNull();
 			assertThat(jarFile.getEntry(this.libPath + "commons-lang3-3.9.jar")).isNotNull();
@@ -490,7 +503,7 @@ void multiModuleCustomLayers() throws IOException {
 		BuildResult build = this.gradleBuild.build(this.taskName);
 		assertThat(build.task(":" + this.taskName).getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 		Map<String, List<String>> indexedLayers;
-		String layerToolsJar = this.libPath + JarModeLibrary.LAYER_TOOLS.getName();
+		String layerToolsJar = this.libPath + JarModeLibrary.TOOLS.getName();
 		try (JarFile jarFile = new JarFile(new File(this.gradleBuild.getProjectDir(), "build/libs").listFiles()[0])) {
 			assertThat(jarFile.getEntry(layerToolsJar)).isNotNull();
 			assertThat(jarFile.getEntry(this.libPath + "alpha-1.2.3.jar")).isNotNull();

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/AbstractBootArchiveTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -80,6 +80,7 @@
  * @param <T> the type of the concrete BootArchive implementation
  * @author Andy Wilkinson
  * @author Scott Frederick
+ * @author Moritz Halbritter
  */
 abstract class AbstractBootArchiveTests<T extends Jar & BootArchive> {
 
@@ -496,7 +497,7 @@ void archiveShouldBeLayeredByDefault() throws IOException {
 			assertThat(jarFile.getManifest().getMainAttributes().getValue("Spring-Boot-Lib")).isEqualTo(this.libPath);
 			assertThat(jarFile.getManifest().getMainAttributes().getValue("Spring-Boot-Layers-Index"))
 				.isEqualTo(this.indexPath + "layers.idx");
-			assertThat(getEntryNames(jarFile)).contains(this.libPath + JarModeLibrary.LAYER_TOOLS.getName());
+			assertThat(getEntryNames(jarFile)).contains(this.libPath + JarModeLibrary.TOOLS.getName());
 		}
 	}
 
@@ -530,7 +531,7 @@ void whenJarIsLayeredThenLayersIndexIsPresentAndCorrect() throws IOException {
 			List<String> index = entryLines(jarFile, this.indexPath + "layers.idx");
 			assertThat(getLayerNames(index)).containsExactly("dependencies", "spring-boot-loader",
 					"snapshot-dependencies", "application");
-			String layerToolsJar = this.libPath + JarModeLibrary.LAYER_TOOLS.getName();
+			String layerToolsJar = this.libPath + JarModeLibrary.TOOLS.getName();
 			List<String> expected = new ArrayList<>();
 			expected.add("- \"dependencies\":");
 			expected.add("  - \"" + this.libPath + "first-library.jar\"");
@@ -584,7 +585,7 @@ void whenJarIsLayeredWithCustomStrategiesThenLayersIndexIsPresentAndCorrect() th
 			List<String> index = entryLines(jarFile, this.indexPath + "layers.idx");
 			assertThat(getLayerNames(index)).containsExactly("my-deps", "my-internal-deps", "my-snapshot-deps",
 					"resources", "application");
-			String layerToolsJar = this.libPath + JarModeLibrary.LAYER_TOOLS.getName();
+			String layerToolsJar = this.libPath + JarModeLibrary.TOOLS.getName();
 			List<String> expected = new ArrayList<>();
 			expected.add("- \"my-deps\":");
 			expected.add("  - \"" + layerToolsJar + "\"");
@@ -614,15 +615,32 @@ void whenJarIsLayeredWithCustomStrategiesThenLayersIndexIsPresentAndCorrect() th
 	@Test
 	void whenArchiveIsLayeredThenLayerToolsAreAddedToTheJar() throws IOException {
 		List<String> entryNames = getEntryNames(createLayeredJar());
-		assertThat(entryNames).contains(this.libPath + JarModeLibrary.LAYER_TOOLS.getName());
+		assertThat(entryNames).contains(this.libPath + JarModeLibrary.TOOLS.getName());
 	}
 
 	@Test
+	void shouldAddToolsToTheJar() throws IOException {
+		this.task.getMainClass().set("com.example.Main");
+		executeTask();
+		List<String> entryNames = getEntryNames(this.task.getArchiveFile().get().getAsFile());
+		assertThat(entryNames).isNotEmpty().contains(this.libPath + JarModeLibrary.TOOLS.getName());
+	}
+
+	@Test
+	@SuppressWarnings("removal")
 	void whenArchiveIsLayeredAndIncludeLayerToolsIsFalseThenLayerToolsAreNotAddedToTheJar() throws IOException {
 		List<String> entryNames = getEntryNames(
 				createLayeredJar((configuration) -> configuration.getIncludeLayerTools().set(false)));
-		assertThat(entryNames).isNotEmpty()
-			.doesNotContain(this.indexPath + "layers/dependencies/lib/spring-boot-jarmode-layertools.jar");
+		assertThat(entryNames).isNotEmpty().doesNotContain(this.libPath + JarModeLibrary.TOOLS.getName());
+	}
+
+	@Test
+	void whenIncludeToolsIsFalseThenToolsAreNotAddedToTheJar() throws IOException {
+		this.task.getIncludeTools().set(false);
+		this.task.getMainClass().set("com.example.Main");
+		executeTask();
+		List<String> entryNames = getEntryNames(this.task.getArchiveFile().get().getAsFile());
+		assertThat(entryNames).isNotEmpty().doesNotContain(this.libPath + JarModeLibrary.TOOLS.getName());
 	}
 
 	protected File jarFile(String name) throws IOException {

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/BootJarIntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,7 +67,7 @@ void packagedApplicationClasspath() throws IOException {
 		assertThat(output).containsPattern("1\\. .*classes");
 		assertThat(output).containsPattern("2\\. .*library-1.0-SNAPSHOT.jar");
 		assertThat(output).containsPattern("3\\. .*commons-lang3-3.9.jar");
-		assertThat(output).containsPattern("4\\. .*spring-boot-jarmode-layertools.*.jar");
+		assertThat(output).containsPattern("4\\. .*spring-boot-jarmode-tools.*.jar");
 		assertThat(output).doesNotContain("5. ");
 	}
 
@@ -77,7 +77,7 @@ void explodedApplicationClasspath() throws IOException {
 		BuildResult result = this.gradleBuild.build("launch");
 		String output = result.getOutput();
 		assertThat(output).containsPattern("1\\. .*classes");
-		assertThat(output).containsPattern("2\\. .*spring-boot-jarmode-layertools.*.jar");
+		assertThat(output).containsPattern("2\\. .*spring-boot-jarmode-tools.*.jar");
 		assertThat(output).containsPattern("3\\. .*library-1.0-SNAPSHOT.jar");
 		assertThat(output).containsPattern("4\\. .*commons-lang3-3.9.jar");
 		assertThat(output).doesNotContain("5. ");