Skip to content

Registry

Since testcontainers-go v0.30.0

Introduction

The Testcontainers module for Registry.

Adding this module to your project dependencies

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

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

Usage example

registryContainer, err := registry.Run(context.Background(), "registry:2.8.3")
defer func() {
    if err := testcontainers.TerminateContainer(registryContainer); 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 Registry module exposes one entrypoint function to create the Registry container, and this function receives three parameters:

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

Docker Auth Config

The module exposes a way to set the Docker Auth Config for the Registry container, thanks to the SetDockerAuthConfig function. This is useful when you need to pull images from a private registry. It basically sets the DOCKER_AUTH_CONFIG environment variable with authentication for the given host, username and password sets. It returns a function to reset the environment back to the previous state, which is helpful when you need to reset the environment after a test.

On the same hand, the module also exposes a way to build a Docker Auth Config for the Registry container, thanks to the DockerAuthConfig helper function. This function returns a map of AuthConfigs including base64 encoded Auth field for the provided details. It also accepts additional host, username and password triples to add more auth configurations.

Container Options

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

Image

If you need to set a different Registry Docker image, you can set a valid Docker image as the second argument in the Run function. E.g. Run(context.Background(), "registry:2.8.3").

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

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.Run(ctx, "postgres:15-alpine", testcontainers.WithEnv(map[string]string{"POSTGRES_INITDB_ARGS": "--no-sync"}))

WithHostPortAccess

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

postgres, err = postgresModule.Run(ctx, "postgres:15-alpine", 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 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 := TestLogger(t)
    ctr, err := postgresModule.Run(ctx, "postgres:15-alpine", 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.

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 := Run(ctx, "postgres:13-alpine",
    /* 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.

With Authentication

It's possible to enable authentication for the Registry container. By default, it is disabled, but you can enable it in two ways:

  • You can use WithHtpasswd to enable authentication with a string representing the contents of a htpasswd file. A temporary file will be created with the contents of the string and copied to the container.
  • You can use WithHtpasswdFile to copy a htpasswd file from your local filesystem to the container.

In both cases, the htpasswd file will be copied into the /auth directory inside the container.

registryContainer, err := registry.Run(
    ctx,
    registry.DefaultImage,
    registry.WithHtpasswd("testuser:$2y$05$tTymaYlWwJOqie.bcSUUN.I.kxmo1m5TLzYQ4/ejJ46UMXGtq78EO"),
)

ctx := context.Background()
registryContainer, err := registry.Run(
    ctx,
    "registry:2.8.3",
    registry.WithHtpasswdFile(filepath.Join("testdata", "auth", "htpasswd")),
    registry.WithData(filepath.Join("testdata", "data")),
)

WithData

In the case you want to initialise the Registry with your own images, you can use WithData to copy a directory from your local filesystem to the container. The directory will be copied into the /data directory inside the container. The format of the directory should be the same as the one used by the Registry to store images. Otherwise, the Registry will start but you won't be able to read any images from it.

ctx := context.Background()
registryContainer, err := registry.Run(
    ctx,
    "registry:2.8.3",
    registry.WithHtpasswdFile(filepath.Join("testdata", "auth", "htpasswd")),
    registry.WithData(filepath.Join("testdata", "data")),
)

Container Methods

The Registry container exposes the following methods:

HostAddress

This method returns the returns the host address including port of the Distribution Registry. E.g. localhost:32878.

Address

This method returns the HTTP address string to connect to the Distribution Registry, so that you can use to connect to the Registry. E.g. http://localhost:32878.

httpAddress, err := registryContainer.Address(ctx)

ImageExists

The ImageExists method allows to check if an image exists in the Registry. It receives the Go context and the image reference as parameters.

Info

The image reference should be in the format my-registry:port/image:tag in order to be pushed to the Registry.

PushImage

The PushImage method allows to push an image to the Registry. It receives the Go context and the image reference as parameters.

Info

The image reference should be in the format my-registry:port/image:tag in order to be pushed to the Registry.

// repo is localhost:32878/customredis
// tag is v1.2.3
err = registryContainer.PushImage(context.Background(), fmt.Sprintf("%s:%s", repo, tag))
if err != nil {
    log.Printf("failed to push image: %s", err)
    return
}

If the push operation is successful, the method will internally wait for the image to be available in the Registry, querying the Registry API, returning an error in case of any failure (e.g. pushing or waiting for the image).

DeleteImage

The DeleteImage method allows to delete an image from the Registry. It receives the Go context and the image reference as parameters.

Info

The image reference should be in the format image:tag in order to be deleted from the Registry.

// newImage is customredis:v1.2.3
err = registryContainer.DeleteImage(context.Background(), newImage)
if err != nil {
    log.Printf("failed to delete image: %s", err)
    return
}