Merge pull request kubernetes#121888 from SD-13/e2e-gomega-be-true-or-false

Enhance boolean assertions when fail

Author: k8s-ci-robot

hack/verify-golangci-lint.sh

@@ -26,7 +26,7 @@ Usage: $0 [-r <revision>|-a] [-s] [-c none|<config>] [-- <golangci-lint run flag
    -a: automatically select the common base of origin/master and HEAD
        as revision
    -s: select a strict configuration for new code
-   -n: in addition to strict checking, also enable hints (aka nits) that may are may not
+   -n: in addition to strict checking, also enable hints (aka nits) that may or may not
        be useful
    -g <github action file>: also write results with --out-format=github-actions
        to a separate file

test/e2e/apimachinery/discovery.go

@@ -308,7 +308,7 @@ var _ = SIGDescribe("Discovery", func() {
 					break
 				}
 			}
-			gomega.Expect(foundResource).To(gomega.BeTrue(), "Resource %q was not found inside of resourceList\n%#v", t.validResource, resourceList.APIResources)
+			gomega.Expect(foundResource).To(gomega.BeTrueBecause("Resource %q was not found inside of resourceList\n%#v", t.validResource, resourceList.APIResources))
 		}
 	})
 })

test/e2e/apimachinery/protocol.go

@@ -72,7 +72,7 @@ var _ = SIGDescribe("client-go should negotiate", func() {
 			defer w.Stop()
 
 			evt, ok := <-w.ResultChan()
-			o.Expect(ok).To(o.BeTrue())
+			o.Expect(ok).To(o.BeTrueBecause("unexpected watch event: %v, %#v", evt.Type, evt.Object))
 			switch evt.Type {
 			case watch.Added, watch.Modified:
 				// this is allowed

test/e2e/apimachinery/webhook.go

@@ -825,7 +825,7 @@ var _ = SIGDescribe("AdmissionWebhook [Privileged:ClusterAdmin]", func() {
 		_, err := createValidatingWebhookConfiguration(ctx, f, validatingWebhookConfiguration)
 		gomega.Expect(err).To(gomega.HaveOccurred(), "create validatingwebhookconfiguration should have been denied by the api-server")
 		expectedErrMsg := "compilation failed"
-		gomega.Expect(strings.Contains(err.Error(), expectedErrMsg)).To(gomega.BeTrue())
+		gomega.Expect(err).To(gomega.MatchError(gomega.ContainSubstring(expectedErrMsg)))
 	})
 
 	/*
@@ -849,7 +849,7 @@ var _ = SIGDescribe("AdmissionWebhook [Privileged:ClusterAdmin]", func() {
 		_, err := createMutatingWebhookConfiguration(ctx, f, mutatingWebhookConfiguration)
 		gomega.Expect(err).To(gomega.HaveOccurred(), "create mutatingwebhookconfiguration should have been denied by the api-server")
 		expectedErrMsg := "compilation failed"
-		gomega.Expect(strings.Contains(err.Error(), expectedErrMsg)).To(gomega.BeTrue())
+		gomega.Expect(err).To(gomega.MatchError(gomega.ContainSubstring(expectedErrMsg)))
 	})
 
 	/*
@@ -908,7 +908,7 @@ var _ = SIGDescribe("AdmissionWebhook [Privileged:ClusterAdmin]", func() {
 			"mutation-start":   "yes",
 			"mutation-stage-1": "yes",
 		}
-		gomega.Expect(reflect.DeepEqual(expectedConfigMapData, mutatedCM.Data)).To(gomega.BeTrue())
+		gomega.Expect(mutatedCM.Data).Should(gomega.Equal(expectedConfigMapData))
 
 		ginkgo.By("create the configmap with 'skip-me' name")
 
@@ -918,7 +918,7 @@ var _ = SIGDescribe("AdmissionWebhook [Privileged:ClusterAdmin]", func() {
 		expectedConfigMapData = map[string]string{
 			"mutation-start": "yes",
 		}
-		gomega.Expect(reflect.DeepEqual(expectedConfigMapData, skippedCM.Data)).To(gomega.BeTrue())
+		gomega.Expect(skippedCM.Data).Should(gomega.Equal(expectedConfigMapData))
 	})
 })
 

test/e2e/apps/disruption.go

@@ -209,8 +209,8 @@ var _ = SIGDescribe("DisruptionController", func() {
 					return false, err
 				}
 				return isPDBErroring(pdb), nil
-			}, 1*time.Minute, 1*time.Second).ShouldNot(gomega.BeTrue(), "pod shouldn't error for "+
-				"unmanaged pod")
+			}, 1*time.Minute, 1*time.Second).ShouldNot(gomega.BeTrueBecause("pod shouldn't error for " +
+				"unmanaged pod"))
 		})
 
 	evictionCases := []struct {

test/e2e/common/node/container_probe.go

@@ -113,7 +113,7 @@ var _ = SIGDescribe("Probing container", func() {
 				return false, err
 			}
 			return podutil.IsPodReady(p), nil
-		}, 1*time.Minute, 1*time.Second).ShouldNot(gomega.BeTrue(), "pod should not be ready")
+		}, 1*time.Minute, 1*time.Second).ShouldNot(gomega.BeTrueBecause("pod should not be ready"))
 
 		p, err := podClient.Get(ctx, p.Name, metav1.GetOptions{})
 		framework.ExpectNoError(err)
@@ -726,7 +726,7 @@ done
 				}
 			}
 			return false, nil
-		}, 1*time.Minute, framework.Poll).ShouldNot(gomega.BeTrue(), "should not see liveness probes")
+		}, 1*time.Minute, framework.Poll).ShouldNot(gomega.BeTrueBecause("should not see liveness probes"))
 	})
 })
 
@@ -792,7 +792,7 @@ var _ = SIGDescribe(nodefeature.SidecarContainers, feature.SidecarContainers, "P
 				return false, err
 			}
 			return podutil.IsPodReady(p), nil
-		}, 1*time.Minute, 1*time.Second).ShouldNot(gomega.BeTrue(), "pod should not be ready")
+		}, 1*time.Minute, 1*time.Second).ShouldNot(gomega.BeTrueBecause("pod should not be ready"))
 
 		p, err := podClient.Get(ctx, p.Name, metav1.GetOptions{})
 		framework.ExpectNoError(err)
@@ -1484,7 +1484,7 @@ done
 				}
 			}
 			return false, nil
-		}, 1*time.Minute, framework.Poll).ShouldNot(gomega.BeTrue(), "should not see liveness probes")
+		}, 1*time.Minute, framework.Poll).ShouldNot(gomega.BeTrueBecause("should not see liveness probes"))
 	})
 })
 

test/e2e/framework/log_test.go

@@ -50,15 +50,15 @@ var _ = ginkgo.Describe("log", func() {
 	})
 	ginkgo.AfterEach(func() {
 		framework.Logf("after")
-		gomega.Expect(true).To(gomega.BeFalse(), "true is never false either")
+		gomega.Expect(true).To(gomega.BeFalseBecause("artificial assertion failure"))
 	})
 	ginkgo.It("fails", func() {
 		func() {
 			framework.Failf("I'm failing.")
 		}()
 	})
 	ginkgo.It("asserts", func() {
-		gomega.Expect(false).To(gomega.BeTrue(), "false is never true")
+		gomega.Expect(false).To(gomega.BeTrueBecause("artificial assertion failure"))
 	})
 	ginkgo.It("error", func() {
 		err := errors.New("an error with a long, useless description")
@@ -106,10 +106,7 @@ In [It] at: log_test.go:57 <time>
 < Exit [It] fails - log_test.go:55 <time>
 > Enter [AfterEach] log - log_test.go:51 <time>
 <klog> log_test.go:52] after
-[FAILED] true is never false either
-Expected
-    <bool>: true
-to be false
+[FAILED] artificial assertion failure
 In [AfterEach] at: log_test.go:53 <time>
 < Exit [AfterEach] log - log_test.go:51 <time>
 `,
@@ -119,10 +116,7 @@ In [AfterEach] at: log_test.go:53 <time>
 					Status: "failed",
 					Failure: &reporters.JUnitFailure{
 						Type: "failed",
-						Description: `[FAILED] false is never true
-Expected
-    <bool>: false
-to be true
+						Description: `[FAILED] artificial assertion failure
 In [It] at: log_test.go:61 <time>
 
 There were additional failures detected after the initial failure. These are visible in the timeline
@@ -132,18 +126,12 @@ There were additional failures detected after the initial failure. These are vis
 <klog> log_test.go:49] before
 < Exit [BeforeEach] log - log_test.go:48 <time>
 > Enter [It] asserts - log_test.go:60 <time>
-[FAILED] false is never true
-Expected
-    <bool>: false
-to be true
+[FAILED] artificial assertion failure
 In [It] at: log_test.go:61 <time>
 < Exit [It] asserts - log_test.go:60 <time>
 > Enter [AfterEach] log - log_test.go:51 <time>
 <klog> log_test.go:52] after
-[FAILED] true is never false either
-Expected
-    <bool>: true
-to be false
+[FAILED] artificial assertion failure
 In [AfterEach] at: log_test.go:53 <time>
 < Exit [AfterEach] log - log_test.go:51 <time>
 `,
@@ -174,10 +162,7 @@ In [It] at: log_test.go:65 <time>
 < Exit [It] error - log_test.go:63 <time>
 > Enter [AfterEach] log - log_test.go:51 <time>
 <klog> log_test.go:52] after
-[FAILED] true is never false either
-Expected
-    <bool>: true
-to be false
+[FAILED] artificial assertion failure
 In [AfterEach] at: log_test.go:53 <time>
 < Exit [AfterEach] log - log_test.go:51 <time>
 `,
@@ -210,10 +195,7 @@ In [It] at: log_test.go:68 <time>
 < Exit [It] equal - log_test.go:67 <time>
 > Enter [AfterEach] log - log_test.go:51 <time>
 <klog> log_test.go:52] after
-[FAILED] true is never false either
-Expected
-    <bool>: true
-to be false
+[FAILED] artificial assertion failure
 In [AfterEach] at: log_test.go:53 <time>
 < Exit [AfterEach] log - log_test.go:51 <time>
 `,
@@ -238,10 +220,7 @@ In [It] at: log_test.go:44 <time>
 < Exit [It] fails with helper - log_test.go:70 <time>
 > Enter [AfterEach] log - log_test.go:51 <time>
 <klog> log_test.go:52] after
-[FAILED] true is never false either
-Expected
-    <bool>: true
-to be false
+[FAILED] artificial assertion failure
 In [AfterEach] at: log_test.go:53 <time>
 < Exit [AfterEach] log - log_test.go:51 <time>
 `,
@@ -251,10 +230,7 @@ In [AfterEach] at: log_test.go:53 <time>
 					Status: "failed",
 					Failure: &reporters.JUnitFailure{
 						Type: "failed",
-						Description: `[FAILED] true is never false either
-Expected
-    <bool>: true
-to be false
+						Description: `[FAILED] artificial assertion failure
 In [AfterEach] at: log_test.go:53 <time>
 `,
 					},
@@ -267,10 +243,7 @@ In [AfterEach] at: log_test.go:53 <time>
 < Exit [It] redirects klog - log_test.go:73 <time>
 > Enter [AfterEach] log - log_test.go:51 <time>
 <klog> log_test.go:52] after
-[FAILED] true is never false either
-Expected
-    <bool>: true
-to be false
+[FAILED] artificial assertion failure
 In [AfterEach] at: log_test.go:53 <time>
 < Exit [AfterEach] log - log_test.go:51 <time>
 `,

test/e2e/framework/pod/pod_client.go

@@ -266,7 +266,7 @@ func (c *PodClient) mungeSpec(pod *v1.Pod) {
 		}
 		// If the image policy is not PullAlways, the image must be in the pre-pull list and
 		// pre-pulled.
-		gomega.Expect(ImagePrePullList.Has(c.Image)).To(gomega.BeTrue(), "Image %q is not in the pre-pull list, consider adding it to PrePulledImages in test/e2e/common/util.go or NodePrePullImageList in test/e2e_node/image_list.go", c.Image)
+		gomega.Expect(ImagePrePullList.Has(c.Image)).To(gomega.BeTrueBecause("Image %q is not in the pre-pull list, consider adding it to PrePulledImages in test/e2e/common/util.go or NodePrePullImageList in test/e2e_node/image_list.go", c.Image))
 		// Do not pull images during the tests because the images in pre-pull list should have
 		// been prepulled.
 		c.ImagePullPolicy = v1.PullNever

test/e2e/storage/testsuites/volume_expand.go

@@ -178,7 +178,7 @@ func (v *volumeExpandTestSuite) DefineTests(driver storageframework.TestDriver,
 
 			gomega.Expect(l.resource.Sc.AllowVolumeExpansion).NotTo(gomega.BeNil())
 			allowVolumeExpansion := *l.resource.Sc.AllowVolumeExpansion
-			gomega.Expect(allowVolumeExpansion).To(gomega.BeFalse())
+			gomega.Expect(allowVolumeExpansion).To(gomega.BeFalseBecause("expected AllowVolumeExpansion value to be false"))
 			ginkgo.By("Expanding non-expandable pvc")
 			currentPvcSize := l.resource.Pvc.Spec.Resources.Requests[v1.ResourceStorage]
 			newSize := currentPvcSize.DeepCopy()

test/e2e/windows/density.go

@@ -116,7 +116,7 @@ func runDensityBatchTest(ctx context.Context, f *framework.Framework, testArg de
 
 	gomega.Eventually(ctx, func() bool {
 		return len(watchTimes) == testArg.podsNr
-	}, 10*time.Minute, 10*time.Second).Should(gomega.BeTrue())
+	}, 10*time.Minute, 10*time.Second).Should(gomega.BeTrueBecause("All pods should be observed by the watch."))
 
 	if len(watchTimes) < testArg.podsNr {
 		framework.Failf("Timeout reached waiting for all Pods to be observed by the watch.")