Add logging for Docker API version retrieval failures

This commit introduces a new constructor in `DockerApi`
that accepts `BuildLog` as a parameter.

The `BuildLog` is utilized for logging errors within `DockerApi

See gh-43460

Signed-off-by: Dmytro Nosan <[email protected]>

Author: nosan

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2024 the original author or authors.
+ * 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.
@@ -126,6 +126,17 @@ public void sensitiveTargetBindingDetected(Binding binding) {
 		log();
 	}
 
+	@Override
+	public void failedToGetApiVersion(Exception exception) {
+		StringBuilder message = new StringBuilder("Warning: Failed to determine Docker API version");
+		if (exception != null) {
+			message.append(": ").append(exception.getMessage());
+		}
+		log();
+		log(message.toString());
+		log();
+	}
+
 	private String getDigest(Image image) {
 		List<String> digests = image.getDigests();
 		return (digests.isEmpty() ? "" : digests.get(0));

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2024 the original author or authors.
+ * 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.
@@ -133,6 +133,14 @@ Consumer<TotalProgressEvent> pullingImage(ImageReference imageReference, ImagePl
 	 */
 	void sensitiveTargetBindingDetected(Binding binding);
 
+	/**
+	 * Log that the Docker API version could not be retrieved.
+	 * @param exception the exception that occurred when attempting to get the Docker API
+	 * version
+	 * @since 3.5.0
+	 */
+	void failedToGetApiVersion(Exception exception);
+
 	/**
 	 * Factory method that returns a {@link BuildLog} the outputs to {@link System#out}.
 	 * @return a build log instance that logs to system out

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

@@ -75,7 +75,7 @@ public Builder(DockerConfiguration dockerConfiguration) {
 	 * @param log a logger used to record output
 	 */
 	public Builder(BuildLog log) {
-		this(log, new DockerApi(), null);
+		this(log, null);
 	}
 
 	/**
@@ -85,7 +85,7 @@ public Builder(BuildLog log) {
 	 * @since 2.4.0
 	 */
 	public Builder(BuildLog log, DockerConfiguration dockerConfiguration) {
-		this(log, new DockerApi((dockerConfiguration != null) ? dockerConfiguration.getHost() : null),
+		this(log, new DockerApi((dockerConfiguration != null) ? dockerConfiguration.getHost() : null, log),
 				dockerConfiguration);
 	}
 

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

@@ -28,6 +28,7 @@
 import org.apache.hc.core5.http.Header;
 import org.apache.hc.core5.net.URIBuilder;
 
+import org.springframework.boot.buildpack.platform.build.BuildLog;
 import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration.DockerHostConfiguration;
 import org.springframework.boot.buildpack.platform.docker.transport.HttpTransport;
 import org.springframework.boot.buildpack.platform.docker.transport.HttpTransport.Response;
@@ -87,7 +88,7 @@ public class DockerApi {
 	 * Create a new {@link DockerApi} instance.
 	 */
 	public DockerApi() {
-		this(HttpTransport.create(null));
+		this(HttpTransport.create(null), BuildLog.toSystemOut());
 	}
 
 	/**
@@ -96,21 +97,34 @@ public DockerApi() {
 	 * @since 2.4.0
 	 */
 	public DockerApi(DockerHostConfiguration dockerHost) {
-		this(HttpTransport.create(dockerHost));
+		this(HttpTransport.create(dockerHost), BuildLog.toSystemOut());
+	}
+
+	/**
+	 * Create a new {@link DockerApi} instance.
+	 * @param dockerHost the Docker daemon host information
+	 * @param log a logger used to record output
+	 * @since 3.5.0
+	 */
+	public DockerApi(DockerHostConfiguration dockerHost, BuildLog log) {
+		this(HttpTransport.create(dockerHost), log);
 	}
 
 	/**
 	 * Create a new {@link DockerApi} instance backed by a specific {@link HttpTransport}
 	 * implementation.
 	 * @param http the http implementation
+	 * @param log a logger used to record output
 	 */
-	DockerApi(HttpTransport http) {
+	DockerApi(HttpTransport http, BuildLog log) {
+		Assert.notNull(http, "'http' must not be null");
+		Assert.notNull(log, "'log' must not be null");
 		this.http = http;
 		this.jsonStream = new JsonStream(SharedObjectMapper.get());
 		this.image = new ImageApi();
 		this.container = new ContainerApi();
 		this.volume = new VolumeApi();
-		this.system = new SystemApi();
+		this.system = new SystemApi(log);
 	}
 
 	private HttpTransport http() {
@@ -485,7 +499,10 @@ public void delete(VolumeName name, boolean force) throws IOException {
 	 */
 	class SystemApi {
 
-		SystemApi() {
+		private final BuildLog log;
+
+		SystemApi(BuildLog log) {
+			this.log = log;
 		}
 
 		/**
@@ -502,6 +519,7 @@ ApiVersion getApiVersion() {
 					}
 				}
 				catch (Exception ex) {
+					this.log.failedToGetApiVersion(ex);
 					// fall through to return default value
 				}
 				return UNKNOWN_API_VERSION;

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/docker/DockerApiTests.java

@@ -39,6 +39,7 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+import org.springframework.boot.buildpack.platform.build.BuildLog;
 import org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi;
 import org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi;
 import org.springframework.boot.buildpack.platform.docker.DockerApi.SystemApi;
@@ -59,6 +60,8 @@
 import org.springframework.boot.buildpack.platform.io.IOConsumer;
 import org.springframework.boot.buildpack.platform.io.Owner;
 import org.springframework.boot.buildpack.platform.io.TarArchive;
+import org.springframework.boot.testsupport.system.CapturedOutput;
+import org.springframework.boot.testsupport.system.OutputCaptureExtension;
 import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
 
@@ -82,7 +85,7 @@
  * @author Rafael Ceccone
  * @author Moritz Halbritter
  */
-@ExtendWith(MockitoExtension.class)
+@ExtendWith({ MockitoExtension.class, OutputCaptureExtension.class })
 class DockerApiTests {
 
 	private static final String API_URL = "/v" + DockerApi.API_VERSION;
@@ -108,7 +111,7 @@ class DockerApiTests {
 
 	@BeforeEach
 	void setup() {
-		this.dockerApi = new DockerApi(this.http);
+		this.dockerApi = new DockerApi(this.http, BuildLog.toSystemOut());
 	}
 
 	private HttpTransport http() {
@@ -732,9 +735,10 @@ void getApiVersionWithNoVersionHeaderReturnsUnknownVersion() throws Exception {
 		}
 
 		@Test
-		void getApiVersionWithExceptionReturnsUnknownVersion() throws Exception {
+		void getApiVersionWithExceptionReturnsUnknownVersion(CapturedOutput output) throws Exception {
 			given(http().head(eq(new URI(PING_URL)))).willThrow(new IOException("simulated error"));
 			assertThat(this.api.getApiVersion()).isEqualTo(DockerApi.UNKNOWN_API_VERSION);
+			assertThat(output).contains("Warning: Failed to determine Docker API version: simulated error");
 		}
 
 	}