added modules and cluster keyspace notifications

Author: jruaux

build.gradle

@@ -32,7 +32,9 @@ dependencies {
     api group: 'org.testcontainers', name: 'testcontainers', version: testcontainers_version
     api group: 'org.testcontainers', name: 'junit-jupiter', version: testcontainers_version
     testImplementation 'com.redislabs:mesclun:1.2.2'
-    testImplementation 'org.slf4j:slf4j-jdk14:1.7.30'
+    testImplementation 'org.slf4j:slf4j-simple:1.7.30'
+    testImplementation group: 'org.projectlombok', name: 'lombok', version: lombok_version
+    testAnnotationProcessor group: 'org.projectlombok', name: 'lombok', version: lombok_version
 }
 
 test {

src/main/java/com/redislabs/testcontainers/AbstractRedisContainer.java

@@ -0,0 +1,37 @@
+package com.redislabs.testcontainers;
+
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.shaded.org.apache.commons.lang.ClassUtils;
+import org.testcontainers.utility.DockerImageName;
+
+public abstract class AbstractRedisContainer<C extends AbstractRedisContainer<C>> extends GenericContainer<C> implements RedisContainer {
+
+    public static final int REDIS_PORT = 6379;
+
+    protected AbstractRedisContainer(final DockerImageName dockerImageName) {
+        this(dockerImageName, REDIS_PORT);
+    }
+
+    protected AbstractRedisContainer(final DockerImageName dockerImageName, int port) {
+        super(dockerImageName);
+        withExposedPorts(port);
+        waitingFor(Wait.forLogMessage(".*Ready to accept connections.*\\n", 1));
+    }
+
+    /**
+     * Get Redis URI.
+     *
+     * @return Redis URI.
+     */
+    @Override
+    public String getRedisURI() {
+        return RedisContainerUtils.redisURI(this);
+    }
+
+    @Override
+    public String toString() {
+        return ClassUtils.getShortClassName(getClass());
+    }
+
+}

src/main/java/com/redislabs/testcontainers/RedisClusterContainer.java

@@ -0,0 +1,99 @@
+package com.redislabs.testcontainers;
+
+import org.testcontainers.containers.FixedHostPortGenericContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.utility.MountableFile;
+
+public class RedisClusterContainer extends FixedHostPortGenericContainer<RedisClusterContainer> implements RedisContainer {
+
+    private static final String ENV_MASTERS = "MASTERS";
+    private static final String ENV_SLAVES_PER_MASTER = "SLAVES_PER_MASTER";
+    private static final String ENV_INITIAL_PORT = "INITIAL_PORT";
+    private static final String ENV_IP = "IP";
+
+    private static final String DEFAULT_IMAGE_NAME = "grokzen/redis-cluster:6.2.1";
+    private static final String KEYSPACE_NOTIFICATIONS_IMAGE_NAME = "jruaux/redis-cluster:6.2.1";
+    private static final int DEFAULT_INITIAL_PORT = 7000;
+    private static final int DEFAULT_MASTERS = 3;
+    private static final int DEFAULT_SLAVES_PER_MASTER = 0;
+    private static final String DEFAULT_IP = "0.0.0.0";
+
+    private int initialPort = DEFAULT_INITIAL_PORT;
+    private int masters = DEFAULT_MASTERS;
+    private int slavesPerMaster = DEFAULT_SLAVES_PER_MASTER;
+
+    public RedisClusterContainer() {
+        this(DEFAULT_IMAGE_NAME);
+    }
+
+    protected RedisClusterContainer(final String dockerImageName) {
+        super(dockerImageName);
+        withIP(DEFAULT_IP);
+        update();
+        waitingFor(Wait.forLogMessage(".*Cluster state changed: ok*\\n", 1));
+    }
+
+    public RedisClusterContainer withKeyspaceNotifications() {
+        setDockerImageName(KEYSPACE_NOTIFICATIONS_IMAGE_NAME);
+        return this;
+    }
+
+    public RedisClusterContainer withIP(String ip) {
+        withEnv(ENV_IP, ip);
+        return this;
+    }
+
+    private RedisClusterContainer update() {
+        withEnv(ENV_INITIAL_PORT, String.valueOf(initialPort));
+        withEnv(ENV_MASTERS, String.valueOf(masters));
+        withEnv(ENV_SLAVES_PER_MASTER, String.valueOf(slavesPerMaster));
+        for (int port : ports()) {
+            withFixedExposedPort(port, port);
+        }
+        return this;
+    }
+
+    private int[] ports() {
+        int totalNodes = masters * (slavesPerMaster + 1);
+        int[] ports = new int[totalNodes];
+        for (int index = 0; index < totalNodes; index++) {
+            ports[index] = initialPort + index;
+        }
+        return ports;
+    }
+
+    public String[] getRedisURIs() {
+        int[] ports = ports();
+        String[] redisURIs = new String[ports.length];
+        for (int index = 0; index < ports.length; index++) {
+            redisURIs[index] = RedisContainerUtils.redisURI(getHost(), ports[index]);
+        }
+        return redisURIs;
+    }
+
+    public String getRedisURI() {
+        return getRedisURIs()[0];
+    }
+
+    public RedisClusterContainer withMasters(int count) {
+        if (count <= 0) {
+            throw new IllegalArgumentException("Count must be greater than zero");
+        }
+        this.masters = masters;
+        return update();
+    }
+
+    public RedisClusterContainer withSlavesPerMaster(int count) {
+        if (count < 0) {
+            throw new IllegalArgumentException("Count must be zero or greater");
+        }
+        this.slavesPerMaster = count;
+        return update();
+    }
+
+    public RedisClusterContainer withInitialPort(int port) {
+        this.initialPort = port;
+        return update();
+    }
+
+}

src/main/java/com/redislabs/testcontainers/RedisContainer.java

@@ -1,86 +1,7 @@
 package com.redislabs.testcontainers;
 
-import lombok.Getter;
-import org.testcontainers.containers.GenericContainer;
-import org.testcontainers.containers.wait.strategy.Wait;
-import org.testcontainers.utility.DockerImageName;
-import org.testcontainers.utility.MountableFile;
+public interface RedisContainer {
 
-/**
- * This container wraps Redis and optionally Redis Cluster
- * Some code borrowed from https://github.com/jaredpetersen/kafka-connect-redis
- */
-public class RedisContainer extends GenericContainer<RedisContainer> {
-
-    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("redis");
-    private static final String DEFAULT_TAG = "6";
-
-    public static final int REDIS_PORT = 6379;
-
-    @Getter
-    private boolean cluster;
-
-    public RedisContainer() {
-        this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
-    }
-
-    protected RedisContainer(final DockerImageName dockerImageName) {
-        super(dockerImageName);
-        dockerImageName.assertCompatibleWith(defaultImageName());
-        withExposedPorts(REDIS_PORT);
-        waitingFor(Wait.forLogMessage(".*Ready to accept connections.*\\n", 1));
-    }
-
-    protected DockerImageName defaultImageName() {
-        return DEFAULT_IMAGE_NAME;
-    }
-
-    @SuppressWarnings("unchecked")
-    public <C extends RedisContainer> C withKeyspaceNotifications() {
-        withCopyFileToContainer(MountableFile.forClasspathResource("redis-keyspace-notifications.conf"), "/data/redis.conf");
-        withCommand("redis-server", "/data/redis.conf");
-        return (C) this;
-    }
-
-    public <C extends RedisContainer> C withClusterKeyspaceNotifications() {
-        return withClusterMode("redis-cluster-keyspace-notifications.conf");
-    }
-
-    /**
-     * Enables Redis cluster mode
-     *
-     * @param <C> this RedisContainer instance
-     * @return a Redis Cluster container
-     */
-    public <C extends RedisContainer> C withClusterMode() {
-        return withClusterMode("redis-cluster.conf");
-    }
-
-    @SuppressWarnings("unchecked")
-    private <C extends RedisContainer> C withClusterMode(String conf) {
-        withCopyFileToContainer(MountableFile.forClasspathResource(conf), "/data/redis-cluster.conf");
-        withCopyFileToContainer(MountableFile.forClasspathResource("nodes-cluster.conf"), "/data/nodes.conf");
-        withCommand("redis-server", "/data/redis-cluster.conf");
-        waitingFor(Wait.forLogMessage(".*Cluster state changed: ok*\\n", 1));
-        cluster = true;
-        return (C) this;
-    }
-
-    /**
-     * Get Redis URI.
-     *
-     * @return Redis URI.
-     */
-    public String getRedisUri() {
-        return "redis://" + this.getHost() + ":" + this.getFirstMappedPort();
-    }
-
-    @Override
-    public String toString() {
-        if (cluster) {
-            return "cluster " + getRedisUri();
-        }
-        return getRedisUri();
-    }
+    String getRedisURI();
 
 }

src/main/java/com/redislabs/testcontainers/RedisContainerUtils.java

@@ -0,0 +1,15 @@
+package com.redislabs.testcontainers;
+
+import org.testcontainers.containers.GenericContainer;
+
+public class RedisContainerUtils {
+
+    public static String redisURI(String host, int port) {
+        return "redis://" + host + ":" + port;
+    }
+
+    public static String redisURI(GenericContainer<?> container) {
+        return redisURI(container.getHost(), container.getFirstMappedPort());
+    }
+
+}

src/main/java/com/redislabs/testcontainers/RedisModulesContainer.java

@@ -2,36 +2,17 @@
 
 import org.testcontainers.utility.DockerImageName;
 
-public class RedisModulesContainer extends RedisContainer {
+public class RedisModulesContainer extends AbstractRedisContainer<RedisModulesContainer> {
 
     private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("redislabs/redismod");
     private static final String DEFAULT_TAG = "latest";
 
     public RedisModulesContainer() {
-        super(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
+        this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
-    public RedisModulesContainer(final DockerImageName dockerImageName) {
+    protected RedisModulesContainer(final DockerImageName dockerImageName) {
         super(dockerImageName);
     }
 
-    @Override
-    protected DockerImageName defaultImageName() {
-        return DEFAULT_IMAGE_NAME;
-    }
-
-    @Override
-    public <C extends RedisContainer> C withKeyspaceNotifications() {
-        throw new UnsupportedOperationException("RedisModulesContainer does not support keyspace notifications");
-    }
-
-    @Override
-    public <C extends RedisContainer> C withClusterKeyspaceNotifications() {
-        throw new UnsupportedOperationException("RedisModulesContainer does not support keyspace notifications");
-    }
-
-    @Override
-    public <C extends RedisContainer> C withClusterMode() {
-        throw new UnsupportedOperationException("RedisModulesContainer does not support cluster mode");
-    }
 }

src/main/java/com/redislabs/testcontainers/RedisStandaloneContainer.java

@@ -0,0 +1,26 @@
+package com.redislabs.testcontainers;
+
+import org.testcontainers.utility.DockerImageName;
+import org.testcontainers.utility.MountableFile;
+
+public class RedisStandaloneContainer extends AbstractRedisContainer<RedisStandaloneContainer> {
+
+    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("redis");
+    private static final String DEFAULT_TAG = "latest";
+
+    public RedisStandaloneContainer() {
+        this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
+    }
+
+    protected RedisStandaloneContainer(final DockerImageName dockerImageName) {
+        super(dockerImageName);
+    }
+
+    @SuppressWarnings("unchecked")
+    public <C extends RedisStandaloneContainer> C withKeyspaceNotifications() {
+        withCopyFileToContainer(MountableFile.forClasspathResource("redis-keyspace-notifications.conf"), "/data/redis.conf");
+        withCommand("redis-server", "/data/redis.conf");
+        return (C) this;
+    }
+
+}