Use exit code constants

We have leaked the exit number codess all over the code, this patch removes the numbers to constants. Signed-off-by: Daniel J Walsh <[email protected]>
containers · Sep 12, 2019 · 535111b · 535111b
1 parent af8fedc
commit 535111b
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 31 deletions.
diff --git a/cmd/podman/containers_prune.go b/cmd/podman/containers_prune.go
@@ -53,15 +53,15 @@ func pruneContainersCmd(c *cliconfig.PruneContainersValues) error {
 	if err != nil {
 		if errors.Cause(err) == define.ErrNoSuchCtr {
 			if len(c.InputArgs) > 1 {
-				exitCode = 125
+				exitCode = define.ExecErrorCodeGeneric
 			} else {
 				exitCode = 1
 			}
 		}
 		return err
 	}
 	if len(failures) > 0 {
-		exitCode = 125
+		exitCode = define.ExecErrorCodeGeneric
 	}
 	return printCmdResults(ok, failures)
 }
diff --git a/cmd/podman/main.go b/cmd/podman/main.go
@@ -8,6 +8,7 @@ import (
 
 	"github.com/containers/libpod/cmd/podman/cliconfig"
 	"github.com/containers/libpod/libpod"
+	"github.com/containers/libpod/libpod/define"
 	_ "github.com/containers/libpod/pkg/hooks/0.1.0"
 	"github.com/containers/libpod/pkg/rootless"
 	"github.com/containers/libpod/version"
@@ -20,7 +21,7 @@ import (
 // This is populated by the Makefile from the VERSION file
 // in the repository
 var (
-	exitCode = 125
+	exitCode = define.ExecErrorCodeGeneric
 	Ctx      context.Context
 	span     opentracing.Span
 	closer   io.Closer
@@ -152,11 +153,12 @@ func main() {
 	if err := rootCmd.Execute(); err != nil {
 		outputError(err)
 	} else {
-		// The exitCode modified from 125, indicates an application
+		// The exitCode modified from define.ExecErrorCodeGeneric,
+		// indicates an application
 		// running inside of a container failed, as opposed to the
 		// podman command failed.  Must exit with that exit code
 		// otherwise command exited correctly.
-		if exitCode == 125 {
+		if exitCode == define.ExecErrorCodeGeneric {
 			exitCode = 0
 		}
 

diff --git a/cmd/podman/pause.go b/cmd/podman/pause.go
@@ -56,15 +56,15 @@ func pauseCmd(c *cliconfig.PauseValues) error {
 	if err != nil {
 		if errors.Cause(err) == define.ErrNoSuchCtr {
 			if len(c.InputArgs) > 1 {
-				exitCode = 125
+				exitCode = define.ExecErrorCodeGeneric
 			} else {
 				exitCode = 1
 			}
 		}
 		return err
 	}
 	if len(failures) > 0 {
-		exitCode = 125
+		exitCode = define.ExecErrorCodeGeneric
 	}
 	return printCmdResults(ok, failures)
 }
diff --git a/cmd/podman/restart.go b/cmd/podman/restart.go
@@ -61,15 +61,15 @@ func restartCmd(c *cliconfig.RestartValues) error {
 	if err != nil {
 		if errors.Cause(err) == define.ErrNoSuchCtr {
 			if len(c.InputArgs) > 1 {
-				exitCode = 125
+				exitCode = define.ExecErrorCodeGeneric
 			} else {
 				exitCode = 1
 			}
 		}
 		return err
 	}
 	if len(failures) > 0 {
-		exitCode = 125
+		exitCode = define.ExecErrorCodeGeneric
 	}
 	return printCmdResults(ok, failures)
 }
diff --git a/cmd/podman/unpause.go b/cmd/podman/unpause.go
@@ -55,15 +55,15 @@ func unpauseCmd(c *cliconfig.UnpauseValues) error {
 	if err != nil {
 		if errors.Cause(err) == define.ErrNoSuchCtr {
 			if len(c.InputArgs) > 1 {
-				exitCode = 125
+				exitCode = define.ExecErrorCodeGeneric
 			} else {
 				exitCode = 1
 			}
 		}
 		return err
 	}
 	if len(failures) > 0 {
-		exitCode = 125
+		exitCode = define.ExecErrorCodeGeneric
 	}
 	return printCmdResults(ok, failures)
 }
diff --git a/libpod/container_api.go b/libpod/container_api.go
@@ -216,8 +216,8 @@ func (c *Container) Kill(signal uint) error {
 }
 
 // Exec starts a new process inside the container
-// Returns an exit code and an error. If Exec was not able to exec in the container before a failure, an exit code of 126 is returned.
-// If another generic error happens, an exit code of 125 is returned.
+// Returns an exit code and an error. If Exec was not able to exec in the container before a failure, an exit code of define.ExecErrorCodeCannotInvoke is returned.
+// If another generic error happens, an exit code of define.ExecErrorCodeGeneric is returned.
 // Sometimes, the $RUNTIME exec call errors, and if that is the case, the exit code is the exit code of the call.
 // Otherwise, the exit code will be the exit code of the executed call inside of the container.
 // TODO investigate allowing exec without attaching

diff --git a/libpod/define/exec_codes.go b/libpod/define/exec_codes.go
@@ -1,6 +1,8 @@
 package define
 
 import (
+	"strings"
+
 	"github.com/pkg/errors"
 )
 
@@ -28,3 +30,19 @@ func TranslateExecErrorToExitCode(originalEC int, err error) int {
 	}
 	return originalEC
 }
+
+// ExitCode reads the error message when failing to executing container process
+// and then returns 0 if no error, ExecErrorCodeNotFound if command does not exist, or ExecErrorCodeCannotInvoke for
+// all other errors
+func ExitCode(err error) int {
+	if err == nil {
+		return 0
+	}
+	e := strings.ToLower(err.Error())
+	if strings.Contains(e, "file not found") ||
+		strings.Contains(e, "no such file or directory") {
+		return ExecErrorCodeNotFound
+	}
+
+	return ExecErrorCodeCannotInvoke
+}
diff --git a/pkg/adapter/containers.go b/pkg/adapter/containers.go
@@ -341,12 +341,7 @@ func (r *LocalRuntime) Run(ctx context.Context, c *cliconfig.RunValues, exitCode
 		// if the container was created as part of a pod, also start its dependencies, if any.
 		if err := ctr.Start(ctx, c.IsSet("pod")); err != nil {
 			// This means the command did not exist
-			exitCode = 127
-			e := strings.ToLower(err.Error())
-			if strings.Contains(e, "permission denied") || strings.Contains(e, "operation not permitted") || strings.Contains(e, "file not found") || strings.Contains(e, "no such file or directory") {
-				exitCode = 126
-			}
-			return exitCode, err
+			return define.ExitCode(err), err
 		}
 
 		fmt.Printf("%s\n", ctr.ID())
@@ -415,7 +410,7 @@ func (r *LocalRuntime) Run(ctx context.Context, c *cliconfig.RunValues, exitCode
 				logrus.Debugf("unable to remove container %s after failing to start and attach to it", ctr.ID())
 			}
 		}
-		return exitCode, err
+		return define.ExitCode(err), err
 	}
 
 	if ecode, err := ctr.Wait(); err != nil {
@@ -424,7 +419,7 @@ func (r *LocalRuntime) Run(ctx context.Context, c *cliconfig.RunValues, exitCode
 			event, err := r.Runtime.GetLastContainerEvent(ctr.ID(), events.Exited)
 			if err != nil {
 				logrus.Errorf("Cannot get exit code: %v", err)
-				exitCode = 127
+				exitCode = define.ExecErrorCodeNotFound
 			} else {
 				exitCode = event.ContainerExitCode
 			}
@@ -576,7 +571,7 @@ func (r *LocalRuntime) Restore(ctx context.Context, c *cliconfig.RestoreValues)
 // Start will start a container
 func (r *LocalRuntime) Start(ctx context.Context, c *cliconfig.StartValues, sigProxy bool) (int, error) {
 	var (
-		exitCode  = 125
+		exitCode  = define.ExecErrorCodeGeneric
 		lastError error
 	)
 
@@ -636,7 +631,7 @@ func (r *LocalRuntime) Start(ctx context.Context, c *cliconfig.StartValues, sigP
 					event, err := r.Runtime.GetLastContainerEvent(ctr.ID(), events.Exited)
 					if err != nil {
 						logrus.Errorf("Cannot get exit code: %v", err)
-						exitCode = 127
+						exitCode = define.ExecErrorCodeNotFound
 					} else {
 						exitCode = event.ContainerExitCode
 					}
@@ -914,7 +909,7 @@ func (r *LocalRuntime) ExecContainer(ctx context.Context, cli *cliconfig.ExecVal
 		cmd []string
 	)
 	// default invalid command exit code
-	ec := 125
+	ec := define.ExecErrorCodeGeneric
 
 	if cli.Latest {
 		if ctr, err = r.GetLatestContainer(); err != nil {

diff --git a/pkg/adapter/containers_remote.go b/pkg/adapter/containers_remote.go
@@ -669,7 +669,7 @@ func (r *LocalRuntime) Restore(ctx context.Context, c *cliconfig.RestoreValues)
 func (r *LocalRuntime) Start(ctx context.Context, c *cliconfig.StartValues, sigProxy bool) (int, error) {
 	var (
 		finalErr error
-		exitCode = 125
+		exitCode = define.ExecErrorCodeGeneric
 	)
 	// TODO Figure out how to deal with exit codes
 	inputStream := os.Stdin

diff --git a/test/e2e/run_exit_test.go b/test/e2e/run_exit_test.go
@@ -5,6 +5,7 @@ package integration
 import (
 	"os"
 
+	"github.com/containers/libpod/libpod/define"
 	. "github.com/containers/libpod/test/utils"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -34,22 +35,22 @@ var _ = Describe("Podman run exit", func() {
 
 	})
 
-	It("podman run exit 125", func() {
+	It("podman run exit define.ExecErrorCodeGeneric", func() {
 		result := podmanTest.Podman([]string{"run", "--foobar", ALPINE, "ls", "$tmp"})
 		result.WaitWithDefaultTimeout()
-		Expect(result.ExitCode()).To(Equal(125))
+		Expect(result.ExitCode()).To(Equal(define.ExecErrorCodeGeneric))
 	})
 
-	It("podman run exit 126", func() {
+	It("podman run exit ExecErrorCodeCannotInvoke", func() {
 		result := podmanTest.Podman([]string{"run", ALPINE, "/etc"})
 		result.WaitWithDefaultTimeout()
-		Expect(result.ExitCode()).To(Equal(126))
+		Expect(result.ExitCode()).To(Equal(define.ExecErrorCodeCannotInvoke))
 	})
 
-	It("podman run exit 127", func() {
+	It("podman run exit ExecErrorCodeNotFound", func() {
 		result := podmanTest.Podman([]string{"run", ALPINE, "foobar"})
 		result.WaitWithDefaultTimeout()
-		Expect(result.ExitCode()).To(Equal(127))
+		Expect(result.ExitCode()).To(Equal(define.ExecErrorCodeNotFound))
 	})
 
 	It("podman run exit 0", func() {