Improve the usability of GenericContainer (#550)

* Improve the usability of GenericContainer

* Add withEnv with mapper

* Document in CHANGELOG.md, add deprecation comments

CHANGELOG.md

@@ -6,6 +6,9 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 - Added Kafka module ([\#546](https://github.com/testcontainers/testcontainers-java/pull/546))
+- 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))
 
 ## [1.5.1] - 2017-12-19
 

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);

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

@@ -92,7 +92,7 @@ public class GenericContainer<SELF extends GenericContainer<SELF>>
     private Future<String> image;
 
     @NonNull
-    private List<String> env = new ArrayList<>();
+    private Map<String, String> env = new HashMap<>();
 
     @NonNull
     private String[] commandParts = new String[0];
@@ -396,7 +396,8 @@ private void applyConfiguration(CreateContainerCmd createCommand) {
             createCommand.withCmd(commandParts);
         }
 
-        String[] envArray = env.stream()
+        String[] envArray = env.entrySet().stream()
+                .map(it -> it.getKey() + "=" + it.getValue())
                 .toArray(String[]::new);
         createCommand.withEnv(envArray);
 
@@ -533,12 +534,37 @@ public void setCommand(@NonNull String... commandParts) {
         this.commandParts = commandParts;
     }
 
+    @Override
+    public Map<String, String> getEnvMap() {
+        return env;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public List<String> getEnv() {
+        return env.entrySet().stream()
+                .map(it -> it.getKey() + "=" + it.getValue())
+                .collect(Collectors.toList());
+    }
+
+    @Override
+    public void setEnv(List<String> env) {
+        this.env = env.stream()
+                .map(it -> it.split("="))
+                .collect(Collectors.toMap(
+                        it -> it[0],
+                        it -> it[1]
+                ));
+    }
+
     /**
      * {@inheritDoc}
      */
     @Override
     public void addEnv(String key, String value) {
-        env.add(key + "=" + value);
+        env.put(key, value);
     }
 
     /**
@@ -886,6 +912,9 @@ public SELF withLogConsumer(Consumer<OutputFrame> consumer) {
         return self();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public synchronized Info fetchDockerDaemonInfo() throws IOException {
 

core/src/test/java/org/testcontainers/junit/GenericContainerRuleTest.java

@@ -81,9 +81,10 @@ public static void setupContent() throws FileNotFoundException {
      * dirty way for testing.
      */
     @ClassRule
-    public static GenericContainer alpineEnvVar = new GenericContainer("alpine:3.2")
+    public static GenericContainer alpineEnvVar = new GenericContainer<>("alpine:3.2")
             .withExposedPorts(80)
-            .withEnv("MAGIC_NUMBER", "42")
+            .withEnv("MAGIC_NUMBER", "4")
+            .withEnv("MAGIC_NUMBER", oldValue -> oldValue.orElse("") + "2")
             .withCommand("/bin/sh", "-c", "while true; do echo \"$MAGIC_NUMBER\" | nc -l -p 80; done");
 
     /**