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

refactor: improve metadata handler of oras cp #1624

Merged
merged 4 commits into from
Feb 19, 2025
Merged

refactor: improve metadata handler of oras cp #1624

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89b7e3b
improve metadata handler of oras cp
Feb 17, 2025
311c385
resolved comments
Feb 19, 2025
1bf3ce6
Merge branch 'main' into cp-handlers
Feb 19, 2025
2b8e4b6
resolved comments
Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cmd/oras/internal/display/metadata/interface.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,7 @@ type ManifestIndexUpdateHandler ManifestIndexCreateHandler
// CopyHandler handles metadata output for cp events.
type CopyHandler interface {
TaggedHandler
Renderer

OnCopied(fromRef string, toRef string, desc ocispec.Descriptor) error
}
12 changes: 12 additions & 0 deletions cmd/oras/internal/display/metadata/text/copy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
// CopyHandler handles text metadata output for cp events.
type CopyHandler struct {
printer *output.Printer
desc ocispec.Descriptor
}

// NewCopyHandler returns a new handler for cp events.
Expand All @@ -37,3 +38,14 @@ func NewCopyHandler(printer *output.Printer) metadata.CopyHandler {
func (h *CopyHandler) OnTagged(_ ocispec.Descriptor, tag string) error {
return h.printer.Println("Tagged", tag)
}

// Render implements metadata.Renderer.
func (h *CopyHandler) Render() error {
return h.printer.Println("Digest:", h.desc.Digest)
}

// OnCopied implements metadata.CopyHandler.
func (h *CopyHandler) OnCopied(fromRef string, toRef string, desc ocispec.Descriptor) error {
h.desc = desc
return h.printer.Println("Copied", fromRef, "=>", toRef)
}
9 changes: 5 additions & 4 deletions cmd/oras/root/cp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,10 @@
// correct source digest
opts.From.RawReference = fmt.Sprintf("%s@%s", opts.From.Path, desc.Digest.String())
}
_ = opts.Printer.Println("Copied", opts.From.AnnotatedReference(), "=>", opts.To.AnnotatedReference())

if err := metadataHandler.OnCopied(opts.From.AnnotatedReference(), opts.To.AnnotatedReference(), desc); err != nil {
return err
}

Check warning on line 147 in cmd/oras/root/cp.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/root/cp.go#L146-L147 

Added lines #L146 - L147 were not covered by tests

if len(opts.extraRefs) != 0 {
tagNOpts := oras.DefaultTagNOptions
Expand All @@ -152,9 +155,7 @@
}
}

_ = opts.Printer.Println("Digest:", desc.Digest)

return nil
return metadataHandler.Render()
}

func doCopy(ctx context.Context, copyHandler status.CopyHandler, src oras.ReadOnlyGraphTarget, dst oras.GraphTarget, opts *copyOptions) (desc ocispec.Descriptor, err error) {
Expand Down
Loading