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.

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
Changes from 1 commit
Commits
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: Speed up TestPaginatedTemplateVersions via errgroup
  • Loading branch information
mafredri committed Aug 4, 2022
commit 0a7642cb974ee8ba42014facbf721e64ef547d1c
45 changes: 33 additions & 12 deletions coderd/templateversions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"golang.org/x/sync/errgroup"

"github.com/coder/coder/coderd/coderdtest"
"github.com/coder/coder/codersdk"
Expand Down Expand Up @@ -815,25 +816,45 @@ func TestPaginatedTemplateVersions(t *testing.T) {
_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
// This test takes longer than a long time.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It apparently takes even longer than that!

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

// Populate database with template versions.
total := 9
eg, egCtx := errgroup.WithContext(ctx)
templateVersionIDs := make([]uuid.UUID, total)
for i := 0; i < total; i++ {
data, err := echo.Tar(nil)
require.NoError(t, err)
file, err := client.Upload(ctx, codersdk.ContentTypeTar, data)
require.NoError(t, err)
templateVersion, err := client.CreateTemplateVersion(ctx, user.OrganizationID, codersdk.CreateTemplateVersionRequest{
TemplateID: template.ID,
StorageSource: file.Hash,
StorageMethod: codersdk.ProvisionerStorageMethodFile,
Provisioner: codersdk.ProvisionerTypeEcho,
i := i
eg.Go(func() error {
data, err := echo.Tar(nil)
if err != nil {
return err
}
file, err := client.Upload(egCtx, codersdk.ContentTypeTar, data)
if err != nil {
return err
}
templateVersion, err := client.CreateTemplateVersion(egCtx, user.OrganizationID, codersdk.CreateTemplateVersionRequest{
TemplateID: template.ID,
StorageSource: file.Hash,
StorageMethod: codersdk.ProvisionerStorageMethodFile,
Provisioner: codersdk.ProvisionerTypeEcho,
})
if err != nil {
return err
}

templateVersionIDs[i] = templateVersion.ID

return nil
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the sort of thing where it would be really useful to have a mock database and just return some predefined fixture.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very much agreed!

})
require.NoError(t, err)
}
err := eg.Wait()
require.NoError(t, err)

_ = coderdtest.AwaitTemplateVersionJob(t, client, templateVersion.ID)
for _, id := range templateVersionIDs {
_ = coderdtest.AwaitTemplateVersionJob(t, client, id)
}

templateVersions, err := client.TemplateVersionsByTemplate(ctx,
Expand Down