Merge remote-tracking branch 'upstream/master' into issue-374

Author: Nikita Salnikov-Tarnovski

CHANGELOG.md

@@ -3,8 +3,14 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 - Fixed retrieval of Docker host IP when running inside Docker. ([\#479](https://github.com/testcontainers/testcontainers-java/issues/479))
+- Fixed overriding MySQL image command. ([\#534](https://github.com/testcontainers/testcontainers-java/issues/534))
 
 ### Changed
+- Added Kafka module ([\#546](https://github.com/testcontainers/testcontainers-java/pull/546))
+- Added "Death Note" to track & kill spawned containers even if the JVM was "kill -9"ed ([\#545](https://github.com/testcontainers/testcontainers-java/pull/545))
+- Environment variables are now stored as Map instead of List ([\#550](https://github.com/testcontainers/testcontainers-java/pull/550))
+- Added `withEnv(String name, Function<Optional<String>, String> mapper)` with optional previous value ([\#550](https://github.com/testcontainers/testcontainers-java/pull/550))
+- Added `withFileSystemBind` overloaded method with `READ_WRITE` file mode by default ([\#550](https://github.com/testcontainers/testcontainers-java/pull/550))
 - All connections to MySQL containers don't use SSL anymore. ([\#374](https://github.com/testcontainers/testcontainers-java/issues/374))
 
 ## [1.5.1] - 2017-12-19

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

@@ -2,35 +2,32 @@
 
 import com.github.dockerjava.api.DockerClient;
 import com.github.dockerjava.api.command.CreateContainerCmd;
-import com.github.dockerjava.api.command.InspectContainerResponse;
 import com.github.dockerjava.api.exception.InternalServerErrorException;
 import com.github.dockerjava.api.exception.NotFoundException;
 import com.github.dockerjava.api.model.*;
 import com.github.dockerjava.core.command.ExecStartResultCallback;
 import com.github.dockerjava.core.command.PullImageResultCallback;
 import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.ImmutableMap;
 import lombok.Synchronized;
 import lombok.extern.slf4j.Slf4j;
-import org.apache.commons.io.IOUtils;
 import org.hamcrest.BaseMatcher;
 import org.hamcrest.Description;
-import org.rnorth.ducttape.unreliables.Unreliables;
 import org.rnorth.visibleassertions.VisibleAssertions;
-import org.testcontainers.dockerclient.*;
+import org.testcontainers.dockerclient.DockerClientProviderStrategy;
+import org.testcontainers.dockerclient.DockerMachineClientProviderStrategy;
 import org.testcontainers.utility.ComparableVersion;
-import org.testcontainers.utility.MountableFile;
+import org.testcontainers.utility.ResourceReaper;
 import org.testcontainers.utility.TestcontainersConfiguration;
 
 import java.io.ByteArrayOutputStream;
-import java.io.IOException;
 import java.io.InputStream;
-import java.net.Socket;
-import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.ServiceLoader;
-import java.util.concurrent.TimeUnit;
+import java.util.UUID;
 import java.util.function.BiFunction;
 import java.util.function.Consumer;
 
@@ -42,12 +39,22 @@
 @Slf4j
 public class DockerClientFactory {
 
+    public static final String TESTCONTAINERS_LABEL = DockerClientFactory.class.getPackage().getName();
+    public static final String TESTCONTAINERS_SESSION_ID_LABEL = TESTCONTAINERS_LABEL + ".sessionId";
+
+    public static final String SESSION_ID = UUID.randomUUID().toString();
+
+    public static final Map<String, String> DEFAULT_LABELS = ImmutableMap.of(
+            TESTCONTAINERS_LABEL, "true",
+            TESTCONTAINERS_SESSION_ID_LABEL, SESSION_ID
+    );
+
     private static final String TINY_IMAGE = TestcontainersConfiguration.getInstance().getTinyImage();
     private static DockerClientFactory instance;
 
     // Cached client configuration
     private DockerClientProviderStrategy strategy;
-    private boolean preconditionsChecked = false;
+    private boolean initialized = false;
     private String activeApiVersion;
     private String activeExecutionDriver;
 
@@ -95,7 +102,7 @@ public DockerClient client() {
         log.info("Docker host IP address is {}", hostIpAddress);
         DockerClient client = strategy.getClient();
 
-        if (!preconditionsChecked) {
+        if (!initialized) {
             Info dockerInfo = client.infoCmd().exec();
             Version version = client.versionCmd().exec();
             activeApiVersion = version.getApiVersion();
@@ -106,30 +113,19 @@ public DockerClient client() {
                     "  Operating System: " + dockerInfo.getOperatingSystem() + "\n" +
                     "  Total Memory: " + dockerInfo.getMemTotal() / (1024 * 1024) + " MB");
 
-            if (!TestcontainersConfiguration.getInstance().isDisableChecks()) {
-                VisibleAssertions.info("Checking the system...");
-
-                checkDockerVersion(version.getVersion());
-
-                MountableFile mountableFile = MountableFile.forClasspathResource(this.getClass().getName().replace(".", "/") + ".class");
+            String ryukContainerId = ResourceReaper.start(hostIpAddress, client);
+            log.info("Ryuk started - will monitor and terminate Testcontainers containers on JVM exit");
 
-                runInsideDocker(
-                        client,
-                        cmd -> cmd
-                                .withCmd("/bin/sh", "-c", "while true; do printf 'hello' | nc -l -p 80; done")
-                                .withBinds(new Bind(mountableFile.getResolvedPath(), new Volume("/dummy"), AccessMode.ro))
-                                .withExposedPorts(new ExposedPort(80))
-                                .withPublishAllPorts(true),
-                        (dockerClient, id) -> {
+            VisibleAssertions.info("Checking the system...");
 
-                            checkDiskSpace(dockerClient, id);
-                            checkMountableFile(dockerClient, id);
-                            checkExposedPort(hostIpAddress, dockerClient, id);
+            checkDockerVersion(version.getVersion());
 
-                            return null;
-                        });
+            if (!TestcontainersConfiguration.getInstance().isDisableChecks()) {
+                checkDiskSpace(client, ryukContainerId);
+                checkMountableFile(client, ryukContainerId);
             }
-            preconditionsChecked = true;
+
+            initialized = true;
         }
 
         return client;
@@ -178,26 +174,10 @@ private void checkMountableFile(DockerClient dockerClient, String id) {
         }
     }
 
-    private void checkExposedPort(String hostIpAddress, DockerClient dockerClient, String id) {
-        String response = Unreliables.retryUntilSuccess(3, TimeUnit.SECONDS, () -> {
-            InspectContainerResponse inspectedContainer = dockerClient.inspectContainerCmd(id).exec();
-
-            String portSpec = inspectedContainer.getNetworkSettings().getPorts().getBindings().values().iterator().next()[0].getHostPortSpec();
-
-            try (Socket socket = new Socket(hostIpAddress, Integer.parseInt(portSpec))) {
-                return IOUtils.toString(socket.getInputStream(), Charset.defaultCharset());
-            } catch (IOException e) {
-                return e.getMessage();
-            }
-        });
-
-        VisibleAssertions.assertEquals("A port exposed by a docker container should be accessible", "hello", response);
-    }
-
     /**
    * Check whether the image is available locally and pull it otherwise
    */
-    private void checkAndPullImage(DockerClient client, String image) {
+    public void checkAndPullImage(DockerClient client, String image) {
         List<Image> images = client.listImagesCmd().withImageNameFilter(image).exec();
         if (images.isEmpty()) {
             client.pullImageCmd(image).exec(new PullImageResultCallback()).awaitSuccess();
@@ -221,7 +201,8 @@ public <T> T runInsideDocker(Consumer<CreateContainerCmd> createContainerCmdCons
 
     private <T> T runInsideDocker(DockerClient client, Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {
         checkAndPullImage(client, TINY_IMAGE);
-        CreateContainerCmd createContainerCmd = client.createContainerCmd(TINY_IMAGE);
+        CreateContainerCmd createContainerCmd = client.createContainerCmd(TINY_IMAGE)
+                .withLabels(DEFAULT_LABELS);
         createContainerCmdConsumer.accept(createContainerCmd);
         String id = createContainerCmd.exec().getId();
 
@@ -263,7 +244,7 @@ DiskSpaceUsage parseAvailableDiskSpace(String dfOutput) {
      * @return the docker API version of the daemon that we have connected to
      */
     public String getActiveApiVersion() {
-        if (!preconditionsChecked) {
+        if (!initialized) {
             client();
         }
         return activeApiVersion;
@@ -273,7 +254,7 @@ public String getActiveApiVersion() {
      * @return the docker execution driver of the daemon that we have connected to
      */
     public String getActiveExecutionDriver() {
-        if (!preconditionsChecked) {
+        if (!initialized) {
             client();
         }
         return activeExecutionDriver;

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

@@ -15,9 +15,12 @@
  * An ambassador container is used as a TCP proxy, enabling any TCP port of another linked container to be exposed
  * publicly, even if that container does not make the port public itself. The <code>richnorth/ambassador:latest</code>
  * container is used (based on HAProxy).
+ *
+ * @deprecated use {@link SocatContainer}
  */
 @EqualsAndHashCode(callSuper = false)
 @Data
+@Deprecated
 public class AmbassadorContainer<SELF extends AmbassadorContainer<SELF>> extends GenericContainer<SELF> {
 
     private final String otherContainerName;

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

@@ -17,8 +17,10 @@
 import java.time.Duration;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.Future;
 import java.util.function.Consumer;
+import java.util.function.Function;
 
 public interface Container<SELF extends Container<SELF>> extends LinkableContainer {
 
@@ -135,6 +137,17 @@ default void addFileSystemBind(final String hostPath, final String containerPath
      */
     SELF waitingFor(@NonNull WaitStrategy waitStrategy);
 
+    /**
+     * Adds a file system binding.
+     *
+     * @param hostPath the file system path on the host
+     * @param containerPath the file system path inside the container
+     * @return this
+     */
+    default SELF withFileSystemBind(String hostPath, String containerPath) {
+        return withFileSystemBind(hostPath, containerPath, BindMode.READ_WRITE);
+    }
+
     /**
      * Adds a file system binding.
      *
@@ -171,6 +184,18 @@ default void addFileSystemBind(final String hostPath, final String containerPath
      */
     SELF withEnv(String key, String value);
 
+    /**
+     * Add an environment variable to be passed to the container.
+     *
+     * @param key   environment variable key
+     * @param mapper environment variable value mapper, accepts old value as an argument
+     * @return this
+     */
+    default SELF withEnv(String key, Function<Optional<String>, String> mapper) {
+        Optional<String> oldValue = Optional.ofNullable(getEnvMap().get(key));
+        return withEnv(key, mapper.apply(oldValue));
+    }
+
     /**
      * Add environment variables to be passed to the container.
      *
@@ -383,6 +408,11 @@ default Integer getFirstMappedPort() {
      */
     SELF withLogConsumer(Consumer<OutputFrame> consumer);
 
+    /**
+     *
+     * @deprecated please use {@code org.testcontainers.DockerClientFactory.instance().client().infoCmd().exec()}
+     */
+    @Deprecated
     Info fetchDockerDaemonInfo() throws IOException;
 
     /**
@@ -438,8 +468,15 @@ ExecResult execInContainer(Charset outputCharset, String... command)
 
     Future<String> getImage();
 
+    /**
+     *
+     * @deprecated use getEnvMap
+     */
+    @Deprecated
     List<String> getEnv();
 
+    Map<String, String> getEnvMap();
+
     String[] getCommandParts();
 
     List<Bind> getBinds();
@@ -452,12 +489,22 @@ ExecResult execInContainer(Charset outputCharset, String... command)
 
     DockerClient getDockerClient();
 
+    /**
+     *
+     * @deprecated please use {@code org.testcontainers.DockerClientFactory.instance().client().infoCmd().exec()}
+     */
+    @Deprecated
     Info getDockerDaemonInfo();
 
     String getContainerId();
 
     String getContainerName();
 
+    /**
+     *
+     * @deprecated please use {@code org.testcontainers.DockerClientFactory.instance().client().inspectContainerCmd(container.getContainerId()).exec()}
+     */
+    @Deprecated
     InspectContainerResponse getContainerInfo();
 
     void setExposedPorts(List<Integer> exposedPorts);