From 25ce72a7131c8fba67d05e0c219f966cfff82d63 Mon Sep 17 00:00:00 2001 From: Junjie Gao Date: Thu, 13 Feb 2025 08:12:39 +0000 Subject: [PATCH] fix: resolve comments Signed-off-by: Junjie Gao --- cmd/notation/blob/inspect.go | 4 +++- cmd/notation/internal/display/metadata/interface.go | 4 ++-- .../internal/display/metadata/json/blob_inspect.go | 9 ++++----- cmd/notation/internal/display/metadata/json/inspect.go | 4 ++-- .../internal/display/metadata/tree/blob_inspect.go | 7 +++---- cmd/notation/internal/display/metadata/tree/inspect.go | 4 ++-- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/cmd/notation/blob/inspect.go b/cmd/notation/blob/inspect.go index 4c2a5aa32..55bc0f31e 100644 --- a/cmd/notation/blob/inspect.go +++ b/cmd/notation/blob/inspect.go @@ -63,15 +63,17 @@ Example - Inspect a signature: } func runInspect(opts *inspectOpts) error { + // initialize display handler displayHandler, err := display.NewBlobInspectHandler(opts.Printer, opts.Format) if err != nil { return err } + + // parse signature file envelopeMediaType, err := parseEnvelopeMediaType(filepath.Base(opts.sigPath)) if err != nil { return err } - envelopeBytes, err := os.ReadFile(opts.sigPath) if err != nil { return fmt.Errorf("failed to read signature file: %w", err) diff --git a/cmd/notation/internal/display/metadata/interface.go b/cmd/notation/internal/display/metadata/interface.go index ffb668059..6deb11da4 100644 --- a/cmd/notation/internal/display/metadata/interface.go +++ b/cmd/notation/internal/display/metadata/interface.go @@ -44,8 +44,8 @@ type InspectHandler interface { type BlobInspectHandler interface { Renderer - // OnEvelopeParsed sets the parsed envelope for the handler. - OnEnvelopeParsed(nodeName, envelopeMediaType string, envelope signature.Envelope) error + // OnEnvelopeParsed sets the parsed envelope for the handler. + OnEnvelopeParsed(signaturePath, signatureEnvelopeType string, envelope signature.Envelope) error } // VerifyHandler is a handler for rendering metadata information of diff --git a/cmd/notation/internal/display/metadata/json/blob_inspect.go b/cmd/notation/internal/display/metadata/json/blob_inspect.go index 759206bd2..07b0f627e 100644 --- a/cmd/notation/internal/display/metadata/json/blob_inspect.go +++ b/cmd/notation/internal/display/metadata/json/blob_inspect.go @@ -19,11 +19,10 @@ import ( ) // BlobInspectHandler is a handler for inspecting metadata information and -// rendering it in a JSON format. It implements the metadata.BlobInspectHandler +// rendering it in JSON format. It implements the metadata.BlobInspectHandler // interface. type BlobInspectHandler struct { - printer *output.Printer - + printer *output.Printer signature *signature } @@ -36,9 +35,9 @@ func NewBlobInspectHandler(printer *output.Printer) *BlobInspectHandler { } // OnEnvelopeParsed sets the parsed envelope for the handler. -func (h *BlobInspectHandler) OnEnvelopeParsed(nodeName, envelopeMediaType string, envelope coresignature.Envelope) error { +func (h *BlobInspectHandler) OnEnvelopeParsed(nodeName, signatureEnvelopeType string, envelope coresignature.Envelope) error { // blob signature does not have a digest - sig, err := newSignature("", envelopeMediaType, envelope) + sig, err := newSignature("", signatureEnvelopeType, envelope) if err != nil { return err } diff --git a/cmd/notation/internal/display/metadata/json/inspect.go b/cmd/notation/internal/display/metadata/json/inspect.go index 9e041dabd..5c103b3d2 100644 --- a/cmd/notation/internal/display/metadata/json/inspect.go +++ b/cmd/notation/internal/display/metadata/json/inspect.go @@ -106,7 +106,7 @@ func (h *InspectHandler) Render() error { } // newSignature parses the signature blob and returns a Signature object. -func newSignature(digest, envelopeMediaType string, sigEnvelope coresignature.Envelope) (*signature, error) { +func newSignature(digest, signatureEnvelopeType string, sigEnvelope coresignature.Envelope) (*signature, error) { envelopeContent, err := sigEnvelope.Content() if err != nil { return nil, err @@ -123,7 +123,7 @@ func newSignature(digest, envelopeMediaType string, sigEnvelope coresignature.En } sig := &signature{ Digest: digest, - SignatureEnvelopeType: envelopeMediaType, + SignatureEnvelopeType: signatureEnvelopeType, SignatureAlgorithm: string(signatureAlgorithm), SignedAttributes: getSignedAttributes(envelopeContent), UserDefinedAttributes: signedArtifactDesc.Annotations, diff --git a/cmd/notation/internal/display/metadata/tree/blob_inspect.go b/cmd/notation/internal/display/metadata/tree/blob_inspect.go index d02df35a4..942be7306 100644 --- a/cmd/notation/internal/display/metadata/tree/blob_inspect.go +++ b/cmd/notation/internal/display/metadata/tree/blob_inspect.go @@ -22,8 +22,7 @@ import ( // rendering it in a tree format. It implements the metadata.BlobInspectHandler // interface. type BlobInspectHandler struct { - printer *output.Printer - + printer *output.Printer signatureNode *node } @@ -36,8 +35,8 @@ func NewBlobInspectHandler(printer *output.Printer) *BlobInspectHandler { } // OnEnvelopeParsed sets the parsed envelope for the handler. -func (h *BlobInspectHandler) OnEnvelopeParsed(nodeName, envelopeMediaType string, envelope signature.Envelope) error { - sigNode, err := newSignatureNode(nodeName, envelopeMediaType, envelope) +func (h *BlobInspectHandler) OnEnvelopeParsed(signaturePath, signatureEnvelopeType string, envelope signature.Envelope) error { + sigNode, err := newSignatureNode(signaturePath, signatureEnvelopeType, envelope) if err != nil { return err } diff --git a/cmd/notation/internal/display/metadata/tree/inspect.go b/cmd/notation/internal/display/metadata/tree/inspect.go index 7cc1c3a5a..b3d609fdf 100644 --- a/cmd/notation/internal/display/metadata/tree/inspect.go +++ b/cmd/notation/internal/display/metadata/tree/inspect.go @@ -82,7 +82,7 @@ func (h *InspectHandler) Render() error { return h.rootReferenceNode.Print(h.printer) } -func newSignatureNode(nodeName, envelopeMediaType string, sigEnvelope coresignature.Envelope) (*node, error) { +func newSignatureNode(nodeName, signatureEnvelopeType string, sigEnvelope coresignature.Envelope) (*node, error) { envelopeContent, err := sigEnvelope.Content() if err != nil { return nil, err @@ -99,7 +99,7 @@ func newSignatureNode(nodeName, envelopeMediaType string, sigEnvelope coresignat // create signature node sigNode := newNode(nodeName) sigNode.AddPair("signature algorithm", string(signatureAlgorithm)) - sigNode.AddPair("signature envelope type", envelopeMediaType) + sigNode.AddPair("signature envelope type", signatureEnvelopeType) addSignedAttributes(sigNode, envelopeContent) addUserDefinedAttributes(sigNode, signedArtifactDesc.Annotations)