[chore] changes for lint

Makefile

@@ -5,6 +5,8 @@ all:
 	go generate
 	go test
 	golangci-lint run
+	@ echo any output from the following command indicates an out-of-date direct dependency
+	go list -u -m -f '{{if (and (not .Indirect) .Update)}}{{.}}{{end}}' all
 
 coverageO:
 	go install github.com/eltorocorp/drygopher/drygopher@latest
@@ -28,3 +30,8 @@ golanglint:
 	# binary will be $(go env GOPATH)/bin/golangci-lint
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $$(go env GOPATH)/bin v1.45.2
 	golangci-lint --version
+
+misspell:;
+	go install github.com/client9/misspell/cmd/misspell@latest
+	misspell -w `find . -name \*.md`
+

apply.go

@@ -53,7 +53,7 @@
 				var err error
 				d.db, err = OpenAnyDB(s.options.Overrides.MigrateDSN)
 				if err != nil {
-					return errors.Wrap(err, "Could not open database")
+					return errors.Wrap(err, "could not open database")
 				}
 			}
 			err = d.prepare(ctx)
@@ -67,7 +67,7 @@
 				}
 			}()
 			if s.options.Overrides.ErrorIfMigrateNeeded && !d.done(s) {
-				return errors.Errorf("Migrations required for %s", d.DBName)
+				return errors.Errorf("migrations required for %s", d.DBName)
 			}
 			return d.migrate(ctx, s)
 		}(d)
