Smart test label normalization (#174)

* Normalize label hanlding in smart-test commands

* Improve texts

* PR feedback

Author: daniel-de-vera

internal/command/smarttest/execution_cancel.go

@@ -16,7 +16,7 @@ func newCancel(tConfig *config.SmartTestExec) *cobra.Command {
 		SmartTestExec: tConfig,
 	}
 	cmd := &cobra.Command{
-		Use:   "cancel [<execution-ID> | --run-id <run-ID>]",
+		Use:   "cancel [ID | --run-id RUN_ID]",
 		Short: "Cancel a test execution",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return cancel(cmd.Context(), cfg, cmd.OutOrStdout(), cmd.ErrOrStderr(), args)

internal/command/smarttest/execution_get.go

@@ -14,7 +14,7 @@ func newGet(tConfig *config.SmartTestExec) *cobra.Command {
 		SmartTestExec: tConfig,
 	}
 	cmd := &cobra.Command{
-		Use:   "get <execution-ID>",
+		Use:   "get ID",
 		Short: "Get a test execution",
 		Args:  cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {

internal/command/smarttest/execution_list.go

@@ -16,7 +16,7 @@ func newList(tConfig *config.SmartTestExec) *cobra.Command {
 		SmartTestExec: tConfig,
 	}
 	cmd := &cobra.Command{
-		Use:   "list [--test-name <test-name> | --run-id <run-ID>]",
+		Use:   "list [filter-opts]",
 		Short: "List test executions",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return list(cfg, cmd.OutOrStdout(), cmd.ErrOrStderr(), args)
@@ -59,7 +59,7 @@ func list(cfg *config.SmartTestExecList, wOut, wErr io.Writer, args []string) er
 		params.WithExecutionPhase(&cfg.ExecutionPhase)
 	}
 	if len(cfg.Labels) > 0 {
-		params.WithLabel(cfg.Labels)
+		params.WithLabel(cfg.Labels.ToQueryFilter())
 	}
 	result, err := cfg.Client.TestExecutions.QueryTestExecutions(params, nil)
 	if err != nil {

internal/config/smarttest.go

@@ -20,7 +20,7 @@ type SmartTestRun struct {
 	*SmartTest
 	Directory  string
 	File       string
-	Labels     RunLabels
+	Labels     TestExecLabels
 	Cluster    string
 	Sandbox    string
 	RouteGroup string
@@ -29,9 +29,9 @@ type SmartTestRun struct {
 	NoWait     bool
 }
 
-type RunLabels map[string]string
+type TestExecLabels map[string]string
 
-func (rl RunLabels) String() string {
+func (rl TestExecLabels) String() string {
 	keys := make([]string, 0, len(rl))
 	for k := range rl {
 		keys = append(keys, k)
@@ -47,32 +47,43 @@ func (rl RunLabels) String() string {
 	return res.String()
 }
 
-func (rl RunLabels) Set(v string) error {
+func (rl TestExecLabels) Set(v string) error {
 	key, val, ok := strings.Cut(v, "=")
 	if !ok {
-		return fmt.Errorf("%q should be in form <key>:<value>", v)
+		return fmt.Errorf("%q should be in form <key>=<value>", v)
 	}
 	rl[key] = val
 	return nil
 }
 
-func (tl RunLabels) Type() string {
+func (tl TestExecLabels) Type() string {
 	return "labels"
 }
 
+func (tl TestExecLabels) ToQueryFilter() []string {
+	if len(tl) == 0 {
+		return nil
+	}
+	result := make([]string, 0, len(tl))
+	for k, v := range tl {
+		result = append(result, k+":"+v)
+	}
+	return result
+}
+
 // AddFlags adds the flags for the test run command
 func (c *SmartTestRun) AddFlags(cmd *cobra.Command) {
-	cmd.Flags().StringVarP(&c.Directory, "directory", "d", "", "Base directory for finding tests")
-	cmd.Flags().StringVarP(&c.File, "file", "f", "", "Smart Test file to run")
-	cmd.Flags().StringVar(&c.Cluster, "cluster", "", "Cluster where to run tests")
-	cmd.Flags().StringVar(&c.Sandbox, "sandbox", "", "Sandbox where to run tests")
-	cmd.Flags().StringVar(&c.RouteGroup, "route-group", "", "Route group where to run tests")
-	cmd.Flags().BoolVar(&c.Publish, "publish", false, "Publish test results")
+	cmd.Flags().StringVarP(&c.Directory, "directory", "d", "", "base directory for finding tests")
+	cmd.Flags().StringVarP(&c.File, "file", "f", "", "smart test file to run")
+	cmd.Flags().StringVar(&c.Cluster, "cluster", "", "cluster where to run tests")
+	cmd.Flags().StringVar(&c.Sandbox, "sandbox", "", "sandbox where to run tests")
+	cmd.Flags().StringVar(&c.RouteGroup, "route-group", "", "route group where to run tests")
+	cmd.Flags().BoolVar(&c.Publish, "publish", false, "publish test results")
 	cmd.Flags().DurationVar(&c.Timeout, "timeout", 0, "timeout when waiting for the tests to complete, if 0 is specified, no timeout will be applied (default 0)")
 	cmd.Flags().BoolVar(&c.NoWait, "no-wait", false, "do not wait until the tests are completed")
 
 	c.Labels = make(map[string]string)
-	cmd.Flags().Var(c.Labels, "set-label", "set a label in form key:value for all test executions in the run")
+	cmd.Flags().Var(&c.Labels, "set-label", "set a label in form key=value for all test executions in the run (can be specified multiple times)")
 }
 
 type SmartTestExec struct {
@@ -92,18 +103,20 @@ type SmartTestExecList struct {
 	RepoPath       string
 	RepoCommitSHA  string
 	ExecutionPhase string
-	Labels         []string
+	Labels         TestExecLabels
 }
 
 func (c *SmartTestExecList) AddFlags(cmd *cobra.Command) {
-	cmd.Flags().StringVar(&c.TestName, "test-name", "", "Filter test executions by test name")
-	cmd.Flags().StringVar(&c.RunID, "run-id", "", "Filter test executions by run ID")
-	cmd.Flags().StringVar(&c.Sandbox, "sandbox", "", "Filter test executions by sandbox name")
-	cmd.Flags().StringVar(&c.Repo, "repo", "", "Filter test executions by repository name")
-	cmd.Flags().StringVar(&c.RepoPath, "repo-path", "", "Filter test executions by repository path")
-	cmd.Flags().StringVar(&c.RepoCommitSHA, "repo-commit-sha", "", "Filter test executions by repository commit SHA")
-	cmd.Flags().StringVar(&c.ExecutionPhase, "phase", "", "Filter test executions by phase (one of 'pending', 'in_progress', 'succeeded', 'canceled' or 'failed')")
-	cmd.Flags().StringArrayVar(&c.Labels, "label", []string{}, "Filter test executions by label in the format key:value (can be specified multiple times)")
+	cmd.Flags().StringVar(&c.TestName, "test-name", "", "filter test executions by test name")
+	cmd.Flags().StringVar(&c.RunID, "run-id", "", "filter test executions by run ID")
+	cmd.Flags().StringVar(&c.Sandbox, "sandbox", "", "filter test executions by sandbox name")
+	cmd.Flags().StringVar(&c.Repo, "repo", "", "filter test executions by repository name")
+	cmd.Flags().StringVar(&c.RepoPath, "repo-path", "", "filter test executions by repository path")
+	cmd.Flags().StringVar(&c.RepoCommitSHA, "repo-commit-sha", "", "filter test executions by repository commit SHA")
+	cmd.Flags().StringVar(&c.ExecutionPhase, "phase", "", "filter test executions by phase (one of 'pending', 'in_progress', 'succeeded', 'canceled' or 'failed')")
+
+	c.Labels = make(map[string]string)
+	cmd.Flags().Var(&c.Labels, "label", "filter test executions by label in the format key=value (can be specified multiple times)")
 }
 
 type SmartTestExecCancel struct {
@@ -112,5 +125,5 @@ type SmartTestExecCancel struct {
 }
 
 func (c *SmartTestExecCancel) AddFlags(cmd *cobra.Command) {
-	cmd.Flags().StringVar(&c.RunID, "run-id", "", "Cancel all test executions of this run ID")
+	cmd.Flags().StringVar(&c.RunID, "run-id", "", "cancel all test executions in the run")
 }