Add DefaultDockerClientConfig.Builder#isDockerHostSetExplicitly (docker-java#1692)

kiview · web-flow · commit e6f4adebf940 · 2021-08-23T22:58:08.000+02:00
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/DefaultDockerClientConfig.java b/docker-java-core/src/main/java/com/github/dockerjava/core/DefaultDockerClientConfig.java
@@ -58,6 +58,8 @@ public class DefaultDockerClientConfig implements Serializable, DockerClientConf
 
     static final Properties DEFAULT_PROPERTIES = new Properties();
 
+    static final String DEFAULT_DOCKER_HOST = "unix:///var/run/docker.sock";
+
     static {
         CONFIG_KEYS.add(DOCKER_HOST);
         CONFIG_KEYS.add(DOCKER_TLS_VERIFY);
@@ -69,7 +71,6 @@ public class DefaultDockerClientConfig implements Serializable, DockerClientConf
         CONFIG_KEYS.add(REGISTRY_EMAIL);
         CONFIG_KEYS.add(REGISTRY_URL);
 
-        DEFAULT_PROPERTIES.put(DOCKER_HOST, "unix:///var/run/docker.sock");
         DEFAULT_PROPERTIES.put(DOCKER_CONFIG, "${user.home}/.docker");
         DEFAULT_PROPERTIES.put(REGISTRY_URL, "https://index.docker.io/v1/");
         DEFAULT_PROPERTIES.put(REGISTRY_USERNAME, "${user.name}");
@@ -337,8 +338,12 @@ public static class Builder {
          * registry.email, DOCKER_CERT_PATH, and DOCKER_CONFIG.
          */
         public Builder withProperties(Properties p) {
-            return withDockerHost(p.getProperty(DOCKER_HOST))
-                    .withDockerTlsVerify(p.getProperty(DOCKER_TLS_VERIFY))
+
+            if (p.getProperty(DOCKER_HOST) != null) {
+                withDockerHost(p.getProperty(DOCKER_HOST));
+            }
+
+            return withDockerTlsVerify(p.getProperty(DOCKER_TLS_VERIFY))
                     .withDockerConfig(p.getProperty(DOCKER_CONFIG))
                     .withDockerCertPath(p.getProperty(DOCKER_CERT_PATH))
                     .withApiVersion(p.getProperty(API_VERSION))
@@ -412,6 +417,10 @@ public final Builder withDockerTlsVerify(Boolean dockerTlsVerify) {
             return this;
         }
 
+        public final boolean isDockerHostSetExplicitly() {
+            return dockerHost != null;
+        }
+
         /**
          * Overrides the default {@link SSLConfig} that is used when calling {@link Builder#withDockerTlsVerify(java.lang.Boolean)} and
          * {@link Builder#withDockerCertPath(String)}. This way it is possible to pass a custom {@link SSLConfig} to the resulting
@@ -435,7 +444,9 @@ public DefaultDockerClientConfig build() {
                 sslConfig = customSslConfig;
             }
 
-            return new DefaultDockerClientConfig(dockerHost, dockerConfig, apiVersion, registryUrl, registryUsername,
+            URI dockerHostUri = (dockerHost != null) ? dockerHost : URI.create(DEFAULT_DOCKER_HOST);
+
+            return new DefaultDockerClientConfig(dockerHostUri, dockerConfig, apiVersion, registryUrl, registryUsername,
                     registryPassword, registryEmail, sslConfig);
         }
 
diff --git a/docker-java/src/test/java/com/github/dockerjava/core/DefaultDockerClientConfigTest.java b/docker-java/src/test/java/com/github/dockerjava/core/DefaultDockerClientConfigTest.java
@@ -98,8 +98,8 @@ public void emptyHost() {
         DefaultDockerClientConfig config = buildConfig(env, new Properties());
 
         assertEquals(
-            config.getDockerHost().toString(),
-            DefaultDockerClientConfig.DEFAULT_PROPERTIES.get(DefaultDockerClientConfig.DOCKER_HOST)
+            DefaultDockerClientConfig.DEFAULT_DOCKER_HOST,
+            config.getDockerHost().toString()
         );
     }
 
@@ -224,6 +224,46 @@ public void withDockerTlsVerify() throws Exception {
         assertThat((Boolean) field.get(builder), is(true));
     }
 
+    @Test
+    public void dockerHostSetExplicitlyOnSetter() {
+        DefaultDockerClientConfig.Builder builder = DefaultDockerClientConfig.createDefaultConfigBuilder(Collections.emptyMap(), new Properties());
+        assertThat(builder.isDockerHostSetExplicitly(), is(false));
+
+        builder.withDockerHost("tcp://foo");
+        assertThat(builder.isDockerHostSetExplicitly(), is(true));
+    }
+
+    @Test
+    public void dockerHostSetExplicitlyOnSystemProperty() {
+        Properties systemProperties = new Properties();
+        systemProperties.put(DefaultDockerClientConfig.DOCKER_HOST, "tcp://foo");
+
+        DefaultDockerClientConfig.Builder builder =  DefaultDockerClientConfig.createDefaultConfigBuilder(Collections.emptyMap(), systemProperties);
+
+        assertThat(builder.isDockerHostSetExplicitly(), is(true));
+    }
+
+    @Test
+    public void dockerHostSetExplicitlyOnEnv() {
+        Map<String, String> env = new HashMap<>();
+        env.put(DefaultDockerClientConfig.DOCKER_HOST, "tcp://foo");
+
+        DefaultDockerClientConfig.Builder builder =  DefaultDockerClientConfig.createDefaultConfigBuilder(env, new Properties());
+
+        assertThat(builder.isDockerHostSetExplicitly(), is(true));
+    }
+
+    @Test
+    public void dockerHostSetExplicitlyIfSetToDefaultByUser() {
+        Map<String, String> env = new HashMap<>();
+        env.put(DefaultDockerClientConfig.DOCKER_HOST, DefaultDockerClientConfig.DEFAULT_DOCKER_HOST);
+
+        DefaultDockerClientConfig.Builder builder =  DefaultDockerClientConfig.createDefaultConfigBuilder(env, new Properties());
+
+        assertThat(builder.isDockerHostSetExplicitly(), is(true));
+    }
+
+
     @Test
     public void testGetAuthConfigurationsFromDockerCfg() throws URISyntaxException {
         File cfgFile = new File(Resources.getResource("com.github.dockerjava.core/registry.v1").toURI());
