tapdb: add func to create test db handle from an existing sqlite file

These new functions aid in investigating an existing tapd sqlite
database file.

Author: ffranr

tapdb/sqlite.go

@@ -170,13 +170,21 @@ func (s *SqliteStore) ExecuteMigrations(target MigrationTarget) error {
 func NewTestSqliteDB(t *testing.T) *SqliteStore {
 	t.Helper()
 
-	dbFileName := filepath.Join(t.TempDir(), "tmp.db")
-	t.Logf("Creating new SQLite DB for testing: %s", dbFileName)
-
 	// TODO(roasbeef): if we pass :memory: for the file name, then we get
 	// an in mem version to speed up tests
+	dbPath := filepath.Join(t.TempDir(), "tmp.db")
+	t.Logf("Creating new SQLite DB handle for testing: %s", dbPath)
+
+	return NewTestSqliteDbHandleFromPath(t, dbPath)
+}
+
+// NewTestSqliteDbHandleFromPath is a helper function that creates a SQLite
+// database handle given a database file path.
+func NewTestSqliteDbHandleFromPath(t *testing.T, dbPath string) *SqliteStore {
+	t.Helper()
+
 	sqlDB, err := NewSqliteStore(&SqliteConfig{
-		DatabaseFileName: dbFileName,
+		DatabaseFileName: dbPath,
 		SkipMigrations:   false,
 	})
 	require.NoError(t, err)

tapdb/sqlutils_test.go

@@ -221,11 +221,8 @@ func (d *DbHandler) AddRandomServerAddrs(t *testing.T,
 	return addrs
 }
 
-// NewDbHandle creates a new store and query handle to the test database.
-func NewDbHandle(t *testing.T) *DbHandler {
-	// Create a new test database.
-	db := NewTestDB(t)
-
+// newDbHandleFromDb creates a new database store handle given a database store.
+func newDbHandleFromDb(db *BaseDB) *DbHandler {
 	testClock := clock.NewTestClock(time.Now())
 
 	// Gain a handle to the pending (minting) universe federation store.
@@ -268,3 +265,17 @@ func NewDbHandle(t *testing.T) *DbHandler {
 		DirectQuery:             db,
 	}
 }
+
+// NewDbHandleFromPath creates a new database store handle given a database file
+// path.
+func NewDbHandleFromPath(t *testing.T, dbPath string) *DbHandler {
+	db := NewTestDbHandleFromPath(t, dbPath)
+	return newDbHandleFromDb(db.BaseDB)
+}
+
+// NewDbHandle creates a new database store handle.
+func NewDbHandle(t *testing.T) *DbHandler {
+	// Create a new test database with the default database file path.
+	db := NewTestDB(t)
+	return newDbHandleFromDb(db.BaseDB)
+}

tapdb/test_postgres.go

@@ -11,6 +11,12 @@ func NewTestDB(t *testing.T) *PostgresStore {
 	return NewTestPostgresDB(t)
 }
 
+// NewTestDbHandleFromPath is a helper function that creates a new handle to an
+// existing SQLite database for testing.
+func NewTestDbHandleFromPath(t *testing.T, dbPath string) *PostgresStore {
+	return NewTestPostgresDB(t)
+}
+
 // NewTestDBWithVersion is a helper function that creates a Postgres database
 // for testing and migrates it to the given version.
 func NewTestDBWithVersion(t *testing.T, version uint) *PostgresStore {

tapdb/test_sqlite.go

@@ -11,6 +11,12 @@ func NewTestDB(t *testing.T) *SqliteStore {
 	return NewTestSqliteDB(t)
 }
 
+// NewTestDbHandleFromPath is a helper function that creates a new handle to an
+// existing SQLite database for testing.
+func NewTestDbHandleFromPath(t *testing.T, dbPath string) *SqliteStore {
+	return NewTestSqliteDbHandleFromPath(t, dbPath)
+}
+
 // NewTestDBWithVersion is a helper function that creates an SQLite database for
 // testing and migrates it to the given version.
 func NewTestDBWithVersion(t *testing.T, version uint) *SqliteStore {