Refactor openTempSQLite to return only *sql.DB and update all test cases accordingly

Author: AlphaOne1

dialects_test.go

@@ -4,10 +4,10 @@
 package dmorph_test
 
 import (
-	"regexp"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/AlphaOne1/dmorph"
 )
@@ -30,8 +30,6 @@ func TestDialectStatements(t *testing.T) {
 		{name: "SQLite", caller: dmorph.DialectSQLite},
 	}
 
-	re := regexp.MustCompile("%s")
-
 	for k, v := range tests {
 		d := v.caller()
 
@@ -40,28 +38,25 @@ func TestDialectStatements(t *testing.T) {
 		}
 		assert.Contains(t, d.CreateTemplate, "%s",
 			"no table name placeholder in create template for", v.name)
-		assert.Regexp(t, re, d.CreateTemplate)
 
 		if len(d.AppliedTemplate) < 10 {
 			t.Errorf("%v: applied template is too short for %v", k, v.name)
 		}
 		assert.Contains(t, d.AppliedTemplate, "%s",
 			"no table name placeholder in applied template for", v.name)
-		assert.Regexp(t, re, d.AppliedTemplate)
 
 		if len(d.RegisterTemplate) < 10 {
 			t.Errorf("%v: register template is too short for %v", k, v.name)
 		}
 		assert.Contains(t, d.RegisterTemplate, "%s",
 			"no table name placeholder in register template for", v.name)
-		assert.Regexp(t, re, d.RegisterTemplate)
 	}
 }
 
 // TestCallsOnClosedDB verifies that methods fail as expected when called on a closed database connection.
 func TestCallsOnClosedDB(t *testing.T) {
-	db, _ := openTempSQLite(t)
-	db.Close()
+	db := openTempSQLite(t)
+	require.NoError(t, db.Close())
 
 	assert.Error(t,
 		dmorph.DialectSQLite().EnsureMigrationTableExists(t.Context(), db, "irrelevant"),
@@ -82,7 +77,7 @@ func TestEnsureMigrationTableExistsSQLError(t *testing.T) {
             )`,
 	}
 
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	assert.Error(t, dialect.EnsureMigrationTableExists(t.Context(), db, "test"), "expected error")
 }
@@ -108,11 +103,11 @@ func TestEnsureMigrationTableExistsCommitError(t *testing.T) {
 			DELETE FROM t0 WHERE id = 1;`,
 	}
 
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	_, execErr := db.ExecContext(t.Context(), "PRAGMA foreign_keys = ON")
 
-	assert.NoError(t, execErr, "foreign keys checking could not be enabled")
+	require.NoError(t, execErr, "foreign keys checking could not be enabled")
 
 	assert.Error(t, dialect.EnsureMigrationTableExists(t.Context(), db, "test"), "expected error")
 }

file_migration_test.go

