Redis embedded server for Java integration testing
This repository is a fork of https://github.com/ozimov/embedded-redis, which is in turn a fork of https://github.com/kstyrc/embedded-redis. We've updated the embedded Redis binaries to version 6.0.5 so we can write tests that use recent Redis features without imposing dependencies that are not well-encapsulated by a single Maven/Gradle build.
Maven Central:
<dependency>
<groupId>org.signal</groupId>
<artifactId>embedded-redis</artifactId>
<version>0.8.0</version>
</dependency>Running 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();Our Embedded Redis has support for HA Redis clusters with Sentinels and master-slave replication
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;
private Set<String> jedisSentinelHosts;
@Before
public void setup() throws Exception {
//creates a cluster with 3 sentinels, quorum size of 2 and 3 replication groups, each with one master and one slave
cluster = RedisCluster.builder().ephemeral().sentinelCount(3).quorumSize(2)
.replicationGroup("master1", 1)
.replicationGroup("master2", 1)
.replicationGroup("master3", 1)
.build();
cluster.start();
//retrieve ports on which sentinels have been started, using a simple Jedis utility class
jedisSentinelHosts = JedisUtil.sentinelHosts(cluster);
}
@Test
public void test() throws Exception {
// testing code that requires redis running
JedisSentinelPool pool = new JedisSentinelPool("master1", jedisSentinelHosts);
}
@After
public void tearDown() throws Exception {
cluster.stop();
}
}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 sentinels with cluster.sentinelPorts()
or servers with cluster.serverPorts(). JedisUtil class contains utility methods for use with Jedis client.
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> sentinels = Arrays.asList(26739, 26912);
final List<Integer> group1 = Arrays.asList(6667, 6668);
final List<Integer> group2 = Arrays.asList(6387, 6379);
//creates a cluster with 3 sentinels, quorum size of 2 and 3 replication groups, each with one master and one slave
cluster = RedisCluster.builder().sentinelPorts(sentinels).quorumSize(2)
.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.
By default, RedisServer runs an OS-specific executable enclosed in in the embedded-redis jar. The jar includes:
- Redis 6.0.5 for Linux/Unix (amd64 and x86)
- Redis 6.0.5 for macOS (amd64)
The enclosed binaries are built from source from the 6.0.5 tag in the official Redis repository. The Linux binaries are statically-linked amd64 and x86 executables built using the build-server-binaries.sh script included in this repository at /src/main/docker. The macOS binaries are built according to the instructions in the README. Windows binaries are not included because Windows is not officially supported by Redis.
Callers may provide a path to a specific redis-server executable if needed.
Licensed under the Apache License, Version 2.0
- Krzysztof Styrc (@kstyrc)
- Piotr Turek (@turu)
- anthonyu (@anthonyu)
- Artem Orobets (@enisher)
- Sean Simonsen (@SeanSimonsen)
- Rob Winch (@rwinch)
- Jon Chambers (@jchambers)
- Include statically-linked Redis binaries
- Update still more dependencies
- Updated to Redis 6.0.5
- Dropped support for Windows
- Updated to Guava 29
- Updated dependencies
- Fixed an incorrect maximum memory setting
- Add support for more Redis versions
- Bind to 127.0.0.1 by default
- Clean up gracefully at JVM exit
- Support JDK 6 +
- OS detection fix
- redis binary per OS/arch pair
- Updated to 2.8.19 binary for Windows
- Updated for Java 8
- Added Sentinel support
- Ability to create arbitrary clusters on arbitrary (ephemeral) ports
- Updated to latest guava
- Throw an exception if redis has not been started
- Redis errorStream logged to System.out
- Fluent API for RedisServer creation
- Initial decent release