🌱 Add error messages for all e2e Ginkgo expects

Co-Authored-By: Fabrizio Pandini <[email protected]>

Author: Cecile Robert-Michon

test/e2e/cluster_upgrade_runtimesdk.go

@@ -475,12 +475,12 @@ func runtimeHookTestHandler(ctx context.Context, c client.Client, namespace, clu
 	configMap := &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: clusterName + "-hookresponses", Namespace: namespace}}
 	Eventually(func() error {
 		return c.Get(ctx, util.ObjectKey(configMap), configMap)
-	}).Should(Succeed())
+	}).Should(Succeed(), "Failed to get ConfigMap %s/%s", namespace, configMap.Name)
 	patch := client.RawPatch(types.MergePatchType,
 		[]byte(fmt.Sprintf(`{"data":{"%s-preloadedResponse":%s}}`, hookName, "\"{\\\"Status\\\": \\\"Success\\\"}\"")))
 	Eventually(func() error {
 		return c.Patch(ctx, configMap, patch)
-	}).Should(Succeed())
+	}).Should(Succeed(), "Failed to set %s response to Status:Success to unblock the reconciliation", hookName)
 
 	// Expect the Hook to pass, setting the blockingCondition to false before the timeout ends.
 	Eventually(func() bool {

test/e2e/clusterctl_upgrade.go

@@ -285,7 +285,7 @@ func ClusterctlUpgradeSpec(ctx context.Context, inputGetter func() ClusterctlUpg
 				}
 			}
 			return n, nil
-		}, input.E2EConfig.GetIntervals(specName, "wait-worker-nodes")...).Should(Equal(*controlPlaneMachineCount + *workerMachineCount))
+		}, input.E2EConfig.GetIntervals(specName, "wait-worker-nodes")...).Should(Equal(*controlPlaneMachineCount+*workerMachineCount), "Timed out waiting for all machines to be exist")
 
 		By("THE MANAGEMENT CLUSTER WITH OLDER VERSION OF PROVIDERS WORKS!")
 

test/e2e/self_hosted.go

@@ -122,7 +122,7 @@ func SelfHostedSpec(ctx context.Context, inputGetter func() SelfHostedSpecInput)
 				return nil
 			}
 			return errors.New("cluster object not yet reconciled")
-		}, "1m", "5s").Should(Succeed())
+		}, "1m", "5s").Should(Succeed(), "Failed to get the Cluster %s/%s", cluster.Namespace, cluster.Name)
 
 		if isDockerCluster {
 			Expect(bootstrap.LoadImagesToKindCluster(ctx, bootstrap.LoadImagesToKindClusterInput{

test/framework/alltypes_helpers.go

@@ -171,7 +171,7 @@ func CreateRelatedResources(ctx context.Context, input CreateRelatedResourcesInp
 		Byf("creating a/an %s resource", obj.GetObjectKind().GroupVersionKind())
 		Eventually(func() error {
 			return input.Creator.Create(ctx, obj)
-		}, intervals...).Should(Succeed())
+		}, intervals...).Should(Succeed(), "failed to create %s", obj.GetObjectKind().GroupVersionKind())
 	}
 }
 

test/framework/cluster_helpers.go

@@ -43,7 +43,7 @@ func CreateCluster(ctx context.Context, input CreateClusterInput, intervals ...i
 	By("creating an InfrastructureCluster resource")
 	Eventually(func() error {
 		return input.Creator.Create(ctx, input.InfraCluster)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to create InfrastructureCluster %s/%s", input.InfraCluster.GetNamespace(), input.InfraCluster.GetName())
 
 	// This call happens in an eventually because of a race condition with the
 	// webhook server. If the latter isn't fully online then this call will
@@ -55,7 +55,7 @@ func CreateCluster(ctx context.Context, input CreateClusterInput, intervals ...i
 			return err
 		}
 		return nil
-	}, intervals...).Should(Succeed())
+	}, intervals...).Should(Succeed(), "Failed to create Cluster %s/%s", input.Cluster.Namespace, input.Cluster.Name)
 }
 
 // GetAllClustersByNamespaceInput is the input for GetAllClustersByNamespace.
