embedded-redis-cluster

Embedded Redis Cluster for Java integration testing

Fork Notes

This repository clones from kstyrc original repository and ozimov clone repository. The main goal of this fork is to provide real redis cluster support, allowing access with redis-cluster API, such as JedisCluster or (more standard) redis-cli -c option.

Maven dependency

Not yet

Cluster Usage

This Redis cluster supports multi-node master and slave. Behind the scene, it will automatically setup the cluster using CLUSTER MEET and CLUSTER REPLICATE

Using ephemeral ports

A simple redis integration test with Redis cluster on ephemeral ports, with setup similar to that from production would look like this:

public class SomeIntegrationTestThatRequiresRedis {
  private RedisCluster cluster;

  @Before
  public void setup() throws Exception {
    /*
     * creates a cluster with quorum size of 2 and 3 replication groups, 
     * each with one master and one slave
     */
    cluster = RedisCluster.builder().ephemeral()
                    .replicationGroup("master1", 1)
                    .replicationGroup("master2", 1)
                    .replicationGroup("master3", 1)
                    .build();
    cluster.start();
  }
  
  @Test
  public void test() throws Exception {
    JedisCluster jc = new JedisCluster(new HostAndPort("127.0.0.1", cluster.ports().get(0)));
    // your test code
  }
  
  @After
  public void tearDown() throws Exception {
    cluster.stop();
  }
}

Retrieving ports

The above example starts Redis cluster on ephemeral ports, which you can later get with cluster.ports(), which will return a list of all ports of the cluster. You can also get ports of servers with cluster.serverPorts(). JedisUtil class contains utility methods for use with Jedis client.

Using predefined ports

You can also start Redis cluster on predefined ports and even mix both approaches:

public class SomeIntegrationTestThatRequiresRedis {
  private RedisCluster cluster;

  @Before
  public void setup() throws Exception {
    final List<Integer> group1 = Arrays.asList(6667, 6668);
    final List<Integer> group2 = Arrays.asList(6387, 6379);
    /*
     * creates a cluster with quorum size of 2 and 3 replication groups, 
     * each with one master and one slave
     */
    cluster = RedisCluster.builder()
          .serverPorts(group1).replicationGroup("master1", 1)
          .serverPorts(group2).replicationGroup("master2", 1)
          .ephemeralServers().replicationGroup("master3", 1)
          .build();
    cluster.start();
  }
}

The above will create and start a cluster with sentinels on ports 26739, 26912, first replication group on 6667, 6668, second replication group on 6387, 6379 and third replication group on ephemeral ports.

Simple Redis/Sentinel (non-cluster) Usage

Running Simple RedisServer is as simple as:

RedisServer redisServer = new RedisServer(6379);
redisServer.start();
// do some work
redisServer.stop();

You can also provide RedisServer with your own executable:

// 1) given explicit file (os-independence broken!)
RedisServer redisServer = new RedisServer("/path/to/your/redis", 6379);

// 2) given os-independent matrix
RedisExecProvider customProvider = RedisExecProvider.defaultProvider()
  .override(OS.UNIX, "/path/to/unix/redis")
  .override(OS.WINDOWS, Architecture.x86, "/path/to/windows/redis")
  .override(OS.Windows, Architecture.x86_64, "/path/to/windows/redis")
  .override(OS.MAC_OS_X, Architecture.x86, "/path/to/macosx/redis")
  .override(OS.MAC_OS_X, Architecture.x86_64, "/path/to/macosx/redis")
  
RedisServer redisServer = new RedisServer(customProvider, 6379);

You can also use fluent API to create RedisServer:

RedisServer redisServer = RedisServer.builder()
  .redisExecProvider(customRedisProvider)
  .port(6379)
  .slaveOf("locahost", 6378)
  .configFile("/path/to/your/redis.conf")
  .build();

Or even create simple redis.conf file from scratch:

RedisServer redisServer = RedisServer.builder()
  .redisExecProvider(customRedisProvider)
  .port(6379)
  .setting("bind 127.0.0.1") // good for local development on Windows to prevent security popups
  .slaveOf("locahost", 6378)
  .setting("daemonize no")
  .setting("appendonly no")
  .setting("maxmemory 128M")
  .build();

Redis version

Because this fork aims to support real redis cluster, the redis used should be version 3 or higher

This fork only support 64-bit options, if you need 32-bit ones, please provide it yourself

The default built-in redis here are as follows:

• Linux/Unix: 3.0.7
• OSX/macOS: 3.0.7
• Windows: 3.0.5

However, you should provide RedisServer with redis executable if you need specific version.

License

Licensed under the Apache License, Version 2.0

Contributors

• Aaron Dwi (@aarondwi)
• Krzysztof Styrc (@kstyrc)
• Piotr Turek (@turu)
• anthonyu (@anthonyu)
• Artem Orobets (@enisher)
• Sean Simonsen (@SeanSimonsen)
• Rob Winch (@rwinch)
• Roberto Trunfio (@robertotru)
• Michael (@MichaelSp)
• Johno Crawford (@johnou)
• Stian Lindhom (@stianl)
• Glenn Nethercutt (@gnethercutt)
• AndyWilks79 (@AndyWilks79)