Redis¶

Since testcontainers-go v0.20.0

Introduction¶

The Testcontainers module for Redis.

Adding this module to your project dependencies¶

Please run the following command to add the Redis module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/redis

Usage example¶

Creating a Redis container

ctx := context.Background()

redisContainer, err := redis.RunContainer(ctx,
    testcontainers.WithImage("docker.io/redis:7"),
    redis.WithSnapshotting(10, 1),
    redis.WithLogLevel(redis.LogLevelVerbose),
    redis.WithConfigFile(filepath.Join("testdata", "redis7.conf")),
)
if err != nil {
    panic(err)
}

// Clean up the container
defer func() {
    if err := redisContainer.Terminate(ctx); err != nil {
        panic(err)
    }
}()

Module Reference¶

The Redis module exposes one entrypoint function to create the containerr, and this function receives two parameters:

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*RedisContainer, error)

context.Context, the Go context.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Container Options¶

When starting the Redis container, you can pass options in a variadic way to configure it.

Tip

You can find all the available configuration and environment variables for the Redis Docker image on Docker Hub.

Image¶

If you need to set a different Redis Docker image, you can use testcontainers.WithImage with a valid Docker image for Redis. E.g. testcontainers.WithImage("docker.io/redis:7").

Wait Strategies¶

If you need to set a different wait strategy for the container, you can use testcontainers.WithWaitStrategy with a valid wait strategy.

Info

The default deadline for the wait strategy is 60 seconds.

At the same time, it's possible to set a wait strategy and a custom deadline with testcontainers.WithWaitStrategyAndDeadline.

Startup Commands¶

Not available until the next release of testcontainers-go main

Testcontainers exposes the WithStartupCommand(e ...Executable) option to run arbitrary commands in the container right after it's started.

Info

To better understand how this feature works, please read the Create containers: Lifecycle Hooks documentation.

It also exports an Executable interface, defining one single method: AsCommand(), which returns a slice of strings to represent the command and positional arguments to be executed in the container.

You could use this feature to run a custom script, or to run a command that is not supported by the module right after the container is started.

Docker type modifiers¶

If you need an advanced configuration for the container, you can leverage the following Docker type modifiers:

testcontainers.WithConfigModifier
testcontainers.WithHostConfigModifier
testcontainers.WithEndpointSettingsModifier

Please read the Create containers: Advanced Settings documentation for more information.

Snapshotting¶

By default Redis saves snapshots of the dataset on disk, in a binary file called dump.rdb. You can configure Redis to have it save the dataset every N seconds if there are at least M changes in the dataset. E.g. WithSnapshotting(10, 1).

Tip

Please check Redis docs on persistence for more information.

Log Level¶

By default Redis saves snapshots of the dataset on disk, in a binary file called dump.rdb. You can configure Redis to have it save the dataset every N seconds if there are at least M changes in the dataset. E.g. WithLogLevel(LogLevelDebug).

Tip

Please check Redis docs on logging for more information.

Redis configuration¶

In the case you have a custom config file for Redis, it's possible to copy that file into the container before it's started. E.g. WithConfigFile(filepath.Join("testdata", "redis7.conf")).

Container Methods¶

ConnectionString¶

This method returns the connection string to connect to the Redis container, using the default 6379 port.

Get connection string

uri, err := redisContainer.ConnectionString(ctx)

Redis variants¶

It's possible to use the Redis container with Redis-Stack. You simply need to update the image name.

Image for Redis-StackImage for Redis-Stack Server

image: "docker.io/redis/redis-stack:latest",

image: "docker.io/redis/redis-stack-server:latest",