Use testcontainers.

Author: arthurschreiber

.github/workflows/ci.yml

@@ -1,35 +1,23 @@
-
 name: CI
+
 on: [pull_request]
+
 jobs:
   build:
+
     runs-on: ubuntu-latest
+
     steps:
-    - name: Setup MySQL
-      run: >-
-        docker run --rm -d
-        --name mysql
-        -p 3306:3306
-        --health-cmd="mysqladmin ping"
-        --health-interval=10s
-        --health-timeout=5s
-        --health-retries=3
-        mysql:8.0.39
-        -e MYSQL_ROOT_PASSWORD=root
-        -e MYSQL_DATABASE=test
-        --log-bin=mysql-bin
-        --binlog-format=row
-        --gtid-mode=ON
-        --enforce-gtid-consistency=ON
-        --transaction-write-set-extraction=XXHASH64
-        --binlog-transaction-dependency-tracking=WRITESET
     - uses: actions/checkout@v4
+
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
         go-version-file: go.mod
+
     - name: Build
       run: script/cibuild
+
     - name: Upload gh-ost binary artifact
       uses: actions/upload-artifact@v4
       with:

go.mod

@@ -8,21 +8,64 @@ require (
 	github.com/go-sql-driver/mysql v1.8.1
 	github.com/google/uuid v1.6.0
 	github.com/openark/golib v0.0.0-20210531070646-355f37940af8
-	github.com/stretchr/testify v1.8.0
+	github.com/stretchr/testify v1.9.0
+	github.com/testcontainers/testcontainers-go v0.34.0
 	golang.org/x/net v0.24.0
 	golang.org/x/term v0.19.0
 	golang.org/x/text v0.14.0
 )
 
 require (
+	dario.cat/mergo v1.0.0 // indirect
 	filippo.io/edwards25519 v1.1.0 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/Microsoft/go-winio v0.6.2 // indirect
+	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/containerd/containerd v1.7.18 // indirect
+	github.com/containerd/log v0.1.0 // indirect
+	github.com/containerd/platforms v0.2.1 // indirect
+	github.com/cpuguy83/dockercfg v0.3.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/distribution/reference v0.6.0 // indirect
+	github.com/docker/docker v27.1.1+incompatible // indirect
+	github.com/docker/go-connections v0.5.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/klauspost/compress v1.17.4 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/moby/docker-image-spec v1.3.1 // indirect
+	github.com/moby/patternmatcher v0.6.0 // indirect
+	github.com/moby/sys/sequential v0.5.0 // indirect
+	github.com/moby/sys/user v0.1.0 // indirect
+	github.com/moby/term v0.5.0 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.1.0 // indirect
 	github.com/pingcap/errors v0.11.5-0.20210425183316-da1aaba5fb63 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
+	github.com/shirou/gopsutil/v3 v3.23.12 // indirect
+	github.com/shoenig/go-m1cpu v0.1.6 // indirect
 	github.com/shopspring/decimal v0.0.0-20180709203117-cd690d0c9e24 // indirect
 	github.com/siddontang/go v0.0.0-20180604090527-bdc77568d726 // indirect
 	github.com/siddontang/go-log v0.0.0-20180807004314-8d05993dda07 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/tklauser/go-sysconf v0.3.12 // indirect
+	github.com/tklauser/numcpus v0.6.1 // indirect
+	github.com/yusufpapurcu/wmi v1.2.3 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
+	go.opentelemetry.io/otel v1.24.0 // indirect
+	go.opentelemetry.io/otel/metric v1.24.0 // indirect
+	go.opentelemetry.io/otel/trace v1.24.0 // indirect
 	go.uber.org/atomic v1.7.0 // indirect
-	golang.org/x/sys v0.19.0 // indirect
+	golang.org/x/crypto v0.22.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,13 +1,16 @@
 package binlog
 
 import (
+	"context"
 	"database/sql"
 	"testing"
 
 	"github.com/github/gh-ost/go/base"
 	"github.com/github/gh-ost/go/mysql"
 	"github.com/stretchr/testify/require"
-	"golang.org/x/net/context"
+	"github.com/stretchr/testify/suite"
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/wait"
 )
 
 func getCurrentBinlogCoordinates(t *testing.T, db *sql.DB) mysql.BinlogCoordinates {
@@ -24,11 +27,11 @@ func getCurrentBinlogCoordinates(t *testing.T, db *sql.DB) mysql.BinlogCoordinat
 	return mysql.BinlogCoordinates{LogFile: file, LogPos: position}
 }
 
-func getMigrationContext() *base.MigrationContext {
+func getMigrationContext(host string) *base.MigrationContext {
 	migrationContext := base.NewMigrationContext()
 	migrationContext.InspectorConnectionConfig = &mysql.ConnectionConfig{
 		Key: mysql.InstanceKey{
-			Hostname: "localhost",
+			Hostname: host,
 			Port:     3306,
 		},
 		User:     "root",
@@ -40,29 +43,73 @@ func getMigrationContext() *base.MigrationContext {
 }
 
 func prepareDatabase(t *testing.T, db *sql.DB) {
-	_, err := db.Exec("DROP DATABASE test")
+	_, err := db.Exec("CREATE TABLE test.gh_ost_test (id int NOT NULL AUTO_INCREMENT, name varchar(255), PRIMARY KEY (id)) ENGINE=InnoDB")
 	require.NoError(t, err)
 
-	_, err = db.Exec("CREATE DATABASE test")
+	_, err = db.Exec("CREATE TABLE test.gh_ost_test2 (id int NOT NULL AUTO_INCREMENT, name varchar(255), PRIMARY KEY (id)) ENGINE=InnoDB")
 	require.NoError(t, err)
+}
 
-	_, err = db.Exec("CREATE TABLE test.gh_ost_test (id int NOT NULL AUTO_INCREMENT, name varchar(255), PRIMARY KEY (id)) ENGINE=InnoDB")
-	require.NoError(t, err)
+type GoMySQLReaderTestSuite struct {
+	suite.Suite
 
-	_, err = db.Exec("CREATE TABLE test.gh_ost_test2 (id int NOT NULL AUTO_INCREMENT, name varchar(255), PRIMARY KEY (id)) ENGINE=InnoDB")
-	require.NoError(t, err)
+	mysqlContainer testcontainers.Container
+}
+
+func (suite *GoMySQLReaderTestSuite) SetupSuite() {
+	ctx := context.Background()
+
+	req := testcontainers.ContainerRequest{
+		Image:      "mysql:8.0",
+		Env:        map[string]string{"MYSQL_ROOT_PASSWORD": "root"},
+		WaitingFor: wait.ForLog("port: 3306  MySQL Community Server - GPL"),
+	}
+
+	mysqlContainer, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
+		ContainerRequest: req,
+		Started:          true,
+	})
+	suite.Require().NoError(err)
+	suite.mysqlContainer = mysqlContainer
+}
+
+func (suite *GoMySQLReaderTestSuite) TearDownSuite() {
+	ctx := context.Background()
+	suite.Require().NoError(suite.mysqlContainer.Terminate(ctx))
+}
+
+func (suite *GoMySQLReaderTestSuite) SetupTest() {
+	ctx := context.Background()
+
+	rc, _, err := suite.mysqlContainer.Exec(ctx, []string{"mysql", "-proot", "-e", "CREATE DATABASE test"})
+	suite.Require().NoError(err)
+	suite.Require().Equal(0, rc, "expected exit code 0")
+}
+
+func (suite *GoMySQLReaderTestSuite) TearDownTest() {
+	ctx := context.Background()
+
+	rc, _, err := suite.mysqlContainer.Exec(ctx, []string{"mysql", "-proot", "-e", "DROP DATABASE test"})
+	suite.Require().NoError(err)
+	suite.Require().Equal(0, rc, "expected exit code 0")
 }
 
-func TestStreamTransactionSingleAutoCommitChange(t *testing.T) {
-	db, err := sql.Open("mysql", "root:root@/")
+func (suite *GoMySQLReaderTestSuite) TestStreamTransactionSingleAutoCommitChange() {
+	t := suite.T()
+
+	ctx := context.Background()
+	host, err := suite.mysqlContainer.ContainerIP(ctx)
+	require.NoError(t, err)
+
+	db, err := sql.Open("mysql", "root:root@tcp("+host+")/")
 	require.NoError(t, err)
 	defer db.Close()
 
 	prepareDatabase(t, db)
 
 	binlogCoordinates := getCurrentBinlogCoordinates(t, db)
 
-	migrationContext := getMigrationContext()
+	migrationContext := getMigrationContext(host)
 	migrationContext.DatabaseName = "test"
 	migrationContext.OriginalTableName = "gh_ost_test"
 	migrationContext.AlterStatement = "ALTER TABLE gh_ost_test ENGINE=InnoDB"
@@ -96,16 +143,22 @@ func TestStreamTransactionSingleAutoCommitChange(t *testing.T) {
 	require.Len(t, transactionsChan, 0)
 }
 
-func TestStreamTransactionSingleChangeInTransaction(t *testing.T) {
-	db, err := sql.Open("mysql", "root:root@/")
+func (suite *GoMySQLReaderTestSuite) TestStreamTransactionSingleChangeInTransaction() {
+	t := suite.T()
+
+	ctx := context.Background()
+	host, err := suite.mysqlContainer.ContainerIP(ctx)
+	require.NoError(t, err)
+
+	db, err := sql.Open("mysql", "root:root@tcp("+host+")/")
 	require.NoError(t, err)
 	defer db.Close()
 
 	prepareDatabase(t, db)
 
 	binlogCoordinates := getCurrentBinlogCoordinates(t, db)
 
-	migrationContext := getMigrationContext()
+	migrationContext := getMigrationContext(host)
 	migrationContext.DatabaseName = "test"
 	migrationContext.OriginalTableName = "gh_ost_test"
 	migrationContext.AlterStatement = "ALTER TABLE gh_ost_test ENGINE=InnoDB"
@@ -145,16 +198,22 @@ func TestStreamTransactionSingleChangeInTransaction(t *testing.T) {
 	require.Len(t, transactionsChan, 0)
 }
 
-func TestStreamTransactionMultipleChangesInTransaction(t *testing.T) {
-	db, err := sql.Open("mysql", "root:root@/")
+func (suite *GoMySQLReaderTestSuite) TestStreamTransactionMultipleChangesInTransaction() {
+	t := suite.T()
+
+	ctx := context.Background()
+	host, err := suite.mysqlContainer.ContainerIP(ctx)
+	require.NoError(t, err)
+
+	db, err := sql.Open("mysql", "root:root@tcp("+host+")/")
 	require.NoError(t, err)
 	defer db.Close()
 
 	prepareDatabase(t, db)
 
 	binlogCoordinates := getCurrentBinlogCoordinates(t, db)
 
-	migrationContext := getMigrationContext()
+	migrationContext := getMigrationContext(host)
 	migrationContext.DatabaseName = "test"
 	migrationContext.OriginalTableName = "gh_ost_test"
 	migrationContext.AlterStatement = "ALTER TABLE gh_ost_test ENGINE=InnoDB"
@@ -200,16 +259,22 @@ func TestStreamTransactionMultipleChangesInTransaction(t *testing.T) {
 	require.Len(t, transactionsChan, 0)
 }
 
-func TestStreamTransactionWithDDL(t *testing.T) {
-	db, err := sql.Open("mysql", "root:root@/")
+func (suite *GoMySQLReaderTestSuite) TestStreamTransactionWithDDL() {
+	t := suite.T()
+
+	ctx := context.Background()
+	host, err := suite.mysqlContainer.ContainerIP(ctx)
+	require.NoError(t, err)
+
+	db, err := sql.Open("mysql", "root:root@tcp("+host+")/")
 	require.NoError(t, err)
 	defer db.Close()
 
 	prepareDatabase(t, db)
 
 	binlogCoordinates := getCurrentBinlogCoordinates(t, db)
 
-	migrationContext := getMigrationContext()
+	migrationContext := getMigrationContext(host)
 	migrationContext.DatabaseName = "test"
 	migrationContext.OriginalTableName = "gh_ost_test"
 	migrationContext.AlterStatement = "ALTER TABLE gh_ost_test ENGINE=InnoDB"
@@ -242,3 +307,7 @@ func TestStreamTransactionWithDDL(t *testing.T) {
 	close(transactionsChan)
 	require.Len(t, transactionsChan, 0)
 }
+
+func TestGoMySQLReader(t *testing.T) {
+	suite.Run(t, new(GoMySQLReaderTestSuite))
+}

go/binlog/gomysql_reader_test.go

@@ -13,10 +13,32 @@ import (
 	"github.com/github/gh-ost/go/mysql"
 	"github.com/github/gh-ost/go/sql"
 	"github.com/stretchr/testify/require"
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/wait"
 )
 
 func TestCoordinator(t *testing.T) {
-	db, err := gosql.Open("mysql", "root:root@/")
+	ctx := context.Background()
+	req := testcontainers.ContainerRequest{
+		Image:      "mysql:8.0",
+		Env:        map[string]string{"MYSQL_ROOT_PASSWORD": "root"},
+		WaitingFor: wait.ForLog("port: 3306  MySQL Community Server - GPL"),
+	}
+
+	mysqlContainer, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
+		ContainerRequest: req,
+		Started:          true,
+	})
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		ctx := context.Background()
+		require.NoError(t, mysqlContainer.Terminate(ctx))
+	})
+
+	host, err := mysqlContainer.ContainerIP(ctx)
+	require.NoError(t, err)
+
+	db, err := gosql.Open("mysql", "root:root@tcp("+host+")/")
 	require.NoError(t, err)
 
 	t.Cleanup(func() {
@@ -31,7 +53,6 @@ func TestCoordinator(t *testing.T) {
 	require.NoError(t, err)
 
 	migrationContext := base.NewMigrationContext()
-	migrationContext.Hostname = "localhost"
 	migrationContext.DatabaseName = "test"
 	migrationContext.OriginalTableName = "gh_ost_test"
 	migrationContext.AlterStatement = "ALTER TABLE gh_ost_test ENGINE=InnoDB"
@@ -44,7 +65,7 @@ func TestCoordinator(t *testing.T) {
 
 	migrationContext.ApplierConnectionConfig = &mysql.ConnectionConfig{
 		Key: mysql.InstanceKey{
-			Hostname: "localhost",
+			Hostname: host,
 			Port:     3306,
 		},
 		User:     "root",
@@ -53,7 +74,7 @@ func TestCoordinator(t *testing.T) {
 
 	migrationContext.InspectorConnectionConfig = &mysql.ConnectionConfig{
 		Key: mysql.InstanceKey{
-			Hostname: "localhost",
+			Hostname: host,
 			Port:     3306,
 		},
 		User:     "root",