Skip to content

Redpanda

Since testcontainers-go v0.20.0

Introduction

Redpanda is a streaming data platform for developers. Kafka API compatible. 10x faster. No ZooKeeper. No JVM! This Testcontainers module provides three APIs:

  • Kafka API
  • Schema Registry API
  • Redpanda Admin API

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

redpandaContainer, err := redpanda.Run(ctx,
    "docker.redpanda.com/redpandadata/redpanda:v23.3.3",
    redpanda.WithEnableSASL(),
    redpanda.WithEnableKafkaAuthorization(),
    redpanda.WithEnableWasmTransform(),
    redpanda.WithBootstrapConfig("data_transforms_per_core_memory_reservation", 33554432),
    redpanda.WithBootstrapConfig("data_transforms_per_function_memory_limit", 16777216),
    redpanda.WithNewServiceAccount("superuser-1", "test"),
    redpanda.WithNewServiceAccount("superuser-2", "test"),
    redpanda.WithNewServiceAccount("no-superuser", "test"),
    redpanda.WithSuperusers("superuser-1", "superuser-2"),
    redpanda.WithEnableSchemaRegistryHTTPBasicAuth(),
)
defer func() {
    if err := testcontainers.TerminateContainer(redpandaContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

Module Reference

Run function

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

The Redpanda module exposes one entrypoint function to create the Redpanda container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*RedpandaContainer, error)
  • context.Context, the Go context.
  • string, the Docker image to use.
  • testcontainers.ContainerCustomizer, a variadic argument for passing options.

Container Options

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

Image

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "docker.redpanda.com/redpandadata/redpanda:v23.1.7").

Image Substitutions

In more locked down / secured environments, it can be problematic to pull images from Docker Hub and run them without additional precautions.

An image name substitutor converts a Docker image name, as may be specified in code, to an alternative name. This is intended to provide a way to override image names, for example to enforce pulling of images from a private registry.

Testcontainers for Go exposes an interface to perform this operation: ImageSubstitutor, and a No-operation implementation to be used as reference for custom implementations:

// ImageSubstitutor represents a way to substitute container image names
type ImageSubstitutor interface {
    // Description returns the name of the type and a short description of how it modifies the image.
    // Useful to be printed in logs
    Description() string
    Substitute(image string) (string, error)
}

type NoopImageSubstitutor struct{}

// Description returns a description of what is expected from this Substitutor,
// which is used in logs.
func (s NoopImageSubstitutor) Description() string {
    return "NoopImageSubstitutor (noop)"
}

// Substitute returns the original image, without any change
func (s NoopImageSubstitutor) Substitute(image string) (string, error) {
    return image, nil
}

Using the WithImageSubstitutors options, you could define your own substitutions to the container images. E.g. adding a prefix to the images so that they can be pulled from a Docker registry other than Docker Hub. This is the usual mechanism for using Docker image proxies, caches, etc.

WithEnv

If you need to either pass additional environment variables to a container or override them, you can use testcontainers.WithEnv for example:

ctr, err = mymodule.Run(ctx, "docker.io/myservice:1.2.3", testcontainers.WithEnv(map[string]string{"FOO": "BAR"}))

WithExposedPorts

  • Not available until the next release of testcontainers-go main

If you need to expose additional ports from the container, you can use testcontainers.WithExposedPorts. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithExposedPorts("8080/tcp", "9090/tcp"))

WithEntrypoint

  • Not available until the next release of testcontainers-go main

If you need to completely replace the container's entrypoint, you can use testcontainers.WithEntrypoint. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithEntrypoint("/bin/sh", "-c", "echo hello"))

WithEntrypointArgs

  • Not available until the next release of testcontainers-go main

If you need to append commands to the container's entrypoint, you can use testcontainers.WithEntrypointArgs. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithEntrypointArgs("echo", "hello"))

WithCmd

  • Not available until the next release of testcontainers-go main

If you need to completely replace the container's command, you can use testcontainers.WithCmd. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithCmd("echo", "hello"))

WithCmdArgs

  • Not available until the next release of testcontainers-go main

If you need to append commands to the container's command, you can use testcontainers.WithCmdArgs. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithCmdArgs("echo", "hello"))

WithLabels

  • Not available until the next release of testcontainers-go main

If you need to add Docker labels to the container, you can use testcontainers.WithLabels. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithLabels(map[string]string{
        "environment": "testing",
        "project":     "myapp",
    }))

