Add option to use configured Docker host in builder

This commit adds support for a `docker.bindHostToBuilder` option in
the Maven and Gradle image building goal and task.

Fixes gh-29384

Author: scottfrederick

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2022 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.
@@ -27,6 +27,7 @@
 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.ResolvedDockerHost;
 import org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException;
 import org.springframework.boot.buildpack.platform.docker.type.Image;
 import org.springframework.boot.buildpack.platform.docker.type.ImageReference;
@@ -83,7 +84,8 @@ public Builder(BuildLog log) {
 	 * @since 2.4.0
 	 */
 	public Builder(BuildLog log, DockerConfiguration dockerConfiguration) {
-		this(log, new DockerApi(dockerConfiguration), dockerConfiguration);
+		this(log, new DockerApi((dockerConfiguration != null) ? dockerConfiguration.getHost() : null),
+				dockerConfiguration);
 	}
 
 	Builder(BuildLog log, DockerApi docker, DockerConfiguration dockerConfiguration) {
@@ -147,7 +149,11 @@ private Buildpacks getBuildpacks(BuildRequest request, ImageFetcher imageFetcher
 	}
 
 	private void executeLifecycle(BuildRequest request, EphemeralBuilder builder) throws IOException {
-		try (Lifecycle lifecycle = new Lifecycle(this.log, this.docker, request, builder)) {
+		ResolvedDockerHost dockerHost = null;
+		if (this.dockerConfiguration != null && this.dockerConfiguration.isBindHostToBuilder()) {
+			dockerHost = ResolvedDockerHost.from(this.dockerConfiguration.getHost());
+		}
+		try (Lifecycle lifecycle = new Lifecycle(this.log, this.docker, dockerHost, request, builder)) {
 			lifecycle.execute();
 		}
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2022 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.
@@ -22,6 +22,7 @@
 
 import org.springframework.boot.buildpack.platform.docker.DockerApi;
 import org.springframework.boot.buildpack.platform.docker.LogUpdateEvent;
+import org.springframework.boot.buildpack.platform.docker.configuration.ResolvedDockerHost;
 import org.springframework.boot.buildpack.platform.docker.type.Binding;
 import org.springframework.boot.buildpack.platform.docker.type.ContainerConfig;
 import org.springframework.boot.buildpack.platform.docker.type.ContainerContent;
@@ -47,10 +48,14 @@ class Lifecycle implements Closeable {
 
 	private static final String PLATFORM_API_VERSION_KEY = "CNB_PLATFORM_API";
 
+	private static final String DOMAIN_SOCKET_PATH = "/var/run/docker.sock";
+
 	private final BuildLog log;
 
 	private final DockerApi docker;
 
+	private final ResolvedDockerHost dockerHost;
+
 	private final BuildRequest request;
 
 	private final EphemeralBuilder builder;
@@ -75,12 +80,15 @@ class Lifecycle implements Closeable {
 	 * Create a new {@link Lifecycle} instance.
 	 * @param log build output log
 	 * @param docker the Docker API
+	 * @param dockerHost the Docker host information
 	 * @param request the request to process
 	 * @param builder the ephemeral builder used to run the phases
 	 */
-	Lifecycle(BuildLog log, DockerApi docker, BuildRequest request, EphemeralBuilder builder) {
+	Lifecycle(BuildLog log, DockerApi docker, ResolvedDockerHost dockerHost, BuildRequest request,
+			EphemeralBuilder builder) {
 		this.log = log;
 		this.docker = docker;
+		this.dockerHost = dockerHost;
 		this.request = request;
 		this.builder = builder;
 		this.lifecycleVersion = LifecycleVersion.parse(builder.getBuilderMetadata().getLifecycle().getVersion());
@@ -147,6 +155,7 @@ void execute() throws IOException {
 	private Phase createPhase() {
 		Phase phase = new Phase("creator", isVerboseLogging());
 		phase.withDaemonAccess();
+		configureDaemonAccess(phase);
 		phase.withLogLevelArg();
 		phase.withArgs("-app", Directory.APPLICATION);
 		phase.withArgs("-platform", Directory.PLATFORM);
@@ -176,6 +185,24 @@ private Phase createPhase() {
 		return phase;
 	}
 
+	private void configureDaemonAccess(Phase phase) {
+		if (this.dockerHost != null) {
+			if (this.dockerHost.isRemote()) {
+				phase.withEnv("DOCKER_HOST", this.dockerHost.getAddress());
+				if (this.dockerHost.isSecure()) {
+					phase.withEnv("DOCKER_TLS_VERIFY", "1");
+					phase.withEnv("DOCKER_CERT_PATH", this.dockerHost.getCertificatePath());
+				}
+			}
+			else {
+				phase.withBinding(Binding.from(this.dockerHost.getAddress(), DOMAIN_SOCKET_PATH));
+			}
+		}
+		else {
+			phase.withBinding(Binding.from(DOMAIN_SOCKET_PATH, DOMAIN_SOCKET_PATH));
+		}
+	}
+
 	private boolean isVerboseLogging() {
 		return this.request.isVerboseLogging() && this.lifecycleVersion.isEqualOrGreaterThan(LOGGING_MINIMUM_VERSION);
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2022 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.
@@ -35,8 +35,6 @@
  */
 class Phase {
 
-	private static final String DOMAIN_SOCKET_PATH = "/var/run/docker.sock";
-
 	private final String name;
 
 	private final boolean verboseLogging;
@@ -132,7 +130,6 @@ public String toString() {
 	void apply(ContainerConfig.Update update) {
 		if (this.daemonAccess) {
 			update.withUser("root");
-			update.withBinding(Binding.from(DOMAIN_SOCKET_PATH, DOMAIN_SOCKET_PATH));
 		}
 		update.withCommand("/cnb/lifecycle/" + this.name, StringUtils.toStringArray(this.args));
 		update.withLabel("author", "spring-boot");

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2022 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.
@@ -28,7 +28,7 @@
 import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
 import org.apache.http.client.utils.URIBuilder;
 
-import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration;
+import org.springframework.boot.buildpack.platform.docker.configuration.DockerHost;
 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.ContainerConfig;
@@ -75,16 +75,16 @@ public class DockerApi {
 	 * Create a new {@link DockerApi} instance.
 	 */
 	public DockerApi() {
-		this(new DockerConfiguration());
+		this(HttpTransport.create(null));
 	}
 
 	/**
 	 * Create a new {@link DockerApi} instance.
-	 * @param dockerConfiguration the docker configuration
+	 * @param dockerHost the Docker daemon host information
 	 * @since 2.4.0
 	 */
-	public DockerApi(DockerConfiguration dockerConfiguration) {
-		this(HttpTransport.create((dockerConfiguration != null) ? dockerConfiguration.getHost() : null));
+	public DockerApi(DockerHost dockerHost) {
+		this(HttpTransport.create(dockerHost));
 	}
 
 	/**

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2022 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.
@@ -33,21 +33,28 @@ public final class DockerConfiguration {
 
 	private final DockerRegistryAuthentication publishAuthentication;
 
+	private final boolean bindHostToBuilder;
+
 	public DockerConfiguration() {
-		this(null, null, null);
+		this(null, null, null, false);
 	}
 
 	private DockerConfiguration(DockerHost host, DockerRegistryAuthentication builderAuthentication,
-			DockerRegistryAuthentication publishAuthentication) {
+			DockerRegistryAuthentication publishAuthentication, boolean bindHostToBuilder) {
 		this.host = host;
 		this.builderAuthentication = builderAuthentication;
 		this.publishAuthentication = publishAuthentication;
+		this.bindHostToBuilder = bindHostToBuilder;
 	}
 
 	public DockerHost getHost() {
 		return this.host;
 	}
 
+	public boolean isBindHostToBuilder() {
+		return this.bindHostToBuilder;
+	}
+
 	public DockerRegistryAuthentication getBuilderRegistryAuthentication() {
 		return this.builderAuthentication;
 	}
@@ -59,35 +66,40 @@ public DockerRegistryAuthentication getPublishRegistryAuthentication() {
 	public DockerConfiguration withHost(String address, boolean secure, String certificatePath) {
 		Assert.notNull(address, "Address must not be null");
 		return new DockerConfiguration(new DockerHost(address, secure, certificatePath), this.builderAuthentication,
-				this.publishAuthentication);
+				this.publishAuthentication, this.bindHostToBuilder);
+	}
+
+	public DockerConfiguration withBindHostToBuilder(boolean bindHostToBuilder) {
+		return new DockerConfiguration(this.host, this.builderAuthentication, this.publishAuthentication,
+				bindHostToBuilder);
 	}
 
 	public DockerConfiguration withBuilderRegistryTokenAuthentication(String token) {
 		Assert.notNull(token, "Token must not be null");
 		return new DockerConfiguration(this.host, new DockerRegistryTokenAuthentication(token),
-				this.publishAuthentication);
+				this.publishAuthentication, this.bindHostToBuilder);
 	}
 
 	public DockerConfiguration withBuilderRegistryUserAuthentication(String username, String password, String url,
 			String email) {
 		Assert.notNull(username, "Username must not be null");
 		Assert.notNull(password, "Password must not be null");
 		return new DockerConfiguration(this.host, new DockerRegistryUserAuthentication(username, password, url, email),
-				this.publishAuthentication);
+				this.publishAuthentication, this.bindHostToBuilder);
 	}
 
 	public DockerConfiguration withPublishRegistryTokenAuthentication(String token) {
 		Assert.notNull(token, "Token must not be null");
 		return new DockerConfiguration(this.host, this.builderAuthentication,
-				new DockerRegistryTokenAuthentication(token));
+				new DockerRegistryTokenAuthentication(token), this.bindHostToBuilder);
 	}
 
 	public DockerConfiguration withPublishRegistryUserAuthentication(String username, String password, String url,
 			String email) {
 		Assert.notNull(username, "Username must not be null");
 		Assert.notNull(password, "Password must not be null");
 		return new DockerConfiguration(this.host, this.builderAuthentication,
-				new DockerRegistryUserAuthentication(username, password, url, email));
+				new DockerRegistryUserAuthentication(username, password, url, email), this.bindHostToBuilder);
 	}
 
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2022 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.
@@ -30,6 +30,10 @@ public class DockerHost {
 
 	private final String certificatePath;
 
+	public DockerHost(String address) {
+		this(address, false, null);
+	}
+
 	public DockerHost(String address, boolean secure, String certificatePath) {
 		this.address = address;
 		this.secure = secure;

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

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2012-2022 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.configuration;
+
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+import com.sun.jna.Platform;
+
+import org.springframework.boot.buildpack.platform.system.Environment;
+
+/**
+ * Resolves a {@link DockerHost} from the environment, configuration, or using defaults.
+ *
+ * @author Scott Frederick
+ * @since 2.7.0
+ */
+public class ResolvedDockerHost extends DockerHost {
+
+	private static final String UNIX_SOCKET_PREFIX = "unix://";
+
+	private static final String DOMAIN_SOCKET_PATH = "/var/run/docker.sock";
+
+	private static final String WINDOWS_NAMED_PIPE_PATH = "//./pipe/docker_engine";
+
+	private static final String DOCKER_HOST = "DOCKER_HOST";
+
+	private static final String DOCKER_TLS_VERIFY = "DOCKER_TLS_VERIFY";
+
+	private static final String DOCKER_CERT_PATH = "DOCKER_CERT_PATH";
+
+	ResolvedDockerHost(String address, boolean secure, String certificatePath) {
+		super(address, secure, certificatePath);
+	}
+
+	@Override
+	public String getAddress() {
+		return super.getAddress().startsWith(UNIX_SOCKET_PREFIX)
+				? super.getAddress().substring(UNIX_SOCKET_PREFIX.length()) : super.getAddress();
+	}
+
+	public boolean isRemote() {
+		return getAddress().startsWith("http") || getAddress().startsWith("tcp");
+	}
+
+	public boolean isLocalFileReference() {
+		try {
+			return Files.exists(Paths.get(getAddress()));
+		}
+		catch (Exception ex) {
+			return false;
+		}
+	}
+
+	public static ResolvedDockerHost from(DockerHost dockerHost) {
+		return from(Environment.SYSTEM, dockerHost);
+	}
+
+	static ResolvedDockerHost from(Environment environment, DockerHost dockerHost) {
+		if (environment.get(DOCKER_HOST) != null) {
+			return new ResolvedDockerHost(environment.get(DOCKER_HOST), isTrue(environment.get(DOCKER_TLS_VERIFY)),
+					environment.get(DOCKER_CERT_PATH));
+		}
+		if (dockerHost != null && dockerHost.getAddress() != null) {
+			return new ResolvedDockerHost(dockerHost.getAddress(), dockerHost.isSecure(),
+					dockerHost.getCertificatePath());
+		}
+		return new ResolvedDockerHost(Platform.isWindows() ? WINDOWS_NAMED_PIPE_PATH : DOMAIN_SOCKET_PATH, false, null);
+	}
+
+	private static boolean isTrue(String value) {
+		try {
+			return (value != null) && (Integer.parseInt(value) == 1);
+		}
+		catch (NumberFormatException ex) {
+			return false;
+		}
+	}
+
+}