feat(core): add support for handling deprecated method (#3786)

Co-authored-by: Jules Castéran <[email protected]>

Author: jremy42

internal/core/autocomplete.go

@@ -186,6 +186,9 @@ func BuildAutoCompleteTree(ctx context.Context, commands *Commands) *AutoComplet
 	globalFlags := getGlobalFlags(ctx)
 	root := NewAutoCompleteCommandNode(globalFlags)
 	for _, cmd := range commands.commands {
+		if cmd.Deprecated {
+			continue
+		}
 		node := root
 
 		// Creates nodes for namespaces, resources, verbs

internal/core/autocomplete_test.go

@@ -67,6 +67,15 @@ func testAutocompleteGetCommands() *core.Commands {
 				},
 			},
 		},
+		&core.Command{
+			Namespace:  "test",
+			Resource:   "flower",
+			Verb:       "deprecated",
+			ArgsType:   reflect.TypeOf(struct{}{}),
+			Deprecated: true,
+			Short:      "this command is deprected",
+			Long:       "This command is deprecated and should not show up in autocomplete.",
+		},
 	)
 }
 
@@ -291,3 +300,17 @@ func TestAutocompleteProfiles(t *testing.T) {
 	t.Run("scw test -p ", run(&testCase{Suggestions: core.AutocompleteSuggestions{"p1", "p2"}}))
 	t.Run("scw test flower --profile ", run(&testCase{Suggestions: core.AutocompleteSuggestions{"p1", "p2"}}))
 }
+
+func TestAutocompleteDeprecatedCommand(t *testing.T) {
+	ctx := core.InjectMeta(context.Background(), &core.Meta{
+		Commands: testAutocompleteGetCommands(),
+	})
+
+	type testCase = autoCompleteTestCase
+
+	run := func(tc *testCase) func(*testing.T) {
+		return runAutocompleteTest(ctx, tc)
+	}
+
+	t.Run("scw test flower deprecated", run(&testCase{Suggestions: nil}))
+}

internal/core/cobra_builder.go

@@ -172,6 +172,11 @@ func (b *cobraBuilder) hydrateCobra(cobraCmd *cobra.Command, cmd *Command, group
 		cobraCmd.PersistentFlags().BoolP("wait", "w", false, waitUsage)
 	}
 
+	if cmd.Deprecated {
+		cobraCmd.IsAvailableCommand()
+		cobraCmd.Deprecated = "Deprecated:"
+	}
+
 	if commandHasWeb(cmd) {
 		cobraCmd.PersistentFlags().Bool("web", false, "open console page for the current ressource")
 	}
@@ -204,15 +209,19 @@ DEPRECATED ARGS:
 {{- range $_, $group := orderGroups (getCommandsGroups .Commands) }}
 
 {{ $group.Title }} COMMANDS:
-{{- range $_, $command := orderCommands $.Commands }}
-{{- if $command.IsAvailableCommand }}
+  {{- range $_, $command := orderCommands $.Commands }}
+  {{- if or $command.IsAvailableCommand $command.Deprecated }}
   {{- if or ($command.ContainsGroup $group.ID) (and (eq $group.ID "utility") (eq $command.Name "help")) }}
-  {{ rpad $command.Name .NamePadding }} {{ if $command.Short }}{{ $command.Short }}{{end}}
-  {{- end }}
+  {{ rpad $command.Name .NamePadding }}
+  {{- if $command.Deprecated }} {{ if $command.Short }}{{ $command.Short }} (Deprecated){{ end }}
+  {{- else }} {{ if $command.Short }}{{ $command.Short }}{{ end }}
+{{- end }}
 {{- end }}
 {{- end }}
 {{- end }}
 {{- end }}
+{{- end }}
+
 {{- if .HasAvailableLocalFlags }}
 
 FLAGS:

internal/core/cobra_builder_test.go

@@ -39,3 +39,53 @@ func Test_UnknownCommand(t *testing.T) {
 		),
 	}))
 }
+
+func Test_DeprecatedCommand(t *testing.T) {
+	dummyNamespaceCommand := &core.Command{
+		Namespace: "instance",
+	}
+
+	dummyResourceCommand1 := &core.Command{
+		Namespace:  "instance",
+		Resource:   "server",
+		Short:      "short server",
+		Deprecated: false,
+	}
+
+	dummyResourceCommand2 := &core.Command{
+		Namespace:  "instance",
+		Resource:   "engine",
+		Short:      "short engine",
+		Deprecated: true,
+	}
+
+	dummyResourceCommand3 := &core.Command{
+		Namespace:  "instance",
+		Resource:   "a",
+		Short:      "short server",
+		Deprecated: false,
+	}
+
+	dummyResourceCommand4 := &core.Command{
+		Namespace:  "instance",
+		Resource:   "b",
+		Short:      "short server",
+		Deprecated: true,
+	}
+
+	cmds := core.NewCommands(
+		dummyNamespaceCommand,
+		dummyResourceCommand1,
+		dummyResourceCommand2,
+		dummyResourceCommand3,
+		dummyResourceCommand4,
+	)
+	t.Run("", core.Test(&core.TestConfig{
+		Commands: cmds,
+		Cmd:      "scw instance -h",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			core.TestCheckExitCode(0),
+		),
+	}))
+}

internal/core/cobra_usage_builder.go

@@ -161,7 +161,12 @@ func orderCobraCommands(cobraCommands []*cobra.Command) []*cobra.Command {
 	copy(commands, cobraCommands)
 
 	sort.Slice(commands, func(i, j int) bool {
-		return commands[i].Use < commands[j].Use
+		deprecatedI := commands[i].Deprecated != ""
+		deprecatedJ := commands[j].Deprecated != ""
+		if deprecatedI == deprecatedJ {
+			return commands[i].Use < commands[j].Use
+		}
+		return !deprecatedI && deprecatedJ
 	})
 	return commands
 }

internal/core/command.go

@@ -93,6 +93,8 @@ type Command struct {
 
 	// Groups contains a list of groups IDs
 	Groups []string
+	//
+	Deprecated bool
 }
 
 // CommandPreValidateFunc allows to manipulate args before validation.
@@ -289,7 +291,6 @@ func (c *Commands) find(path ...string) (*Command, bool) {
 func (c *Commands) GetSortedCommand() []*Command {
 	commands := make([]*Command, len(c.commands))
 	copy(commands, c.commands)
-
 	sort.Slice(commands, func(i, j int) bool {
 		return commands[i].signature() < commands[j].signature()
 	})

internal/core/testdata/test-deprecated-command#00.golden

@@ -0,0 +1,21 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+USAGE:
+  scw instance <command>
+
+AVAILABLE COMMANDS:
+  a           short server
+  server      short server
+  b           short server (Deprecated)
+  engine      short engine (Deprecated)
+
+FLAGS:
+  -h, --help   help for instance
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
+
+Use "scw instance [command] --help" for more information about a command.