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.

Sign up for GitHub

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

chore: improve error message when attaching with no file or annotation #1253

Merged
merged 1 commit into from
Jan 26, 2024
Merged

chore: improve error message when attaching with no file or annotation #1253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion cmd/oras/root/attach.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,13 @@ func runAttach(cmd *cobra.Command, opts *attachOptions) error {
return err
}
if len(opts.FileRefs) == 0 && len(annotations[option.AnnotationManifest]) == 0 {
return errors.New("no blob or manifest annotation are provided")
return &oerrors.Error{
Err: errors.New(`neither file nor annotation provided in the command`),
Usage: fmt.Sprintf("%s %s", cmd.Parent().CommandPath(), cmd.Use),
Recommendation: `To attach to an existing artifact, please provide files
via argument or annotations via flag "--annotation". Run "oras attach -h"
for more options and examples`,
}
}

// prepare manifest
Expand Down
4 changes: 2 additions & 2 deletions test/e2e/suite/command/attach.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ var _ = Describe("ORAS beginners:", func() {

It("should fail if no file reference or manifest annotation provided for registry", func() {
ORAS("attach", "--artifact-type", "oras/test", RegistryRef(ZOTHost, ImageRepo, foobar.Tag)).
ExpectFailure().MatchErrKeyWords("Error: no blob or manifest annotation are provided").Exec()
ExpectFailure().MatchErrKeyWords("Error: neither file nor annotation", "Usage:").Exec()
})

It("should fail if no file reference or manifest annotation provided for OCI layout", func() {
root := GinkgoT().TempDir()
ORAS("attach", "--artifact-type", "oras/test", LayoutRef(root, foobar.Tag)).
ExpectFailure().MatchErrKeyWords("Error: no blob or manifest annotation are provided").Exec()
ExpectFailure().MatchErrKeyWords("Error: neither file nor annotation", "Usage:").Exec()
})

It("should fail if distribution spec is unknown", func() {
Expand Down
Loading