@@ -16,7 +16,7 @@ import (
 )
 
 func TestWithMigrationFromFile(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	runErr := dmorph.Run(t.Context(),
 		db,
@@ -27,7 +27,7 @@ func TestWithMigrationFromFile(t *testing.T) {
 }
 
 func TestWithMigrationFromFileError(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	runErr := dmorph.Run(t.Context(),
 		db,
@@ -52,7 +52,7 @@ func TestMigrationFromFileFSError(t *testing.T) {
 
 // TestApplyStepsStreamError tests error handling in applyStepsStream.
 func TestApplyStepsStreamError(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	buf := bytes.Buffer{}
 	buf.WriteString("utter nonsense")

migration_test.go

@@ -39,7 +39,7 @@ func prepareDB() (string, error) {
 	return result, nil
 }
 
-func openTempSQLite(t *testing.T) (*sql.DB, string) {
+func openTempSQLite(t *testing.T) *sql.DB {
 	t.Helper()
 
 	dbFile, err := prepareDB()
@@ -50,12 +50,12 @@ func openTempSQLite(t *testing.T) (*sql.DB, string) {
 	require.NoError(t, dbErr, "DB could not be opened")
 	t.Cleanup(func() { _ = db.Close() })
 
-	return db, dbFile
+	return db
 }
 
 // TestMigration tests the happy flow.
 func TestMigration(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	migrationsDir, migrationsDirErr := fs.Sub(testMigrationsDir, "testData")
 
@@ -71,7 +71,7 @@ func TestMigration(t *testing.T) {
 
 // TestMigrationUpdate tests the happy flow of updating on existing migrations.
 func TestMigrationUpdate(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	migrationsDir, migrationsDirErr := fs.Sub(testMigrationsDir, "testData")
 
@@ -103,7 +103,7 @@ func (m TestMigrationImpl) Migrate(ctx context.Context, tx *sql.Tx) error {
 
 // TestWithMigrations tests the adding of migrations using WithMigrations.
 func TestWithMigrations(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	runErr := dmorph.Run(t.Context(),
 		db,
@@ -123,7 +123,7 @@ func TestMigrationUnableToCreateMorpher(t *testing.T) {
 
 // TestMigrationTooOld tests what happens if the applied migrations are too old.
 func TestMigrationTooOld(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	migrationsDir, migrationsDirErr := fs.Sub(testMigrationsDir, "testData")
 
@@ -146,7 +146,7 @@ func TestMigrationTooOld(t *testing.T) {
 
 // TestMigrationUnrelated0 tests what happens if the applied migrations are unrelated to existing ones.
 func TestMigrationUnrelated0(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	migrationsDir, migrationsDirErr := fs.Sub(testMigrationsDir, "testData")
 
@@ -169,7 +169,7 @@ func TestMigrationUnrelated0(t *testing.T) {
 
 // TestMigrationUnrelated1 tests what happens if the applied migrations are unrelated to existing ones.
 func TestMigrationUnrelated1(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	migrationsDir, migrationsDirErr := fs.Sub(testMigrationsDir, "testData")
 
@@ -193,7 +193,7 @@ func TestMigrationUnrelated1(t *testing.T) {
 // TestMigrationAppliedUnordered tests the case, that somehow the migrations in the
 // database are registered not in the order of their keys.
 func TestMigrationAppliedUnordered(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	migrationsDir, migrationsDirErr := fs.Sub(testMigrationsDir, "testData")
 
@@ -380,7 +380,7 @@ func TestMigrationRunInvalid(t *testing.T) {
 // TestMigrationRunInvalidCreate tests the behavior of running a migration
 // with an invalid CreateTemplate in the dialect.
 func TestMigrationRunInvalidCreate(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	dialect := dmorph.DialectSQLite()
 	dialect.CreateTemplate = "utter nonsense"
@@ -398,7 +398,7 @@ func TestMigrationRunInvalidCreate(t *testing.T) {
 
 // TestMigrationRunInvalidApplied tests the failure scenario where the AppliedTemplate of the dialect is invalid.
 func TestMigrationRunInvalidApplied(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	dialect := dmorph.DialectSQLite()
 	dialect.AppliedTemplate = "utter nonsense"
@@ -416,7 +416,7 @@ func TestMigrationRunInvalidApplied(t *testing.T) {
 
 // TestMigrationApplyInvalidDB verifies that applying migrations to an invalid or closed database results in an error.
 func TestMigrationApplyInvalidDB(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	morpher, morpherErr := dmorph.NewMorpher(
 		dmorph.WithDialect(dmorph.DialectSQLite()),
@@ -431,7 +431,7 @@ func TestMigrationApplyInvalidDB(t *testing.T) {
 
 // TestMigrationApplyUnableRegister tests the behavior when the migration registration fails due to an invalid template.
 func TestMigrationApplyUnableRegister(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	morpher, morpherErr := dmorph.NewMorpher(
 		dmorph.WithDialect(dmorph.DialectSQLite()),
@@ -453,7 +453,7 @@ func TestMigrationApplyUnableRegister(t *testing.T) {
 // TestMigrationApplyUnableCommit tests the scenario where a migration application fails
 // due to inability to commit a transaction.
 func TestMigrationApplyUnableCommit(t *testing.T) {
-	db, _ := openTempSQLite(t)
+	db := openTempSQLite(t)
 
 	morpher, morpherErr := dmorph.NewMorpher(
 		dmorph.WithDialect(dmorph.DialectSQLite()),