Content-Length: 548455 | pFad | http://github.com/coder/coder/pull/19079/files

D0 feat(cli): support description in create and presets list CLI commands by ssncferreira · Pull Request #19079 · coder/coder · GitHub
Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion cli/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,12 @@ func promptPresetSelection(inv *serpent.Invocation, presets []codersdk.Preset) (
var presetOptions []string

for _, preset := range presets {
option := preset.Name
var option string
if preset.Description == "" {
option = preset.Name
} else {
option = fmt.Sprintf("%s: %s", preset.Name, preset.Description)
}
presetOptions = append(presetOptions, option)
presetMap[option] = &preset
}
Expand Down
3 changes: 2 additions & 1 deletion cli/create_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,8 @@ func TestCreateWithPreset(t *testing.T) {

// Given: a template and a template version with two presets
preset := proto.Preset{
Name: "preset-test",
Name: "preset-test",
Description: "Preset Test.",
Parameters: []*proto.PresetParameter{
{Name: firstParameterName, Value: secondOptionalParameterValue},
{Name: thirdParameterName, Value: thirdParameterValue},
Expand Down
29 changes: 19 additions & 10 deletions cli/templatepresets.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ func (r *RootCmd) templatePresets() *serpent.Command {
func (r *RootCmd) templatePresetsList() *serpent.Command {
defaultColumns := []string{
"name",
"description",
"parameters",
"default",
"desired prebuild instances",
}
formatter := cliui.NewOutputFormatter(
cliui.TableFormat([]templatePresetRow{}, defaultColumns),
cliui.TableFormat([]TemplatePresetRow{}, defaultColumns),
cliui.JSONFormat(),
)
client := new(codersdk.Client)
Expand Down Expand Up @@ -108,10 +109,13 @@ func (r *RootCmd) templatePresetsList() *serpent.Command {
return nil
}

cliui.Infof(
inv.Stdout,
"Showing presets for template %q and template version %q.\n", template.Name, version.Name,
)
// Only display info message for table output
if formatter.FormatID() == "table" {
cliui.Infof(
inv.Stdout,
"Showing presets for template %q and template version %q.\n", template.Name, version.Name,
)
}
rows := templatePresetsToRows(presets...)
out, err := formatter.Format(inv.Context(), rows)
if err != nil {
Expand All @@ -128,12 +132,13 @@ func (r *RootCmd) templatePresetsList() *serpent.Command {
return cmd
}

type templatePresetRow struct {
// For json format:
type TemplatePresetRow struct {
// For json format
TemplatePreset codersdk.Preset `table:"-"`

// For table format:
Name string `json:"-" table:"name,default_sort"`
Description string `json:"-" table:"description"`
Parameters string `json:"-" table:"parameters"`
Default bool `json:"-" table:"default"`
DesiredPrebuildInstances string `json:"-" table:"desired prebuild instances"`
Expand All @@ -149,15 +154,19 @@ func formatPresetParameters(params []codersdk.PresetParameter) string {

// templatePresetsToRows converts a list of presets to a list of rows
// for outputting.
func templatePresetsToRows(presets ...codersdk.Preset) []templatePresetRow {
rows := make([]templatePresetRow, len(presets))
func templatePresetsToRows(presets ...codersdk.Preset) []TemplatePresetRow {
rows := make([]TemplatePresetRow, len(presets))
for i, preset := range presets {
prebuildInstances := "-"
if preset.DesiredPrebuildInstances != nil {
prebuildInstances = strconv.Itoa(*preset.DesiredPrebuildInstances)
}
rows[i] = templatePresetRow{
rows[i] = TemplatePresetRow{
// For json format
TemplatePreset: preset,
// For table format
Name: preset.Name,
Description: preset.Description,
Parameters: formatPresetParameters(preset.Parameters),
Default: preset.Default,
DesiredPrebuildInstances: prebuildInstances,
Expand Down
79 changes: 73 additions & 6 deletions cli/templatepresets_test.go
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"
Expand Down Expand Up @@ -84,8 +87,9 @@ func TestTemplatePresets(t *testing.T) {
},
},
{
Name: "preset-prebuilds",
Parameters: []*proto.PresetParameter{},
Name: "preset-prebuilds",
Description: "Preset without parameters and 2 prebuild instances.",
Parameters: []*proto.PresetParameter{},
Prebuild: &proto.Prebuild{
Instances: 2,
},
Expand Down Expand Up @@ -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+\s+false\s+2`)
pty.ExpectRegexMatch(`preset-prebuilds\s+Preset without parameters and 2 prebuild instances.\s+\s+false\s+2`)
})

t.Run("ListsPresetsForSpecifiedTemplateVersion", func(t *testing.T) {
Expand Down Expand Up @@ -158,8 +162,9 @@ func TestTemplatePresets(t *testing.T) {
},
},
{
Name: "preset-prebuilds",
Parameters: []*proto.PresetParameter{},
Name: "preset-prebuilds",
Description: "Preset without parameters and 2 prebuild instances.",
Parameters: []*proto.PresetParameter{},
Prebuild: &proto.Prebuild{
Instances: 2,
},
Expand Down Expand Up @@ -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+\s+false\s+2`)
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: testutil.TryReceive instead

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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)
})
}

Expand Down
2 changes: 1 addition & 1 deletion cli/testdata/coder_templates_presets_list_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ OPTIONS:
-O, --org string, $CODER_ORGANIZATION
Select which organization (uuid or name) to use.

-c, --column [name|parameters|default|desired prebuild instances] (default: name,parameters,default,desired prebuild instances)
-c, --column [name|description|parameters|default|desired prebuild instances] (default: name,description,parameters,default,desired prebuild instances)
Columns to display in table output.

-o, --output table|json (default: table)
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/templates_presets_list.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/coder/coder/pull/19079/files

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy