MySQL¶

Since testcontainers-go v0.20.0

Introduction¶

The Testcontainers module for MySQL.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a MySQL container

container, err := RunContainer(ctx)
if err != nil {
    t.Fatal(err)
}

Module Reference¶

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

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

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

Container Options¶

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

Tip

You can find all the available configuration and environment variables for the MySQL Docker image on Docker Hub.

Set Image¶

By default, the image used is mysql:8. If you need to use a different image, you can use testcontainers.WithImage option.

Custom Image

container, err := RunContainer(ctx, testcontainers.WithImage("mysql:5.6"),
    WithConfigFile("./testdata/my.cnf"))
if err != nil {
    t.Fatal(err)
}

Set username, password and database name¶

If you need to set a different database, and its credentials, you can use WithUsername, WithPassword, WithDatabase options. By default, the username, the password and the database name is test.

Custom Database initialization

container, err := RunContainer(ctx,
    WithDatabase("foo"),
    WithUsername("root"),
    WithPassword(""))
if err != nil {
    t.Fatal(err)
}

Init Scripts¶

If you would like to perform DDL or DML operations in the MySQL container, add one or more *.sql, *.sql.gz, or *.sh scripts to the container request. Those files will be copied under /docker-entrypoint-initdb.d.

Include init scripts

container, err := RunContainer(ctx,
    WithScripts(filepath.Join("testdata", "schema.sql")))
if err != nil {
    t.Fatal(err)
}

Custom configuration¶

If you need to set a custom configuration, you can use WithConfigFile option.

Custom MySQL config file

container, err := RunContainer(ctx, testcontainers.WithImage("mysql:5.6"),
    WithConfigFile("./testdata/my.cnf"))
if err != nil {
    t.Fatal(err)
}