diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/ImagePackager.java b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/ImagePackager.java index e19e1abb2c..eabafac45e 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/ImagePackager.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/ImagePackager.java @@ -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 { @@ -38,10 +39,14 @@ public class ImagePackager extends Packager { */ public ImagePackager(File source) { super(source, null); + if (isAlreadyPackaged()) { + Assert.isTrue(getBackupFile().exists() && getBackupFile().isFile(), + "Original source '" + getBackupFile() + "' is required for building an image"); + } } /** - * 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 @@ -52,8 +57,8 @@ 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"); + Assert.state(!isAlreadyPackaged(source), + () -> "Repackaged archive file " + source + " cannot be used to build an image"); try (JarFile sourceJar = new JarFile(source)) { write(sourceJar, libraries, writer); } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java index 5fb17b0e57..1dfede6d3e 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java @@ -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,7 +70,7 @@ public abstract class Packager { private static final String SPRING_BOOT_APPLICATION_CLASS_NAME = "org.springframework.boot.autoconfigure.SpringBootApplication"; - private List mainClassTimeoutListeners = new ArrayList<>(); + private final List mainClassTimeoutListeners = new ArrayList<>(); private String mainClass; @@ -153,15 +154,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 +291,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() { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/BuildImageTests.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/BuildImageTests.java index 5994f3725c..c33c88a4ca 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/BuildImageTests.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/BuildImageTests.java @@ -70,16 +70,15 @@ public class BuildImageTests extends AbstractArchiveIntegrationTests { @TestTemplate void whenBuildImageIsInvokedWithRepackageTheExistingArchiveIsUsed(MavenBuild mavenBuild) { - mavenBuild.project("build-image-with-repackage").goals("package").prepare(this::writeLongNameResource) - .execute((project) -> { + mavenBuild.project("build-image-with-repackage").goals("package") + .systemProperty("spring-boot.build-image.pullPolicy", "IF_NOT_PRESENT") + .prepare(this::writeLongNameResource).execute((project) -> { File jar = new File(project, "target/build-image-with-repackage-0.0.1.BUILD-SNAPSHOT.jar"); assertThat(jar).isFile(); File original = new File(project, "target/build-image-with-repackage-0.0.1.BUILD-SNAPSHOT.jar.original"); assertThat(original).isFile(); - String log = buildLog(project); - System.out.println(log); - assertThat(log).contains("Building image") + assertThat(buildLog(project)).contains("Building image") .contains("docker.io/library/build-image-with-repackage:0.0.1.BUILD-SNAPSHOT") .contains("Successfully built image"); ImageReference imageReference = ImageReference.of(ImageName.of("build-image-with-repackage"), @@ -248,6 +247,13 @@ public class BuildImageTests extends AbstractArchiveIntegrationTests { .contains("'urn:cnb:builder:example/does-not-exist:0.0.1' not found in builder")); } + @TestTemplate + void failsWhenFinalNameIsMisconfigured(MavenBuild mavenBuild) { + mavenBuild.project("build-image-final-name").goals("package") + .executeAndFail((project) -> assertThat(buildLog(project)).contains("final-name.jar.original") + .contains("is required for building an image")); + } + private void writeLongNameResource(File project) { StringBuilder name = new StringBuilder(); new Random().ints('a', 'z' + 1).limit(128).forEach((i) -> name.append((char) i)); diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-final-name/pom.xml b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-final-name/pom.xml new file mode 100644 index 0000000000..599371978a --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-final-name/pom.xml @@ -0,0 +1,33 @@ + + + 4.0.0 + org.springframework.boot.maven.it + build-image-final-name + 0.0.1.BUILD-SNAPSHOT + + UTF-8 + @java.version@ + @java.version@ + + + + + @project.groupId@ + @project.artifactId@ + @project.version@ + + + + repackage + build-image + + + final-name + + + + + + + diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-final-name/src/main/java/org/test/SampleApplication.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-final-name/src/main/java/org/test/SampleApplication.java new file mode 100644 index 0000000000..27259ff01a --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-final-name/src/main/java/org/test/SampleApplication.java @@ -0,0 +1,28 @@ +/* + * Copyright 2012-2020 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. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.test; + +public class SampleApplication { + + public static void main(String[] args) throws Exception { + System.out.println("Launched"); + synchronized(args) { + args.wait(); // Prevent exit" + } + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java index c23ce8ef02..3fedcd4416 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java @@ -186,7 +186,8 @@ public class BuildImageMojo extends AbstractPackagerMojo { } private BuildRequest getBuildRequest(Libraries libraries) throws MojoExecutionException { - Function content = (owner) -> getApplicationContent(owner, libraries); + ImagePackager imagePackager = new ImagePackager(getArchiveFile()); + Function content = (owner) -> getApplicationContent(owner, libraries, imagePackager); Image image = (this.image != null) ? this.image : new Image(); if (image.name == null && this.imageName != null) { image.setName(this.imageName); @@ -217,8 +218,8 @@ public class BuildImageMojo extends AbstractPackagerMojo { || this.docker.getPublishRegistry().isEmpty(); } - private TarArchive getApplicationContent(Owner owner, Libraries libraries) { - ImagePackager packager = getConfiguredPackager(() -> new ImagePackager(getArchiveFile())); + private TarArchive getApplicationContent(Owner owner, Libraries libraries, ImagePackager imagePackager) { + ImagePackager packager = getConfiguredPackager(() -> imagePackager); return new PackagedTarArchive(owner, libraries, packager); }