feat: [TKC-2299] add tags to testworkflow models (#5744)

* feat: add tags to testworkflow models Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: missed model Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: dep update Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * feat: filter by tags Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: convert dots for parallel step Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: convert dots for execute Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: remove filed Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: remove tags Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: remove unsued tags Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: unit tests Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * feat: pass execution tags Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: format result Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: remove from parallel step Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: cli docs Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: extract methods Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: go mod tidy Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * fix: typo Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> --------- Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> Co-authored-by: Jacek Wysocki <jacek.wysocki@gmail.com>
kubeshop · Aug 30, 2024 · 864daf8 · 864daf8
1 parent 466e4d4
commit 864daf8
Show file tree

Hide file tree

Showing 32 changed files with 227 additions and 20 deletions.
diff --git a/api/v1/testkube.yaml b/api/v1/testkube.yaml
@@ -3735,6 +3735,7 @@ paths:
         - pro
       parameters:
         - $ref: "#/components/parameters/ID"
+        - $ref: "#/components/parameters/TagSelector"
       summary: List test workflow executions
       description: List test workflow executions
       operationId: listTestWorkflowExecutionsByTestWorkflow
@@ -3963,6 +3964,7 @@ paths:
         - pro
       parameters:
         - $ref: "#/components/parameters/ID"
+        - $ref: "#/components/parameters/TagSelector"
       summary: List test workflow executions
       description: List test workflow executions
       operationId: listTestWorkflowExecutions
@@ -7905,6 +7907,8 @@ components:
           type: boolean
           description: whether webhooks on the execution of this test workflow are disabled
           default: false
+        tags:
+          $ref: "#/components/schemas/TestWorkflowTagValue"
 
     TestWorkflowWithExecution:
       type: object
@@ -7996,6 +8000,8 @@ components:
           example:
             - true
             - false
+        tags:
+          $ref: "#/components/schemas/TestWorkflowTagValue"
       required:
         - id
         - name
@@ -8028,6 +8034,8 @@ components:
           $ref: "#/components/schemas/TestWorkflowResultSummary"
         workflow:
           $ref: "#/components/schemas/TestWorkflowSummary"
+        tags:
+          $ref: "#/components/schemas/TestWorkflowTagValue"
       required:
         - id
         - name
@@ -8541,6 +8549,8 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/TestWorkflowEvent"
+        execution:
+          $ref: "#/components/schemas/TestWorkflowTagSchema"
 
     TestWorkflowTemplateSpec:
       type: object
@@ -8577,6 +8587,8 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/TestWorkflowEvent"
+        execution:
+          $ref: "#/components/schemas/TestWorkflowTagSchema"
 
     TestWorkflowStepControl:
       type: object
@@ -9398,6 +9410,19 @@ components:
           format: int64
           description: test workflow execution generation
 
+    TestWorkflowTagValue:
+      type: object
+      description: tag values to pass to the test workflow execution
+      additionalProperties:
+        type: string
+
+    TestWorkflowTagSchema:
+      type: object
+      description: test workflow execution tag definition
+      properties:
+        tags:
+          $ref: "#/components/schemas/TestWorkflowTagValue"
+
     ContentGitAuthType:
       type: string
       description: auth type for git requests
@@ -10521,6 +10546,12 @@ components:
         default: false
       description: dont delete CRD
       required: false
+    TagSelector:
+      in: query
+      name: tagSelector
+      schema:
+        type: string
+        description: Test workflow execution tags
   requestBodies:
     UploadsBody:
       description: "Upload files request body data"

diff --git a/cmd/kubectl-testkube/commands/testworkflows/executions.go b/cmd/kubectl-testkube/commands/testworkflows/executions.go
@@ -19,6 +19,7 @@ func NewGetTestWorkflowExecutionsCmd() *cobra.Command {
 		selectors        []string
 		testWorkflowName string
 		logsOnly         bool
+		tags             []string
 	)
 
 	cmd := &cobra.Command{
@@ -44,7 +45,8 @@ func NewGetTestWorkflowExecutionsCmd() *cobra.Command {
 				client, _, err := common.GetClient(cmd)
 				ui.ExitOnError("getting client", err)
 
-				executions, err := client.ListTestWorkflowExecutions(testWorkflowName, limit, strings.Join(selectors, ","))
+				executions, err := client.ListTestWorkflowExecutions(testWorkflowName, limit,
+					strings.Join(selectors, ","), strings.Join(tags, ","))
 				ui.ExitOnError("getting test workflow executions list", err)
 				err = render.List(cmd, testkube.TestWorkflowExecutionSummaries(executions.Results), os.Stdout)
 				ui.ExitOnError("rendering list", err)
@@ -84,6 +86,7 @@ func NewGetTestWorkflowExecutionsCmd() *cobra.Command {
 	cmd.Flags().IntVar(&limit, "limit", 1000, "max number of records to return")
 	cmd.Flags().StringSliceVarP(&selectors, "label", "l", nil, "label key value pair: --label key1=value1")
 	cmd.Flags().BoolVar(&logsOnly, "logs-only", false, "show only execution logs")
+	cmd.Flags().StringSliceVarP(&tags, "tag", "", nil, "tag key value pair: --tag key1=value1")
 
 	return cmd
 }
diff --git a/cmd/kubectl-testkube/commands/testworkflows/renderer/testworkflowexecution_obj.go b/cmd/kubectl-testkube/commands/testworkflows/renderer/testworkflowexecution_obj.go
@@ -59,10 +59,14 @@ func printPrettyOutput(ui *ui.UI, execution testkube.TestWorkflowExecution) {
 		}
 		ui.Warn("Requested at:        ", execution.ScheduledAt.String())
 		ui.Warn("Disabled webhooks:   ", fmt.Sprint(execution.DisableWebhooks))
+		if len(execution.Tags) > 0 {
+			ui.NL()
+			ui.Warn("Tags:                ", testkube.MapToString(execution.Tags))
+		}
 		if execution.Result != nil && execution.Result.Status != nil {
 			ui.Warn("Status:              ", string(*execution.Result.Status))
 			if !execution.Result.QueuedAt.IsZero() {
-				ui.Warn("Queued at:          ", execution.Result.QueuedAt.String())
+				ui.Warn("Queued at:           ", execution.Result.QueuedAt.String())
 			}
 			if !execution.Result.StartedAt.IsZero() {
 				ui.Warn("Started at:          ", execution.Result.StartedAt.String())

diff --git a/cmd/kubectl-testkube/commands/testworkflows/run.go b/cmd/kubectl-testkube/commands/testworkflows/run.go
@@ -40,6 +40,7 @@ func NewRunTestWorkflowCmd() *cobra.Command {
 		downloadDir              string
 		format                   string
 		masks                    []string
+		tags                     map[string]string
 	)
 
 	cmd := &cobra.Command{
@@ -65,6 +66,7 @@ func NewRunTestWorkflowCmd() *cobra.Command {
 				Name:            executionName,
 				Config:          config,
 				DisableWebhooks: disableWebhooks,
+				Tags:            tags,
 			})
 			if err != nil {
 				// User friendly Open Source operation error
@@ -121,6 +123,7 @@ func NewRunTestWorkflowCmd() *cobra.Command {
 	cmd.Flags().BoolVarP(&downloadArtifactsEnabled, "download-artifacts", "d", false, "download artifacts automatically")
 	cmd.Flags().StringVar(&format, "format", "folder", "data format for storing files, one of folder|archive")
 	cmd.Flags().StringArrayVarP(&masks, "mask", "", []string{}, "regexp to filter downloaded files, single or comma separated, like report/.* or .*\\.json,.*\\.js$")
+	cmd.Flags().StringToStringVarP(&tags, "tag", "", map[string]string{}, "execution tags in a form of name1=val1 passed to executor")
 
 	return cmd
 }

diff --git a/cmd/tcl/testworkflow-toolkit/commands/execute.go b/cmd/tcl/testworkflow-toolkit/commands/execute.go
@@ -32,6 +32,7 @@ import (
 	"github.com/kubeshop/testkube/pkg/mapper/testworkflows"
 	"github.com/kubeshop/testkube/pkg/testworkflows/testworkflowprocessor/constants"
 	"github.com/kubeshop/testkube/pkg/ui"
+	"github.com/kubeshop/testkube/pkg/utils"
 )
 
 type testExecutionDetails struct {
@@ -151,10 +152,16 @@ func buildWorkflowExecution(workflow testworkflowsv1.StepExecuteWorkflow, async
 	return func() (err error) {
 		c := env.Testkube()
 
+		tags, err := utils.DecodeEnvVarToStringMap(env.ExecutionTags())
+		if err != nil {
+			ui.Errf("failed to decode tags: %s: %s", workflow.Name, err.Error())
+		}
+
 		exec, err := c.ExecuteTestWorkflow(workflow.Name, testkube.TestWorkflowExecutionRequest{
 			Name:            workflow.ExecutionName,
 			Config:          testworkflows.MapConfigValueKubeToAPI(workflow.Config),
 			DisableWebhooks: env.ExecutionDisableWebhooks(),
+			Tags:            tags,
 		})
 		execName := exec.Name
 		if err != nil {

diff --git a/cmd/tcl/testworkflow-toolkit/spawn/utils.go b/cmd/tcl/testworkflow-toolkit/spawn/utils.go
@@ -205,6 +205,7 @@ func CreateExecutionMachine(prefix string, index int64) (string, expressions.Mac
 			"number":          env.ExecutionNumber(),
 			"scheduledAt":     env.ExecutionScheduledAt().UTC().Format(constants.RFC3339Millis),
 			"disableWebhooks": env.ExecutionDisableWebhooks(),
+			"tags":            env.ExecutionTags(),
 		})
 }
 

diff --git a/cmd/testworkflow-toolkit/env/config.go b/cmd/testworkflow-toolkit/env/config.go
@@ -47,6 +47,7 @@ type envExecutionConfig struct {
 	RootResourceId  string `envconfig:"TK_EXR"`
 	FSPrefix        string `envconfig:"TK_FS"`
 	DisableWebhooks bool   `envconfig:"TK_DWH"`
+	Tags            string `envconfig:"TK_TAG"`
 }
 
 type envSystemConfig struct {
@@ -157,3 +158,7 @@ func ExecutionDisableWebhooks() bool {
 func JUnitParserEnabled() bool {
 	return Config().Features.EnableJUnitParser
 }
+
+func ExecutionTags() string {
+	return Config().Execution.Tags
+}
diff --git a/internal/app/api/v1/testworkflowexecutions.go b/internal/app/api/v1/testworkflowexecutions.go
@@ -510,5 +510,10 @@ func getWorkflowExecutionsFilterFromRequest(c *fiber.Ctx) testworkflow2.Filter {
 		filter = filter.WithSelector(selector)
 	}
 
+	tagSelector := c.Query("tagSelector")
+	if tagSelector != "" {
+		filter = filter.WithTagSelector(tagSelector)
+	}
+
 	return filter
 }
diff --git a/pkg/api/v1/client/interface.go b/pkg/api/v1/client/interface.go
@@ -158,7 +158,7 @@ type TestWorkflowAPI interface {
 // TestWorkflowExecutionAPI describes test workflow api methods
 type TestWorkflowExecutionAPI interface {
 	GetTestWorkflowExecution(executionID string) (execution testkube.TestWorkflowExecution, err error)
-	ListTestWorkflowExecutions(id string, limit int, selector string) (executions testkube.TestWorkflowExecutionsResult, err error)
+	ListTestWorkflowExecutions(id string, limit int, selector, tagSelector string) (executions testkube.TestWorkflowExecutionsResult, err error)
 	AbortTestWorkflowExecution(workflow string, id string) error
 	AbortTestWorkflowExecutions(workflow string) error
 	GetTestWorkflowExecutionArtifacts(executionID string) (artifacts testkube.Artifacts, err error)

diff --git a/pkg/api/v1/client/testworkflow.go b/pkg/api/v1/client/testworkflow.go
@@ -136,14 +136,15 @@ func (c TestWorkflowClient) GetTestWorkflowExecution(id string) (testkube.TestWo
 }
 
 // ListTestWorkflowExecutions list test workflow executions for selected workflow
-func (c TestWorkflowClient) ListTestWorkflowExecutions(id string, limit int, selector string) (testkube.TestWorkflowExecutionsResult, error) {
+func (c TestWorkflowClient) ListTestWorkflowExecutions(id string, limit int, selector, tagSelector string) (testkube.TestWorkflowExecutionsResult, error) {
 	uri := c.testWorkflowExecutionsResultTransport.GetURI("/test-workflow-executions/")
 	if id != "" {
 		uri = c.testWorkflowExecutionsResultTransport.GetURI(fmt.Sprintf("/test-workflows/%s/executions", id))
 	}
 	params := map[string]string{
-		"selector": selector,
-		"pageSize": fmt.Sprintf("%d", limit),
+		"selector":    selector,
+		"pageSize":    fmt.Sprintf("%d", limit),
+		"tagSelector": tagSelector,
 	}
 	return c.testWorkflowExecutionsResultTransport.Execute(http.MethodGet, uri, nil, params)
 }

diff --git a/pkg/api/v1/testkube/model_test_workflow_execution.go b/pkg/api/v1/testkube/model_test_workflow_execution.go
@@ -38,5 +38,6 @@ type TestWorkflowExecution struct {
 	// test workflow execution name started the test workflow execution
 	TestWorkflowExecutionName string `json:"testWorkflowExecutionName,omitempty"`
 	// whether webhooks on the execution of this test workflow are disabled
-	DisableWebhooks bool `json:"disableWebhooks,omitempty"`
+	DisableWebhooks bool              `json:"disableWebhooks,omitempty"`
+	Tags            map[string]string `json:"tags,omitempty"`
 }
diff --git a/pkg/api/v1/testkube/model_test_workflow_execution_extended.go b/pkg/api/v1/testkube/model_test_workflow_execution_extended.go
@@ -5,7 +5,7 @@ import "github.com/kubeshop/testkube/pkg/utils"
 type TestWorkflowExecutions []TestWorkflowExecution
 
 func (executions TestWorkflowExecutions) Table() (header []string, output [][]string) {
-	header = []string{"Id", "Name", "Test Workflow Name", "Status", "Labels"}
+	header = []string{"Id", "Name", "Test Workflow Name", "Status", "Labels", "Tags"}
 
 	for _, e := range executions {
 		status := "unknown"
@@ -19,6 +19,7 @@ func (executions TestWorkflowExecutions) Table() (header []string, output [][]st
 			e.Workflow.Name,
 			status,
 			MapToString(e.Workflow.Labels),
+			MapToString(e.Tags),
 		})
 	}
 
@@ -28,6 +29,9 @@ func (executions TestWorkflowExecutions) Table() (header []string, output [][]st
 func (e *TestWorkflowExecution) ConvertDots(fn func(string) string) *TestWorkflowExecution {
 	e.Workflow.ConvertDots(fn)
 	e.ResolvedWorkflow.ConvertDots(fn)
+	if e.Tags != nil {
+		e.Tags = convertDotsInMap(e.Tags, fn)
+	}
 	return e
 }
 

diff --git a/pkg/api/v1/testkube/model_test_workflow_execution_request.go b/pkg/api/v1/testkube/model_test_workflow_execution_request.go
@@ -16,5 +16,6 @@ type TestWorkflowExecutionRequest struct {
 	// test workflow execution name started the test workflow execution
 	TestWorkflowExecutionName string `json:"testWorkflowExecutionName,omitempty"`
 	// whether webhooks on the execution of this test workflow are disabled
-	DisableWebhooks bool `json:"disableWebhooks,omitempty"`
+	DisableWebhooks bool              `json:"disableWebhooks,omitempty"`
+	Tags            map[string]string `json:"tags,omitempty"`
 }
diff --git a/pkg/api/v1/testkube/model_test_workflow_execution_summary.go b/pkg/api/v1/testkube/model_test_workflow_execution_summary.go
@@ -26,4 +26,5 @@ type TestWorkflowExecutionSummary struct {
 	StatusAt time.Time                  `json:"statusAt,omitempty"`
 	Result   *TestWorkflowResultSummary `json:"result,omitempty"`
 	Workflow *TestWorkflowSummary       `json:"workflow"`
+	Tags     map[string]string          `json:"tags,omitempty"`
 }
diff --git a/pkg/api/v1/testkube/model_test_workflow_execution_summary_extended.go b/pkg/api/v1/testkube/model_test_workflow_execution_summary_extended.go
@@ -7,7 +7,7 @@ import (
 type TestWorkflowExecutionSummaries []TestWorkflowExecutionSummary
 
 func (executions TestWorkflowExecutionSummaries) Table() (header []string, output [][]string) {
-	header = []string{"Id", "Name", "Test Workflow Name", "Status", "Labels"}
+	header = []string{"Id", "Name", "Test Workflow Name", "Status", "Labels", "Tags"}
 
 	for _, e := range executions {
 		status := "unknown"
@@ -21,6 +21,7 @@ func (executions TestWorkflowExecutionSummaries) Table() (header []string, outpu
 			e.Workflow.Name,
 			status,
 			MapToString(e.Workflow.Labels),
+			MapToString(e.Tags),
 		})
 	}
 
@@ -29,6 +30,9 @@ func (executions TestWorkflowExecutionSummaries) Table() (header []string, outpu
 
 func (e *TestWorkflowExecutionSummary) ConvertDots(fn func(string) string) *TestWorkflowExecutionSummary {
 	e.Workflow.ConvertDots(fn)
+	if e.Tags != nil {
+		e.Tags = convertDotsInMap(e.Tags, fn)
+	}
 	return e
 }
 

diff --git a/pkg/api/v1/testkube/model_test_workflow_extended.go b/pkg/api/v1/testkube/model_test_workflow_extended.go
@@ -30,7 +30,7 @@ func (w *TestWorkflow) ConvertDots(fn func(string) string) *TestWorkflow {
 	if w == nil {
 		return w
 	}
-	if w.Labels == nil {
+	if w.Labels != nil {
 		w.Labels = convertDotsInMap(w.Labels, fn)
 	}
 	if w.Spec.Pod != nil {
@@ -56,6 +56,10 @@ func (w *TestWorkflow) ConvertDots(fn func(string) string) *TestWorkflow {
 	for i := range w.Spec.After {
 		w.Spec.After[i].ConvertDots(fn)
 	}
+	if w.Spec.Execution != nil {
+		w.Spec.Execution.Tags = convertDotsInMap(w.Spec.Execution.Tags, fn)
+	}
+
 	return w
 }
 

diff --git a/pkg/api/v1/testkube/model_test_workflow_independent_step_parallel.go b/pkg/api/v1/testkube/model_test_workflow_independent_step_parallel.go
@@ -52,4 +52,5 @@ type TestWorkflowIndependentStepParallel struct {
 	Steps     []TestWorkflowIndependentStep                 `json:"steps,omitempty"`
 	After     []TestWorkflowIndependentStep                 `json:"after,omitempty"`
 	Events    []TestWorkflowEvent                           `json:"events,omitempty"`
+	Execution *TestWorkflowTagSchema                        `json:"execution,omitempty"`
 }
diff --git a/pkg/api/v1/testkube/model_test_workflow_spec.go b/pkg/api/v1/testkube/model_test_workflow_spec.go
@@ -22,4 +22,5 @@ type TestWorkflowSpec struct {
 	Steps     []TestWorkflowStep                     `json:"steps,omitempty"`
 	After     []TestWorkflowStep                     `json:"after,omitempty"`
 	Events    []TestWorkflowEvent                    `json:"events,omitempty"`
+	Execution *TestWorkflowTagSchema                 `json:"execution,omitempty"`
 }
diff --git a/pkg/api/v1/testkube/model_test_workflow_step_parallel.go b/pkg/api/v1/testkube/model_test_workflow_step_parallel.go
@@ -54,4 +54,5 @@ type TestWorkflowStepParallel struct {
 	Steps     []TestWorkflowStep                     `json:"steps,omitempty"`
 	After     []TestWorkflowStep                     `json:"after,omitempty"`
 	Events    []TestWorkflowEvent                    `json:"events,omitempty"`
+	Execution *TestWorkflowTagSchema                 `json:"execution,omitempty"`
 }
diff --git a/pkg/api/v1/testkube/model_test_workflow_tag_schema.go b/pkg/api/v1/testkube/model_test_workflow_tag_schema.go
@@ -0,0 +1,15 @@
+/*
+ * Testkube API
+ *
+ * Testkube provides a Kubernetes-native framework for test definition, execution and results
+ *
+ * API version: 1.0.0
+ * Contact: testkube@kubeshop.io
+ * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
+ */
+package testkube
+
+// test workflow execution tag definition
+type TestWorkflowTagSchema struct {
+	Tags map[string]string `json:"tags,omitempty"`
+}
diff --git a/pkg/api/v1/testkube/model_test_workflow_template_spec.go b/pkg/api/v1/testkube/model_test_workflow_template_spec.go
@@ -21,4 +21,5 @@ type TestWorkflowTemplateSpec struct {
 	Steps     []TestWorkflowIndependentStep                 `json:"steps,omitempty"`
 	After     []TestWorkflowIndependentStep                 `json:"after,omitempty"`
 	Events    []TestWorkflowEvent                           `json:"events,omitempty"`
+	Execution *TestWorkflowTagSchema                        `json:"execution,omitempty"`
 }