Skip to content

fix: improve error messages of notation CLI#810

Merged
22 commits merged intomainfrom
unknown repository
Nov 3, 2023
Merged

fix: improve error messages of notation CLI#810
22 commits merged intomainfrom
unknown repository

Conversation

@ghost
Copy link

@ghost ghost commented Oct 27, 2023 •
edited by ghost
Loading

This PR improves error messages of notation sign, notation verify, notation list, and notation inspect commands. The changes include:

$ notation sign
Error: missing reference to the artifact: use `notation sign--help` to see what parameters are required

$ notation sign net-monitor:v1
Error: "net-monitor:v1": invalid reference: missing repository. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation sign test localhost:5000/net-monitor:v1
Error: "test": invalid reference: missing repository. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation sign localhost:5001/net-monitor
Error: "localhost:5001/net-monitor": invalid reference: no tag or digest. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation sign localhost:5001/net-monitor:
Error: "localhost:5001/net-monitor:": invalid reference: no tag or digest. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation sign 'localhost:5001/net-monitor:()'
Error: "localhost:5001/net-monitor:()": invalid reference: invalid tag. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation sign localhost:5001/net-monitor@
Error: "localhost:5001/net-monitor@": invalid reference: no tag or digest. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation sign localhost:5001/net-monitor@invalid
Error: "localhost:5001/net-monitor@invalid": invalid reference: invalid digest; invalid checksum digest format. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation sign --oci-layout
Error: missing reference to the artifact: use `notation sign --help` to see what parameters are required

$ notation sign --oci-layout net-monitor
Error: "net-monitor": invalid reference: missing tag or digest. Expecting <file_path>:<tag> or <file_path>@<digest>

$ notation sign --oci-layout net-monitor:
Error: "net-monitor:": invalid reference: missing tag or digest. Expecting <file_path>:<tag> or <file_path>@<digest>

$ notation sign --oci-layout net-monitor@
Error: "net-monitor@": invalid reference: missing tag or digest. Expecting <file_path>:<tag> or <file_path>@<digest>

$ notation sign --oci-layout :v1
Error: ":v1": invalid reference: missing oci-layout file path. Expecting <file_path>:<tag> or <file_path>@<digest>

$ notation sign --oci-layout '@sha256:abc'
Error: "@sha256:abc": invalid reference: missing oci-layout file path. Expecting <file_path>:<tag> or <file_path>@<digest>

$ notation verify
Error: missing reference to the artifact: use `notation verify --help` to see what parameters are required

$ notation verify net-monitor:v1
Error: "net-monitor:v1": invalid reference: missing repository. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation verify test localhost:5000/net-monitor:v1
Error: "test": invalid reference: missing repository. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation verify localhost:5001/net-monitor
Error: "localhost:5001/net-monitor": invalid reference: no tag or digest. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation verify localhost:5001/net-monitor:
Error: "localhost:5001/net-monitor:": invalid reference: no tag or digest. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation verify 'localhost:5001/net-monitor:()'
Error: "localhost:5001/net-monitor:()": invalid reference: invalid tag. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation verify localhost:5001/net-monitor@
Error: "localhost:5001/net-monitor@": invalid reference: no tag or digest. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation verify localhost:5001/net-monitor@invalid
Error: "localhost:5001/net-monitor@invalid": invalid reference: invalid digest; invalid checksum digest format. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>

$ notation verify testReg/testRepo@sha256:abcd
Error: the trust store "myStore" of type "ca" does not exist. Use command 'notation cert add' to create and add trusted certificates to the trust store

$ notation verify testReg/testRepo@sha256:abcd
Error: no x509 certificates were found in trust store "myStore" of type "ca". Use command 'notation cert add' to create and add trusted certificates to the trust store

$ notation verify testReg/testRepo@sha256:abcd
Error: failed to access the trust store "myStore" of type "ca". open /home/user/.config/notation/truststore/x509/ca/myStore: permission denied

# Same pattern applies to notation list command
$ notation list ....

# Same pattern applies to notation inspect command
$ notation inspect ....

Note, this PR depends on notaryproject/notation-go#345. (On the notation CLI side, we are not displaying any individual signature error, only corresponding error messages are updated.)

notaryproject/notation-go#345 has been merged. Notation CLI dependencies are up to date.

Resolves #699
Resolves #700
Resolves #701
Resolves #808

Patrick Zheng added 19 commits August 25, 2023 15:25
initial commits
21bee9e 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Merge branch 'notaryproject:main' into errMsg
3fead85
e2e test
5243d1d 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
fix
ae3703f 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
initial commits
e3ef191 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
go mod tidy
76d4c62 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated error message
d818c0a 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated notation-go
920747b 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated based on notation-go
04a1525 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated notation-go
4747695 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated notation-go
215dddf 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
resolved conflicts
08a9dc7 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated per code review
aea48fe 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
resolved conflicts
967c1e7 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated notation-go
a97e8b2 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
updated errMsg
e3776e8 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
fixed unit tests
940d495 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
fixed e2e tests
c7dfa42 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
fixed e2e tests
77dd8e5 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
@ghost ghost requested a review from yizha1 October 27, 2023 07:18
@codecov-commenter
Copy link

codecov-commenter commented Oct 27, 2023 •
edited by codecov bot
Loading

Codecov Report

Attention: Patch coverage is 59.18367% with 20 lines in your changes missing coverage. Please review.

Project coverage is 64.05%. Comparing base (31c9e84) to head (cd7e69d).
Report is 136 commits behind head on main.

