Upgrade to docker-java 3.2.2, add Apache HttpClient5 option (#2803)

Author: bsideup

.github/workflows/ci.yml

@@ -66,3 +66,21 @@ jobs:
           wget -q https://get.cimate.io/release/linux/cimate
           chmod +x cimate
           ./cimate "**/TEST-*.xml"
+  httpclient5_test:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build with Gradle
+        run: |
+          echo "transport.type=httpclient5" > $HOME/.testcontainers.properties
+          cat $HOME/.testcontainers.properties
+          ./gradlew --no-daemon --scan testcontainers:test --tests '*EventStreamTest'
+      - name: aggregate test reports with ciMate
+        if: always()
+        env:
+          CIMATE_PROJECT_ID: 2348n4vl
+          CIMATE_CI_KEY: "CI / Apache HttpClient5"
+        run: |
+          wget -q https://get.cimate.io/release/linux/cimate
+          chmod +x cimate
+          ./cimate "**/TEST-*.xml"

core/build.gradle

@@ -157,13 +157,18 @@ dependencies {
 
     compile "net.java.dev.jna:jna-platform:5.5.0"
 
-    shaded ('com.github.docker-java:docker-java-transport-okhttp:3.2.1') {
+    shaded ('com.github.docker-java:docker-java-transport-okhttp:3.2.2') {
         exclude(group: 'net.java.dev.jna')
         exclude(group: 'com.google.code.findbug')
         exclude(group: 'org.slf4j')
         exclude(group: 'org.apache.commons', module: 'commons-compress')
     }
 
+    shaded ('com.github.docker-java:docker-java-transport-zerodep:3.2.2') {
+        exclude(group: 'net.java.dev.jna')
+        exclude(group: 'org.slf4j')
+    }
+
     shaded "org.yaml:snakeyaml:1.25"
 
     shaded 'org.glassfish.main.external:trilead-ssh2-repackaged:4.1.2'

core/src/main/java/org/testcontainers/DelegatingDockerClient.java

@@ -0,0 +1,12 @@
+package org.testcontainers;
+
+import com.github.dockerjava.api.DockerClient;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.Delegate;
+
+@RequiredArgsConstructor
+class DelegatingDockerClient implements DockerClient {
+
+    @Delegate
+    private final DockerClient dockerClient;
+}

core/src/main/java/org/testcontainers/DockerClientFactory.java

@@ -148,7 +148,12 @@ public DockerClient client() {
 
         String hostIpAddress = strategy.getDockerHostIpAddress();
         log.info("Docker host IP address is {}", hostIpAddress);
-        final DockerClient client = strategy.getClient();
+        final DockerClient client = new DelegatingDockerClient(strategy.getClient()) {
+            @Override
+            public void close() {
+                throw new IllegalStateException("You should never close the global DockerClient!");
+            }
+        };
 
         Info dockerInfo = client.infoCmd().exec();
         Version version = client.versionCmd().exec();

core/src/main/java/org/testcontainers/containers/ContainerState.java

@@ -310,8 +310,8 @@ default  <T> T copyFileFromContainer(String containerPath, ThrowingFunction<Inpu
             throw new IllegalStateException("copyFileFromContainer can only be used when the Container is created.");
         }
 
+        DockerClient dockerClient = DockerClientFactory.instance().client();
         try (
-            DockerClient dockerClient = DockerClientFactory.instance().client();
             InputStream inputStream = dockerClient.copyArchiveFromContainerCmd(getContainerId(), containerPath).exec();
             TarArchiveInputStream tarInputStream = new TarArchiveInputStream(inputStream)
         ) {

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

@@ -4,7 +4,9 @@
 import com.github.dockerjava.api.model.Network;
 import com.github.dockerjava.core.DockerClientConfig;
 import com.github.dockerjava.core.DockerClientImpl;
-import com.github.dockerjava.okhttp.OkHttpDockerCmdExecFactory;
+import com.github.dockerjava.okhttp.OkDockerHttpClient;
+import com.github.dockerjava.transport.DockerHttpClient;
+import com.github.dockerjava.zerodep.ZerodepDockerHttpClient;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Throwables;
 import org.apache.commons.io.IOUtils;
@@ -116,6 +118,13 @@ public static DockerClientProviderStrategy getFirstValidStrategy(List<DockerClie
                     try {
                         strategy.test();
                         LOGGER.info("Found Docker environment with {}", strategy.getDescription());
+                        LOGGER.debug(
+                            "Transport type: '{}', Docker host: '{}'",
+                            TestcontainersConfiguration.getInstance().getTransportType(),
+                            strategy.config != null
+                                ? strategy.config.getDockerHost()
+                                : "<unknown>"
+                        );
                         strategy.checkOSType();
 
                         if (strategy.isPersistable()) {
@@ -171,9 +180,28 @@ public DockerClient getClient() {
     }
 
     protected DockerClient getClientForConfig(DockerClientConfig config) {
-        return DockerClientImpl
-            .getInstance(new AuthDelegatingDockerClientConfig(config))
-            .withDockerCmdExecFactory(new OkHttpDockerCmdExecFactory());
+        config = new AuthDelegatingDockerClientConfig(config);
+        final DockerHttpClient dockerHttpClient;
+
+        String transportType = TestcontainersConfiguration.getInstance().getTransportType();
+        switch (transportType) {
+            case "okhttp":
+                dockerHttpClient = new OkDockerHttpClient.Builder()
+                    .dockerHost(config.getDockerHost())
+                    .sslConfig(config.getSSLConfig())
+                    .build();
+                break;
+            case "httpclient5":
+                dockerHttpClient = new ZerodepDockerHttpClient.Builder()
+                    .dockerHost(config.getDockerHost())
+                    .sslConfig(config.getSSLConfig())
+                    .build();
+                break;
+            default:
+                throw new IllegalArgumentException("Unknown transport type '" + transportType + "'");
+        }
+
+        return DockerClientImpl.getInstance(config, dockerHttpClient);
     }
 
     protected void ping(DockerClient client, int timeoutInSeconds) {

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

@@ -120,11 +120,6 @@ public String getDockerClientStrategyClassName() {
         return (String) environmentProperties.get("docker.client.strategy");
     }
 
-    /**
-     *
-     * @deprecated we no longer have different transport types
-     */
-    @Deprecated
     public String getTransportType() {
         return properties.getProperty("transport.type", "okhttp");
     }

examples/build.gradle

@@ -3,4 +3,8 @@ apply from: "$rootDir/../gradle/ci-support.gradle"
 
 subprojects {
     apply plugin:"java"
+
+    repositories {
+        jcenter()
+    }
 }