MongoDB

Since testcontainers-go v0.23.0

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.RunContainer(ctx, testcontainers.WithImage("mongo:6"))
if err != nil {
    panic(err)
}

// Clean up the container
defer func() {
    if err := mongodbContainer.Terminate(ctx); err != nil {
        panic(err)
    }
}()

Module reference

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

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*MongoDBContainer, error)

• context.Context, the Go context.
• testcontainers.ContainerCustomizer, a variadic argument for passing options.

Container Options

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

Image

If you need to set a different MongoDB Docker image, you can use testcontainers.WithImage with a valid Docker image for MongoDB. E.g. testcontainers.WithImage("mongo:6").

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

• Not available until the next release of testcontainers-go main

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 one single method: AsCommand(), which returns a slice of strings 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 started.

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.

Container Methods

The MongoDB container exposes the following methods:

ConnectionString

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 use 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.RunContainer(ctx, testcontainers.WithImage("mongo:6"))
if err != nil {
    panic(err)
}

// Clean up the container
defer func() {
    if err := mongodbContainer.Terminate(ctx); err != nil {
        panic(err)
    }
}()

endpoint, err := mongodbContainer.ConnectionString(ctx)
if err != nil {
    panic(err)
}

mongoClient, err := mongo.Connect(ctx, options.Client().ApplyURI(endpoint))
if err != nil {
    panic(err)
}