Relocate DockerConfiguration and refactor buildpack platform code

Relate `DockerConfiguration` from `...platform.docker` to
`...platform.build` since it contains build specific concepts.

This commit also refactors a few other areas of the code to make it
easier to support credential helpers in the future.

Closes gh-45283

Author: philwebb

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

@@ -26,7 +26,8 @@
 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.configuration.DockerConnectionConfiguration;
+import org.springframework.boot.buildpack.platform.docker.configuration.DockerRegistryAuthentication;
 import org.springframework.boot.buildpack.platform.docker.configuration.ResolvedDockerHost;
 import org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException;
 import org.springframework.boot.buildpack.platform.docker.type.Binding;
@@ -54,7 +55,7 @@ public class Builder {
 
 	private final DockerApi docker;
 
-	private final DockerConfiguration dockerConfiguration;
+	private final BuilderDockerConfiguration dockerConfiguration;
 
 	/**
 	 * Create a new builder instance.
@@ -67,8 +68,22 @@ public Builder() {
 	 * Create a new builder instance.
 	 * @param dockerConfiguration the docker configuration
 	 * @since 2.4.0
+	 * @deprecated since 3.5.0 for removal in 4.0.0 in favor of
+	 * {@link #Builder(BuilderDockerConfiguration)}
 	 */
-	public Builder(DockerConfiguration dockerConfiguration) {
+	@Deprecated(since = "3.5.0", forRemoval = true)
+	@SuppressWarnings("removal")
+	public Builder(
+			org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration dockerConfiguration) {
+		this(BuildLog.toSystemOut(), dockerConfiguration);
+	}
+
+	/**
+	 * Create a new builder instance.
+	 * @param dockerConfiguration the docker configuration
+	 * @since 3.5.0
+	 */
+	public Builder(BuilderDockerConfiguration dockerConfiguration) {
 		this(BuildLog.toSystemOut(), dockerConfiguration);
 	}
 
@@ -85,17 +100,45 @@ public Builder(BuildLog log) {
 	 * @param log a logger used to record output
 	 * @param dockerConfiguration the docker configuration
 	 * @since 2.4.0
+	 * @deprecated since 3.5.0 for removal in 4.0.0 in favor of
+	 * {@link #Builder(BuildLog, BuilderDockerConfiguration)}
 	 */
-	public Builder(BuildLog log, DockerConfiguration dockerConfiguration) {
-		this(log, new DockerApi((dockerConfiguration != null) ? dockerConfiguration.getHost() : null,
+	@Deprecated(since = "3.5.0", forRemoval = true)
+	@SuppressWarnings("removal")
+	public Builder(BuildLog log,
+			org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration dockerConfiguration) {
+		this(log, adaptDeprecatedConfiguration(dockerConfiguration));
+	}
+
+	@SuppressWarnings("removal")
+	private static BuilderDockerConfiguration adaptDeprecatedConfiguration(
+			org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration configuration) {
+		if (configuration == null) {
+			return null;
+		}
+		DockerConnectionConfiguration connection = org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration.DockerHostConfiguration
+			.asConnectionConfiguration(configuration.getHost());
+		return new BuilderDockerConfiguration(connection, configuration.isBindHostToBuilder(),
+				configuration.getBuilderRegistryAuthentication(), configuration.getPublishRegistryAuthentication());
+	}
+
+	/**
+	 * Create a new builder instance.
+	 * @param log a logger used to record output
+	 * @param dockerConfiguration the docker configuration
+	 * @since 3.5.0
+	 */
+	public Builder(BuildLog log, BuilderDockerConfiguration dockerConfiguration) {
+		this(log, new DockerApi((dockerConfiguration != null) ? dockerConfiguration.connection() : null,
 				BuildLogAdapter.get(log)), dockerConfiguration);
 	}
 
-	Builder(BuildLog log, DockerApi docker, DockerConfiguration dockerConfiguration) {
+	Builder(BuildLog log, DockerApi docker, BuilderDockerConfiguration dockerConfiguration) {
 		Assert.notNull(log, "'log' must not be null");
 		this.log = log;
 		this.docker = docker;
-		this.dockerConfiguration = dockerConfiguration;
+		this.dockerConfiguration = (dockerConfiguration != null) ? dockerConfiguration
+				: new BuilderDockerConfiguration();
 	}
 
 	public void build(BuildRequest request) throws DockerEngineException, IOException {
@@ -104,8 +147,8 @@ public void build(BuildRequest request) throws DockerEngineException, IOExceptio
 		validateBindings(request.getBindings());
 		String domain = request.getBuilder().getDomain();
 		PullPolicy pullPolicy = request.getPullPolicy();
-		ImageFetcher imageFetcher = new ImageFetcher(domain, getBuilderAuthHeader(), pullPolicy,
-				request.getImagePlatform());
+		ImageFetcher imageFetcher = new ImageFetcher(domain, this.dockerConfiguration.builderRegistryAuthentication(),
+				pullPolicy, request.getImagePlatform());
 		Image builderImage = imageFetcher.fetchImage(ImageType.BUILDER, request.getBuilder());
 		BuilderMetadata builderMetadata = BuilderMetadata.fromImage(builderImage);
 		request = withRunImageIfNeeded(request, builderMetadata);
@@ -182,8 +225,8 @@ private void executeLifecycle(EphemeralBuilder builder, Lifecycle lifecycle) thr
 	}
 
 	private ResolvedDockerHost getDockerHost() {
-		boolean bindHostToBuilder = this.dockerConfiguration != null && this.dockerConfiguration.isBindHostToBuilder();
-		return (bindHostToBuilder) ? ResolvedDockerHost.from(this.dockerConfiguration.getHost()) : null;
+		boolean bindToBuilder = this.dockerConfiguration.bindHostToBuilder();
+		return (bindToBuilder) ? ResolvedDockerHost.from(this.dockerConfiguration.connection()) : null;
 	}
 
 	private void tagImage(ImageReference sourceReference, List<ImageReference> tags) throws IOException {
@@ -203,18 +246,13 @@ private void pushImages(ImageReference name, List<ImageReference> tags) throws I
 	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());
+		String authHeader = authHeader(this.dockerConfiguration.publishRegistryAuthentication());
+		this.docker.image().push(reference, listener, authHeader);
 		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 static String authHeader(DockerRegistryAuthentication authentication) {
+		return (authentication != null) ? authentication.getAuthHeader() : null;
 	}
 
 	/**
@@ -224,23 +262,25 @@ private class ImageFetcher {
 
 		private final String domain;
 
-		private final String authHeader;
+		private final DockerRegistryAuthentication registryAuthentication;
 
 		private final PullPolicy pullPolicy;
 
 		private ImagePlatform defaultPlatform;
 
-		ImageFetcher(String domain, String authHeader, PullPolicy pullPolicy, ImagePlatform platform) {
+		ImageFetcher(String domain, DockerRegistryAuthentication registryAuthentication, PullPolicy pullPolicy,
+				ImagePlatform platform) {
 			this.domain = domain;
-			this.authHeader = authHeader;
+			this.registryAuthentication = registryAuthentication;
 			this.pullPolicy = pullPolicy;
 			this.defaultPlatform = platform;
 		}
 
 		Image fetchImage(ImageType type, ImageReference reference) throws IOException {
 			Assert.notNull(type, "'type' must not be null");
 			Assert.notNull(reference, "'reference' must not be null");
-			Assert.state(this.authHeader == null || reference.getDomain().equals(this.domain),
+			String authHeader = authHeader(this.registryAuthentication);
+			Assert.state(authHeader == null || reference.getDomain().equals(this.domain),
 					() -> String.format("%s '%s' must be pulled from the '%s' authenticated registry",
 							StringUtils.capitalize(type.getDescription()), reference, this.domain));
 			if (this.pullPolicy == PullPolicy.ALWAYS) {
@@ -260,7 +300,8 @@ Image fetchImage(ImageType type, ImageReference reference) throws IOException {
 		private Image pullImage(ImageReference reference, ImageType imageType) throws IOException {
 			TotalProgressPullListener listener = new TotalProgressPullListener(
 					Builder.this.log.pullingImage(reference, this.defaultPlatform, imageType));
-			Image image = Builder.this.docker.image().pull(reference, this.defaultPlatform, listener, this.authHeader);
+			String authHeader = authHeader(this.registryAuthentication);
+			Image image = Builder.this.docker.image().pull(reference, this.defaultPlatform, listener, authHeader);
 			Builder.this.log.pulledImage(image, imageType);
 			if (this.defaultPlatform == null) {
 				this.defaultPlatform = ImagePlatform.from(image);

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

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2012-2025 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.build;
+
+import org.springframework.boot.buildpack.platform.docker.configuration.DockerConnectionConfiguration;
+import org.springframework.boot.buildpack.platform.docker.configuration.DockerRegistryAuthentication;
+
+/**
+ * {@link Builder} configuration options for Docker.
+ *
+ * @param connection the Docker host configuration
+ * @param bindHostToBuilder if the host resolved from the connection should be bound to
+ * the builder
+ * @param builderRegistryAuthentication the builder {@link DockerRegistryAuthentication}
+ * @param publishRegistryAuthentication the publish {@link DockerRegistryAuthentication}
+ * @author Phillip Webb
+ * @author Wei Jiang
+ * @author Scott Frederick
+ * @since 3.5.0
+ */
+public record BuilderDockerConfiguration(DockerConnectionConfiguration connection, boolean bindHostToBuilder,
+		DockerRegistryAuthentication builderRegistryAuthentication,
+		DockerRegistryAuthentication publishRegistryAuthentication) {
+
+	public BuilderDockerConfiguration() {
+		this(null, false, null, null);
+	}
+
+	public BuilderDockerConfiguration withContext(String context) {
+		return withConnection(new DockerConnectionConfiguration.Context(context));
+	}
+
+	public BuilderDockerConfiguration withHost(String address, boolean secure, String certificatePath) {
+		return withConnection(new DockerConnectionConfiguration.Host(address, secure, certificatePath));
+	}
+
+	private BuilderDockerConfiguration withConnection(DockerConnectionConfiguration hostConfiguration) {
+		return new BuilderDockerConfiguration(hostConfiguration, this.bindHostToBuilder,
+				this.builderRegistryAuthentication, this.publishRegistryAuthentication);
+	}
+
+	public BuilderDockerConfiguration withBindHostToBuilder(boolean bindHostToBuilder) {
+		return new BuilderDockerConfiguration(this.connection, bindHostToBuilder, this.builderRegistryAuthentication,
+				this.publishRegistryAuthentication);
+	}
+
+	public BuilderDockerConfiguration withBuilderRegistryAuthentication(
+			DockerRegistryAuthentication builderRegistryAuthentication) {
+		return new BuilderDockerConfiguration(this.connection, this.bindHostToBuilder, builderRegistryAuthentication,
+				this.publishRegistryAuthentication);
+
+	}
+
+	public BuilderDockerConfiguration withPublishRegistryAuthentication(
+			DockerRegistryAuthentication publishRegistryAuthentication) {
+		return new BuilderDockerConfiguration(this.connection, this.bindHostToBuilder,
+				this.builderRegistryAuthentication, publishRegistryAuthentication);
+	}
+
+}

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

@@ -28,7 +28,7 @@
 import org.apache.hc.core5.http.Header;
 import org.apache.hc.core5.net.URIBuilder;
 
-import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration.DockerHostConfiguration;
+import org.springframework.boot.buildpack.platform.docker.configuration.DockerConnectionConfiguration;
 import org.springframework.boot.buildpack.platform.docker.transport.HttpTransport;
 import org.springframework.boot.buildpack.platform.docker.transport.HttpTransport.Response;
 import org.springframework.boot.buildpack.platform.docker.type.ApiVersion;
@@ -87,26 +87,32 @@ public class DockerApi {
 	 * Create a new {@link DockerApi} instance.
 	 */
 	public DockerApi() {
-		this(null);
+		this(HttpTransport.create((DockerConnectionConfiguration) null), DockerLog.toSystemOut());
 	}
 
 	/**
 	 * Create a new {@link DockerApi} instance.
 	 * @param dockerHost the Docker daemon host information
 	 * @since 2.4.0
+	 * @deprecated since 3.5.0 for removal in 4.0.0 in favor of
+	 * {@link #DockerApi(DockerConnectionConfiguration, DockerLog)}
 	 */
-	public DockerApi(DockerHostConfiguration dockerHost) {
-		this(dockerHost, DockerLog.toSystemOut());
+	@Deprecated(since = "3.5.0", forRemoval = true)
+	@SuppressWarnings("removal")
+	public DockerApi(
+			org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration.DockerHostConfiguration dockerHost) {
+		this(org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration.DockerHostConfiguration
+			.asConnectionConfiguration(dockerHost), DockerLog.toSystemOut());
 	}
 
 	/**
 	 * Create a new {@link DockerApi} instance.
-	 * @param dockerHost the Docker daemon host information
+	 * @param connectionConfiguration the connection configuration to use
 	 * @param log a logger used to record output
 	 * @since 3.5.0
 	 */
-	public DockerApi(DockerHostConfiguration dockerHost, DockerLog log) {
-		this(HttpTransport.create(dockerHost), log);
+	public DockerApi(DockerConnectionConfiguration connectionConfiguration, DockerLog log) {
+		this(HttpTransport.create(connectionConfiguration), log);
 	}
 
 	/**

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

@@ -17,14 +17,19 @@
 package org.springframework.boot.buildpack.platform.docker.configuration;
 
 import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
 
 /**
  * Docker configuration options.
  *
  * @author Wei Jiang
  * @author Scott Frederick
  * @since 2.4.0
+ * @deprecated since 3.5.0 for removal in 4.0.0 in favor of
+ * {@link org.springframework.boot.buildpack.platform.build.BuilderDockerConfiguration}.
  */
+@Deprecated(since = "3.5.0", forRemoval = true)
+@SuppressWarnings("removal")
 public final class DockerConfiguration {
 
 	private final DockerHostConfiguration host;
@@ -113,6 +118,13 @@ public DockerConfiguration withEmptyPublishRegistryAuthentication() {
 				new DockerRegistryUserAuthentication("", "", "", ""), this.bindHostToBuilder);
 	}
 
+	/**
+	 * Docker host configuration.
+	 *
+	 * @deprecated since 3.5.0 for removal in 4.0.0 in favor of
+	 * {@link DockerHostConfiguration}
+	 */
+	@Deprecated(since = "3.5.0", forRemoval = true)
 	public static class DockerHostConfiguration {
 
 		private final String address;
@@ -158,6 +170,24 @@ static DockerHostConfiguration forContext(String context) {
 			return new DockerHostConfiguration(null, context, false, null);
 		}
 
+		/**
+		 * Adapts a {@link DockerHostConfiguration} to a
+		 * {@link DockerConnectionConfiguration}.
+		 * @param configuration the configuration to adapt
+		 * @return the adapted configuration
+		 * @since 3.5.0
+		 */
+		public static DockerConnectionConfiguration asConnectionConfiguration(DockerHostConfiguration configuration) {
+			if (configuration != null && StringUtils.hasLength(configuration.context)) {
+				return new DockerConnectionConfiguration.Context(configuration.context);
+			}
+			if (configuration != null && StringUtils.hasLength(configuration.address)) {
+				return new DockerConnectionConfiguration.Host(configuration.address, configuration.secure,
+						configuration.certificatePath);
+			}
+			return null;
+		}
+
 	}
 
 }