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/volume_plugin_test.go b/test/e2e/volume_plugin_test.go
index 183050e8c..cdf635b14 100644
--- a/test/e2e/volume_plugin_test.go
+++ b/test/e2e/volume_plugin_test.go
@@ -8,6 +8,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 volume plugins", func() {
@@ -41,13 +42,13 @@ var _ = Describe("Podman volume plugins", func() {
 	It("volume create with nonexistent plugin errors", func() {
 		session := podmanTest.Podman([]string{"volume", "create", "--driver", "notexist", "test_volume_name"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Not(Equal(0)))
+		Expect(session).To(ExitWithError())
 	})
 
 	It("volume create with not-running plugin does not error", func() {
 		session := podmanTest.Podman([]string{"volume", "create", "--driver", "testvol0", "test_volume_name"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Not(Equal(0)))
+		Expect(session).To(ExitWithError())
 	})
 
 	It("volume create and remove with running plugin succeeds", func() {
@@ -60,27 +61,27 @@ var _ = Describe("Podman volume plugins", func() {
 		pluginName := "testvol1"
 		plugin := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
 		plugin.WaitWithDefaultTimeout()
-		Expect(plugin.ExitCode()).To(Equal(0))
+		Expect(plugin).Should(Exit(0))
 
 		volName := "testVolume1"
 		create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
 		create.WaitWithDefaultTimeout()
-		Expect(create.ExitCode()).To(Equal(0))
+		Expect(create).Should(Exit(0))
 
 		ls1 := podmanTest.Podman([]string{"volume", "ls", "-q"})
 		ls1.WaitWithDefaultTimeout()
-		Expect(ls1.ExitCode()).To(Equal(0))
+		Expect(ls1).Should(Exit(0))
 		arrOutput := ls1.OutputToStringArray()
 		Expect(len(arrOutput)).To(Equal(1))
 		Expect(arrOutput[0]).To(ContainSubstring(volName))
 
 		remove := podmanTest.Podman([]string{"volume", "rm", volName})
 		remove.WaitWithDefaultTimeout()
-		Expect(remove.ExitCode()).To(Equal(0))
+		Expect(remove).Should(Exit(0))
 
 		ls2 := podmanTest.Podman([]string{"volume", "ls", "-q"})
 		ls2.WaitWithDefaultTimeout()
-		Expect(ls2.ExitCode()).To(Equal(0))
+		Expect(ls2).Should(Exit(0))
 		Expect(len(ls2.OutputToStringArray())).To(Equal(0))
 	})
 
@@ -94,16 +95,16 @@ var _ = Describe("Podman volume plugins", func() {
 		pluginName := "testvol2"
 		plugin := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
 		plugin.WaitWithDefaultTimeout()
-		Expect(plugin.ExitCode()).To(Equal(0))
+		Expect(plugin).Should(Exit(0))
 
 		volName := "testVolume1"
 		create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
 		create.WaitWithDefaultTimeout()
-		Expect(create.ExitCode()).To(Equal(0))
+		Expect(create).Should(Exit(0))
 
 		volInspect := podmanTest.Podman([]string{"volume", "inspect", "--format", "{{ .Driver }}", volName})
 		volInspect.WaitWithDefaultTimeout()
-		Expect(volInspect.ExitCode()).To(Equal(0))
+		Expect(volInspect).Should(Exit(0))
 		Expect(volInspect.OutputToString()).To(ContainSubstring(pluginName))
 	})
 
@@ -118,33 +119,33 @@ var _ = Describe("Podman volume plugins", func() {
 		ctrName := "pluginCtr"
 		plugin := podmanTest.Podman([]string{"run", "--name", ctrName, "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
 		plugin.WaitWithDefaultTimeout()
-		Expect(plugin.ExitCode()).To(Equal(0))
+		Expect(plugin).Should(Exit(0))
 
 		volName := "testVolume1"
 		create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
 		create.WaitWithDefaultTimeout()
-		Expect(create.ExitCode()).To(Equal(0))
+		Expect(create).Should(Exit(0))
 
 		ls1 := podmanTest.Podman([]string{"volume", "ls", "-q"})
 		ls1.WaitWithDefaultTimeout()
-		Expect(ls1.ExitCode()).To(Equal(0))
+		Expect(ls1).Should(Exit(0))
 		arrOutput := ls1.OutputToStringArray()
 		Expect(len(arrOutput)).To(Equal(1))
 		Expect(arrOutput[0]).To(ContainSubstring(volName))
 
 		stop := podmanTest.Podman([]string{"stop", "--timeout", "0", ctrName})
 		stop.WaitWithDefaultTimeout()
-		Expect(stop.ExitCode()).To(Equal(0))
+		Expect(stop).Should(Exit(0))
 
 		// Remove should exit non-zero because missing plugin
 		remove := podmanTest.Podman([]string{"volume", "rm", volName})
 		remove.WaitWithDefaultTimeout()
-		Expect(remove.ExitCode()).To(Not(Equal(0)))
+		Expect(remove).To(ExitWithError())
 
 		// But the volume should still be gone
 		ls2 := podmanTest.Podman([]string{"volume", "ls", "-q"})
 		ls2.WaitWithDefaultTimeout()
-		Expect(ls2.ExitCode()).To(Equal(0))
+		Expect(ls2).Should(Exit(0))
 		Expect(len(ls2.OutputToStringArray())).To(Equal(0))
 	})
 
@@ -158,20 +159,20 @@ var _ = Describe("Podman volume plugins", func() {
 		pluginName := "testvol4"
 		plugin := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
 		plugin.WaitWithDefaultTimeout()
-		Expect(plugin.ExitCode()).To(Equal(0))
+		Expect(plugin).Should(Exit(0))
 
 		volName := "testVolume1"
 		create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
 		create.WaitWithDefaultTimeout()
-		Expect(create.ExitCode()).To(Equal(0))
+		Expect(create).Should(Exit(0))
 
 		ctr1 := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", fmt.Sprintf("%v:/test", volName), ALPINE, "sh", "-c", "touch /test/testfile && echo helloworld > /test/testfile"})
 		ctr1.WaitWithDefaultTimeout()
-		Expect(ctr1.ExitCode()).To(Equal(0))
+		Expect(ctr1).Should(Exit(0))
 
 		ctr2 := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", fmt.Sprintf("%v:/test", volName), ALPINE, "cat", "/test/testfile"})
 		ctr2.WaitWithDefaultTimeout()
-		Expect(ctr2.ExitCode()).To(Equal(0))
+		Expect(ctr2).Should(Exit(0))
 		Expect(ctr2.OutputToString()).To(ContainSubstring("helloworld"))
 
 		// HACK: `volume rm -f` is timing out trying to remove containers using the volume.
@@ -179,6 +180,6 @@ var _ = Describe("Podman volume plugins", func() {
 		// TODO: fix this when I get back
 		rmAll := podmanTest.Podman([]string{"rm", "-af"})
 		rmAll.WaitWithDefaultTimeout()
-		Expect(rmAll.ExitCode()).To(Equal(0))
+		Expect(rmAll).Should(Exit(0))
 	})
 })