Break out scopes and events.
This repo has gotten unwieldy, and there are portions of it that need to be
imported by a large number of other packages.
For example, scopes will be used in almost every API we write. Rather than
importing the entirety of this codebase into every API we write, I've opted to
move the scope logic out into a scopes package, with a subpackage for the
defined types, which is all most projects actually want to import.
We also define some event type constants, and importing those shouldn't require
a project to import all our dependencies, either. So I made an events subpackage
that just holds those constants.
This package has become a little bit of a red-headed stepchild and is do for a
refactor, but I'm trying to put that off as long as I can.
The refactoring of our scopes stuff has left a bug wherein a token can be
granted for scopes that don't exist. I'm going to need to revisit that, and also
how to limit scopes to only be granted to the users that should be able to
request them. But that's a battle for another day.
8 "code.secondbit.org/scopes.hg/types"
9 "code.secondbit.org/uuid.hg"
13 if os.Getenv("PG_TEST_DB") != "" {
14 p, err := NewPostgres(os.Getenv("PG_TEST_DB"))
18 tokenStores = append(tokenStores, &p)
22 var tokenStores = []tokenStore{NewMemstore()}
24 func compareTokens(token1, token2 Token) (success bool, field string, val1, val2 interface{}) {
25 if token1.AccessToken != token2.AccessToken {
26 return false, "access token", token1.AccessToken, token2.AccessToken
28 if token1.RefreshToken != token2.RefreshToken {
29 return false, "refresh token", token1.RefreshToken, token2.RefreshToken
31 if !token1.Created.Equal(token2.Created) {
32 return false, "created", token1.Created, token2.Created
34 if token1.CreatedFrom != token2.CreatedFrom {
35 return false, "created from", token1.CreatedFrom, token2.CreatedFrom
37 if token1.ExpiresIn != token2.ExpiresIn {
38 return false, "expires in", token1.ExpiresIn, token2.ExpiresIn
40 if token1.TokenType != token2.TokenType {
41 return false, "token type", token1.TokenType, token2.TokenType
43 if len(token1.Scopes) != len(token2.Scopes) {
44 return false, "scopes", token1.Scopes, token2.Scopes
46 for pos, scope := range token1.Scopes {
47 if scope != token2.Scopes[pos] {
48 return false, "scopes", token1.Scopes, token2.Scopes
51 if !token1.ProfileID.Equal(token2.ProfileID) {
52 return false, "profile ID", token1.ProfileID, token2.ProfileID
54 if token1.Revoked != token2.Revoked {
55 return false, "revoked", token1.Revoked, token2.Revoked
57 return true, "", nil, nil
60 func TestTokenStoreSuccess(t *testing.T) {
63 AccessToken: "access",
64 RefreshToken: "refresh",
65 Created: time.Now().Round(time.Millisecond),
68 Scopes: scopeTypes.StringsToScopes([]string{"scope"}),
69 ProfileID: uuid.NewID(),
71 for _, store := range tokenStores {
72 context := Context{tokens: store}
73 retrievedAccess, err := context.GetToken(token.AccessToken, false)
75 t.Errorf("Expected ErrTokenNotFound from %T, got %+v", store, retrievedAccess)
76 } else if err != ErrTokenNotFound {
77 t.Errorf("Expected ErrTokenNotFound from %T, got %s", store, err)
79 retrievedRefresh, err := context.GetToken(token.RefreshToken, true)
81 t.Errorf("Expected ErrTokenNotFound from %T, got %+v", store, retrievedRefresh)
82 } else if err != ErrTokenNotFound {
83 t.Errorf("Expected ErrTokenNotFound from %T, got %s", store, err)
85 err = context.RevokeToken(token.RefreshToken)
86 if err != ErrTokenNotFound {
87 t.Errorf("Expected ErrTokenNotFound from %T, got %s", store, err)
89 err = context.SaveToken(token)
91 t.Errorf("Error saving token to %T: %s", store, err)
93 err = context.SaveToken(token)
94 if err != ErrTokenAlreadyExists {
95 t.Errorf("Expected ErrTokenAlreadyExists from %T, got %s", store, err)
97 retrievedAccess, err = context.GetToken(token.AccessToken, false)
99 t.Errorf("Error retrieving token from %T: %s", store, err)
101 success, field, expectation, result := compareTokens(token, retrievedAccess)
103 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
105 retrievedRefresh, err = context.GetToken(token.RefreshToken, true)
107 t.Errorf("Error retrieving refresh token from %T: %s", store, err)
109 success, field, expectation, result = compareTokens(token, retrievedRefresh)
111 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
113 retrievedProfile, err := context.GetTokensByProfileID(token.ProfileID, 25, 0)
115 t.Errorf("Error retrieving token by profile from %T: %s", store, err)
117 if len(retrievedProfile) != 1 {
118 t.Errorf("Expected 1 token retrieved by profile ID from %T, got %+v", store, retrievedProfile)
120 success, field, expectation, result = compareTokens(token, retrievedProfile[0])
122 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
124 err = context.RevokeToken(token.RefreshToken)
126 t.Errorf("Error revoking token in %T: %s", store, err)
128 retrievedRevoked, err := context.GetToken(token.AccessToken, false)
130 t.Errorf("Error retrieving token from %T: %s", store, err)
133 success, field, expectation, result = compareTokens(token, retrievedRevoked)
135 t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store)
140 // BUG(paddy): We need to test the refreshTokenValidate function.
141 // BUG(paddy): We need to test the refreshTokenInvalidate function.