- Notifications
You must be signed in to change notification settings - Fork1k
fix(coderd/wsbuilder): correctly evaluate dynamic workspace tag values#15897
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
10 commits Select commitHold shift + click to select a range
0ebaeb2 chore(enterprise/coderd/coderdenttest: add NewExternalProvisionerDaem…
johnstcnf8a0356 chore(enterprise/coderd): RED: add TestWorkspaceTagsTerraform
johnstcn2279385 coderd/wsbuilder: pass template variable values to workspace tag eval…
johnstcnf7cb744 wsbuilder: make tests pass
johnstcnc6fe518 fixup! wsbuilder: make tests pass
johnstcn40d3dfe coderd/wsbuilder: improve test coverage of workspace tags
johnstcne17bceb fix more tests
johnstcncf7d67e broaden test coverage
johnstcn5b3c33a formatting
johnstcn82d8c93 address PR comments
johnstcnFile 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
86 changes: 44 additions & 42 deletionscoderd/wsbuilder/wsbuilder.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 |
|---|---|---|
| @@ -12,9 +12,9 @@ import ( | ||
| "github.com/hashicorp/hcl/v2" | ||
| "github.com/hashicorp/hcl/v2/hclsyntax" | ||
| "github.com/coder/coder/v2/coderd/rbac/policy" | ||
| "github.com/coder/coder/v2/provisioner/terraform/tfparse" | ||
| "github.com/coder/coder/v2/provisionersdk" | ||
| "github.com/google/uuid" | ||
| @@ -64,6 +64,7 @@ type Builder struct { | ||
| templateVersion *database.TemplateVersion | ||
| templateVersionJob *database.ProvisionerJob | ||
| templateVersionParameters *[]database.TemplateVersionParameter | ||
| templateVersionVariables *[]database.TemplateVersionVariable | ||
| templateVersionWorkspaceTags *[]database.TemplateVersionWorkspaceTag | ||
| lastBuild *database.WorkspaceBuild | ||
| lastBuildErr *error | ||
| @@ -617,6 +618,22 @@ func (b *Builder) getTemplateVersionParameters() ([]database.TemplateVersionPara | ||
| return tvp, nil | ||
| } | ||
| func (b *Builder) getTemplateVersionVariables() ([]database.TemplateVersionVariable, error) { | ||
| if b.templateVersionVariables != nil { | ||
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. Should we use a mutex/atomic here? 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 don't think the builder is meant to be safe for concurrent use. 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. Yea, we do this pattern everywhere. It's all single threaded | ||
| return *b.templateVersionVariables, nil | ||
| } | ||
| tvID, err := b.getTemplateVersionID() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("get template version ID to get variables: %w", err) | ||
| } | ||
| tvs, err := b.store.GetTemplateVersionVariables(b.ctx, tvID) | ||
| if err != nil && !xerrors.Is(err, sql.ErrNoRows) { | ||
| return nil, xerrors.Errorf("get template version %s variables: %w", tvID, err) | ||
| } | ||
| b.templateVersionVariables = &tvs | ||
| return tvs, nil | ||
| } | ||
| // verifyNoLegacyParameters verifies that initiator can't start the workspace build | ||
| // if it uses legacy parameters (database.ParameterSchemas). | ||
| func (b *Builder) verifyNoLegacyParameters() error { | ||
| @@ -678,17 +695,40 @@ func (b *Builder) getProvisionerTags() (map[string]string, error) { | ||
| tags[name] = value | ||
| } | ||
| // Step 2: Mutate workspace tags: | ||
| // - Get workspace tags from the template version job | ||
| // - Get template version variables from the template version as they can be | ||
| // referenced in workspace tags | ||
| // - Get parameters from the workspace build as they can also be referenced | ||
| // in workspace tags | ||
| // - Evaluate workspace tags given the above inputs | ||
| workspaceTags, err := b.getTemplateVersionWorkspaceTags() | ||
| if err != nil { | ||
| return nil, BuildError{http.StatusInternalServerError, "failed to fetch template version workspace tags", err} | ||
| } | ||
| tvs, err := b.getTemplateVersionVariables() | ||
| if err != nil { | ||
| return nil, BuildError{http.StatusInternalServerError, "failed to fetch template version variables", err} | ||
| } | ||
| varsM := make(map[string]string) | ||
| for _, tv := range tvs { | ||
| // FIXME: do this in Terraform? This is a bit of a hack. | ||
| if tv.Value == "" { | ||
| varsM[tv.Name] = tv.DefaultValue | ||
| } else { | ||
| varsM[tv.Name] = tv.Value | ||
| } | ||
| } | ||
| parameterNames, parameterValues, err := b.getParameters() | ||
| if err != nil { | ||
| return nil, err // already wrapped BuildError | ||
| } | ||
| paramsM := make(map[string]string) | ||
| for i, name := range parameterNames { | ||
| paramsM[name] = parameterValues[i] | ||
| } | ||
| evalCtx :=tfparse.BuildEvalContext(varsM, paramsM) | ||
| for _, workspaceTag := range workspaceTags { | ||
| expr, diags := hclsyntax.ParseExpression([]byte(workspaceTag.Value), "expression.hcl", hcl.InitialPos) | ||
| if diags.HasErrors() { | ||
| @@ -701,7 +741,7 @@ func (b *Builder) getProvisionerTags() (map[string]string, error) { | ||
| } | ||
| // Do not use "val.AsString()" as it can panic | ||
| str, err :=tfparse.CtyValueString(val) | ||
| if err != nil { | ||
| return nil, BuildError{http.StatusBadRequest, "failed to marshal cty.Value as string", err} | ||
| } | ||
| @@ -710,44 +750,6 @@ func (b *Builder) getProvisionerTags() (map[string]string, error) { | ||
| return tags, nil | ||
| } | ||
| func (b *Builder) getTemplateVersionWorkspaceTags() ([]database.TemplateVersionWorkspaceTag, error) { | ||
| if b.templateVersionWorkspaceTags != nil { | ||
| return *b.templateVersionWorkspaceTags, nil | ||
56 changes: 48 additions & 8 deletionscoderd/wsbuilder/wsbuilder_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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.