e2e tests: use Should(Exit()) and ExitWithError()

e2e test failures are rife with messages like:

   Expected 1 to equal 0

These make me cry. They're anti-helpful, requiring the reader
to dive into the source code to figure out what those numbers
mean.

Solution: Go tests have a '.Should(Exit(NNN))' mechanism. I
don't know if it spits out a better diagnostic (I have no way
to run e2e tests on my laptop), but I have to fantasize that
it will, and given the state of our flakes I assume that at
least one test will fail and give me the opportunity to see
what the error message looks like.

THIS IS NOT REVIEWABLE CODE. There is no way for a human
to review it. Don't bother. Maybe look at a few random
ones for sanity. If you want to really review, here is
a reproducer of what I did:

   cd test/e2e
   ! positive assertions. The second is the same as the first,
   ! with the addition of (unnecessary) parentheses because
   ! some invocations were written that way. The third is BeZero().
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.To\(Equal\((\d+)\)\)/Expect($1).Should(Exit($2))/' *_test.go
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.To\(\(Equal\((\d+)\)\)\)/Expect($1).Should(Exit($2))/' *_test.go
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.To\(BeZero\(\)\)/Expect($1).Should(Exit(0))/' *_test.go

   ! Same as above, but handles three non-numeric exit codes
   ! in run_exit_test.go
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.To\(Equal\((\S+)\)\)/Expect($1).Should(Exit($2))/' *_test.go

   ! negative assertions. Difference is the spelling of 'To(Not)',
   ! 'ToNot', and 'NotTo'. I assume those are all the same.
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.To\(Not\(Equal\((0)\)\)\)/Expect($1).To(ExitWithError())/' *_test.go
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.ToNot\(Equal\((0)\)\)/Expect($1).To(ExitWithError())/' *_test.go
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.NotTo\(Equal\((0)\)\)/Expect($1).To(ExitWithError())/' *_test.go
   ! negative, old use of BeZero()
   perl -pi -e 's/Expect\((\S+)\.ExitCode\(\)\)\.ToNot\(BeZero\(\)\)/Expect($1).Should(ExitWithError())/' *_test.go

Run those on a clean copy of main branch (at the same branch
point as my PR, of course), then diff against a checked-out
copy of my PR. There should be no differences. Then all you
have to review is that my replacements above are sane.

UPDATE: nope, that's not enough, you also need to add gomega/gexec
to the files that don't have it:

   perl -pi -e '$_ .= "$1/gexec\"\n" if m!^(.*/onsi/gomega)"!' $(grep -L gomega/gexec $(git log -1 --stat | awk '$1 ~ /test\/e2e\// { print $1}'))

UPDATE 2: hand-edit run_volume_test.go

UPDATE 3: sigh, add WaitWithDefaultTimeout() to a couple of places

UPDATE 4: skip a test due to bug #10935 (race condition)

Signed-off-by: Ed Santiago <santiago@redhat.com>

1 files changed, 22 insertions, 21 deletions

