Skip to content

Commit d2b74e9

Browse files
committed
Added getting started to README
1 parent 4a034e2 commit d2b74e9

File tree

4 files changed

+73
-7
lines changed

4 files changed

+73
-7
lines changed

README.adoc

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,73 @@
44
:project-name: testcontainers-redis
55
:project-group: com.redis.testcontainers
66
:project-version: 1.3.3
7+
:junit-version: 5.7.2
8+
:testcontainers-version: 1.15.3
9+
:sourcedir: subprojects/testcontainers-redis/src/test/java
710

811
image:https://github.com/{project-owner}/{project-name}/actions/workflows/early-access.yml/badge.svg["Build Status", link="https://github.com/{project-owner}/{project-name}/actions"]
912
image:https://img.shields.io/maven-central/v/{project-group}/{project-name}.svg[Download, link="https://search.maven.org/#search|ga|1|{project-name}"]
1013
image:https://img.shields.io/github/downloads/{project-owner}/{project-name}/total[GitHub all releases]
1114

1215
Testcontainers Redis is an extension of Testcontainers that supports Redis, Redis Modules, and Redis Enterprise.
16+
17+
== Getting Started
18+
19+
=== Junit 5
20+
21+
.Gradle
22+
[source,groovy,subs="+attributes"]
23+
----
24+
testImplementation "org.junit.jupiter:junit-jupiter-api:{junit-version}"
25+
testImplementation "org.junit.jupiter:junit-jupiter-params:{junit-version}"
26+
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:{junit-version}"
27+
testImplementation "com.redis.testcontainers:testcontainers-redis:{project-version}"
28+
testImplementation "com.redis.testcontainers:junit-jupiter:{testcontainers-version}"
29+
----
30+
31+
.Maven
32+
[source,xml,subs="+attributes"]
33+
----
34+
<dependency>
35+
<groupId>org.junit.jupiter</groupId>
36+
<artifactId>junit-jupiter-api</artifactId>
37+
<version>{junit-version}</version>
38+
<scope>test</scope>
39+
</dependency>
40+
<dependency>
41+
<groupId>org.junit.jupiter</groupId>
42+
<artifactId>junit-jupiter-params</artifactId>
43+
<version>{junit-version}</version>
44+
<scope>test</scope>
45+
</dependency>
46+
<dependency>
47+
<groupId>org.junit.jupiter</groupId>
48+
<artifactId>junit-jupiter-engine</artifactId>
49+
<version>{junit-version}</version>
50+
<scope>test</scope>
51+
</dependency>
52+
<dependency>
53+
<groupId>com.redis.testcontainers</groupId>
54+
<artifactId>testcontainers-redis</artifactId>
55+
<version>{project-version}</version>
56+
<scope>test</scope>
57+
</dependency>
58+
<dependency>
59+
<groupId>com.redis.testcontainers</groupId>
60+
<artifactId>junit-jupiter</artifactId>
61+
<version>{testcontainers-version}</version>
62+
<scope>test</scope>
63+
</dependency>
64+
----
65+
66+
Redis::
67+
https://github.com/redis-developer/testcontainers-redis/blob/master/subprojects/testcontainers-redis/src/test/java/com/redis/testcontainers/TestRedis.java[TestRedis.java]
68+
69+
Redis Cluster::
70+
https://github.com/redis-developer/testcontainers-redis/blob/master/subprojects/testcontainers-redis/src/test/java/com/redis/testcontainers/TestRedisCluster.java[TestRedisCluster.java]
71+
72+
Redis Modules::
73+
https://github.com/redis-developer/testcontainers-redis/blob/master/subprojects/testcontainers-redis/src/test/java/com/redis/testcontainers/TestRedisModules.java[TestRedisModules.java]
74+
75+
Redis Enterprise::
76+
https://github.com/redis-developer/testcontainers-redis/blob/master/subprojects/testcontainers-redis/src/test/java/com/redis/testcontainers/TestRedisEnterprise.java[TestRedisEnterprise.java]

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.3.3
1+
1.3.4-SNAPSHOT

gradle.properties

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ sourceCompatibility=1.8
33
targetCompatibility=1.8
44
redisBuildVersion=0.2.0
55
kordampPluginVersion=0.46.0
6-
lombokPluginVersion=6.0.0-m2
6+
lombokPluginVersion=6.0.0-m2
7+
junitVersion=5.7.2
8+
testcontainersVersion=1.15.3
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
dependencies {
2-
implementation 'com.redis.testcontainers:testcontainers:1.15.3'
3-
testImplementation 'com.redis.testcontainers:junit-jupiter:1.15.3'
4-
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.2'
5-
testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.7.2'
6-
testImplementation 'org.junit.jupiter:junit-jupiter-params:5.7.2'
2+
implementation group: 'com.redis.testcontainers', name: 'testcontainers', version: testcontainersVersion
3+
testImplementation group: 'com.redis.testcontainers', name: 'junit-jupiter', version: testcontainersVersion
4+
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: junitVersion
5+
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: junitVersion
6+
testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: junitVersion
77
testImplementation 'org.slf4j:slf4j-simple:1.7.30'
88
testImplementation 'com.redis:lettucemod:1.5.1'
99
}

0 commit comments

Comments
 (0)