feat: [TKC-3016] add defaultConfigs for TestWorkflow executions (#6090)

kubeshop · Dec 18, 2024 · b0b3f6e · b0b3f6e
1 parent 378ab7e
commit b0b3f6e
Show file tree

Hide file tree

Showing 5 changed files with 193 additions and 15 deletions.
diff --git a/api/v1/testkube.yaml b/api/v1/testkube.yaml
@@ -9534,6 +9534,9 @@ components:
         defaultValue:
           type: string
           description: configuration value default
+        truncated:
+          type: boolean
+          description: indicates if the value is truncated
 
 
     TestWorkflowConfigValue:

diff --git a/pkg/api/v1/testkube/model_test_workflow_execution_config_value.go b/pkg/api/v1/testkube/model_test_workflow_execution_config_value.go
@@ -15,4 +15,6 @@ type TestWorkflowExecutionConfigValue struct {
 	Value string `json:"value,omitempty"`
 	// configuration value default
 	DefaultValue string `json:"defaultValue,omitempty"`
+	// indicates if the value is truncated
+	Truncated bool `json:"truncated,omitempty"`
 }
diff --git a/pkg/repository/testworkflow/mongo.go b/pkg/repository/testworkflow/mongo.go
@@ -21,7 +21,10 @@ import (
 
 var _ Repository = (*MongoRepository)(nil)
 
-const CollectionName = "testworkflowresults"
+const (
+	CollectionName       = "testworkflowresults"
+	configParamSizeLimit = 100
+)
 
 func NewMongoRepository(db *mongo.Database, allowDiskUse bool, opts ...MongoRepositoryOpt) *MongoRepository {
 	r := &MongoRepository{
@@ -60,9 +63,39 @@ type MongoRepositoryOpt func(*MongoRepository)
 
 func (r *MongoRepository) Get(ctx context.Context, id string) (result testkube.TestWorkflowExecution, err error) {
 	err = r.Coll.FindOne(ctx, bson.M{"$or": bson.A{bson.M{"id": id}, bson.M{"name": id}}}).Decode(&result)
+
+	if result.ResolvedWorkflow != nil && result.ResolvedWorkflow.Spec != nil && result.ConfigParams != nil {
+		r.populateConfigParams(result.ResolvedWorkflow, result.ConfigParams)
+	}
+
 	return *result.UnscapeDots(), err
 }
 
+func (r *MongoRepository) populateConfigParams(resolvedWorkflow *testkube.TestWorkflow, configParams map[string]testkube.TestWorkflowExecutionConfigValue) {
+	for k, v := range resolvedWorkflow.Spec.Config {
+		if v.Default_ != nil {
+			if _, ok := configParams[k]; !ok {
+				configParams[k] = testkube.TestWorkflowExecutionConfigValue{
+					DefaultValue: v.Default_.Value,
+				}
+			} else {
+				value := configParams[k].Value
+				truncated := false
+				if len(value) > configParamSizeLimit {
+					value = value[:configParamSizeLimit]
+					truncated = true
+				}
+				configParams[k] = testkube.TestWorkflowExecutionConfigValue{
+					DefaultValue: v.Default_.Value,
+					Value:        value,
+					Truncated:    truncated,
+				}
+			}
+		}
+	}
+	return
+}
+
 func (r *MongoRepository) GetByNameAndTestWorkflow(ctx context.Context, name, workflowName string) (result testkube.TestWorkflowExecution, err error) {
 	err = r.Coll.FindOne(ctx, bson.M{"$or": bson.A{bson.M{"id": name}, bson.M{"name": name}}, "workflow.name": workflowName}).Decode(&result)
 	return *result.UnscapeDots(), err
@@ -241,8 +274,13 @@ func (r *MongoRepository) GetExecutions(ctx context.Context, filter Filter) (res
 	return
 }
 
+type TestWorkflowExecutionSummaryWithResolvedWorkflow struct {
+	testkube.TestWorkflowExecutionSummary `json:",inline" bson:",inline"`
+	ResolvedWorkflow                      *testkube.TestWorkflow `json:"resolvedWorkflow,omitempty"`
+}
+
 func (r *MongoRepository) GetExecutionsSummary(ctx context.Context, filter Filter) (result []testkube.TestWorkflowExecutionSummary, err error) {
-	result = make([]testkube.TestWorkflowExecutionSummary, 0)
+	executions := make([]TestWorkflowExecutionSummaryWithResolvedWorkflow, 0)
 	query, opts := composeQueryAndOpts(filter)
 	if r.allowDiskUse {
 		opts.SetAllowDiskUse(r.allowDiskUse)
@@ -255,16 +293,20 @@ func (r *MongoRepository) GetExecutionsSummary(ctx context.Context, filter Filte
 		"result.steps":          0,
 		"result.initialization": 0,
 		"workflow.spec":         0,
-		"resolvedWorkflow":      0,
 	})
 	cursor, err := r.Coll.Find(ctx, query, opts)
 	if err != nil {
 		return
 	}
-	err = cursor.All(ctx, &result)
+	err = cursor.All(ctx, &executions)
+	result = make([]testkube.TestWorkflowExecutionSummary, len(executions))
+	for i := range executions {
+		executions[i].UnscapeDots()
 
-	for i := range result {
-		result[i].UnscapeDots()
+		if executions[i].ResolvedWorkflow != nil && executions[i].ResolvedWorkflow.Spec != nil && executions[i].ConfigParams != nil {
+			r.populateConfigParams(executions[i].ResolvedWorkflow, executions[i].ConfigParams)
+		}
+		result[i] = executions[i].TestWorkflowExecutionSummary
 	}
 	return
 }

diff --git a/pkg/repository/testworkflow/mongo_integration_test.go b/pkg/repository/testworkflow/mongo_integration_test.go
@@ -431,3 +431,135 @@ func TestNewMongoRepository_GetExecutions_Actor_Integration(t *testing.T) {
 
 	assert.Len(t, res, 0)
 }
+
+func TestNewMongoRepository_GetExecutionsSummary_Integration(t *testing.T) {
+	test.IntegrationTest(t)
+	ctx := context.Background()
+	client, err := mongo.Connect(ctx, options.Client().ApplyURI(cfg.APIMongoDSN))
+	if err != nil {
+		t.Fatalf("error connecting to mongo: %v", err)
+	}
+	db := client.Database("testworkflow-executions-summary-mongo-repository-test")
+	t.Cleanup(func() {
+		db.Drop(ctx)
+	})
+	repo := NewMongoRepository(db, false)
+
+	// Insert test data
+	execution := testkube.TestWorkflowExecution{
+		Id:   "test-id-1",
+		Name: "test-name-1",
+		Workflow: &testkube.TestWorkflow{
+			Name: "test-workflow-1",
+			Spec: &testkube.TestWorkflowSpec{},
+		},
+		ResolvedWorkflow: &testkube.TestWorkflow{
+			Name: "test-workflow-1",
+			Spec: &testkube.TestWorkflowSpec{
+				Config: map[string]testkube.TestWorkflowParameterSchema{
+					"param1": {
+						Default_: &testkube.BoxedString{
+							Value: "default",
+						},
+					},
+				},
+			},
+		},
+		ConfigParams: map[string]testkube.TestWorkflowExecutionConfigValue{},
+	}
+	err = repo.Insert(ctx, execution)
+	assert.NoError(t, err)
+
+	execution2 := testkube.TestWorkflowExecution{
+		Id:   "test-id-1",
+		Name: "test-name-2",
+		Workflow: &testkube.TestWorkflow{
+			Name: "test-workflow-2",
+			Spec: &testkube.TestWorkflowSpec{},
+		},
+		ResolvedWorkflow: &testkube.TestWorkflow{
+			Name: "test-workflow-2",
+			Spec: &testkube.TestWorkflowSpec{
+				Config: map[string]testkube.TestWorkflowParameterSchema{
+					"param1": {
+						Default_: &testkube.BoxedString{
+							Value: "default",
+						},
+					},
+				},
+			},
+		},
+		ConfigParams: map[string]testkube.TestWorkflowExecutionConfigValue{
+			"param1": {
+				Value: "custom-value",
+			},
+		},
+	}
+	err = repo.Insert(ctx, execution2)
+	assert.NoError(t, err)
+
+	// Test GetExecutionsSummary
+	filter := NewExecutionsFilter().WithName("test-workflow-1")
+	result, err := repo.GetExecutionsSummary(ctx, filter)
+	assert.NoError(t, err)
+	assert.Len(t, result, 1)
+	assert.Equal(t, "test-name-1", result[0].Name)
+	assert.Equal(t, "default", result[0].ConfigParams["param1"].DefaultValue)
+
+	filter = NewExecutionsFilter().WithName("test-workflow-2")
+	result, err = repo.GetExecutionsSummary(ctx, filter)
+	assert.NoError(t, err)
+	assert.Len(t, result, 1)
+	assert.Equal(t, "test-name-2", result[0].Name)
+	assert.Equal(t, "default", result[0].ConfigParams["param1"].DefaultValue)
+	assert.Equal(t, "custom-value", result[0].ConfigParams["param1"].Value)
+}
+
+func TestNewMongoRepository_Get_Integration(t *testing.T) {
+	test.IntegrationTest(t)
+
+	ctx := context.Background()
+
+	client, err := mongo.Connect(ctx, options.Client().ApplyURI(cfg.APIMongoDSN))
+	if err != nil {
+		t.Fatalf("error connecting to mongo: %v", err)
+	}
+	db := client.Database("testworkflow-get-mongo-repository-test")
+	t.Cleanup(func() {
+		db.Drop(ctx)
+	})
+
+	repo := NewMongoRepository(db, false)
+	execution := testkube.TestWorkflowExecution{
+		Id:   "test-id-1",
+		Name: "test-name-1",
+		Workflow: &testkube.TestWorkflow{
+			Name: "test-workflow-1",
+			Spec: &testkube.TestWorkflowSpec{},
+		},
+		ResolvedWorkflow: &testkube.TestWorkflow{
+			Name: "test-workflow-1",
+			Spec: &testkube.TestWorkflowSpec{
+				Config: map[string]testkube.TestWorkflowParameterSchema{
+					"param1": {
+						Default_: &testkube.BoxedString{
+							Value: "default",
+						},
+					},
+				},
+			},
+		},
+		ConfigParams: map[string]testkube.TestWorkflowExecutionConfigValue{},
+	}
+	err = repo.Insert(ctx, execution)
+	assert.NoError(t, err)
+
+	result, err := repo.Get(ctx, "test-id-1")
+	assert.NoError(t, err)
+
+	assert.Equal(t, execution.Id, result.Id)
+	assert.Equal(t, execution.Name, result.Name)
+	assert.Equal(t, "default", result.ConfigParams["param1"].DefaultValue)
+	assert.Equal(t, false, result.ConfigParams["param1"].Truncated)
+
+}
diff --git a/pkg/testworkflows/testworkflowexecutor/executor.go b/pkg/testworkflows/testworkflowexecutor/executor.go
@@ -468,31 +468,30 @@ func (e *executor) initialize(ctx context.Context, workflow *testworkflowsv1.Tes
 		DisableWebhooks:           request.DisableWebhooks,
 		Tags:                      map[string]string{},
 		RunningContext:            request.RunningContext,
+		ConfigParams:              make(map[string]testkube.TestWorkflowExecutionConfigValue),
 	}
 
 	// Store the configuration if it is small and not sensitive
 	if testworkflows.CountMapBytes(request.Config) < ConfigSizeLimit {
 		storeConfig := true
 		schema := workflow.Spec.Config
-		config := make(map[string]testkube.TestWorkflowExecutionConfigValue)
 		for _, v := range schema {
 			if v.Sensitive {
 				storeConfig = false
+				execution.ConfigParams = nil
 				break
 			}
 		}
 
-		for k, v := range request.Config {
-			if _, ok := schema[k]; ok {
-				config[k] = testkube.TestWorkflowExecutionConfigValue{
-					Value: v,
+		if storeConfig {
+			for k, v := range request.Config {
+				if _, ok := schema[k]; ok {
+					execution.ConfigParams[k] = testkube.TestWorkflowExecutionConfigValue{
+						Value: v,
+					}
 				}
 			}
 		}
-
-		if storeConfig {
-			execution.ConfigParams = config
-		}
 	}
 
 	// Try to resolve tags initialily