test: Add helper function to wait for misc. resources to be present

test/e2e/resource_helpers.go

@@ -0,0 +1,61 @@
+//go:build e2e
+
+// Copyright 2024 Nutanix. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package e2e
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	. "github.com/onsi/gomega"
+	capie2e "sigs.k8s.io/cluster-api/test/e2e"
+	"sigs.k8s.io/cluster-api/test/framework"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+// WaitForResourcesInput is the input for WaitForResources.
+type WaitForResourcesInput struct {
+	Getter    framework.Getter
+	Resources []client.Object
+}
+
+// WaitForResources waits until the resources are present.
+func WaitForResources(
+	ctx context.Context,
+	input WaitForResourcesInput,
+	intervals ...interface{},
+) {
+	start := time.Now()
+
+	for i := range input.Resources {
+		obj := input.Resources[i].DeepCopyObject().(client.Object)
+		key := client.ObjectKeyFromObject(obj)
+		capie2e.Byf("waiting for resource %s %s to be present",
+			obj.GetObjectKind().GroupVersionKind(),
+			key,
+		)
+		Logf("starting to wait for resource %s %s to become present",
+			obj.GetObjectKind().GroupVersionKind(),
+			key,
+		)
+		Eventually(func() bool {
+			if err := input.Getter.Get(ctx, key, obj); err != nil {
+				return false
+			}
+			return true
+		}, intervals...).Should(BeTrue(),
+			fmt.Sprintf("Resource %s %s was not found",
+				obj.GetObjectKind().GroupVersionKind(),
+				key,
+			),
+		)
+		Logf("Resource %s is now available, took %v",
+			obj.GetObjectKind().GroupVersionKind(),
+			key,
+			time.Since(start),
+		)
+	}
+}