Add support for publishing docker images to a registry

This commit adds options to the Maven and Gradle plugins to publish
to a Docker registry the image generated by the image-building goal
and task.

The Docker registry auth configuration added in an earlier commit
was modified to accept separate auth configs for the builder/run
image and the generated image, since it is likely these images will
be stored in separate registries or repositories with distinct
auth required for each.

Fixes gh-21001

Author: scottfrederick

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/AbstractBuildLog.java

@@ -75,6 +75,16 @@ public void pulledImage(Image image, ImageType imageType) {
 		log(String.format(" > Pulled %s '%s'", imageType.getDescription(), getDigest(image)));
 	}
 
+	@Override
+	public Consumer<TotalProgressEvent> pushingImage(ImageReference imageReference) {
+		return getProgressConsumer(String.format(" > Pushing image '%s'", imageReference));
+	}
+
+	@Override
+	public void pushedImage(ImageReference imageReference) {
+		log(String.format(" > Pushed image '%s'", imageReference));
+	}
+
 	@Override
 	public void executingLifecycle(BuildRequest request, LifecycleVersion version, VolumeName buildCacheVolume) {
 		log(" > Executing lifecycle version " + version);

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/BuildLog.java

@@ -92,11 +92,24 @@ public interface BuildLog {
 
 	/**
 	 * Log that an image has been pulled.
-	 * @param image the builder image that was pulled
+	 * @param image the image that was pulled
 	 * @param imageType the image type that was pulled
 	 */
 	void pulledImage(Image image, ImageType imageType);
 
+	/**
+	 * Log that an image is being pushed.
+	 * @param imageReference the image reference
+	 * @return a consumer for progress update events
+	 */
+	Consumer<TotalProgressEvent> pushingImage(ImageReference imageReference);
+
+	/**
+	 * Log that an image has been pushed.
+	 * @param imageReference the image reference
+	 */
+	void pushedImage(ImageReference imageReference);
+
 	/**
 	 * Log that the lifecycle is executing.
 	 * @param request the build request

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/BuildRequest.java

@@ -59,6 +59,8 @@ public class BuildRequest {
 
 	private final PullPolicy pullPolicy;
 
+	private final boolean publish;
+
 	BuildRequest(ImageReference name, Function<Owner, TarArchive> applicationContent) {
 		Assert.notNull(name, "Name must not be null");
 		Assert.notNull(applicationContent, "ApplicationContent must not be null");
@@ -70,12 +72,13 @@ public class BuildRequest {
 		this.cleanCache = false;
 		this.verboseLogging = false;
 		this.pullPolicy = PullPolicy.ALWAYS;
+		this.publish = false;
 		this.creator = Creator.withVersion("");
 	}
 
 	BuildRequest(ImageReference name, Function<Owner, TarArchive> applicationContent, ImageReference builder,
 			ImageReference runImage, Creator creator, Map<String, String> env, boolean cleanCache,
-			boolean verboseLogging, PullPolicy pullPolicy) {
+			boolean verboseLogging, PullPolicy pullPolicy, boolean publish) {
 		this.name = name;
 		this.applicationContent = applicationContent;
 		this.builder = builder;
@@ -85,6 +88,7 @@ public class BuildRequest {
 		this.cleanCache = cleanCache;
 		this.verboseLogging = verboseLogging;
 		this.pullPolicy = pullPolicy;
+		this.publish = publish;
 	}
 
 	/**
@@ -95,7 +99,7 @@ public class BuildRequest {
 	public BuildRequest withBuilder(ImageReference builder) {
 		Assert.notNull(builder, "Builder must not be null");
 		return new BuildRequest(this.name, this.applicationContent, builder.inTaggedOrDigestForm(), this.runImage,
-				this.creator, this.env, this.cleanCache, this.verboseLogging, this.pullPolicy);
+				this.creator, this.env, this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish);
 	}
 
 	/**
@@ -105,7 +109,7 @@ public BuildRequest withBuilder(ImageReference builder) {
 	 */
 	public BuildRequest withRunImage(ImageReference runImageName) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, runImageName.inTaggedOrDigestForm(),
-				this.creator, this.env, this.cleanCache, this.verboseLogging, this.pullPolicy);
+				this.creator, this.env, this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish);
 	}
 
 	/**
@@ -116,7 +120,7 @@ public BuildRequest withRunImage(ImageReference runImageName) {
 	public BuildRequest withCreator(Creator creator) {
 		Assert.notNull(creator, "Creator must not be null");
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, creator, this.env,
-				this.cleanCache, this.verboseLogging, this.pullPolicy);
+				this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish);
 	}
 
 	/**
@@ -131,7 +135,7 @@ public BuildRequest withEnv(String name, String value) {
 		Map<String, String> env = new LinkedHashMap<>(this.env);
 		env.put(name, value);
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator,
-				Collections.unmodifiableMap(env), this.cleanCache, this.verboseLogging, this.pullPolicy);
+				Collections.unmodifiableMap(env), this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish);
 	}
 
 	/**
@@ -144,7 +148,8 @@ public BuildRequest withEnv(Map<String, String> env) {
 		Map<String, String> updatedEnv = new LinkedHashMap<>(this.env);
 		updatedEnv.putAll(env);
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator,
-				Collections.unmodifiableMap(updatedEnv), this.cleanCache, this.verboseLogging, this.pullPolicy);
+				Collections.unmodifiableMap(updatedEnv), this.cleanCache, this.verboseLogging, this.pullPolicy,
+				this.publish);
 	}
 
 	/**
@@ -154,7 +159,7 @@ public BuildRequest withEnv(Map<String, String> env) {
 	 */
 	public BuildRequest withCleanCache(boolean cleanCache) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
