Replace WithOffset() with GinkgoHelper()

Signed-off-by: Dale Haiducek <19750917+dhaiducek@users.noreply.github.com>

Author: dhaiducek

test/e2e/case20_compliance_api_controller_test.go

@@ -37,12 +37,14 @@ var _ = Describe("Test governance-policy-database secret changes and DB annotati
 	nsName := fmt.Sprintf("case20-%d", seededRand.Int31())
 
 	createCase20Policy := func(ctx context.Context) {
+		GinkgoHelper()
+
 		By("Creating " + case20PolicyName)
 		utils.Kubectl("apply", "-f", case20PolicyYAML, "-n", nsName, "--kubeconfig="+kubeconfigHub)
 		plc := utils.GetWithTimeout(
 			clientHubDynamic, gvrPolicy, case20PolicyName, nsName, true, defaultTimeoutSeconds,
 		)
-		ExpectWithOffset(1, plc).NotTo(BeNil())
+		Expect(plc).NotTo(BeNil())
 
 		By("Patching the placement with decision of cluster local-cluster")
 		pld := utils.GetWithTimeout(
@@ -57,13 +59,13 @@ var _ = Describe("Test governance-policy-database secret changes and DB annotati
 		_, err := clientHubDynamic.Resource(gvrPlacementDecision).Namespace(nsName).UpdateStatus(
 			ctx, pld, metav1.UpdateOptions{},
 		)
-		ExpectWithOffset(1, err).ToNot(HaveOccurred())
+		Expect(err).ToNot(HaveOccurred())
 
 		By("Waiting for the replicated policy")
 		replicatedPolicy := utils.GetWithTimeout(
 			clientHubDynamic, gvrPolicy, case20PolicyName, nsName, true, defaultTimeoutSeconds,
 		)
-		ExpectWithOffset(1, replicatedPolicy).NotTo(BeNil())
+		Expect(replicatedPolicy).NotTo(BeNil())
 	}
 
 	BeforeAll(func(ctx context.Context) {
@@ -144,8 +146,10 @@ var _ = Describe("Test governance-policy-database secret changes and DB annotati
 })
 
 func bringDownDBConnection(ctx context.Context) {
+	GinkgoHelper()
+
 	By("Setting the port to 12345")
-	EventuallyWithOffset(1, func(g Gomega) {
+	Eventually(func(g Gomega) {
 		namespacedSecret := clientHub.CoreV1().Secrets("open-cluster-management")
 		secret, err := namespacedSecret.Get(
 			ctx, complianceeventsapi.DBSecretName, metav1.GetOptions{},
@@ -159,7 +163,7 @@ func bringDownDBConnection(ctx context.Context) {
 	}, defaultTimeoutSeconds, 1).Should(Succeed())
 
 	By("Waiting for the database connection to be down")
-	EventuallyWithOffset(1, func(g Gomega) {
+	Eventually(func(g Gomega) {
 		req, err := http.NewRequestWithContext(
 			ctx, http.MethodGet, fmt.Sprintf("https://localhost:%d/api/v1/compliance-events/1", complianceAPIPort), nil,
 		)
@@ -189,8 +193,10 @@ func bringDownDBConnection(ctx context.Context) {
 }
 
 func restoreDBConnection(ctx context.Context) {
+	GinkgoHelper()
+
 	By("Restoring the database connection")
-	EventuallyWithOffset(1, func(g Gomega) {
+	Eventually(func(g Gomega) {
 		namespacedSecret := clientHub.CoreV1().Secrets("open-cluster-management")
 		secret, err := namespacedSecret.Get(
 			ctx, complianceeventsapi.DBSecretName, metav1.GetOptions{},
@@ -208,7 +214,7 @@ func restoreDBConnection(ctx context.Context) {
 	}, defaultTimeoutSeconds, 1).Should(Succeed())
 
 	By("Waiting for the database connection to be up")
-	EventuallyWithOffset(1, func(g Gomega) {
+	Eventually(func(g Gomega) {
 		req, err := http.NewRequestWithContext(
 			ctx,
 			http.MethodGet,

test/e2e/case5_policy_automation_test.go

@@ -30,15 +30,17 @@ var _ = Describe("Test policy automation", Label("policyautomation"), Ordered, f
 	ansiblelistlen := 0
 	// Use this only when target_clusters managed1 managed2 managed3
 	getLastAnsiblejob := func() *unstructured.Unstructured {
+		GinkgoHelper()
+
 		ansiblejobList, err := clientHubDynamic.Resource(gvrAnsibleJob).Namespace(testNamespace).List(
 			context.TODO(), metav1.ListOptions{},
 		)
-		ExpectWithOffset(1, err).ToNot(HaveOccurred())
+		Expect(err).ToNot(HaveOccurred())
 		for _, ansiblejob := range ansiblejobList.Items {
 			targetClusters, _, err := unstructured.NestedSlice(ansiblejob.Object,
 				"spec", "extra_vars", "target_clusters")
 			if err != nil {
-				ExpectWithOffset(1, err).ToNot(HaveOccurred())
+				Expect(err).ToNot(HaveOccurred())
 			}
 			for _, clusterName := range targetClusters {
 				if clusterName == "managed3" {
@@ -50,10 +52,12 @@ var _ = Describe("Test policy automation", Label("policyautomation"), Ordered, f
 		return nil
 	}
 	getLastAnsiblejobByTime := func() *unstructured.Unstructured {
+		GinkgoHelper()
+
 		ansiblejobList, err := clientHubDynamic.Resource(gvrAnsibleJob).Namespace(testNamespace).List(
 			context.TODO(), metav1.ListOptions{},
 		)
-		ExpectWithOffset(1, err).ToNot(HaveOccurred())
+		Expect(err).ToNot(HaveOccurred())
 		sort.Slice(ansiblejobList.Items, func(i, j int) bool {
 			p1 := ansiblejobList.Items[i].GetCreationTimestamp()
 			p2 := ansiblejobList.Items[j].GetCreationTimestamp()

test/utils/utils.go

@@ -136,13 +136,15 @@ func GetClusterLevelWithTimeout(
 	wantFound bool,
 	timeout int,
 ) *unstructured.Unstructured {
+	GinkgoHelper()
+
 	if timeout < 1 {
 		timeout = 1
 	}
 
 	var obj *unstructured.Unstructured
 
-	EventuallyWithOffset(1, func() error {
+	Eventually(func() error {
 		var err error
 		namespace := clientHubDynamic.Resource(gvr)
 
@@ -178,13 +180,15 @@ func GetWithTimeout(
 	wantFound bool,
 	timeout int,
 ) *unstructured.Unstructured {
+	GinkgoHelper()
+
 	if timeout < 1 {
 		timeout = 1
 	}
 
 	var obj *unstructured.Unstructured
 
-	EventuallyWithOffset(1, func() error {
+	Eventually(func() error {
 		var err error
 		namespace := clientHubDynamic.Resource(gvr).Namespace(namespace)
 
@@ -221,13 +225,15 @@ func ListWithTimeout(
 	wantFound bool,
 	timeout int,
 ) *unstructured.UnstructuredList {
+	GinkgoHelper()
+
 	if timeout < 1 {
 		timeout = 1
 	}
 
 	var list *unstructured.UnstructuredList
 
-	EventuallyWithOffset(1, func() error {
+	Eventually(func() error {
 		var err error
 		list, err = clientHubDynamic.Resource(gvr).List(context.TODO(), opts)
 		if err != nil {
@@ -259,13 +265,15 @@ func ListWithTimeoutByNamespace(
 	wantFound bool,
 	timeout int,
 ) *unstructured.UnstructuredList {
+	GinkgoHelper()
+
 	if timeout < 1 {
 		timeout = 1
 	}
 
 	var list *unstructured.UnstructuredList
 
-	EventuallyWithOffset(1, func() error {
+	Eventually(func() error {
 		var err error
 		list, err = clientHubDynamic.Resource(gvr).Namespace(ns).List(context.TODO(), opts)
 		if err != nil {
@@ -364,9 +372,11 @@ func GetMetrics(metricPatterns ...string) []string {
 func GetMatchingEvents(
 	client kubernetes.Interface, namespace, objName, reasonRegex, msgRegex string, timeout int,
 ) []corev1.Event {
+	GinkgoHelper()
+
 	var eventList *corev1.EventList
 
-	EventuallyWithOffset(1, func() error {
+	Eventually(func() error {
 		var err error
 		eventList, err = client.CoreV1().Events(namespace).List(context.TODO(), metav1.ListOptions{})