Skip to content

CockroachDB

Since testcontainers-go v0.28.0

Introduction

The Testcontainers module for CockroachDB.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

cockroachdbContainer, err := cockroachdb.RunContainer(ctx)
if err != nil {
    log.Fatalf("failed to start container: %s", err)
}

// Clean up the container
defer func() {
    if err := cockroachdbContainer.Terminate(ctx); err != nil {
        log.Fatalf("failed to terminate container: %s", err)
    }
}()

Module reference

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

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*CockroachDBContainer, error)
  • context.Context, the Go context.
  • testcontainers.ContainerCustomizer, a variadic argument for passing options.

Warning

When TLS is enabled there's a very small, unlikely chance that the underlying driver can panic when registering the driver as part of waiting for CockroachDB to be ready to accept connections. If this is repeatedly happening please open an issue.

Container Options

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

Image

If you need to set a different CockroachDB Docker image, you can use testcontainers.WithImage with a valid Docker image for CockroachDB. E.g. testcontainers.WithImage("cockroachdb/cockroach:latest-v23.1").

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 operations: 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

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

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

postgres, err = postgresModule.RunContainer(ctx, testcontainers.WithEnv(map[string]string{"POSTGRES_INITDB_ARGS", "--no-sync"}))

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))
}

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.

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.

container, err := RunContainer(ctx,
    /* 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.

Database

Set the database that is created & dialled with cockroachdb.WithDatabase.

Password authentication

Disable insecure mode and connect with password authentication by setting cockroachdb.WithUser and cockroachdb.WithPassword.

Store size

Control the maximum amount of memory used for storage, by default this is 100% but can be changed by provided a valid option to WithStoreSize. Checkout https://www.cockroachlabs.com/docs/stable/cockroach-start#store for the full range of options available.

TLS authentication

cockroachdb.WithTLS lets you provide the CA certificate along with the certicate and key for the node & clients to connect with. Internally CockroachDB requires a client certificate for the user to connect with.

A helper cockroachdb.NewTLSConfig exists to generate all of this for you.

Container Methods

The CockroachDB container exposes the following methods:

ConnectionString

Dial address to open a new connection.

MustConnectionString

Same as ConnectionString but any error to generate the address will raise a panic

TLSConfig

Returns *tls.Config setup to allow you to dial your client over TLS, if enabled, else this will error with cockroachdb.ErrTLSNotEnabled.