Merge branch '2.3.x' into 2.4.x

Closes gh-25700
This commit is contained in:
Scott Frederick
2021-03-16 17:31:32 -05:00
7 changed files with 107 additions and 34 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
@@ -28,6 +28,7 @@ import org.springframework.util.Assert;
* Utility class that can be used to export a fully packaged archive to an OCI image.
*
* @author Phillip Webb
* @author Scott Frederick
* @since 2.3.0
*/
public class ImagePackager extends Packager {
@@ -37,11 +38,18 @@ public class ImagePackager extends Packager {
* @param source the source file to package
*/
public ImagePackager(File source) {
super(source, null);
Assert.notNull(source, "Source file must not be null");
this.source = source.getAbsoluteFile();
if (isAlreadyPackaged()) {
this.source = getBackupFile();
}
Assert.isTrue(this.source.exists() && this.source.isFile(),
"Source '" + this.source + "' must refer to an existing file");
Assert.state(!isAlreadyPackaged(), () -> "Repackaged archive file " + getSource() + " cannot be exported");
}
/**
* Create an packaged image.
* Create a packaged image.
* @param libraries the contained libraries
* @param exporter the exporter used to write the image
* @throws IOException on IO error
@@ -51,10 +59,7 @@ public class ImagePackager extends Packager {
}
private void packageImage(Libraries libraries, AbstractJarWriter writer) throws IOException {
File source = isAlreadyPackaged() ? getBackupFile() : getSource();
Assert.state(source.exists() && source.isFile(), () -> "Unable to read jar file " + source);
Assert.state(!isAlreadyPackaged(source), () -> "Repackaged jar file " + source + " cannot be exported");
try (JarFile sourceJar = new JarFile(source)) {
try (JarFile sourceJar = new JarFile(getSource())) {
write(sourceJar, libraries, writer);
}
}

View File

@@ -45,6 +45,7 @@ import org.springframework.util.StringUtils;
* @author Andy Wilkinson
* @author Stephane Nicoll
* @author Madhura Bhave
* @author Scott Frederick
* @since 2.3.0
*/
public abstract class Packager {
@@ -69,15 +70,15 @@ public abstract class Packager {
private static final String SPRING_BOOT_APPLICATION_CLASS_NAME = "org.springframework.boot.autoconfigure.SpringBootApplication";
private List<MainClassTimeoutWarningListener> mainClassTimeoutListeners = new ArrayList<>();
private final List<MainClassTimeoutWarningListener> mainClassTimeoutListeners = new ArrayList<>();
private String mainClass;
private final File source;
protected File source;
private Layout layout;
private LayoutFactory layoutFactory;
protected LayoutFactory layoutFactory;
private Layers layers;
@@ -85,19 +86,6 @@ public abstract class Packager {
private boolean includeRelevantJarModeJars = true;
/**
* Create a new {@link Packager} instance.
* @param source the source JAR file to package
* @param layoutFactory the layout factory to use or {@code null}
*/
protected Packager(File source, LayoutFactory layoutFactory) {
Assert.notNull(source, "Source file must not be null");
Assert.isTrue(source.exists() && source.isFile(),
() -> "Source must refer to an existing file, got " + source.getAbsolutePath());
this.source = source.getAbsoluteFile();
this.layoutFactory = layoutFactory;
}
/**
* Add a listener that will be triggered to display a warning if searching for the
* main class takes too long.
@@ -153,15 +141,18 @@ public abstract class Packager {
this.includeRelevantJarModeJars = includeRelevantJarModeJars;
}
protected final boolean isAlreadyPackaged() throws IOException {
protected final boolean isAlreadyPackaged() {
return isAlreadyPackaged(this.source);
}
protected final boolean isAlreadyPackaged(File file) throws IOException {
protected final boolean isAlreadyPackaged(File file) {
try (JarFile jarFile = new JarFile(file)) {
Manifest manifest = jarFile.getManifest();
return (manifest != null && manifest.getMainAttributes().getValue(BOOT_VERSION_ATTRIBUTE) != null);
}
catch (IOException ex) {
throw new IllegalStateException("Error reading archive file", ex);
}
}
protected final void write(JarFile sourceJar, Libraries libraries, AbstractJarWriter writer) throws IOException {
@@ -287,8 +278,7 @@ public abstract class Packager {
* @return the file to use to backup the original source
*/
public final File getBackupFile() {
File source = getSource();
return new File(source.getParentFile(), source.getName() + ".original");
return new File(this.source.getParentFile(), this.source.getName() + ".original");
}
protected final File getSource() {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
@@ -32,6 +32,7 @@ import org.springframework.util.Assert;
* @author Andy Wilkinson
* @author Stephane Nicoll
* @author Madhura Bhave
* @author Scott Frederick
* @since 1.0.0
*/
public class Repackager extends Packager {
@@ -42,8 +43,16 @@ public class Repackager extends Packager {
this(source, null);
}
/**
* Create a new {@link Repackager} instance.
* @param source the source archive file to package
* @param layoutFactory the layout factory to use or {@code null}
*/
public Repackager(File source, LayoutFactory layoutFactory) {
super(source, layoutFactory);
Assert.notNull(source, "Source file must not be null");
Assert.isTrue(source.exists() && source.isFile(), "Source '" + source + "' must refer to an existing file");
this.source = source.getAbsoluteFile();
this.layoutFactory = layoutFactory;
}
/**