Skip to content

Commit 09c7ce6

Browse files
scottfrederickscottfrederick
committed
Merge branch '2.6.x' into 2.7.x
Closes gh-31824
2 parents 2e98caf + a7dfeae commit 09c7ce6

File tree

14 files changed

+43
-68
lines changed

14 files changed

+43
-68
lines changed

‎spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/configuration/DockerConfiguration.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,9 @@ public DockerConfiguration withPublishRegistryUserAuthentication(String username
102102
new DockerRegistryUserAuthentication(username, password, url, email), this.bindHostToBuilder);
103103
}
104104

105+
public DockerConfiguration withEmptyPublishRegistryAuthentication() {
106+
return new DockerConfiguration(this.host, this.builderAuthentication,
107+
new DockerRegistryUserAuthentication("", "", "", ""));
108+
}
109+
105110
}

‎spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/packaging-oci-image.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,10 @@ An OCI image containing a https://buildpacks.io/docs/buildpack-author-guide/pack
369369

370370
[[build-image.examples.publish]]
371371
=== Image Publishing
372-
The generated image can be published to a Docker registry by enabling a `publish` option and configuring authentication for the registry using `docker.publishRegistry` properties.
372+
The generated image can be published to a Docker registry by enabling a `publish` option.
373+
374+
If the Docker registry requires authentication, the credentials can be configured using `docker.publishRegistry` properties.
375+
If the Docker registry does not require authentication, the `docker.publishRegistry` configuration can be omitted.
373376

374377
[source,groovy,indent=0,subs="verbatim,attributes",role="primary"]
375378
.Groovy

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
import groovy.lang.Closure;
2626
import org.gradle.api.Action;
2727
import org.gradle.api.DefaultTask;
28-
import org.gradle.api.GradleException;
2928
import org.gradle.api.JavaVersion;
3029
import org.gradle.api.Project;
3130
import org.gradle.api.Task;
@@ -594,11 +593,6 @@ private BuildRequest customizePullPolicy(BuildRequest request) {
594593
}
595594