-				cleanCache, this.verboseLogging, this.pullPolicy);
+				cleanCache, this.verboseLogging, this.pullPolicy, this.publish);
 	}
 
 	/**
@@ -164,7 +169,7 @@ public BuildRequest withCleanCache(boolean cleanCache) {
 	 */
 	public BuildRequest withVerboseLogging(boolean verboseLogging) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
-				this.cleanCache, verboseLogging, this.pullPolicy);
+				this.cleanCache, verboseLogging, this.pullPolicy, this.publish);
 	}
 
 	/**
@@ -174,7 +179,17 @@ public BuildRequest withVerboseLogging(boolean verboseLogging) {
 	 */
 	public BuildRequest withPullPolicy(PullPolicy pullPolicy) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
-				this.cleanCache, this.verboseLogging, pullPolicy);
+				this.cleanCache, this.verboseLogging, pullPolicy, this.publish);
+	}
+
+	/**
+	 * Return a new {@link BuildRequest} with an updated publish setting.
+	 * @param publish if the built image should be pushed to a registry
+	 * @return an updated build request
+	 */
+	public BuildRequest withPublish(boolean publish) {
+		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
+				this.cleanCache, this.verboseLogging, this.pullPolicy, publish);
 	}
 
 	/**
@@ -244,6 +259,14 @@ public boolean isVerboseLogging() {
 		return this.verboseLogging;
 	}
 
+	/**
+	 * Return if the built image should be pushed to a registry.
+	 * @return if the built image should be pushed to a registry
+	 */
+	public boolean isPublish() {
+		return this.publish;
+	}
+
 	/**
 	 * Return the image {@link PullPolicy} that the builder should use.
 	 * @return image pull policy

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/Builder.java

@@ -23,6 +23,7 @@
 import org.springframework.boot.buildpack.platform.docker.DockerApi;
 import org.springframework.boot.buildpack.platform.docker.TotalProgressEvent;
 import org.springframework.boot.buildpack.platform.docker.TotalProgressPullListener;
+import org.springframework.boot.buildpack.platform.docker.TotalProgressPushListener;
 import org.springframework.boot.buildpack.platform.docker.UpdateListener;
 import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration;
 import org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException;
@@ -45,6 +46,8 @@ public class Builder {
 
 	private final DockerApi docker;
 
+	private final DockerConfiguration dockerConfiguration;
+
 	/**
 	 * Create a new builder instance.
 	 */