@@ -118,7 +118,7 @@ func PatchClusterLabel(ctx context.Context, input PatchClusterLabelInput) {
 	input.Cluster.SetLabels(input.Labels)
 	Eventually(func() error {
 		return patchHelper.Patch(ctx, input.Cluster)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to patch label to cluster %s/%s", input.Cluster.Namespace, input.Cluster.Name)
 }
 
 // WaitForClusterToProvisionInput is the input for WaitForClusterToProvision.
@@ -140,7 +140,7 @@ func WaitForClusterToProvision(ctx context.Context, input WaitForClusterToProvis
 			return "", err
 		}
 		return cluster.Status.Phase, nil
-	}, intervals...).Should(Equal(string(clusterv1.ClusterPhaseProvisioned)))
+	}, intervals...).Should(Equal(string(clusterv1.ClusterPhaseProvisioned)), "Timed out waiting for Cluster %s/%s to provision", input.Cluster.GetNamespace(), input.Cluster.GetName())
 	return cluster
 }
 

test/framework/cluster_topology_helpers.go

@@ -102,7 +102,7 @@ func UpgradeClusterTopologyAndWaitForUpgrade(ctx context.Context, input UpgradeC
 	}
 	Eventually(func() error {
 		return patchHelper.Patch(ctx, input.Cluster)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to patch Cluster topology %s/%s with version %s", input.Cluster.Namespace, input.Cluster.Name, input.KubernetesUpgradeVersion)
 
 	// Once we have patched the Kubernetes Cluster we can run PreWaitForControlPlaneToBeUpgraded.
 	// Note: This can e.g. be used to verify the BeforeClusterUpgrade lifecycle hook is executed

test/framework/control_plane.go

@@ -45,5 +45,5 @@ func WaitForControlPlaneToBeUpToDate(ctx context.Context, input WaitForControlPl
 			return 0, err
 		}
 		return controlplane.Status.UpdatedReplicas, nil
-	}, intervals...).Should(Equal(*input.ControlPlane.Spec.Replicas))
+	}, intervals...).Should(Equal(*input.ControlPlane.Spec.Replicas), "Timed waiting for all control plane replicas to be updated")
 }

test/framework/controlplane_helpers.go

@@ -49,7 +49,7 @@ func CreateKubeadmControlPlane(ctx context.Context, input CreateKubeadmControlPl
 	By("creating the machine template")
 	Eventually(func() error {
 		return input.Creator.Create(ctx, input.MachineTemplate)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to create MachineTemplate %s", input.MachineTemplate.GetName())
 
 	By("creating a KubeadmControlPlane")
 	Eventually(func() error {
@@ -58,7 +58,7 @@ func CreateKubeadmControlPlane(ctx context.Context, input CreateKubeadmControlPl
 			log.Logf("Failed to create the KubeadmControlPlane: %+v", err)
 		}
 		return err
-	}, intervals...).Should(Succeed())
+	}, intervals...).Should(Succeed(), "Failed to create the KubeadmControlPlane %s/%s", input.ControlPlane.Namespace, input.ControlPlane.Name)
 }
 
 // GetKubeadmControlPlaneByClusterInput is the input for GetKubeadmControlPlaneByCluster.
@@ -113,7 +113,7 @@ func WaitForKubeadmControlPlaneMachinesToExist(ctx context.Context, input WaitFo
 			}
 		}
 		return count, nil
-	}, intervals...).Should(Equal(int(*input.ControlPlane.Spec.Replicas)))
+	}, intervals...).Should(Equal(int(*input.ControlPlane.Spec.Replicas)), "Timed out waiting for %d control plane machines to exist", int(*input.ControlPlane.Spec.Replicas))
 }
 
 // WaitForOneKubeadmControlPlaneMachineToExistInput is the input for WaitForKubeadmControlPlaneMachinesToExist.
