Skip to content

ClickHouse

Since testcontainers-go v0.23.0

Introduction

The Testcontainers module for ClickHouse.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

user := "clickhouse"
password := "password"
dbname := "testdb"

clickHouseContainer, err := clickhouse.RunContainer(ctx,
    testcontainers.WithImage("clickhouse/clickhouse-server:23.3.8.21-alpine"),
    clickhouse.WithUsername(user),
    clickhouse.WithPassword(password),
    clickhouse.WithDatabase(dbname),
    clickhouse.WithInitScripts(filepath.Join("testdata", "init-db.sh")),
    clickhouse.WithConfigFile(filepath.Join("testdata", "config.xml")),
)
if err != nil {
    log.Fatalf("failed to start container: %s", err)
}
defer func() {
    if err := clickHouseContainer.Terminate(ctx); err != nil {
        log.Fatalf("failed to terminate container: %s", err)
    }
}()

Module reference

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

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

Container Ports

Here you can find the list with the default ports used by the ClickHouse container.

httpPort   = nat.Port("8123/tcp")
nativePort = nat.Port("9000/tcp")

Container Options

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

Image

If you need to set a different ClickHouse Docker image, you can use testcontainers.WithImage with a valid Docker image for ClickHouse. E.g. testcontainers.WithImage("clickhouse/clickhouse-server:23.3.8.21-alpine").

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.RunContainer(ctx, 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.RunContainer(ctx, 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)
    _, err := postgresModule.RunContainer(ctx, 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.

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.

Set username, password and database name

If you need to set a different database, and its credentials, you can use WithUsername, WithPassword, WithDatabase options. E.g. WithUsername("user"), WithPassword("password"), WithDatabase("db").

Info

The default values for the username is default, for password is clickhouse and for the default database name is clickhouse.

Init Scripts

If you would like to do additional initialization in the ClickHouse container, add one or more *.sql, *.sql.gz, or *.sh scripts to the container request. Those files will be copied after the container is created but before it's started under /docker-entrypoint-initdb.d. According to ClickHouse Docker image, it will run any *.sql files, run any executable *.sh scripts, and source any non-executable *.sh scripts found in that directory to do further initialization before starting the service.

container, err := clickhouse.RunContainer(ctx,
    clickhouse.WithUsername(user),
    clickhouse.WithPassword(password),
    clickhouse.WithDatabase(dbname),
    clickhouse.WithInitScripts(filepath.Join("testdata", "init-db.sh")),
)
if err != nil {
    t.Fatal(err)
}

#!/bin/bash
set -e

clickhouse-client \
  --user "$CLICKHOUSE_USER" \
  --password "$CLICKHOUSE_PASSWORD" \
  --database "$CLICKHOUSE_DB" \
  --query "create table if not exists test_table (id UInt64) engine = MergeTree PRIMARY KEY (id) ORDER BY (id) SETTINGS index_granularity = 8192; INSERT INTO test_table (id) VALUES (1);" --multiquery

Zookeeper

Clusterized ClickHouse requires to start Zookeeper and pass link to it via config.xml.

zkPort := nat.Port("2181/tcp")

zkcontainer, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
    ContainerRequest: testcontainers.ContainerRequest{
        ExposedPorts: []string{zkPort.Port()},
        Image:        "zookeeper:3.7",
        WaitingFor:   wait.ForListeningPort(zkPort),
    },
    Started: true,
})
if err != nil {
    t.Fatal(err)
}

ipaddr, err := zkcontainer.ContainerIP(ctx)
if err != nil {
    t.Fatal(err)
}

container, err := clickhouse.RunContainer(ctx,
    clickhouse.WithUsername(user),
    clickhouse.WithPassword(password),
    clickhouse.WithDatabase(dbname),
    clickhouse.WithZookeeper(ipaddr, zkPort.Port()),
)
if err != nil {
    t.Fatal(err)
}

Warning

The WithZookeeper option will panic if it's not possible to create the Zookeeper config file.

Custom configuration

If you need to set a custom configuration, the module provides the WithConfigFile option to pass the path to a custom configuration file in XML format.

<clickhouse>
  <allow_no_password>1</allow_no_password>
</clickhouse>

In the case you want to pass a YAML configuration file, you can use the WithYamlConfigFile option.

allow_no_password: true

Container Methods

The ClickHouse container exposes the following methods:

ConnectionHost

This method returns the host and port of the ClickHouse container, using the default, native 9000/tcp port. E.g. localhost:9000

connectionHost, err := container.ConnectionHost(ctx)

ConnectionString

This method returns the dsn connection string to connect to the ClickHouse container, using the default, native 9000/tcp port obtained from the ConnectionHost method. It's possible to pass extra parameters to the connection string, e.g. dial_timeout=300ms or skip_verify=false, in a variadic way.

e.g. clickhouse://default:pass@localhost:9000?dial_timeout=300ms&skip_verify=false

connectionString, err := container.ConnectionString(ctx, "debug=true")