opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli): support description in create and presets list CLI commands (#19079)

Browse Source 
## Description

This PR improves the `coder templates presets` and `coder create` CLI
commands to include preset descriptions.

## Changes

* Added a `description` column to the `coder templates presets list` CLI
command.
* Fixed the `-o json` output for `coder templates presets list` to
correctly include and format data.
* Updated the `coder create` CLI command to display the preset's
description in the selection menu.

Follow-up from: 
* https://github.com/coder/coder/pull/18910 
* https://github.com/coder/coder/pull/18912
* https://github.com/coder/coder/pull/18977
This commit is contained in:
Susana Ferreira
2025-07-29 16:59:26 +01:00
committed by GitHub
parent 415273f648
commit 4e7331a9c4
6 changed files with 105 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/templatepresets_test.go
+73 -6
View File
@@ -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",
Parameters: []*proto.PresetParameter{},
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+\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) {
@@ -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,
},
@@ -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
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)
})
}