Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sort repackaged libraries in a reproducible Maven build

Browse Source 
When a Maven build is configured to ensure reproducibility, any
libraries added to `BOOT-INF/lib` in a jar archive or to `WEB-INF/lib`
in a war archive by the Spring Boot plugin repackaging should be
sorted by name to ensure a stable and predictable order.

Fixes gh-27436
This commit is contained in:
Scott Frederick
2021-08-20 12:52:36 -05:00
parent 813fc9ea92
commit 40a9c4d90f
5 changed files with 89 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java
View File

@@ -24,6 +24,7 @@ import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.jar.Attributes;
@@ -192,8 +193,13 @@ public abstract class Packager {
}
protected final void write(JarFile sourceJar, Libraries libraries, AbstractJarWriter writer) throws IOException {
write(sourceJar, libraries, writer, false);
}
protected final void write(JarFile sourceJar, Libraries libraries, AbstractJarWriter writer,
boolean ensureReproducibleBuild) throws IOException {
Assert.notNull(libraries, "Libraries must not be null");
write(sourceJar, writer, new PackagedLibraries(libraries));
write(sourceJar, writer, new PackagedLibraries(libraries, ensureReproducibleBuild));
}
private void write(JarFile sourceJar, AbstractJarWriter writer, PackagedLibraries libraries) throws IOException {
@@ -454,18 +460,18 @@ public abstract class Packager {
}
/**
* An {@link UnpackHandler} that determines that an entry needs to be unpacked if a
* library that requires unpacking has a matching entry name.
* Libraries that should be packaged into the archive.
*/
private final class PackagedLibraries {
private final Map<String, Library> libraries = new LinkedHashMap<>();
private final Map<String, Library> libraries;
private final UnpackHandler unpackHandler;
private final Function<JarEntry, Library> libraryLookup;
PackagedLibraries(Libraries libraries) throws IOException {
PackagedLibraries(Libraries libraries, boolean ensureReproducibleBuild) throws IOException {
this.libraries = (ensureReproducibleBuild) ? new TreeMap<>() : new LinkedHashMap<>();
libraries.doWithLibraries((library) -> {
if (isZip(library::openStream)) {
addLibrary(library);
@@ -521,6 +527,10 @@ public abstract class Packager {
writer.writeIndexFile(layout.getClasspathIndexFileLocation(), names);
}
/**
* An {@link UnpackHandler} that determines that an entry needs to be unpacked if
* a library that requires unpacking has a matching entry name.
*/
private class PackagedLibrariesUnpackHandler implements UnpackHandler {
@Override

2
spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Repackager.java
View File

@@ -141,7 +141,7 @@ public class Repackager extends Packager {
private void repackage(JarFile sourceJar, File destination, Libraries libraries, LaunchScript launchScript,
FileTime lastModifiedTime) throws IOException {
try (JarWriter writer = new JarWriter(destination, launchScript, lastModifiedTime)) {
write(sourceJar, libraries, writer);
write(sourceJar, libraries, writer, lastModifiedTime != null);
}
if (lastModifiedTime != null) {
destination.setLastModified(lastModifiedTime.toMillis());