CouchDB¶

Not available until the next release main

Introduction¶

The Testcontainers module for Apache CouchDB, a document-oriented NoSQL database that uses JSON to store data, JavaScript as its query language using MapReduce, and HTTP for an API.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a CouchDB container

ctx := context.Background()

couchdbContainer, err := couchdb.Run(ctx, "couchdb:3",
    couchdb.WithAdminCredentials("admin", "password"),
)
defer func() {
    if err := testcontainers.TerminateContainer(couchdbContainer); 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¶

Not available until the next release main

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, 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(), "couchdb:3").

Container Options¶

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

WithAdminCredentials¶

Not available until the next release main

Sets the admin username and password for the CouchDB container. These credentials are used to authenticate against the CouchDB HTTP API and are reflected in the connection string returned by ConnectionString.

The default credentials are admin / password.

E.g. couchdb.WithAdminCredentials("myuser", "mypassword").

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 · Chainable since main
WithHostConfigModifier Since v0.20.0 · Chainable since main
WithEndpointSettingsModifier Since v0.20.0 · Chainable since main
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

Container Methods¶

The CouchDB container exposes the following methods:

ConnectionString¶

Not available until the next release main

The ConnectionString method returns the connection string to connect to the CouchDB container. It returns a string with the format http://user:password@host:5984.

E.g. http://admin:password@localhost:32768.

It can be used to configure a CouchDB HTTP client:

Using ConnectionString

ctx := context.Background()

couchdbContainer, err := couchdb.Run(ctx, "couchdb:3",
    couchdb.WithAdminCredentials("admin", "password"),
)
defer func() {
    if err := testcontainers.TerminateContainer(couchdbContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}