Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure that the manifest of the generated jar is the first entry #5409

Merged
merged 1 commit into from
Nov 14, 2019
Merged

Ensure that the manifest of the generated jar is the first entry #5409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/JarResultBuildStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,11 @@ private JarBuildItem buildUberJar(CurateOutcomeBuildItem curateOutcomeBuildItem,

final List<AppDependency> appDeps = curateOutcomeBuildItem.getEffectiveModel().getUserDependencies();

AppArtifact appArtifact = curateOutcomeBuildItem.getEffectiveModel().getAppArtifact();
// the manifest needs to be the first entry in the jar, otherwise JarInputStream does not work properly
// see https://bugs.openjdk.java.net/browse/JDK-8031748
generateManifest(runnerZipFs, classPath.toString(), packageConfig, appArtifact, applicationInfo);

for (AppDependency appDep : appDeps) {
final AppArtifact depArtifact = appDep.getArtifact();
final Path resolvedDep = depResolver.resolve(depArtifact);
Expand Down Expand Up @@ -261,12 +266,8 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
}
}
}

copyCommonContent(runnerZipFs, services, applicationArchivesBuildItem, transformedClasses, generatedClasses,
generatedResources, seen);
AppArtifact appArtifact = curateOutcomeBuildItem.getEffectiveModel().getAppArtifact();
generateManifest(runnerZipFs, classPath.toString(), packageConfig, appArtifact, applicationInfo);

}

runnerJar.toFile().setReadable(true, false);
Expand Down Expand Up @@ -375,10 +376,13 @@ private void doThinJarGeneration(CurateOutcomeBuildItem curateOutcomeBuildItem,
final List<AppDependency> appDeps = curateOutcomeBuildItem.getEffectiveModel().getUserDependencies();

copyLibraryJars(transformedClasses, libDir, depResolver, classPath, appDeps);
copyCommonContent(runnerZipFs, services, applicationArchivesBuildItem, transformedClasses, allClasses,
generatedResources, seen);

AppArtifact appArtifact = curateOutcomeBuildItem.getEffectiveModel().getAppArtifact();
// the manifest needs to be the first entry in the jar, otherwise JarInputStream does not work properly
// see https://bugs.openjdk.java.net/browse/JDK-8031748
generateManifest(runnerZipFs, classPath.toString(), packageConfig, appArtifact, applicationInfo);
copyCommonContent(runnerZipFs, services, applicationArchivesBuildItem, transformedClasses, allClasses,
generatedResources, seen);
}

private void copyLibraryJars(TransformedClassesBuildItem transformedClasses, Path libDir, AppModelResolver depResolver,
Expand Down Expand Up @@ -528,6 +532,8 @@ private void generateManifest(FileSystem runnerZipFs, final String classPath, Pa
manifest.read(is);
}
Files.delete(manifestPath);
} else {
Files.createDirectories(runnerZipFs.getPath("META-INF"));
}
Attributes attributes = manifest.getMainAttributes();
attributes.put(Attributes.Name.MANIFEST_VERSION, "1.0");
Expand Down
44 changes: 34 additions & 10 deletions integration-tests/maven/src/test/java/io/quarkus/maven/it/PackageIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,24 @@
import static org.junit.jupiter.api.Assertions.assertEquals;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Properties;
import java.util.Set;
import java.util.jar.JarInputStream;
import java.util.jar.Manifest;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

import org.apache.maven.shared.invoker.MavenInvocationException;
import org.assertj.core.util.Arrays;
import org.junit.Assert;
import org.junit.jupiter.api.Test;

