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

Jump to bottom

housekeeping: refactoring for sustainable coding #1151

Open
2 of 7 tasks
JeyJeyGao opened this issue Jan 17, 2025 · 1 comment
Open
2 of 7 tasks

housekeeping: refactoring for sustainable coding #1151

JeyJeyGao opened this issue Jan 17, 2025 · 1 comment
Assignees
@JeyJeyGao
Labels
enhancement New feature or request

Comments

@JeyJeyGao
Copy link
Contributor

JeyJeyGao commented Jan 17, 2025 •
edited
Loading

command output refactoring

Input flags code refactoring

  • refactor common flags: logging flags, secure flags
  • refactor sign command flags
  • refactor verify command flags
  • refactor other commands flags
@JeyJeyGao JeyJeyGao added the enhancement New feature or request label Jan 17, 2025
@JeyJeyGao JeyJeyGao self-assigned this Jan 17, 2025
@JeyJeyGao JeyJeyGao mentioned this issue Jan 20, 2025
Merged
@JeyJeyGao
Copy link
Contributor Author

As suggested by @shizhMSFT . We need to enhance the code https://github.com/notaryproject/notation/pull/1150/files#r1922159179

@shizhMSFT shizhMSFT changed the title Refactor works housekeeping: refactoring for sustainable coding Jan 21, 2025
JeyJeyGao added a commit that referenced this issue Feb 7, 2025
@JeyJeyGao
refactor: extract inspect rendering logic to be display handlers (#1150)
80cb6ee 
Depends on spec change: #1156 

Refactor:
- Extract output formatting logic from the inspect command layer to an
isolated display handler layer for processing rendering.
- Add `json` and `tree` inspect handlers.

Fix:
- For `tree` output, make the key names with multiple words separated by
space characters rather than capitalizing the words, which is defined in
the [inspect command
spec](https://github.com/notaryproject/notation/blob/v1.2.0/specs/commandline/inspect.md#inspect-signatures-on-the-supplied-oci-artifact-identified-by-the-digest).
- For `json` output, default to rendering time in RFC3339 with
nanoseconds (Notation expiry, signing time and certificate expiry are
accurate to 1 second. Timestamp [RFC
3161](https://www.rfc-editor.org/rfc/rfc3161#section-2.4.2) can have
fraction-of-second time value).

E2E Test:
- inspect signature with timestamp, signature expiry and user metadata
(text, json)
- inspect signatures with invalid timestamp (test, json)
- inspect with `-o` shorthand.

Resolves part of #1151

---------

Signed-off-by: Junjie Gao <[email protected]>
@JeyJeyGao JeyJeyGao mentioned this issue Feb 8, 2025
Merged
JeyJeyGao added a commit that referenced this issue Feb 11, 2025
@JeyJeyGao
refactor: verify display handler (#1167)
73b1551 
Refactor:
- move the verify command output related logic to be `VerifyHandler`

Example:
```sh
notation verify notationreg.azurecr.io/hello-world:v1
Warning: Always verify the artifact using digest(@sha256:...) rather than a tag(:v1) because resolved digest may not point to the same signed artifact, as tags are mutable.

Successfully verified signature for notationreg.azurecr.io/hello-world@sha256:d37ada95d47ad12224c205a938129df7a3e52345828b4fa27b03a98825d1e2e7

The artifact was signed with the following user metadata.

KEY   VALUE
foo   bar
```

Resolve part of #1151

---------

Signed-off-by: Junjie Gao <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JeyJeyGao JeyJeyGao

Labels
enhancement New feature or request
Projects
Notary Project Planning Board
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JeyJeyGao