- Notifications
You must be signed in to change notification settings - Fork1.1k
feat: implement dynamic parameter validation#18482
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
2 changes: 1 addition & 1 deletioncli/server.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: 5 additions & 2 deletionscoderd/autobuild/lifecycle_executor.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 |
|---|---|---|
| @@ -17,6 +17,7 @@ import ( | ||
| "golang.org/x/xerrors" | ||
| "cdr.dev/slog" | ||
| "github.com/coder/coder/v2/coderd/files" | ||
| "github.com/coder/coder/v2/coderd/audit" | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| @@ -35,6 +36,7 @@ type Executor struct { | ||
| ctx context.Context | ||
| db database.Store | ||
| ps pubsub.Pubsub | ||
| fileCache*files.Cache | ||
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. TIL this is a thing! | ||
| templateScheduleStore*atomic.Pointer[schedule.TemplateScheduleStore] | ||
| accessControlStore*atomic.Pointer[dbauthz.AccessControlStore] | ||
| auditor*atomic.Pointer[audit.Auditor] | ||
| @@ -61,13 +63,14 @@ type Stats struct { | ||
| } | ||
| // New returns a new wsactions executor. | ||
| funcNewExecutor(ctx context.Context,db database.Store,ps pubsub.Pubsub,fc*files.Cache,reg prometheus.Registerer,tss*atomic.Pointer[schedule.TemplateScheduleStore],auditor*atomic.Pointer[audit.Auditor],acs*atomic.Pointer[dbauthz.AccessControlStore],log slog.Logger,tick<-chan time.Time,enqueuer notifications.Enqueuer,exp codersdk.Experiments)*Executor { | ||
| factory:=promauto.With(reg) | ||
| le:=&Executor{ | ||
| //nolint:gocritic // Autostart has a limited set of permissions. | ||
| ctx:dbauthz.AsAutostart(ctx), | ||
| db:db, | ||
| ps:ps, | ||
| fileCache:fc, | ||
| templateScheduleStore:tss, | ||
| tick:tick, | ||
| log:log.Named("autobuild"), | ||
| @@ -276,7 +279,7 @@ func (e *Executor) runOnce(t time.Time) Stats { | ||
| } | ||
| } | ||
| nextBuild,job,_,err=builder.Build(e.ctx,tx,e.fileCache,nil, audit.WorkspaceBuildBaggage{IP:"127.0.0.1"}) | ||
| iferr!=nil { | ||
| returnxerrors.Errorf("build workspace with transition %q: %w",nextTransition,err) | ||
| } | ||
2 changes: 2 additions & 0 deletionscoderd/coderdtest/coderdtest.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
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
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,35 @@ | ||
| package dynamicparameters_test | ||
| import ( | ||
| "testing" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/coder/coder/v2/coderd/dynamicparameters" | ||
| ) | ||
| funcTestProvisionerVersionSupportsDynamicParameters(t*testing.T) { | ||
MemberAuthor 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. This test is just moved | ||
| t.Parallel() | ||
| forv,dyn:=rangemap[string]bool{ | ||
| "":false, | ||
| "na":false, | ||
| "0.0":false, | ||
| "0.10":false, | ||
| "1.4":false, | ||
| "1.5":false, | ||
| "1.6":true, | ||
| "1.7":true, | ||
| "1.8":true, | ||
| "2.0":true, | ||
| "2.17":true, | ||
| "4.0":true, | ||
| } { | ||
| t.Run(v,func(t*testing.T) { | ||
| t.Parallel() | ||
| does:=dynamicparameters.ProvisionerVersionSupportsDynamicParameters(v) | ||
| require.Equal(t,dyn,does) | ||
| }) | ||
| } | ||
| } | ||
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,189 @@ | ||
| package dynamicparameters | ||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "github.com/google/uuid" | ||
| "github.com/hashicorp/hcl/v2" | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/util/slice" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| typeparameterValueSourceint | ||
| const ( | ||
| sourceDefaultparameterValueSource=iota | ||
| sourcePrevious | ||
| sourceBuild | ||
| sourcePreset | ||
| ) | ||
| typeparameterValuestruct { | ||
| Valuestring | ||
| SourceparameterValueSource | ||
| } | ||
| //nolint:revive // firstbuild is a control flag to turn on immutable validation | ||
| funcResolveParameters( | ||
| ctx context.Context, | ||
| ownerID uuid.UUID, | ||
| rendererRenderer, | ||
| firstBuildbool, | ||
| previousValues []database.WorkspaceBuildParameter, | ||
| buildValues []codersdk.WorkspaceBuildParameter, | ||
| presetValues []database.TemplateVersionPresetParameter, | ||
| ) (map[string]string, hcl.Diagnostics) { | ||
| previousValuesMap:=slice.ToMapFunc(previousValues,func(p database.WorkspaceBuildParameter) (string,string) { | ||
| returnp.Name,p.Value | ||
| }) | ||
| // Start with previous | ||
| values:=parameterValueMap(slice.ToMapFunc(previousValues,func(p database.WorkspaceBuildParameter) (string,parameterValue) { | ||
| returnp.Name,parameterValue{Source:sourcePrevious,Value:p.Value} | ||
| })) | ||
| // Add build values (overwrite previous values if they exist) | ||
| for_,buildValue:=rangebuildValues { | ||
| values[buildValue.Name]=parameterValue{Source:sourceBuild,Value:buildValue.Value} | ||
| } | ||
| // Add preset values (overwrite previous and build values if they exist) | ||
| for_,preset:=rangepresetValues { | ||
| values[preset.Name]=parameterValue{Source:sourcePreset,Value:preset.Value} | ||
| } | ||
| // originalValues is going to be used to detect if a user tried to change | ||
| // an immutable parameter after the first build. | ||
| originalValues:=make(map[string]parameterValue,len(values)) | ||
| forname,value:=rangevalues { | ||
| // Store the original values for later use. | ||
| originalValues[name]=value | ||
| } | ||
| // Render the parameters using the values that were supplied to the previous build. | ||
| // | ||
| // This is how the form should look to the user on their workspace settings page. | ||
| // This is the original form truth that our validations should initially be based on. | ||
| output,diags:=renderer.Render(ctx,ownerID,values.ValuesMap()) | ||
| ifdiags.HasErrors() { | ||
| // Top level diagnostics should break the build. Previous values (and new) should | ||
| // always be valid. If there is a case where this is not true, then this has to | ||
| // be changed to allow the build to continue with a different set of values. | ||
| returnnil,diags | ||
| } | ||
| // The user's input now needs to be validated against the parameters. | ||
| // Mutability & Ephemeral parameters depend on sequential workspace builds. | ||
| // | ||
| // To enforce these, the user's input values are trimmed based on the | ||
| // mutability and ephemeral parameters defined in the template version. | ||
| for_,parameter:=rangeoutput.Parameters { | ||
| // Ephemeral parameters should not be taken from the previous build. | ||
| // They must always be explicitly set in every build. | ||
| // So remove their values if they are sourced from the previous build. | ||
| ifparameter.Ephemeral { | ||
| v:=values[parameter.Name] | ||
| ifv.Source==sourcePrevious { | ||
| delete(values,parameter.Name) | ||
| } | ||
| } | ||
| // Immutable parameters should also not be allowed to be changed from | ||
| // the previous build. Remove any values taken from the preset or | ||
| // new build params. This forces the value to be the same as it was before. | ||
| // | ||
| // We do this so the next form render uses the original immutable value. | ||
| if!firstBuild&&!parameter.Mutable { | ||
| delete(values,parameter.Name) | ||
| prev,ok:=previousValuesMap[parameter.Name] | ||
| ifok { | ||
| values[parameter.Name]=parameterValue{ | ||
| Value:prev, | ||
| Source:sourcePrevious, | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // This is the final set of values that will be used. Any errors at this stage | ||
| // are fatal. Additional validation for immutability has to be done manually. | ||
| output,diags=renderer.Render(ctx,ownerID,values.ValuesMap()) | ||
| ifdiags.HasErrors() { | ||
| returnnil,diags | ||
| } | ||
| // parameterNames is going to be used to remove any excess values that were left | ||
| // around without a parameter. | ||
| parameterNames:=make(map[string]struct{},len(output.Parameters)) | ||
| for_,parameter:=rangeoutput.Parameters { | ||
| parameterNames[parameter.Name]=struct{}{} | ||
| if!firstBuild&&!parameter.Mutable { | ||
| // Immutable parameters should not be changed after the first build. | ||
| // They can match the original value though! | ||
| ifparameter.Value.AsString()!=originalValues[parameter.Name].Value { | ||
| varsrc*hcl.Range | ||
| ifparameter.Source!=nil { | ||
| src=¶meter.Source.HCLBlock().TypeRange | ||
| } | ||
| // An immutable parameter was changed, which is not allowed. | ||
| // Add the failed diagnostic to the output. | ||
| diags=diags.Append(&hcl.Diagnostic{ | ||
| Severity:hcl.DiagError, | ||
| Summary:"Immutable parameter changed", | ||
| Detail:fmt.Sprintf("Parameter %q is not mutable, so it can't be updated after creating a workspace.",parameter.Name), | ||
| Subject:src, | ||
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. Nice 👍 | ||
| }) | ||
| } | ||
| } | ||
| // TODO: Fix the `hcl.Diagnostics(...)` type casting. It should not be needed. | ||
| ifhcl.Diagnostics(parameter.Diagnostics).HasErrors() { | ||
| // All validation errors are raised here. | ||
| diags=diags.Extend(hcl.Diagnostics(parameter.Diagnostics)) | ||
| } | ||
Comment on lines +145 to +149 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. follow-up issue? MemberAuthor 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'll do you one better:#18501 Just trying to break out some of the diffs | ||
| // If the parameter has a value, but it was not set explicitly by the user at any | ||
| // build, then save the default value. An example where this is important is if a | ||
| // template has a default value of 'region = us-west-2', but the user never sets | ||
| // it. If the default value changes to 'region = us-east-1', we want to preserve | ||
| // the original value of 'us-west-2' for the existing workspaces. | ||
| // | ||
| // parameter.Value will be populated from the default at this point. So grab it | ||
| // from there. | ||
| if_,ok:=values[parameter.Name];!ok&¶meter.Value.IsKnown()&¶meter.Value.Valid() { | ||
| values[parameter.Name]=parameterValue{ | ||
| Value:parameter.Value.AsString(), | ||
| Source:sourceDefault, | ||
| } | ||
| } | ||
| } | ||
| // Delete any values that do not belong to a parameter. This is to not save | ||
| // parameter values that have no effect. These leaky parameter values can cause | ||
| // problems in the future, as it makes it challenging to remove values from the | ||
| // database | ||
| fork:=rangevalues { | ||
| if_,ok:=parameterNames[k];!ok { | ||
| delete(values,k) | ||
| } | ||
| } | ||
| // Return the values to be saved for the build. | ||
| returnvalues.ValuesMap(),diags | ||
| } | ||
| typeparameterValueMapmap[string]parameterValue | ||
| func (pparameterValueMap)ValuesMap()map[string]string { | ||
| values:=make(map[string]string,len(p)) | ||
| forname,paramValue:=rangep { | ||
| values[name]=paramValue.Value | ||
| } | ||
| returnvalues | ||
| } | ||
40 changes: 24 additions & 16 deletionscoderd/parameters_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.