Skip to content

chore: Use contexts with timeout in coderd tests #3381

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Aug 9, 2022
Merged

chore: Use contexts with timeout in coderd tests #3381

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c352a07
chore: Use contexts with timeout in `coderd` tests
mafredri Aug 4, 2022
4f7e32e
fix: Speed up TestPaginatedUsers by creating users concurrently
mafredri Aug 4, 2022
ae17114
fix: Bump timeout even more, add individual timeout for assert
mafredri Aug 4, 2022
d76d9ca
chore: Convert into table based test with subtests
mafredri Aug 4, 2022
421e52d
chore: Add nolint
mafredri Aug 4, 2022
0a7642c
chore: Speed up TestPaginatedTemplateVersions via errgroup
mafredri Aug 4, 2022
e3ad325
chore: Manually check template version to control timeout
mafredri Aug 4, 2022
8f5213d
fix: Use testutil constants
mafredri Aug 4, 2022
3774fb1
fix: Whoops
mafredri Aug 4, 2022
98b89ba
chore: Increase assert pagination timeout
mafredri Aug 4, 2022
52d480c
Merge branch 'main' into mafredri/coderd-test-timeouts
mafredri Aug 4, 2022
0ac5fac
Merge branch 'main' into mafredri/coderd-test-timeouts
mafredri Aug 5, 2022
1b99e0b
Merge branch 'main' into mafredri/coderd-test-timeouts
mafredri Aug 5, 2022
b7600aa
Merge branch 'main' into mafredri/coderd-test-timeouts
mafredri Aug 9, 2022
f770c21
Update coderd/templateversions_test.go
mafredri Aug 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: Convert into table based test with subtests
  • Loading branch information
@mafredri
mafredri committed Aug 4, 2022
commit d76d9ca868f55e2cbf19c711d1f911ae5949490c
46 changes: 29 additions & 17 deletions coderd/users_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1095,8 +1095,8 @@ func TestPaginatedUsers(t *testing.T) {
client := coderdtest.New(t, &coderdtest.Options{APIRateLimit: -1})
coderdtest.CreateFirstUser(t, client)

// This test can take longer than a long time.
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong*4)
// This test takes longer than a long time.
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong*2)
defer cancel()

me, err := client.User(ctx, codersdk.Me)
Expand Down Expand Up @@ -1153,25 +1153,41 @@ func TestPaginatedUsers(t *testing.T) {
sortUsers(allUsers)
sortUsers(specialUsers)

assertPagination(ctx, t, client, 10, allUsers, nil)
assertPagination(ctx, t, client, 5, allUsers, nil)
assertPagination(ctx, t, client, 3, allUsers, nil)
assertPagination(ctx, t, client, 1, allUsers, nil)

// Try a search
gmailSearch := func(request codersdk.UsersRequest) codersdk.UsersRequest {
request.Search = "gmail"
return request
}
assertPagination(ctx, t, client, 3, specialUsers, gmailSearch)
assertPagination(ctx, t, client, 7, specialUsers, gmailSearch)

usernameSearch := func(request codersdk.UsersRequest) codersdk.UsersRequest {
request.Search = "specialuser"
return request
}
assertPagination(ctx, t, client, 3, specialUsers, usernameSearch)
assertPagination(ctx, t, client, 1, specialUsers, usernameSearch)

tests := []struct {
name string
limit int
allUsers []codersdk.User
opt func(request codersdk.UsersRequest) codersdk.UsersRequest
}{
{name: "all users", limit: 10, allUsers: allUsers},
{name: "all users", limit: 5, allUsers: allUsers},
{name: "all users", limit: 3, allUsers: allUsers},
{name: "all users", limit: 1, allUsers: allUsers},
{name: "gmail search", limit: 3, allUsers: specialUsers, opt: gmailSearch},
{name: "gmail search", limit: 7, allUsers: specialUsers, opt: gmailSearch},
{name: "username search", limit: 3, allUsers: specialUsers, opt: usernameSearch},
{name: "username search", limit: 3, allUsers: specialUsers, opt: usernameSearch},
}
for _, tt := range tests {
tt := tt
t.Run(fmt.Sprintf("%s %d", tt.name, tt.limit), func(t *testing.T) {
t.Parallel()

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

assertPagination(ctx, t, client, tt.limit, tt.allUsers, tt.opt)
})
}
}

// Assert pagination will page through the list of all users using the given
Expand All @@ -1180,10 +1196,6 @@ func TestPaginatedUsers(t *testing.T) {
func assertPagination(ctx context.Context, t *testing.T, client *codersdk.Client, limit int, allUsers []codersdk.User,
opt func(request codersdk.UsersRequest) codersdk.UsersRequest,
) {
// Ensure any single assertion doesn't take too long.s
ctx, cancel := context.WithTimeout(ctx, testutil.WaitLong)
defer cancel()

var count int
if opt == nil {
opt = func(request codersdk.UsersRequest) codersdk.UsersRequest {
Expand Down