embedded-redis-spring
Starts a Redis server and makes the port available as Spring Boot environment property. Stops the server when the Spring context is destroyed.
Requires Java 8 or later. Uses embedded-redis and Spring Boot.
Installation
You can find the latest version on Maven Central.
Usage
The only thing you need is the AutoConfigureEmbeddedRedis annotation:
@SpringBootTest
@AutoConfigureEmbeddedRedis
public class AutoConfigureWithKnownPortsTest {
@Test
public void testConnection() {
RedisClient redisClient = RedisClient
.create("redis://localhost:6379/");
...
}
}
To use random port:
@SpringBootTest
@AutoConfigureEmbeddedRedis(port = 0)
public class AutoConfigureWithRandomPortsTest {
@Value("${embedded-redis.port:-1}")
private int port;
@Test
public void testConnection() {
RedisClient redisClient = RedisClient
.create(String.format("redis://localhost:%d/", port));
...
}
}
If you want to configure the RedisServer before it's started, provide an implementation for
EmbeddedRedisConfigurer, and set the
class name in the annotation element serverConfigurerClass. If a Spring bean of this type exists, it'll be used;
otherwise, a new instance will be created using the public no-argument constructor.
See KDoc for more details.
Contribute
This project is a volunteer effort. You are welcome to send pull requests, ask questions, or create issues. you can help by spreading the word and "Starring" the GitHub repo!
License
Copyright 2021 Abhijit Sarkar - Released under Apache License v2.0.