- Notifications
You must be signed in to change notification settings - Fork1.1k
fix(coderd): ensure lifecycle executor has sufficient task permissions#20539
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
172 changes: 172 additions & 0 deletionscoderd/autobuild/lifecycle_executor_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1764,3 +1764,175 @@ func TestExecutorAutostartSkipsWhenNoProvisionersAvailable(t *testing.T) { | ||
| assert.Len(t, stats.Transitions, 1, "should create builds when provisioners are available") | ||
| } | ||
| func TestExecutorTaskWorkspace(t *testing.T) { | ||
| t.Parallel() | ||
| createTaskTemplate := func(t *testing.T, client *codersdk.Client, orgID uuid.UUID, ctx context.Context, defaultTTL time.Duration) codersdk.Template { | ||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Can we avoid duplication here? I'm fine to defer cleanup to later though. ContributorAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. What thoughts do you have here? Is this related to how many similar test utilities we have for creating task templates? Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Yup, similar test setups, but let's defer 👍🏻 | ||
| t.Helper() | ||
| taskAppID := uuid.New() | ||
| version := coderdtest.CreateTemplateVersion(t, client, orgID, &echo.Responses{ | ||
| Parse: echo.ParseComplete, | ||
| ProvisionPlan: []*proto.Response{ | ||
| { | ||
| Type: &proto.Response_Plan{ | ||
| Plan: &proto.PlanComplete{HasAiTasks: true}, | ||
| }, | ||
| }, | ||
| }, | ||
| ProvisionApply: []*proto.Response{ | ||
| { | ||
| Type: &proto.Response_Apply{ | ||
| Apply: &proto.ApplyComplete{ | ||
| Resources: []*proto.Resource{ | ||
| { | ||
| Agents: []*proto.Agent{ | ||
| { | ||
| Id: uuid.NewString(), | ||
| Name: "dev", | ||
| Auth: &proto.Agent_Token{ | ||
| Token: uuid.NewString(), | ||
| }, | ||
| Apps: []*proto.App{ | ||
| { | ||
| Id: taskAppID.String(), | ||
| Slug: "task-app", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| AiTasks: []*proto.AITask{ | ||
| { | ||
| AppId: taskAppID.String(), | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
| coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID) | ||
| template := coderdtest.CreateTemplate(t, client, orgID, version.ID) | ||
| if defaultTTL > 0 { | ||
| _, err := client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{ | ||
| DefaultTTLMillis: defaultTTL.Milliseconds(), | ||
| }) | ||
| require.NoError(t, err) | ||
| } | ||
| return template | ||
| } | ||
| createTaskWorkspace := func(t *testing.T, client *codersdk.Client, template codersdk.Template, ctx context.Context, input string) codersdk.Workspace { | ||
| t.Helper() | ||
| exp := codersdk.NewExperimentalClient(client) | ||
| task, err := exp.CreateTask(ctx, "me", codersdk.CreateTaskRequest{ | ||
| TemplateVersionID: template.ActiveVersionID, | ||
| Input: input, | ||
| }) | ||
| require.NoError(t, err) | ||
| require.True(t, task.WorkspaceID.Valid, "task should have a workspace") | ||
| workspace, err := client.Workspace(ctx, task.WorkspaceID.UUID) | ||
| require.NoError(t, err) | ||
| coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID) | ||
| return workspace | ||
| } | ||
| t.Run("Autostart", func(t *testing.T) { | ||
| t.Parallel() | ||
| var ( | ||
| ctx = testutil.Context(t, testutil.WaitShort) | ||
| sched = mustSchedule(t, "CRON_TZ=UTC 0 * * * *") | ||
| tickCh = make(chan time.Time) | ||
| statsCh = make(chan autobuild.Stats) | ||
| client, db = coderdtest.NewWithDatabase(t, &coderdtest.Options{ | ||
| AutobuildTicker: tickCh, | ||
| IncludeProvisionerDaemon: true, | ||
| AutobuildStats: statsCh, | ||
| }) | ||
| admin = coderdtest.CreateFirstUser(t, client) | ||
| ) | ||
| // Given: A task workspace | ||
| template := createTaskTemplate(t, client, admin.OrganizationID, ctx, 0) | ||
| workspace := createTaskWorkspace(t, client, template, ctx, "test task for autostart") | ||
| // Given: The task workspace has an autostart schedule | ||
| err := client.UpdateWorkspaceAutostart(ctx, workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{ | ||
| Schedule: ptr.Ref(sched.String()), | ||
| }) | ||
| require.NoError(t, err) | ||
| // Given: That the workspace is in a stopped state. | ||
| workspace = coderdtest.MustTransitionWorkspace(t, client, workspace.ID, codersdk.WorkspaceTransitionStart, codersdk.WorkspaceTransitionStop) | ||
| p, err := coderdtest.GetProvisionerForTags(db, time.Now(), workspace.OrganizationID, map[string]string{}) | ||
| require.NoError(t, err) | ||
| // When: the autobuild executor ticks after the scheduled time | ||
| go func() { | ||
| tickTime := sched.Next(workspace.LatestBuild.CreatedAt) | ||
| coderdtest.UpdateProvisionerLastSeenAt(t, db, p.ID, tickTime) | ||
| tickCh <- tickTime | ||
| close(tickCh) | ||
| }() | ||
| // Then: We expect to see a start transition | ||
| stats := <-statsCh | ||
| require.Len(t, stats.Transitions, 1, "lifecycle executor should transition the task workspace") | ||
| assert.Contains(t, stats.Transitions, workspace.ID, "task workspace should be in transitions") | ||
| assert.Equal(t, database.WorkspaceTransitionStart, stats.Transitions[workspace.ID], "should autostart the workspace") | ||
| require.Empty(t, stats.Errors, "should have no errors when managing task workspaces") | ||
| }) | ||
| t.Run("Autostop", func(t *testing.T) { | ||
| t.Parallel() | ||
| var ( | ||
| ctx = testutil.Context(t, testutil.WaitShort) | ||
| tickCh = make(chan time.Time) | ||
| statsCh = make(chan autobuild.Stats) | ||
| client, db = coderdtest.NewWithDatabase(t, &coderdtest.Options{ | ||
| AutobuildTicker: tickCh, | ||
| IncludeProvisionerDaemon: true, | ||
| AutobuildStats: statsCh, | ||
| }) | ||
| admin = coderdtest.CreateFirstUser(t, client) | ||
| ) | ||
| // Given: A task workspace with an 8 hour deadline | ||
| template := createTaskTemplate(t, client, admin.OrganizationID, ctx, 8*time.Hour) | ||
| workspace := createTaskWorkspace(t, client, template, ctx, "test task for autostop") | ||
| // Given: The workspace is currently running | ||
| workspace = coderdtest.MustWorkspace(t, client, workspace.ID) | ||
| require.Equal(t, codersdk.WorkspaceTransitionStart, workspace.LatestBuild.Transition) | ||
| require.NotZero(t, workspace.LatestBuild.Deadline, "workspace should have a deadline for autostop") | ||
| p, err := coderdtest.GetProvisionerForTags(db, time.Now(), workspace.OrganizationID, map[string]string{}) | ||
| require.NoError(t, err) | ||
| // When: the autobuild executor ticks after the deadline | ||
| go func() { | ||
| tickTime := workspace.LatestBuild.Deadline.Time.Add(time.Minute) | ||
| coderdtest.UpdateProvisionerLastSeenAt(t, db, p.ID, tickTime) | ||
| tickCh <- tickTime | ||
| close(tickCh) | ||
| }() | ||
| // Then: We expect to see a stop transition | ||
| stats := <-statsCh | ||
| require.Len(t, stats.Transitions, 1, "lifecycle executor should transition the task workspace") | ||
| assert.Contains(t, stats.Transitions, workspace.ID, "task workspace should be in transitions") | ||
| assert.Equal(t, database.WorkspaceTransitionStop, stats.Transitions[workspace.ID], "should autostop the workspace") | ||
| require.Empty(t, stats.Errors, "should have no errors when managing task workspaces") | ||
| }) | ||
| } | ||
1 change: 1 addition & 0 deletionscoderd/database/dbauthz/dbauthz.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.