WithFiles

  • Not available until the next release of testcontainers-go main

If you need to copy files into the container, you can use testcontainers.WithFiles. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithFiles([]testcontainers.ContainerFile{
        {
            HostFilePath:      "/path/to/local/file.txt",
            ContainerFilePath: "/container/file.txt",
            FileMode:          0o644,
        },
    }))

This option allows you to copy files from the host into the container at creation time.

WithMounts

  • Not available until the next release of testcontainers-go main

If you need to add volume mounts to the container, you can use testcontainers.WithMounts. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithMounts([]testcontainers.ContainerMount{
        {
            Source: testcontainers.GenericVolumeMountSource{Name: "appdata"},
            Target: "/app/data",
        },
    }))

WithTmpfs

  • Not available until the next release of testcontainers-go main

If you need to add tmpfs mounts to the container, you can use testcontainers.WithTmpfs. For example:

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", 
    testcontainers.WithTmpfs(map[string]string{
        "/tmp": "size=100m",
        "/run": "size=100m",
    }))

WithHostPortAccess

If you need to access a port that is already running in the host, you can use testcontainers.WithHostPortAccess for example:

ctr, err = mymodule.Run(ctx, "docker.io/myservice:1.2.3", testcontainers.WithHostPortAccess(8080))

To understand more about this feature, please read the Exposing host ports to the container documentation.

WithLogConsumers

If you need to consume the logs of the container, you can use testcontainers.WithLogConsumers with a valid log consumer. An example of a log consumer is the following:

type TestLogConsumer struct {
    Msgs []string
}

func (g *TestLogConsumer) Accept(l Log) {
    g.Msgs = append(g.Msgs, string(l.Content))
}

WithLogger

If you need to either pass logger to a container, you can use testcontainers.WithLogger.

Info

Consider calling this before other "With" functions as these may generate logs.

In this example we also use the testcontainers-go log.TestLogger, which writes to the passed in testing.TB using Logf. The result is that we capture all logging from the container into the test context meaning its hidden behind go test -v and is associated with the relevant test, providing the user with useful context instead of appearing out of band.

func TestHandler(t *testing.T) {
    logger := log.TestLogger(t)
    ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", testcontainers.WithLogger(logger))
    CleanupContainer(t, ctr)
    require.NoError(t, err)
    // Do something with container.
}

Please read the Following Container Logs documentation for more information about creating log consumers.

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

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 the following methods:

  • AsCommand(), which returns a slice of strings to represent the command and positional arguments to be executed in the container;
  • Options(), which returns the slice of functional options with the Docker's ExecConfigs used to create the command in the container (the working directory, environment variables, user executing the command, etc) and the possible output format (Multiplexed).

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.

Ready Commands

Testcontainers exposes the WithAfterReadyCommand(e ...Executable) option to run arbitrary commands in the container right after it's ready, which happens when the defined wait strategies have finished with success.

Info

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

It leverages the Executable interface 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 ready.

Build from Dockerfile

  • Not available until the next release of testcontainers-go main

Testcontainers exposes the testcontainers.WithDockerfile option to build a container from a Dockerfile. The functional option receives a testcontainers.FromDockerfile struct that is applied to the container request before starting the container. As a result, the container is built and started in one go.

df := testcontainers.FromDockerfile{
    Context:    ".",
    Dockerfile: "Dockerfile",
    Repo:       "testcontainers",
    Tag:        "latest",
    BuildArgs:  map[string]*string{"ARG1": nil, "ARG2": nil},
}   

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3", testcontainers.WithDockerfile(df))

WithNetwork

By default, the container is started in the default Docker network. If you want to use an already existing Docker network you created in your code, you can use the network.WithNetwork(aliases []string, nw *testcontainers.DockerNetwork) option, which receives an alias as parameter and your network, attaching the container to it, and setting the network alias for that network.

In the case you need to retrieve the network name, you can simply read it from the struct's Name field. E.g. nw.Name.

Warning

This option is not checking whether the network exists or not. If you use a network that doesn't exist, the container will start in the default Docker network, as in the default behavior.

WithNewNetwork

If you want to attach your containers to a throw-away network, you can use the network.WithNewNetwork(ctx context.Context, aliases []string, opts ...network.NetworkCustomizer) option, which receives an alias as parameter, creating the new network with a random name, attaching the container to it, and setting the network alias for that network.