Files with missing lines Patch % Lines
cmd/notation/verify.go 40.00% 7 Missing and 2 partials ⚠️
cmd/notation/manifest.go 0.00% 6 Missing and 1 partial ⚠️
cmd/notation/registry.go 0.00% 3 Missing and 1 partial ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #810      +/-   ##
==========================================
- Coverage   64.09%   64.05%   -0.05%     
==========================================
  Files          40       40              
  Lines        2284     2323      +39     
==========================================
+ Hits         1464     1488      +24     
- Misses        698      709      +11     
- Partials      122      126       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

shizhMSFT
shizhMSFT reviewed Oct 27, 2023
View reviewed changes
@ghost ghost requested review from JeyJeyGao and shizhMSFT November 2, 2023 02:39
JeyJeyGao
JeyJeyGao previously approved these changes Nov 2, 2023
View reviewed changes
Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

added corresponding error messages for oci-layout
cd7e69d 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
@ghost ghost requested a review from JeyJeyGao November 2, 2023 03:22
JeyJeyGao
JeyJeyGao approved these changes Nov 2, 2023
View reviewed changes
Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

shizhMSFT
shizhMSFT approved these changes Nov 2, 2023
View reviewed changes
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

priteshbandi
priteshbandi approved these changes Nov 2, 2023
View reviewed changes
Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ghost ghost merged commit bb2669b into notaryproject:main Nov 3, 2023
@ghost ghost deleted the errMsg branch November 3, 2023 00:30
priteshbandi pushed a commit that referenced this pull request Nov 3, 2023
bump: update dependencies (#815)
ed70c9d 
Bumping up to notation-go v1.0.1.
As #810 is merged, bumping
up build is successful now.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
shizhMSFT pushed a commit that referenced this pull request Nov 3, 2023
@shizhMSFT
fix: improve error messages of notation CLI (#810)
56b6830 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
shizhMSFT pushed a commit that referenced this pull request Nov 3, 2023
@shizhMSFT
bump: update dependencies (#815)
f001dc1 
Bumping up to notation-go v1.0.1.
As #810 is merged, bumping
up build is successful now.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
shizhMSFT pushed a commit that referenced this pull request Nov 3, 2023
@shizhMSFT
fix: improve error messages of notation CLI (#810)
9e5693f 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
shizhMSFT pushed a commit that referenced this pull request Nov 3, 2023
@shizhMSFT
bump: update dependencies (#815)
e07fc1a 
Bumping up to notation-go v1.0.1.
As #810 is merged, bumping
up build is successful now.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
@shizhMSFT shizhMSFT mentioned this pull request Nov 6, 2023
Merged
6 tasks
@FeynmanZhou FeynmanZhou mentioned this pull request Nov 7, 2023
Closed
@p-linnane p-linnane mentioned this pull request Nov 8, 2023
Merged
@yizha1 yizha1 mentioned this pull request Jan 2, 2024
Closed
@ghost ghost mentioned this pull request Jan 25, 2024
Merged
6 tasks
rgnote pushed a commit to rgnote/notation that referenced this pull request Mar 8, 2024
@rgnote
fix: improve error messages of notation CLI (notaryproject#810)
2190445 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
rgnote pushed a commit to rgnote/notation that referenced this pull request Mar 8, 2024
@rgnote
bump: update dependencies (notaryproject#815)
c2343e5 
Bumping up to notation-go v1.0.1.
As notaryproject#810 is merged, bumping
up build is successful now.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
rgnote pushed a commit to rgnote/notation that referenced this pull request Mar 8, 2024
@rgnote
fix: improve error messages of notation CLI (notaryproject#810)
a882cc9 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Signed-off-by: rgnote <5878554+rgnote@users.noreply.github.com>
rgnote pushed a commit to rgnote/notation that referenced this pull request Mar 8, 2024
@rgnote
bump: update dependencies (notaryproject#815)
14b6b44 
Bumping up to notation-go v1.0.1.
As notaryproject#810 is merged, bumping
up build is successful now.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Signed-off-by: rgnote <5878554+rgnote@users.noreply.github.com>
7h3-3mp7y-m4n pushed a commit to 7h3-3mp7y-m4n/notation that referenced this pull request Mar 29, 2025
@7h3-3mp7y-m4n
fix: improve error messages of notation CLI (notaryproject#810)
6ddff86 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
7h3-3mp7y-m4n pushed a commit to 7h3-3mp7y-m4n/notation that referenced this pull request Mar 29, 2025
@7h3-3mp7y-m4n
bump: update dependencies (notaryproject#815)
21ffceb 
Bumping up to notation-go v1.0.1.
As notaryproject#810 is merged, bumping
up build is successful now.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
FeynmanZhou pushed a commit to FeynmanZhou/notation that referenced this pull request May 15, 2025
@FeynmanZhou
fix: improve error messages of notation CLI (notaryproject#810)
af8320d 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
FeynmanZhou pushed a commit to FeynmanZhou/notation that referenced this pull request May 15, 2025
@FeynmanZhou
bump: update dependencies (notaryproject#815)
687b2d8 
Bumping up to notation-go v1.0.1.
As notaryproject#810 is merged, bumping
up build is successful now.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gokarnm gokarnm Awaiting requested review from gokarnm gokarnm is a code owner

@justincormack justincormack Awaiting requested review from justincormack

@NiazFK NiazFK Awaiting requested review from NiazFK NiazFK is a code owner

@rgnote rgnote Awaiting requested review from rgnote rgnote is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

@yizha1 yizha1 Awaiting requested review from yizha1 yizha1 is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

5 participants

@codecov-commenter @priteshbandi @shizhMSFT @JeyJeyGao @iamsamirzon

Comments