Skip to content

Commit

Permalink
main: return different exit code when an input is not found
Browse files Browse the repository at this point in the history
This is a proof of concept that shows how we could do a different
exit code in skopeo when an input is not found. The use case is
`osbuild` which uses skopeo to inspect images and it would be
nice to differenciate between an image that is not found and
general skopeo errors (or errors like network issues etc).

I picked exit code (2) for not found because it is also the value
of ENOENT but that is arbitrary and I'm happy to switch to any
other value (we could do `44` as `404` :-) - happy about ideas).

Man page and a test are added.

P.S. I also found that for local images that are not found `ErrNotAnImage`
is returned so the docstring of `storage.ErrNotAnImage` may need
updating (I'm happy to do this separtely if desired).

To reproduce:
```
$ skopeo inspect containers-storage:010101010101
FATA[0000] Error parsing image name "containers-storage:010101010101": reference "[overlay@/media/space/home/egon/.local/share/containers/storage+/run/user/1000/containers]docker.io/library/010101010101:latest" does not resolve to an image ID: identifier is not an image
```

For references (from storage/errors.go):
```
ErrNotAnImage = errors.New("identifier is not an image")
```

Signed-off-by: Michael Vogt <[email protected]>
  • Loading branch information
mvo5 committed Mar 22, 2024
1 parent d5ac962 commit 4d71e73
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 0 deletions.
4 changes: 4 additions & 0 deletions cmd/skopeo/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ func main() {
}
rootCmd, _ := createApp()
if err := rootCmd.Execute(); err != nil {
if isNotFoundImageError(err) {
logrus.Error(err)
logrus.Exit(2)
}
logrus.Fatal(err)
}
}
Expand Down
2 changes: 2 additions & 0 deletions cmd/skopeo/proxy.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ import (
"github.com/containers/image/v5/transports"
"github.com/containers/image/v5/transports/alltransports"
"github.com/containers/image/v5/types"
"github.com/containers/storage"
dockerdistributionerrcode "github.com/docker/distribution/registry/api/errcode"
dockerdistributionapi "github.com/docker/distribution/registry/api/v2"
"github.com/opencontainers/go-digest"
Expand Down Expand Up @@ -235,6 +236,7 @@ func isDockerManifestUnknownError(err error) bool {
// TODO drive this into containers/image properly
func isNotFoundImageError(err error) bool {
return isDockerManifestUnknownError(err) ||
errors.Is(err, storage.ErrNotAnImage) ||
errors.Is(err, ocilayout.ImageNotFoundError{})
}

Expand Down
7 changes: 7 additions & 0 deletions docs/skopeo.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,13 @@ Print the version number
Default directory containing registry configuration, if **--registries.d** is not specified.
The contents of this directory are documented in [containers-registries.d(5)](https://github.com/containers/image/blob/main/docs/containers-registries.d.5.md).

## EXIT STATUS
`skopeo` exists with status 0 if the operation was successfully. Error result
in a non-zero exit code. If the input image cannot be found an exit status of
2 is returned. Note that this is best effort and for remote registries the
status often cannot be reliably reported.


## SEE ALSO
skopeo-login(1), docker-login(1), containers-auth.json(5), containers-storage.conf(5), containers-policy.json(5), containers-transports(5)

Expand Down
7 changes: 7 additions & 0 deletions systemtest/010-inspect.bats
Original file line number Diff line number Diff line change
Expand Up @@ -129,4 +129,11 @@ END_EXPECT
expect_output --from="$repo_tags" "" "inspect --no-tags was expected to return empty RepoTags[]"
}

@test "inspect: image unknown" {
# non existing image
run_skopeo 2 inspect containers-storage:non-existing-tag
expect_output --substring "identifier is not an image" \
"skopeo inspect containers-storage:010101010101"
}

# vim: filetype=sh

0 comments on commit 4d71e73

Please sign in to comment.