Merge pull request #9481 from VilledeMontreal/feat/compMultiUninstall

feat(comp): Uninstall accepts multiple releases

cmd/helm/completion_test.go

@@ -62,3 +62,32 @@ func TestCompletionFileCompletion(t *testing.T) {
 	checkFileCompletion(t, "completion zsh", false)
 	checkFileCompletion(t, "completion fish", false)
 }
+
+func checkReleaseCompletion(t *testing.T, cmdName string, multiReleasesAllowed bool) {
+	multiReleaseTestGolden := "output/empty_nofile_comp.txt"
+	if multiReleasesAllowed {
+		multiReleaseTestGolden = "output/release_list_repeat_comp.txt"
+	}
+	tests := []cmdTestCase{{
+		name:   "completion for uninstall",
+		cmd:    fmt.Sprintf("__complete %s ''", cmdName),
+		golden: "output/release_list_comp.txt",
+		rels: []*release.Release{
+			release.Mock(&release.MockReleaseOptions{Name: "athos"}),
+			release.Mock(&release.MockReleaseOptions{Name: "porthos"}),
+			release.Mock(&release.MockReleaseOptions{Name: "aramis"}),
+		},
+	}, {
+		name:   "completion for uninstall repetition",
+		cmd:    fmt.Sprintf("__complete %s porthos ''", cmdName),
+		golden: multiReleaseTestGolden,
+		rels: []*release.Release{
+			release.Mock(&release.MockReleaseOptions{Name: "athos"}),
+			release.Mock(&release.MockReleaseOptions{Name: "porthos"}),
+			release.Mock(&release.MockReleaseOptions{Name: "aramis"}),
+		},
+	}}
+	for _, test := range tests {
+		runTestCmd(t, []cmdTestCase{test})
+	}
+}

cmd/helm/get_all.go

@@ -45,7 +45,7 @@ func newGetAllCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			res, err := client.Run(args[0])

cmd/helm/get_all_test.go

@@ -42,6 +42,10 @@ func TestGetCmd(t *testing.T) {
 	runTestCmd(t, tests)
 }
 
+func TestGetAllCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "get all", false)
+}
+
 func TestGetAllRevisionCompletion(t *testing.T) {
 	revisionFlagCompletionTest(t, "get all")
 }

cmd/helm/get_hooks.go

@@ -45,7 +45,7 @@ func newGetHooksCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			res, err := client.Run(args[0])

cmd/helm/get_hooks_test.go

@@ -37,6 +37,10 @@ func TestGetHooks(t *testing.T) {
 	runTestCmd(t, tests)
 }
 
+func TestGetHooksCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "get hooks", false)
+}
+
 func TestGetHooksRevisionCompletion(t *testing.T) {
 	revisionFlagCompletionTest(t, "get hooks")
 }

cmd/helm/get_manifest.go

@@ -47,7 +47,7 @@ func newGetManifestCmd(cfg *action.Configuration, out io.Writer) *cobra.Command
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			res, err := client.Run(args[0])

cmd/helm/get_manifest_test.go

@@ -37,6 +37,10 @@ func TestGetManifest(t *testing.T) {
 	runTestCmd(t, tests)
 }
 
+func TestGetManifestCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "get manifest", false)
+}
+
 func TestGetManifestRevisionCompletion(t *testing.T) {
 	revisionFlagCompletionTest(t, "get manifest")
 }

cmd/helm/get_notes.go

@@ -43,7 +43,7 @@ func newGetNotesCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			res, err := client.Run(args[0])

cmd/helm/get_notes_test.go

@@ -37,6 +37,10 @@ func TestGetNotesCmd(t *testing.T) {
 	runTestCmd(t, tests)
 }
 
+func TestGetNotesCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "get notes", false)
+}
+
 func TestGetNotesRevisionCompletion(t *testing.T) {
 	revisionFlagCompletionTest(t, "get notes")
 }

cmd/helm/get_values.go

@@ -50,7 +50,7 @@ func newGetValuesCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			vals, err := client.Run(args[0])

cmd/helm/get_values_test.go

@@ -53,6 +53,10 @@ func TestGetValuesCmd(t *testing.T) {
 	runTestCmd(t, tests)
 }
 
+func TestGetValuesCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "get values", false)
+}
+
 func TestGetValuesRevisionCompletion(t *testing.T) {
 	revisionFlagCompletionTest(t, "get values")
 }

cmd/helm/history.go

@@ -65,7 +65,7 @@ func newHistoryCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			history, err := getHistory(client, args[0])

cmd/helm/history_test.go

@@ -109,6 +109,10 @@ func revisionFlagCompletionTest(t *testing.T, cmdName string) {
 	runTestCmd(t, tests)
 }
 