Expand All @@ -30,7 +35,7 @@ public class PackageIT extends MojoTestBase {

@Test
public void testPackageWorksWhenUberjarIsFalse()
throws MavenInvocationException, FileNotFoundException, InterruptedException {
throws MavenInvocationException, IOException, InterruptedException {
testDir = initProject("projects/uberjar-check", "projects/project-uberjar-false");

running = new RunningInvoker(testDir, false);
Expand All @@ -40,20 +45,32 @@ public void testPackageWorksWhenUberjarIsFalse()
assertThat(result.getProcess().waitFor()).isEqualTo(0);

final File targetDir = getTargetDir();
assertThat(getNumberOfFilesEndingWith(targetDir, ".jar")).isEqualTo(2);
List<File> jars = getFilesEndingWith(targetDir, ".jar");
assertThat(jars).hasSize(2);

// make sure the jar can be read by JarInputStream
ensureManifestOfJarIsReadableByJarInputStream(
jars.stream().filter(f -> f.getName().contains("-runner")).findFirst().get());
}

private void ensureManifestOfJarIsReadableByJarInputStream(File jar) throws IOException {
try (InputStream fileInputStream = new FileInputStream(jar)) {
Manifest manifest = new JarInputStream(fileInputStream).getManifest();
assertThat(manifest).isNotNull();
}
}

@Test
public void testPackageWorksWhenUberjarIsTrue()
throws MavenInvocationException, FileNotFoundException, InterruptedException {
throws MavenInvocationException, IOException, InterruptedException {
testDir = initProject("projects/uberjar-check", "projects/project-uberjar-true");

createAndVerifyUberJar();
// ensure that subsequent package without clean also works
createAndVerifyUberJar();
}

private void createAndVerifyUberJar() throws FileNotFoundException, MavenInvocationException, InterruptedException {
private void createAndVerifyUberJar() throws IOException, MavenInvocationException, InterruptedException {
Properties p = new Properties();
p.setProperty("quarkus.package.uber-jar", "true");

Expand All @@ -63,8 +80,11 @@ private void createAndVerifyUberJar() throws FileNotFoundException, MavenInvocat
assertThat(result.getProcess().waitFor()).isEqualTo(0);

final File targetDir = getTargetDir();
assertThat(getNumberOfFilesEndingWith(targetDir, ".jar")).isEqualTo(1);
List<File> jars = getFilesEndingWith(targetDir, ".jar");
assertThat(jars).hasSize(1);
assertThat(getNumberOfFilesEndingWith(targetDir, ".original")).isEqualTo(1);

ensureManifestOfJarIsReadableByJarInputStream(jars.get(0));
}

@Test
Expand Down Expand Up @@ -105,7 +125,7 @@ public void testCustomPackaging()
*/
@Test
public void testRunnerUberJarHasValidCRC() throws Exception {
testDir = initProject("projects/uberjar-check", "projects/project-uberjar-true");
testDir = initProject("projects/uberjar-check", "projects/project-uberjar-true2");

running = new RunningInvoker(testDir, false);

Expand Down Expand Up @@ -134,7 +154,7 @@ public void testRunnerUberJarHasValidCRC() throws Exception {
*/
@Test
public void testRunnerJarHasValidCRC() throws Exception {
testDir = initProject("projects/uberjar-check", "projects/project-uberjar-false");
testDir = initProject("projects/uberjar-check", "projects/project-uberjar-false2");

running = new RunningInvoker(testDir, false);
final MavenProcessInvocationResult result = running.execute(Collections.singletonList("package"),
Expand All @@ -150,9 +170,13 @@ public void testRunnerJarHasValidCRC() throws Exception {
assertZipEntriesCanBeOpenedAndClosed(runnerJar);
}

private int getNumberOfFilesEndingWith(File dir, String suffix) {
private List<File> getFilesEndingWith(File dir, String suffix) {
final File[] files = dir.listFiles((d, name) -> name.endsWith(suffix));
return files != null ? files.length : 0;
return files != null ? Arrays.asList(files) : Collections.emptyList();
}

private int getNumberOfFilesEndingWith(File dir, String suffix) {
return getFilesEndingWith(dir, suffix).size();
}

private File getTargetDir() {
Expand Down