- Notifications
You must be signed in to change notification settings - Fork928
feat: Allow inheriting parameters from previous template_versions when updating a template#2397
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
18 commits Select commitHold shift + click to select a range
ed33a1c WIP: feat: Update templates also updates parameters
Emyrk1f2892c Insert params for template version update
Emyrk8d62c96 feat: Implement parameters list
Emyrkaceca62 Working implementation of inherited params
Emyrkeffbde7 Merge remote-tracking branch 'origin/main' into stevenmasley/template…
Emyrke569f0f Fix name of enum
Emyrk2e5bf44 Lint cleanup
Emyrke5b90bc Enable always prompting of params
Emyrk9d17dac Fix db query for scope enum
Emyrk04098c3 Update comment
Emyrk3422844 Fix list parameters
Emyrk5f881aa Rename field
Emyrkbcca07a Merge remote-tracking branch 'origin/main' into stevenmasley/template…
Emyrkc43aedc Unit test param prompting
Emyrkfa9b230 Add "--always-prompt" flag and logging info
Emyrk9438db8 Linting fixes
Emyrk5c590ae Linting
Emyrkf46b4af Remove excessive prompt
EmyrkFile 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
15 changes: 11 additions & 4 deletionscli/parameterslist.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
105 changes: 87 additions & 18 deletionscli/templatecreate.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 |
|---|---|---|
| @@ -82,7 +82,13 @@ func templateCreate() *cobra.Command { | ||
| } | ||
| spin.Stop() | ||
| job, _, err := createValidTemplateVersion(cmd, createValidTemplateVersionArgs{ | ||
| Client: client, | ||
| Organization: organization, | ||
| Provisioner: database.ProvisionerType(provisioner), | ||
| FileHash: resp.Hash, | ||
| ParameterFile: parameterFile, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| @@ -98,7 +104,6 @@ func templateCreate() *cobra.Command { | ||
| createReq := codersdk.CreateTemplateRequest{ | ||
| Name: templateName, | ||
| VersionID: job.ID, | ||
| MaxTTLMillis: ptr.Ref(maxTTL.Milliseconds()), | ||
| MinAutostartIntervalMillis: ptr.Ref(minAutostartInterval.Milliseconds()), | ||
| } | ||
| @@ -133,14 +138,34 @@ func templateCreate() *cobra.Command { | ||
| return cmd | ||
| } | ||
| type createValidTemplateVersionArgs struct { | ||
| Client *codersdk.Client | ||
| Organization codersdk.Organization | ||
| Provisioner database.ProvisionerType | ||
| FileHash string | ||
| ParameterFile string | ||
| // Template is only required if updating a template's active version. | ||
| Template *codersdk.Template | ||
| // ReuseParameters will attempt to reuse params from the Template field | ||
| // before prompting the user. Set to false to always prompt for param | ||
| // values. | ||
| ReuseParameters bool | ||
| } | ||
| func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVersionArgs, parameters ...codersdk.CreateParameterRequest) (*codersdk.TemplateVersion, []codersdk.CreateParameterRequest, error) { | ||
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. yeah we're there now :D (args struct) 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 really want to try refactoring this function. It's growing limbs and becoming quite large lol. "Get it working" was my first step... | ||
| before := time.Now() | ||
| client := args.Client | ||
| req := codersdk.CreateTemplateVersionRequest{ | ||
| StorageMethod: codersdk.ProvisionerStorageMethodFile, | ||
| StorageSource:args.FileHash, | ||
| Provisioner: codersdk.ProvisionerType(args.Provisioner), | ||
| ParameterValues: parameters, | ||
| } | ||
| if args.Template != nil { | ||
| req.TemplateID = args.Template.ID | ||
| } | ||
| version, err := client.CreateTemplateVersion(cmd.Context(), args.Organization.ID, req) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| @@ -175,33 +200,77 @@ func createValidTemplateVersion(cmd *cobra.Command, client *codersdk.Client, org | ||
| return nil, nil, err | ||
| } | ||
| // lastParameterValues are pulled from the current active template version if | ||
| // templateID is provided. This allows pulling params from the last | ||
| // version instead of prompting if we are updating template versions. | ||
| lastParameterValues := make(map[string]codersdk.Parameter) | ||
| if args.ReuseParameters && args.Template != nil { | ||
| activeVersion, err := client.TemplateVersion(cmd.Context(), args.Template.ActiveVersionID) | ||
| if err != nil { | ||
| return nil, nil, xerrors.Errorf("Fetch current active template version: %w", err) | ||
| } | ||
| // We don't want to compute the params, we only want to copy from this scope | ||
| values, err := client.Parameters(cmd.Context(), codersdk.ParameterImportJob, activeVersion.Job.ID) | ||
| if err != nil { | ||
| return nil, nil, xerrors.Errorf("Fetch previous version parameters: %w", err) | ||
| } | ||
| for _, value := range values { | ||
| lastParameterValues[value.Name] = value | ||
| } | ||
| } | ||
| if provisionerd.IsMissingParameterError(version.Job.Error) { | ||
| valuesBySchemaID := map[string]codersdk.TemplateVersionParameter{} | ||
| for _, parameterValue := range parameterValues { | ||
| valuesBySchemaID[parameterValue.SchemaID.String()] = parameterValue | ||
| } | ||
| sort.Slice(parameterSchemas, func(i, j int) bool { | ||
| return parameterSchemas[i].Name < parameterSchemas[j].Name | ||
| }) | ||
| // parameterMapFromFile can be nil if parameter file is not specified | ||
| var parameterMapFromFile map[string]string | ||
| if args.ParameterFile != "" { | ||
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 think we should remove the 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. The file logic needs to be looked at for sure. I kept it as is for now. | ||
| _, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("Attempting to read the variables from the parameter file.")+"\r\n") | ||
| parameterMapFromFile, err = createParameterMapFromFile(args.ParameterFile) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| } | ||
| // pulled params come from the last template version | ||
| pulled := make([]string, 0) | ||
| missingSchemas := make([]codersdk.ParameterSchema, 0) | ||
| for _, parameterSchema := range parameterSchemas { | ||
| _, ok := valuesBySchemaID[parameterSchema.ID.String()] | ||
| if ok { | ||
| continue | ||
| } | ||
| // The file values are handled below. So don't handle them here, | ||
| // just check if a value is present in the file. | ||
| _, fileOk := parameterMapFromFile[parameterSchema.Name] | ||
| if inherit, ok := lastParameterValues[parameterSchema.Name]; ok && !fileOk { | ||
| // If the value is not in the param file, and can be pulled from the last template version, | ||
| // then don't mark it as missing. | ||
| parameters = append(parameters, codersdk.CreateParameterRequest{ | ||
| CloneID: inherit.ID, | ||
| }) | ||
| pulled = append(pulled, fmt.Sprintf("%q", parameterSchema.Name)) | ||
| continue | ||
| } | ||
| missingSchemas = append(missingSchemas, parameterSchema) | ||
| } | ||
| _, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("This template has required variables! They are scoped to the template, and not viewable after being set.")) | ||
| if len(pulled) > 0 { | ||
| _, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render(fmt.Sprintf("The following parameter values are being pulled from the latest template version: %s.", strings.Join(pulled, ", ")))) | ||
| _, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("Use \"--always-prompt\" flag to change the values.")) | ||
| } | ||
| _, _ = fmt.Fprint(cmd.OutOrStdout(), "\r\n") | ||
| for _, parameterSchema := range missingSchemas { | ||
| parameterValue, err := getParameterValueFromMapOrInput(cmd, parameterMapFromFile, parameterSchema) | ||
| if err != nil { | ||
| @@ -218,7 +287,7 @@ func createValidTemplateVersion(cmd *cobra.Command, client *codersdk.Client, org | ||
| // This recursion is only 1 level deep in practice. | ||
| // The first pass populates the missing parameters, so it does not enter this `if` block again. | ||
| return createValidTemplateVersion(cmd,args, parameters...) | ||
| } | ||
| if version.Job.Status != codersdk.ProvisionerJobSucceeded { | ||
45 changes: 19 additions & 26 deletionscli/templateupdate.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.