- Notifications
You must be signed in to change notification settings - Fork928
feat: run a terraform plan before creating workspaces with the given template parameters#1732
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
Show all changes
11 commits Select commitHold shift + click to select a range
3e9ecc3 feat: add new provisioner job type template_version_plan
deansheathercf033aa feat: finish implementing workspace planning
deansheatherbafe1c1 merge main
deansheathercfe34af big tests
deansheather0d03a39 fix: workspaces: relax error assertion
johnstcn4078fd1 fix
deansheather8d04749 fixup! fix
deansheather4b06c72 gen
deansheather2fee23a fixup! gen
deansheather6b95e54 remove heavy object nesting in tests
deansheather0b6d083 Rename template version plan to template version dry run
deansheatherFile 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
31 changes: 29 additions & 2 deletionscli/cliui/provisionerjob.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 |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| package cliui | ||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| @@ -35,6 +36,9 @@ type ProvisionerJobOptions struct { | ||
| FetchInterval time.Duration | ||
| // Verbose determines whether debug and trace logs will be shown. | ||
| Verbose bool | ||
| // Silent determines whether log output will be shown unless there is an | ||
| // error. | ||
| Silent bool | ||
| } | ||
| // ProvisionerJob renders a provisioner job with interactive cancellation. | ||
| @@ -133,12 +137,30 @@ func ProvisionerJob(ctx context.Context, writer io.Writer, opts ProvisionerJobOp | ||
| return xerrors.Errorf("logs: %w", err) | ||
| } | ||
| var ( | ||
| // logOutput is where log output is written | ||
| logOutput = writer | ||
| // logBuffer is where logs are buffered if opts.Silent is true | ||
| logBuffer = &bytes.Buffer{} | ||
| ) | ||
| if opts.Silent { | ||
| logOutput = logBuffer | ||
| } | ||
| flushLogBuffer := func() { | ||
| if opts.Silent { | ||
| _, _ = io.Copy(writer, logBuffer) | ||
| } | ||
| } | ||
| ticker := time.NewTicker(opts.FetchInterval) | ||
| defer ticker.Stop() | ||
deansheather marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| for { | ||
| select { | ||
| case err = <-errChan: | ||
| flushLogBuffer() | ||
| return err | ||
| case <-ctx.Done(): | ||
| flushLogBuffer() | ||
| return ctx.Err() | ||
| case <-ticker.C: | ||
| updateJob() | ||
| @@ -160,8 +182,10 @@ func ProvisionerJob(ctx context.Context, writer io.Writer, opts ProvisionerJobOp | ||
| } | ||
| err = xerrors.New(job.Error) | ||
| jobMutex.Unlock() | ||
| flushLogBuffer() | ||
| return err | ||
| } | ||
| output := "" | ||
| switch log.Level { | ||
| case codersdk.LogLevelTrace, codersdk.LogLevelDebug: | ||
| @@ -176,14 +200,17 @@ func ProvisionerJob(ctx context.Context, writer io.Writer, opts ProvisionerJobOp | ||
| case codersdk.LogLevelInfo: | ||
| output = log.Output | ||
| } | ||
| jobMutex.Lock() | ||
| if log.Stage != currentStage && log.Stage != "" { | ||
| updateStage(log.Stage, log.CreatedAt) | ||
| jobMutex.Unlock() | ||
| continue | ||
| } | ||
| _, _ = fmt.Fprintf(logOutput, "%s %s\n", Styles.Placeholder.Render(" "), output) | ||
| if !opts.Silent { | ||
| didLogBetweenStage = true | ||
| } | ||
| jobMutex.Unlock() | ||
| } | ||
| } | ||
37 changes: 33 additions & 4 deletionscli/create.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 |
|---|---|---|
| @@ -170,10 +170,40 @@ func create() *cobra.Command { | ||
| } | ||
| _, _ = fmt.Fprintln(cmd.OutOrStdout()) | ||
| // Run a dry-run with the given parameters to check correctness | ||
| after := time.Now() | ||
| dryRun, err := client.CreateTemplateVersionDryRun(cmd.Context(), templateVersion.ID, codersdk.CreateTemplateVersionDryRunRequest{ | ||
| WorkspaceName: workspaceName, | ||
| ParameterValues: parameters, | ||
| }) | ||
| if err != nil { | ||
| return xerrors.Errorf("begin workspace dry-run: %w", err) | ||
| } | ||
| _, _ = fmt.Fprintln(cmd.OutOrStdout(), "Planning workspace...") | ||
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. I kept the language "Planning workspace" because I couldn't come up with something that made sense with the word "dry-run".... "Dry-running workspace" "Running workspace dry-run" etc. | ||
| err = cliui.ProvisionerJob(cmd.Context(), cmd.OutOrStdout(), cliui.ProvisionerJobOptions{ | ||
| Fetch: func() (codersdk.ProvisionerJob, error) { | ||
| return client.TemplateVersionDryRun(cmd.Context(), templateVersion.ID, dryRun.ID) | ||
| }, | ||
| Cancel: func() error { | ||
| return client.CancelTemplateVersionDryRun(cmd.Context(), templateVersion.ID, dryRun.ID) | ||
| }, | ||
| Logs: func() (<-chan codersdk.ProvisionerJobLog, error) { | ||
| return client.TemplateVersionDryRunLogsAfter(cmd.Context(), templateVersion.ID, dryRun.ID, after) | ||
| }, | ||
| // Don't show log output for the dry-run unless there's an error. | ||
| Silent: true, | ||
| }) | ||
| if err != nil { | ||
| // TODO (Dean): reprompt for parameter values if we deem it to | ||
| // be a validation error | ||
Comment on lines +197 to +198 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. TODO: open an issue 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. | ||
| return xerrors.Errorf("dry-run workspace: %w", err) | ||
| } | ||
| resources, err := client.TemplateVersionDryRunResources(cmd.Context(), templateVersion.ID, dryRun.ID) | ||
| if err != nil { | ||
| return xerrors.Errorf("get workspace dry-run resources: %w", err) | ||
| } | ||
| err = cliui.WorkspaceResources(cmd.OutOrStdout(), resources, cliui.WorkspaceResourcesOptions{ | ||
| WorkspaceName: workspaceName, | ||
| // Since agent's haven't connected yet, hiding this makes more sense. | ||
| @@ -192,7 +222,6 @@ func create() *cobra.Command { | ||
| return err | ||
| } | ||
| workspace, err := client.CreateWorkspace(cmd.Context(), organization.ID, codersdk.CreateWorkspaceRequest{ | ||
| TemplateID: template.ID, | ||
| Name: workspaceName, | ||
| @@ -204,7 +233,7 @@ func create() *cobra.Command { | ||
| return err | ||
| } | ||
| err = cliui.WorkspaceBuild(cmd.Context(), cmd.OutOrStdout(), client, workspace.LatestBuild.ID,after) | ||
| if err != nil { | ||
| return err | ||
| } | ||
48 changes: 48 additions & 0 deletionscli/create_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
7 changes: 7 additions & 0 deletionscoderd/coderd.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
26 changes: 26 additions & 0 deletionscoderd/coderd_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
3 changes: 2 additions & 1 deletioncoderd/database/dump.sql
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
9 changes: 9 additions & 0 deletionscoderd/database/migrations/000099_provisioner_job_type_dry_run.down.sql
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 |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| -- It's not possible to drop enum values from enum types, so the UP has "IF NOT | ||
| -- EXISTS". | ||
| -- Delete all jobs that use the new enum value. | ||
| DELETE FROM | ||
| provisioner_jobs | ||
| WHERE | ||
| type = 'template_version_dry_run' | ||
| ; |
2 changes: 2 additions & 0 deletionscoderd/database/migrations/000099_provisioner_job_type_dry_run.up.sql
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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| ALTER TYPE provisioner_job_type | ||
| ADD VALUE IF NOT EXISTS 'template_version_dry_run'; |
1 change: 1 addition & 0 deletionscoderd/database/models.go
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
19 changes: 14 additions & 5 deletionscoderd/parameter/compute.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.