Meilisearch¶

Introduction¶

The Testcontainers module for Meilisearch.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a Meilisearch container

ctx := context.Background()

meiliContainer, err := meilisearch.Run(
    ctx,
    "getmeili/meilisearch:v1.10.3",
    meilisearch.WithMasterKey("my-master-key"),
    meilisearch.WithDumpImport("testdata/movies.dump"),
)
defer func() {
    if err := testcontainers.TerminateContainer(meiliContainer); 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.34.0

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*MeilisearchContainer, 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(), "getmeili/meilisearch:v1.10.3").

Container Options¶

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

Master Key¶

Since v0.34.0

If you need to set a master key, you can use the WithMasterKey(key string) option. Otherwise, the default will be used which is just-a-master-key-for-test, which is exported on the container fields.

Dump Data¶

Since v0.34.0

If you need to dump data in Meilisearch upon initialization for testing, you can use WithDumpData(filepath string) option where filepath can be an absolute path or relative path to a dump file. Please refer to the official Meilisearch documentation about dump files here.

The following options are exposed by the testcontainers package.