Skip to content

fix: improve error message for --signature-format flag #925

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

Jump to bottom
Merged
7 commits merged into from
Apr 18, 2024
Merged

fix: improve error message for --signature-format flag #925

7 commits merged into from
Apr 18, 2024

Conversation

@JeyJeyGao
Copy link
Contributor

@JeyJeyGao JeyJeyGao commented Apr 9, 2024 •
edited
Loading

Previous error message:

$ notation sign localhost:5000/hello-app:v1 --plugin azure-kv --id https://x.vault.azure.net/certificates/self-signed-pem/xxx --signature-format xxx
Error: signature format "xxx" not supported

Improved error message:

$ notation sign localhost:5000/hello-app:v1 --plugin azure-kv --id https://x.vault.azure.net/certificates/self-signed-pem/xxx --signature-format xxx
Error: signature format "xxx" not supported
Please use the supported signature envelope format "jws" or "cose"

Test(not related to the fix):

  • added unit test and e2e test to reach codecov target

Resolves #868
Signed-off-by: Junjie Gao junjiegao@microsoft.com

@JeyJeyGao
fix: improve error message for --signature-format flag
689006e 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao requested a review from a user April 9, 2024 08:00
@codecov-commenter
Copy link

codecov-commenter commented Apr 9, 2024 •
edited by codecov bot
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.91%. Comparing base (eaa5fb4) to head (9facfa5).
Report is 23 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #925      +/-   ##
==========================================
+ Coverage   64.93%   70.91%   +5.98%     
==========================================
  Files          45       45              
  Lines        2729     2166     -563     
==========================================
- Hits         1772     1536     -236     
+ Misses        795      440     -355     
- Partials      162      190      +28

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

@JeyJeyGao JeyJeyGao mentioned this pull request Apr 9, 2024
Closed
priteshbandi
priteshbandi previously approved these changes Apr 9, 2024
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 reviewed Apr 10, 2024
View reviewed changes
shizhMSFT
shizhMSFT previously approved these changes Apr 10, 2024
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

@JeyJeyGao
fix: update error message
8e98706 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao dismissed stale reviews from shizhMSFT and priteshbandi via 8e98706 April 10, 2024 06:05
@JeyJeyGao JeyJeyGao requested review from a user, priteshbandi and shizhMSFT April 10, 2024 06:07
ghost
ghost previously approved these changes Apr 10, 2024
View reviewed changes
Copy link

@ghost ghost left a comment •
edited by ghost
Loading

Choose a reason for hiding this comment

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

LGTM

(the codecov failed though)

@JeyJeyGao
fix: improve test coverage
584ea42 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao requested a review from a user April 10, 2024 06:35
@JeyJeyGao
test: improve e2e
4617be1 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao
test: improve e2e test
b6828aa 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao
fix: update script
ca8ad88 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
priteshbandi
priteshbandi previously approved these changes Apr 10, 2024
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

@JeyJeyGao
test: improve e2e test
9facfa5 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
shizhMSFT
shizhMSFT approved these changes Apr 11, 2024
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

ghost
ghost approved these changes Apr 11, 2024
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

LGTM

@JeyJeyGao JeyJeyGao requested a review from priteshbandi April 12, 2024 01:15
@ghost ghost merged commit e5c210c into notaryproject:main Apr 18, 2024
This was referenced Jun 11, 2024
Merged
Merged
7h3-3mp7y-m4n pushed a commit to 7h3-3mp7y-m4n/notation that referenced this pull request Mar 29, 2025
@JeyJeyGao @7h3-3mp7y-m4n
fix: improve error message for --signature-format flag (notaryproject…
70aa9b4 
…#925)

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
FeynmanZhou pushed a commit to FeynmanZhou/notation that referenced this pull request May 15, 2025
@JeyJeyGao @FeynmanZhou
fix: improve error message for --signature-format flag (notaryproject…
c59ed88 
…#925)

Signed-off-by: Junjie Gao <junjiegao@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

@FeynmanZhou FeynmanZhou FeynmanZhou left review comments

@priteshbandi priteshbandi priteshbandi approved these changes

@shizhMSFT shizhMSFT shizhMSFT approved these changes

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

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

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

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

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

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

+1 more reviewer
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve error logs for notation sign

5 participants

@JeyJeyGao @codecov-commenter @priteshbandi @shizhMSFT @FeynmanZhou