Merge pull request #1456 from github/arthur/use-stretchr-testify

Switch all unit tests to use `stretchr/testify` for assertions.

go.mod

@@ -8,17 +8,21 @@ 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.9.0
 	golang.org/x/net v0.24.0
 	golang.org/x/term v0.19.0
 	golang.org/x/text v0.14.0
 )
 
 require (
 	filippo.io/edwards25519 v1.1.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pingcap/errors v0.11.5-0.20210425183316-da1aaba5fb63 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // 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
 	go.uber.org/atomic v1.7.0 // indirect
 	golang.org/x/sys v0.19.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -20,8 +20,10 @@ github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/jmoiron/sqlx v1.3.3/go.mod h1:2BljVx/86SuTyjE+aPYlHCTNvZrnJXghYGpNiXLBMCQ=
+github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
 github.com/mattn/go-sqlite3 v1.14.6/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU=
@@ -51,8 +53,9 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 go.uber.org/atomic v1.3.2/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
 go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
@@ -99,6 +102,7 @@ golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8T
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

go/base/context_test.go

@@ -11,7 +11,7 @@ import (
 	"time"
 
 	"github.com/openark/golib/log"
-	test "github.com/openark/golib/tests"
+	"github.com/stretchr/testify/require"
 )
 
 func init() {
@@ -22,22 +22,22 @@ func TestGetTableNames(t *testing.T) {
 	{
 		context := NewMigrationContext()
 		context.OriginalTableName = "some_table"
-		test.S(t).ExpectEquals(context.GetOldTableName(), "_some_table_del")
-		test.S(t).ExpectEquals(context.GetGhostTableName(), "_some_table_gho")
-		test.S(t).ExpectEquals(context.GetChangelogTableName(), "_some_table_ghc")
+		require.Equal(t, "_some_table_del", context.GetOldTableName())
+		require.Equal(t, "_some_table_gho", context.GetGhostTableName())
+		require.Equal(t, "_some_table_ghc", context.GetChangelogTableName(), "_some_table_ghc")
 	}
 	{
 		context := NewMigrationContext()
 		context.OriginalTableName = "a123456789012345678901234567890123456789012345678901234567890"
-		test.S(t).ExpectEquals(context.GetOldTableName(), "_a1234567890123456789012345678901234567890123456789012345678_del")
-		test.S(t).ExpectEquals(context.GetGhostTableName(), "_a1234567890123456789012345678901234567890123456789012345678_gho")
-		test.S(t).ExpectEquals(context.GetChangelogTableName(), "_a1234567890123456789012345678901234567890123456789012345678_ghc")
+		require.Equal(t, "_a1234567890123456789012345678901234567890123456789012345678_del", context.GetOldTableName())
+		require.Equal(t, "_a1234567890123456789012345678901234567890123456789012345678_gho", context.GetGhostTableName())
+		require.Equal(t, "_a1234567890123456789012345678901234567890123456789012345678_ghc", context.GetChangelogTableName())
 	}
 	{
 		context := NewMigrationContext()
 		context.OriginalTableName = "a123456789012345678901234567890123456789012345678901234567890123"
 		oldTableName := context.GetOldTableName()
-		test.S(t).ExpectEquals(oldTableName, "_a1234567890123456789012345678901234567890123456789012345678_del")
+		require.Equal(t, "_a1234567890123456789012345678901234567890123456789012345678_del", oldTableName)
 	}
 	{
 		context := NewMigrationContext()
@@ -46,15 +46,15 @@ func TestGetTableNames(t *testing.T) {
 		longForm := "Jan 2, 2006 at 3:04pm (MST)"
 		context.StartTime, _ = time.Parse(longForm, "Feb 3, 2013 at 7:54pm (PST)")
 		oldTableName := context.GetOldTableName()
-		test.S(t).ExpectEquals(oldTableName, "_a1234567890123456789012345678901234567890123_20130203195400_del")
+		require.Equal(t, "_a1234567890123456789012345678901234567890123_20130203195400_del", oldTableName)
 	}
 	{
 		context := NewMigrationContext()
 		context.OriginalTableName = "foo_bar_baz"
 		context.ForceTmpTableName = "tmp"
-		test.S(t).ExpectEquals(context.GetOldTableName(), "_tmp_del")
-		test.S(t).ExpectEquals(context.GetGhostTableName(), "_tmp_gho")
-		test.S(t).ExpectEquals(context.GetChangelogTableName(), "_tmp_ghc")
+		require.Equal(t, "_tmp_del", context.GetOldTableName())
+		require.Equal(t, "_tmp_gho", context.GetGhostTableName())
+		require.Equal(t, "_tmp_ghc", context.GetChangelogTableName())
 	}
 }
 

go/base/load_map_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 
 	"github.com/openark/golib/log"
-	test "github.com/openark/golib/tests"
+	"github.com/stretchr/testify/require"
 )
 
 func init() {
@@ -20,39 +20,39 @@ func TestParseLoadMap(t *testing.T) {
 	{
 		loadList := ""
 		m, err := ParseLoadMap(loadList)
-		test.S(t).ExpectNil(err)
-		test.S(t).ExpectEquals(len(m), 0)
+		require.NoError(t, err)
+		require.Len(t, m, 0)
 	}
 	{
 		loadList := "threads_running=20,threads_connected=10"
 		m, err := ParseLoadMap(loadList)
-		test.S(t).ExpectNil(err)
-		test.S(t).ExpectEquals(len(m), 2)
-		test.S(t).ExpectEquals(m["threads_running"], int64(20))
-		test.S(t).ExpectEquals(m["threads_connected"], int64(10))
+		require.NoError(t, err)
+		require.Len(t, m, 2)
+		require.Equal(t, int64(20), m["threads_running"])
+		require.Equal(t, int64(10), m["threads_connected"])
 	}
 	{
 		loadList := "threads_running=20=30,threads_connected=10"
 		_, err := ParseLoadMap(loadList)
-		test.S(t).ExpectNotNil(err)
+		require.Error(t, err)
 	}
 	{
 		loadList := "threads_running=20,threads_connected"
 		_, err := ParseLoadMap(loadList)
-		test.S(t).ExpectNotNil(err)
+		require.Error(t, err)
 	}
 }
 
 func TestString(t *testing.T) {
 	{
 		m, _ := ParseLoadMap("")
 		s := m.String()
-		test.S(t).ExpectEquals(s, "")
+		require.Equal(t, "", s)
 	}
 	{
 		loadList := "threads_running=20,threads_connected=10"
 		m, _ := ParseLoadMap(loadList)
 		s := m.String()
-		test.S(t).ExpectEquals(s, "threads_connected=10,threads_running=20")
+		require.Equal(t, "threads_connected=10,threads_running=20", s)
 	}
 }

go/base/utils_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 
 	"github.com/openark/golib/log"
-	test "github.com/openark/golib/tests"
+	"github.com/stretchr/testify/require"
 )
 
 func init() {
@@ -19,11 +19,11 @@ func init() {
 func TestStringContainsAll(t *testing.T) {
 	s := `insert,delete,update`
 
-	test.S(t).ExpectFalse(StringContainsAll(s))
-	test.S(t).ExpectFalse(StringContainsAll(s, ""))
-	test.S(t).ExpectFalse(StringContainsAll(s, "drop"))
-	test.S(t).ExpectTrue(StringContainsAll(s, "insert"))
-	test.S(t).ExpectFalse(StringContainsAll(s, "insert", "drop"))
-	test.S(t).ExpectTrue(StringContainsAll(s, "insert", ""))
-	test.S(t).ExpectTrue(StringContainsAll(s, "insert", "update", "delete"))
+	require.False(t, StringContainsAll(s))
+	require.False(t, StringContainsAll(s, ""))
+	require.False(t, StringContainsAll(s, "drop"))
+	require.True(t, StringContainsAll(s, "insert"))
+	require.False(t, StringContainsAll(s, "insert", "drop"))
+	require.True(t, StringContainsAll(s, "insert", ""))
+	require.True(t, StringContainsAll(s, "insert", "update", "delete"))
 }

go/logic/applier_test.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 	"testing"
 
-	test "github.com/openark/golib/tests"
+	"github.com/stretchr/testify/require"
 
 	"github.com/github/gh-ost/go/base"
 	"github.com/github/gh-ost/go/binlog"
@@ -21,33 +21,33 @@ func TestApplierGenerateSqlModeQuery(t *testing.T) {
 	applier := NewApplier(migrationContext)
 
 	{
-		test.S(t).ExpectEquals(
-			applier.generateSqlModeQuery(),
+		require.Equal(t,
 			`sql_mode = CONCAT(@@session.sql_mode, ',NO_AUTO_VALUE_ON_ZERO,STRICT_ALL_TABLES')`,
+			applier.generateSqlModeQuery(),
 		)
 	}
 	{
 		migrationContext.SkipStrictMode = true
 		migrationContext.AllowZeroInDate = false
-		test.S(t).ExpectEquals(
-			applier.generateSqlModeQuery(),
+		require.Equal(t,
 			`sql_mode = CONCAT(@@session.sql_mode, ',NO_AUTO_VALUE_ON_ZERO')`,
+			applier.generateSqlModeQuery(),
 		)
 	}
 	{
 		migrationContext.SkipStrictMode = false
 		migrationContext.AllowZeroInDate = true
-		test.S(t).ExpectEquals(
-			applier.generateSqlModeQuery(),
+		require.Equal(t,
 			`sql_mode = REPLACE(REPLACE(CONCAT(@@session.sql_mode, ',NO_AUTO_VALUE_ON_ZERO,STRICT_ALL_TABLES'), 'NO_ZERO_IN_DATE', ''), 'NO_ZERO_DATE', '')`,
+			applier.generateSqlModeQuery(),
 		)
 	}
 	{
 		migrationContext.SkipStrictMode = true
 		migrationContext.AllowZeroInDate = true
-		test.S(t).ExpectEquals(
-			applier.generateSqlModeQuery(),
+		require.Equal(t,
 			`sql_mode = REPLACE(REPLACE(CONCAT(@@session.sql_mode, ',NO_AUTO_VALUE_ON_ZERO'), 'NO_ZERO_IN_DATE', ''), 'NO_ZERO_DATE', '')`,
+			applier.generateSqlModeQuery(),
 		)
 	}
 }
@@ -72,8 +72,8 @@ func TestApplierUpdateModifiesUniqueKeyColumns(t *testing.T) {
 			NewColumnValues:   columnValues,
 			WhereColumnValues: columnValues,
 		})
-		test.S(t).ExpectEquals(modifiedColumn, "")
-		test.S(t).ExpectFalse(isModified)
+		require.Equal(t, "", modifiedColumn)
+		require.False(t, isModified)
 	})
 
 	t.Run("modified", func(t *testing.T) {
@@ -83,8 +83,8 @@ func TestApplierUpdateModifiesUniqueKeyColumns(t *testing.T) {
 			NewColumnValues:   sql.ToColumnValues([]interface{}{123456, 24}),
 			WhereColumnValues: columnValues,
 		})
-		test.S(t).ExpectEquals(modifiedColumn, "item_id")
-		test.S(t).ExpectTrue(isModified)
+		require.Equal(t, "item_id", modifiedColumn)
+		require.True(t, isModified)
 	})
 }
 
@@ -112,17 +112,17 @@ func TestApplierBuildDMLEventQuery(t *testing.T) {
 		}
 
 		res := applier.buildDMLEventQuery(binlogEvent)
-		test.S(t).ExpectEquals(len(res), 1)
-		test.S(t).ExpectNil(res[0].err)
-		test.S(t).ExpectEquals(strings.TrimSpace(res[0].query), `delete /* gh-ost `+"`test`.`_test_gho`"+` */
+		require.Len(t, res, 1)
+		require.NoError(t, res[0].err)
+		require.Equal(t, `delete /* gh-ost `+"`test`.`_test_gho`"+` */
 		from
 			`+"`test`.`_test_gho`"+`
 		where
 			((`+"`id`"+` = ?) and (`+"`item_id`"+` = ?))`,
-		)
-		test.S(t).ExpectEquals(len(res[0].args), 2)
-		test.S(t).ExpectEquals(res[0].args[0], 123456)
-		test.S(t).ExpectEquals(res[0].args[1], 42)
+			strings.TrimSpace(res[0].query))
+		require.Len(t, res[0].args, 2)
+		require.Equal(t, 123456, res[0].args[0])
+		require.Equal(t, 42, res[0].args[1])
 	})
 
 	t.Run("insert", func(t *testing.T) {
@@ -132,18 +132,19 @@ func TestApplierBuildDMLEventQuery(t *testing.T) {
 			NewColumnValues: columnValues,
 		}
 		res := applier.buildDMLEventQuery(binlogEvent)
-		test.S(t).ExpectEquals(len(res), 1)
-		test.S(t).ExpectNil(res[0].err)
-		test.S(t).ExpectEquals(strings.TrimSpace(res[0].query),
+		require.Len(t, res, 1)
+		require.NoError(t, res[0].err)
+		require.Equal(t,
 			`replace /* gh-ost `+"`test`.`_test_gho`"+` */
 		into
 			`+"`test`.`_test_gho`"+`
 			`+"(`id`, `item_id`)"+`
 		values
-			(?, ?)`)
-		test.S(t).ExpectEquals(len(res[0].args), 2)
-		test.S(t).ExpectEquals(res[0].args[0], 123456)
-		test.S(t).ExpectEquals(res[0].args[1], 42)
+			(?, ?)`,
+			strings.TrimSpace(res[0].query))
+		require.Len(t, res[0].args, 2)
+		require.Equal(t, 123456, res[0].args[0])
+		require.Equal(t, 42, res[0].args[1])
 	})
 
 	t.Run("update", func(t *testing.T) {
@@ -154,20 +155,21 @@ func TestApplierBuildDMLEventQuery(t *testing.T) {
 			WhereColumnValues: columnValues,
 		}
 		res := applier.buildDMLEventQuery(binlogEvent)
-		test.S(t).ExpectEquals(len(res), 1)
-		test.S(t).ExpectNil(res[0].err)
-		test.S(t).ExpectEquals(strings.TrimSpace(res[0].query),
+		require.Len(t, res, 1)
+		require.NoError(t, res[0].err)
+		require.Equal(t,
 			`update /* gh-ost `+"`test`.`_test_gho`"+` */
 			`+"`test`.`_test_gho`"+`
 		set
 			`+"`id`"+`=?, `+"`item_id`"+`=?
 		where
-			((`+"`id`"+` = ?) and (`+"`item_id`"+` = ?))`)
-		test.S(t).ExpectEquals(len(res[0].args), 4)
-		test.S(t).ExpectEquals(res[0].args[0], 123456)
-		test.S(t).ExpectEquals(res[0].args[1], 42)
-		test.S(t).ExpectEquals(res[0].args[2], 123456)
-		test.S(t).ExpectEquals(res[0].args[3], 42)
+			((`+"`id`"+` = ?) and (`+"`item_id`"+` = ?))`,
+			strings.TrimSpace(res[0].query))
+		require.Len(t, res[0].args, 4)
+		require.Equal(t, 123456, res[0].args[0])
+		require.Equal(t, 42, res[0].args[1])
+		require.Equal(t, 123456, res[0].args[2])
+		require.Equal(t, 42, res[0].args[3])
 	})
 }
 
@@ -180,6 +182,6 @@ func TestApplierInstantDDL(t *testing.T) {
 
 	t.Run("instantDDLstmt", func(t *testing.T) {
 		stmt := applier.generateInstantDDLQuery()
-		test.S(t).ExpectEquals(stmt, "ALTER /* gh-ost */ TABLE `test`.`mytable` ADD INDEX (foo), ALGORITHM=INSTANT")
+		require.Equal(t, "ALTER /* gh-ost */ TABLE `test`.`mytable` ADD INDEX (foo), ALGORITHM=INSTANT", stmt)
 	})
 }