MongoDB¶

Introduction¶

The Testcontainers module for MongoDB.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a MongoDB container

ctx := context.Background()

mongodbContainer, err := mongodb.Run(ctx, "mongo:6")
defer func() {
    if err := testcontainers.TerminateContainer(mongodbContainer); 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 MongoDB module exposes one entrypoint function to create the MongoDB container, and this function receives three parameters:

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

Container Options¶

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

WithUsername¶

Since v0.27.0

This functional option sets the initial username to be created when the container starts. It is used in conjunction with WithPassword to set a username and its password, creating the specified user with superuser power.

E.g. testcontainers.WithUsername("mymongouser").

WithPassword¶

Since v0.27.0

This functional option sets the initial password to be created when the container starts. It is used in conjunction with WithUsername to set a username and its password, setting the password for the superuser power.

E.g. testcontainers.WithPassword("mymongopwd").

WithReplicaSet¶

Since v0.31.0

The WithReplicaSet functional option configures the container to run a single-node MongoDB replica set named rs. The MongoDB container will wait until the replica set is ready.

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 Not available until the next release main
WithWaitStrategyAndDeadline Since v0.20.0
WithAdditionalWaitStrategyAndDeadline Not available until the next release main
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 Not available until the next release main
WithAdditionalLifecycleHooks Not available until the next release main
WithStartupCommand Since v0.25.0
WithAfterReadyCommand Since v0.28.0

Files & Mounts Options¶

Build Options¶

WithDockerfile Since v0.37.0

Logging Options¶

WithLogConsumers Since v0.28.0
WithLogConsumerConfig Not available until the next release main
WithLogger Since v0.29.0

Image Options¶

WithAlwaysPull Not available until the next release main
WithImageSubstitutors Since v0.26.0
WithImagePlatform Not available until the next release main

Networking Options¶

WithNetwork Since v0.27.0
WithNetworkByName Not available until the next release main
WithBridgeNetwork Not available until the next release main
WithNewNetwork Since v0.27.0

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 Not available until the next release main
WithNoStart Not available until the next release main

Experimental Options¶

WithReuseByName Since v0.37.0

Container Methods¶

The MongoDB container exposes the following methods:

ConnectionString¶

Since v0.23.0

The ConnectionString method returns the connection string to connect to the MongoDB container. It returns a string with the format mongodb://<host>:<port>.

It can be used to configure a MongoDB client (go.mongodb.org/mongo-driver/mongo), e.g.:

Using ConnectionString with the MongoDB client

ctx := context.Background()

mongodbContainer, err := mongodb.Run(ctx, "mongo:6")
defer func() {
    if err := testcontainers.TerminateContainer(mongodbContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

endpoint, err := mongodbContainer.ConnectionString(ctx)
if err != nil {
    log.Printf("failed to get connection string: %s", err)
    return
}

mongoClient, err := mongo.Connect(ctx, options.Client().ApplyURI(endpoint))
if err != nil {
    log.Printf("failed to connect to MongoDB: %s", err)
    return
}