synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

add tests to ensure that preubilds are correctly provisioned for active template versions

Browse Source
This commit is contained in:
Sas Swart
2025-03-03 10:20:47 +00:00
parent be166ea239
commit e16d763241
4 changed files with 43 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
coderd/database/queries.sql.go
View File

@ -5624,7 +5624,7 @@ FROM workspace_prebuilds p
ON tvp_curr.id = p.current_preset_id -- See https://github.com/coder/internal/issues/398. ON tvp_curr.id = p.current_preset_id -- See https://github.com/coder/internal/issues/398.
WHERE (b.transition = 'start'::workspace_transition WHERE (b.transition = 'start'::workspace_transition
-- Jobs that are not in terminal states. -- Jobs that are not in terminal states.
OR pj.job_status IN ('failed'::provisioner_job_status, 'canceled'::provisioner_job_status, AND pj.job_status NOT IN ('failed'::provisioner_job_status, 'canceled'::provisioner_job_status,
'unknown'::provisioner_job_status)) 'unknown'::provisioner_job_status))
` `

2
coderd/database/queries/prebuilds.sql
View File

@ -18,7 +18,7 @@ FROM workspace_prebuilds p
ON tvp_curr.id = p.current_preset_id -- See https://github.com/coder/internal/issues/398. ON tvp_curr.id = p.current_preset_id -- See https://github.com/coder/internal/issues/398.
WHERE (b.transition = 'start'::workspace_transition WHERE (b.transition = 'start'::workspace_transition
-- Jobs that are not in terminal states. -- Jobs that are not in terminal states.
OR pj.job_status IN ('failed'::provisioner_job_status, 'canceled'::provisioner_job_status, AND pj.job_status NOT IN ('failed'::provisioner_job_status, 'canceled'::provisioner_job_status,
'unknown'::provisioner_job_status)); 'unknown'::provisioner_job_status));
-- name: GetTemplatePresetsWithPrebuilds :many -- name: GetTemplatePresetsWithPrebuilds :many

3
enterprise/coderd/prebuilds/controller.go
View File

@ -223,6 +223,9 @@ func (c *Controller) determineState(ctx context.Context, store database.Store, t
} }
presetsWithPrebuilds, err := db.GetTemplatePresetsWithPrebuilds(ctx, dbTemplateID) presetsWithPrebuilds, err := db.GetTemplatePresetsWithPrebuilds(ctx, dbTemplateID)
if err != nil {
return xerrors.Errorf("failed to get template presets with prebuilds: %w", err)
}
if len(presetsWithPrebuilds) == 0 { if len(presetsWithPrebuilds) == 0 {
return nil return nil
} }

183
enterprise/coderd/prebuilds/controller_test.go
View File

