Elasticsearch¶

Introduction¶

The Testcontainers module for Elasticsearch.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating an Elasticsearch container

ctx := context.Background()
elasticsearchContainer, err := elasticsearch.Run(ctx, "docker.elastic.co/elasticsearch/elasticsearch:8.9.0")
defer func() {
    if err := testcontainers.TerminateContainer(elasticsearchContainer); 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¶

Since v0.32.0

Info

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

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*ElasticsearchContainer, error)

context.Context, the Go context.
string, the Docker image to use.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Image¶

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "docker.elastic.co/elasticsearch/elasticsearch:8.0.0").

Container Options¶

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

WithPassword¶

Since v0.24.0

If you need to set a different password to request authorization when performing HTTP requests to the container, you can use the WithPassword option. By default, the username is set to elastic, and the password is set to changeme.

Info

In versions of Elasticsearch prior to 8.0.0, the default password is empty.

Custom Password

ctx := context.Background()
elasticsearchContainer, err := elasticsearch.Run(
    ctx,
    "docker.elastic.co/elasticsearch/elasticsearch:7.9.2",
    elasticsearch.WithPassword("foo"),
)
defer func() {
    if err := testcontainers.TerminateContainer(elasticsearchContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

The following options are exposed by the testcontainers package.

Basic Options¶

WithExposedPorts Since v0.37.0
WithEnv Since v0.29.0
WithWaitStrategy Since v0.20.0
WithAdditionalWaitStrategy Since v0.38.0
WithWaitStrategyAndDeadline Since v0.20.0
WithAdditionalWaitStrategyAndDeadline Since v0.38.0
WithEntrypoint Since v0.37.0
WithEntrypointArgs Since v0.37.0
WithCmd Since v0.37.0
WithCmdArgs Since v0.37.0
WithLabels Since v0.37.0

Lifecycle Options¶

WithLifecycleHooks Since v0.38.0
WithAdditionalLifecycleHooks Since v0.38.0
WithStartupCommand Since v0.25.0
WithAfterReadyCommand Since v0.28.0

Files & Mounts Options¶

Build Options¶

WithDockerfile Since v0.37.0

Logging Options¶

Image Options¶

Networking Options¶

Advanced Options¶

WithHostPortAccess Since v0.31.0
WithConfigModifier Since v0.20.0
WithHostConfigModifier Since v0.20.0
WithEndpointSettingsModifier Since v0.20.0
CustomizeRequest Since v0.20.0
WithName Since v0.38.0
WithNoStart Since v0.38.0
WithProvider Since v0.39.0

Experimental Options¶

WithReuseByName Since v0.37.0

Examples¶

Configuring the access to the Elasticsearch container¶

The Elasticsearch container exposes its settings in order to configure the client to connect to it. With those settings it's very easy to setup up our preferred way to connect to the container. We are going to show you two ways to connect to the container, using the HTTP client from the standard library, and using the Elasticsearch client.

Info

The TLS access is only supported on Elasticsearch 8 and above, so please pay attention to how the below examples are using the CACert and URL settings.

Using the standard library's HTTP client¶

Create an HTTP client

client := http.DefaultClient

if esContainer.Settings.CACert == nil {
    return client
}

// configure TLS transport based on the certificate bytes that were retrieved from the container
caCertPool := x509.NewCertPool()
caCertPool.AppendCertsFromPEM(esContainer.Settings.CACert)

client.Transport = &http.Transport{
    TLSClientConfig: &tls.Config{
        RootCAs: caCertPool,
    },
}

The esContainer instance is obtained from the elasticsearch.New function.

In the case you configured the Elasticsearch container to set up a password, you'll need to add the Authorization header to the request. You can use the SetBasicAuth method from the HTTP request to generate the header value.

Using an authenticated client

req.SetBasicAuth(esContainer.Settings.Username, esContainer.Settings.Password)

Using the Elasticsearch client¶

First, you must install the Elasticsearch Go client, so please read their install guide for more information.

Create an Elasticsearch client

ctx := context.Background()
elasticsearchContainer, err := elasticsearch.Run(
    ctx,
    "docker.elastic.co/elasticsearch/elasticsearch:8.9.0",
    elasticsearch.WithPassword("foo"),
)
defer func() {
    if err := testcontainers.TerminateContainer(elasticsearchContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

cfg := es.Config{
    Addresses: []string{
        elasticsearchContainer.Settings.Address,
    },
    Username: "elastic",
    Password: elasticsearchContainer.Settings.Password,
    CACert:   elasticsearchContainer.Settings.CACert,
}

esClient, err := es.NewClient(cfg)
if err != nil {
    log.Printf("error creating the client: %s", err)
    return
}

resp, err := esClient.Info()
if err != nil {
    log.Printf("error getting response: %s", err)
    return
}
defer resp.Body.Close()