Skip to content

feat(coderd): add matched provisioner daemons information to more places #15688

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 16 commits into from
Dec 2, 2024
Merged

feat(coderd): add matched provisioner daemons information to more places #15688

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ba944ab
feat(coderd/wsbuilder): return provisioners available at time of insert
johnstcn Nov 29, 2024
4e51f20
feat(coderd): add matched provisioner daemons information to addition…
johnstcn Nov 29, 2024
47036e8
fix linter complaint re nil ptr deref
johnstcn Dec 1, 2024
16be03b
add test coverage for matched provisioners with workspace build creation
johnstcn Dec 1, 2024
4304a06
skip for non-postgres
johnstcn Dec 1, 2024
9ef68dd
add tests for workspace creation
johnstcn Dec 1, 2024
38788d5
revert fe changes in this pr
johnstcn Dec 1, 2024
1c95ffe
coderd/wsbuilder: use dbauthz.AsSystemReadProvisionerDaemons instead …
johnstcn Dec 1, 2024
98521be
refactor: extract WarnMatchedProvisioners to cliutil
johnstcn Dec 1, 2024
e1423f5
fixup! refactor: extract WarnMatchedProvisioners to cliutil
johnstcn Dec 1, 2024
517a505
feat(cli): add provisioner warning to create/start/stop commands
johnstcn Dec 1, 2024
c4295ef
Apply suggestions from code review
johnstcn Dec 2, 2024
c5fb83b
feat(coderd): add endpoint for matched provisioners of template versi…
johnstcn Dec 2, 2024
3bd62fd
feat(cli): delete: warn on no matched provisioners
johnstcn Dec 2, 2024
2f625bc
address linter complaint
johnstcn Dec 2, 2024
848338e
add test for cli/delete
johnstcn Dec 2, 2024
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
add test coverage for matched provisioners with workspace build creation
  • Loading branch information
@johnstcn
johnstcn committed Dec 1, 2024
commit 16be03bc621fdc66d56dba67bbf2a8fc2583a0bb
110 changes: 110 additions & 0 deletions coderd/workspacebuilds_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,12 @@ func TestPostWorkspaceBuild(t *testing.T) {
Transition: codersdk.WorkspaceTransitionStart,
})
require.NoError(t, err)
if assert.NotNil(t, build.MatchedProvisioners) {
require.Equal(t, 1, build.MatchedProvisioners.Count)
require.Equal(t, 1, build.MatchedProvisioners.Available)
require.NotZero(t, build.MatchedProvisioners.MostRecentlySeen.Time)
}

coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, build.ID)

require.Eventually(t, func() bool {
Expand Down Expand Up @@ -1124,6 +1130,12 @@ func TestPostWorkspaceBuild(t *testing.T) {
Transition: codersdk.WorkspaceTransitionStart,
})
require.NoError(t, err)
if assert.NotNil(t, build.MatchedProvisioners) {
require.Equal(t, 1, build.MatchedProvisioners.Count)
require.Equal(t, 1, build.MatchedProvisioners.Available)
require.NotZero(t, build.MatchedProvisioners.MostRecentlySeen.Time)
}

require.Equal(t, workspace.LatestBuild.BuildNumber+1, build.BuildNumber)
})

Expand All @@ -1150,6 +1162,12 @@ func TestPostWorkspaceBuild(t *testing.T) {
ProvisionerState: wantState,
})
require.NoError(t, err)
if assert.NotNil(t, build.MatchedProvisioners) {
require.Equal(t, 1, build.MatchedProvisioners.Count)
require.Equal(t, 1, build.MatchedProvisioners.Available)
require.NotZero(t, build.MatchedProvisioners.MostRecentlySeen.Time)
}

gotState, err := client.WorkspaceBuildState(ctx, build.ID)
require.NoError(t, err)
require.Equal(t, wantState, gotState)
Expand All @@ -1173,6 +1191,12 @@ func TestPostWorkspaceBuild(t *testing.T) {
})
require.NoError(t, err)
require.Equal(t, workspace.LatestBuild.BuildNumber+1, build.BuildNumber)
if assert.NotNil(t, build.MatchedProvisioners) {
require.Equal(t, 1, build.MatchedProvisioners.Count)
require.Equal(t, 1, build.MatchedProvisioners.Available)
require.NotZero(t, build.MatchedProvisioners.MostRecentlySeen.Time)
}

coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, build.ID)

res, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{
Expand All @@ -1181,6 +1205,92 @@ func TestPostWorkspaceBuild(t *testing.T) {
require.NoError(t, err)
require.Len(t, res.Workspaces, 0)
})

t.Run("NoProvisionersAvailable", func(t *testing.T) {
t.Parallel()
// Given: a coderd instance with a provisioner daemon
store, ps, db := dbtestutil.NewDBWithSQLDB(t)
client, closeDaemon := coderdtest.NewWithProvisionerCloser(t, &coderdtest.Options{
Database: store,
Pubsub: ps,
IncludeProvisionerDaemon: true,
})
// Given: a user, template, and workspace
user := coderdtest.CreateFirstUser(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
workspace := coderdtest.CreateWorkspace(t, client, template.ID)
coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)

// Stop the provisioner daemon.
require.NoError(t, closeDaemon.Close())
ctx := testutil.Context(t, testutil.WaitLong)
// Given: no provisioner daemons exist.
_, err := db.ExecContext(ctx, `DELETE FROM provisioner_daemons;`)
Copy link
Member Author

Choose a reason for hiding this comment

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

self-review: this is kinda yucky but I don't agree with the idea of creating database queries for things that will only ever get used intests.

require.NoError(t, err)

// When: a new workspace build is created
build, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
TemplateVersionID: template.ActiveVersionID,
Transition: codersdk.WorkspaceTransitionStart,
})
// Then: the request should succeed.
require.NoError(t, err)
// Then: the provisioner job should remain pending.
require.Equal(t, codersdk.ProvisionerJobPending, build.Job.Status)
// Then: the response should indicate no provisioners are available.
if assert.NotNil(t, build.MatchedProvisioners) {
require.Zero(t, build.MatchedProvisioners.Count)
require.Zero(t, build.MatchedProvisioners.Available)
require.Zero(t, build.MatchedProvisioners.MostRecentlySeen.Time)
}
})

t.Run("AllProvisionersStale", func(t *testing.T) {
t.Parallel()
// Given: a coderd instance with a provisioner daemon
store, ps, db := dbtestutil.NewDBWithSQLDB(t)
client, closeDaemon := coderdtest.NewWithProvisionerCloser(t, &coderdtest.Options{
Database: store,
Pubsub: ps,
IncludeProvisionerDaemon: true,
})
// Given: a user, template, and workspace
user := coderdtest.CreateFirstUser(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
workspace := coderdtest.CreateWorkspace(t, client, template.ID)
coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)

ctx := testutil.Context(t, testutil.WaitLong)
// Given: all provisioner daemons are stale
// First stop the provisioner
require.NoError(t, closeDaemon.Close())
newLastSeenAt := dbtime.Now().Add(-time.Hour)
// Update the last seen at for all provisioner daemons. We have to use the
// SQL db directly because store.UpdateProvisionerDaemonLastSeenAt has a
// built-in check to prevent updating the last seen at to a time in the past.
_, err := db.ExecContext(ctx, `UPDATE provisioner_daemons SET last_seen_at = $1;`, newLastSeenAt)
require.NoError(t, err)

// When: a new workspace build is created
build, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
TemplateVersionID: template.ActiveVersionID,
Transition: codersdk.WorkspaceTransitionStart,
})
// Then: the request should succeed
require.NoError(t, err)
// Then: the provisioner job should remain pending
require.Equal(t, codersdk.ProvisionerJobPending, build.Job.Status)
// Then: the response should indicate no provisioners are available
if assert.NotNil(t, build.MatchedProvisioners) {
require.Zero(t, build.MatchedProvisioners.Available)
require.Equal(t, 1, build.MatchedProvisioners.Count)
require.Equal(t, newLastSeenAt.UTC(), build.MatchedProvisioners.MostRecentlySeen.Time.UTC())
}
})
}

func TestWorkspaceBuildTimings(t *testing.T) {
Expand Down
Loading