[sql-41] firewalldb: add migration code for kvstores from kvdb to SQL

accounts/sql_migration_test.go

@@ -39,9 +39,6 @@ func TestAccountStoreMigration(t *testing.T) {
 		*db.TransactionExecutor[SQLQueries]) {
 
 		testDBStore := NewTestDB(t, clock)
-		t.Cleanup(func() {
-			require.NoError(t, testDBStore.Close())
-		})
 
 		store, ok := testDBStore.(*SQLStore)
 		require.True(t, ok)

accounts/test_postgres.go

@@ -16,13 +16,13 @@ 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 NewSQLStore(db.NewTestPostgresDB(t).BaseDB, clock)
+	return createStore(t, db.NewTestPostgresDB(t).BaseDB, clock)
 }
 
 // NewTestDBFromPath is a helper function that creates a new SQLStore with a
 // connection to an existing postgres database for testing.
 func NewTestDBFromPath(t *testing.T, dbPath string,
 	clock clock.Clock) Store {
 
-	return NewSQLStore(db.NewTestPostgresDB(t).BaseDB, clock)
+	return createStore(t, db.NewTestPostgresDB(t).BaseDB, clock)
 }

accounts/test_sql.go

@@ -0,0 +1,22 @@
+//go:build test_db_postgres || test_db_sqlite
+
+package accounts
+
+import (
+	"testing"
+
+	"github.com/lightninglabs/lightning-terminal/db"
+	"github.com/lightningnetwork/lnd/clock"
+	"github.com/stretchr/testify/require"
+)
+
+// createStore is a helper function that creates a new SQLStore and ensure that
+// it is closed when during the test cleanup.
+func createStore(t *testing.T, sqlDB *db.BaseDB, clock clock.Clock) *SQLStore {
+	store := NewSQLStore(sqlDB, clock)
+	t.Cleanup(func() {
+		require.NoError(t, store.Close())
+	})
+
+	return store
+}

accounts/test_sqlite.go

@@ -16,15 +16,15 @@ 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 NewSQLStore(db.NewTestSqliteDB(t).BaseDB, clock)
+	return createStore(t, db.NewTestSqliteDB(t).BaseDB, clock)
 }
 
 // NewTestDBFromPath is a helper function that creates a new SQLStore with a
 // connection to an existing SQL database for testing.
 func NewTestDBFromPath(t *testing.T, dbPath string,
 	clock clock.Clock) Store {
 
-	return NewSQLStore(
-		db.NewTestSqliteDbHandleFromPath(t, dbPath).BaseDB, clock,
+	return createStore(
+		t, db.NewTestSqliteDbHandleFromPath(t, dbPath).BaseDB, clock,
 	)
 }

db/sqlc/queries/kvstores.sql

@@ -28,6 +28,10 @@ VALUES ($1, $2, $3, $4, $5, $6);
 DELETE FROM kvstores
 WHERE perm = false;
 
+-- name: ListAllKVStoresRecords :many
+SELECT *
+FROM kvstores;
+
 -- name: GetGlobalKVStoreRecord :one
 SELECT value
 FROM kvstores

firewalldb/actions_test.go

@@ -28,9 +28,6 @@ func TestActionStorage(t *testing.T) {
 	sessDB := session.NewTestDBWithAccounts(t, clock, accountsDB)
 
 	db := NewTestDBWithSessionsAndAccounts(t, sessDB, accountsDB, clock)
-	t.Cleanup(func() {
-		_ = db.Close()
-	})
 
 	// Assert that attempting to add an action for a session that does not
 	// exist returns an error.
@@ -198,9 +195,6 @@ func TestListActions(t *testing.T) {
 	sessDB := session.NewTestDB(t, clock)
 
 	db := NewTestDBWithSessions(t, sessDB, clock)
-	t.Cleanup(func() {
-		_ = db.Close()
-	})
 
 	// Add 2 sessions that we can reference.
 	sess1, err := sessDB.NewSession(
@@ -466,9 +460,6 @@ func TestListGroupActions(t *testing.T) {
 	}
 
 	db := NewTestDBWithSessions(t, sessDB, clock)
-	t.Cleanup(func() {
-		_ = db.Close()
-	})
 
 	// There should not be any actions in group 1 yet.
 	al, _, _, err := db.ListActions(ctx, nil, WithActionGroupID(group1))

firewalldb/db.go

@@ -14,29 +14,21 @@ var (
 	ErrNoSuchKeyFound = fmt.Errorf("no such key found")
 )
 
-// firewallDBs is an interface that groups the RulesDB and PrivacyMapper
-// interfaces.
-type firewallDBs interface {
-	RulesDB
-	PrivacyMapper
-	ActionDB
-}
-
 // DB manages the firewall rules database.
 type DB struct {
 	started sync.Once
 	stopped sync.Once
 
-	firewallDBs
+	FirewallDBs
 
 	cancel fn.Option[context.CancelFunc]
 }
 
 // NewDB creates a new firewall database. For now, it only contains the
 // underlying rules' and privacy mapper databases.
-func NewDB(dbs firewallDBs) *DB {
+func NewDB(dbs FirewallDBs) *DB {
 	return &DB{
-		firewallDBs: dbs,
+		FirewallDBs: dbs,
 	}
 }
 

firewalldb/interface.go

@@ -134,3 +134,11 @@ type ActionDB interface {
 	// and feature name.
 	GetActionsReadDB(groupID session.ID, featureName string) ActionsReadDB
 }
+
+// FirewallDBs is an interface that groups the RulesDB, PrivacyMapper and
+// ActionDB interfaces.
+type FirewallDBs interface {
+	RulesDB
+	PrivacyMapper
+	ActionDB
+}

firewalldb/kvstores_kvdb.go

@@ -16,13 +16,13 @@ the temporary store changes instead of just keeping an in-memory store is that
 we can then guarantee atomicity if changes are made to both the permanent and
 temporary stores.
 
-rules -> perm -> rule-name -> global   -> {k:v}
-              -> sessions -> group ID  -> session-kv-store  -> {k:v}
-			               -> feature-kv-stores -> feature-name -> {k:v}
+"rules" -> "perm" -> rule-name -> "global" -> {k:v}
+				  "session-kv-store" -> group ID -> {k:v}
+							         -> "feature-kv-stores" -> feature-name -> {k:v}
 
-      -> temp -> rule-name -> global   -> {k:v}
-	      -> sessions -> group ID  -> session-kv-store  -> {k:v}
-				       -> feature-kv-stores -> feature-name -> {k:v}
+        -> "temp" -> rule-name -> "global" -> {k:v}
+				  "session-kv-store" -> group ID -> {k:v}
+							         -> "feature-kv-stores" -> feature-name -> {k:v}
 */
 
 var (