Skip to content

Commit 536c77a

Browse files
ketangketang
authored
fix: confirm when deleting template (coder#2866)
* prompt for confirmation before deleting templates (coder#2830) * populate templateNames from the interactive picker too * allow skipping delete confirmation prompt with --yes flag * eliminate unnecessary newline * test both confirmation of delete and `--yes` with no confirmation * fix failing test that needed --yes * remove unnecessary empty line the linter disliked * make the tests correct
1 parent fa7dcf6 commit 536c77a

3 files changed

Lines changed: 82 additions & 12 deletions

File tree

‎cli/templatecreate_test.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ func TestTemplateCreate(t *testing.T) {
229229
"templates",
230230
"delete",
231231
"my-template",
232+
"--yes",
232233
}
233234
cmd, root := clitest.New(t, args...)
234235
clitest.SetupConfig(t, client, root)

‎cli/templatedelete.go‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package cli
22

33
import (
44
"fmt"
5+
"strings"
56
"time"
67

78
"github.com/spf13/cobra"
@@ -12,7 +13,7 @@ import (
1213
)
1314

1415
func templateDelete() *cobra.Command {
15-
return &cobra.Command{
16+
cmd := &cobra.Command{
1617
Use: "delete [name...]",
1718
Short: "Delete templates",
1819
RunE: func(cmd *cobra.Command, args []string) error {
@@ -33,6 +34,14 @@ func templateDelete() *cobra.Command {
3334

3435
if len(args) > 0 {
3536
templateNames = args
37+
38+
for _, templateName := range templateNames {
39+
template, err := client.TemplateByName(ctx, organization.ID, templateName)
40+
if err != nil {
41+
return xerrors.Errorf("get template by name: %w", err)
42+
}
43+
templates = append(templates, template)
44+
}
3645
} else {
3746
allTemplates, err := client.TemplatesByOrganization(ctx, organization.ID)
3847
if err != nil {
@@ -58,17 +67,19 @@ func templateDelete() *cobra.Command {
5867
for _, template := range allTemplates {
5968
if template.Name == selection {
6069
templates = append(templates, template)
70+
templateNames = append(templateNames, template.Name)
6171
}
6272
}
6373
}
6474

65-
for _, templateName := range templateNames {
66-
template, err := client.TemplateByName(ctx, organization.ID, templateName)
67-
if err != nil {
68-
return xerrors.Errorf("get template by name: %w", err)
69-
}
70-
71-
templates = append(templates, template)
75+
// Confirm deletion of the template.
76+
_, err = cliui.Prompt(cmd, cliui.PromptOptions{
77+
Text: fmt.Sprintf("Delete these templates: %s?", cliui.Styles.Code.Render(strings.Join(templateNames, ", "))),
78+
IsConfirm: true,
79+
Default: "no",
80+
})
81+
if err != nil {
82+
return err
7283
}
7384

7485
for _, template := range templates {
@@ -83,4 +94,7 @@ func templateDelete() *cobra.Command {
8394
return nil
8495
},
8596
}
97+
98+
cliui.AllowSkipPrompt(cmd)
99+
return cmd
86100
}

‎cli/templatedelete_test.go‎

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@ package cli_test
22

33
import (
44
"context"
5+
"fmt"
6+
"strings"
57
"testing"
68

79
"github.com/stretchr/testify/require"
810

911
"github.com/coder/coder/cli/clitest"
12+
"github.com/coder/coder/cli/cliui"
1013
"github.com/coder/coder/coderd/coderdtest"
1114
"github.com/coder/coder/codersdk"
1215
"github.com/coder/coder/pty/ptytest"
@@ -25,14 +28,27 @@ func TestTemplateDelete(t *testing.T) {
2528
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
2629

2730
cmd, root := clitest.New(t, "templates", "delete", template.Name)
31+
2832
clitest.SetupConfig(t, client, root)
29-
require.NoError(t, cmd.Execute())
33+
pty := ptytest.New(t)
34+
cmd.SetIn(pty.Input())
35+
cmd.SetOut(pty.Output())
36+
37+
execDone := make(chan error)
38+
go func() {
39+
execDone <- cmd.Execute()
40+
}()
41+
42+
pty.ExpectMatch(fmt.Sprintf("Delete these templates: %s?", cliui.Styles.Code.Render(template.Name)))
43+
pty.WriteLine("yes")
44+
45+
require.NoError(t, <-execDone)
3046

3147
_, err := client.Template(context.Background(), template.ID)
3248
require.Error(t, err, "template should not exist")
3349
})
3450

35-
t.Run("Multiple", func(t *testing.T) {
51+
t.Run("Multiple --yes", func(t *testing.T) {
3652
t.Parallel()
3753

3854
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
@@ -49,7 +65,7 @@ func TestTemplateDelete(t *testing.T) {
4965
templateNames = append(templateNames, template.Name)
5066
}
5167

52-
cmd, root := clitest.New(t, append([]string{"templates", "delete"}, templateNames...)...)
68+
cmd, root := clitest.New(t, append([]string{"templates", "delete", "--yes"}, templateNames...)...)
5369
clitest.SetupConfig(t, client, root)
5470
require.NoError(t, cmd.Execute())
5571

@@ -59,6 +75,45 @@ func TestTemplateDelete(t *testing.T) {
5975
}
6076
})
6177

78+
t.Run("Multiple prompted", func(t *testing.T) {
79+
t.Parallel()
80+
81+
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
82+
user := coderdtest.CreateFirstUser(t, client)
83+
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
84+
_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
85+
templates := []codersdk.Template{
86+
coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID),
87+
coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID),
88+
coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID),
89+
}
90+
templateNames := []string{}
91+
for _, template := range templates {
92+
templateNames = append(templateNames, template.Name)
93+
}
94+
95+
cmd, root := clitest.New(t, append([]string{"templates", "delete"}, templateNames...)...)
96+
clitest.SetupConfig(t, client, root)
97+
pty := ptytest.New(t)
98+
cmd.SetIn(pty.Input())
99+
cmd.SetOut(pty.Output())
100+
101+
execDone := make(chan error)
102+
go func() {
103+
execDone <- cmd.Execute()
104+
}()
105+
106+
pty.ExpectMatch(fmt.Sprintf("Delete these templates: %s?", cliui.Styles.Code.Render(strings.Join(templateNames, ", "))))
107+
pty.WriteLine("yes")
108+
109+
require.NoError(t, <-execDone)
110+
111+
for _, template := range templates {
112+
_, err := client.Template(context.Background(), template.ID)
113+
require.Error(t, err, "template should not exist")
114+
}
115+
})
116+
62117
t.Run("Selector", func(t *testing.T) {
63118
t.Parallel()
64119

@@ -80,7 +135,7 @@ func TestTemplateDelete(t *testing.T) {
80135
execDone <- cmd.Execute()
81136
}()
82137

83-
pty.WriteLine("docker-local")
138+
pty.WriteLine("yes")
84139
require.NoError(t, <-execDone)
85140

86141
_, err := client.Template(context.Background(), template.ID)

0 commit comments

Comments
 (0)