Allow to disable configuration of EnvironmentAndSystemPropertyClientProviderStrategy through Testcontainers (#4387)

Adds the `dockerconfig.source` property that can be used to change the way `EnvironmentAndSystemPropertyClientProviderStrategy` is configured.  Additionally, `EnvironmentAndSystemPropertyClientProviderStrategy` is not persistable anymore.

Currently supports the following modes:
* `auto` (which is the default), meaning that the Testcontainers configuration mechanisms can be used to configure docker-java
* `autoIgnoringUserProperties`, same as `auto`, but ignoring values set in the user properties

Author: kiview

core/src/main/java/org/testcontainers/dockerclient/EnvironmentAndSystemPropertyClientProviderStrategy.java

@@ -2,6 +2,7 @@
 
 import com.github.dockerjava.core.DefaultDockerClientConfig;
 import com.github.dockerjava.core.DockerClientConfig;
+import lombok.Getter;
 import org.testcontainers.utility.TestcontainersConfiguration;
 
 import java.util.Optional;
@@ -25,13 +26,32 @@ public final class EnvironmentAndSystemPropertyClientProviderStrategy extends Do
 
     private final DockerClientConfig dockerClientConfig;
 
+    @Getter
+    private final boolean applicable;
+
     public EnvironmentAndSystemPropertyClientProviderStrategy() {
         // use docker-java defaults if present, overridden if our own configuration is set
-        DefaultDockerClientConfig.Builder configBuilder = DefaultDockerClientConfig.createDefaultConfigBuilder();
+        this(DefaultDockerClientConfig.createDefaultConfigBuilder());
+    }
+
+    EnvironmentAndSystemPropertyClientProviderStrategy(DefaultDockerClientConfig.Builder configBuilder) {
+        String dockerConfigSource = TestcontainersConfiguration.getInstance()
+            .getEnvVarOrProperty("dockerconfig.source", "auto");
 
-        getSetting("docker.host").ifPresent(configBuilder::withDockerHost);
-        getSetting("docker.tls.verify").ifPresent(configBuilder::withDockerTlsVerify);
-        getSetting("docker.cert.path").ifPresent(configBuilder::withDockerCertPath);
+        switch (dockerConfigSource) {
+            case "auto":
+                Optional<String> dockerHost = getSetting("docker.host");
+                dockerHost.ifPresent(configBuilder::withDockerHost);
+                applicable = dockerHost.isPresent();
+                getSetting("docker.tls.verify").ifPresent(configBuilder::withDockerTlsVerify);
+                getSetting("docker.cert.path").ifPresent(configBuilder::withDockerCertPath);
+                break;
+            case "autoIgnoringUserProperties":
+                applicable = configBuilder.isDockerHostSetExplicitly();
+                break;
+            default:
+                throw new InvalidConfigurationException("Invalid value for dockerconfig.source: " + dockerConfigSource);
+        }
 
         dockerClientConfig = configBuilder.build();
     }
@@ -40,11 +60,6 @@ private Optional<String> getSetting(final String name) {
         return Optional.ofNullable(TestcontainersConfiguration.getInstance().getEnvVarOrUserProperty(name, null));
     }
 
-    @Override
-    protected boolean isApplicable() {
-        return getSetting("docker.host").isPresent();
-    }
-
     @Override
     public TransportConfig getTransportConfig() {
         return TransportConfig.builder()
@@ -62,4 +77,9 @@ protected int getPriority() {
     public String getDescription() {
         return "Environment variables, system properties and defaults. Resolved dockerHost=" + dockerClientConfig.getDockerHost();
     }
+
+    @Override
+    protected boolean isPersistable() {
+        return false;
+    }
 }

core/src/main/java/org/testcontainers/utility/TestcontainersConfiguration.java

@@ -13,7 +13,6 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.testcontainers.UnstableAPI;
-import org.testcontainers.dockerclient.EnvironmentAndSystemPropertyClientProviderStrategy;
 
 import java.io.File;
 import java.io.FileNotFoundException;
@@ -182,20 +181,8 @@ public String getDockerClientStrategyClassName() {
             return prefixedEnvVarStrategy;
         }
 
-        // looks for unprefixed env var or unprefixed property
-        String unprefixedEnvVarOrProperty = getEnvVarOrUserProperty("docker.client.strategy", null);
-        if (unprefixedEnvVarOrProperty != null) {
-            return unprefixedEnvVarOrProperty;
-        }
-
-        // If docker.host is set then EnvironmentAndSystemPropertyClientProviderStrategy is likely to work
-        String dockerHostProperty = getEnvVarOrUserProperty("docker.host", null);
-        if (dockerHostProperty != null) {
-            return EnvironmentAndSystemPropertyClientProviderStrategy.class.getCanonicalName();
-        }
-
-        // No value set, and no implicit value to use either
-        return null;
+        // looks for unprefixed env var or unprefixed property, or null if the strategy is not set at all
+        return getEnvVarOrUserProperty("docker.client.strategy", null);
     }
 
     public String getTransportType() {

core/src/test/java/org/testcontainers/dockerclient/EnvironmentAndSystemPropertyClientProviderStrategyTest.java

@@ -16,10 +16,16 @@
 import java.net.URI;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.ArgumentMatchers.isNull;
 
@@ -45,6 +51,7 @@ public void checkEnvironmentClear() {
 
     @Test
     public void testWhenConfigAbsent() {
+        Mockito.doReturn("auto").when(TestcontainersConfiguration.getInstance()).getEnvVarOrProperty(eq("dockerconfig.source"), anyString());
         Mockito.doReturn(null).when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.host"), isNull());
         Mockito.doReturn(null).when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.tls.verify"), isNull());
         Mockito.doReturn(null).when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.cert.path"), isNull());
@@ -58,6 +65,7 @@ public void testWhenConfigAbsent() {
 
     @Test
     public void testWhenDockerHostPresent() {
+        Mockito.doReturn("auto").when(TestcontainersConfiguration.getInstance()).getEnvVarOrProperty(eq("dockerconfig.source"), anyString());
         Mockito.doReturn("tcp://1.2.3.4:2375").when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.host"), isNull());
         Mockito.doReturn(null).when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.tls.verify"), isNull());
         Mockito.doReturn(null).when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.cert.path"), isNull());
@@ -74,6 +82,7 @@ public void testWhenDockerHostAndSSLConfigPresent() throws IOException {
         Path tempDir = Files.createTempDirectory("testcontainers-test");
         String tempDirPath = tempDir.toAbsolutePath().toString();
 
+        Mockito.doReturn("auto").when(TestcontainersConfiguration.getInstance()).getEnvVarOrProperty(eq("dockerconfig.source"), anyString());
         Mockito.doReturn("tcp://1.2.3.4:2375").when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.host"), isNull());
         Mockito.doReturn("1").when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.tls.verify"), isNull());
         Mockito.doReturn(tempDirPath).when(TestcontainersConfiguration.getInstance()).getEnvVarOrUserProperty(eq("docker.cert.path"), isNull());
@@ -88,4 +97,25 @@ public void testWhenDockerHostAndSSLConfigPresent() throws IOException {
         assertTrue(sslConfig instanceof LocalDirectorySSLConfig);
         assertEquals(tempDirPath, ((LocalDirectorySSLConfig) sslConfig).getDockerCertPath());
     }
+
+    @Test
+    public void applicableWhenIgnoringUserPropertiesAndConfigured() {
+        Mockito.doReturn("autoIgnoringUserProperties").when(TestcontainersConfiguration.getInstance()).getEnvVarOrProperty(eq("dockerconfig.source"), anyString());
+
+        DefaultDockerClientConfig.Builder configBuilder = DefaultDockerClientConfig.createDefaultConfigBuilder()
+            .withDockerHost("tcp://1.2.3.4:2375");
+
+        EnvironmentAndSystemPropertyClientProviderStrategy strategy = new EnvironmentAndSystemPropertyClientProviderStrategy(configBuilder);
+
+        assertTrue(strategy.isApplicable());
+    }
+
+    @Test
+    public void notApplicableWhenIgnoringUserPropertiesAndNotConfigured() {
+        Mockito.doReturn("autoIgnoringUserProperties").when(TestcontainersConfiguration.getInstance()).getEnvVarOrProperty(eq("dockerconfig.source"), anyString());
+
+        EnvironmentAndSystemPropertyClientProviderStrategy strategy = new EnvironmentAndSystemPropertyClientProviderStrategy();
+
+        assertFalse(strategy.isApplicable());
+    }
 }

core/src/test/java/org/testcontainers/utility/TestcontainersConfigurationTest.java

@@ -2,7 +2,6 @@
 
 import org.junit.Before;
 import org.junit.Test;
-import org.testcontainers.dockerclient.EnvironmentAndSystemPropertyClientProviderStrategy;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -156,13 +155,6 @@ public void shouldReadDockerClientStrategyFromEnvironment() {
         assertEquals("Docker client strategy is changed by env var", "foo", newConfig().getDockerClientStrategyClassName());
     }
 
-    @Test
-    public void shouldUseImplicitDockerClientStrategyWhenDockerHostPropertyIsSet() {
-        userProperties.remove("docker.client.strategy");
-        userProperties.put("docker.host", "tcp://1.2.3.4:5678");
-        assertEquals("Docker client strategy is implicitly set when docker host property is set", EnvironmentAndSystemPropertyClientProviderStrategy.class.getCanonicalName(), newConfig().getDockerClientStrategyClassName());
-    }
-
     @Test
     public void shouldNotUseImplicitDockerClientStrategyWhenDockerHostAndStrategyAreBothSet() {
         userProperties.put("docker.client.strategy", "foo");

docs/features/configuration.md

@@ -126,3 +126,7 @@ docker.host=tcp\://my.docker.host\:1234     # Equivalent to the DOCKER_HOST envi
 docker.tls.verify=1                         # Equivalent to the DOCKER_TLS_VERIFY environment variable
 docker.cert.path=/some/path                 # Equivalent to the DOCKER_CERT_PATH environment variable
 ```
+In addition, you can deactivate this behaviour by specifying:
+```properties
+dockerconfig.source=autoIgnoringUserProperties # 'auto' by default
+```