@@ -66,7 +69,7 @@ public Builder(DockerConfiguration dockerConfiguration) {
 	 * @param log a logger used to record output
 	 */
 	public Builder(BuildLog log) {
-		this(log, new DockerApi());
+		this(log, new DockerApi(), null);
 	}
 
 	/**
@@ -76,13 +79,14 @@ public Builder(BuildLog log) {
 	 * @since 2.4.0
 	 */
 	public Builder(BuildLog log, DockerConfiguration dockerConfiguration) {
-		this(log, new DockerApi(dockerConfiguration));
+		this(log, new DockerApi(dockerConfiguration), dockerConfiguration);
 	}
 
-	Builder(BuildLog log, DockerApi docker) {
+	Builder(BuildLog log, DockerApi docker, DockerConfiguration dockerConfiguration) {
 		Assert.notNull(log, "Log must not be null");
 		this.log = log;
 		this.docker = docker;
+		this.dockerConfiguration = dockerConfiguration;
 	}
 
 	public void build(BuildRequest request) throws DockerEngineException, IOException {
@@ -97,6 +101,9 @@ public void build(BuildRequest request) throws DockerEngineException, IOExceptio
 		this.docker.image().load(builder.getArchive(), UpdateListener.none());
 		try {
 			executeLifecycle(request, builder);
+			if (request.isPublish()) {
+				pushImage(request.getName());
+			}
 		}
 		finally {
 			this.docker.image().remove(builder.getName(), true);
@@ -143,11 +150,28 @@ private Image getImage(BuildRequest request, ImageType imageType) throws IOExcep
 	private Image pullImage(ImageReference reference, ImageType imageType) throws IOException {
 		Consumer<TotalProgressEvent> progressConsumer = this.log.pullingImage(reference, imageType);
 		TotalProgressPullListener listener = new TotalProgressPullListener(progressConsumer);
-		Image image = this.docker.image().pull(reference, listener);
+		Image image = this.docker.image().pull(reference, listener, getBuilderAuthHeader());
 		this.log.pulledImage(image, imageType);
 		return image;
 	}
 
+	private void pushImage(ImageReference reference) throws IOException {
+		Consumer<TotalProgressEvent> progressConsumer = this.log.pushingImage(reference);
+		TotalProgressPushListener listener = new TotalProgressPushListener(progressConsumer);
+		this.docker.image().push(reference, listener, getPublishAuthHeader());
+		this.log.pushedImage(reference);
+	}
+
+	private String getBuilderAuthHeader() {
+		return (this.dockerConfiguration != null && this.dockerConfiguration.getBuilderRegistryAuthentication() != null)
+				? this.dockerConfiguration.getBuilderRegistryAuthentication().getAuthHeader() : null;
+	}
+
+	private String getPublishAuthHeader() {
+		return (this.dockerConfiguration != null && this.dockerConfiguration.getPublishRegistryAuthentication() != null)
+				? this.dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader() : null;
+	}
+
 	private void assertStackIdsMatch(Image runImage, Image builderImage) {
 		StackId runImageStackId = StackId.fromImage(runImage);
 		StackId builderImageStackId = StackId.fromImage(builderImage);

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/DockerApi.java

@@ -78,7 +78,7 @@ public DockerApi() {
 	 * @since 2.4.0
 	 */
 	public DockerApi(DockerConfiguration dockerConfiguration) {
-		this(HttpTransport.create(dockerConfiguration));
+		this(HttpTransport.create((dockerConfiguration != null) ? dockerConfiguration.getHost() : null));
 	}
 
 	/**
@@ -156,13 +156,26 @@ public class ImageApi {
 		 * @throws IOException on IO error
 		 */
 		public Image pull(ImageReference reference, UpdateListener<PullImageUpdateEvent> listener) throws IOException {
+			return pull(reference, listener, null);
+		}
+
+		/**
+		 * Pull an image from a registry.
+		 * @param reference the image reference to pull
+		 * @param listener a pull listener to receive update events
+		 * @param registryAuth registry authentication credentials
+		 * @return the {@link ImageApi pulled image} instance
+		 * @throws IOException on IO error
+		 */
+		public Image pull(ImageReference reference, UpdateListener<PullImageUpdateEvent> listener, String registryAuth)
+				throws IOException {
 			Assert.notNull(reference, "Reference must not be null");
 			Assert.notNull(listener, "Listener must not be null");
 			URI createUri = buildUrl("/images/create", "fromImage", reference.toString());
 			DigestCaptureUpdateListener digestCapture = new DigestCaptureUpdateListener();
 			listener.onStart();
 			try {
-				try (Response response = http().post(createUri)) {
+				try (Response response = http().post(createUri, registryAuth)) {
 					jsonStream().get(response.getContent(), PullImageUpdateEvent.class, (event) -> {
 						digestCapture.onUpdate(event);
 						listener.onUpdate(event);
@@ -175,6 +188,33 @@ public Image pull(ImageReference reference, UpdateListener<PullImageUpdateEvent>
 			}
 		}
 
+		/**
+		 * Push an image to a registry.
+		 * @param reference the image reference to push
+		 * @param listener a push listener to receive update events
+		 * @param registryAuth registry authentication credentials
+		 * @throws IOException on IO error
+		 */
+		public void push(ImageReference reference, UpdateListener<PushImageUpdateEvent> listener, String registryAuth)
+				throws IOException {
+			Assert.notNull(reference, "Reference must not be null");
+			Assert.notNull(listener, "Listener must not be null");
+			URI pushUri = buildUrl("/images/" + reference + "/push");
+			ErrorCaptureUpdateListener errorListener = new ErrorCaptureUpdateListener();
+			listener.onStart();
+			try {
+				try (Response response = http().post(pushUri, registryAuth)) {
+					jsonStream().get(response.getContent(), PushImageUpdateEvent.class, (event) -> {
+						errorListener.onUpdate(event);
+						listener.onUpdate(event);
+					});
+				}
+			}
+			finally {
+				listener.onFinish();
+			}
+		}
+
 		/**
 		 * Load an {@link ImageArchive} into Docker.
 		 * @param archive the archive to load
@@ -398,4 +438,18 @@ String getCapturedStream() {
 
 	}
 
+	/**
+	 * {@link UpdateListener} used to capture the details of an error in a response
+	 * stream.
+	 */
+	private static class ErrorCaptureUpdateListener implements UpdateListener<PushImageUpdateEvent> {
+
+		@Override
+		public void onUpdate(PushImageUpdateEvent event) {
+			Assert.state(event.getErrorDetail() == null,
+					() -> "Error response received when pushing image: " + event.getErrorDetail().getMessage());
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/ImageProgressUpdateEvent.java

@@ -0,0 +1,43 @@
+/*
+ * 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.springframework.boot.buildpack.platform.docker;
+
+/**
+ * A {@link ProgressUpdateEvent} fired for image events.
+ *
+ * @author Phillip Webb
+ * @author Scott Frederick
+ * @since 2.4.0
+ */
+public class ImageProgressUpdateEvent extends ProgressUpdateEvent {
+
+	private final String id;
+
+	protected ImageProgressUpdateEvent(String id, String status, ProgressDetail progressDetail, String progress) {
+		super(status, progressDetail, progress);
+		this.id = id;
+	}
+
+	/**
+	 * Returns the ID of the image layer being updated if available.
+	 * @return the ID of the updated layer or {@code null}
+	 */
+	public String getId() {
+		return this.id;
+	}
+
+}