- Notifications
You must be signed in to change notification settings - Fork1k
feat(cli): support description in create and presets list CLI commands#19079
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
3 commits Select commitHold shift + click to select a range
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
7 changes: 6 additions & 1 deletioncli/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
3 changes: 2 additions & 1 deletioncli/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
29 changes: 19 additions & 10 deletionscli/templatepresets.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
79 changes: 73 additions & 6 deletionscli/templatepresets_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 |
|---|---|---|
| @@ -1,11 +1,14 @@ | ||
| package cli_test | ||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "testing" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/coder/coder/v2/cli" | ||
| "github.com/coder/coder/v2/cli/clitest" | ||
| "github.com/coder/coder/v2/coderd/coderdtest" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| @@ -84,8 +87,9 @@ func TestTemplatePresets(t *testing.T) { | ||
| }, | ||
| }, | ||
| { | ||
| Name: "preset-prebuilds", | ||
| Description: "Preset without parameters and 2 prebuild instances.", | ||
| Parameters: []*proto.PresetParameter{}, | ||
| Prebuild: &proto.Prebuild{ | ||
| Instances: 2, | ||
| }, | ||
| @@ -117,7 +121,7 @@ func TestTemplatePresets(t *testing.T) { | ||
| pty.ExpectRegexMatch(`preset-default\s+k1=v2\s+true\s+0`) | ||
| // The parameter order is not guaranteed in the output, so we match both possible orders | ||
| pty.ExpectRegexMatch(`preset-multiple-params\s+(k1=v1,k2=v2)|(k2=v2,k1=v1)\s+false\s+-`) | ||
| pty.ExpectRegexMatch(`preset-prebuilds\s+Preset without parameters and 2 prebuild instances.\s+\s+false\s+2`) | ||
| }) | ||
| t.Run("ListsPresetsForSpecifiedTemplateVersion", func(t *testing.T) { | ||
| @@ -158,8 +162,9 @@ func TestTemplatePresets(t *testing.T) { | ||
| }, | ||
| }, | ||
| { | ||
| Name: "preset-prebuilds", | ||
| Description: "Preset without parameters and 2 prebuild instances.", | ||
| Parameters: []*proto.PresetParameter{}, | ||
| Prebuild: &proto.Prebuild{ | ||
| Instances: 2, | ||
| }, | ||
| @@ -208,7 +213,69 @@ func TestTemplatePresets(t *testing.T) { | ||
| pty.ExpectRegexMatch(`preset-default\s+k1=v2\s+true\s+0`) | ||
| // The parameter order is not guaranteed in the output, so we match both possible orders | ||
| pty.ExpectRegexMatch(`preset-multiple-params\s+(k1=v1,k2=v2)|(k2=v2,k1=v1)\s+false\s+-`) | ||
| pty.ExpectRegexMatch(`preset-prebuilds\s+Preset without parameters and 2 prebuild instances.\s+\s+false\s+2`) | ||
| }) | ||
| t.Run("ListsPresetsJSON", func(t *testing.T) { | ||
| t.Parallel() | ||
| client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true}) | ||
| owner := coderdtest.CreateFirstUser(t, client) | ||
| member, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) | ||
| // Given: an active template version that includes presets | ||
| preset := proto.Preset{ | ||
| Name: "preset-default", | ||
| Description: "Preset with parameters and 2 prebuild instances.", | ||
| Icon: "/emojis/1f60e.png", | ||
| Default: true, | ||
| Parameters: []*proto.PresetParameter{ | ||
| { | ||
| Name: "k1", | ||
| Value: "v2", | ||
| }, | ||
| }, | ||
| Prebuild: &proto.Prebuild{ | ||
| Instances: 2, | ||
| }, | ||
| } | ||
| version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, templateWithPresets([]*proto.Preset{&preset})) | ||
| _ = coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID) | ||
| template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID) | ||
| require.Equal(t, version.ID, template.ActiveVersionID) | ||
| // When: listing presets for that template | ||
| inv, root := clitest.New(t, "templates", "presets", "list", template.Name, "-o", "json") | ||
| clitest.SetupConfig(t, member, root) | ||
| buf := bytes.NewBuffer(nil) | ||
| inv.Stdout = buf | ||
| doneChan := make(chan struct{}) | ||
| var runErr error | ||
| go func() { | ||
| defer close(doneChan) | ||
| runErr = inv.Run() | ||
| }() | ||
| <-doneChan | ||
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. suggestion: 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 didn't know about this. I will address it in a follow-up PR to update the other tests as well 👍 | ||
| require.NoError(t, runErr) | ||
| // Should: return the active version's preset | ||
| var jsonPresets []cli.TemplatePresetRow | ||
| err := json.Unmarshal(buf.Bytes(), &jsonPresets) | ||
| require.NoError(t, err, "unmarshal JSON output") | ||
| require.Len(t, jsonPresets, 1) | ||
| jsonPreset := jsonPresets[0].TemplatePreset | ||
| require.Equal(t, preset.Name, jsonPreset.Name) | ||
| require.Equal(t, preset.Description, jsonPreset.Description) | ||
| require.Equal(t, preset.Icon, jsonPreset.Icon) | ||
| require.Equal(t, preset.Default, jsonPreset.Default) | ||
| require.Equal(t, len(preset.Parameters), len(jsonPreset.Parameters)) | ||
| require.Equal(t, preset.Parameters[0].Name, jsonPreset.Parameters[0].Name) | ||
| require.Equal(t, preset.Parameters[0].Value, jsonPreset.Parameters[0].Value) | ||
| require.Equal(t, int(preset.Prebuild.Instances), *jsonPreset.DesiredPrebuildInstances) | ||
| }) | ||
| } | ||
2 changes: 1 addition & 1 deletioncli/testdata/coder_templates_presets_list_--help.golden
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
8 changes: 4 additions & 4 deletionsdocs/reference/cli/templates_presets_list.md
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.
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.