multi: introduce migration stream for unit tests

In upcoming commits, we will introduce a new migration stream package
that will need to reference the db package, as well as the accounts,
session and firewalldb package in future commits. To avoid circular
dependencies, we therefore introduce a new migration stream that unit
tests can use, in order to avoid having to import the new migration
stream package.

Author: ViktorTigerstrom

accounts/test_sqlite.go

@@ -18,7 +18,8 @@ var ErrDBClosed = errors.New("database is closed")
 // NewTestDB is a helper function that creates an SQLStore database for testing.
 func NewTestDB(t *testing.T, clock clock.Clock) Store {
 	return createStore(
-		t, sqldb.NewTestSqliteDB(t, db.LitdMigrationStreams).BaseDB,
+		t,
+		sqldb.NewTestSqliteDB(t, db.MakeTestMigrationStreams()).BaseDB,
 		clock,
 	)
 }
@@ -28,7 +29,9 @@ func NewTestDB(t *testing.T, clock clock.Clock) Store {
 func NewTestDBFromPath(t *testing.T, dbPath string,
 	clock clock.Clock) Store {
 
-	tDb := sqldb.NewTestSqliteDBFromPath(t, dbPath, db.LitdMigrationStreams)
+	tDb := sqldb.NewTestSqliteDBFromPath(
+		t, dbPath, db.MakeTestMigrationStreams(),
+	)
 
 	return createStore(t, tDb.BaseDB, clock)
 }

db/migrations.go

@@ -1,5 +1,11 @@
 package db
 
+import (
+	"github.com/golang-migrate/migrate/v4"
+	"github.com/golang-migrate/migrate/v4/database/pgx/v5"
+	"github.com/lightningnetwork/lnd/sqldb/v2"
+)
+
 const (
 	// LatestMigrationVersion is the latest migration version of the
 	// database. This is used to implement downgrade protection for the
@@ -8,3 +14,29 @@ const (
 	// NOTE: This MUST be updated when a new migration is added.
 	LatestMigrationVersion = 5
 )
+
+// MakeTestMigrationStreams creates the migration streams for the unit test
+// environment.
+func MakeTestMigrationStreams() []sqldb.MigrationStream {
+	migStream := sqldb.MigrationStream{
+		MigrateTableName: pgx.DefaultMigrationsTable,
+		SQLFileDirectory: "sqlc/migrations",
+		Schemas:          SqlSchemas,
+
+		// LatestMigrationVersion is the latest migration version of the
+		// database.  This is used to implement downgrade protection for
+		// the daemon.
+		//
+		// NOTE: This MUST be updated when a new migration is added.
+		LatestMigrationVersion: LatestMigrationVersion,
+
+		MakePostMigrationChecks: func(
+			db *sqldb.BaseDB) (map[uint]migrate.PostStepCallback,
+			error) {
+
+			return make(map[uint]migrate.PostStepCallback), nil
+		},
+	}
+
+	return []sqldb.MigrationStream{migStream}
+}

db/postgres.go

@@ -68,5 +68,5 @@ func NewTestPostgresDB(t *testing.T) *sqldb.PostgresStore {
 		sqlFixture.TearDown(t)
 	})
 
-	return sqldb.NewTestPostgresDB(t, sqlFixture, LitdMigrationStreams)
+	return sqldb.NewTestPostgresDB(t, sqlFixture, MakeTestMigrationStreams())
 }

firewalldb/test_sqlite.go

@@ -13,7 +13,8 @@ import (
 // NewTestDB is a helper function that creates an BBolt database for testing.
 func NewTestDB(t *testing.T, clock clock.Clock) FirewallDBs {
 	return createStore(
-		t, sqldb.NewTestSqliteDB(t, db.LitdMigrationStreams).BaseDB,
+		t,
+		sqldb.NewTestSqliteDB(t, db.MakeTestMigrationStreams()).BaseDB,
 		clock,
 	)
 }
@@ -23,7 +24,9 @@ func NewTestDB(t *testing.T, clock clock.Clock) FirewallDBs {
 func NewTestDBFromPath(t *testing.T, dbPath string,
 	clock clock.Clock) FirewallDBs {
 
-	tDb := sqldb.NewTestSqliteDBFromPath(t, dbPath, db.LitdMigrationStreams)
+	tDb := sqldb.NewTestSqliteDBFromPath(
+		t, dbPath, db.MakeTestMigrationStreams(),
+	)
 
 	return createStore(t, tDb.BaseDB, clock)
 }

session/test_sqlite.go

@@ -18,7 +18,8 @@ var ErrDBClosed = errors.New("database is closed")
 // NewTestDB is a helper function that creates an SQLStore database for testing.
 func NewTestDB(t *testing.T, clock clock.Clock) Store {
 	return createStore(
-		t, sqldb.NewTestSqliteDB(t, db.LitdMigrationStreams).BaseDB,
+		t,
+		sqldb.NewTestSqliteDB(t, db.MakeTestMigrationStreams()).BaseDB,
 		clock,
 	)
 }
@@ -28,7 +29,9 @@ func NewTestDB(t *testing.T, clock clock.Clock) Store {
 func NewTestDBFromPath(t *testing.T, dbPath string,
 	clock clock.Clock) Store {
 
-	tDb := sqldb.NewTestSqliteDBFromPath(t, dbPath, db.LitdMigrationStreams)
+	tDb := sqldb.NewTestSqliteDBFromPath(
+		t, dbPath, db.MakeTestMigrationStreams(),
+	)
 
 	return createStore(t, tDb.BaseDB, clock)
 }