Merge pull request #4 from jupiter-tools/feature/add-a-readme

Feature/add a readme

Author: antkorwin

README.adoc

@@ -0,0 +1,70 @@
+:toc: preamble
+
+# Spring Test Redis
+
+image:https://travis-ci.com/jupiter-tools/spring-test-redis.svg?branch=master["Build Status", link="https://travis-ci.com/jupiter-tools/spring-test-redis"]
+
+
+Tools to write integration tests of Spring Framework with Redis.
+
+## Overview
+
+image:./images/redis.png[redis container scheme,300]
+
+## How to write integration tests on Spring Framework with Redis
+
+Add this library in dependencies:
+
+[source,xml]
+----
+<dependency>
+    <groupId>com.jupiter-tools</groupId>
+    <artifactId>spring-test-redis</artifactId>
+    <version>0.1</version>
+</dependency>
+----
+
+And now, you can start Redis in docker (TestContainers) by the using of `@RedisTestContainer` annotation in tests:
+
+[source, java]
+----
+@SpringBootTest
+@RedisTestContainer
+class RedisTestContainerTest {
+
+    @Autowired
+    private RedisTemplate redisTemplate;
+
+    @Test
+    void readWriteValueByRedisTemplate() {
+        String key = "test";
+        String value = "sabracadabra";
+        // Act
+        redisTemplate.opsForValue().set(key, value);
+        // Assert
+        assertThat(redisTemplate.opsForValue().get(key)).isEqualTo(value);
+    }
+}
+----
+
+You can use this annotation to start Redis container in tests both with JUnit5 and JUnit4. The implementation doesn't depend on some test framework, just on the Spring Framework.
+
+## How to use multiple Redis containers in the one test case:
+
+[source, java]
+----
+@SpringBootTest
+@RedisTestContainer  <1>
+@RedisTestContainer(hostTargetProperty = "my.host", portTargetProperty = "my.port")  <2>
+class MultipleContainerInOneTest {
+
+    ...
+
+}
+----
+<1> start a Redis test container and set a host/port value of started container to default Spring Boot properties (`spring.redis.host` and `spring.redis.port`)
+<2> start another Redis container and set a host/port value to specified properties, exactly in these properties you can read an actual value of host/port after run application context.
+
+After test execution you can see something like this in the output:
+
+image:./images/multiple_containers.png[multiple docker container result in stdout]

images/multiple_containers.png

@@ -1,6 +1,8 @@
 package com.jupitertools.springtestredis.customizer;
 
 import com.jupitertools.springtestredis.RedisTestContainer;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.MergedContextConfiguration;
@@ -24,6 +26,8 @@ public class PropertyMutationContextCustomizer implements ContextCustomizer {
 
     private static final Integer REDIS_PORT = 6379;
 
+    private static final Log logger = LogFactory.getLog("RedisTestContainer");
+
     public PropertyMutationContextCustomizer(Set<RedisContainerDescription> descriptions) {
         this.descriptions = descriptions;
     }
@@ -33,8 +37,7 @@ public void customizeContext(ConfigurableApplicationContext context,
                                  MergedContextConfiguration mergedConfig) {
 
         for (RedisContainerDescription description : descriptions) {
-
-            System.out.println("Start REDIS TestContainer");
+            logger.info("Start REDIS TestContainer");
             GenericContainer redis = new GenericContainer("redis:latest").withExposedPorts(REDIS_PORT);
             redis.start();
 
@@ -48,8 +51,12 @@ public void customizeContext(ConfigurableApplicationContext context,
 
     @Override
     public boolean equals(Object o) {
-        if (this == o) { return true; }
-        if (o == null || getClass() != o.getClass()) { return false; }
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
         PropertyMutationContextCustomizer that = (PropertyMutationContextCustomizer) o;
         return Objects.equals(descriptions, that.descriptions);
     }