refactor: extract inspect rendering logic to be display handlers #1150
Conversation
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1150 +/- ##
==========================================
+ Coverage 73.30% 74.48% +1.18%
==========================================
Files 53 60 +7
Lines 3240 3363 +123
==========================================
+ Hits 2375 2505 +130
+ Misses 671 664 -7
Partials 194 194 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
JeyJeyGao
requested review from
gokarnm,
NiazFK,
priteshbandi,
rgnote,
toddysm,
Two-Hearts,
vaninrao10 and
yizha1
as code owners
JeyJeyGao
changed the title
| "github.com/spf13/pflag" | ||
| ) | ||
|
|
||
| type FormatType string |
There was a problem hiding this comment.
code style: require docs on exposed type
| func (f *Format) ApplyFlags(fs *pflag.FlagSet) { | ||
| var quotedAllowedTypes []string | ||
| for _, t := range f.allowedTypes { | ||
| quotedAllowedTypes = append(quotedAllowedTypes, fmt.Sprintf("'%s'", t)) | ||
| } | ||
| usage := fmt.Sprintf("output format, options: %s", strings.Join(quotedAllowedTypes, ", ")) | ||
| // apply flags | ||
| fs.StringVar(&f.FormatFlag, "output", f.FormatFlag, usage) | ||
| } |
There was a problem hiding this comment.
note: we need to enhance this later in v2
| // Common option struct. | ||
| type Common struct { | ||
| Printer *output.Printer | ||
| } |
There was a problem hiding this comment.
Will you refactor --debug in later PRs?
| if err := opts.Format.Parse(cmd); err != nil { | ||
| return err | ||
| } | ||
| if err := opts.Common.Parse(cmd); err != nil { | ||
| return err | ||
| } |
There was a problem hiding this comment.
| OnReferenceResolved(reference, mediaType string) | ||
|
|
||
| // InspectSignature inspects a signature to get it ready to be rendered. | ||
| InspectSignature(digest string, envelopeMediaType string, sigEnvelope signature.Envelope) error |
There was a problem hiding this comment.
This line is not updated as expected as #1150 (comment)
Note: It is OK to pass the related object which is not fully printed.
| printer *output.Printer | ||
|
|
||
| root *tree.Node | ||
| cncfSigNode *tree.Node |
There was a problem hiding this comment.
The field name cncfSigNode is confusing. Let's consider a better name.
| // mediaType is a no-op for this handler. | ||
| func (h *InspectHandler) OnReferenceResolved(reference, mediaType string) { |
There was a problem hiding this comment.
| // mediaType is a no-op for this handler. | |
| func (h *InspectHandler) OnReferenceResolved(reference, mediaType string) { | |
| func (h *InspectHandler) OnReferenceResolved(reference, _ string) { |
| if h.root == nil || h.cncfSigNode == nil { | ||
| return fmt.Errorf("artifact reference is not set") | ||
| } |
There was a problem hiding this comment.
They are not reachable, aren't they?
| if h.root == nil { | ||
| return fmt.Errorf("artifact reference is not set") | ||
| } |
There was a problem hiding this comment.
They are not reachable, aren't they?
| // | ||
| // mediaType is a no-op for this handler. | ||
| func (h *InspectHandler) OnReferenceResolved(reference, mediaType string) { | ||
| if h.root == nil { |
There was a problem hiding this comment.
It is unnecessary to check h.root.
Refactor:
jsonandtreeinspect handlers.Fix:
treeoutput, make the key names with multiple words separated by space characters rather than capitalizing the words, which is defined in the inspect command spec.jsonoutput, default to rendering time in RFC3339 with nanoseconds (Notation expiry, signing time and certificate expiry are accurate to 1 second. Timestamp RFC 3161 can have fraction-of-second time value).Test:
Resolves part of #1151