fix: fast namespace deletion (#2617)

* fix: fast namespace deletion

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* fix tests

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

---------

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

Author: eddycharly

pkg/cleanup/cleaner/cleaner.go

@@ -25,19 +25,21 @@ type Cleaner interface {
 	Run(ctx context.Context, stepReport *model.StepReport) []error
 }
 
-func New(timeout time.Duration, delay *time.Duration, propagation metav1.DeletionPropagation) Cleaner {
+func New(timeout time.Duration, waitForDeletion bool, delay *time.Duration, propagation metav1.DeletionPropagation) Cleaner {
 	return &cleaner{
-		delay:       delay,
-		timeout:     timeout,
-		propagation: propagation,
+		delay:           delay,
+		timeout:         timeout,
+		propagation:     propagation,
+		waitForDeletion: waitForDeletion,
 	}
 }
 
 type cleaner struct {
-	delay       *time.Duration
-	timeout     time.Duration
-	propagation metav1.DeletionPropagation
-	entries     []cleanupEntry
+	delay           *time.Duration
+	timeout         time.Duration
+	propagation     metav1.DeletionPropagation
+	waitForDeletion bool
+	entries         []cleanupEntry
 }
 
 func (c *cleaner) Add(client client.Client, object client.Object) {
@@ -82,8 +84,10 @@ func (c *cleaner) delete(ctx context.Context, entry cleanupEntry) error {
 		if !kerrors.IsNotFound(err) {
 			return err
 		}
-	} else if err := client.WaitForDeletion(ctx, entry.client, entry.object); err != nil {
-		return err
+	} else if c.waitForDeletion {
+		if err := client.WaitForDeletion(ctx, entry.client, entry.object); err != nil {
+			return err
+		}
 	}
 	return nil
 }

pkg/cleanup/cleaner/cleaner_test.go

@@ -19,32 +19,46 @@ import (
 
 func TestNew(t *testing.T) {
 	tests := []struct {
-		name    string
-		timeout time.Duration
-		delay   *time.Duration
-		want    Cleaner
+		name            string
+		timeout         time.Duration
+		delay           *time.Duration
+		waitForDeletion bool
+		want            Cleaner
 	}{{
-		name:    "with timeout",
-		timeout: time.Minute,
-		delay:   nil,
+		name:            "with timeout",
+		timeout:         time.Minute,
+		delay:           nil,
+		waitForDeletion: false,
 		want: &cleaner{
 			timeout:     time.Minute,
 			delay:       nil,
 			propagation: metav1.DeletePropagationBackground,
 		},
 	}, {
-		name:    "with delay",
-		timeout: time.Minute,
-		delay:   ptr.To(10 * time.Second),
+		name:            "with delay",
+		timeout:         time.Minute,
+		delay:           ptr.To(10 * time.Second),
+		waitForDeletion: false,
 		want: &cleaner{
 			timeout:     time.Minute,
 			delay:       ptr.To(10 * time.Second),
 			propagation: metav1.DeletePropagationBackground,
 		},
+	}, {
+		name:            "with waitForDeletion",
+		timeout:         time.Minute,
+		delay:           nil,
+		waitForDeletion: true,
+		want: &cleaner{
+			timeout:         time.Minute,
+			delay:           nil,
+			propagation:     metav1.DeletePropagationBackground,
+			waitForDeletion: true,
+		},
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got := New(tt.timeout, tt.delay, metav1.DeletePropagationBackground)
+			got := New(tt.timeout, tt.waitForDeletion, tt.delay, metav1.DeletePropagationBackground)
 			assert.Equal(t, tt.want, got)
 		})
 	}
@@ -193,9 +207,10 @@ func Test_cleaner_Run(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			c := &cleaner{
-				delay:   ptr.To(time.Second),
-				timeout: 1 * time.Second,
-				entries: tt.entries,
+				delay:           ptr.To(time.Second),
+				timeout:         1 * time.Second,
+				entries:         tt.entries,
+				waitForDeletion: true,
 			}
 			got := c.Run(context.TODO(), &model.StepReport{})
 			assert.Equal(t, tt.want, got)

pkg/runner/runner.go

@@ -3,6 +3,7 @@ package runner
 import (
 	"context"
 	"fmt"
+	"sync"
 	"testing"
 	"time"
 
@@ -72,10 +73,15 @@ func (r *runner) run(ctx context.Context, m mainstart, nsOptions v1alpha2.Namesp
 			ctx = logging.WithSink(ctx, newSink(r.clock, tc.Quiet(), t.Log))
 			// setup logger
 			ctx = logging.WithLogger(ctx, logging.NewLogger(t.Name(), "", "@chainsaw"))
+			wg := sync.WaitGroup{}
+			t.Cleanup(func() {
+				wg.Wait()
+			})
 			// setup cleanup
-			cleanup := cleaner.New(tc.Timeouts().Cleanup, nil, tc.DeletionPropagation())
+			cleanup := cleaner.New(tc.Timeouts().Cleanup, false, nil, tc.DeletionPropagation())
 			t.Cleanup(func() {
 				fail(t, r.cleanup(ctx, tc, cleanup))
+				logging.Log(ctx, logging.Internal, logging.LogStatus, nil, color.BoldRed)
 			})
 			// setup namespace
 			tc, err := r.setupNamespace(ctx, nsOptions, tc, cleanup)
@@ -103,6 +109,8 @@ func (r *runner) run(ctx context.Context, m mainstart, nsOptions v1alpha2.Namesp
 					// helper to run test
 					runTest := func(ctx context.Context, t *testing.T, testId int, scenarioId int, scenarioName string, tc enginecontext.TestContext, bindings ...v1alpha1.Binding) {
 						t.Helper()
+						wg.Add(1)
+						defer wg.Done()
 						// setup logger sink
 						ctx = logging.WithSink(ctx, newSink(r.clock, tc.Quiet(), t.Log))
 						// setup concurrency
@@ -147,7 +155,7 @@ func (r *runner) run(ctx context.Context, m mainstart, nsOptions v1alpha2.Namesp
 							return
 						}
 						// setup cleaner
-						cleanup := cleaner.New(tc.Timeouts().Cleanup, nil, tc.DeletionPropagation())
+						cleanup := cleaner.New(tc.Timeouts().Cleanup, false, nil, tc.DeletionPropagation())
 						t.Cleanup(func() {
 							fail(t, r.testCleanup(ctx, tc, cleanup, report))
 						})
@@ -267,7 +275,7 @@ func (r *runner) runStep(
 		r.onFail()
 		return true
 	}
-	cleaner := cleaner.New(tc.Timeouts().Cleanup, tc.DelayBeforeCleanup(), tc.DeletionPropagation())
+	cleaner := cleaner.New(tc.Timeouts().Cleanup, true, tc.DelayBeforeCleanup(), tc.DeletionPropagation())
 	cleanup(func() {
 		if !cleaner.Empty() || len(step.Cleanup) != 0 {
 			report := &model.StepReport{