mirror of
https://github.com/lightninglabs/lightning-terminal.git
synced 2026-08-13 12:33:36 +02:00
itest: add kvdb -> SQL migration test
This commit implements an itest kvdb -> SQL migration itest. The intention of the itest is to verify that the kvdb -> SQL migration flow works for a litd node which has data inserted to the bbolt database. To verify that, the minimum amount of data required to trigger the full migration flow is inserted into the bbolt database, which is one object to each database file. Those objects are: * One account - accounts.DB file * One session - session.db file * One action - rules.db file As the respective unit tests for each migration extensively tests that data of all forms for each database file can successfully be migrated, the itest only focuses on testing that the full migration flow works, and leaves the responsibility of data variation coverage to the respective unit test. The test is executed in different steps, and uses RPCs to seed and validate migration fixtures: 1. Start a node with a bbolt backend. 2. Insert one account, one session and one action via RPC. 3. Snapshot the inserted objects via RPC. 4. Restart with the configured SQL backend to trigger migration. 5. Query objects again via RPC. 6. Compare the new objects to the pre-migration snapshot. 7. Assert the migrated objects in SQL via direct queries, to verify that it's actually the SQL database that contains the migrated objects.
This commit is contained in:
Viktor Torstensson
parent
80615c2a90
commit
1222951d5c
2 changed files with 401 additions and 0 deletions
397
itest/litd_migration_test.go
Normal file
397
itest/litd_migration_test.go
Normal file
|
|
@ -0,0 +1,397 @@
|
|||
//go:build itest
|
||||
|
||||
package itest
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"time"
|
||||
|
||||
terminal "github.com/lightninglabs/lightning-terminal"
|
||||
"github.com/lightninglabs/lightning-terminal/accounts"
|
||||
"github.com/lightninglabs/lightning-terminal/db/sqlc"
|
||||
"github.com/lightninglabs/lightning-terminal/db/sqlcmig6"
|
||||
"github.com/lightninglabs/lightning-terminal/firewalldb"
|
||||
"github.com/lightninglabs/lightning-terminal/litrpc"
|
||||
"github.com/lightningnetwork/lnd/clock"
|
||||
"github.com/lightningnetwork/lnd/sqldb/v2"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// testKvdbSQLMigration implements an itest kvdb -> SQL migration itest. The
|
||||
// intention of the itest is to verify that the kvdb -> SQL migration flow works
|
||||
// for a litd node which has data inserted to the bbolt database.
|
||||
// To verify that, the minimum amount of data is inserted into the bbolt
|
||||
// database, which is one object to each database file. Those objects are:
|
||||
// * One account - accounts.DB file
|
||||
// * One session - session.db file
|
||||
// * One action - rules.db file
|
||||
//
|
||||
// As the respective unit tests for each migration extensively tests that data
|
||||
// of all forms for each database file can successfully be migrated, the itest
|
||||
// only focuses on testing that the full migration flow works, and leaves the
|
||||
// responsibility of data variation coverage to the respective unit test.
|
||||
//
|
||||
// The test is executed in different steps, and uses RPCs to seed and validate
|
||||
// migration fixtures:
|
||||
// 1. Start a node with a bbolt backend.
|
||||
// 2. Insert one account, one session and one action via RPC.
|
||||
// 3. Snapshot the inserted objects via RPC.
|
||||
// 4. Restart with the configured SQL backend to trigger migration.
|
||||
// 5. Query objects again via RPC.
|
||||
// 6. Compare the new objects to the pre-migration snapshot.
|
||||
// 7. Assert the migrated objects in SQL via direct queries, to verify that it's
|
||||
// actually the SQL database that contains the migrated objects.
|
||||
func testKvdbSQLMigration(ctx context.Context, net *NetworkHarness,
|
||||
t *harnessTest) {
|
||||
|
||||
if *litDBBackend == terminal.DatabaseBackendBbolt {
|
||||
t.t.Skipf("Skipping kvdb migration test for bbolt backend")
|
||||
}
|
||||
|
||||
ctxt, cancel := context.WithTimeout(ctx, defaultTimeout)
|
||||
defer cancel()
|
||||
|
||||
// Step 1: Start a node with a bbolt backend.
|
||||
// We want to start from an explicit bbolt backend regardless of the
|
||||
// command line flag used to run the itests.
|
||||
migNode, err := net.NewNode(
|
||||
t.t, "Migrator", nil, false, true,
|
||||
fmt.Sprintf(
|
||||
"--databasebackend=%s", terminal.DatabaseBackendBbolt,
|
||||
),
|
||||
"--firewall.request-logger.level=all",
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
defer shutdownAndAssert(net, t, migNode)
|
||||
|
||||
// Setup a raw gRPC connection used to set up RPC clients.
|
||||
rawConn, err := connectRPC(
|
||||
ctxt, migNode.Cfg.LitAddr(), migNode.Cfg.LitTLSCertPath,
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// Get the litd admin macaroon context from the migration node.
|
||||
macBytes := getLiTMacFromFile(t.t, migNode.Cfg)
|
||||
ctxm := macaroonContext(ctxt, macBytes)
|
||||
|
||||
// LiT RPC clients are used to seed and assert migration fixtures.
|
||||
accountsClient := litrpc.NewAccountsClient(rawConn)
|
||||
sessionsClient := litrpc.NewSessionsClient(rawConn)
|
||||
autopilotClient := litrpc.NewAutopilotClient(rawConn)
|
||||
firewallClient := litrpc.NewFirewallClient(rawConn)
|
||||
|
||||
// Step 2: Insert one account, one session and one action via RPC.
|
||||
migrationRefs := setupMigrationData(
|
||||
ctxm, t, accountsClient, sessionsClient, autopilotClient,
|
||||
firewallClient,
|
||||
)
|
||||
|
||||
// Step 3: Query and snapshot inserted data via RPC while on bbolt.
|
||||
beforeMigration := queryMigrationData(
|
||||
ctxm, t, accountsClient, sessionsClient, firewallClient,
|
||||
migrationRefs.actionMethod,
|
||||
)
|
||||
|
||||
// Close now so restarts can reopen stores without locks.
|
||||
rawConn.Close()
|
||||
|
||||
// Step 4: Restart with configured backend to trigger migration.
|
||||
err = net.RestartNode(
|
||||
migNode, func() error { return nil }, []LitArgOption{
|
||||
WithLitArg("databasebackend", *litDBBackend),
|
||||
WithLitArg("firewall.request-logger.level", "all"),
|
||||
},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// Setup clients for the restarted node once more.
|
||||
rawConn, err = connectRPC(
|
||||
ctxt, migNode.Cfg.LitAddr(), migNode.Cfg.LitTLSCertPath,
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
defer rawConn.Close()
|
||||
|
||||
accountsClient = litrpc.NewAccountsClient(rawConn)
|
||||
sessionsClient = litrpc.NewSessionsClient(rawConn)
|
||||
firewallClient = litrpc.NewFirewallClient(rawConn)
|
||||
|
||||
// Step 5: Query migrated data via RPC and compare with pre-migration
|
||||
// snapshot.
|
||||
afterMigration := queryMigrationData(
|
||||
ctxm, t, accountsClient, sessionsClient, firewallClient,
|
||||
migrationRefs.actionMethod,
|
||||
)
|
||||
|
||||
// Step 6: Ensure that the results received by RPC prior and after the
|
||||
// migration are equal.
|
||||
assertMigrationSnapshotsEqual(t, beforeMigration, afterMigration)
|
||||
|
||||
// Step 7: Assert migrated data in SQL.
|
||||
assertMinimalMigrationDataSQL(ctxt, t, migNode, migrationRefs)
|
||||
}
|
||||
|
||||
// migrationDataRefs stores stable identifiers used to refetch and assert the
|
||||
// test fixtures before and after migration.
|
||||
type migrationDataRefs struct {
|
||||
accountID string
|
||||
sessionID []byte
|
||||
actionMethod string
|
||||
}
|
||||
|
||||
// migrationDataSnapshot captures the RPC objects for the migration fixtures at
|
||||
// one point in time, so pre/post-migration data can be compared directly.
|
||||
type migrationDataSnapshot struct {
|
||||
account *litrpc.Account
|
||||
session *litrpc.Session
|
||||
action *litrpc.Action
|
||||
}
|
||||
|
||||
// setupMigrationData creates one account, one session and one
|
||||
// action through RPCs only. Note that the function intentionally inserts a
|
||||
// single object into every kvdb database file, which is the minimal dataset
|
||||
// required to verify that data from each database file gets migrated to SQL
|
||||
// when executing the itest.
|
||||
func setupMigrationData(adminCtx context.Context,
|
||||
t *harnessTest,
|
||||
accountsClient litrpc.AccountsClient,
|
||||
sessionsClient litrpc.SessionsClient,
|
||||
autopilotClient litrpc.AutopilotClient,
|
||||
firewallClient litrpc.FirewallClient) migrationDataRefs {
|
||||
|
||||
// 1. Insert an account.
|
||||
accountResp, err := accountsClient.CreateAccount(
|
||||
adminCtx, &litrpc.CreateAccountRequest{
|
||||
AccountBalance: 10_000,
|
||||
ExpirationDate: time.Now().Add(time.Hour).Unix(),
|
||||
Label: "migration-rpc-account",
|
||||
},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// 2. Insert a session.
|
||||
sessionResp, err := sessionsClient.AddSession(
|
||||
adminCtx, &litrpc.AddSessionRequest{
|
||||
Label: "migration-rpc-session",
|
||||
SessionType: litrpc.SessionType_TYPE_MACAROON_ADMIN,
|
||||
ExpiryTimestampSeconds: uint64(
|
||||
time.Now().Add(30 * time.Minute).Unix(),
|
||||
),
|
||||
MailboxServerAddr: mailboxServerAddr,
|
||||
},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// 3. Insert an action.
|
||||
_, err = autopilotClient.ListAutopilotFeatures(
|
||||
adminCtx, &litrpc.ListAutopilotFeaturesRequest{},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// Note that this function intentionally uses the ListAutopilotFeatures
|
||||
// method, as that then becomes easily queryable. As the
|
||||
// firewall.request-logger.level=all config option is used for this
|
||||
// test, more than one action will be created during its execution.
|
||||
// Therefore, using this specific method makes it easy to query this
|
||||
// specific action added below.
|
||||
actionMethod := "/litrpc.Autopilot/ListAutopilotFeatures"
|
||||
actionsResp, err := firewallClient.ListActions(
|
||||
adminCtx, &litrpc.ListActionsRequest{
|
||||
MethodName: actionMethod,
|
||||
StartTimestamp: uint64(time.Now().Unix()),
|
||||
MaxNumActions: 1,
|
||||
Reversed: true,
|
||||
},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
require.Len(t.t, actionsResp.Actions, 1)
|
||||
|
||||
return migrationDataRefs{
|
||||
accountID: accountResp.Account.Id,
|
||||
sessionID: sessionResp.Session.Id,
|
||||
actionMethod: actionMethod,
|
||||
}
|
||||
}
|
||||
|
||||
// queryMigrationData fetches the migration fixtures via RPC.
|
||||
func queryMigrationData(adminCtx context.Context, t *harnessTest,
|
||||
accountsClient litrpc.AccountsClient,
|
||||
sessionsClient litrpc.SessionsClient,
|
||||
firewallClient litrpc.FirewallClient,
|
||||
actionMethod string) migrationDataSnapshot {
|
||||
|
||||
accountsResp, err := accountsClient.ListAccounts(
|
||||
adminCtx, &litrpc.ListAccountsRequest{},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
require.Len(t.t, accountsResp.Accounts, 1)
|
||||
|
||||
sessionsResp, err := sessionsClient.ListSessions(
|
||||
adminCtx, &litrpc.ListSessionsRequest{},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
require.Len(t.t, sessionsResp.Sessions, 1)
|
||||
|
||||
actionsResp, err := firewallClient.ListActions(
|
||||
adminCtx, &litrpc.ListActionsRequest{
|
||||
MethodName: actionMethod,
|
||||
Reversed: true,
|
||||
},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
require.Len(t.t, actionsResp.Actions, 1)
|
||||
|
||||
return migrationDataSnapshot{
|
||||
account: accountsResp.Accounts[0],
|
||||
session: sessionsResp.Sessions[0],
|
||||
action: actionsResp.Actions[0],
|
||||
}
|
||||
}
|
||||
|
||||
// assertMigrationSnapshotsEqual asserts that the post-migration RPC
|
||||
// snapshot matches the pre-migration RPC snapshot. The session comparison
|
||||
// applies a focused normalization for known kvdb vs SQL macaroon recipe
|
||||
// representation differences.
|
||||
func assertMigrationSnapshotsEqual(t *harnessTest,
|
||||
before migrationDataSnapshot,
|
||||
after migrationDataSnapshot) {
|
||||
|
||||
require.NotNil(t.t, before.account)
|
||||
require.NotNil(t.t, before.session)
|
||||
require.NotNil(t.t, before.action)
|
||||
require.NotNil(t.t, after.account)
|
||||
require.NotNil(t.t, after.session)
|
||||
require.NotNil(t.t, after.action)
|
||||
|
||||
// As a nil macaroon recipe will be represented differently in kvdb vs
|
||||
// SQL dbs, we need to override that field in the session.
|
||||
overrideRPCMacaroonRecipe(before.session, after.session)
|
||||
|
||||
require.Equal(t.t, before.account, after.account)
|
||||
require.Equal(t.t, before.session, after.session)
|
||||
require.Equal(t.t, before.action, after.action)
|
||||
}
|
||||
|
||||
// overrideRPCMacaroonRecipe normalizes the one known RPC representation
|
||||
// mismatch in this test: kvdb can return a non-nil MacaroonRecipe while SQL can
|
||||
// return nil for equivalent empty recipe data.
|
||||
func overrideRPCMacaroonRecipe(kvSession *litrpc.Session,
|
||||
sqlSession *litrpc.Session) {
|
||||
|
||||
if kvSession == nil || sqlSession == nil {
|
||||
return
|
||||
}
|
||||
|
||||
// Normalize SQL nil vs empty recipe when kvdb had an explicit empty
|
||||
// macaroon recipe.
|
||||
if kvSession.MacaroonRecipe != nil && sqlSession.MacaroonRecipe == nil {
|
||||
sqlSession.MacaroonRecipe = &litrpc.MacaroonRecipe{}
|
||||
}
|
||||
}
|
||||
|
||||
// assertMinimalMigrationDataSQL checks that migration fixtures are available
|
||||
// through SQL-backed stores after migration. Note that the SQL assertion is
|
||||
// only intended to verify that an entry for the respective inserted object
|
||||
// exists in the database, and not that all fields are the same. Test coverage
|
||||
// for that has already been implemented in unit tests, which is responsible for
|
||||
// those assertions.
|
||||
func assertMinimalMigrationDataSQL(ctx context.Context, t *harnessTest,
|
||||
node *HarnessNode, data migrationDataRefs) {
|
||||
|
||||
sqlStore := openMigrationSQLStore(t, node)
|
||||
defer sqlStore.Close()
|
||||
|
||||
queries := sqlcmig6.NewForType(sqlStore, sqlStore.BackendType)
|
||||
|
||||
accountsList, err := queries.ListAllAccounts(ctx)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
require.Len(t.t, accountsList, 1)
|
||||
dbAccount := accountsList[0]
|
||||
|
||||
alias, err := accounts.AccountIDFromInt64(dbAccount.Alias)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
require.Equal(t.t, data.accountID, alias.String())
|
||||
|
||||
sessions, err := queries.ListSessions(ctx)
|
||||
require.NoError(t.t, err)
|
||||
require.Len(t.t, sessions, 1)
|
||||
|
||||
dbSession := sessions[0]
|
||||
require.Equal(t.t, data.sessionID, dbSession.Alias)
|
||||
|
||||
actionStore := firewalldb.NewSQLDB(
|
||||
sqlStore, sqlc.NewForType(sqlStore, sqlStore.BackendType),
|
||||
clock.NewDefaultClock(),
|
||||
)
|
||||
actions, _, _, err := actionStore.ListActions(
|
||||
ctx, nil, firewalldb.WithActionMethodName(data.actionMethod),
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
require.NotEmpty(t.t, actions)
|
||||
require.Len(t.t, actions, 1)
|
||||
|
||||
require.Equal(t.t, data.actionMethod, actions[0].RPCMethod)
|
||||
}
|
||||
|
||||
// openMigrationSQLStore opens a SQL database handle for the backend selected
|
||||
// by the itest `-litdbbackend` flag.
|
||||
//
|
||||
// The migration test starts on bbolt and then restarts litd with
|
||||
// `-litdbbackend=<backend>` to trigger kvdb -> SQL migration. This helper
|
||||
// mirrors that backend choice and opens the matching SQL store so the test can
|
||||
// assert migrated rows directly:
|
||||
// - `sqlite`: opens the node-local `litd.db` SQLite file.
|
||||
// - `postgres`: opens the configured Postgres database from the node config.
|
||||
//
|
||||
// The returned value is always a `*sqldb.BaseDB`, independent of which SQL
|
||||
// implementation is used underneath.
|
||||
func openMigrationSQLStore(t *harnessTest,
|
||||
node *HarnessNode) *sqldb.BaseDB {
|
||||
|
||||
switch *litDBBackend {
|
||||
case terminal.DatabaseBackendPostgres:
|
||||
pgConf := node.Cfg.PostgresConfig
|
||||
|
||||
require.NotNil(
|
||||
t.t, pgConf,
|
||||
"postgres config required for postgres backend",
|
||||
)
|
||||
|
||||
sqlStore, err := sqldb.NewPostgresStore(
|
||||
&sqldb.PostgresConfig{
|
||||
Dsn: pgConf.DSN(false),
|
||||
SkipMigrations: true,
|
||||
RequireSSL: pgConf.RequireSSL,
|
||||
MaxOpenConnections: pgConf.MaxOpenConnections,
|
||||
MaxIdleConnections: pgConf.MaxIdleConnections,
|
||||
ConnMaxLifetime: pgConf.ConnMaxLifetime,
|
||||
ConnMaxIdleTime: pgConf.ConnMaxIdleTime,
|
||||
},
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
return sqlStore.BaseDB
|
||||
|
||||
case terminal.DatabaseBackendSqlite:
|
||||
dbPath := filepath.Join(
|
||||
node.Cfg.LitDir, node.Cfg.NetParams.Name, "litd.db",
|
||||
)
|
||||
|
||||
sqlStore, err := sqldb.NewSqliteStore(
|
||||
&sqldb.SqliteConfig{
|
||||
SkipMigrations: true,
|
||||
SkipMigrationDbBackup: true,
|
||||
}, dbPath,
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
return sqlStore.BaseDB
|
||||
|
||||
default:
|
||||
t.t.Fatalf("unsupported sql backend %v", *litDBBackend)
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
|
@ -23,6 +23,10 @@ var allTestCases = []*testCase{
|
|||
name: "terminal large http header",
|
||||
test: testLargeHttpHeader,
|
||||
},
|
||||
{
|
||||
name: "kvdb to sql migration",
|
||||
test: testKvdbSQLMigration,
|
||||
},
|
||||
{
|
||||
name: "custom channels",
|
||||
test: testCustomChannels,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue