add support for configuring the Docker image name via @LocalstackDockerProperties (#40)

Author: cbromberg

README.md

@@ -22,11 +22,12 @@ The container can be configured by using the `@LocalstackDockerProperties` annot
 ```
 ...
 import cloud.localstack.LocalstackTestRunner;
+import cloud.localstack.ServiceName;
 import cloud.localstack.TestUtils;
 import cloud.localstack.docker.annotation.LocalstackDockerProperties;
 
 @RunWith(LocalstackTestRunner.class)
-@LocalstackDockerProperties(services = { "s3", "sqs", "kinesis" })
+@LocalstackDockerProperties(services = { ServiceName.S3, "sqs", "kinesis" })
 public class MyCloudAppTest {
 
   @Test
@@ -70,6 +71,7 @@ You can configure the Docker behaviour using the `@LocalstackDockerProperties` a
 |-----------------------------|------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------|
 | `pullNewImage`              | Determines if a new image is pulled from the docker repo before the tests are run.                                           | boolean                      | `false`         |
 | `services`                  | Determines which services should be run when the localstack starts.                                                          | String[]                     | All           |
+| `imageName`                 | Use a specific image name (organisation/repo) for docker container                                                           | String                       | `localstack/localstack`  |
 | `imageTag`                  | Use a specific image tag for docker container                                                                                | String                       | `latest`        |
 | `portEdge`                  | Port number for the edge service, the main entry point for all API invocations                                               | String                       | `4566`        |
 | `portElasticSearch`         | Port number for the elasticsearch service                                                                                    | String                       | `4571`        |

pom.xml

@@ -5,7 +5,7 @@
     <groupId>cloud.localstack</groupId>
     <artifactId>localstack-utils</artifactId>
     <packaging>jar</packaging>
-    <version>0.2.7</version>
+    <version>0.2.8-SNAPSHOT</version>
     <name>localstack-utils</name>
 
     <description>Java utilities for the LocalStack platform.</description>

src/main/java/cloud/localstack/Localstack.java

@@ -66,6 +66,7 @@ public void startup(LocalstackDockerConfiguration dockerConfiguration) {
                 dockerConfiguration.getExternalHostName(),
                 dockerConfiguration.isPullNewImage(),
                 dockerConfiguration.isRandomizePorts(),
+                dockerConfiguration.getImageName(),
                 dockerConfiguration.getImageTag(),
                 dockerConfiguration.getPortEdge(),
                 dockerConfiguration.getPortElasticSearch(),

src/main/java/cloud/localstack/docker/Container.java

@@ -21,6 +21,7 @@ public class Container {
     private static final Logger LOG = Logger.getLogger(Container.class.getName());
 
     private static final String LOCALSTACK_NAME = "localstack/localstack";
+    private static final String LOCALSTACK_TAG = "latest";
     private static final String LOCALSTACK_PORT_EDGE = "4566";
     private static final String LOCALSTACK_PORT_ELASTICSEARCH = "4571";
 
@@ -47,16 +48,19 @@ public class Container {
      * @param pullNewImage determines if docker pull should be run to update to the latest image of the container
      * @param randomizePorts determines if the container should expose the default local stack ports or if it should expose randomized ports
      *                       in order to prevent conflicts with other localstack containers running on the same machine
+     * @param imageName the name of the image defaults to {@value LOCALSTACK_NAME} if null
+     * @param imageTag the tag of the image to pull, defaults to {@value LOCALSTACK_TAG} if null
      * @param environmentVariables map of environment variables to be passed to the docker container
      */
     public static Container createLocalstackContainer(
-        String externalHostName, boolean pullNewImage, boolean randomizePorts, String imageTag, String portEdge,
+        String externalHostName, boolean pullNewImage, boolean randomizePorts, String imageName, String imageTag, String portEdge,
         String portElasticSearch,  Map<String, String> environmentVariables, Map<Integer, Integer> portMappings) {
 
         environmentVariables = environmentVariables == null ? Collections.emptyMap() : environmentVariables;
         portMappings = portMappings == null ? Collections.emptyMap() : portMappings;
 
-        String fullImageName = LOCALSTACK_NAME + ":" + (imageTag == null ? "latest" : imageTag);
+        String imageNameOrDefault = (imageName == null ? LOCALSTACK_NAME : imageName);
+        String fullImageName = imageNameOrDefault + ":" + (imageTag == null ? LOCALSTACK_TAG : imageTag);
         boolean imageExists = new ListImagesCommand().execute().contains(fullImageName);
 
         String fullPortEdge = (portEdge == null ? LOCALSTACK_PORT_EDGE : portEdge) + ":" + LOCALSTACK_PORT_EDGE;
@@ -65,10 +69,10 @@ public static Container createLocalstackContainer(
 
         if(pullNewImage || !imageExists) {
             LOG.info("Pulling latest image...");
-            new PullCommand(LOCALSTACK_NAME, imageTag).execute();
+            new PullCommand(imageNameOrDefault, imageTag).execute();
         }
 
-        RunCommand runCommand = new RunCommand(LOCALSTACK_NAME, imageTag)
+        RunCommand runCommand = new RunCommand(imageNameOrDefault, imageTag)
             .withExposedPorts(fullPortEdge, randomizePorts)
             .withExposedPorts(fullPortElasticSearch, randomizePorts)
             .withEnvironmentVariable(LOCALSTACK_EXTERNAL_HOSTNAME, externalHostName)
@@ -200,4 +204,11 @@ public void stop() {
     public String executeCommand(List<String> command) {
         return new ExecCommand(containerId).execute(command);
     }
+
+    /**
+     * Returns the container ID which can be used to execute Docker CLI / API level commands on the container.
+     */
+    String getContainerId() {
+        return containerId;
+    }
 }

src/main/java/cloud/localstack/docker/annotation/LocalstackDockerAnnotationProcessor.java

@@ -35,6 +35,7 @@ private LocalstackDockerConfiguration processDockerPropertiesAnnotation(Localsta
             .pullNewImage(properties.pullNewImage())
             .ignoreDockerRunErrors(properties.ignoreDockerRunErrors())
             .randomizePorts(properties.randomizePorts())
+            .imageName(StringUtils.isEmpty(properties.imageName()) ? null : properties.imageName())
             .imageTag(StringUtils.isEmpty(properties.imageTag()) ? null : properties.imageTag())
             .portEdge(getEnvOrDefault("LOCALSTACK_EDGE_PORT", properties.portEdge()))
             .portElasticSearch(getEnvOrDefault("LOCALSTACK_ELASTICSEARCH_PORT", properties.portElasticSearch()))

src/main/java/cloud/localstack/docker/annotation/LocalstackDockerConfiguration.java

@@ -23,6 +23,7 @@ public class LocalstackDockerConfiguration {
 
     private final boolean randomizePorts;
 
+    private final String imageName;
     private final String imageTag;
 
     @Builder.Default

src/main/java/cloud/localstack/docker/annotation/LocalstackDockerProperties.java

@@ -46,6 +46,11 @@
      */
     String[] services() default {};
 
+    /**
+     * Use a specific image name (consisting of organisation and repository, e.g. localstack/localstack-full for docker container
+     */
+    String imageName() default "";
+
     /**
      * Use a specific image tag for docker container
      */

src/test/java/cloud/localstack/deprecated/PortBindingTest.java

@@ -35,7 +35,7 @@ public void testAccessPredefinedPort() {
     @Test
     public void createLocalstackContainerWithRandomPorts() throws Exception {
         Container container = Container.createLocalstackContainer(
-            EXTERNAL_HOST_NAME, pullNewImage, true, null, null, null, null, null);
+            EXTERNAL_HOST_NAME, pullNewImage, true, null, null, null, null, null, null);
 
         try {
             container.waitForAllPorts(EXTERNAL_HOST_NAME);
@@ -53,7 +53,7 @@ public void createLocalstackContainerWithRandomPorts() throws Exception {
     @Test
     public void createLocalstackContainerWithStaticPorts() throws Exception {
         Container container = Container.createLocalstackContainer(
-            EXTERNAL_HOST_NAME, pullNewImage, false, null, null, null, null, null);
+            EXTERNAL_HOST_NAME, pullNewImage, false, null, null, null, null, null, null);
 
         try {
             container.waitForAllPorts(EXTERNAL_HOST_NAME);

src/test/java/cloud/localstack/docker/ContainerTest.java

@@ -1,8 +1,12 @@
 package cloud.localstack.docker;
 
+import cloud.localstack.Localstack;
+import cloud.localstack.docker.annotation.LocalstackDockerProperties;
 import org.junit.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 
 import static org.junit.Assert.assertEquals;
@@ -22,7 +26,7 @@ public void createLocalstackContainer() throws Exception {
         HashMap<String, String> environmentVariables = new HashMap<>();
         environmentVariables.put(MY_PROPERTY, MY_VALUE);
         Container localStackContainer = Container.createLocalstackContainer(
-            EXTERNAL_HOST_NAME, pullNewImage, false, null, null, null, environmentVariables, null);
+                EXTERNAL_HOST_NAME, pullNewImage, false, null, null, null, null, environmentVariables, null);
 
         try {
             localStackContainer.waitForAllPorts(EXTERNAL_HOST_NAME);
@@ -44,10 +48,43 @@ public void createLocalstackContainer() throws Exception {
         }
     }
 
+    @Test
+    public void createLocalstackContainerWithFullImage() {
+
+        String customImageName = "localstack/localstack-full";
+        Container localStackContainer = Container.createLocalstackContainer(
+                EXTERNAL_HOST_NAME, pullNewImage, false, customImageName, null, null, null, null, null);
+
+        try {
+            localStackContainer.waitForAllPorts(EXTERNAL_HOST_NAME);
+
+            String imageName = new DockerExe()
+                    .execute(Arrays.asList("container", "inspect",
+                            localStackContainer.getContainerId(), "--format", "{{.Config.Image}}"));
+            assertEquals(customImageName, imageName);
+        }
+        finally {
+            localStackContainer.stop();
+        }
+    }
+
+    @ExtendWith(LocalstackDockerExtension.class)
+    @LocalstackDockerProperties(imageName = "localstack/localstack-full")
+    public static class ContainerTest1 {
+        @org.junit.jupiter.api.Test
+        public void imageName() {
+            String imageName = new DockerExe()
+                    .execute(Arrays.asList("container", "inspect",
+                            Localstack.INSTANCE.getLocalStackContainer().getContainerId(),
+                            "--format", "{{.Config.Image}}"));
+            assertEquals("localstack/localstack-full", imageName);
+        }
+    }
+
     @Test
     public void createLocalstackContainerWithCustomPorts() throws Exception {
         Container localStackContainer = Container.createLocalstackContainer(
-            EXTERNAL_HOST_NAME, pullNewImage, false, null, "45660", "45710", null, null);
+                EXTERNAL_HOST_NAME, pullNewImage, false, null, null, "45660", "45710", null, null);
 
         try {
             localStackContainer.waitForAllPorts(EXTERNAL_HOST_NAME);
@@ -63,7 +100,7 @@ public void createLocalstackContainerWithCustomPorts() throws Exception {
     @Test
     public void createLocalstackContainerWithRandomPorts() throws Exception {
         Container localStackContainer = Container.createLocalstackContainer(
-            EXTERNAL_HOST_NAME, pullNewImage, false, null, ":4566", ":4571", null, null);
+                EXTERNAL_HOST_NAME, pullNewImage, false, null, null, ":4566", ":4571", null, null);
 
         try {
             localStackContainer.waitForAllPorts(EXTERNAL_HOST_NAME);