From 570863ca269cb7588a337d6fb1631d87f02cd215 Mon Sep 17 00:00:00 2001
From: ziggie <ziggie1984@protonmail.com>
Date: Wed, 15 Oct 2025 17:26:45 +0200
Subject: [PATCH] paymentsdb: add harness to run payment db agnostic tests

In commit adds the harness which will be used to run db agnostic
tests against the kv and sql backend. We have adopted all the
unit tests so far so that with this commit all the payment tests
not specifically put into the kv_store_test.go should all pass
for all backends.
---
 payments/db/test_kvdb.go     |  2 +
 payments/db/test_postgres.go | 77 ++++++++++++++++++++++++++++++++++++
 payments/db/test_sqlite.go   | 56 ++++++++++++++++++++++++++
 3 files changed, 135 insertions(+)
 create mode 100644 payments/db/test_postgres.go
 create mode 100644 payments/db/test_sqlite.go

diff --git a/payments/db/test_kvdb.go b/payments/db/test_kvdb.go
index e0ee1738d..a4bbfccbd 100644
--- a/payments/db/test_kvdb.go
+++ b/payments/db/test_kvdb.go
@@ -1,3 +1,5 @@
+//go:build !test_db_sqlite && !test_db_postgres
+
 package paymentsdb
 
 import (
diff --git a/payments/db/test_postgres.go b/payments/db/test_postgres.go
new file mode 100644
index 000000000..b4f00f9b0
--- /dev/null
+++ b/payments/db/test_postgres.go
@@ -0,0 +1,77 @@
+//go:build test_db_postgres && !test_db_sqlite
+
+package paymentsdb
+
+import (
+	"database/sql"
+	"testing"
+
+	"github.com/lightningnetwork/lnd/sqldb"
+	"github.com/stretchr/testify/require"
+)
+
+// NewTestDB is a helper function that creates a SQLStore backed by a SQL
+// database for testing.
+func NewTestDB(t testing.TB, opts ...OptionModifier) DB {
+	return NewTestDBWithFixture(t, nil, opts...)
+}
+
+// NewTestDBFixture creates a new sqldb.TestPgFixture for testing purposes.
+func NewTestDBFixture(t *testing.T) *sqldb.TestPgFixture {
+	pgFixture := sqldb.NewTestPgFixture(
+		t, sqldb.DefaultPostgresFixtureLifetime,
+	)
+	t.Cleanup(func() {
+		pgFixture.TearDown(t)
+	})
+	return pgFixture
+}
+
+// NewTestDBWithFixture is a helper function that creates a SQLStore backed by a
+// SQL database for testing.
+func NewTestDBWithFixture(t testing.TB,
+	pgFixture *sqldb.TestPgFixture, opts ...OptionModifier) DB {
+
+	var querier BatchedSQLQueries
+	if pgFixture == nil {
+		querier = newBatchQuerier(t)
+	} else {
+		querier = newBatchQuerierWithFixture(t, pgFixture)
+	}
+
+	store, err := NewSQLStore(
+		&SQLStoreConfig{
+			QueryCfg: sqldb.DefaultPostgresConfig(),
+		}, querier, opts...,
+	)
+	require.NoError(t, err)
+
+	return store
+}
+
+// newBatchQuerier creates a new BatchedSQLQueries instance for testing
+// using a PostgreSQL database fixture.
+func newBatchQuerier(t testing.TB) BatchedSQLQueries {
+	pgFixture := sqldb.NewTestPgFixture(
+		t, sqldb.DefaultPostgresFixtureLifetime,
+	)
+	t.Cleanup(func() {
+		pgFixture.TearDown(t)
+	})
+
+	return newBatchQuerierWithFixture(t, pgFixture)
+}
+
+// newBatchQuerierWithFixture creates a new BatchedSQLQueries instance for
+// testing using a PostgreSQL database fixture.
+func newBatchQuerierWithFixture(t testing.TB,
+	pgFixture *sqldb.TestPgFixture) BatchedSQLQueries {
+
+	db := sqldb.NewTestPostgresDB(t, pgFixture).BaseDB
+
+	return sqldb.NewTransactionExecutor(
+		db, func(tx *sql.Tx) SQLQueries {
+			return db.WithTx(tx)
+		},
+	)
+}
diff --git a/payments/db/test_sqlite.go b/payments/db/test_sqlite.go
new file mode 100644
index 000000000..8664db484
--- /dev/null
+++ b/payments/db/test_sqlite.go
@@ -0,0 +1,56 @@
+//go:build !test_db_postgres && test_db_sqlite
+
+package paymentsdb
+
+import (
+	"database/sql"
+	"testing"
+
+	"github.com/lightningnetwork/lnd/sqldb"
+	"github.com/stretchr/testify/require"
+)
+
+// NewTestDB is a helper function that creates a SQLStore backed by a SQL
+// database for testing.
+func NewTestDB(t testing.TB, opts ...OptionModifier) DB {
+	return NewTestDBWithFixture(t, nil, opts...)
+}
+
+// NewTestDBFixture is a no-op for the sqlite build.
+func NewTestDBFixture(_ *testing.T) *sqldb.TestPgFixture {
+	return nil
+}
+
+// NewTestDBWithFixture is a helper function that creates a SQLStore backed by a
+// SQL database for testing.
+func NewTestDBWithFixture(t testing.TB, _ *sqldb.TestPgFixture,
+	opts ...OptionModifier) DB {
+
+	store, err := NewSQLStore(
+		&SQLStoreConfig{
+			QueryCfg: sqldb.DefaultSQLiteConfig(),
+		}, newBatchQuerier(t), opts...,
+	)
+	require.NoError(t, err)
+	return store
+}
+
+// newBatchQuerier creates a new BatchedSQLQueries instance for testing
+// using a SQLite database.
+func newBatchQuerier(t testing.TB) BatchedSQLQueries {
+	return newBatchQuerierWithFixture(t, nil)
+}
+
+// newBatchQuerierWithFixture creates a new BatchedSQLQueries instance for
+// testing using a SQLite database.
+func newBatchQuerierWithFixture(t testing.TB,
+	_ *sqldb.TestPgFixture) BatchedSQLQueries {
+
+	db := sqldb.NewTestSqliteDB(t).BaseDB
+
+	return sqldb.NewTransactionExecutor(
+		db, func(tx *sql.Tx) SQLQueries {
+			return db.WithTx(tx)
+		},
+	)
+}