feat: add Abort() option for Execution Worker, that may be useful lat…

…er for different drivers than Kubernetes
kubeshop · Oct 15, 2024 · 46e6f65 · 46e6f65
1 parent 0f18c42
commit 46e6f65
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 11 deletions.
diff --git a/cmd/tcl/testworkflow-toolkit/commands/parallel.go b/cmd/tcl/testworkflow-toolkit/commands/parallel.go
@@ -377,7 +377,7 @@ func NewParallelCmd() *cobra.Command {
 							} else {
 								_, index := spawn.GetServiceByResourceId(err.Id)
 								spawn.CreateLogger("worker", descriptions[index], index, params.Count)("warning", "failed to resume", err.Error.Error())
-								_ = spawn.ExecutionWorker().Destroy(context.Background(), err.Id, executionworkertypes.DestroyOptions{
+								_ = spawn.ExecutionWorker().Abort(context.Background(), err.Id, executionworkertypes.DestroyOptions{
 									Namespace: namespaces[index],
 								})
 							}

diff --git a/internal/app/api/v1/testworkflowexecutions.go b/internal/app/api/v1/testworkflowexecutions.go
@@ -249,7 +249,7 @@ func (s *TestkubeAPI) AbortTestWorkflowExecutionHandler() fiber.Handler {
 		}
 
 		// Abort the Test Workflow
-		err = s.ExecutionWorkerClient.Destroy(ctx, execution.Id, executionworkertypes.DestroyOptions{
+		err = s.ExecutionWorkerClient.Abort(ctx, execution.Id, executionworkertypes.DestroyOptions{
 			Namespace: execution.Namespace,
 		})
 		if err != nil {
@@ -353,7 +353,7 @@ func (s *TestkubeAPI) AbortAllTestWorkflowExecutionsHandler() fiber.Handler {
 		}
 
 		for _, execution := range executions {
-			err = s.ExecutionWorkerClient.Destroy(ctx, execution.Id, executionworkertypes.DestroyOptions{
+			err = s.ExecutionWorkerClient.Abort(ctx, execution.Id, executionworkertypes.DestroyOptions{
 				Namespace: execution.Namespace,
 			})
 			if err != nil {

diff --git a/pkg/testworkflows/executionworker/executionworkertypes/interface.go b/pkg/testworkflows/executionworker/executionworkertypes/interface.go
@@ -219,6 +219,9 @@ type Worker interface {
 	// List lists all the currently deployed resources matching the criteria.
 	List(ctx context.Context, options ListOptions) ([]ListResultItem, error)
 
+	// Abort may either destroy or just stop the selected resource (so the data can be still accessible)
+	Abort(ctx context.Context, id string, options DestroyOptions) error
+
 	// Destroy gets rid of all the data for the selected resource.
 	Destroy(ctx context.Context, id string, options DestroyOptions) error
 

diff --git a/pkg/testworkflows/executionworker/executionworkertypes/mock_worker.go b/pkg/testworkflows/executionworker/executionworkertypes/mock_worker.go
diff --git a/pkg/testworkflows/executionworker/kubernetesworker/worker.go b/pkg/testworkflows/executionworker/kubernetesworker/worker.go
@@ -426,6 +426,11 @@ func (w *worker) List(ctx context.Context, options executionworkertypes.ListOpti
 	return list, nil
 }
 
+func (w *worker) Abort(ctx context.Context, id string, options executionworkertypes.DestroyOptions) error {
+	// It may safely destroy all the resources - the trace should be still readable.
+	return w.Destroy(ctx, id, options)
+}
+
 func (w *worker) Destroy(ctx context.Context, id string, options executionworkertypes.DestroyOptions) (err error) {
 	if options.Namespace == "" {
 		options.Namespace, err = w.registry.GetNamespace(ctx, id)

diff --git a/pkg/triggers/scraper.go b/pkg/triggers/scraper.go
@@ -180,7 +180,7 @@ func (s *Service) abortRunningTestWorkflowExecutions(ctx context.Context, status
 		if execution.Result != nil && (execution.Result.IsRunning() || execution.Result.IsQueued() || execution.Result.IsPaused()) {
 			// Pro edition only (tcl protected code)
 			// Obtain the controller
-			err = s.executionWorkerClient.Destroy(ctx, execution.Id, executionworkertypes.DestroyOptions{
+			err = s.executionWorkerClient.Abort(ctx, execution.Id, executionworkertypes.DestroyOptions{
 				Namespace: s.testkubeNamespace,
 			})
 			if err != nil {