@@ -85,7 +85,7 @@
 		for _, ref := range migration.Base().rawAfter {
 			after, ok := d.migrationIndex[ref]
 			if !ok {
-				return errors.Errorf("Migration %s for %s is supposed to be after %s for %s but that cannot be found",
+				return errors.Errorf("migration %s for %s is supposed to be after %s for %s but that cannot be found",
 					migration.Base().Name.Name, migration.Base().Name.Library, ref.Name, ref.Library)
 			}
 			nodes[after.Base().order].Blocking = append(nodes[after.Base().order].Blocking, migration.Base().order)
@@ -229,7 +229,7 @@
 	if m.Base().skipIf != nil {
 		skip, err := m.Base().skipIf()
 		if err != nil {
-			return false, errors.Wrapf(err, "SkipIf %s", m.Base().Name)
+			return false, errors.Wrapf(err, "skipIf %s", m.Base().Name)
 		}
 		if skip {
 			d.log.Debug(" skipping migration")
@@ -240,7 +240,7 @@
 	if m.Base().skipRemainingIf != nil {
 		skip, err := m.Base().skipRemainingIf()
 		if err != nil {
-			return false, errors.Wrapf(err, "SkipRemainingIf %s", m.Base().Name)
+			return false, errors.Wrapf(err, "skipRemainingIf %s", m.Base().Name)
 		}
 		if skip {
 			d.log.Debug(" skipping remaining migrations")
@@ -294,7 +294,7 @@
 // allDone reports status
 func (d *Database) allDone(m Migration, err error) {
 	if err != nil && m != nil {
-		err = errors.Wrapf(err, "Migration %s", m.Base().Name)
+		err = errors.Wrapf(err, "migration %s", m.Base().Name)
 	}
 	if d.Options.OnMigrationsComplete != nil {
 		d.Options.OnMigrationsComplete(d, err)

driver.go

@@ -22,7 +22,7 @@ func OpenAnyDB(dsn string) (*sql.DB, error) {
 				return sql.Open(driver, dsn)
 			}
 		}
-		return nil, fmt.Errorf("Could not find database driver matching %s", wanted)
+		return nil, fmt.Errorf("could not find database driver matching %s", wanted)
 	}
-	return nil, fmt.Errorf("Could not find appropriate database driver for DSN")
+	return nil, fmt.Errorf("could not find appropriate database driver for DSN")
 }

driver_test.go

@@ -13,8 +13,8 @@ import (
 func TestOpenAnyDB(t *testing.T) {
 	_, err := libschema.OpenAnyDB("http://foo/bar")
 	require.Error(t, err)
-	assert.Contains(t, err.Error(), "Could not find database driver matching http")
+	assert.Contains(t, err.Error(), "could not find database driver matching http")
 	_, err = libschema.OpenAnyDB("postgres")
 	require.Error(t, err)
-	assert.Contains(t, err.Error(), "Could not find appropriate database driver for DSN")
+	assert.Contains(t, err.Error(), "could not find appropriate database driver for DSN")
 }

lsmysql/bad_test.go

@@ -32,7 +32,7 @@ func TestBadMigrationsMysql(t *testing.T) {
 		},
 		{
 			name:  "wrong db",
-			error: `Non-mysql`,
+			error: `non-mysql`,
 			define: func(dbase *libschema.Database) {
 				dbase.Migrations("L2",
 					lspostgres.Script("T4", `INSERT INTO T1 (id) VALUES ('T4')`),
@@ -49,28 +49,28 @@ func TestBadMigrationsMysql(t *testing.T) {
 		},
 		{
 			name:  "bad table1",
-			error: `Tracking table 'foo.bar.baz' is not valid`,
+			error: `tracking table 'foo.bar.baz' is not valid`,
 			reopt: func(o *libschema.Options) {
 				o.TrackingTable = "foo.bar.baz"
 			},
 		},
 		{
 			name:  "bad table2",
-			error: `Tracking table schema name must be a simple identifier, not 'foo'bar'`,
+			error: `tracking table schema name must be a simple identifier, not 'foo'bar'`,
 			reopt: func(o *libschema.Options) {
 				o.TrackingTable = "foo'bar.baz"
 			},
 		},
 		{
 			name:  "non idempotent",
-			error: `Unconditional migration has non-idempotent DDL (Data Definition Language [schema changes]`,
+			error: `unconditional migration has non-idempotent DDL (Data Definition Language [schema changes]`,
 			define: func(dbase *libschema.Database) {
 				dbase.Migrations("L2", lsmysql.Script("T4", `CREATE TABLE T1 (id text) TYPE = InnoDB`))
 			},
 		},
 		{
 			name:  "combines data & ddl",
-			error: `Migration combines DDL (Data Definition Language [schema changes]) and data manipulation`,
+			error: `migration combines DDL (Data Definition Language [schema changes]) and data manipulation`,
 			define: func(dbase *libschema.Database) {
 				dbase.Migrations("L2", lsmysql.Script("T4", `
 					CREATE TABLE IF NOT EXISTST1 (id text) TYPE = InnoDB;
@@ -80,21 +80,21 @@ func TestBadMigrationsMysql(t *testing.T) {
 		},
 		{
 			name:  "bad table3",
-			error: `Tracking table table name must be a simple identifier, not 'bar'baz'`,
+			error: `tracking table table name must be a simple identifier, not 'bar'baz'`,
 			reopt: func(o *libschema.Options) {
 				o.TrackingTable = "foo.bar'baz"
 			},
 		},
 		{
 			name:  "bad table4",
-			error: `Tracking table table name must be a simple identifier, not 'bar'baz'`,
+			error: `tracking table table name must be a simple identifier, not 'bar'baz'`,
 			reopt: func(o *libschema.Options) {
 				o.TrackingTable = "bar'baz"
 			},
 		},
 		{
 			name:  "bad schema",
-			error: `Options.SchemaOverride must be a simple identifier`,
+			error: `options.SchemaOverride must be a simple identifier`,
 			reopt: func(o *libschema.Options) {
 				o.SchemaOverride = `"foo."bar.baz"`
 			},
@@ -120,7 +120,9 @@ func testBadMigration(t *testing.T, expected string, define func(*libschema.Data
 
 	db, err := sql.Open("mysql", dsn)
 	require.NoError(t, err, "open database")
-	defer db.Close()
+	defer func() {
+		assert.NoError(t, db.Close())
+	}()
 	defer cleanup(db)
 
 	if reopt != nil {

lsmysql/check.go

@@ -9,9 +9,15 @@ import (
 	"github.com/pkg/errors"
 )
 
-var ErrDataAndDDL = errors.New("Migration combines DDL (Data Definition Language [schema changes]) and data manipulation")
-var ErrNonIdempotentDDL = errors.New("Unconditional migration has non-idempotent DDL (Data Definition Language [schema changes])")
-var ifExistsRE = regexp.MustCompile(`(?i)\bIF (?:NOT )?EXISTS\b`)
+var (
+	// ErrDataAndDDL is returned when a migration combines DML and DDL
+	ErrDataAndDDL = errors.New("migration combines DDL (Data Definition Language [schema changes]) and data manipulation")
+
+	// ErrNonIdempotentDDL is returned when a migration has non-idempotent DDL
+	ErrNonIdempotentDDL = errors.New("unconditional migration has non-idempotent DDL (Data Definition Language [schema changes])")
+
+	ifExistsRE = regexp.MustCompile(`(?i)\bIF (?:NOT )?EXISTS\b`)
+)
 
 // CheckScript attempts to validate that an SQL command does not do
 // both schema changes (DDL) and data changes.  The returned error

lsmysql/mysql.go

@@ -111,7 +111,8 @@
 func Generate(
 	name string,
 	generator func(context.Context, *sql.Tx) string,
-	opts ...libschema.MigrationOption) libschema.Migration {
+	opts ...libschema.MigrationOption,
+) libschema.Migration {
 	return mmigration{
 		MigrationBase: libschema.MigrationBase{
 			Name: libschema.MigrationName{
@@ -127,7 +128,8 @@
 func Computed(
 	name string,
 	action func(context.Context, *sql.Tx) error,
-	opts ...libschema.MigrationOption) libschema.Migration {
+	opts ...libschema.MigrationOption,
+) libschema.Migration {
 	return mmigration{
 		MigrationBase: libschema.MigrationBase{
 			Name: libschema.MigrationName{
@@ -172,11 +174,11 @@
 	}()
 	if d.Options.SchemaOverride != "" {
 		if !simpleIdentifierRE.MatchString(d.Options.SchemaOverride) {
-			return nil, errors.Errorf("Options.SchemaOverride must be a simple identifier, not '%s'", d.Options.SchemaOverride)
+			return nil, errors.Errorf("options.SchemaOverride must be a simple identifier, not '%s'", d.Options.SchemaOverride)
 		}
 		_, err := tx.Exec(`USE ` + d.Options.SchemaOverride)
 		if err != nil {
-			return nil, errors.Wrapf(err, "Set search path to %s for %s", d.Options.SchemaOverride, m.Base().Name)
+			return nil, errors.Wrapf(err, "set search path to %s for %s", d.Options.SchemaOverride, m.Base().Name)
 		}
 	}
 	pm := m.(*mmigration)
@@ -196,11 +198,11 @@
 		err = pm.computed(ctx, tx)
 	}
 	if err != nil {
-		err = errors.Wrapf(err, "Problem with migration %s", m.Base().Name)
+		err = errors.Wrapf(err, "problem with migration %s", m.Base().Name)
 		_ = tx.Rollback()
 		ntx, txerr := d.DB().BeginTx(ctx, d.Options.MigrationTxOptions)
 		if txerr != nil {
-			return nil, errors.Wrapf(err, "Tx for saving status for %s also failed with %s", m.Base().Name, txerr)
+			return nil, errors.Wrapf(err, "tx for saving status for %s also failed with %s", m.Base().Name, txerr)
 		}
 		tx = ntx
 	}
@@ -209,7 +211,7 @@
 		if err == nil {
 			err = txerr
 		} else {
-			err = errors.Wrapf(err, "Save status for %s also failed: %s", m.Base().Name, txerr)
+			err = errors.Wrapf(err, "save status for %s also failed: %s", m.Base().Name, txerr)
 		}
 	}
 	return
@@ -229,7 +231,7 @@
 				CREATE SCHEMA IF NOT EXISTS %s
 				`, schema))
 		if err != nil {
-			return errors.Wrapf(err, "Could not create libschema schema '%s'", schema)
+			return errors.Wrapf(err, "could not create libschema schema '%s'", schema)
 		}
 	}
 	_, err = d.DB().ExecContext(ctx, fmt.Sprintf(`
@@ -242,7 +244,7 @@
 			PRIMARY KEY	(library, migration)
 		) ENGINE = InnoDB`, tableName))
 	if err != nil {
-		return errors.Wrapf(err, "Could not create libschema migrations table '%s'", tableName)
+		return errors.Wrapf(err, "could not create libschema migrations table '%s'", tableName)
 	}
 	return nil
 }
@@ -270,20 +272,20 @@
 	case 2:
 		schema := s[0]
 		if !simpleIdentifierRE.MatchString(schema) {
-			return "", "", "", errors.Errorf("Tracking table schema name must be a simple identifier, not '%s'", schema)
+			return "", "", "", errors.Errorf("tracking table schema name must be a simple identifier, not '%s'", schema)
 		}
 		table := s[1]
 		if !simpleIdentifierRE.MatchString(table) {
-			return "", "", "", errors.Errorf("Tracking table table name must be a simple identifier, not '%s'", table)
+			return "", "", "", errors.Errorf("tracking table table name must be a simple identifier, not '%s'", table)
 		}
 		return schema, schema + "." + table, table, nil
 	case 1:
 		if !simpleIdentifierRE.MatchString(tableName) {
-			return "", "", "", errors.Errorf("Tracking table table name must be a simple identifier, not '%s'", tableName)
+			return "", "", "", errors.Errorf("tracking table table name must be a simple identifier, not '%s'", tableName)
 		}
 		return "", tableName, tableName, nil
 	default:
-		return "", "", "", errors.Errorf("Tracking table '%s' is not valid", tableName)
+		return "", "", "", errors.Errorf("tracking table '%s' is not valid", tableName)
 	}
 }
 
@@ -309,7 +311,7 @@
 		VALUES (?, ?, ?, ?, ?, now())`, p.trackingTable(d))
 	_, err := tx.Exec(q, p.databaseName, m.Base().Name.Library, m.Base().Name.Name, done, estr)
 	if err != nil {
-		return errors.Wrapf(err, "Save status for %s", m.Base().Name)
+		return errors.Wrapf(err, "save status for %s", m.Base().Name)
 	}
 	return nil
 }
@@ -345,7 +347,7 @@
 	var gotLock int
 	err = tx.QueryRow(`SELECT GET_LOCK(?, -1)`, p.lockStr).Scan(&gotLock)
 	if err != nil {
-		return errors.Wrapf(err, "Could not get lock for libschema migrations")
+		return errors.Wrapf(err, "could not get lock for libschema migrations")
 	}
 	p.lockTx = tx
 
@@ -429,17 +431,22 @@
 // It is expected to be called by libschema and is not
 // called internally which means that is safe to override
 // in types that embed MySQL.
-func (p *MySQL) LoadStatus(ctx context.Context, _ *internal.Log, d *libschema.Database) ([]libschema.MigrationName, error) {
+func (p *MySQL) LoadStatus(ctx context.Context, _ *internal.Log, d *libschema.Database) (_ []libschema.MigrationName, err error) {
 	// TODO: DRY
 	tableName := p.trackingTable(d)
 	rows, err := d.DB().QueryContext(ctx, fmt.Sprintf(`
 		SELECT	library, migration, done
 		FROM	%s
 		WHERE	db_name = ?`, tableName), p.databaseName)
 	if err != nil {
-		return nil, errors.Wrap(err, "Cannot query migration status")
+		return nil, errors.Wrap(err, "cannot query migration status")
 	}
-	defer rows.Close()
+	defer func() {
+		e := rows.Close()
+		if e != nil && err == nil {
+			err = errors.Wrap(e, "close scan on migration table")
+		}
+	}()
 	var unknowns []libschema.MigrationName
 	for rows.Next() {
 		var (
@@ -448,7 +455,7 @@
 		)
 		err := rows.Scan(&name.Library, &name.Name, &status.Done)
 		if err != nil {
-			return nil, errors.Wrap(err, "Cannot scan migration status")
+			return nil, errors.Wrap(err, "cannot scan migration status")
 		}
 		if m, ok := d.Lookup(name); ok {
 			m.Base().SetStatus(status)
@@ -468,13 +475,13 @@
 func (p *MySQL) IsMigrationSupported(d *libschema.Database, _ *internal.Log, migration libschema.Migration) error {
 	m, ok := migration.(*mmigration)
 	if !ok {
-		return fmt.Errorf("Non-mysql migration %s registered with mysql migrations", migration.Base().Name)
+		return fmt.Errorf("non-mysql migration %s registered with mysql migrations", migration.Base().Name)
 	}
 	if m.script != nil {
 		return nil
 	}
 	if m.computed != nil {
 		return nil
 	}
-	return errors.Errorf("Migration %s is not supported", m.Name)
+	return errors.Errorf("migration %s is not supported", m.Name)
 }

lsmysql/mysql_repeat_test.go

@@ -22,7 +22,7 @@ func TestRepeat(t *testing.T) {
 	db, err := sql.Open("mysql", dsn)
 	require.NoError(t, err)
 	defer func() {
-		db.Close()
+		assert.NoError(t, db.Close())
 	}()
 
 	options, cleanup := lstesting.FakeSchema(t, "")