- Notifications
You must be signed in to change notification settings - Fork1k
test: start migrating dbauthz tests to mocked db#19257
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+186 −17
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
28 changes: 15 additions & 13 deletionscoderd/database/dbauthz/dbauthz_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -11,9 +11,11 @@ import ( | ||
| "testing" | ||
| "time" | ||
| "github.com/brianvoe/gofakeit/v7" | ||
| "github.com/google/uuid" | ||
| "github.com/sqlc-dev/pqtype" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/mock/gomock" | ||
| "golang.org/x/xerrors" | ||
| "cdr.dev/slog" | ||
| @@ -22,6 +24,7 @@ import ( | ||
| "github.com/coder/coder/v2/coderd/database/db2sdk" | ||
| "github.com/coder/coder/v2/coderd/database/dbauthz" | ||
| "github.com/coder/coder/v2/coderd/database/dbgen" | ||
| "github.com/coder/coder/v2/coderd/database/dbmock" | ||
| "github.com/coder/coder/v2/coderd/database/dbtestutil" | ||
| "github.com/coder/coder/v2/coderd/database/dbtime" | ||
| "github.com/coder/coder/v2/coderd/notifications" | ||
| @@ -204,14 +207,15 @@ func defaultIPAddress() pqtype.Inet { | ||
| } | ||
| func (s *MethodTestSuite) TestAPIKey() { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 🙌 | ||
| s.Run("DeleteAPIKeyByID", s.Mocked(func(dbm *dbmock.MockStore, faker *gofakeit.Faker, check *expects) { | ||
| key := testutil.Fake(s.T(), faker, database.APIKey{}) | ||
| dbm.EXPECT().GetAPIKeyByID(gomock.Any(), key.ID).Return(key, nil).AnyTimes() | ||
| dbm.EXPECT().DeleteAPIKeyByID(gomock.Any(), key.ID).Return(nil).AnyTimes() | ||
| check.Args(key.ID).Asserts(key, policy.ActionDelete).Returns() | ||
| })) | ||
| s.Run("GetAPIKeyByID", s.Mocked(func(dbm *dbmock.MockStore, faker *gofakeit.Faker, check *expects) { | ||
| key := testutil.Fake(s.T(),faker, database.APIKey{}) | ||
| dbm.EXPECT().GetAPIKeyByID(gomock.Any(),key.ID).Return(key, nil).AnyTimes() | ||
| check.Args(key.ID).Asserts(key, policy.ActionRead).Returns(key) | ||
| })) | ||
| s.Run("GetAPIKeyByName", s.Subtest(func(db database.Store, check *expects) { | ||
| @@ -234,14 +238,12 @@ func (s *MethodTestSuite) TestAPIKey() { | ||
| Asserts(a, policy.ActionRead, b, policy.ActionRead). | ||
| Returns(slice.New(a, b)) | ||
| })) | ||
| s.Run("GetAPIKeysByUserID", s.Mocked(func(dbm *dbmock.MockStore, faker *gofakeit.Faker, check *expects) { | ||
| u1 := testutil.Fake(s.T(), faker, database.User{}) | ||
| keyA := testutil.Fake(s.T(), faker, database.APIKey{UserID: u1.ID, LoginType: database.LoginTypeToken, TokenName: "key-a"}) | ||
| keyB := testutil.Fake(s.T(), faker, database.APIKey{UserID: u1.ID, LoginType: database.LoginTypeToken, TokenName: "key-b"}) | ||
| dbm.EXPECT().GetAPIKeysByUserID(gomock.Any(), gomock.Any()).Return(slice.New(keyA, keyB), nil).AnyTimes() | ||
| check.Args(database.GetAPIKeysByUserIDParams{LoginType: database.LoginTypeToken, UserID: u1.ID}). | ||
| Asserts(keyA, policy.ActionRead, keyB, policy.ActionRead). | ||
| Returns(slice.New(keyA, keyB)) | ||
34 changes: 30 additions & 4 deletionscoderd/database/dbauthz/setup_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionsgo.mod
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletionsgo.sum
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletionstestutil/faker.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package testutil | ||
| import ( | ||
| "reflect" | ||
| "testing" | ||
| "github.com/brianvoe/gofakeit/v7" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
| // Fake will populate any zero fields in the provided struct with fake data. | ||
| // Non-zero fields will remain unchanged. | ||
| // Usage: | ||
| // | ||
| //key := Fake(t, faker, database.APIKey{ | ||
| // TokenName: "keep-my-name", | ||
| //}) | ||
| func Fake[T any](t *testing.T, faker *gofakeit.Faker, seed T) T { | ||
| t.Helper() | ||
| var tmp T | ||
| err := faker.Struct(&tmp) | ||
| require.NoError(t, err, "failed to generate fake data for type %T", tmp) | ||
| mergeZero(&seed, tmp) | ||
| return seed | ||
| } | ||
| // mergeZero merges the fields of src into dst, but only if the field in dst is | ||
| // currently the zero value. | ||
| // Make sure `dst` is a pointer to a struct, otherwise the fields are not assignable. | ||
| func mergeZero(dst any, src any) { | ||
| srcv := reflect.ValueOf(src) | ||
| if srcv.Kind() == reflect.Ptr { | ||
| srcv = srcv.Elem() | ||
| } | ||
| remain := [][2]reflect.Value{ | ||
| {reflect.ValueOf(dst).Elem(), srcv}, | ||
| } | ||
| // Traverse the struct fields and set them only if they are currently zero. | ||
| // This is a breadth-first traversal of the struct fields. Struct definitions | ||
| // Should not be that deep, so we should not hit any stack overflow issues. | ||
| for { | ||
| if len(remain) == 0 { | ||
| return | ||
| } | ||
| dv, sv := remain[0][0], remain[0][1] | ||
| remain = remain[1:] // | ||
| for i := 0; i < dv.NumField(); i++ { | ||
| df := dv.Field(i) | ||
| sf := sv.Field(i) | ||
| if !df.CanSet() { | ||
| continue | ||
| } | ||
| if df.IsZero() { // only write if currently zero | ||
| df.Set(sf) | ||
| continue | ||
| } | ||
| if dv.Field(i).Kind() == reflect.Struct { | ||
| // If the field is a struct, we need to traverse it as well. | ||
| remain = append(remain, [2]reflect.Value{df, sf}) | ||
| } | ||
| } | ||
| } | ||
| } |
71 changes: 71 additions & 0 deletionstestutil/faker_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| package testutil_test | ||
| import ( | ||
| "testing" | ||
| "github.com/brianvoe/gofakeit/v7" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/testutil" | ||
| ) | ||
| type simpleStruct struct { | ||
| ID uuid.UUID | ||
| Name string | ||
| Description string | ||
| Age int `fake:"{number:18,60}"` | ||
| } | ||
| type nestedStruct struct { | ||
| Person simpleStruct | ||
| Address string | ||
| } | ||
| func TestFake(t *testing.T) { | ||
| t.Parallel() | ||
| t.Run("Simple", func(t *testing.T) { | ||
| t.Parallel() | ||
| faker := gofakeit.New(0) | ||
| person := testutil.Fake(t, faker, simpleStruct{ | ||
| Name: "alice", | ||
| }) | ||
| require.Equal(t, "alice", person.Name) | ||
| require.NotEqual(t, uuid.Nil, person.ID) | ||
| require.NotEmpty(t, person.Description) | ||
| require.Greater(t, person.Age, 17, "Age should be greater than 17") | ||
| require.Less(t, person.Age, 61, "Age should be less than 61") | ||
| }) | ||
| t.Run("Nested", func(t *testing.T) { | ||
| t.Parallel() | ||
| faker := gofakeit.New(0) | ||
| person := testutil.Fake(t, faker, nestedStruct{ | ||
| Person: simpleStruct{ | ||
| Name: "alice", | ||
| }, | ||
| }) | ||
| require.Equal(t, "alice", person.Person.Name) | ||
| require.NotEqual(t, uuid.Nil, person.Person.ID) | ||
| require.NotEmpty(t, person.Person.Description) | ||
| require.Greater(t, person.Person.Age, 17, "Age should be greater than 17") | ||
| require.NotEmpty(t, person.Address) | ||
| }) | ||
| t.Run("DatabaseType", func(t *testing.T) { | ||
| t.Parallel() | ||
| faker := gofakeit.New(0) | ||
| id := uuid.New() | ||
| key := testutil.Fake(t, faker, database.APIKey{ | ||
| UserID: id, | ||
| TokenName: "keep-my-name", | ||
| }) | ||
| require.Equal(t, id, key.UserID) | ||
| require.NotEmpty(t, key.TokenName) | ||
| }) | ||
| } |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.