https://github.com/redis-field-engineering/testcontainers-redis

Testcontainers module for Redis
https://github.com/redis-field-engineering/testcontainers-redis

Last synced: 3 months ago
JSON representation

Testcontainers module for Redis

• Host: GitHub
• URL: https://github.com/redis-field-engineering/testcontainers-redis
• Owner: redis-field-engineering
• License: apache-2.0
• Created: 2021-04-15T16:57:35.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-02-19T17:00:24.000Z (3 months ago)
• Last Synced: 2025-02-19T17:33:57.436Z (3 months ago)
• Language: Java
• Size: 2 MB
• Stars: 38
• Watchers: 7
• Forks: 12
• Open Issues: 9
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= Testcontainers Redis

:linkattrs:

:project-owner:   redis-field-engineering

:project-name:    testcontainers-redis

:project-group:   com.redis

:project-version: 2.2.4

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"]

image:https://img.shields.io/maven-central/v/{project-group}/{project-name}[Download,link="https://search.maven.org/#search|ga|1|{project-name}"]

image:https://img.shields.io/github/license/{project-owner}/{project-name}["License",link="https://github.com/{project-owner}/{project-name}"]

Testcontainers Redis is an extension of Testcontainers that supports Redis (Standalone and Cluster), Redis Modules, and Redis Enterprise containers.

== Getting Started

=== Gradle

[source,groovy,subs="+attributes"]

----

dependencies {

    testImplementation "{project-group}:{project-name}:{project-version}"

}

----

=== Maven

[source,xml,subs="+attributes"]

----

    {project-group}

    {project-name}

    {project-version}

    test

----

== Usage

=== Redis Example

[source,java]

----

@Testcontainers

class RedisExampleTest {

    @Container

    private static RedisContainer container = new RedisContainer(

            RedisContainer.DEFAULT_IMAGE_NAME.withTag(RedisContainer.DEFAULT_TAG));

    @Test

    void testSomethingUsingLettuce() {

        // Retrieve the Redis URI from the container

        String redisURI = container.getRedisURI();

        RedisClient client = RedisClient.create(redisURI);

        try (StatefulRedisConnection connection = client.connect()) {

            RedisCommands commands = connection.sync();

            Assertions.assertEquals("PONG", commands.ping());

        }

    }

}

----

=== Redis Stack Example

[source,java]

----

@Testcontainers

class RedisStackExampleTest {

    @Container

    private static RedisStackContainer container = new RedisStackContainer(

            RedisStackContainer.DEFAULT_IMAGE_NAME.withTag(RedisStackContainer.DEFAULT_TAG));

    @Test

    void testSomethingUsingLettuceMod() {

        // Retrieve the Redis URI from the container

        String redisURI = container.getRedisURI();

        RedisModulesClient client = RedisModulesClient.create(redisURI);

        try (StatefulRedisModulesConnection connection = client.connect()) {

            RedisModulesCommands commands = connection.sync();

            commands.ftCreate("myIndex", Field.tag("myField").build());

            IndexInfo indexInfo = RedisModulesUtils.indexInfo(commands.ftInfo("myIndex"));

            Assertions.assertEquals(1, indexInfo.getFields().size());

            Assertions.assertEquals("myField", indexInfo.getFields().get(0).getName());

        }

    }

}

----