Clean up after Client deletion, finish cleaning up after Profile deletion.
6f473576c6ae started cleaning up after Profiles when they're deleted, but
didn't clean up the Clients created by that Profile. This fixes that, and also
fixes a BUG note about cleaning up after a Client when it's deleted.
Extend the authorizationCodeStore to have a deleteAuthorizationCodesByClientID
method that will delete the AuthorizationCodes that have been granted by the
Client specified by the passed ID. We also implemented this in memstore and
postgres, so tests continue to pass.
Extend the clientStore to have a deleteClientsByOwner method that will delete
the Clients that were created by the Profile specified by the passed ID. We also
implemented this in memstore and postgres, so tests continue to pass.
Extend the clientStore to have a removeEndpointsByClientID method that will
delete the Endpoints that belong(ed) to a the Client specified by the passed ID.
We also implemented this in memstore and postgres, so tests continue to pass.
Extend the tokenStore to have a revokeTokensByClientID method that will revoke
all the Tokens that were granted to the Client specified by the passed ID. We
also implemented this in memstore and postgres, so tests continue to pass.
When listing Clients by their owner, allow setting the num argument (which
controls how many to return) to 0 or lower, and using that to signal "return all
Clients belonging to this owner", instead of paging. This is useful when
deleting the Clients belonging to a Profile as part of the cleanup after
deleting the Profile.
Create a cleanUpAfterClientDeletion helper function that will delete the
Endpoints and AuthorizationCodes belonging to a Client, and revoke the Tokens
belonging to a Client, as part of cleaning up after a Client has been deleted.
Add a check in the handler for listing Clients owned by a Profile to disallow
the num argument to be lower than 1, because the API should be forced to page.
Call our cleanUpAfterClientDeletion once the Client has been deleted in the
appropriate handler.
Fill out our Context with new methods to wrap all the new methods we're adding
to our *Stores.
In cleanUpAfterProfileDeletion, obtain a list of clients belonging to the owner,
use our new DeleteClientsByOwner method to remove all of them, and then use the
list to run our new cleanUpAfterClientDeletion function to clear away the final
remnants of a Profile when it's deleted.
8 "code.secondbit.org/uuid.hg"
12 if os.Getenv("PG_TEST_DB") != "" {
13 p, err := NewPostgres(os.Getenv("PG_TEST_DB"))
17 sessionStores = append(sessionStores, &p)
21 var sessionStores = []sessionStore{NewMemstore()}
23 func compareSessions(session1, session2 Session) (success bool, field string, val1, val2 interface{}) {
24 if session1.ID != session2.ID {
25 return false, "ID", session1.ID, session2.ID
27 if session1.IP != session2.IP {
28 return false, "IP", session1.IP, session2.IP
30 if session1.UserAgent != session2.UserAgent {
31 return false, "UserAgent", session1.UserAgent, session2.UserAgent
33 if !session1.ProfileID.Equal(session2.ProfileID) {
34 return false, "ProfileID", session1.ProfileID, session2.ProfileID
36 if !session1.Created.Equal(session2.Created) {
37 return false, "Created", session1.Created, session2.Created
39 if !session1.Expires.Equal(session2.Expires) {
40 return false, "Expires", session1.Expires, session2.Expires
42 if session1.Login != session2.Login {
43 return false, "Login", session1.Login, session2.Login
45 if session1.Active != session2.Active {
46 return false, "Active", session1.Active, session2.Active
48 if session1.CSRFToken != session2.CSRFToken {
49 return false, "CSRFToken", session1.CSRFToken, session2.CSRFToken
51 return true, "", nil, nil
54 func TestSessionStoreSuccess(t *testing.T) {
57 ID: uuid.NewID().String() + uuid.NewID().String(),
59 UserAgent: "TestRunner",
60 ProfileID: uuid.NewID(),
61 Created: time.Now().Round(time.Millisecond),
62 Login: "test@example.com",
65 for _, store := range sessionStores {
66 context := Context{sessions: store}
67 err := context.CreateSession(session)
69 t.Errorf("Error saving session to %T: %s", store, err)
71 err = context.CreateSession(session)
72 if err != ErrSessionAlreadyExists {
73 t.Errorf("Expected ErrSessionAlreadyExists from %T, got %s", store, err)
75 retrieved, err := context.GetSession(session.ID)
77 t.Errorf("Error retrieving session from %T: %s", store, err)
79 success, field, expectation, result := compareSessions(session, retrieved)
81 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
83 retrievedList, err := context.ListSessions(session.ProfileID, time.Time{}, 10)
85 t.Errorf("Error retrieving sessions by profile from %T: %s", store, err)
87 if len(retrievedList) != 1 {
88 t.Errorf("Expected 1 session retrieved by profile from %T, got %d", store, len(retrievedList))
90 success, field, expectation, result = compareSessions(session, retrievedList[0])
92 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
94 err = context.TerminateSession(session.ID)
96 t.Errorf("Error terminating session in %T: %s", store, err)
98 retrieved, err = context.GetSession(session.ID)
100 t.Errorf("Error retrieving session from %T: %s", store, err)
103 expected.Active = false
104 success, field, expectation, result = compareSessions(expected, retrieved)
106 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
108 retrievedList, err = context.ListSessions(session.ProfileID, time.Time{}, 10)
110 t.Errorf("Error retrieving sessions by profile from %T: %s", store, err)
112 if len(retrievedList) != 1 {
113 t.Errorf("Expected 1 session retrieved by profile from %T, got %d", store, len(retrievedList))
115 success, field, expectation, result = compareSessions(expected, retrievedList[0])
117 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
119 err = context.RemoveSession(session.ID)
121 t.Errorf("Error removing session from %T: %s", store, err)
123 retrieved, err = context.GetSession(session.ID)
124 if err != ErrSessionNotFound {
125 t.Errorf("Expected ErrSessionNotFound from %T, got %s", store, err)
127 retrievedList, err = context.ListSessions(session.ProfileID, time.Time{}, 10)
129 t.Errorf("Error retrieving sessions by profile from %T: %s", store, err)
131 if len(retrievedList) != 0 {
132 t.Errorf("Expected 0 sessions retrieved by profile from %T, got %d", store, len(retrievedList))
134 err = context.RemoveSession(session.ID)
135 if err != ErrSessionNotFound {
136 t.Errorf("Expected ErrSessionNotFound from %T, got %s", store, err)
138 err = context.TerminateSession(session.ID)
139 if err != ErrSessionNotFound {
140 t.Errorf("Expected ERrSessionNotFound from %T, got %s", store, err)
145 // BUG(paddy): We need to test the CreateSessionHandler.
146 // BUG(paddy): We need to test the credentialsValidate function.