Skip to content

chore(scaletest/createworkspaces): address context usage #16306

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 2 commits into from
Jan 28, 2025
Merged

chore(scaletest/createworkspaces): address context usage #16306

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5db2d84
chore(scaletest/createworkspaces): address context usage
johnstcn Jan 28, 2025
9e0eb5f
fixup! chore(scaletest/createworkspaces): address context usage
johnstcn Jan 28, 2025
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
74 changes: 34 additions & 40 deletions scaletest/createworkspaces/run_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,22 +249,23 @@ func Test_Runner(t *testing.T) {
},
})

ctx := testutil.Context(t, testutil.WaitLong)
cancelCtx, cancelFunc := context.WithCancel(ctx)
runnerCtx, runnerCancel := context.WithTimeout(context.Background(), testutil.WaitLong)

done := make(chan struct{})
logs := bytes.NewBuffer(nil)
go func() {
err := runner.Run(cancelCtx, "1", logs)
err := runner.Run(runnerCtx, "1", logs)
logsStr := logs.String()
t.Log("Runner logs:\n\n" + logsStr)
require.ErrorIs(t, err, context.Canceled)
close(done)
}()

// Wait for the workspace build job to be picked up.
checkJobStartedCtx := testutil.Context(t, testutil.WaitLong)
jobCh := make(chan codersdk.ProvisionerJob, 1)
require.Eventually(t, func() bool {
workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{})
workspaces, err := client.Workspaces(checkJobStartedCtx, codersdk.WorkspaceFilter{})
if err != nil {
return false
}
Expand All @@ -273,65 +274,58 @@ func Test_Runner(t *testing.T) {
}

ws := workspaces.Workspaces[0]
t.Logf("checking build: %s | %s", ws.LatestBuild.Transition, ws.LatestBuild.Job.Status)
t.Logf("checking build: %s | %s | %s", ws.ID, ws.LatestBuild.Transition, ws.LatestBuild.Job.Status)
// There should be only one build at present.
if ws.LatestBuild.Transition != codersdk.WorkspaceTransitionStart {
t.Errorf("expected build transition %s, got %s", codersdk.WorkspaceTransitionStart, ws.LatestBuild.Transition)
return false
}
return ws.LatestBuild.Job.Status == codersdk.ProvisionerJobRunning
}, testutil.WaitShort, testutil.IntervalMedium)

cancelFunc()
<-done
if ws.LatestBuild.Job.Status != codersdk.ProvisionerJobRunning {
return false
}
jobCh <- ws.LatestBuild.Job
return true
}, testutil.WaitLong, testutil.IntervalSlow)

ctx = testutil.Context(t, testutil.WaitLong) // Reset ctx to avoid timeouts.
t.Log("canceling scaletest workspace creation")
runnerCancel()
<-done
t.Log("canceled scaletest workspace creation")
// Ensure we have a job to interrogate
runningJob := testutil.RequireRecvCtx(testutil.Context(t, testutil.WaitShort), t, jobCh)
require.NotZero(t, runningJob.ID)

// When we run the cleanup, it should be canceled
cleanupLogs := bytes.NewBuffer(nil)
cancelCtx, cancelFunc = context.WithCancel(ctx)
// Reset ctx to avoid timeouts.
cleanupCtx, cleanupCancel := context.WithTimeout(context.Background(), testutil.WaitLong)
done = make(chan struct{})
go func() {
// This will return an error as the "delete" operation will never complete.
_ = runner.Cleanup(cancelCtx, "1", cleanupLogs)
_ = runner.Cleanup(cleanupCtx, "1", cleanupLogs)
close(done)
}()

// Ensure the job has been marked as deleted
// Ensure the job has been marked as canceled
checkJobCanceledCtx := testutil.Context(t, testutil.WaitLong)
require.Eventually(t, func() bool {
workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{})
if err != nil {
pj, err := client.OrganizationProvisionerJob(checkJobCanceledCtx, runningJob.OrganizationID, runningJob.ID)
if !assert.NoError(t, err) {
return false
}

if len(workspaces.Workspaces) == 0 {
return false
}
t.Logf("provisioner job id:%s status:%s", pj.ID, pj.Status)

// There should be two builds
builds, err := client.WorkspaceBuilds(ctx, codersdk.WorkspaceBuildsRequest{
WorkspaceID: workspaces.Workspaces[0].ID,
})
if err != nil {
if pj.Status != codersdk.ProvisionerJobFailed &&
pj.Status != codersdk.ProvisionerJobCanceling &&
pj.Status != codersdk.ProvisionerJobCanceled {
return false
}
for i, build := range builds {
t.Logf("checking build #%d: %s | %s", i, build.Transition, build.Job.Status)
// One of the builds should be for creating the workspace,
if build.Transition != codersdk.WorkspaceTransitionStart {
continue
}

// And it should be either failed (Echo returns an error when job is canceled), canceling, or canceled.
if build.Job.Status == codersdk.ProvisionerJobFailed ||
build.Job.Status == codersdk.ProvisionerJobCanceling ||
build.Job.Status == codersdk.ProvisionerJobCanceled {
return true
}
}
return false
}, testutil.WaitShort, testutil.IntervalMedium)
cancelFunc()

return true
}, testutil.WaitLong, testutil.IntervalSlow)
cleanupCancel()
<-done
cleanupLogsStr := cleanupLogs.String()
require.Contains(t, cleanupLogsStr, "canceling workspace build")
Expand Down
Loading