Remove classpath index manifest attribute from repackaged war files

Fixes gh-28895
spring-projects · Dec 3, 2021 · 467c092 · 467c092
1 parent af60a8a
commit 467c092
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 11 deletions.
diff --git a/...spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Layouts.java b/...spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Layouts.java
@@ -29,6 +29,7 @@
  * @author Dave Syer
  * @author Andy Wilkinson
  * @author Madhura Bhave
+ * @author Scott Frederick
  * @since 1.0.0
  */
 public final class Layouts {
@@ -160,11 +161,6 @@ public String getClassesLocation() {
 			return "WEB-INF/classes/";
 		}
 
-		@Override
-		public String getClasspathIndexFileLocation() {
-			return "WEB-INF/classpath.idx";
-		}
-
 		@Override
 		public String getLayersIndexFileLocation() {
 			return "WEB-INF/layers.idx";

diff --git a/...pring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java b/...pring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java
@@ -510,15 +510,15 @@ void write(AbstractJarWriter writer) throws IOException {
 					writtenPaths.add(path);
 				}
 			}
-			if (getLayout() instanceof RepackagingLayout) {
-				writeClasspathIndex(writtenPaths, (RepackagingLayout) getLayout(), writer);
-			}
+			writeClasspathIndexIfNecessary(writtenPaths, getLayout(), writer);
 		}
 
-		private void writeClasspathIndex(List<String> paths, RepackagingLayout layout, AbstractJarWriter writer)
+		private void writeClasspathIndexIfNecessary(List<String> paths, Layout layout, AbstractJarWriter writer)
 				throws IOException {
-			List<String> names = paths.stream().map((path) -> "- \"" + path + "\"").collect(Collectors.toList());
-			writer.writeIndexFile(layout.getClasspathIndexFileLocation(), names);
+			if (layout.getClasspathIndexFileLocation() != null) {
+				List<String> names = paths.stream().map((path) -> "- \"" + path + "\"").collect(Collectors.toList());
+				writer.writeIndexFile(layout.getClasspathIndexFileLocation(), names);
+			}
 		}
 
 		private class PackagedLibrariesUnpackHandler implements UnpackHandler {

diff --git a/...ugin/src/intTest/java/org/springframework/boot/maven/AbstractArchiveIntegrationTests.java b/...ugin/src/intTest/java/org/springframework/boot/maven/AbstractArchiveIntegrationTests.java
@@ -43,6 +43,7 @@
  * Base class for archive (jar or war) related Maven plugin integration tests.
  *
  * @author Andy Wilkinson
+ * @author Scott Frederick
  */
 abstract class AbstractArchiveIntegrationTests {
 
@@ -201,6 +202,11 @@ ManifestAssert hasAttribute(String name, String value) {
 				return this;
 			}
 
+			ManifestAssert doesNotHaveAttribute(String name) {
+				assertThat(this.actual.getMainAttributes().getValue(name)).isNull();
+				return this;
+			}
+
 		}
 
 	}

diff --git a/...oot-maven-plugin/src/intTest/java/org/springframework/boot/maven/JarIntegrationTests.java b/...oot-maven-plugin/src/intTest/java/org/springframework/boot/maven/JarIntegrationTests.java
@@ -38,6 +38,7 @@
  *
  * @author Andy Wilkinson
  * @author Madhura Bhave
+ * @author Scott Frederick
  */
 @ExtendWith(MavenBuildExtension.class)
 class JarIntegrationTests extends AbstractArchiveIntegrationTests {
@@ -363,6 +364,16 @@ void whenJarIsRepackagedWithTheCustomLayers(MavenBuild mavenBuild) {
 		});
 	}
 
+	@TestTemplate
+	void repackagedJarContainsClasspathIndex(MavenBuild mavenBuild) {
+		mavenBuild.project("jar").execute((project) -> {
+			File repackaged = new File(project, "target/jar-0.0.1.BUILD-SNAPSHOT.jar");
+			assertThat(jar(repackaged)).manifest(
+					(manifest) -> manifest.hasAttribute("Spring-Boot-Classpath-Index", "BOOT-INF/classpath.idx"));
+			assertThat(jar(repackaged)).hasEntryWithName("BOOT-INF/classpath.idx");
+		});
+	}
+
 	@TestTemplate
 	void whenJarIsRepackagedWithOutputTimestampConfiguredThenJarIsReproducible(MavenBuild mavenBuild)
 			throws InterruptedException {

diff --git a/...oot-maven-plugin/src/intTest/java/org/springframework/boot/maven/WarIntegrationTests.java b/...oot-maven-plugin/src/intTest/java/org/springframework/boot/maven/WarIntegrationTests.java
@@ -38,6 +38,7 @@
  * Integration tests for the Maven plugin's war support.
  *
  * @author Andy Wilkinson
+ * @author Scott Frederick
  */
 @ExtendWith(MavenBuildExtension.class)
 class WarIntegrationTests extends AbstractArchiveIntegrationTests {
@@ -190,6 +191,16 @@ void whenWarIsRepackagedWithTheCustomLayers(MavenBuild mavenBuild) {
 		});
 	}
 
+	@TestTemplate
+	void repackagedWarDoesNotContainClasspathIndex(MavenBuild mavenBuild) {
+		mavenBuild.project("war").execute((project) -> {
+			File repackaged = new File(project, "target/war-0.0.1.BUILD-SNAPSHOT.war");
+			assertThat(jar(repackaged))
+					.manifest((manifest) -> manifest.doesNotHaveAttribute("Spring-Boot-Classpath-Index"));
+			assertThat(jar(repackaged)).doesNotHaveEntryWithName("BOOT-INF/classpath.idx");
+		});
+	}
+
 	@TestTemplate
 	void whenEntryIsExcludedItShouldNotBePresentInTheRepackagedWar(MavenBuild mavenBuild) {
 		mavenBuild.project("war-exclude-entry").execute((project) -> {