Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

podman unshare keep exit code #11513

Merged
merged 1 commit into from
Sep 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion cmd/podman/system/unshare.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package system

import (
"os"
"os/exec"

"github.com/containers/common/pkg/completion"
"github.com/containers/podman/v3/cmd/podman/registry"
Expand Down Expand Up @@ -50,5 +51,23 @@ func unshare(cmd *cobra.Command, args []string) error {
args = []string{shell}
}

return registry.ContainerEngine().Unshare(registry.Context(), args, unshareOptions)
err := registry.ContainerEngine().Unshare(registry.Context(), args, unshareOptions)
if err != nil {
if exitError, ok := err.(*exec.ExitError); ok {
// the user command inside the unshare env has failed
// we set the exit code, do not return the error to the user
// otherwise "exit status X" will be printed
registry.SetExitCode(exitError.ExitCode())
return nil
}
// cmd.Run() can return fs.ErrNotExist, fs.ErrPermission or exec.ErrNotFound
// follow podman run/exec standard with the exit codes
if errors.Is(err, os.ErrNotExist) || errors.Is(err, exec.ErrNotFound) {
registry.SetExitCode(127)
} else if errors.Is(err, os.ErrPermission) {
registry.SetExitCode(126)
}
return err
}
return nil
}
29 changes: 29 additions & 0 deletions docs/source/markdown/podman-unshare.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,35 @@ connect to a rootless container via IP address (CNI networking). This is otherwi
not possible from the host network namespace.
_Note: Using this option with more than one unshare session can have unexpected results._

## Exit Codes

The exit code from `podman unshare` gives information about why the container
failed to run or why it exited. When `podman unshare` commands exit with a non-zero code,
the exit codes follow the `chroot` standard, see below:

**125** The error is with podman **_itself_**

$ podman unshare --foo; echo $?
Error: unknown flag: --foo
125

**126** Executing a _contained command_ and the _command_ cannot be invoked

$ podman unshare /etc; echo $?
Error: fork/exec /etc: permission denied
126

**127** Executing a _contained command_ and the _command_ cannot be found

$ podman run busybox foo; echo $?
Error: fork/exec /usr/bin/bogus: no such file or directory
127

**Exit code** _contained command_ exit code

$ podman run busybox /bin/sh -c 'exit 3'; echo $?
3

## EXAMPLE

```
Expand Down
35 changes: 33 additions & 2 deletions test/e2e/unshare_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ var _ = Describe("Podman unshare", func() {
session := podmanTest.Podman([]string{"unshare", "readlink", "/proc/self/ns/user"})
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(0))
ok, _ := session.GrepString(userNS)
Expect(ok).To(BeFalse())
Expect(session.OutputToString()).ToNot(ContainSubstring(userNS))
})

It("podman unshare --rootles-cni", func() {
Expand All @@ -57,4 +56,36 @@ var _ = Describe("Podman unshare", func() {
Expect(session).Should(Exit(0))
Expect(session.OutputToString()).To(ContainSubstring("tap0"))
})

It("podman unshare exit codes", func() {
session := podmanTest.Podman([]string{"unshare", "false"})
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(1))
Expect(session.OutputToString()).Should(Equal(""))
Expect(session.ErrorToString()).Should(Equal(""))

session = podmanTest.Podman([]string{"unshare", "/usr/bin/bogus"})
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(127))
Expect(session.OutputToString()).Should(Equal(""))
Expect(session.ErrorToString()).Should(ContainSubstring("no such file or directory"))

session = podmanTest.Podman([]string{"unshare", "bogus"})
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(127))
Expect(session.OutputToString()).Should(Equal(""))
Expect(session.ErrorToString()).Should(ContainSubstring("executable file not found in $PATH"))

session = podmanTest.Podman([]string{"unshare", "/usr"})
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(126))
Expect(session.OutputToString()).Should(Equal(""))
Expect(session.ErrorToString()).Should(ContainSubstring("permission denied"))

session = podmanTest.Podman([]string{"unshare", "--bogus"})
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(125))
Expect(session.OutputToString()).Should(Equal(""))
Expect(session.ErrorToString()).Should(ContainSubstring("unknown flag: --bogus"))
})
})