In the case you need to retrieve the network name, you can use the Networks(ctx) method of the Container interface, right after it's running, which returns a slice of strings with the names of the networks where the container is attached.

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.

Customising the ContainerRequest

This option will merge the customized request into the module's own ContainerRequest.

ctr, err := mymodule.Run(ctx, "docker.io/myservice:1.2.3",
    /* Other module options */
    testcontainers.CustomizeRequest(testcontainers.GenericContainerRequest{
        ContainerRequest: testcontainers.ContainerRequest{
            Cmd: []string{"-c", "log_statement=all"},
        },
    }),
)

The above example is updating the predefined command of the image, appending them to the module's command.

Info

This can't be used to replace the command, only to append options.

TLS Encryption

If you need to enable TLS use WithTLS with a valid PEM encoded certificate and key.

Additional Listener

There are scenarios where additional listeners are needed, for example if you want to consume/from another container in the same network

You can use the WithListener option to add a listener to the Redpanda container.

ctr, err := redpanda.Run(ctx,
    "redpandadata/redpanda:v23.2.18",
    network.WithNetwork([]string{"redpanda-host"}, rpNetwork),
    redpanda.WithListener("redpanda:29092"), redpanda.WithAutoCreateTopics(),
)

Container defined in the same network

kcat, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
    ContainerRequest: testcontainers.ContainerRequest{
        Image: "confluentinc/cp-kcat:7.4.1",
        Networks: []string{
            rpNetwork.Name,
        },
        Entrypoint: []string{
            "sh",
        },
        Cmd: []string{
            "-c",
            "tail -f /dev/null",
        },
    },
    Started: true,
})

Produce messages using the new registered listener

_, _, err = kcat.Exec(ctx, []string{"kcat", "-b", "redpanda:29092", "-t", "msgs", "-P", "-l", "/tmp/msgs.txt"})

Adding Service Accounts

It's possible to add service accounts to the Redpanda container using the WithNewServiceAccount option, setting the service account name and its password. E.g. WithNewServiceAccount("service-account", "password").

Adding Super Users

When a super user is needed, you can use the WithSuperusers option, passing a variadic list of super users. E.g. WithSuperusers("superuser-1", "superuser-2").

Enabling SASL

The WithEnableSASL() option enables SASL scram sha authentication. By default, no authentication (plaintext) is used. When setting an authentication method, make sure to add users as well and authorize them using the WithSuperusers() option.

WithEnableKafkaAuthorization

The WithEnableKafkaAuthorization enables authorization for connections on the Kafka API.

WithEnableWasmTransform

The WithEnableWasmTransform enables wasm transform.

Warning

Should not be used with RP versions before 23.3

WithEnableSchemaRegistryHTTPBasicAuth

The WithEnableSchemaRegistryHTTPBasicAuth enables HTTP basic authentication for the Schema Registry.

WithAutoCreateTopics

The WithAutoCreateTopics option enables the auto-creation of topics.

WithTLS

The WithTLS option enables TLS encryption. It requires a valid PEM encoded certificate and key, passed as byte slices. E.g. WithTLS([]byte(cert), []byte(key)).

WithBootstrapConfig

WithBootstrapConfig adds an arbitrary config key-value pair to the Redpanda container. Per the name, this config will be interpolated into the generated bootstrap config file, which is particularly useful for configs requiring a restart when otherwise applied to a running Redpanda instance. E.g. WithBootstrapConfig("config_key", config_value), where config_value is of type any.

Container Methods

The Redpanda container exposes the following methods:

KafkaSeedBroker

KafkaSeedBroker returns the seed broker that should be used for connecting to the Kafka API with your Kafka client. It'll be returned in the format: "host:port" - for example: "localhost:55687".

seedBroker, err := ctr.KafkaSeedBroker(ctx)

SchemaRegistryAddress

SchemaRegistryAddress returns the address to the schema registry API. This is an HTTP-based API and thus the returned format will be: http://host:port.

schemaRegistryURL, err := ctr.SchemaRegistryAddress(ctx)

AdminAPIAddress

AdminAPIAddress returns the address to the Redpanda Admin API. This is an HTTP-based API and thus the returned format will be: http://host:port.

adminAPIURL, err := ctr.AdminAPIAddress(ctx)

WithAdminAPIAuthentication

Enables Admin API Authentication by setting admin_api_require_auth cluster configuration property to true. It also configures a bootstrap superuser account via RP_BOOTSTRAP_USER environment variable.