Skip to content

Commit a7dfeae

Browse files
scottfrederickscottfrederick
committed
Merge branch 'gh-28844' into 2.6.x
Closes gh-31823
2 parents ab2b04f + 9b0cdac commit a7dfeae

File tree

14 files changed

+49
-74
lines changed

14 files changed

+49
-74
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: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2020 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.
@@ -90,4 +90,9 @@ public DockerConfiguration withPublishRegistryUserAuthentication(String username
9090
new DockerRegistryUserAuthentication(username, password, url, email));
9191
}
9292

93+
public DockerConfiguration withEmptyPublishRegistryAuthentication() {
94+
return new DockerConfiguration(this.host, this.builderAuthentication,
95+
new DockerRegistryUserAuthentication("", "", "", ""));
96+
}
97+
9398
}

‎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
@@ -368,7 +368,10 @@ An OCI image containing a https://buildpacks.io/docs/buildpack-author-guide/pack
368368

369369
[[build-image.examples.publish]]
370370
=== Image Publishing
371-
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.
371+
The generated image can be published to a Docker registry by enabling a `publish` option.
372+
373+
If the Docker registry requires authentication, the credentials can be configured using `docker.publishRegistry` properties.
374+
If the Docker registry does not require authentication, the `docker.publishRegistry` configuration can be omitted.
372375

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

‎spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImage.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.
@@ -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;
@@ -605,11 +604,6 @@ private BuildRequest customizePullPolicy(BuildRequest request) {
605604
}
606605

607606
private BuildRequest customizePublish(BuildRequest request) {
608-
boolean publishRegistryAuthNotConfigured = this.docker == null || this.docker.getPublishRegistry() == null
609-
|| this.docker.getPublishRegistry().hasEmptyAuth();
610-
if (this.publish && publishRegistryAuthNotConfigured) {
611-
throw new GradleException("Publishing an image requires docker.publishRegistry to be configured");
612-
}
613607
request = request.withPublish(this.publish);
614608
return request;
615609
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2020 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.
@@ -179,7 +179,7 @@ private DockerConfiguration customizeBuilderAuthentication(DockerConfiguration d
179179

180180
private DockerConfiguration customizePublishAuthentication(DockerConfiguration dockerConfiguration) {
181181
if (this.publishRegistry == null || this.publishRegistry.hasEmptyAuth()) {
182-
return dockerConfiguration;
182+
return dockerConfiguration.withEmptyPublishRegistryAuthentication();
183183
}
184184
if (this.publishRegistry.hasTokenAuth() && !this.publishRegistry.hasUserAuth()) {
185185
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: 13 additions & 6 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.
@@ -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
@@ -54,7 +57,9 @@ void asDockerConfigurationWithHostConfiguration() {
5457
assertThat(host.isSecure()).isEqualTo(true);
5558
assertThat(host.getCertificatePath()).isEqualTo("/tmp/ca-cert");
5659
assertThat(dockerSpec.asDockerConfiguration().getBuilderRegistryAuthentication()).isNull();
57-
assertThat(dockerSpec.asDockerConfiguration().getPublishRegistryAuthentication()).isNull();
60+
assertThat(decoded(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()))
61+
.contains("\"username\" : \"\"").contains("\"password\" : \"\"").contains("\"email\" : \"\"")
62+
.contains("\"serveraddress\" : \"\"");
5863
}
5964

6065
@Test
@@ -67,7 +72,9 @@ void asDockerConfigurationWithHostConfigurationNoTlsVerify() {
6772
assertThat(host.isSecure()).isEqualTo(false);
6873
assertThat(host.getCertificatePath()).isNull();
6974
assertThat(dockerSpec.asDockerConfiguration().getBuilderRegistryAuthentication()).isNull();
70-
assertThat(dockerSpec.asDockerConfiguration().getPublishRegistryAuthentication()).isNull();
75+
assertThat(decoded(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()))
76+
.contains("\"username\" : \"\"").contains("\"password\" : \"\"").contains("\"email\" : \"\"")
77+
.contains("\"serveraddress\" : \"\"");
7178
}
7279

7380
@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
@@ -338,7 +338,10 @@ An OCI image containing a https://buildpacks.io/docs/buildpack-author-guide/pack
338338

339339
[[build-image.examples.publish]]
340340
=== Image Publishing
341-
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.
341+
The generated image can be published to a Docker registry by enabling a `publish` option.
342+
343+
If the Docker registry requires authentication, the credentials can be configured using `docker.publishRegistry` parameters.
344+
If the Docker registry does not require authentication, the `docker.publishRegistry` configuration can be omitted.
342345

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

‎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")

0 commit comments

Comments
 (0)