Skip to content

Commit 4525a0c

Browse files
philwebbphilwebb
committed
Merge pull request #47284 from DKARAGODIN
* pr/47284: Write signature files to uber wars for Oracle Java 17 verification Closes gh-47284
2 parents b361a1f + 43d91ae commit 4525a0c

File tree

11 files changed

+154
-27
lines changed

11 files changed

+154
-27
lines changed

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,12 @@ private String determineSpringBootVersion() {
122122
}
123123

124124
CopyAction createCopyAction(Jar jar, ResolvedDependencies resolvedDependencies,
125-
LoaderImplementation loaderImplementation, boolean supportsSignatureFile) {
126-
return createCopyAction(jar, resolvedDependencies, loaderImplementation, supportsSignatureFile, null, null);
125+
LoaderImplementation loaderImplementation) {
126+
return createCopyAction(jar, resolvedDependencies, loaderImplementation, null, null);
127127
}
128128

129129
CopyAction createCopyAction(Jar jar, ResolvedDependencies resolvedDependencies,
130-
LoaderImplementation loaderImplementation, boolean supportsSignatureFile, LayerResolver layerResolver,
131-
String jarmodeToolsLocation) {
130+
LoaderImplementation loaderImplementation, LayerResolver layerResolver, String jarmodeToolsLocation) {
132131
File output = jar.getArchiveFile().get().getAsFile();
133132
Manifest manifest = jar.getManifest();
134133
boolean preserveFileTimestamps = jar.isPreserveFileTimestamps();
@@ -143,8 +142,7 @@ CopyAction createCopyAction(Jar jar, ResolvedDependencies resolvedDependencies,
143142
String encoding = jar.getMetadataCharset();
144143
CopyAction action = new BootZipCopyAction(output, manifest, preserveFileTimestamps, dirPermissions,
145144
filePermissions, includeDefaultLoader, jarmodeToolsLocation, requiresUnpack, exclusions, launchScript,
146-
librarySpec, compressionResolver, encoding, resolvedDependencies, supportsSignatureFile, layerResolver,
147-
loaderImplementation);
145+
librarySpec, compressionResolver, encoding, resolvedDependencies, layerResolver, loaderImplementation);
148146
return jar.isReproducibleFileOrder() ? new ReproducibleOrderingCopyAction(action) : action;
149147
}
150148

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ protected CopyAction createCopyAction() {
150150
layerResolver = new LayerResolver(this.resolvedDependencies, this.layered, this::isLibrary);
151151
}
152152
String jarmodeToolsLocation = isIncludeJarmodeTools() ? LIB_DIRECTORY : null;
153-
return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, true, layerResolver,
153+
return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, layerResolver,
154154
jarmodeToolsLocation);
155155
}
156156

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ protected CopyAction createCopyAction() {
124124
layerResolver = new LayerResolver(this.resolvedDependencies, this.layered, this::isLibrary);
125125
}
126126
String jarmodeToolsLocation = isIncludeJarmodeTools() ? LIB_DIRECTORY : null;
127-
return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, false,
128-
layerResolver, jarmodeToolsLocation);
127+
return this.support.createCopyAction(this, this.resolvedDependencies, loaderImplementation, layerResolver,
128+
jarmodeToolsLocation);
129129
}
130130

131131
@SuppressWarnings("removal")