@ -112,7 +112,6 @@ func TestNoReconciliationActionsIfNoPrebuilds(t *testing.T) {
func setupTestDBTemplate( func setupTestDBTemplate(
t *testing.T, t *testing.T,
ctx context.Context,
db database.Store, db database.Store,
) ( ) (
orgID uuid.UUID, orgID uuid.UUID,
@ -220,7 +219,7 @@ func setupTestDBPrebuild(
OrganizationID: orgID, OrganizationID: orgID,
Error: buildError, Error: buildError,
}) })
prebuild := dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{ dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{
WorkspaceID: workspace.ID, WorkspaceID: workspace.ID,
InitiatorID: OwnerID, InitiatorID: OwnerID,
TemplateVersionID: templateVersion.ID, TemplateVersionID: templateVersion.ID,
@ -229,71 +228,58 @@ func setupTestDBPrebuild(
Transition: transition, Transition: transition,
}) })
return templateVersion.ID, preset.ID, prebuild.ID return templateVersion.ID, preset.ID, workspace.ID
} }
func TestPrebuildCreation(t *testing.T) { func TestActiveTemplateVersionPrebuilds(t *testing.T) {
t.Parallel() t.Parallel()
// Scenario: Prebuilds are created if and only if they are needed
type testCase struct { type testCase struct {
name string name string
prebuildStatus database.WorkspaceStatus prebuildStatus database.WorkspaceStatus
shouldCreateNewPrebuild bool shouldCreateNewPrebuild bool
shouldDeleteOldPrebuild bool shouldDeleteOldPrebuild bool
templateVersionActive bool
} }
testCases := []testCase{ testCases := []testCase{
{ {
name: "running prebuild", name: "running prebuild",
prebuildStatus: database.WorkspaceStatusRunning, prebuildStatus: database.WorkspaceStatusRunning,
templateVersionActive: true,
shouldCreateNewPrebuild: false, shouldCreateNewPrebuild: false,
shouldDeleteOldPrebuild: false, shouldDeleteOldPrebuild: false,
}, },
// { {
// name: "stopped prebuild", name: "stopped prebuild",
// prebuildStatus: database.WorkspaceStatusStopped, prebuildStatus: database.WorkspaceStatusStopped,
// templateVersionActive: true, shouldCreateNewPrebuild: true,
// shouldCreateNewPrebuild: true, shouldDeleteOldPrebuild: false,
// shouldDeleteOldPrebuild: false, },
// }, {
// { name: "failed prebuild",
// name: "failed prebuild", prebuildStatus: database.WorkspaceStatusFailed,
// prebuildStatus: database.WorkspaceStatusFailed, shouldCreateNewPrebuild: true,
// templateVersionActive: true, shouldDeleteOldPrebuild: false,
// shouldCreateNewPrebuild: true, },
// shouldDeleteOldPrebuild: true, {
// }, name: "canceled prebuild",
// { prebuildStatus: database.WorkspaceStatusCanceled,
// name: "canceled prebuild", shouldCreateNewPrebuild: true,
// prebuildStatus: database.WorkspaceStatusCanceled, shouldDeleteOldPrebuild: false,
// templateVersionActive: true, },
// shouldCreateNewPrebuild: true,
// shouldDeleteOldPrebuild: true,
// },
// { // {
// name: "deleted prebuild", // name: "deleted prebuild",
// prebuildStatus: database.WorkspaceStatusDeleted, // prebuildStatus: database.WorkspaceStatusDeleted,
// templateVersionActive: true, // shouldConsiderPrebuildRunning: false,
// shouldConsiderPrebuildInProgress: false,
// shouldCreateNewPrebuild: true, // shouldCreateNewPrebuild: true,
// shouldDeleteOldPrebuild: false, // shouldDeleteOldPrebuild: false,
// }, // },
// { {
// name: "pending prebuild", name: "pending prebuild",
// prebuildStatus: database.WorkspaceStatusPending, prebuildStatus: database.WorkspaceStatusPending,
// templateVersionActive: true, shouldCreateNewPrebuild: false,
// shouldCreateNewPrebuild: false, shouldDeleteOldPrebuild: false,
// shouldDeleteOldPrebuild: false, },
// },
// {
// name: "inactive template version",
// prebuildStatus: database.WorkspaceStatusRunning,
// shouldDeleteOldPrebuild: true,
// templateVersionActive: false,
// shouldCreateNewPrebuild: false,
// },
} }
for _, tc := range testCases { for _, tc := range testCases {
tc := tc tc := tc
@ -305,7 +291,7 @@ func TestPrebuildCreation(t *testing.T) {
logger := testutil.Logger(t) logger := testutil.Logger(t)
controller := NewController(db, pubsub, cfg, logger) controller := NewController(db, pubsub, cfg, logger)
orgID, userID, templateID := setupTestDBTemplate(t, ctx, db) orgID, userID, templateID := setupTestDBTemplate(t, db)
_, _, prebuildID := setupTestDBPrebuild( _, _, prebuildID := setupTestDBPrebuild(
t, t,
ctx, ctx,
@ -316,125 +302,32 @@ func TestPrebuildCreation(t *testing.T) {
userID, userID,
templateID, templateID,
) )
if !tc.templateVersionActive {
_, _, _ = setupTestDBPrebuild(
t,
ctx,
db,
pubsub,
tc.prebuildStatus,
orgID,
userID,
templateID,
)
}
controller.reconcile(ctx, nil) controller.reconcile(ctx, nil)
createdNewPrebuild := false createdNewPrebuild := false
deletedOldPrebuild := false deletedOldPrebuild := true
workspaces, err := db.GetWorkspacesByTemplateID(ctx, templateID) workspaces, err := db.GetWorkspacesByTemplateID(ctx, templateID)
require.NoError(t, err) require.NoError(t, err)
for _, workspace := range workspaces { for _, workspace := range workspaces {
if workspace.ID == prebuildID && workspace.Deleted { if workspace.ID == prebuildID {
deletedOldPrebuild = true deletedOldPrebuild = false
} }
if workspace.ID != prebuildID && !workspace.Deleted { if workspace.ID != prebuildID {
createdNewPrebuild = true createdNewPrebuild = true
} }
} }
require.Equal(t, tc.shouldCreateNewPrebuild, createdNewPrebuild) require.Equal(t, tc.shouldCreateNewPrebuild, createdNewPrebuild)
// workspacebuilds, err := db.GetWorkspaceBuildsCreatedAfter(ctx, time.Now().Add(-24*time.Hour))
// require.NoError(t, err)
require.Equal(t, tc.shouldDeleteOldPrebuild, deletedOldPrebuild) require.Equal(t, tc.shouldDeleteOldPrebuild, deletedOldPrebuild)
}) })
} }
} }
func TestDeleteUnwantedPrebuilds(t *testing.T) { func TestInactiveTemplateVersionPrebuilds(t *testing.T) {
// Scenario: Prebuilds are deleted if and only if they are extraneous // Scenario: Prebuilds are never created and always deleted if the template version is inactive
t.Parallel() t.Parallel()
t.Skip("todo")
ctx := testutil.Context(t, testutil.WaitShort)
db, pubsub := dbtestutil.NewDB(t)
cfg := codersdk.PrebuildsConfig{}
logger := testutil.Logger(t)
controller := NewController(db, pubsub, cfg, logger)
type testCase struct {
name string
prebuildStatus database.WorkspaceStatus
shouldDelete bool
}
testCases := []testCase{
{
name: "running prebuild",
prebuildStatus: database.WorkspaceStatusRunning,
shouldDelete: false,
},
{
name: "stopped prebuild",
prebuildStatus: database.WorkspaceStatusStopped,
shouldDelete: true,
},
{
name: "failed prebuild",
prebuildStatus: database.WorkspaceStatusFailed,
shouldDelete: true,
},
{
name: "canceled prebuild",
prebuildStatus: database.WorkspaceStatusCanceled,
shouldDelete: true,
},
{
name: "deleted prebuild",
prebuildStatus: database.WorkspaceStatusDeleted,
shouldDelete: true,
},
{
name: "pending prebuild",
prebuildStatus: database.WorkspaceStatusPending,
shouldDelete: false,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
db, pubsub := dbtestutil.NewDB(t)
cfg := codersdk.PrebuildsConfig{}
logger := testutil.Logger(t)
controller := NewController(db, pubsub, cfg, logger)
controller.reconcile(ctx, nil)
jobs, err := db.GetProvisionerJobsCreatedAfter(ctx, time.Now().Add(-time.Hour))
require.NoError(t, err)
require.Equal(t, tc.shouldDelete, len(jobs) == 1)
})
}
// when does a prebuild get deleted?
// * when it is in some way permanently ineligible to be claimed
// * or it belongs to a template version that is no longer active
// * or it belongs to a template version that is deprecated
// * when there are more prebuilds than the preset desires
// * someone could have manually created a workspace for the prebuild user
// * any workspaces that were created for the prebuilds user and don't match a preset should be deleted - deferred
// given a preset that desires 2 prebuilds
// and there are 3 running prebuilds for the preset
// and there are 4 non-running prebuilds for the preset
// * one is not running because its latest build was a stop transition
// * another is not running because its latest build was a delete transition
// * a third is not running because its latest build was a start transition but the build failed
// * a fourth is not running because its latest build was a start transition but the build was canceled
// when we trigger the reconciliation loop for all templates
controller.reconcile(ctx, nil)
// then the four non running prebuilds are deleted
// and 1 of the running prebuilds is deleted
// because stopped, deleted and failed builds are not considered running in terms of the definition of "running" above.
} }
// TODO (sasswart): test claim (success, fail) x (eligible) // TODO (sasswart): test claim (success, fail) x (eligible)