Two prebuild tests constructed a `StoreReconciler` without starting its job-notification worker. `TestWorkspaceProvisionerdServerMetrics` waited for the acquirer's 30s backup poll; `TestClaimPrebuild` advanced a mock backup ticker by hand. Two prebuild tables also paid for an unnecessarily expensive fixture per leaf. The two provisioning tests now start the reconciler and stop it in cleanup; their unadvanced mock clocks prevent periodic reconciliation from interfering with explicit reconciliation calls. Polling moves to `IntervalFast`, with the existing timeouts unchanged. `TestClaimPrebuild` removes its hand-rolled acquirer and checks freshly fetched rows when waiting for a replacement prebuild. `TestMetricsCollector` shares one database with a rolled-back transaction per leaf, and `TestReconcileAll` uses `dbtestutil.NewDB` plus `dbgen.User` instead of a full coderd. `TestEnterpriseCreateWithPreset` had the same 30s wait. #29458 fixed it on main by posting the pending jobs itself, so after the rebase onto main this PR only moves that test's polling to `IntervalFast`. Its table row and the full `enterprise/cli` package medians below were measured before #29458 landed. | Test | Before | After | |---|---|---| | `enterprise/cli/TestEnterpriseCreateWithPreset` (2 leaves) | 64.56s | 1.35s | | `enterprise/coderd/TestWorkspaceProvisionerdServerMetrics` | 30.94s | 0.69s | | `prebuilds/TestMetricsCollector` (80 leaves) | 17.56s | 7.09s | | `prebuilds/TestClaimPrebuild` (10 leaves) | 24.05s | 18.46s | | `prebuilds/TestReconcileAll` (16 leaves) | 8.17s | 6.22s | Independent review measurements: median summed leaf time from two targeted runs per side in A-B-B-A order, against merge base `0ea777a341`, using `go test -json -tags=testsmallbatch -count=1 -v -p 1 -parallel 8`. The CLI and coderd tests were selected individually; the three prebuild tests ran together. Other agents shared the machine, so fixture timings were noisy. The provisioning speedups hold; the measured prebuild fixture ratios are smaller than the original estimates. Selected-prebuild-test package elapsed was 5.50s/7.61s before and 2.36s/6.29s after, with medians of 6.56s and 4.33s. These are not full-package timings. Separate full-package A-B-B-A runs measured `enterprise/coderd/prebuilds` at 31.62s/18.63s before and 20.78s/21.63s after, with medians of 25.12s and 21.20s. Full `enterprise/cli` package medians were 54.09s before and 26.21s after. The full `enterprise/coderd` package was not run locally. <details> <summary>Investigation notes</summary> - The reconciler publishes queued provisioner jobs from a worker started by `Run` (`reconcile.go:220-241`). Reconciliation itself only runs after a mock-clock tick; none of these tests advances that clock. `Stop` uses a fresh `WaitShort` context and is registered after database/pubsub cleanup, so it executes first. - `coderdenttest.GetRunningPrebuilds` has one caller, the workspace-metrics test. Its polling interval changes, not its context deadline. - Both the metrics collector and its reconciler receive each leaf's transaction store (`metricscollector_test.go:207-221`). `UpdateState` passes that same store to `SnapshotState`, whose nested transaction reuses the existing transaction. Assertions require two templates and non-nil metric series with exact values. - The post-claim check now waits for the fetched prebuild count to return from one to two (`claim_test.go:324-360`), rather than checking the unchanged pre-claim map. - The original 6.8s/7.4s to 4.5s/4.6s prebuild measurements selected only the three changed tests. The measurements above distinguish that selection from the full package. Not changed, with reasons: `TestWorkspaceTagsTerraform` and `TestWorkspaceTemplateParamsChange` run real Terraform, which is the coverage; `TestPrebuildReconciliation` cannot use rolled-back transactions without collapsing its separate advisory-lock and write transactions; `TestReplicas` and `TestConn_CoordinatorRollingRestart` are bounded by tailnet handshake retry timing, and an earlier shared-pubsub prototype did not help. Validation: all five changed tests pass with `-count=5` and `-race -count=2`; both full-package comparisons pass on both sides; `gofmt -l`, `git diff --check`, and scoped `golangci-lint` are clean. No source fixes were needed during independent review. Codex completed review of `7b81822414` with no findings. Relevant Go and lint CI jobs passed. No production code changes. </details> _Investigated, implemented, and validated by Coder Agents on behalf of @ibetitsmike._ Rebased onto `9cfe27063df`. `go build` and `go vet` of the four touched packages, scoped `golangci-lint` and `paralleltestctx`, and the five changed tests (`-count=1`, then `-race -count=2`) pass. > Xum (an AI agent) rebased this PR onto main on behalf of @ibetitsmike.
632 lines
22 KiB
Go
632 lines
22 KiB
Go
package cli_test
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
"sync"
|
|
"sync/atomic"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"go.opentelemetry.io/otel/trace/noop"
|
|
|
|
"github.com/coder/coder/v2/cli"
|
|
"github.com/coder/coder/v2/cli/clitest"
|
|
"github.com/coder/coder/v2/coderd/coderdtest"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbtestutil"
|
|
"github.com/coder/coder/v2/coderd/database/provisionerjobs"
|
|
"github.com/coder/coder/v2/coderd/database/pubsub"
|
|
"github.com/coder/coder/v2/coderd/files"
|
|
"github.com/coder/coder/v2/coderd/notifications"
|
|
agplprebuilds "github.com/coder/coder/v2/coderd/prebuilds"
|
|
"github.com/coder/coder/v2/coderd/rbac"
|
|
"github.com/coder/coder/v2/coderd/wsbuilder"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/coder/v2/enterprise/coderd/coderdenttest"
|
|
"github.com/coder/coder/v2/enterprise/coderd/license"
|
|
"github.com/coder/coder/v2/enterprise/coderd/prebuilds"
|
|
"github.com/coder/coder/v2/provisioner/echo"
|
|
"github.com/coder/coder/v2/provisionersdk/proto"
|
|
"github.com/coder/coder/v2/testutil"
|
|
"github.com/coder/coder/v2/testutil/expecter"
|
|
"github.com/coder/quartz"
|
|
)
|
|
|
|
func TestEnterpriseCreate(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
type setupData struct {
|
|
firstResponse codersdk.CreateFirstUserResponse
|
|
second codersdk.Organization
|
|
owner *codersdk.Client
|
|
member *codersdk.Client
|
|
}
|
|
|
|
type setupArgs struct {
|
|
firstTemplates []string
|
|
secondTemplates []string
|
|
}
|
|
|
|
// setupMultipleOrganizations creates an extra organization, assigns a member
|
|
// both organizations, and optionally creates templates in each organization.
|
|
setupMultipleOrganizations := func(t *testing.T, args setupArgs) setupData {
|
|
ownerClient, first := coderdenttest.New(t, &coderdenttest.Options{
|
|
Options: &coderdtest.Options{
|
|
// This only affects the first org.
|
|
IncludeProvisionerDaemon: true,
|
|
},
|
|
LicenseOptions: &coderdenttest.LicenseOptions{
|
|
Features: license.Features{
|
|
codersdk.FeatureExternalProvisionerDaemons: 1,
|
|
codersdk.FeatureMultipleOrganizations: 1,
|
|
},
|
|
},
|
|
})
|
|
|
|
second := coderdenttest.CreateOrganization(t, ownerClient, coderdenttest.CreateOrganizationOptions{
|
|
IncludeProvisionerDaemon: true,
|
|
})
|
|
member, _ := coderdtest.CreateAnotherUser(t, ownerClient, first.OrganizationID, rbac.ScopedRoleOrgMember(second.ID))
|
|
|
|
var wg sync.WaitGroup
|
|
|
|
createTemplate := func(tplName string, orgID uuid.UUID) {
|
|
version := coderdtest.CreateTemplateVersion(t, ownerClient, orgID, nil)
|
|
wg.Go(func() {
|
|
coderdtest.AwaitTemplateVersionJobCompleted(t, ownerClient, version.ID)
|
|
})
|
|
|
|
coderdtest.CreateTemplate(t, ownerClient, orgID, version.ID, func(request *codersdk.CreateTemplateRequest) {
|
|
request.Name = tplName
|
|
})
|
|
}
|
|
|
|
for _, tplName := range args.firstTemplates {
|
|
createTemplate(tplName, first.OrganizationID)
|
|
}
|
|
|
|
for _, tplName := range args.secondTemplates {
|
|
createTemplate(tplName, second.ID)
|
|
}
|
|
|
|
wg.Wait()
|
|
|
|
return setupData{
|
|
firstResponse: first,
|
|
owner: ownerClient,
|
|
second: second,
|
|
member: member,
|
|
}
|
|
}
|
|
|
|
// Test creating a workspace in the second organization with a template
|
|
// name.
|
|
t.Run("CreateMultipleOrganization", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const templateName = "secondtemplate"
|
|
setup := setupMultipleOrganizations(t, setupArgs{
|
|
secondTemplates: []string{templateName},
|
|
})
|
|
member := setup.member
|
|
|
|
args := []string{
|
|
"create",
|
|
"my-workspace",
|
|
"-y",
|
|
"--template", templateName,
|
|
}
|
|
inv, root := clitest.New(t, args...)
|
|
clitest.SetupConfig(t, member, root)
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
|
|
ws, err := member.WorkspaceByOwnerAndName(context.Background(), codersdk.Me, "my-workspace", codersdk.WorkspaceOptions{})
|
|
if assert.NoError(t, err, "expected workspace to be created") {
|
|
assert.Equal(t, ws.TemplateName, templateName)
|
|
assert.Equal(t, ws.OrganizationName, setup.second.Name, "workspace in second organization")
|
|
}
|
|
})
|
|
|
|
// If a template name exists in two organizations, the workspace create will
|
|
// fail.
|
|
t.Run("AmbiguousTemplateName", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const templateName = "ambiguous"
|
|
setup := setupMultipleOrganizations(t, setupArgs{
|
|
firstTemplates: []string{templateName},
|
|
secondTemplates: []string{templateName},
|
|
})
|
|
member := setup.member
|
|
|
|
args := []string{
|
|
"create",
|
|
"my-workspace",
|
|
"-y",
|
|
"--template", templateName,
|
|
}
|
|
inv, root := clitest.New(t, args...)
|
|
clitest.SetupConfig(t, member, root)
|
|
err := inv.Run()
|
|
require.Error(t, err, "expected error due to ambiguous template name")
|
|
require.ErrorContains(t, err, "multiple templates found")
|
|
})
|
|
|
|
// Ambiguous template names are allowed if the organization is specified.
|
|
t.Run("WorkingAmbiguousTemplateName", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const templateName = "ambiguous"
|
|
setup := setupMultipleOrganizations(t, setupArgs{
|
|
firstTemplates: []string{templateName},
|
|
secondTemplates: []string{templateName},
|
|
})
|
|
member := setup.member
|
|
|
|
args := []string{
|
|
"create",
|
|
"my-workspace",
|
|
"-y",
|
|
"--template", templateName,
|
|
"--org", setup.second.Name,
|
|
}
|
|
inv, root := clitest.New(t, args...)
|
|
clitest.SetupConfig(t, member, root)
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
|
|
ws, err := member.WorkspaceByOwnerAndName(context.Background(), codersdk.Me, "my-workspace", codersdk.WorkspaceOptions{})
|
|
if assert.NoError(t, err, "expected workspace to be created") {
|
|
assert.Equal(t, ws.TemplateName, templateName)
|
|
assert.Equal(t, ws.OrganizationName, setup.second.Name, "workspace in second organization")
|
|
}
|
|
})
|
|
|
|
// Site-wide admins (Owners) can create workspaces in organizations they
|
|
// are not a member of by using the --org flag.
|
|
t.Run("OwnerCanCreateInNonMemberOrg", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const templateName = "ownertemplate"
|
|
setup := setupMultipleOrganizations(t, setupArgs{
|
|
secondTemplates: []string{templateName},
|
|
})
|
|
|
|
// Create a new Owner user who is NOT a member of the second org.
|
|
// The setup.owner created the second org and is auto-added as member,
|
|
// so we need a different Owner to test the RBAC-only path.
|
|
newOwner, _ := coderdtest.CreateAnotherUser(t, setup.owner, setup.firstResponse.OrganizationID, rbac.RoleOwner())
|
|
|
|
args := []string{
|
|
"create",
|
|
"owner-workspace",
|
|
"-y",
|
|
"--template", templateName,
|
|
"--org", setup.second.Name,
|
|
}
|
|
inv, root := clitest.New(t, args...)
|
|
clitest.SetupConfig(t, newOwner, root)
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
|
|
ws, err := newOwner.WorkspaceByOwnerAndName(context.Background(), codersdk.Me, "owner-workspace", codersdk.WorkspaceOptions{})
|
|
if assert.NoError(t, err, "expected workspace to be created") {
|
|
assert.Equal(t, ws.TemplateName, templateName)
|
|
assert.Equal(t, ws.OrganizationName, setup.second.Name, "workspace in second organization")
|
|
}
|
|
})
|
|
|
|
// If an organization is specified, but the template is not in that
|
|
// organization, an error is thrown.
|
|
t.Run("CreateIncorrectOrg", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const templateName = "secondtemplate"
|
|
setup := setupMultipleOrganizations(t, setupArgs{
|
|
firstTemplates: []string{templateName},
|
|
})
|
|
member := setup.member
|
|
|
|
args := []string{
|
|
"create",
|
|
"my-workspace",
|
|
"-y",
|
|
"--org", setup.second.Name,
|
|
"--template", templateName,
|
|
}
|
|
inv, root := clitest.New(t, args...)
|
|
clitest.SetupConfig(t, member, root)
|
|
err := inv.Run()
|
|
require.Error(t, err)
|
|
// The error message should indicate the flag to fix the issue.
|
|
require.ErrorContains(t, err, fmt.Sprintf("--org=%q", "coder"))
|
|
})
|
|
}
|
|
|
|
func TestEnterpriseCreateWithPreset(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const (
|
|
firstParameterName = "first_parameter"
|
|
firstParameterDisplayName = "First Parameter"
|
|
firstParameterDescription = "This is the first parameter"
|
|
firstParameterValue = "1"
|
|
|
|
firstOptionalParameterName = "first_optional_parameter"
|
|
firstOptionParameterDescription = "This is the first optional parameter"
|
|
firstOptionalParameterValue = "1"
|
|
secondOptionalParameterName = "second_optional_parameter"
|
|
secondOptionalParameterDescription = "This is the second optional parameter"
|
|
secondOptionalParameterValue = "2"
|
|
|
|
thirdParameterName = "third_parameter"
|
|
thirdParameterDescription = "This is the third parameter"
|
|
thirdParameterValue = "3"
|
|
)
|
|
|
|
echoResponses := func(presets ...*proto.Preset) *echo.Responses {
|
|
return prepareEchoResponses([]*proto.RichParameter{
|
|
{
|
|
Name: firstParameterName,
|
|
DisplayName: firstParameterDisplayName,
|
|
Description: firstParameterDescription,
|
|
Mutable: true,
|
|
DefaultValue: firstParameterValue,
|
|
Options: []*proto.RichParameterOption{
|
|
{
|
|
Name: firstOptionalParameterName,
|
|
Description: firstOptionParameterDescription,
|
|
Value: firstOptionalParameterValue,
|
|
},
|
|
{
|
|
Name: secondOptionalParameterName,
|
|
Description: secondOptionalParameterDescription,
|
|
Value: secondOptionalParameterValue,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Name: thirdParameterName,
|
|
Description: thirdParameterDescription,
|
|
DefaultValue: thirdParameterValue,
|
|
Mutable: true,
|
|
},
|
|
}, presets...)
|
|
}
|
|
|
|
runReconciliationLoop := func(
|
|
t *testing.T,
|
|
ctx context.Context,
|
|
db database.Store,
|
|
pb pubsub.Pubsub,
|
|
reconciler *prebuilds.StoreReconciler,
|
|
presets []codersdk.Preset,
|
|
) {
|
|
t.Helper()
|
|
|
|
state, err := reconciler.SnapshotState(ctx, db)
|
|
require.NoError(t, err)
|
|
require.Len(t, presets, 1)
|
|
ps, err := state.FilterByPreset(presets[0].ID)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, ps)
|
|
actions, err := reconciler.CalculateActions(ctx, *ps)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, actions)
|
|
require.NoError(t, reconciler.ReconcilePreset(ctx, *ps))
|
|
|
|
// StoreReconciler queues its "job posted" pubsub notification on an
|
|
// internal channel that only StoreReconciler.Run drains. These tests
|
|
// drive the reconciler directly and never start Run, so without this
|
|
// provisionerd would only see the job on its 30 second backup poll.
|
|
jobs, err := db.GetProvisionerJobsCreatedAfter(ctx, time.Time{})
|
|
require.NoError(t, err)
|
|
for _, job := range jobs {
|
|
if job.JobStatus != database.ProvisionerJobStatusPending {
|
|
continue
|
|
}
|
|
require.NoError(t, provisionerjobs.PostJob(pb, job))
|
|
}
|
|
}
|
|
|
|
getRunningPrebuilds := func(
|
|
t *testing.T,
|
|
ctx context.Context,
|
|
db database.Store,
|
|
prebuildInstances int,
|
|
) []database.GetRunningPrebuiltWorkspacesRow {
|
|
t.Helper()
|
|
|
|
var runningPrebuilds []database.GetRunningPrebuiltWorkspacesRow
|
|
testutil.Eventually(ctx, t, func(context.Context) bool {
|
|
runningPrebuilds = nil
|
|
rows, err := db.GetRunningPrebuiltWorkspaces(ctx)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
|
|
for _, row := range rows {
|
|
runningPrebuilds = append(runningPrebuilds, row)
|
|
|
|
agents, err := db.GetWorkspaceAgentsInLatestBuildByWorkspaceID(ctx, row.ID)
|
|
if err != nil || len(agents) == 0 {
|
|
return false
|
|
}
|
|
|
|
for _, agent := range agents {
|
|
err = db.UpdateWorkspaceAgentLifecycleStateByID(ctx, database.UpdateWorkspaceAgentLifecycleStateByIDParams{
|
|
ID: agent.ID,
|
|
LifecycleState: database.WorkspaceAgentLifecycleStateReady,
|
|
StartedAt: sql.NullTime{Time: time.Now().Add(time.Hour), Valid: true},
|
|
ReadyAt: sql.NullTime{Time: time.Now().Add(-1 * time.Hour), Valid: true},
|
|
})
|
|
if err != nil {
|
|
return false
|
|
}
|
|
}
|
|
}
|
|
|
|
t.Logf("found %d running prebuilds so far, want %d", len(runningPrebuilds), prebuildInstances)
|
|
return len(runningPrebuilds) == prebuildInstances
|
|
}, testutil.IntervalFast, "prebuilds not running")
|
|
|
|
return runningPrebuilds
|
|
}
|
|
|
|
// This test verifies that when the selected preset has running prebuilds,
|
|
// one of those prebuilds is claimed for the user upon workspace creation.
|
|
t.Run("PresetFlagClaimsPrebuiltWorkspace", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Setup
|
|
ctx := testutil.Context(t, testutil.WaitSuperLong)
|
|
db, pb := dbtestutil.NewDB(t, dbtestutil.WithDumpOnFailure())
|
|
client, _, api, owner := coderdenttest.NewWithAPI(t, &coderdenttest.Options{
|
|
Options: &coderdtest.Options{
|
|
Database: db,
|
|
Pubsub: pb,
|
|
IncludeProvisionerDaemon: true,
|
|
},
|
|
})
|
|
|
|
// Setup Prebuild reconciler
|
|
cache := files.New(prometheus.NewRegistry(), &coderdtest.FakeAuthorizer{})
|
|
newNoopUsageCheckerPtr := func() *atomic.Pointer[wsbuilder.UsageChecker] {
|
|
var noopUsageChecker wsbuilder.UsageChecker = wsbuilder.NoopUsageChecker{}
|
|
buildUsageChecker := atomic.Pointer[wsbuilder.UsageChecker]{}
|
|
buildUsageChecker.Store(&noopUsageChecker)
|
|
return &buildUsageChecker
|
|
}
|
|
reconciler := prebuilds.NewStoreReconciler(
|
|
db, pb, cache,
|
|
codersdk.PrebuildsConfig{},
|
|
testutil.Logger(t),
|
|
quartz.NewMock(t),
|
|
prometheus.NewRegistry(),
|
|
notifications.NewNoopEnqueuer(),
|
|
newNoopUsageCheckerPtr(),
|
|
noop.NewTracerProvider(),
|
|
10,
|
|
nil,
|
|
)
|
|
var claimer agplprebuilds.Claimer = prebuilds.NewEnterpriseClaimer()
|
|
api.AGPL.PrebuildsClaimer.Store(&claimer)
|
|
|
|
// Given: a template and a template version where the preset defines values for all required parameters,
|
|
// and is configured to have 1 prebuild instance
|
|
prebuildInstances := int32(1)
|
|
preset := proto.Preset{
|
|
Name: "preset-test",
|
|
Parameters: []*proto.PresetParameter{
|
|
{Name: firstParameterName, Value: secondOptionalParameterValue},
|
|
{Name: thirdParameterName, Value: thirdParameterValue},
|
|
},
|
|
Prebuild: &proto.Prebuild{
|
|
Instances: prebuildInstances,
|
|
},
|
|
}
|
|
member, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
|
|
version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, echoResponses(&preset))
|
|
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
|
|
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID)
|
|
presets, err := client.TemplateVersionPresets(ctx, version.ID)
|
|
require.NoError(t, err)
|
|
require.Len(t, presets, 1)
|
|
require.Equal(t, preset.Name, presets[0].Name)
|
|
|
|
// Given: Reconciliation loop runs and starts prebuilt workspaces
|
|
runReconciliationLoop(t, ctx, db, pb, reconciler, presets)
|
|
runningPrebuilds := getRunningPrebuilds(t, ctx, db, int(prebuildInstances))
|
|
require.Len(t, runningPrebuilds, int(prebuildInstances))
|
|
require.Equal(t, presets[0].ID, runningPrebuilds[0].CurrentPresetID.UUID)
|
|
|
|
// Given: a running prebuilt workspace, ready to be claimed
|
|
prebuild := coderdtest.MustWorkspace(t, client, runningPrebuilds[0].ID)
|
|
require.Equal(t, codersdk.WorkspaceTransitionStart, prebuild.LatestBuild.Transition)
|
|
require.Equal(t, template.ID, prebuild.TemplateID)
|
|
require.Equal(t, version.ID, prebuild.TemplateActiveVersionID)
|
|
require.Equal(t, presets[0].ID, *prebuild.LatestBuild.TemplateVersionPresetID)
|
|
|
|
// When: running the create command with the specified preset
|
|
workspaceName := "my-workspace"
|
|
inv, root := clitest.New(t, "create", workspaceName, "--template", template.Name, "-y", "--preset", preset.Name)
|
|
clitest.SetupConfig(t, member, root)
|
|
stdout := expecter.NewAttachedToInvocation(t, inv)
|
|
err = inv.Run()
|
|
require.NoError(t, err)
|
|
|
|
// Should: display the selected preset as well as its parameters
|
|
presetName := fmt.Sprintf("Preset '%s' applied:", preset.Name)
|
|
stdout.ExpectMatch(ctx, presetName)
|
|
stdout.ExpectMatch(ctx, fmt.Sprintf("%s: '%s'", firstParameterName, secondOptionalParameterValue))
|
|
stdout.ExpectMatch(ctx, fmt.Sprintf("%s: '%s'", thirdParameterName, thirdParameterValue))
|
|
|
|
// Verify if the new workspace uses expected parameters.
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
|
|
defer cancel()
|
|
|
|
// Should: create the user's workspace by claiming the existing prebuilt workspace
|
|
workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{
|
|
Name: workspaceName,
|
|
})
|
|
require.NoError(t, err)
|
|
require.Len(t, workspaces.Workspaces, 1)
|
|
require.Equal(t, prebuild.ID, workspaces.Workspaces[0].ID)
|
|
|
|
// Should: create a workspace using the expected template version and the preset-defined parameters
|
|
workspaceLatestBuild := workspaces.Workspaces[0].LatestBuild
|
|
require.Equal(t, version.ID, workspaceLatestBuild.TemplateVersionID)
|
|
require.Equal(t, presets[0].ID, *workspaceLatestBuild.TemplateVersionPresetID)
|
|
buildParameters, err := client.WorkspaceBuildParameters(ctx, workspaceLatestBuild.ID)
|
|
require.NoError(t, err)
|
|
require.Len(t, buildParameters, 2)
|
|
require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: firstParameterName, Value: secondOptionalParameterValue})
|
|
require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: thirdParameterName, Value: thirdParameterValue})
|
|
})
|
|
|
|
// This test verifies that when the user provides `--preset None`,
|
|
// no preset is applied, no prebuilt workspace is claimed, and
|
|
// a new regular workspace is created instead.
|
|
t.Run("PresetNoneDoesNotClaimPrebuiltWorkspace", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Setup
|
|
ctx := testutil.Context(t, testutil.WaitSuperLong)
|
|
db, pb := dbtestutil.NewDB(t, dbtestutil.WithDumpOnFailure())
|
|
client, _, api, owner := coderdenttest.NewWithAPI(t, &coderdenttest.Options{
|
|
Options: &coderdtest.Options{
|
|
Database: db,
|
|
Pubsub: pb,
|
|
IncludeProvisionerDaemon: true,
|
|
},
|
|
})
|
|
|
|
// Setup Prebuild reconciler
|
|
cache := files.New(prometheus.NewRegistry(), &coderdtest.FakeAuthorizer{})
|
|
newNoopUsageCheckerPtr := func() *atomic.Pointer[wsbuilder.UsageChecker] {
|
|
var noopUsageChecker wsbuilder.UsageChecker = wsbuilder.NoopUsageChecker{}
|
|
buildUsageChecker := atomic.Pointer[wsbuilder.UsageChecker]{}
|
|
buildUsageChecker.Store(&noopUsageChecker)
|
|
return &buildUsageChecker
|
|
}
|
|
reconciler := prebuilds.NewStoreReconciler(
|
|
db, pb, cache,
|
|
codersdk.PrebuildsConfig{},
|
|
testutil.Logger(t),
|
|
quartz.NewMock(t),
|
|
prometheus.NewRegistry(),
|
|
notifications.NewNoopEnqueuer(),
|
|
newNoopUsageCheckerPtr(),
|
|
noop.NewTracerProvider(),
|
|
10,
|
|
nil,
|
|
)
|
|
var claimer agplprebuilds.Claimer = prebuilds.NewEnterpriseClaimer()
|
|
api.AGPL.PrebuildsClaimer.Store(&claimer)
|
|
|
|
// Given: a template and a template version where the preset defines values for all required parameters,
|
|
// and is configured to have 1 prebuild instance
|
|
prebuildInstances := int32(1)
|
|
presetWithPrebuild := proto.Preset{
|
|
Name: "preset-test",
|
|
Parameters: []*proto.PresetParameter{
|
|
{Name: firstParameterName, Value: secondOptionalParameterValue},
|
|
{Name: thirdParameterName, Value: thirdParameterValue},
|
|
},
|
|
Prebuild: &proto.Prebuild{
|
|
Instances: prebuildInstances,
|
|
},
|
|
}
|
|
member, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
|
|
version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, echoResponses(&presetWithPrebuild))
|
|
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
|
|
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID)
|
|
presets, err := client.TemplateVersionPresets(ctx, version.ID)
|
|
require.NoError(t, err)
|
|
require.Len(t, presets, 1)
|
|
|
|
// Given: Reconciliation loop runs and starts prebuilt workspaces
|
|
runReconciliationLoop(t, ctx, db, pb, reconciler, presets)
|
|
runningPrebuilds := getRunningPrebuilds(t, ctx, db, int(prebuildInstances))
|
|
require.Len(t, runningPrebuilds, int(prebuildInstances))
|
|
require.Equal(t, presets[0].ID, runningPrebuilds[0].CurrentPresetID.UUID)
|
|
|
|
// Given: a running prebuilt workspace, ready to be claimed
|
|
prebuild := coderdtest.MustWorkspace(t, client, runningPrebuilds[0].ID)
|
|
require.Equal(t, codersdk.WorkspaceTransitionStart, prebuild.LatestBuild.Transition)
|
|
require.Equal(t, template.ID, prebuild.TemplateID)
|
|
require.Equal(t, version.ID, prebuild.TemplateActiveVersionID)
|
|
require.Equal(t, presets[0].ID, *prebuild.LatestBuild.TemplateVersionPresetID)
|
|
|
|
// When: running the create command without a preset flag
|
|
workspaceName := "my-workspace"
|
|
inv, root := clitest.New(t, "create", workspaceName, "--template", template.Name, "-y",
|
|
"--preset", cli.PresetNone,
|
|
"--parameter", fmt.Sprintf("%s=%s", firstParameterName, firstParameterValue),
|
|
"--parameter", fmt.Sprintf("%s=%s", thirdParameterName, thirdParameterValue))
|
|
clitest.SetupConfig(t, member, root)
|
|
stdout := expecter.NewAttachedToInvocation(t, inv)
|
|
err = inv.Run()
|
|
require.NoError(t, err)
|
|
stdout.ExpectMatch(ctx, "No preset applied.")
|
|
|
|
// Verify if the new workspace uses expected parameters.
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
|
|
defer cancel()
|
|
|
|
// Should: create a new user's workspace without claiming the existing prebuilt workspace
|
|
workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{
|
|
Name: workspaceName,
|
|
})
|
|
require.NoError(t, err)
|
|
require.Len(t, workspaces.Workspaces, 1)
|
|
require.NotEqual(t, prebuild.ID, workspaces.Workspaces[0].ID)
|
|
|
|
// Should: create a workspace using the expected template version and the specified parameters
|
|
workspaceLatestBuild := workspaces.Workspaces[0].LatestBuild
|
|
require.Equal(t, version.ID, workspaceLatestBuild.TemplateVersionID)
|
|
require.Nil(t, workspaceLatestBuild.TemplateVersionPresetID)
|
|
buildParameters, err := client.WorkspaceBuildParameters(ctx, workspaceLatestBuild.ID)
|
|
require.NoError(t, err)
|
|
require.Len(t, buildParameters, 2)
|
|
require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: firstParameterName, Value: firstParameterValue})
|
|
require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: thirdParameterName, Value: thirdParameterValue})
|
|
})
|
|
}
|
|
|
|
func prepareEchoResponses(parameters []*proto.RichParameter, presets ...*proto.Preset) *echo.Responses {
|
|
return &echo.Responses{
|
|
Parse: echo.ParseComplete,
|
|
ProvisionGraph: []*proto.Response{
|
|
{
|
|
Type: &proto.Response_Graph{
|
|
Graph: &proto.GraphComplete{
|
|
Parameters: parameters,
|
|
Presets: presets,
|
|
Resources: []*proto.Resource{
|
|
{
|
|
Type: "compute",
|
|
Name: "main",
|
|
Agents: []*proto.Agent{
|
|
{
|
|
Name: "smith",
|
|
OperatingSystem: "linux",
|
|
Architecture: "i386",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
}
|