+func TestHistoryCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "history", false)
+}
+
 func TestHistoryFileCompletion(t *testing.T) {
 	checkFileCompletion(t, "history", false)
 	checkFileCompletion(t, "history myrelease", false)

cmd/helm/list.go

@@ -193,8 +193,32 @@ func (r *releaseListWriter) WriteYAML(out io.Writer) error {
 	return output.EncodeYAML(out, r.releases)
 }
 
+// Returns all releases from 'releases', except those with names matching 'ignoredReleases'
+func filterReleases(releases []*release.Release, ignoredReleaseNames []string) []*release.Release {
+	// if ignoredReleaseNames is nil, just return releases
+	if ignoredReleaseNames == nil {
+		return releases
+	}
+
+	var filteredReleases []*release.Release
+	for _, rel := range releases {
+		found := false
+		for _, ignoredName := range ignoredReleaseNames {
+			if rel.Name == ignoredName {
+				found = true
+				break
+			}
+		}
+		if !found {
+			filteredReleases = append(filteredReleases, rel)
+		}
+	}
+
+	return filteredReleases
+}
+
 // Provide dynamic auto-completion for release names
-func compListReleases(toComplete string, cfg *action.Configuration) ([]string, cobra.ShellCompDirective) {
+func compListReleases(toComplete string, ignoredReleaseNames []string, cfg *action.Configuration) ([]string, cobra.ShellCompDirective) {
 	cobra.CompDebugln(fmt.Sprintf("compListReleases with toComplete %s", toComplete), settings.Debug)
 
 	client := action.NewList(cfg)
@@ -209,7 +233,8 @@ func compListReleases(toComplete string, cfg *action.Configuration) ([]string, c
 	}
 
 	var choices []string
-	for _, rel := range releases {
+	filteredReleases := filterReleases(releases, ignoredReleaseNames)
+	for _, rel := range filteredReleases {
 		choices = append(choices,
 			fmt.Sprintf("%s\t%s-%s -> %s", rel.Name, rel.Chart.Metadata.Name, rel.Chart.Metadata.Version, rel.Info.Status.String()))
 	}

cmd/helm/release_testing.go

@@ -52,7 +52,7 @@ func newReleaseTestCmd(cfg *action.Configuration, out io.Writer) *cobra.Command
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			client.Namespace = settings.Namespace()

cmd/helm/release_testing_test.go

@@ -20,6 +20,10 @@ import (
 	"testing"
 )
 
+func TestReleaseTestingCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "test", false)
+}
+
 func TestReleaseTestingFileCompletion(t *testing.T) {
 	checkFileCompletion(t, "test", false)
 	checkFileCompletion(t, "test myrelease", false)

cmd/helm/rollback.go

@@ -48,7 +48,7 @@ func newRollbackCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 		Args:  require.MinimumNArgs(1),
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			if len(args) == 0 {
-				return compListReleases(toComplete, cfg)
+				return compListReleases(toComplete, args, cfg)
 			}
 
 			if len(args) == 1 {

cmd/helm/status.go

@@ -59,7 +59,7 @@ func newStatusCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			rel, err := client.Run(args[0])

cmd/helm/testdata/output/release_list_comp.txt

@@ -0,0 +1,5 @@
+aramis	foo-0.1.0-beta.1 -> deployed
+athos	foo-0.1.0-beta.1 -> deployed
+porthos	foo-0.1.0-beta.1 -> deployed
+:4
+Completion ended with directive: ShellCompDirectiveNoFileComp

cmd/helm/testdata/output/release_list_repeat_comp.txt

@@ -0,0 +1,4 @@
+aramis	foo-0.1.0-beta.1 -> deployed
+athos	foo-0.1.0-beta.1 -> deployed
+:4
+Completion ended with directive: ShellCompDirectiveNoFileComp

cmd/helm/uninstall.go

@@ -48,10 +48,7 @@ func newUninstallCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 		Long:       uninstallDesc,
 		Args:       require.MinimumNArgs(1),
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			if len(args) != 0 {
-				return nil, cobra.ShellCompDirectiveNoFileComp
-			}
-			return compListReleases(toComplete, cfg)
+			return compListReleases(toComplete, args, cfg)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			for i := 0; i < len(args); i++ {

cmd/helm/uninstall_test.go

@@ -67,6 +67,10 @@ func TestUninstall(t *testing.T) {
 	runTestCmd(t, tests)
 }
 
+func TestUninstallCompletion(t *testing.T) {
+	checkReleaseCompletion(t, "uninstall", true)
+}
+
 func TestUninstallFileCompletion(t *testing.T) {
 	checkFileCompletion(t, "uninstall", false)
 	checkFileCompletion(t, "uninstall myrelease", false)

cmd/helm/upgrade.go

@@ -74,7 +74,7 @@ func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 		Args:  require.ExactArgs(2),
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			if len(args) == 0 {
-				return compListReleases(toComplete, cfg)
+				return compListReleases(toComplete, args, cfg)
 			}
 			if len(args) == 1 {
 				return compListCharts(toComplete, true)