@@ -242,7 +242,7 @@ func DiscoveryAndWaitForControlPlaneInitialized(ctx context.Context, input Disco
 			Namespace:   input.Cluster.Namespace,
 		})
 		g.Expect(controlPlane).ToNot(BeNil())
-	}, "10s", "1s").Should(Succeed())
+	}, "10s", "1s").Should(Succeed(), "Couldn't get the control plane for the cluster %q", input.Cluster.Name)
 
 	log.Logf("Waiting for the first control plane machine managed by %s/%s to be provisioned", controlPlane.Namespace, controlPlane.Name)
 	WaitForOneKubeadmControlPlaneMachineToExist(ctx, WaitForOneKubeadmControlPlaneMachineToExistInput{
@@ -339,7 +339,7 @@ func UpgradeControlPlaneAndWaitForUpgrade(ctx context.Context, input UpgradeCont
 
 	Eventually(func() error {
 		return patchHelper.Patch(ctx, input.ControlPlane)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to patch the new kubernetes version to KCP %s/%s", input.ControlPlane.Namespace, input.ControlPlane.Name)
 
 	log.Logf("Waiting for control-plane machines to have the upgraded kubernetes version")
 	WaitForControlPlaneMachinesToBeUpgraded(ctx, WaitForControlPlaneMachinesToBeUpgradedInput{
@@ -401,7 +401,7 @@ func ScaleAndWaitControlPlane(ctx context.Context, input ScaleAndWaitControlPlan
 	log.Logf("Scaling controlplane %s/%s from %v to %v replicas", input.ControlPlane.Namespace, input.ControlPlane.Name, scaleBefore, input.Replicas)
 	Eventually(func() error {
 		return patchHelper.Patch(ctx, input.ControlPlane)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to scale controlplane %s/%s from %v to %v replicas", input.ControlPlane.Namespace, input.ControlPlane.Name, scaleBefore, input.Replicas)
 
 	log.Logf("Waiting for correct number of replicas to exist")
 	Eventually(func() (int, error) {
@@ -428,5 +428,5 @@ func ScaleAndWaitControlPlane(ctx context.Context, input ScaleAndWaitControlPlan
 			return -1, errors.New("Machine count does not match existing nodes count")
 		}
 		return nodeRefCount, nil
-	}, input.WaitForControlPlane...).Should(Equal(int(input.Replicas)))
+	}, input.WaitForControlPlane...).Should(Equal(int(input.Replicas)), "Timed out waiting for %d replicas to exist for control-plane %s/%s", int(input.Replicas), input.ControlPlane.Namespace, input.ControlPlane.Name)
 }

test/framework/deployment_helpers.go

@@ -33,7 +33,6 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/api/policy/v1beta1"
-	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
 	utilversion "k8s.io/apimachinery/pkg/util/version"
@@ -311,24 +310,8 @@ func DeployUnevictablePod(ctx context.Context, input DeployUnevictablePodInput)
 	Expect(input.DeploymentName).ToNot(BeNil(), "Need a deployment name in DeployUnevictablePod")
 	Expect(input.Namespace).ToNot(BeNil(), "Need a namespace in DeployUnevictablePod")
 	Expect(input.WorkloadClusterProxy).ToNot(BeNil(), "Need a workloadClusterProxy in DeployUnevictablePod")
-	workloadClient := input.WorkloadClusterProxy.GetClientSet()
 
-	log.Logf("Check if namespace %s exists", input.Namespace)
-	Eventually(func() error {
-		_, err := workloadClient.CoreV1().Namespaces().Get(ctx, input.Namespace, metav1.GetOptions{})
-		if err != nil {
-			if apierrors.IsNotFound(err) {
-				_, errCreateNamespace := workloadClient.CoreV1().Namespaces().Create(ctx, &corev1.Namespace{
-					ObjectMeta: metav1.ObjectMeta{
-						Name: input.Namespace,
-					},
-				}, metav1.CreateOptions{})
-				return errCreateNamespace
-			}
-			return err
-		}
-		return nil
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	EnsureNamespace(ctx, input.WorkloadClusterProxy.GetClient(), input.Namespace)
 
 	workloadDeployment := &appsv1.Deployment{
 		ObjectMeta: metav1.ObjectMeta{
@@ -366,13 +349,14 @@ func DeployUnevictablePod(ctx context.Context, input DeployUnevictablePodInput)
 			},
 		},
 	}
+	workloadClient := input.WorkloadClusterProxy.GetClientSet()
 	if input.ControlPlane != nil {
 		var serverVersion *version.Info
 		Eventually(func() error {
 			var err error
 			serverVersion, err = workloadClient.ServerVersion()
 			return err
-		}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+		}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "failed to get server version")
 
 		// Use the control-plane label for Kubernetes version >= v1.20.0.
 		if utilversion.MustParseGeneric(serverVersion.String()).AtLeast(utilversion.MustParseGeneric("v1.20.0")) {
@@ -445,7 +429,7 @@ func AddDeploymentToWorkloadCluster(ctx context.Context, input AddDeploymentToWo
 			return nil
 		}
 		return fmt.Errorf("deployment %s in namespace %s not successfully created in workload cluster: %v", input.Deployment.Name, input.Namespace, err)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to create deployment %s/%s in workload cluster", input.Namespace, input.Deployment.Name)
 }
 
 type AddPodDisruptionBudgetInput struct {

test/framework/machine_helpers.go

@@ -147,7 +147,7 @@ func WaitForControlPlaneMachinesToBeUpgraded(ctx context.Context, input WaitForC
 			return 0, errors.New("old nodes remain")
 		}
 		return upgraded, nil
-	}, intervals...).Should(Equal(input.MachineCount))
+	}, intervals...).Should(Equal(input.MachineCount), "Timed out waiting for all control-plane machines in Cluster %s/%s to be upgraded to kubernetes version %s", input.Cluster.Namespace, input.Cluster.Name, input.KubernetesUpgradeVersion)
 }
 
 // WaitForMachineDeploymentMachinesToBeUpgradedInput is the input for WaitForMachineDeploymentMachinesToBeUpgraded.
@@ -187,7 +187,7 @@ func WaitForMachineDeploymentMachinesToBeUpgraded(ctx context.Context, input Wai
 			return 0, errors.New("old nodes remain")
 		}
 		return upgraded, nil
-	}, intervals...).Should(Equal(input.MachineCount))
+	}, intervals...).Should(Equal(input.MachineCount), "Timed out waiting for all MachineDeployment %s/%s Machines to be upgraded to kubernetes version %s", input.MachineDeployment.Namespace, input.MachineDeployment.Name, input.KubernetesUpgradeVersion)
 }
 
 // PatchNodeConditionInput is the input for PatchNodeCondition.
@@ -211,13 +211,13 @@ func PatchNodeCondition(ctx context.Context, input PatchNodeConditionInput) {
 	node := &corev1.Node{}
 	Eventually(func() error {
 		return input.ClusterProxy.GetWorkloadCluster(ctx, input.Cluster.Namespace, input.Cluster.Name).GetClient().Get(ctx, types.NamespacedName{Name: input.Machine.Status.NodeRef.Name, Namespace: input.Machine.Status.NodeRef.Namespace}, node)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to get node %s", input.Machine.Status.NodeRef.Name)
 	patchHelper, err := patch.NewHelper(node, input.ClusterProxy.GetWorkloadCluster(ctx, input.Cluster.Namespace, input.Cluster.Name).GetClient())
 	Expect(err).ToNot(HaveOccurred())
 	node.Status.Conditions = append(node.Status.Conditions, input.NodeCondition)
 	Eventually(func() error {
 		return patchHelper.Patch(ctx, node)
-	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed())
+	}, retryableOperationTimeout, retryableOperationInterval).Should(Succeed(), "Failed to patch node %s", input.Machine.Status.NodeRef.Name)
 }
 
 // MachineStatusCheck is a type that operates a status check on a Machine.