feat: add test cleanup to report (#1975) (#1976)

Signed-off-by: Charles-Edouard Brétéché <[email protected]>
Co-authored-by: Charles-Edouard Brétéché <[email protected]>

Author: gcp-cherry-pick-bot[bot]

pkg/cleanup/cleaner/cleaner.go

@@ -5,6 +5,7 @@ import (
 	"time"
 
 	"github.com/kyverno/chainsaw/pkg/client"
+	"github.com/kyverno/chainsaw/pkg/model"
 	kerrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -21,7 +22,7 @@ type CleanerCollector interface {
 
 type Cleaner interface {
 	CleanerCollector
-	Run(ctx context.Context) []error
+	Run(ctx context.Context, stepReport *model.StepReport) []error
 }
 
 func New(timeout time.Duration, delay *time.Duration, propagation metav1.DeletionPropagation) Cleaner {
@@ -50,14 +51,22 @@ func (c *cleaner) Empty() bool {
 	return len(c.entries) == 0
 }
 
-func (c *cleaner) Run(ctx context.Context) []error {
+func (c *cleaner) Run(ctx context.Context, stepReport *model.StepReport) []error {
 	if c.delay != nil {
 		time.Sleep(*c.delay)
 	}
 	var errs []error
 	for i := len(c.entries) - 1; i >= 0; i-- {
-		if err := c.delete(ctx, c.entries[i]); err != nil {
-			errs = append(errs, err)
+		report := model.OperationReport{
+			Type:      model.OperationTypeDelete,
+			StartTime: time.Now(),
+		}
+		if report.Err = c.delete(ctx, c.entries[i]); report.Err != nil {
+			errs = append(errs, report.Err)
+		}
+		report.EndTime = time.Now()
+		if stepReport != nil {
+			stepReport.Add(&report)
 		}
 	}
 	return errs

pkg/cleanup/cleaner/cleaner_test.go

@@ -196,7 +196,7 @@ func Test_cleaner_Run(t *testing.T) {
 				timeout: 1 * time.Second,
 				entries: tt.entries,
 			}
-			got := c.Run(context.TODO())
+			got := c.Run(context.TODO(), nil)
 			assert.Equal(t, tt.want, got)
 		})
 	}

pkg/runner/processors/step.go

@@ -32,7 +32,6 @@ import (
 	"github.com/kyverno/chainsaw/pkg/runner/timeout"
 	"github.com/kyverno/chainsaw/pkg/testing"
 	"github.com/kyverno/pkg/ext/output/color"
-	"go.uber.org/multierr"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 )
@@ -118,7 +117,7 @@ func (p *stepProcessor) Run(ctx context.Context, namespacer namespacer.Namespace
 	t.Cleanup(func() {
 		if !cleaner.Empty() || len(p.step.Cleanup) != 0 {
 			report := &model.StepReport{
-				Name:      fmt.Sprintf("clenaup (%s)", report.Name),
+				Name:      fmt.Sprintf("cleanup (%s)", report.Name),
 				StartTime: time.Now(),
 			}
 			defer func() {
@@ -130,20 +129,12 @@ func (p *stepProcessor) Run(ctx context.Context, namespacer namespacer.Namespace
 				logger.Log(logging.Cleanup, logging.EndStatus, color.BoldFgCyan)
 			}()
 			if !cleaner.Empty() {
-				cleanupReport := &model.OperationReport{
-					Name:      "cleanup",
-					Type:      model.OperationTypeDelete,
-					StartTime: time.Now(),
-				}
-				if errs := cleaner.Run(ctx); len(errs) != 0 {
+				if errs := cleaner.Run(ctx, report); len(errs) != 0 {
 					for _, err := range errs {
 						logging.Log(ctx, logging.Cleanup, logging.ErrorStatus, color.BoldRed, logging.ErrSection(err))
 					}
 					failer.Fail(ctx)
-					cleanupReport.Err = multierr.Combine(errs...)
 				}
-				cleanupReport.EndTime = time.Now()
-				report.Add(cleanupReport)
 			}
 			for i, operation := range p.step.Cleanup {
 				operations, err := p.finallyOperation(i, namespacer, tc.Bindings(), operation)

pkg/runner/processors/test.go

@@ -96,6 +96,10 @@ func (p *testProcessor) Run(ctx context.Context, nspacer namespacer.Namespacer,
 		Concurrent: p.test.Test.Spec.Concurrent,
 		StartTime:  time.Now(),
 	}
+	stepReport := &model.StepReport{
+		Name:      "main",
+		StartTime: time.Now(),
+	}
 	t.Cleanup(func() {
 		report.EndTime = time.Now()
 		if t.Skipped() {
@@ -110,7 +114,15 @@ func (p *testProcessor) Run(ctx context.Context, nspacer namespacer.Namespacer,
 			defer func() {
 				logging.Log(ctx, logging.Cleanup, logging.EndStatus, color.BoldFgCyan)
 			}()
-			for _, err := range mainCleaner.Run(ctx) {
+			stepReport := &model.StepReport{
+				Name:      fmt.Sprintf("cleanup (%s)", stepReport.Name),
+				StartTime: time.Now(),
+			}
+			defer func() {
+				stepReport.EndTime = time.Now()
+				report.Add(stepReport)
+			}()
+			for _, err := range mainCleaner.Run(ctx, stepReport) {
 				logging.Log(ctx, logging.Cleanup, logging.ErrorStatus, color.BoldRed, logging.ErrSection(err))
 				failer.Fail(ctx)
 			}

pkg/runner/processors/tests.go

@@ -44,7 +44,7 @@ func (p *testsProcessor) Run(ctx context.Context, tc engine.Context, tests ...di
 			defer func() {
 				logging.Log(ctx, logging.Cleanup, logging.EndStatus, color.BoldFgCyan)
 			}()
-			for _, err := range mainCleaner.Run(ctx) {
+			for _, err := range mainCleaner.Run(ctx, nil) {
 				logging.Log(ctx, logging.Cleanup, logging.ErrorStatus, color.BoldRed, logging.ErrSection(err))
 				failer.Fail(ctx)
 			}