feat(cli): add supported resources in help command (#2506)

kubeshop · May 26, 2023 · d0f8191 · d0f8191
1 parent a61f1c8
commit d0f8191
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 24 deletions.
diff --git a/cli/cmd/apply_cmd.go b/cli/cmd/apply_cmd.go
@@ -3,6 +3,7 @@ package cmd
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	"github.com/kubeshop/tracetest/cli/actions"
 	"github.com/kubeshop/tracetest/cli/analytics"
@@ -13,12 +14,13 @@ import (
 var definitionFile string
 
 var applyCmd = &cobra.Command{
-	GroupID: cmdGroupResources.ID,
-	Use:     "apply [resource type]",
-	Short:   "Apply resources",
-	Long:    "Apply (create/update) resources to your Tracetest server",
-	PreRun:  setupCommand(),
-	Args:    cobra.MinimumNArgs(1),
+	GroupID:   cmdGroupResources.ID,
+	Use:       fmt.Sprintf("apply %s", strings.Join(validArgs, "|")),
+	Short:     "Apply resources",
+	Long:      "Apply (create/update) resources to your Tracetest server",
+	PreRun:    setupCommand(),
+	Args:      cobra.MatchAll(cobra.MinimumNArgs(1), cobra.OnlyValidArgs),
+	ValidArgs: validArgs,
 	Run: WithResultHandler(func(cmd *cobra.Command, args []string) (string, error) {
 		if definitionFile == "" {
 			return "", fmt.Errorf("file with definition must be specified")

diff --git a/cli/cmd/config.go b/cli/cmd/config.go
@@ -18,6 +18,7 @@ import (
 var cliConfig config.Config
 var cliLogger *zap.Logger
 var resourceRegistry = actions.NewResourceRegistry()
+var validArgs = []string{"config", "datastore", "demo", "environment", "pollingprofile", "transaction"}
 var versionText string
 
 type setupConfig struct {

diff --git a/cli/cmd/delete_cmd.go b/cli/cmd/delete_cmd.go
@@ -3,6 +3,7 @@ package cmd
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	"github.com/kubeshop/tracetest/cli/analytics"
 	"github.com/spf13/cobra"
@@ -11,12 +12,13 @@ import (
 var deletedResourceID string
 
 var deleteCmd = &cobra.Command{
-	GroupID: cmdGroupResources.ID,
-	Use:     "delete [resource type]",
-	Long:    "Delete resources from your Tracetest server",
-	Short:   "Delete resources",
-	PreRun:  setupCommand(),
-	Args:    cobra.MinimumNArgs(1),
+	GroupID:   cmdGroupResources.ID,
+	Use:       fmt.Sprintf("delete %s", strings.Join(validArgs, "|")),
+	Short:     "Delete resources",
+	Long:      "Delete resources from your Tracetest server",
+	PreRun:    setupCommand(),
+	Args:      cobra.MatchAll(cobra.MinimumNArgs(1), cobra.OnlyValidArgs),
+	ValidArgs: validArgs,
 	Run: WithResultHandler(func(_ *cobra.Command, args []string) (string, error) {
 		if deletedResourceID == "" {
 			return "", fmt.Errorf("id of the resource to delete must be specified")

diff --git a/cli/cmd/get_cmd.go b/cli/cmd/get_cmd.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"strings"
 
 	"github.com/kubeshop/tracetest/cli/analytics"
 	"github.com/kubeshop/tracetest/cli/formatters"
@@ -14,12 +15,13 @@ import (
 var resourceID string
 
 var getCmd = &cobra.Command{
-	GroupID: cmdGroupResources.ID,
-	Use:     "get [resource type]",
-	Long:    "Get a resource from your Tracetest server",
-	Short:   "Get resource",
-	PreRun:  setupCommand(),
-	Args:    cobra.MinimumNArgs(1),
+	GroupID:   cmdGroupResources.ID,
+	Use:       fmt.Sprintf("get %s", strings.Join(validArgs, "|")),
+	Short:     "Get resource",
+	Long:      "Get a resource from your Tracetest server",
+	PreRun:    setupCommand(),
+	Args:      cobra.MatchAll(cobra.MinimumNArgs(1), cobra.OnlyValidArgs),
+	ValidArgs: validArgs,
 	Run: WithResultHandler(func(cmd *cobra.Command, args []string) (string, error) {
 		if resourceID == "" {
 			return "", fmt.Errorf("id of the resource to get must be specified")

diff --git a/cli/cmd/list_cmd.go b/cli/cmd/list_cmd.go
@@ -2,6 +2,8 @@ package cmd
 
 import (
 	"context"
+	"fmt"
+	"strings"
 
 	"github.com/kubeshop/tracetest/cli/analytics"
 	"github.com/kubeshop/tracetest/cli/formatters"
@@ -18,12 +20,13 @@ var (
 )
 
 var listCmd = &cobra.Command{
-	GroupID: cmdGroupResources.ID,
-	Use:     "list [resource type]",
-	Long:    "List resources from your Tracetest server",
-	Short:   "List resources",
-	PreRun:  setupCommand(),
-	Args:    cobra.MinimumNArgs(1),
+	GroupID:   cmdGroupResources.ID,
+	Use:       fmt.Sprintf("list %s", strings.Join(validArgs, "|")),
+	Short:     "List resources",
+	Long:      "List resources from your Tracetest server",
+	PreRun:    setupCommand(),
+	Args:      cobra.MatchAll(cobra.MinimumNArgs(1), cobra.OnlyValidArgs),
+	ValidArgs: validArgs,
 	Run: WithResultHandler(func(cmd *cobra.Command, args []string) (string, error) {
 		resourceType := args[0]
 		ctx := context.Background()