diff --git a/test/e2e/save_test.go b/test/e2e/save_test.go
index 69184649f..0b3a88da3 100644
--- a/test/e2e/save_test.go
+++ b/test/e2e/save_test.go
@@ -12,6 +12,7 @@ import (
 	. "github.com/containers/podman/v3/test/utils"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	. "github.com/onsi/gomega/gexec"
 )
 
 var _ = Describe("Podman save", func() {
@@ -42,7 +43,7 @@ var _ = Describe("Podman save", func() {
 
 		save := podmanTest.Podman([]string{"save", "-o", outfile, ALPINE})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save oci flag", func() {
@@ -50,7 +51,7 @@ var _ = Describe("Podman save", func() {
 
 		save := podmanTest.Podman([]string{"save", "-o", outfile, "--format", "oci-archive", ALPINE})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save with stdout", func() {
@@ -59,7 +60,7 @@ var _ = Describe("Podman save", func() {
 
 		save := podmanTest.Podman([]string{"save", ALPINE, ">", outfile})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save quiet flag", func() {
@@ -67,7 +68,7 @@ var _ = Describe("Podman save", func() {
 
 		save := podmanTest.Podman([]string{"save", "-q", "-o", outfile, ALPINE})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save bogus image", func() {
@@ -86,7 +87,7 @@ var _ = Describe("Podman save", func() {
 
 		save := podmanTest.Podman([]string{"save", "--format", "oci-dir", "-o", outdir, ALPINE})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save to directory with v2s2 docker format", func() {
@@ -97,7 +98,7 @@ var _ = Describe("Podman save", func() {
 
 		save := podmanTest.Podman([]string{"save", "--format", "docker-dir", "-o", outdir, ALPINE})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save to directory with docker format and compression", func() {
@@ -108,7 +109,7 @@ var _ = Describe("Podman save", func() {
 
 		save := podmanTest.Podman([]string{"save", "--compress", "--format", "docker-dir", "-o", outdir, ALPINE})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save to directory with --compress but not use docker-dir and oci-dir", func() {
@@ -120,12 +121,12 @@ var _ = Describe("Podman save", func() {
 		save := podmanTest.Podman([]string{"save", "--compress", "--format", "docker-archive", "-o", outdir, ALPINE})
 		save.WaitWithDefaultTimeout()
 		// should not be 0
-		Expect(save.ExitCode()).ToNot(Equal(0))
+		Expect(save).To(ExitWithError())
 
 		save = podmanTest.Podman([]string{"save", "--compress", "--format", "oci-archive", "-o", outdir, ALPINE})
 		save.WaitWithDefaultTimeout()
 		// should not be 0
-		Expect(save.ExitCode()).ToNot(Equal(0))
+		Expect(save).To(ExitWithError())
 
 	})
 
@@ -154,7 +155,7 @@ var _ = Describe("Podman save", func() {
 		port := 5000
 		session := podmanTest.Podman([]string{"run", "-d", "--name", "registry", "-p", strings.Join([]string{strconv.Itoa(port), strconv.Itoa(port)}, ":"), "quay.io/libpod/registry:2.6"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		if !WaitContainerReady(podmanTest, "registry", "listening on", 20, 1) {
 			Skip("Cannot start docker registry.")
 		}
@@ -183,19 +184,19 @@ default-docker:
 
 		session = podmanTest.Podman([]string{"tag", ALPINE, "localhost:5000/alpine"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"push", "--tls-verify=false", "--sign-by", "foo@bar.com", "localhost:5000/alpine"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"rmi", ALPINE, "localhost:5000/alpine"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"pull", "--tls-verify=false", "--signature-policy=sign/policy.json", "localhost:5000/alpine"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		outfile := filepath.Join(podmanTest.TempDir, "temp.tar")
 		save := podmanTest.Podman([]string{"save", "remove-signatures=true", "-o", outfile, "localhost:5000/alpine"})
@@ -207,13 +208,13 @@ default-docker:
 		// pull a digest reference
 		session := podmanTest.Podman([]string{"pull", ALPINELISTDIGEST})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// save a digest reference should exit without error.
 		outfile := filepath.Join(podmanTest.TempDir, "temp.tar")
 		save := podmanTest.Podman([]string{"save", "-o", outfile, ALPINELISTDIGEST})
 		save.WaitWithDefaultTimeout()
-		Expect(save.ExitCode()).To(Equal(0))
+		Expect(save).Should(Exit(0))
 	})
 
 	It("podman save --multi-image-archive (tagged images)", func() {
@@ -224,7 +225,7 @@ default-docker:
 		// Refer to images via ID instead of tag.
 		session := podmanTest.Podman([]string{"images", "--format", "{{.ID}}"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		ids := session.OutputToStringArray()
 
 		Expect(len(RESTORE_IMAGES), len(ids))
@@ -239,17 +240,17 @@ func multiImageSave(podmanTest *PodmanTestIntegration, images []string) {
 	outfile := filepath.Join(podmanTest.TempDir, "temp.tar")
 	session := podmanTest.Podman(append([]string{"save", "-o", outfile, "--multi-image-archive"}, images...))
 	session.WaitWithDefaultTimeout()
-	Expect(session.ExitCode()).To(Equal(0))
+	Expect(session).Should(Exit(0))
 
 	// Remove all images.
 	session = podmanTest.Podman([]string{"rmi", "-af"})
 	session.WaitWithDefaultTimeout()
-	Expect(session.ExitCode()).To(Equal(0))
+	Expect(session).Should(Exit(0))
 
 	// Now load the archive.
 	session = podmanTest.Podman([]string{"load", "-i", outfile})
 	session.WaitWithDefaultTimeout()
-	Expect(session.ExitCode()).To(Equal(0))
+	Expect(session).Should(Exit(0))
 	// Grep for each image in the `podman load` output.
 	for _, image := range images {
 		found, _ := session.GrepString(image)
@@ -260,6 +261,6 @@ func multiImageSave(podmanTest *PodmanTestIntegration, images []string) {
 	for _, image := range images {
 		session = podmanTest.Podman([]string{"image", "exists", image})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 	}
 }