root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Only apply special handling of META-INF to jar files 

The changes for gh-28562 attempted to align the Gradle plugin's
handling of META-INF with the Maven plugin's behavior. Unfortunately,
they want too far, applying the handling to both jar and war files
when the Maven plugin only applies it to jar files.

This commit reworks the changes so that they only apply to jar files.

Closes gh-30026
This commit is contained in:
Andy Wilkinson 2022-03-02 15:19:09 +00:00
parent b43715c70b
commit 4073cf8334
5 changed files with 73 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -179,19 +179,10 @@ class BootArchiveSupport {
} }
void moveModuleInfoToRoot(CopySpec spec) { void moveModuleInfoToRoot(CopySpec spec) {
spec.filesMatching("module-info.class", BootArchiveSupport::moveToRoot); spec.filesMatching("module-info.class", this::moveToRoot);
} }
void moveMetaInfToRoot(CopySpec spec) { void moveToRoot(FileCopyDetails details) {
spec.eachFile((file) -> {
String path = file.getRelativeSourcePath().getPathString();
if (path.startsWith("META-INF/") && !path.equals("META-INF/aop.xml") && !path.endsWith(".kotlin_module")) {
moveToRoot(file);
}
});
}
private static void moveToRoot(FileCopyDetails details) {
details.setRelativePath(details.getRelativeSourcePath()); details.setRelativePath(details.getRelativeSourcePath());
} }

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

