https://github.com/asarkar/embedded-redis-spring

https://github.com/asarkar/embedded-redis-spring

annotation embedded-redis-server integration-testing redis redis-server spring spring-boot testing

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/asarkar/embedded-redis-spring
• Owner: asarkar
• License: apache-2.0
• Created: 2020-11-12T01:10:19.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-14T05:00:10.000Z (8 months ago)
• Last Synced: 2024-05-01T12:20:58.009Z (7 months ago)
• Topics: annotation, embedded-redis-server, integration-testing, redis, redis-server, spring, spring-boot, testing
• Language: Kotlin
• Homepage:
• Size: 76.2 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/ozimov/embedded-redis) and [Spring Boot](https://spring.io/projects/spring-boot). 

## Installation

You can find the latest version on [Maven Central](https://search.maven.org/search?q=g:com.asarkar.spring%20AND%20a:embedded-redis-spring).

## 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](src/main/kotlin/com/asarkar/spring/test/redis/EmbeddedRedisConfigurer.kt), 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](LICENSE).