Merge pull request #2966 from fabriziopandini/e2e-cluster-cleanup

🐛[e2e] add workaround for panic in high level helpers

Author: k8s-ci-robot

test/e2e/common.go

@@ -56,9 +56,12 @@ func dumpSpecResourcesAndCleanup(ctx context.Context, specName string, clusterPr
 
 	if !skipCleanup {
 		Byf("Deleting cluster %s/%s", cluster.Namespace, cluster.Name)
-		framework.DeleteClusterAndWait(ctx, framework.DeleteClusterAndWaitInput{
-			Client:  clusterProxy.GetClient(),
-			Cluster: cluster,
+		// While https://github.com/kubernetes-sigs/cluster-api/issues/2955 is addressed in future iterations, there is a chance
+		// that cluster variable is not set even if the cluster exists, so we are calling DeleteAllClustersAndWait
+		// instead of DeleteClusterAndWait
+		framework.DeleteAllClustersAndWait(ctx, framework.DeleteAllClustersAndWaitInput{
+			Client:    clusterProxy.GetClient(),
+			Namespace: namespace.Name,
 		}, intervalsGetter(specName, "wait-delete-cluster")...)
 
 		Byf("Deleting namespace used for hosting the %q test spec", specName)

test/framework/cluster_helpers.go

@@ -22,7 +22,6 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"sigs.k8s.io/cluster-api/test/framework/options"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -56,6 +55,24 @@ func CreateCluster(ctx context.Context, input CreateClusterInput, intervals ...i
 	}, intervals...).Should(Succeed())
 }
 
+// GetAllClustersByNamespaceInput is the input for GetAllClustersByNamespace.
+type GetAllClustersByNamespaceInput struct {
+	Lister    Lister
+	Namespace string
+}
+
+// GetClustersByNamespace returns the list of Cluster object in a namespace
+func GetAllClustersByNamespace(ctx context.Context, input GetAllClustersByNamespaceInput) []*clusterv1.Cluster {
+	clusterList := &clusterv1.ClusterList{}
+	Expect(input.Lister.List(ctx, clusterList, client.InNamespace(input.Namespace))).To(Succeed(), "Failed to list clusters in namespace %s", input.Namespace)
+
+	clusters := make([]*clusterv1.Cluster, len(clusterList.Items))
+	for i := range clusterList.Items {
+		clusters[i] = &clusterList.Items[i]
+	}
+	return clusters
+}
+
 // GetClusterByNameInput is the input for GetClusterByName.
 type GetClusterByNameInput struct {
 	Getter    Getter
@@ -194,6 +211,39 @@ func DeleteClusterAndWait(ctx context.Context, input DeleteClusterAndWaitInput,
 	Expect(resources).To(BeEmpty(), "There are still Cluster API resources in the %q namespace", input.Cluster.Namespace)
 }
 
+// DeleteAllClustersAndWaitInput is the input type for DeleteAllClustersAndWait.
+type DeleteAllClustersAndWaitInput struct {
+	Client    client.Client
+	Namespace string
+}
+
+// DeleteAllClustersAndWait deletes a cluster object and waits for it to be gone.
+func DeleteAllClustersAndWait(ctx context.Context, input DeleteAllClustersAndWaitInput, intervals ...interface{}) {
+	Expect(ctx).NotTo(BeNil(), "ctx is required for DeleteAllClustersAndWait")
+	Expect(input.Client).ToNot(BeNil(), "Invalid argument. input.Client can't be nil when calling DeleteAllClustersAndWait")
+	Expect(input.Namespace).ToNot(BeEmpty(), "Invalid argument. input.Namespace can't be empty when calling DeleteAllClustersAndWait")
+
+	clusters := GetAllClustersByNamespace(ctx, GetAllClustersByNamespaceInput{
+		Lister:    input.Client,
+		Namespace: input.Namespace,
+	})
+
+	for _, c := range clusters {
+		DeleteCluster(ctx, DeleteClusterInput{
+			Deleter: input.Client,
+			Cluster: c,
+		})
+	}
+
+	for _, c := range clusters {
+		fmt.Fprintf(GinkgoWriter, "Waiting for the Cluster %s/%s to be deleted\n", c.Namespace, c.Name)
+		WaitForClusterDeleted(ctx, WaitForClusterDeletedInput{
+			Getter:  input.Client,
+			Cluster: c,
+		}, intervals...)
+	}
+}
+
 // byClusterOptions returns a set of ListOptions that allows to identify all the objects belonging to a Cluster.
 func byClusterOptions(name, namespace string) []client.ListOption {
 	return []client.ListOption{