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, 59 insertions, 58 deletions

diff --git a/test/e2e/generate_systemd_test.go b/test/e2e/generate_systemd_test.go
index e03d6899e..121f09a11 100644
--- a/test/e2e/generate_systemd_test.go
+++ b/test/e2e/generate_systemd_test.go
@@ -7,6 +7,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 generate systemd", func() {
@@ -54,7 +55,7 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd bad restart-policy value", func() {
 		session := podmanTest.Podman([]string{"create", "--name", "foobar", "alpine", "top"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"generate", "systemd", "--restart-policy", "bogus", "foobar"})
 		session.WaitWithDefaultTimeout()
@@ -65,11 +66,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd with --no-header=true", func() {
 		session := podmanTest.Podman([]string{"create", "--name", "foobar", "alpine", "top"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"generate", "systemd", "foobar", "--no-header=true"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		Expect(session.OutputToString()).NotTo(ContainSubstring("autogenerated by"))
 	})
@@ -77,11 +78,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd with --no-header", func() {
 		session := podmanTest.Podman([]string{"create", "--name", "foobar", "alpine", "top"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"generate", "systemd", "foobar", "--no-header"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		Expect(session.OutputToString()).NotTo(ContainSubstring("autogenerated by"))
 	})
@@ -89,11 +90,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd with --no-header=false", func() {
 		session := podmanTest.Podman([]string{"create", "--name", "foobar", "alpine", "top"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"generate", "systemd", "foobar", "--no-header=false"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		Expect(session.OutputToString()).To(ContainSubstring("autogenerated by"))
 	})
@@ -101,11 +102,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd good timeout value", func() {
 		session := podmanTest.Podman([]string{"create", "--name", "foobar", "alpine", "top"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"generate", "systemd", "--time", "1234", "foobar"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.OutputToString()).To(ContainSubstring("TimeoutStopSec=1294"))
 		Expect(session.OutputToString()).To(ContainSubstring(" stop -t 1234 "))
 	})
@@ -113,11 +114,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd", func() {
 		n := podmanTest.Podman([]string{"run", "--name", "nginx", "-dt", nginx})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "nginx"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// The podman commands in the unit should not contain the root flags
 		Expect(session.OutputToString()).ToNot(ContainSubstring(" --runroot"))
@@ -126,11 +127,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --files --name", func() {
 		n := podmanTest.Podman([]string{"run", "--name", "nginx", "-dt", nginx})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--files", "--name", "nginx"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		for _, file := range session.OutputToStringArray() {
 			os.Remove(file)
@@ -141,30 +142,30 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd with timeout", func() {
 		n := podmanTest.Podman([]string{"run", "--name", "nginx", "-dt", nginx})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--time", "5", "nginx"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.OutputToString()).To(ContainSubstring("podman stop -t 5"))
 	})
 
 	It("podman generate systemd pod --name", func() {
 		n := podmanTest.Podman([]string{"pod", "create", "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-1", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-2", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--time", "42", "--name", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# pod-foo.service"))
@@ -185,15 +186,15 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd pod --name --files", func() {
 		n := podmanTest.Podman([]string{"pod", "create", "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-1", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--name", "--files", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		for _, file := range session.OutputToStringArray() {
 			os.Remove(file)
@@ -206,11 +207,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --new --name foo", func() {
 		n := podmanTest.Podman([]string{"create", "--name", "foo", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "-t", "42", "--name", "--new", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# container-foo.service"))
@@ -224,11 +225,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --new --name=foo", func() {
 		n := podmanTest.Podman([]string{"create", "--name=foo", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "-t", "42", "--name", "--new", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# container-foo.service"))
@@ -238,11 +239,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --new without explicit detaching param", func() {
 		n := podmanTest.Podman([]string{"create", "--name", "foo", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--time", "42", "--name", "--new", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring(" -d "))
@@ -251,11 +252,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --new with explicit detaching param in middle", func() {
 		n := podmanTest.Podman([]string{"create", "--name", "foo", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--time", "42", "--name", "--new", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("--name foo alpine top"))
@@ -264,44 +265,44 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --new pod", func() {
 		n := podmanTest.Podman([]string{"pod", "create", "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--time", "42", "--name", "--new", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.OutputToString()).To(ContainSubstring(" pod create "))
 	})
 
 	It("podman generate systemd --new=false pod", func() {
 		n := podmanTest.Podman([]string{"pod", "create", "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--time", "42", "--name", "--new=false", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.OutputToString()).NotTo(ContainSubstring(" pod create "))
 	})
 
 	It("podman generate systemd --new=true pod", func() {
 		n := podmanTest.Podman([]string{"pod", "create", "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--time", "42", "--name", "--new=true", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.OutputToString()).To(ContainSubstring(" pod create "))
 	})
 
 	It("podman generate systemd --container-prefix con", func() {
 		n := podmanTest.Podman([]string{"create", "--name", "foo", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--name", "--container-prefix", "con", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# con-foo.service"))
@@ -311,11 +312,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --separator _", func() {
 		n := podmanTest.Podman([]string{"create", "--name", "foo", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--name", "--separator", "_", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# container_foo.service"))
@@ -324,19 +325,19 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd pod --pod-prefix p", func() {
 		n := podmanTest.Podman([]string{"pod", "create", "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-1", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-2", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--pod-prefix", "p", "--name", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# p-foo.service"))
@@ -348,19 +349,19 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd pod --pod-prefix p --container-prefix con --separator _ change all prefixes/separator", func() {
 		n := podmanTest.Podman([]string{"pod", "create", "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-1", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-2", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--container-prefix", "con", "--pod-prefix", "p", "--separator", "_", "--name", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# p_foo.service"))
@@ -378,19 +379,19 @@ var _ = Describe("Podman generate systemd", func() {
 
 		n := podmanTest.Podman([]string{"pod", "create", "--pod-id-file", tmpFile, "--name", "foo"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-1", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		n = podmanTest.Podman([]string{"create", "--pod", "foo", "--name", "foo-2", "alpine", "top"})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--new", "--name", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		// Grepping the output (in addition to unit tests)
 		Expect(session.OutputToString()).To(ContainSubstring("# pod-foo.service"))
@@ -405,11 +406,11 @@ var _ = Describe("Podman generate systemd", func() {
 	It("podman generate systemd --format json", func() {
 		n := podmanTest.Podman([]string{"create", "--name", "foo", ALPINE})
 		n.WaitWithDefaultTimeout()
-		Expect(n.ExitCode()).To(Equal(0))
+		Expect(n).Should(Exit(0))
 
 		session := podmanTest.Podman([]string{"generate", "systemd", "--format", "json", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.IsJSONOutputValid()).To(BeTrue())
 	})
 
@@ -417,20 +418,20 @@ var _ = Describe("Podman generate systemd", func() {
 		// Regression test for #9034
 		session := podmanTest.Podman([]string{"create", "--name", "foo", "--log-driver=journald", "--log-opt=tag={{.Name}}", ALPINE})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"generate", "systemd", "--new", "foo"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.OutputToString()).To(ContainSubstring(" --log-opt=tag={{.Name}} "))
 
 		session = podmanTest.Podman([]string{"pod", "create", "--name", "pod", "--label", "key={{someval}}"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 
 		session = podmanTest.Podman([]string{"generate", "systemd", "--new", "pod"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
+		Expect(session).Should(Exit(0))
 		Expect(session.OutputToString()).To(ContainSubstring(" --label key={{someval}}"))
 	})
 })