@ -92,7 +92,7 @@ public class BootJar extends Jar implements BootArchive {
bootInfSpec.into("classes", fromCallTo(this::classpathDirectories)); bootInfSpec.into("classes", fromCallTo(this::classpathDirectories));
bootInfSpec.into("lib", fromCallTo(this::classpathFiles)).eachFile(this.support::excludeNonZipFiles); bootInfSpec.into("lib", fromCallTo(this::classpathFiles)).eachFile(this.support::excludeNonZipFiles);
this.support.moveModuleInfoToRoot(bootInfSpec); this.support.moveModuleInfoToRoot(bootInfSpec);
this.support.moveMetaInfToRoot(bootInfSpec); moveMetaInfToRoot(bootInfSpec);
} }
private Iterable<File> classpathDirectories() { private Iterable<File> classpathDirectories() {
@ -107,6 +107,15 @@ public class BootJar extends Jar implements BootArchive {
return (this.classpath != null) ? this.classpath.filter(filter) : Collections.emptyList(); return (this.classpath != null) ? this.classpath.filter(filter) : Collections.emptyList();
} }
private void moveMetaInfToRoot(CopySpec spec) {
spec.eachFile((file) -> {
String path = file.getRelativeSourcePath().getPathString();
if (path.startsWith("META-INF/") && !path.equals("META-INF/aop.xml") && !path.endsWith(".kotlin_module")) {
this.support.moveToRoot(file);
}
});
}
@Override @Override
public void copy() { public void copy() {
this.support.configureManifest(getManifest(), getMainClass().get(), CLASSES_DIRECTORY, LIB_DIRECTORY, this.support.configureManifest(getManifest(), getMainClass().get(), CLASSES_DIRECTORY, LIB_DIRECTORY,

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

@ -74,7 +74,6 @@ public class BootWar extends War implements BootArchive {
this.mainClass = project.getObjects().property(String.class); this.mainClass = project.getObjects().property(String.class);
getWebInf().into("lib-provided", fromCallTo(this::getProvidedLibFiles)); getWebInf().into("lib-provided", fromCallTo(this::getProvidedLibFiles));
this.support.moveModuleInfoToRoot(getRootSpec()); this.support.moveModuleInfoToRoot(getRootSpec());
this.support.moveMetaInfToRoot(getRootSpec());
getRootSpec().eachFile(this.support::excludeNonZipLibraryFiles); getRootSpec().eachFile(this.support::excludeNonZipLibraryFiles);
project.getConfigurations().all((configuration) -> { project.getConfigurations().all((configuration) -> {
ResolvableDependencies incoming = configuration.getIncoming(); ResolvableDependencies incoming = configuration.getIncoming();

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

@ -185,66 +185,6 @@ abstract class AbstractBootArchiveTests<T extends Jar & BootArchive> {
} }
} }
@Test
void metaInfEntryIsPackagedInTheRootOfTheArchive() throws IOException {
this.task.getMainClass().set("com.example.Main");
File classpathDirectory = new File(this.temp, "classes");
File metaInfEntry = new File(classpathDirectory, "META-INF/test");
metaInfEntry.getParentFile().mkdirs();
metaInfEntry.createNewFile();
File applicationClass = new File(classpathDirectory, "com/example/Application.class");
applicationClass.getParentFile().mkdirs();
applicationClass.createNewFile();
this.task.classpath(classpathDirectory);
executeTask();
try (JarFile jarFile = new JarFile(this.task.getArchiveFile().get().getAsFile())) {
assertThat(jarFile.getEntry(this.classesPath + "com/example/Application.class")).isNotNull();
assertThat(jarFile.getEntry("com/example/Application.class")).isNull();
assertThat(jarFile.getEntry(this.classesPath + "META-INF/test")).isNull();
assertThat(jarFile.getEntry("META-INF/test")).isNotNull();
}
}
@Test
void aopXmlIsPackagedBeneathClassesDirectory() throws IOException {
this.task.getMainClass().set("com.example.Main");
File classpathDirectory = new File(this.temp, "classes");
File aopXml = new File(classpathDirectory, "META-INF/aop.xml");
aopXml.getParentFile().mkdirs();
aopXml.createNewFile();
File applicationClass = new File(classpathDirectory, "com/example/Application.class");
applicationClass.getParentFile().mkdirs();
applicationClass.createNewFile();
this.task.classpath(classpathDirectory);
executeTask();
try (JarFile jarFile = new JarFile(this.task.getArchiveFile().get().getAsFile())) {
assertThat(jarFile.getEntry(this.classesPath + "com/example/Application.class")).isNotNull();
assertThat(jarFile.getEntry("com/example/Application.class")).isNull();
assertThat(jarFile.getEntry(this.classesPath + "META-INF/aop.xml")).isNotNull();
assertThat(jarFile.getEntry("META-INF/aop.xml")).isNull();
}
}
@Test
void kotlinModuleIsPackagedBeneathClassesDirectory() throws IOException {
this.task.getMainClass().set("com.example.Main");
File classpathDirectory = new File(this.temp, "classes");
File kotlinModule = new File(classpathDirectory, "META-INF/example.kotlin_module");
kotlinModule.getParentFile().mkdirs();
kotlinModule.createNewFile();
File applicationClass = new File(classpathDirectory, "com/example/Application.class");
applicationClass.getParentFile().mkdirs();
applicationClass.createNewFile();
this.task.classpath(classpathDirectory);
executeTask();
try (JarFile jarFile = new JarFile(this.task.getArchiveFile().get().getAsFile())) {
assertThat(jarFile.getEntry(this.classesPath + "com/example/Application.class")).isNotNull();
assertThat(jarFile.getEntry("com/example/Application.class")).isNull();
assertThat(jarFile.getEntry(this.classesPath + "META-INF/example.kotlin_module")).isNotNull();
assertThat(jarFile.getEntry("META-INF/example.kotlin_module")).isNull();
}
}
@Test @Test
void classpathCanBeSetUsingAFileCollection() throws IOException { void classpathCanBeSetUsingAFileCollection() throws IOException {
this.task.getMainClass().set("com.example.Main"); this.task.getMainClass().set("com.example.Main");

62
spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/BootJarTests.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2021 the original author or authors. * Copyright 2012-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -103,6 +103,66 @@ class BootJarTests extends AbstractBootArchiveTests<BootJar> {
} }
} }
@Test
void metaInfEntryIsPackagedInTheRootOfTheArchive() throws IOException {
getTask().getMainClass().set("com.example.Main");
File classpathDirectory = new File(this.temp, "classes");
File metaInfEntry = new File(classpathDirectory, "META-INF/test");
metaInfEntry.getParentFile().mkdirs();
metaInfEntry.createNewFile();
File applicationClass = new File(classpathDirectory, "com/example/Application.class");
applicationClass.getParentFile().mkdirs();
applicationClass.createNewFile();
getTask().classpath(classpathDirectory);
executeTask();
try (JarFile jarFile = new JarFile(getTask().getArchiveFile().get().getAsFile())) {
assertThat(jarFile.getEntry("BOOT-INF/classes/com/example/Application.class")).isNotNull();
assertThat(jarFile.getEntry("com/example/Application.class")).isNull();
assertThat(jarFile.getEntry("BOOT-INF/classes/META-INF/test")).isNull();
assertThat(jarFile.getEntry("META-INF/test")).isNotNull();
}
}
@Test
void aopXmlIsPackagedBeneathClassesDirectory() throws IOException {
getTask().getMainClass().set("com.example.Main");
File classpathDirectory = new File(this.temp, "classes");
File aopXml = new File(classpathDirectory, "META-INF/aop.xml");
aopXml.getParentFile().mkdirs();
aopXml.createNewFile();
File applicationClass = new File(classpathDirectory, "com/example/Application.class");
applicationClass.getParentFile().mkdirs();
applicationClass.createNewFile();
getTask().classpath(classpathDirectory);
executeTask();
try (JarFile jarFile = new JarFile(getTask().getArchiveFile().get().getAsFile())) {
assertThat(jarFile.getEntry("BOOT-INF/classes/com/example/Application.class")).isNotNull();
assertThat(jarFile.getEntry("com/example/Application.class")).isNull();
assertThat(jarFile.getEntry("BOOT-INF/classes/META-INF/aop.xml")).isNotNull();
assertThat(jarFile.getEntry("META-INF/aop.xml")).isNull();
}
}
@Test
void kotlinModuleIsPackagedBeneathClassesDirectory() throws IOException {
getTask().getMainClass().set("com.example.Main");
File classpathDirectory = new File(this.temp, "classes");
File kotlinModule = new File(classpathDirectory, "META-INF/example.kotlin_module");
kotlinModule.getParentFile().mkdirs();
kotlinModule.createNewFile();
File applicationClass = new File(classpathDirectory, "com/example/Application.class");
applicationClass.getParentFile().mkdirs();
applicationClass.createNewFile();
getTask().classpath(classpathDirectory);
executeTask();
try (JarFile jarFile = new JarFile(getTask().getArchiveFile().get().getAsFile())) {
assertThat(jarFile.getEntry("BOOT-INF/classes/com/example/Application.class")).isNotNull();
assertThat(jarFile.getEntry("com/example/Application.class")).isNull();
assertThat(jarFile.getEntry("BOOT-INF/classes/META-INF/example.kotlin_module")).isNotNull();
assertThat(jarFile.getEntry("META-INF/example.kotlin_module")).isNull();
}
}
private File createPopulatedJar() throws IOException { private File createPopulatedJar() throws IOException {
addContent(); addContent();
executeTask(); executeTask();