package executor_test import ( "context" "fmt" "os" "strings" "testing" "time" "go.uber.org/goleak" "github.com/coder/coder/coderd/autobuild/executor" "github.com/coder/coder/coderd/autobuild/schedule" "github.com/coder/coder/coderd/coderdtest" "github.com/coder/coder/coderd/database" "github.com/coder/coder/coderd/util/ptr" "github.com/coder/coder/codersdk" "github.com/google/uuid" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func TestExecutorAutostartOK(t *testing.T) { t.Parallel() var ( ctx = context.Background() err error tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) ) // Given: workspace is stopped workspace = mustTransitionWorkspace(t, client, workspace.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionStop) // When: we enable workspace autostart sched, err := schedule.Weekly("* * * * *") require.NoError(t, err) require.NoError(t, client.UpdateWorkspaceAutostart(ctx, workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{ Schedule: ptr.Ref(sched.String()), })) // When: the autobuild executor ticks go func() { tickCh <- time.Now().UTC().Add(time.Minute) close(tickCh) }() // Then: the workspace should eventually be started stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 1) assert.Contains(t, stats.Transitions, workspace.ID) assert.Equal(t, database.WorkspaceTransitionStart, stats.Transitions[workspace.ID]) } func TestExecutorAutostartTemplateUpdated(t *testing.T) { t.Parallel() var ( ctx = context.Background() err error tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) ) // Given: workspace is stopped workspace = mustTransitionWorkspace(t, client, workspace.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionStop) // Given: the workspace template has been updated orgs, err := client.OrganizationsByUser(ctx, workspace.OwnerID.String()) require.NoError(t, err) require.Len(t, orgs, 1) newVersion := coderdtest.UpdateTemplateVersion(t, client, orgs[0].ID, nil, workspace.TemplateID) coderdtest.AwaitTemplateVersionJob(t, client, newVersion.ID) require.NoError(t, client.UpdateActiveTemplateVersion(ctx, workspace.TemplateID, codersdk.UpdateActiveTemplateVersion{ ID: newVersion.ID, })) // When: we enable workspace autostart sched, err := schedule.Weekly("* * * * *") require.NoError(t, err) require.NoError(t, client.UpdateWorkspaceAutostart(ctx, workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{ Schedule: ptr.Ref(sched.String()), })) // When: the autobuild executor ticks go func() { tickCh <- time.Now().UTC().Add(time.Minute) close(tickCh) }() // Then: the workspace should be started using the previous template version, and not the updated version. stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 1) assert.Contains(t, stats.Transitions, workspace.ID) assert.Equal(t, database.WorkspaceTransitionStart, stats.Transitions[workspace.ID]) ws := mustWorkspace(t, client, workspace.ID) assert.Equal(t, workspace.LatestBuild.TemplateVersionID, ws.LatestBuild.TemplateVersionID, "expected workspace build to be using the old template version") } func TestExecutorAutostartAlreadyRunning(t *testing.T) { t.Parallel() var ( ctx = context.Background() err error tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) ) // Given: we ensure the workspace is running require.Equal(t, codersdk.WorkspaceTransitionStart, workspace.LatestBuild.Transition) // When: we enable workspace autostart sched, err := schedule.Weekly("* * * * *") require.NoError(t, err) require.NoError(t, client.UpdateWorkspaceAutostart(ctx, workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{ Schedule: ptr.Ref(sched.String()), })) // When: the autobuild executor ticks go func() { tickCh <- time.Now().UTC().Add(time.Minute) close(tickCh) }() // Then: the workspace should not be started. stats := <-statsCh require.NoError(t, stats.Error) require.Len(t, stats.Transitions, 0) } func TestExecutorAutostartNotEnabled(t *testing.T) { t.Parallel() var ( tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client, func(cwr *codersdk.CreateWorkspaceRequest) { cwr.AutostartSchedule = nil }) ) // Given: workspace does not have autostart enabled require.Empty(t, workspace.AutostartSchedule) // Given: workspace is stopped workspace = mustTransitionWorkspace(t, client, workspace.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionStop) // When: the autobuild executor ticks go func() { tickCh <- time.Now().UTC().Add(time.Minute) close(tickCh) }() // Then: the workspace should not be started. stats := <-statsCh require.NoError(t, stats.Error) require.Len(t, stats.Transitions, 0) } func TestExecutorAutostopOK(t *testing.T) { t.Parallel() var ( tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) ) // Given: workspace is running require.Equal(t, codersdk.WorkspaceTransitionStart, workspace.LatestBuild.Transition) require.NotZero(t, workspace.LatestBuild.Deadline) // When: the autobuild executor ticks *after* the deadline: go func() { tickCh <- workspace.LatestBuild.Deadline.Add(time.Minute) close(tickCh) }() // Then: the workspace should be stopped stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 1) assert.Contains(t, stats.Transitions, workspace.ID) assert.Equal(t, database.WorkspaceTransitionStop, stats.Transitions[workspace.ID]) } func TestExecutorAutostopExtend(t *testing.T) { t.Parallel() var ( ctx = context.Background() tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) originalDeadline = workspace.LatestBuild.Deadline ) // Given: workspace is running require.Equal(t, codersdk.WorkspaceTransitionStart, workspace.LatestBuild.Transition) require.NotZero(t, originalDeadline) // Given: we extend the workspace deadline newDeadline := originalDeadline.Add(30 * time.Minute) err := client.PutExtendWorkspace(ctx, workspace.ID, codersdk.PutExtendWorkspaceRequest{ Deadline: newDeadline, }) require.NoError(t, err, "extend workspace deadline") // When: the autobuild executor ticks *after* the original deadline: go func() { tickCh <- originalDeadline.Add(time.Minute) }() // Then: nothing should happen and the workspace should stay running stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 0) // When: the autobuild executor ticks after the *new* deadline: go func() { tickCh <- newDeadline.Add(time.Minute) close(tickCh) }() // Then: the workspace should be stopped stats = <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 1) assert.Contains(t, stats.Transitions, workspace.ID) assert.Equal(t, database.WorkspaceTransitionStop, stats.Transitions[workspace.ID]) } func TestExecutorAutostopAlreadyStopped(t *testing.T) { t.Parallel() var ( tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace (disabling autostart) workspace = mustProvisionWorkspace(t, client, func(cwr *codersdk.CreateWorkspaceRequest) { cwr.AutostartSchedule = nil }) ) // Given: workspace is stopped workspace = mustTransitionWorkspace(t, client, workspace.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionStop) // When: the autobuild executor ticks past the TTL go func() { tickCh <- workspace.LatestBuild.Deadline.Add(time.Minute) close(tickCh) }() // Then: the workspace should remain stopped and no build should happen. stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 0) } func TestExecutorAutostopNotEnabled(t *testing.T) { t.Parallel() var ( tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace that has no TTL set workspace = mustProvisionWorkspace(t, client, func(cwr *codersdk.CreateWorkspaceRequest) { cwr.TTLMillis = nil }) ) // Given: workspace has no TTL set require.Nil(t, workspace.TTLMillis) // Given: workspace is running require.Equal(t, codersdk.WorkspaceTransitionStart, workspace.LatestBuild.Transition) // When: the autobuild executor ticks past the TTL go func() { tickCh <- workspace.LatestBuild.Deadline.Add(time.Minute) close(tickCh) }() // Then: the workspace should not be stopped. stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 0) } func TestExecutorWorkspaceDeleted(t *testing.T) { t.Parallel() var ( ctx = context.Background() err error tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) ) // When: we enable workspace autostart sched, err := schedule.Weekly("* * * * *") require.NoError(t, err) require.NoError(t, client.UpdateWorkspaceAutostart(ctx, workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{ Schedule: ptr.Ref(sched.String()), })) // Given: workspace is deleted workspace = mustTransitionWorkspace(t, client, workspace.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionDelete) // When: the autobuild executor ticks go func() { tickCh <- time.Now().UTC().Add(time.Minute) close(tickCh) }() // Then: nothing should happen stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 0) } func TestExecutorWorkspaceAutostartTooEarly(t *testing.T) { t.Parallel() var ( ctx = context.Background() err error tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) futureTime = time.Now().Add(time.Hour) futureTimeCron = fmt.Sprintf("%d %d * * *", futureTime.Minute(), futureTime.Hour()) // Given: we have a user with a workspace configured to autostart some time in the future workspace = mustProvisionWorkspace(t, client, func(cwr *codersdk.CreateWorkspaceRequest) { cwr.AutostartSchedule = &futureTimeCron }) ) // When: we enable workspace autostart with some time in the future sched, err := schedule.Weekly(futureTimeCron) require.NoError(t, err) require.NoError(t, client.UpdateWorkspaceAutostart(ctx, workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{ Schedule: ptr.Ref(sched.String()), })) // When: the autobuild executor ticks go func() { tickCh <- time.Now().UTC() close(tickCh) }() // Then: nothing should happen stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 0) } func TestExecutorWorkspaceAutostopBeforeDeadline(t *testing.T) { t.Parallel() var ( tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) ) // When: the autobuild executor ticks before the TTL go func() { tickCh <- workspace.LatestBuild.Deadline.Add(-1 * time.Minute) close(tickCh) }() // Then: nothing should happen stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 0) } func TestExecutorWorkspaceAutostopNoWaitChangedMyMind(t *testing.T) { t.Parallel() var ( ctx = context.Background() tickCh = make(chan time.Time) statsCh = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh, }) // Given: we have a user with a workspace workspace = mustProvisionWorkspace(t, client) ) // Given: the user changes their mind and decides their workspace should not auto-stop err := client.UpdateWorkspaceTTL(ctx, workspace.ID, codersdk.UpdateWorkspaceTTLRequest{TTLMillis: nil}) require.NoError(t, err) // When: the autobuild executor ticks after the deadline go func() { tickCh <- workspace.LatestBuild.Deadline.Add(time.Minute) close(tickCh) }() // Then: the workspace should still stop - sorry! stats := <-statsCh assert.NoError(t, stats.Error) assert.Len(t, stats.Transitions, 1) assert.Contains(t, stats.Transitions, workspace.ID) assert.Equal(t, database.WorkspaceTransitionStop, stats.Transitions[workspace.ID]) } func TestExecutorAutostartMultipleOK(t *testing.T) { if os.Getenv("DB") == "" { t.Skip(`This test only really works when using a "real" database, similar to a HA setup`) } t.Parallel() var ( tickCh = make(chan time.Time) tickCh2 = make(chan time.Time) statsCh1 = make(chan executor.Stats) statsCh2 = make(chan executor.Stats) client = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh, IncludeProvisionerD: true, AutobuildStats: statsCh1, }) _ = coderdtest.New(t, &coderdtest.Options{ AutobuildTicker: tickCh2, IncludeProvisionerD: true, AutobuildStats: statsCh2, }) // Given: we have a user with a workspace that has autostart enabled (default) workspace = mustProvisionWorkspace(t, client) ) // Given: workspace is stopped workspace = mustTransitionWorkspace(t, client, workspace.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionStop) // When: the autobuild executor ticks go func() { tickCh <- time.Now().UTC().Add(time.Minute) tickCh2 <- time.Now().UTC().Add(time.Minute) close(tickCh) close(tickCh2) }() // Then: the workspace should eventually be started stats1 := <-statsCh1 assert.NoError(t, stats1.Error) assert.Len(t, stats1.Transitions, 1) assert.Contains(t, stats1.Transitions, workspace.ID) assert.Equal(t, database.WorkspaceTransitionStart, stats1.Transitions[workspace.ID]) // Then: the other executor should not have done anything stats2 := <-statsCh2 assert.NoError(t, stats2.Error) assert.Len(t, stats2.Transitions, 0) } func mustProvisionWorkspace(t *testing.T, client *codersdk.Client, mut ...func(*codersdk.CreateWorkspaceRequest)) codersdk.Workspace { t.Helper() user := coderdtest.CreateFirstUser(t, client) version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil) template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID) coderdtest.AwaitTemplateVersionJob(t, client, version.ID) ws := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID, mut...) coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID) return mustWorkspace(t, client, ws.ID) } func mustTransitionWorkspace(t *testing.T, client *codersdk.Client, workspaceID uuid.UUID, from, to database.WorkspaceTransition) codersdk.Workspace { t.Helper() ctx := context.Background() workspace, err := client.Workspace(ctx, workspaceID) require.NoError(t, err, "unexpected error fetching workspace") require.Equal(t, workspace.LatestBuild.Transition, codersdk.WorkspaceTransition(from), "expected workspace state: %s got: %s", from, workspace.LatestBuild.Transition) template, err := client.Template(ctx, workspace.TemplateID) require.NoError(t, err, "fetch workspace template") build, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{ TemplateVersionID: template.ActiveVersionID, Transition: codersdk.WorkspaceTransition(to), }) require.NoError(t, err, "unexpected error transitioning workspace to %s", to) _ = coderdtest.AwaitWorkspaceBuildJob(t, client, build.ID) updated := mustWorkspace(t, client, workspace.ID) require.Equal(t, codersdk.WorkspaceTransition(to), updated.LatestBuild.Transition, "expected workspace to be in state %s but got %s", to, updated.LatestBuild.Transition) return updated } func mustWorkspace(t *testing.T, client *codersdk.Client, workspaceID uuid.UUID) codersdk.Workspace { t.Helper() ctx := context.Background() ws, err := client.Workspace(ctx, workspaceID) if err != nil && strings.Contains(err.Error(), "status code 410") { ws, err = client.DeletedWorkspace(ctx, workspaceID) } require.NoError(t, err, "no workspace found with id %s", workspaceID) return ws } func TestMain(m *testing.M) { goleak.VerifyTestMain(m) }