Skip to content


Since testcontainers-go v0.30.0


A testcontainers module for InfluxDB. This module supports v1.x of InfluxDB.

Adding this module to your project dependencies

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

go get

Usage example

ctx := context.Background()

influxdbContainer, err := influxdb.Run(ctx,
if err != nil {
    log.Fatalf("failed to start container: %s", err)

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

Module Reference

Run function


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

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*InfluxDbContainer, 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 container, you can pass options in a variadic way to configure it.


You can find configuration information for the InfluxDB image on Docker Hub and a list of possible environment variables on InfluxDB documentation.


To use a different Docker image, you can set a valid Docker image as the second argument in the Run function. E.g. Run(context.Background(), "influxdb:1.8.0").


Note that influxdb:latest will get you a version 2 image which is not supported by this module.

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.


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


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.


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


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


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)
    _, err := postgresModule.Run(ctx, "postgres:15-alpine", testcontainers.WithLogger(logger))
    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.


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.


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.


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.


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.


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.


If you want to attach your containers to a throw-away network, you can use the network.WithNewNetwork(ctx context.Context, aliases []string, opts 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 */
        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.


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

Set username, password and database name

By default, authentication is disabled and no credentials are needed to use the Influx API against the test container. If you want to test with credentials, include the appropriate environment variables to do so.

Init Scripts

While the InfluxDB image will obey the /docker-entrypoint-initdb.d directory as is common, that directory does not exist in the default image. Instead, you can use the WithInitDb option to pass a directory which will be copied to when the container starts. Any *.sh or *.iql files in the directory will be processed by the image upon startup. When executing these scripts, the script in the image will start the InfluxDB server, run the scripts, stop the server, and restart the server. This makes it tricky to detect the readiness of the container. This module looks for that and adds some extra tests for readiness, but these could be fragile.


The WithInitDb option receives a path to the parent directory of one named docker-entrypoint-initdb.d. This is because the docker-entrypoint-initdb.d directory is not present in the image.

Custom configuration

If you need to set a custom configuration, you can use WithConfigFile option to pass the path to a custom configuration file.

Container Methods


This function is a simple helper to return a URL to the container, using the default 8086 port.

cli, err := influxclient.NewHTTPClient(influxclient.HTTPConfig{
    Addr: influxDbContainer.MustConnectionUrl(context.Background()),

Please check the existence of two methods: ConnectionUrl and MustConnectionUrl. The latter is used to avoid the need to handle errors, while the former is used to return the URL and the error. MustConnectionUrl will panic if an error occurs.


The ConnectionUrl and MustConnectionUrl methods only support HTTP connections at the moment.