Skip to content

OpenSearch

Since v0.29.0

Introduction

The Testcontainers module for OpenSearch.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

opensearchContainer, err := opensearch.Run(
    ctx,
    "opensearchproject/opensearch:2.11.1",
    opensearch.WithUsername("new-username"),
    opensearch.WithPassword("new-password"),
)
defer func() {
    if err := testcontainers.TerminateContainer(opensearchContainer); 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 OpenSearch module exposes one entrypoint function to create the OpenSearch container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*OpenSearchContainer, 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(), "opensearchproject/opensearch:2.11.1").

Container Options

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

User and password

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

ctx := context.Background()

opensearchContainer, err := opensearch.Run(
    ctx,
    "opensearchproject/opensearch:2.11.1",
    opensearch.WithUsername("new-username"),
    opensearch.WithPassword("new-password"),
)
defer func() {
    if err := testcontainers.TerminateContainer(opensearchContainer); 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

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

The OpenSearch container exposes the following methods:

Address

The Address method returns the location where the OpenSearch container is listening. It returns a string with the format http://<host>:<port>.

Warning

TLS is not supported at the moment.

package opensearch_test

import (
    "context"
    "net/http"
    "testing"

    "github.com/stretchr/testify/require"

    "github.com/testcontainers/testcontainers-go"
    "github.com/testcontainers/testcontainers-go/modules/opensearch"
)

func TestOpenSearch(t *testing.T) {
    ctx := context.Background()

    ctr, err := opensearch.Run(ctx, "opensearchproject/opensearch:2.11.1")
    testcontainers.CleanupContainer(t, ctr)
    require.NoError(t, err)

    t.Run("Connect to Address", func(t *testing.T) {
        address, err := ctr.Address(ctx)
        require.NoError(t, err)

        client := &http.Client{}

        req, err := http.NewRequest(http.MethodGet, address, nil)
        require.NoError(t, err)

        resp, err := client.Do(req)
        require.NoError(t, err)
        defer resp.Body.Close()
    })
}