‎spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootZipCopyAction.java‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,6 @@ class BootZipCopyAction implements CopyAction {
114114

115115
private final ResolvedDependencies resolvedDependencies;
116116

117-
private final boolean supportsSignatureFile;
118-
119117
private final LayerResolver layerResolver;
120118

121119
private final LoaderImplementation loaderImplementation;
@@ -124,7 +122,7 @@ class BootZipCopyAction implements CopyAction {
124122
boolean includeDefaultLoader, String jarmodeToolsLocation, Spec<FileTreeElement> requiresUnpack,
125123
Spec<FileTreeElement> exclusions, LaunchScriptConfiguration launchScript, Spec<FileCopyDetails> librarySpec,
126124
Function<FileCopyDetails, ZipCompression> compressionResolver, String encoding,
127-
ResolvedDependencies resolvedDependencies, boolean supportsSignatureFile, LayerResolver layerResolver,
125+
ResolvedDependencies resolvedDependencies, LayerResolver layerResolver,
128126
LoaderImplementation loaderImplementation) {
129127
this.output = output;
130128
this.manifest = manifest;
@@ -140,7 +138,6 @@ class BootZipCopyAction implements CopyAction {
140138
this.compressionResolver = compressionResolver;
141139
this.encoding = encoding;
142140
this.resolvedDependencies = resolvedDependencies;
143-
this.supportsSignatureFile = supportsSignatureFile;
144141
this.layerResolver = layerResolver;
145142
this.loaderImplementation = loaderImplementation;
146143
}
@@ -363,7 +360,7 @@ private void writeJarModeLibrary(String location, JarModeLibrary library) throws
363360
}
364361

365362
private void writeSignatureFileIfNecessary() throws IOException {
366-
if (BootZipCopyAction.this.supportsSignatureFile && hasSignedLibrary()) {
363+
if (hasSignedLibrary()) {
367364
writeEntry("META-INF/BOOT.SF", (out) -> {
368365
}, false);
369366
}

‎spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/AbstractBootArchiveIntegrationTests.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
5050
import org.apache.commons.compress.archivers.zip.ZipFile;
5151
import org.gradle.testkit.runner.BuildResult;
52+
import org.gradle.testkit.runner.BuildTask;
5253
import org.gradle.testkit.runner.TaskOutcome;
5354
import org.junit.jupiter.api.TestTemplate;
5455

@@ -647,6 +648,17 @@ void dirModeAndFileModeAreApplied() throws IOException {
647648
}
648649
}
649650

651+
@TestTemplate
652+
void signed() throws IOException {
653+
BuildTask task = this.gradleBuild.build(this.taskName).task(":" + this.taskName);
654+
assertThat(task).isNotNull();
655+
assertThat(task.getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
656+
File jar = new File(this.gradleBuild.getProjectDir(), "build/libs").listFiles()[0];
657+
try (JarFile jarFile = new JarFile(jar)) {
658+
assertThat(jarFile.getEntry("META-INF/BOOT.SF")).isNotNull();
659+
}
660+
}
661+
650662
private void copyMainClassApplication() throws IOException {
651663
copyApplication("main");
652664
}

‎spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/BootJarIntegrationTests.java‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,12 @@
1616

1717
package org.springframework.boot.gradle.tasks.bundling;
1818

19-
import java.io.File;
2019
import java.io.IOException;
2120
import java.util.Arrays;
2221
import java.util.Set;
2322
import java.util.TreeSet;
24-
import java.util.jar.JarFile;
2523

2624
import org.gradle.testkit.runner.BuildResult;
27-
import org.gradle.testkit.runner.TaskOutcome;
2825
import org.junit.jupiter.api.TestTemplate;
2926

3027
import org.springframework.boot.gradle.junit.GradleCompatibility;
@@ -45,15 +42,6 @@ class BootJarIntegrationTests extends AbstractBootArchiveIntegrationTests {
4542
super("bootJar", "BOOT-INF/lib/", "BOOT-INF/classes/", "BOOT-INF/");
4643
}
4744

48-
@TestTemplate
49-
void signed() throws Exception {
50-
assertThat(this.gradleBuild.build("bootJar").task(":bootJar").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
51-
File jar = new File(this.gradleBuild.getProjectDir(), "build/libs").listFiles()[0];
52-
try (JarFile jarFile = new JarFile(jar)) {
53-
assertThat(jarFile.getEntry("META-INF/BOOT.SF")).isNotNull();
54-
}
55-
}
56-
5745
@TestTemplate
5846
void whenAResolvableCopyOfAnUnresolvableConfigurationIsResolvedThenResolutionSucceeds() {
5947
this.gradleBuild.expectDeprecationWarningsWithAtLeastVersion("8.0").build("build");

‎spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/tasks/bundling/BootWarIntegrationTests-signed.gradle‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/*
2+
* Copyright 2012-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the License);
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
plugins {
18+
id 'war'
19+
id 'java'
20+
id 'org.springframework.boot' version '{version}'
21+
}
22+
23+
bootWar {
24+
mainClass = 'com.example.Application'
25+
}
26+
27+
repositories {
28+
mavenCentral()
29+
maven {
30+
url = 'repository'
31+
}
32+
}
33+
34+
dependencies {
35+
implementation("org.bouncycastle:bcprov-jdk18on:1.78.1")
36+
}

‎spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Repackager.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ public Repackager(File source) {
5151
@Override
5252
protected void writeSignatureFileIfNecessary(Map<String, Library> writtenLibraries, AbstractJarWriter writer)
5353
throws IOException {
54-
if (getSource().getName().toLowerCase(Locale.ROOT).endsWith(".jar") && hasSignedLibrary(writtenLibraries)) {
54+
String sourceName = getSource().getName().toLowerCase(Locale.ROOT);
55+
if ((sourceName.endsWith(".jar") || sourceName.endsWith(".war")) && hasSignedLibrary(writtenLibraries)) {
5556
writer.writeEntry("META-INF/BOOT.SF", (entryWriter) -> {
5657
});
5758
}

‎spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/WarIntegrationTests.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,4 +253,12 @@ void whenEntryIsExcludedItShouldNotBePresentInTheRepackagedWar(MavenBuild mavenB
253253
});
254254
}
255255

256+
@TestTemplate
257+
void whenSigned(MavenBuild mavenBuild) {
258+
mavenBuild.project("war-signed").execute((project) -> {
259+
File repackaged = new File(project, "target/war-signed-0.0.1.BUILD-SNAPSHOT.war");
260+
assertThat(jar(repackaged)).hasEntryWithName("META-INF/BOOT.SF");
261+
});
262+
}
263+
256264
}

‎spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/war-signed/pom.xml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4+
<modelVersion>4.0.0</modelVersion>
5+
<groupId>org.springframework.boot.maven.it</groupId>
6+
<artifactId>war-signed</artifactId>
7+
<version>0.0.1.BUILD-SNAPSHOT</version>
8+
<packaging>war</packaging>
9+
<properties>
10+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
11+
<maven.compiler.source>@java.version@</maven.compiler.source>
12+
<maven.compiler.target>@java.version@</maven.compiler.target>
13+
</properties>
14+
<build>
15+
<plugins>
16+
<plugin>
17+
<groupId>@project.groupId@</groupId>
18+
<artifactId>@project.artifactId@</artifactId>
19+
<version>@project.version@</version>
20+
<executions>
21+
<execution>
22+
<goals>
23+
<goal>repackage</goal>
24+
</goals>
25+
</execution>
26+
</executions>
27+
</plugin>
28+
<plugin>
29+
<groupId>org.apache.maven.plugins</groupId>
30+
<artifactId>maven-war-plugin</artifactId>
31+
<version>@maven-war-plugin.version@</version>
32+
<configuration>
33+
<archive>
34+
<manifest>
35+
<mainClass>some.random.Main</mainClass>
36+
</manifest>
37+
<manifestEntries>
38+
<Not-Used>Foo</Not-Used>
39+
</manifestEntries>
40+
</archive>
41+
</configuration>
42+
</plugin>
43+
</plugins>
44+
</build>
45+
<dependencies>
46+
<dependency>
47+
<groupId>org.springframework</groupId>
48+
<artifactId>spring-context</artifactId>
49+
<version>@spring-framework.version@</version>
50+
</dependency>
51+
<dependency>
52+
<groupId>jakarta.servlet</groupId>
53+
<artifactId>jakarta.servlet-api</artifactId>
54+
<version>@jakarta-servlet.version@</version>
55+
<scope>provided</scope>
56+
</dependency>
57+
<dependency>
58+
<groupId>org.bouncycastle</groupId>
59+
<artifactId>bcprov-jdk18on</artifactId>
60+
<version>1.78.1</version>
61+
</dependency>
62+
</dependencies>
63+
</project>

0 commit comments

Comments
 (0)