Skip to content

feat: add provisioner daemon name to provisioner jobs responses #17877

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 8 commits into from
May 19, 2025
Prev Previous commit
Next Next commit
test: safely compare WorkerID to avoid nil dereference
  • Loading branch information
ssncferreira committed May 19, 2025
commit 98f3f4dc584bd0eee375fc8336129a766a369aad
26 changes: 17 additions & 9 deletions coderd/provisionerjobs_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ func TestProvisionerJobs(t *testing.T) {

// Ensures that when a provisioner job is in the succeeded state,
// the API response includes both worker_id and worker_name fields
t.Run("AssignedProvisionerJob_IncludesWorkerIDAndName", func(t *testing.T) {
t.Run("AssignedProvisionerJob", func(t *testing.T) {
t.Parallel()

db, ps := dbtestutil.NewDB(t, dbtestutil.WithDumpOnFailure())
Expand All @@ -214,7 +214,7 @@ func TestProvisionerJobs(t *testing.T) {
err := provisionerDaemon.Close()
require.NoError(t, err)

t.Run("List_AssignedProvisionerJob_IncludesWorkerIDAndName", func(t *testing.T) {
t.Run("List_IncludesWorkerIDAndName", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitMedium)
Expand All @@ -223,7 +223,9 @@ func TestProvisionerJobs(t *testing.T) {
provisionerDaemons, err := db.GetProvisionerDaemons(ctx)
require.NoError(t, err)
require.Equal(t, 1, len(provisionerDaemons))
require.Equal(t, provisionerDaemonName, provisionerDaemons[0].Name)
if assert.NotEmpty(t, provisionerDaemons) {
require.Equal(t, provisionerDaemonName, provisionerDaemons[0].Name)
}

// Get provisioner jobs
jobs, err := templateAdminClient.OrganizationProvisionerJobs(ctx, owner.OrganizationID, nil)
Expand All @@ -235,12 +237,14 @@ func TestProvisionerJobs(t *testing.T) {
require.Equal(t, database.ProvisionerJobStatusSucceeded, database.ProvisionerJobStatus(job.Status))

// Guarantee that provisioner jobs contain the provisioner daemon ID and name
require.Equal(t, provisionerDaemons[0].ID, *job.WorkerID)
require.Equal(t, provisionerDaemonName, job.WorkerName)
if assert.NotEmpty(t, provisionerDaemons) {
require.Equal(t, &provisionerDaemons[0].ID, job.WorkerID)
require.Equal(t, provisionerDaemonName, job.WorkerName)
}
}
})

t.Run("Get_AssignedProvisionerJob_IncludesWorkerIDAndName", func(t *testing.T) {
t.Run("Get_IncludesWorkerIDAndName", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitMedium)
Expand All @@ -249,7 +253,9 @@ func TestProvisionerJobs(t *testing.T) {
provisionerDaemons, err := db.GetProvisionerDaemons(ctx)
require.NoError(t, err)
require.Equal(t, 1, len(provisionerDaemons))
require.Equal(t, provisionerDaemonName, provisionerDaemons[0].Name)
if assert.NotEmpty(t, provisionerDaemons) {
require.Equal(t, provisionerDaemonName, provisionerDaemons[0].Name)
}

// Get all provisioner jobs
jobs, err := templateAdminClient.OrganizationProvisionerJobs(ctx, owner.OrganizationID, nil)
Expand All @@ -273,8 +279,10 @@ func TestProvisionerJobs(t *testing.T) {
require.Equal(t, database.ProvisionerJobStatusSucceeded, database.ProvisionerJobStatus(workspaceProvisionerJob.Status))

// Guarantee that provisioner job contains the provisioner daemon ID and name
require.Equal(t, provisionerDaemons[0].ID, *workspaceProvisionerJob.WorkerID)
require.Equal(t, provisionerDaemonName, workspaceProvisionerJob.WorkerName)
if assert.NotEmpty(t, provisionerDaemons) {
require.Equal(t, &provisionerDaemons[0].ID, workspaceProvisionerJob.WorkerID)
require.Equal(t, provisionerDaemonName, workspaceProvisionerJob.WorkerName)
}
})
})
}
Expand Down