accounts: DB constructors for tests

This commit adds two new test helpers, NewTestDB and NewTestDBFromPath
in a file that is only built when the test_db_postgres and
test_db_sqlite build flags are not set. When we add sql backends, we
will add helpers with the same names for each new backend. We will then
use the appropriate build flags to run our unit tests against all
backends.

Author: ellemouton

accounts/checkers_test.go

@@ -523,8 +523,7 @@ func testSendPayment(t *testing.T, uri string) {
 	errFunc := func(err error) {
 		lndMock.mainErrChan <- err
 	}
-	store, err := NewBoltStore(t.TempDir(), DBFilename)
-	require.NoError(t, err)
+	store := NewTestDB(t)
 	service, err := NewService(store, errFunc)
 	require.NoError(t, err)
 
@@ -721,8 +720,7 @@ func TestSendPaymentV2(t *testing.T) {
 	errFunc := func(err error) {
 		lndMock.mainErrChan <- err
 	}
-	store, err := NewBoltStore(t.TempDir(), DBFilename)
-	require.NoError(t, err)
+	store := NewTestDB(t)
 	service, err := NewService(store, errFunc)
 	require.NoError(t, err)
 
@@ -910,8 +908,7 @@ func TestSendToRouteV2(t *testing.T) {
 	errFunc := func(err error) {
 		lndMock.mainErrChan <- err
 	}
-	store, err := NewBoltStore(t.TempDir(), DBFilename)
-	require.NoError(t, err)
+	store := NewTestDB(t)
 	service, err := NewService(store, errFunc)
 	require.NoError(t, err)
 

accounts/service_test.go

@@ -264,7 +264,7 @@ func TestAccountService(t *testing.T) {
 				isRunning := s.IsRunning()
 				return isRunning == false
 			})
-			lnd.assertMainErrContains(t, "database not open")
+			lnd.assertMainErrContains(t, ErrDBClosed.Error())
 		},
 	}, {
 		name: "err in invoice err channel",
@@ -833,8 +833,7 @@ func TestAccountService(t *testing.T) {
 			errFunc := func(err error) {
 				lndMock.mainErrChan <- err
 			}
-			store, err := NewBoltStore(t.TempDir(), DBFilename)
-			require.NoError(tt, err)
+			store := NewTestDB(t)
 			service, err := NewService(store, errFunc)
 			require.NoError(t, err)
 

accounts/store_test.go

@@ -15,8 +15,7 @@ func TestAccountStore(t *testing.T) {
 	t.Parallel()
 	ctx := context.Background()
 
-	store, err := NewBoltStore(t.TempDir(), DBFilename)
-	require.NoError(t, err)
+	store := NewTestDB(t)
 
 	// Create an account that does not expire.
 	acct1, err := store.NewAccount(ctx, 0, time.Time{}, "foo")
@@ -112,10 +111,9 @@ func TestLastInvoiceIndexes(t *testing.T) {
 	t.Parallel()
 	ctx := context.Background()
 
-	store, err := NewBoltStore(t.TempDir(), DBFilename)
-	require.NoError(t, err)
+	store := NewTestDB(t)
 
-	_, _, err = store.LastIndexes(ctx)
+	_, _, err := store.LastIndexes(ctx)
 	require.ErrorIs(t, err, ErrNoInvoiceIndexKnown)
 
 	require.NoError(t, store.StoreLastIndexes(ctx, 7, 99))

accounts/test_kvdb.go

@@ -0,0 +1,30 @@
+package accounts
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+// ErrDBClosed is an error that is returned when a database operation is
+// performed on a closed database.
+var ErrDBClosed = errors.New("database not open")
+
+// NewTestDB is a helper function that creates an BBolt database for testing.
+func NewTestDB(t *testing.T) *BoltStore {
+	return NewTestDBFromPath(t, t.TempDir())
+}
+
+// NewTestDBFromPath is a helper function that creates a new BoltStore with a
+// connection to an existing BBolt database for testing.
+func NewTestDBFromPath(t *testing.T, dbPath string) *BoltStore {
+	store, err := NewBoltStore(dbPath, DBFilename)
+	require.NoError(t, err)
+
+	t.Cleanup(func() {
+		require.NoError(t, store.db.Close())
+	})
+
+	return store
+}