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

fix: warning message is printed to stdout by CLI #1650

Merged
merged 17 commits into from
Aug 1, 2024

Conversation

susanshi
Copy link
Collaborator

@susanshi susanshi commented Jul 23, 2024

Description

What this PR does / why we need it:

Currently we are printing warning log out to stdout which pollutes the json verification output.
This PR contains following update:

  • Warning should be logged using the logger.
  • added a unit test file for cli cmd. However the cli command currently is not unit testable, the test currently only validates the command exist.

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #1565

Type of change

Please delete options that are not relevant.

  • [X ] Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Validated the output only contains the verification result json. The warning is now logged ot stderr.

image

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Copy link

codecov bot commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files Coverage Δ
cmd/ratify/cmd/discover.go 32.09% <100.00%> (+13.58%) ⬆️
cmd/ratify/cmd/referrer.go 49.15% <100.00%> (+16.94%) ⬆️
cmd/ratify/cmd/verify.go 75.00% <100.00%> (+8.92%) ⬆️
internal/logger/logger.go 100.00% <ø> (ø)

@susanshi susanshi marked this pull request as ready for review July 29, 2024 07:18
Copy link
Collaborator

@junczhu junczhu left a comment

Choose a reason for hiding this comment

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

LGTM

@susanshi
Copy link
Collaborator Author

todo: Add issue for improve unit test for cli

@binbin-li
Copy link
Collaborator

todo: Add issue for improve unit test for cli

Can you add the reference to notation CLI test in the issue? https://github.com/notaryproject/notation/tree/main/cmd/notation
Adding unit test for CMDs could be quite effort-intensive.

Copy link
Collaborator

@binbin-li binbin-li left a comment

Choose a reason for hiding this comment

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

lgtm!

@susanshi susanshi enabled auto-merge (squash) August 1, 2024 01:11
@susanshi susanshi merged commit 7294999 into ratify-project:dev Aug 1, 2024
18 checks passed
akashsinghal pushed a commit to akashsinghal/ratify that referenced this pull request Sep 13, 2024
binbin-li pushed a commit to binbin-li/ratify that referenced this pull request Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warning message is printed to stdout by CLI
3 participants