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.

Image¶

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

Custom Image

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

By default, the container will use the following Docker image:

Default Docker image

const defaultImage = "mysql:8"

Wait Strategies¶

If you need to set a different wait strategy for MySQL, you can use testcontainers.WithWaitStrategy with a valid wait strategy for MySQL.

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.

Docker type modifiers¶

If you need an advanced configuration for MySQL, 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.

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)
}

Info

The default values for the username is root, for password is test and for the default database name is test.

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)
}

Container Methods¶

ConnectionString¶

This method returns the connection string to connect to the MySQL container, using the default 3306 port. It's possible to pass extra parameters to the connection string, e.g. sslmode=disable or application_name=myapp, in a variadic way.

Get connection string

connectionString, err := container.ConnectionString(ctx, "tls=skip-verify")
if err != nil {
    t.Fatal(err)
}