feat: test workflow tags (#5813)

* feat: test workflow tags Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * feat: test workflow tags api spec Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> * feat: add test workflow api method routes Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io> --------- Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io>
kubeshop · Sep 5, 2024 · 9786aee · 9786aee
1 parent 0808db2
commit 9786aee
Show file tree

Hide file tree

Showing 8 changed files with 102 additions and 21 deletions.
diff --git a/api/v1/testkube.yaml b/api/v1/testkube.yaml
@@ -3761,6 +3761,42 @@ paths:
                 type: array
                 items:
                   $ref: "#/components/schemas/Problem"
+  /test-workflow-with-executions/{id}/tags:
+    get:
+      tags:
+        - test-workflows
+        - api
+      parameters:
+        - $ref: "#/components/parameters/ID"
+      summary: List test workflow execution tags
+      description: List test workflow execution tags for all executed test workflows
+      operationId: listTestWorkflowWithExecutionTags
+      responses:
+        200:
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                additionalProperties:
+                  type: array
+                  items:
+                    type: string
+                example:
+                  app:
+                    - backend
+                  env:
+                    - prod
+                  toDelete:
+                    - "yes"
+        502:
+          description: problem communicating with kubernetes cluster
+          content:
+            application/problem+json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Problem"
   /test-workflows/{id}/executions:
     get:
       tags:
@@ -3860,6 +3896,42 @@ paths:
                 type: array
                 items:
                   $ref: "#/components/schemas/Problem"
+  /test-workflows/{id}/tags:
+    get:
+      tags:
+        - test-workflows
+        - api
+      parameters:
+        - $ref: "#/components/parameters/ID"
+      summary: List test workflow execution tags
+      description: List test workflow execution tags for all executed test workflows
+      operationId: listTestWorkflowTagsByTestWorkflow
+      responses:
+        200:
+          description: successful list operation
+          content:
+            application/json:
+              schema:
+                type: object
+                additionalProperties:
+                  type: array
+                  items:
+                    type: string
+                example:
+                  app:
+                    - backend
+                  env:
+                    - prod
+                  toDelete:
+                    - "yes"
+        502:
+          description: problem communicating with kubernetes cluster
+          content:
+            application/problem+json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Problem"
   /test-workflows/{id}/metrics:
     get:
       tags:

diff --git a/internal/app/api/v1/labels_tags.go b/internal/app/api/v1/labels_tags.go
@@ -28,8 +28,9 @@ func (s TestkubeAPI) ListLabelsHandler() fiber.Handler {
 func (s *TestkubeAPI) ListTagsHandler() fiber.Handler {
 	return func(c *fiber.Ctx) error {
 		errPrefix := "failed to list execution tags"
+		id := c.Params("id")
 
-		tags, err := s.TestWorkflowResults.GetExecutionTags(c.Context())
+		tags, err := s.TestWorkflowResults.GetExecutionTags(c.Context(), id)
 		if err != nil {
 			return s.ClientError(c, errPrefix, err)
 		}

diff --git a/internal/app/api/v1/server.go b/internal/app/api/v1/server.go
@@ -412,6 +412,7 @@ func (s *TestkubeAPI) InitRoutes() {
 	testWorkflows.Delete("/:id", s.DeleteTestWorkflowHandler())
 	testWorkflows.Get("/:id/executions", s.ListTestWorkflowExecutionsHandler())
 	testWorkflows.Post("/:id/executions", s.ExecuteTestWorkflowHandler())
+	testWorkflows.Get("/:id/tags", s.ListTagsHandler())
 	testWorkflows.Get("/:id/metrics", s.GetTestWorkflowMetricsHandler())
 	testWorkflows.Get("/:id/executions/:executionID", s.GetTestWorkflowExecutionHandler())
 	testWorkflows.Post("/:id/abort", s.AbortAllTestWorkflowExecutionsHandler())
@@ -436,6 +437,7 @@ func (s *TestkubeAPI) InitRoutes() {
 	testWorkflowWithExecutions := root.Group("/test-workflow-with-executions")
 	testWorkflowWithExecutions.Get("/", s.ListTestWorkflowWithExecutionsHandler())
 	testWorkflowWithExecutions.Get("/:id", s.GetTestWorkflowWithExecutionHandler())
+	testWorkflowWithExecutions.Get("/:id/tags", s.ListTagsHandler())
 
 	root.Post("/preview-test-workflow", s.PreviewTestWorkflowHandler())
 

diff --git a/pkg/cloud/data/testworkflow/execution.go b/pkg/cloud/data/testworkflow/execution.go
@@ -170,8 +170,8 @@ func (r *CloudRepository) GetNextExecutionNumber(ctx context.Context, testWorkfl
 	return commandResponse.TestWorkflowNumber, nil
 }
 
-func (r *CloudRepository) GetExecutionTags(ctx context.Context) (tags map[string][]string, err error) {
-	req := ExecutionGetExecutionTagsRequest{}
+func (r *CloudRepository) GetExecutionTags(ctx context.Context, testWorkflowName string) (tags map[string][]string, err error) {
+	req := ExecutionGetExecutionTagsRequest{TestWorkflowName: testWorkflowName}
 	process := func(v ExecutionGetExecutionTagsResponse) map[string][]string {
 		return v.Tags
 	}

diff --git a/pkg/cloud/data/testworkflow/execution_models.go b/pkg/cloud/data/testworkflow/execution_models.go
@@ -180,6 +180,7 @@ type ExecutionGetNextExecutionNumberResponse struct {
 }
 
 type ExecutionGetExecutionTagsRequest struct {
+	TestWorkflowName string `json:"testWorkflowName"`
 }
 
 type ExecutionGetExecutionTagsResponse struct {

diff --git a/pkg/repository/testworkflow/interface.go b/pkg/repository/testworkflow/interface.go
@@ -69,7 +69,7 @@ type Repository interface {
 	// GetTestWorkflowMetrics get metrics based on the TestWorkflow results
 	GetTestWorkflowMetrics(ctx context.Context, name string, limit, last int) (metrics testkube.ExecutionsMetrics, err error)
 	// GetExecutionTags gets execution tags
-	GetExecutionTags(ctx context.Context) (map[string][]string, error)
+	GetExecutionTags(ctx context.Context, testWorkflowName string) (map[string][]string, error)
 }
 
 type Sequences interface {

diff --git a/pkg/repository/testworkflow/mock_repository.go b/pkg/repository/testworkflow/mock_repository.go
diff --git a/pkg/repository/testworkflow/mongo.go b/pkg/repository/testworkflow/mongo.go
@@ -508,9 +508,14 @@ func (r *MongoRepository) GetNextExecutionNumber(ctx context.Context, name strin
 	return r.sequenceRepository.GetNextExecutionNumber(ctx, name, sequence.ExecutionTypeTestWorkflow)
 }
 
-func (r *MongoRepository) GetExecutionTags(ctx context.Context) (tags map[string][]string, err error) {
+func (r *MongoRepository) GetExecutionTags(ctx context.Context, testWorkflowName string) (tags map[string][]string, err error) {
+	query := bson.M{"tags": bson.M{"$exists": true}}
+	if testWorkflowName != "" {
+		query["workflow.name"] = testWorkflowName
+	}
+
 	pipeline := []bson.M{
-		{"$match": bson.M{"tags": bson.M{"$exists": true}}},
+		{"$match": query},
 		{"$project": bson.M{
 			"tags": 1,
 		}},