596595
private BuildRequest customizePublish(BuildRequest request) {
597-
boolean publishRegistryAuthNotConfigured = this.docker == null || this.docker.getPublishRegistry() == null
598-
|| this.docker.getPublishRegistry().hasEmptyAuth();
599-
if (this.publish && publishRegistryAuthNotConfigured) {
600-
throw new GradleException("Publishing an image requires docker.publishRegistry to be configured");
601-
}
602596
request = request.withPublish(this.publish);
603597
return request;
604598
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ private DockerConfiguration customizeBuilderAuthentication(DockerConfiguration d
192192

193193
private DockerConfiguration customizePublishAuthentication(DockerConfiguration dockerConfiguration) {
194194
if (this.publishRegistry == null || this.publishRegistry.hasEmptyAuth()) {
195-
return dockerConfiguration;
195+
return dockerConfiguration.withEmptyPublishRegistryAuthentication();
196196
}
197197
if (this.publishRegistry.hasTokenAuth() && !this.publishRegistry.hasUserAuth()) {
198198
return dockerConfiguration.withPublishRegistryTokenAuthentication(this.publishRegistry.getToken());

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2021 the original author or authors.
2+
* Copyright 2012-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -313,15 +313,6 @@ void failsWithInvalidImageName() throws IOException {
313313
.containsPattern("example/Invalid-Image-Name");
314314
}
315315

316-
@TestTemplate
317-
void failsWithPublishMissingPublishRegistry() throws IOException {
318-
writeMainClass();
319-
writeLongNameResource();
320-
BuildResult result = this.gradleBuild.buildAndFail("bootBuildImage", "--publishImage");
321-
assertThat(result.task(":bootBuildImage").getOutcome()).isEqualTo(TaskOutcome.FAILED);
322-
assertThat(result.getOutput()).contains("requires docker.publishRegistry");
323-
}
324-
325316
@TestTemplate
326317
void failsWithBuildpackNotInBuilder() throws IOException {
327318
writeMainClass();

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2021 the original author or authors.
2+
* Copyright 2012-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -21,7 +21,6 @@
2121
import java.util.HashMap;
2222
import java.util.Map;
2323

24-
import org.gradle.api.GradleException;
2524
import org.gradle.api.JavaVersion;
2625
import org.gradle.api.Project;
2726
import org.junit.jupiter.api.BeforeEach;
@@ -36,7 +35,6 @@
3635
import org.springframework.boot.gradle.junit.GradleProjectBuilder;
3736

3837
import static org.assertj.core.api.Assertions.assertThat;
39-
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
4038

4139
/**
4240
* Tests for {@link BootBuildImage}.
@@ -189,13 +187,6 @@ void whenUsingDefaultConfigurationThenRequestHasPublishDisabled() {
189187
assertThat(this.buildImage.createRequest().isPublish()).isFalse();
190188
}
191189

192-
@Test
193-
void whenPublishIsEnabledWithoutPublishRegistryThenExceptionIsThrown() {
194-
this.buildImage.setPublish(true);
195-
assertThatExceptionOfType(GradleException.class).isThrownBy(this.buildImage::createRequest)
196-
.withMessageContaining("Publishing an image requires docker.publishRegistry to be configured");
197-
}
198-
199190
@Test
200191
void whenNoBuilderIsConfiguredThenRequestHasDefaultBuilder() {
201192
assertThat(this.buildImage.createRequest().getBuilder().getName()).isEqualTo("paketobuildpacks/builder");

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,12 @@ class DockerSpecTests {
3737
@Test
3838
void asDockerConfigurationWithDefaults() {
3939
DockerSpec dockerSpec = new DockerSpec();
40-
assertThat(dockerSpec.asDockerConfiguration().getHost()).isNull();
41-
assertThat(dockerSpec.asDockerConfiguration().getBuilderRegistryAuthentication()).isNull();
42-
assertThat(dockerSpec.asDockerConfiguration().getPublishRegistryAuthentication()).isNull();
40+
DockerConfiguration dockerConfiguration = dockerSpec.asDockerConfiguration();
41+
assertThat(dockerConfiguration.getHost()).isNull();
42+
assertThat(dockerConfiguration.getBuilderRegistryAuthentication()).isNull();
43+
assertThat(decoded(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()))
44+
.contains("\"username\" : \"\"").contains("\"password\" : \"\"").contains("\"email\" : \"\"")
45+
.contains("\"serveraddress\" : \"\"");
4346
}
4447

4548
@Test
@@ -55,7 +58,9 @@ void asDockerConfigurationWithHostConfiguration() {
5558
assertThat(host.getCertificatePath()).isEqualTo("/tmp/ca-cert");
5659
assertThat(dockerConfiguration.isBindHostToBuilder()).isFalse();
5760
assertThat(dockerSpec.asDockerConfiguration().getBuilderRegistryAuthentication()).isNull();
58-
assertThat(dockerSpec.asDockerConfiguration().getPublishRegistryAuthentication()).isNull();
61+
assertThat(decoded(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()))
62+
.contains("\"username\" : \"\"").contains("\"password\" : \"\"").contains("\"email\" : \"\"")
63+
.contains("\"serveraddress\" : \"\"");
5964
}
6065

6166
@Test
@@ -84,7 +89,9 @@ void asDockerConfigurationWithBindHostToBuilder() {
8489
assertThat(host.getCertificatePath()).isNull();
8590
assertThat(dockerConfiguration.isBindHostToBuilder()).isTrue();
8691
assertThat(dockerSpec.asDockerConfiguration().getBuilderRegistryAuthentication()).isNull();
87-
assertThat(dockerSpec.asDockerConfiguration().getPublishRegistryAuthentication()).isNull();
92+
assertThat(decoded(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()))
93+
.contains("\"username\" : \"\"").contains("\"password\" : \"\"").contains("\"email\" : \"\"")
94+
.contains("\"serveraddress\" : \"\"");
8895
}
8996

9097
@Test

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ sourceCompatibility = '1.8'
77
targetCompatibility = '1.8'
88

99
bootBuildImage {
10+
builder = "projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1"
1011
publish = true
11-
docker {
12-
publishRegistry {
13-
username = "user"
14-
password = "secret"
15-
}
16-
}
1712
}

‎spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging-oci-image.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,10 @@ An OCI image containing a https://buildpacks.io/docs/buildpack-author-guide/pack
339339

340340
[[build-image.examples.publish]]
341341
=== Image Publishing
342-
The generated image can be published to a Docker registry by enabling a `publish` option and configuring authentication for the registry using `docker.publishRegistry` parameters.
342+
The generated image can be published to a Docker registry by enabling a `publish` option.
343+
344+
If the Docker registry requires authentication, the credentials can be configured using `docker.publishRegistry` parameters.
345+
If the Docker registry does not require authentication, the `docker.publishRegistry` configuration can be omitted.
343346

344347
[source,xml,indent=0,subs="verbatim,attributes",tabsize=4]
345348
----

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2021 the original author or authors.
2+
* Copyright 2012-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -330,12 +330,6 @@ void failsWhenBuildImageIsInvokedOnMultiModuleProjectWithBuildImageGoal(MavenBui
330330
(project) -> assertThat(buildLog(project)).contains("Error packaging archive for image"));
331331
}
332332

333-
@TestTemplate
334-
void failsWhenPublishWithoutPublishRegistryConfigured(MavenBuild mavenBuild) {
335-
mavenBuild.project("build-image").goals("package").systemProperty("spring-boot.build-image.publish", "true")
336-
.executeAndFail((project) -> assertThat(buildLog(project)).contains("requires docker.publishRegistry"));
337-
}
338-
339333
@TestTemplate
340334
void failsWhenBuilderFails(MavenBuild mavenBuild) {
341335
mavenBuild.project("build-image-builder-error").goals("package")

‎spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-publish/pom.xml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,9 @@
2323
</goals>
2424
<configuration>
2525
<image>
26+
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
2627
<publish>true</publish>
2728
</image>
28-
<docker>
29-
<publishRegistry>
30-
<username>user</username>
31-
<password>secret</password>
32-
</publishRegistry>
33-
</docker>
3429
</configuration>
3530
</execution>
3631
</executions>

‎spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ private void buildImage() throws MojoExecutionException {
224224
Libraries libraries = getLibraries(Collections.emptySet());
225225
try {
226226
DockerConfiguration dockerConfiguration = (this.docker != null) ? this.docker.asDockerConfiguration()
227-
: null;
227+
: new Docker().asDockerConfiguration();
228228
BuildRequest request = getBuildRequest(libraries);
229229
Builder builder = new Builder(new MojoBuildLog(this::getLog), dockerConfiguration);
230230
builder.build(request);
@@ -234,7 +234,7 @@ private void buildImage() throws MojoExecutionException {
234234
}
235235
}
236236

237-
private BuildRequest getBuildRequest(Libraries libraries) throws MojoExecutionException {
237+
private BuildRequest getBuildRequest(Libraries libraries) {
238238
ImagePackager imagePackager = new ImagePackager(getArchiveFile(), getBackupFile());
239239
Function<Owner, TarArchive> content = (owner) -> getApplicationContent(owner, libraries, imagePackager);
240240
Image image = (this.image != null) ? this.image : new Image();
@@ -259,17 +259,9 @@ private BuildRequest getBuildRequest(Libraries libraries) throws MojoExecutionEx
259259
if (image.network == null && this.network != null) {
260260
image.setNetwork(this.network);
261261
}
262-
if (image.publish != null && image.publish && publishRegistryNotConfigured()) {
263-
throw new MojoExecutionException("Publishing an image requires docker.publishRegistry to be configured");
264-
}
265262
return customize(image.getBuildRequest(this.project.getArtifact(), content));
266263
}
267264

268-
private boolean publishRegistryNotConfigured() {
269-
return this.docker == null || this.docker.getPublishRegistry() == null
270-
|| this.docker.getPublishRegistry().isEmpty();
271-
}
272-
273265
private TarArchive getApplicationContent(Owner owner, Libraries libraries, ImagePackager imagePackager) {
274266
ImagePackager packager = getConfiguredPackager(() -> imagePackager);
275267
return new PackagedTarArchive(owner, libraries, packager);

‎spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Docker.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ private DockerConfiguration customizeBuilderAuthentication(DockerConfiguration d
161161

162162
private DockerConfiguration customizePublishAuthentication(DockerConfiguration dockerConfiguration) {
163163
if (this.publishRegistry == null || this.publishRegistry.isEmpty()) {
164-
return dockerConfiguration;
164+
return dockerConfiguration.withEmptyPublishRegistryAuthentication();
165165
}
166166
if (this.publishRegistry.hasTokenAuth() && !this.publishRegistry.hasUserAuth()) {
167167
return dockerConfiguration.withPublishRegistryTokenAuthentication(this.publishRegistry.getToken());

‎spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/DockerTests.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,12 @@ class DockerTests {
3636
@Test
3737
void asDockerConfigurationWithDefaults() {
3838
Docker docker = new Docker();
39-
assertThat(docker.asDockerConfiguration().getHost()).isNull();
40-
assertThat(docker.asDockerConfiguration().getBuilderRegistryAuthentication()).isNull();
41-
assertThat(docker.asDockerConfiguration().getPublishRegistryAuthentication()).isNull();
39+
DockerConfiguration dockerConfiguration = docker.asDockerConfiguration();
40+
assertThat(dockerConfiguration.getHost()).isNull();
41+
assertThat(dockerConfiguration.getBuilderRegistryAuthentication()).isNull();
42+
assertThat(decoded(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()))
43+
.contains("\"username\" : \"\"").contains("\"password\" : \"\"").contains("\"email\" : \"\"")
44+
.contains("\"serveraddress\" : \"\"");
4245
}
4346

4447
@Test
@@ -71,7 +74,9 @@ void asDockerConfigurationWithBindHostToBuilder() {
7174
assertThat(host.getCertificatePath()).isEqualTo("/tmp/ca-cert");
7275
assertThat(dockerConfiguration.isBindHostToBuilder()).isTrue();
7376
assertThat(docker.asDockerConfiguration().getBuilderRegistryAuthentication()).isNull();
74-
assertThat(docker.asDockerConfiguration().getPublishRegistryAuthentication()).isNull();
77+
assertThat(decoded(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()))
78+
.contains("\"username\" : \"\"").contains("\"password\" : \"\"").contains("\"email\" : \"\"")
79+
.contains("\"serveraddress\" : \"\"");
7580
}
7681

7782
@Test

0 commit comments

Comments
 (0)