session: add a variadic test session creation modifier

So that we can add more modifiers for future tests.

Author: ellemouton

session/store_test.go

@@ -24,10 +24,10 @@ func TestBasicSessionStore(t *testing.T) {
 	})
 
 	// Create a few sessions.
-	s1 := newSession(t, db, clock, "session 1", nil)
-	s2 := newSession(t, db, clock, "session 2", nil)
-	s3 := newSession(t, db, clock, "session 3", nil)
-	s4 := newSession(t, db, clock, "session 4", nil)
+	s1 := newSession(t, db, clock, "session 1")
+	s2 := newSession(t, db, clock, "session 2")
+	s3 := newSession(t, db, clock, "session 3")
+	s4 := newSession(t, db, clock, "session 4")
 
 	// Persist session 1. This should now succeed.
 	require.NoError(t, db.CreateSession(s1))
@@ -101,10 +101,10 @@ func TestLinkingSessions(t *testing.T) {
 	})
 
 	// Create a new session with no previous link.
-	s1 := newSession(t, db, clock, "session 1", nil)
+	s1 := newSession(t, db, clock, "session 1")
 
 	// Create another session and link it to the first.
-	s2 := newSession(t, db, clock, "session 2", &s1.GroupID)
+	s2 := newSession(t, db, clock, "session 2", withLinkedGroupID(&s1.GroupID))
 
 	// Try to persist the second session and assert that it fails due to the
 	// linked session not existing in the DB yet.
@@ -141,9 +141,9 @@ func TestLinkedSessions(t *testing.T) {
 	// after are all linked to the prior one. All these sessions belong to
 	// the same group. The group ID is equivalent to the session ID of the
 	// first session.
-	s1 := newSession(t, db, clock, "session 1", nil)
-	s2 := newSession(t, db, clock, "session 2", &s1.GroupID)
-	s3 := newSession(t, db, clock, "session 3", &s2.GroupID)
+	s1 := newSession(t, db, clock, "session 1")
+	s2 := newSession(t, db, clock, "session 2", withLinkedGroupID(&s1.GroupID))
+	s3 := newSession(t, db, clock, "session 3", withLinkedGroupID(&s2.GroupID))
 
 	// Persist the sessions.
 	require.NoError(t, db.CreateSession(s1))
@@ -169,8 +169,8 @@ func TestLinkedSessions(t *testing.T) {
 
 	// To ensure that different groups don't interfere with each other,
 	// let's add another set of linked sessions not linked to the first.
-	s4 := newSession(t, db, clock, "session 4", nil)
-	s5 := newSession(t, db, clock, "session 5", &s4.GroupID)
+	s4 := newSession(t, db, clock, "session 4")
+	s5 := newSession(t, db, clock, "session 5", withLinkedGroupID(&s4.GroupID))
 
 	require.NotEqual(t, s4.GroupID, s1.GroupID)
 
@@ -209,7 +209,7 @@ func TestCheckSessionGroupPredicate(t *testing.T) {
 	// function is checked correctly.
 
 	// Add a new session to the DB.
-	s1 := newSession(t, db, clock, "label 1", nil)
+	s1 := newSession(t, db, clock, "label 1")
 	require.NoError(t, db.CreateSession(s1))
 
 	// Check that the group passes against an appropriate predicate.
@@ -234,7 +234,7 @@ func TestCheckSessionGroupPredicate(t *testing.T) {
 	require.NoError(t, db.RevokeSession(s1.LocalPublicKey))
 
 	// Add a new session to the same group as the first one.
-	s2 := newSession(t, db, clock, "label 2", &s1.GroupID)
+	s2 := newSession(t, db, clock, "label 2", withLinkedGroupID(&s1.GroupID))
 	require.NoError(t, db.CreateSession(s2))
 
 	// Check that the group passes against an appropriate predicate.
@@ -256,7 +256,7 @@ func TestCheckSessionGroupPredicate(t *testing.T) {
 	require.False(t, ok)
 
 	// Add a new session that is not linked to the first one.
-	s3 := newSession(t, db, clock, "completely different", nil)
+	s3 := newSession(t, db, clock, "completely different")
 	require.NoError(t, db.CreateSession(s3))
 
 	// Ensure that the first group is unaffected.
@@ -286,8 +286,18 @@ func TestCheckSessionGroupPredicate(t *testing.T) {
 	require.True(t, ok)
 }
 
+// testSessionModifier is a functional option that can be used to modify the
+// default test session created by newSession.
+type testSessionModifier func(*Session)
+
+func withLinkedGroupID(groupID *ID) testSessionModifier {
+	return func(s *Session) {
+		s.GroupID = *groupID
+	}
+}
+
 func newSession(t *testing.T, db Store, clock clock.Clock, label string,
-	linkedGroupID *ID) *Session {
+	mods ...testSessionModifier) *Session {
 
 	id, priv, err := db.GetUnusedIDAndKeyPair()
 	require.NoError(t, err)
@@ -296,11 +306,15 @@ func newSession(t *testing.T, db Store, clock clock.Clock, label string,
 		id, priv, label, TypeMacaroonAdmin,
 		clock.Now(),
 		time.Date(99999, 1, 1, 0, 0, 0, 0, time.UTC),
-		"foo.bar.baz:1234", true, nil, nil, nil, true, linkedGroupID,
+		"foo.bar.baz:1234", true, nil, nil, nil, true, nil,
 		[]PrivacyFlag{ClearPubkeys},
 	)
 	require.NoError(t, err)
 
+	for _, mod := range mods {
+		mod(session)
+	}
+
 	return session
 }