f - firewalldb: actions mig handle empty RPCParamsJson

Author: ViktorT-11

firewalldb/sql_migration_test.go

@@ -1249,9 +1249,12 @@ func randomPrivacyPairs(t *testing.T, ctx context.Context,
 // actionNoSessionOrAccount adds an action which is not linked to any session or
 // account.
 func actionNoSessionOrAccount(t *testing.T, ctx context.Context,
-	boltDB *BoltDB, _ session.Store, _ accounts.Store,
+	boltDB *BoltDB, _ session.Store, acctStore accounts.Store,
 	rStore *rootKeyMockStore) *expectedResult {
 
+	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
+	require.True(t, ok)
+
 	// As the action is not linked to any session, we add a random root
 	// key which we use as the macaroon identifier for the action.
 	// This simulates how similar actions would have been created in
@@ -1263,7 +1266,10 @@ func actionNoSessionOrAccount(t *testing.T, ctx context.Context,
 	actionReq.SessionID = fn.None[session.ID]()
 	actionReq.AccountID = fn.None[accounts.AccountID]()
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1274,9 +1280,12 @@ func actionNoSessionOrAccount(t *testing.T, ctx context.Context,
 
 // actionEmptyRPCParamsJson adds an action which has no RPCParamsJson set.
 func actionEmptyRPCParamsJson(t *testing.T, ctx context.Context,
-	boltDB *BoltDB, _ session.Store, _ accounts.Store,
+	boltDB *BoltDB, _ session.Store, acctStore accounts.Store,
 	rStore *rootKeyMockStore) *expectedResult {
 
+	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
+	require.True(t, ok)
+
 	// As the action is not linked to any session, we add a random root
 	// key which we use as the macaroon identifier for the action.
 	// This simulates how similar actions would have been created in
@@ -1289,7 +1298,10 @@ func actionEmptyRPCParamsJson(t *testing.T, ctx context.Context,
 	actionReq.AccountID = fn.None[accounts.AccountID]()
 	actionReq.RPCParamsJson = []byte{}
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1301,12 +1313,15 @@ func actionEmptyRPCParamsJson(t *testing.T, ctx context.Context,
 // actionWithSessionNoAccount adds an action which is linked a session but no
 // account.
 func actionWithSessionNoAccount(t *testing.T, ctx context.Context,
-	boltDB *BoltDB, sessStore session.Store, _ accounts.Store,
+	boltDB *BoltDB, sessStore session.Store, acctStore accounts.Store,
 	rStore *rootKeyMockStore) *expectedResult {
 
 	// Create the session that we will link the action to.
 	sess := testSession(t, ctx, sessStore)
 
+	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
+	require.True(t, ok)
+
 	// To simulate that the action was created with a macaroon identifier
 	// that matches the session ID prefix, we add a root key with an ID
 	// that matches the session ID prefix.
@@ -1318,7 +1333,10 @@ func actionWithSessionNoAccount(t *testing.T, ctx context.Context,
 	actionReq.SessionID = fn.Some(sess.ID)
 	actionReq.AccountID = fn.None[accounts.AccountID]()
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1332,15 +1350,21 @@ func actionWithSessionNoAccount(t *testing.T, ctx context.Context,
 // therefore couldn't have been linked to the action. Such sessions are filtered
 // out during the migration.
 func actionsWithFilteredSession(t *testing.T, ctx context.Context,
-	boltDB *BoltDB, sessStore session.Store, _ accounts.Store,
+	boltDB *BoltDB, sessStore session.Store, acctStore accounts.Store,
 	rStore *rootKeyMockStore) *expectedResult {
 
+	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
+	require.True(t, ok)
+
 	var actions []*Action
 
 	// addActionFromReq is a helper function that adds an action from the
 	// passed request, and appends the added action to the actions slice.
 	addActionFromReq := func(req AddActionReq) {
-		actions = append(actions, addAction(t, ctx, boltDB, &req))
+		actions = append(actions, addAction(
+			t, ctx, boltDB, &req,
+			acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+		))
 	}
 
 	// First, we add an already expired session, as this should be filtered
@@ -1395,6 +1419,9 @@ func actionWithSessionWithLinkedAccount(t *testing.T, ctx context.Context,
 	boltDB *BoltDB, sessStore session.Store, acctStore accounts.Store,
 	rStore *rootKeyMockStore) *expectedResult {
 
+	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
+	require.True(t, ok)
+
 	// Add a session with a linked account.
 	sess, acct, _ := testSessionWithAccount(
 		t, ctx, sessStore, acctStore,
@@ -1410,7 +1437,10 @@ func actionWithSessionWithLinkedAccount(t *testing.T, ctx context.Context,
 	actionReq.SessionID = fn.Some(sess.ID)
 	actionReq.AccountID = fn.Some(acct.ID)
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1424,6 +1454,9 @@ func actionWithAccount(t *testing.T, ctx context.Context,
 	boltDB *BoltDB, _ session.Store, acctStore accounts.Store,
 	rStore *rootKeyMockStore) *expectedResult {
 
+	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
+	require.True(t, ok)
+
 	// Create the account that we will link the action to.
 	acct, _ := testAccount(t, ctx, acctStore)
 
@@ -1439,7 +1472,10 @@ func actionWithAccount(t *testing.T, ctx context.Context,
 	actionReq.SessionID = fn.None[session.ID]()
 	actionReq.AccountID = fn.Some(acct.ID)
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1456,12 +1492,18 @@ func actionsWithFilteredAccount(t *testing.T, ctx context.Context,
 	boltDB *BoltDB, _ session.Store, acctStore accounts.Store,
 	rStore *rootKeyMockStore) *expectedResult {
 
+	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
+	require.True(t, ok)
+
 	var actions []*Action
 
 	// addActionFromReq is a helper function that adds an action from the
 	// passed request, and appends the added action to the actions slice.
 	addActionFromReq := func(req AddActionReq) {
-		actions = append(actions, addAction(t, ctx, boltDB, &req))
+		actions = append(actions, addAction(
+			t, ctx, boltDB, &req,
+			acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+		))
 	}
 
 	// First, we add an already expired account, as this should be filtered
@@ -1584,7 +1626,10 @@ func actionWithMultipleAccounts(t *testing.T, ctx context.Context,
 	// expiry should be linked to the action. In our case, that's acct2.
 	actionReq.AccountID = fn.Some(newAcct2ID)
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1645,7 +1690,10 @@ func actionWithSessionAndAccount(t *testing.T, ctx context.Context,
 	actionReq.SessionID = fn.Some(sess.ID)
 	actionReq.AccountID = fn.None[accounts.AccountID]()
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.Backend() == sqlc.BackendTypeSqlite,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1712,7 +1760,10 @@ func actionWithSessionWithLinkedAccountAndAccount(t *testing.T,
 	actionReq.SessionID = fn.Some(sess.ID)
 	actionReq.AccountID = fn.Some(acct1.ID)
 
-	action := addAction(t, ctx, boltDB, &actionReq)
+	action := addAction(
+		t, ctx, boltDB, &actionReq,
+		acctSqlStore.BaseDB.Backend() == sqlc.BackendTypePostgres,
+	)
 
 	return &expectedResult{
 		kvEntries: []*kvEntry{},
@@ -1732,6 +1783,8 @@ func randomActions(t *testing.T, ctx context.Context, boltDB *BoltDB,
 	acctSqlStore, ok := acctStore.(*accounts.SQLStore)
 	require.True(t, ok)
 
+	isSqlite := acctSqlStore.BaseDB.Backend() == sqlc.BackendTypeSqlite
+
 	for i := 0; i < numActions; i++ {
 		rJson, err := randomJSON(rand.Intn(20))
 		require.NoError(t, err)
@@ -1918,7 +1971,7 @@ func randomActions(t *testing.T, ctx context.Context, boltDB *BoltDB,
 
 		// 4) Set the actions session and account IDs to match what we
 		//    expect the migrated action to look like.
-		action := addAction(t, ctx, boltDB, &actionReq)
+		action := addAction(t, ctx, boltDB, &actionReq, isSqlite)
 
 		// Append the action to the list of expected actions.
 		actions = append(actions, action)
@@ -1961,7 +2014,7 @@ func randomFirewallDBEntries(t *testing.T, ctx context.Context,
 // they are expected to be set to after the boltDB action has been migrated to
 // SQL.
 func addAction(t *testing.T, ctx context.Context, boltDB *BoltDB,
-	actionReq *AddActionReq) *Action {
+	actionReq *AddActionReq, isSqliteTest bool) *Action {
 
 	// We add one second to the clock prior to adding the action, just to
 	// ensure that the action timestamp is always after the creation time
@@ -1998,10 +2051,11 @@ func addAction(t *testing.T, ctx context.Context, boltDB *BoltDB,
 	action.MacaroonRootKeyID = actionReq.MacaroonRootKeyID
 
 	// In case the actionReq's RPCParamsJson wasn't set, we need to set the
-	// expected action's RPCParamsJson to nil as that's how such
-	// RPCParamsJson are represented in the SQL database, when the returned
-	// expected action should reflect.
-	if len(actionReq.RPCParamsJson) == 0 {
+	// expected action's RPCParamsJson to nil for Sqlite tests as that's
+	// how such RPCParamsJson are represented in the Sqlite database, which
+	// the returned expected action should reflect. Note that for Postgres
+	// dbs, this param is stored as an empty array and not nil.
+	if len(actionReq.RPCParamsJson) == 0 && isSqliteTest {
 		action.RPCParamsJson = nil
 	}