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

refactor: apply metadata render interface to oras discover command #1605

Merged
merged 3 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions cmd/oras/internal/display/metadata/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ type AttachHandler interface {

// DiscoverHandler handles metadata output for discover events.
type DiscoverHandler interface {
Renderer

// MultiLevelSupported returns true if the handler supports multi-level
// discovery.
MultiLevelSupported() bool
// OnDiscovered is called after a referrer is discovered.
OnDiscovered(referrer, subject ocispec.Descriptor) error
// OnCompleted is called when referrer discovery is completed.
OnCompleted() error
}

// ManifestFetchHandler handles metadata output for manifest fetch events.
Expand Down
4 changes: 2 additions & 2 deletions cmd/oras/internal/display/metadata/json/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func (h *discoverHandler) OnDiscovered(referrer, subject ocispec.Descriptor) err
return nil
}

// OnCompleted implements metadata.DiscoverHandler.
func (h *discoverHandler) OnCompleted() error {
// Render implements metadata.DiscoverHandler.
func (h *discoverHandler) Render() error {
return output.PrintPrettyJSON(h.out, model.NewDiscover(h.path, h.referrers))
}
4 changes: 2 additions & 2 deletions cmd/oras/internal/display/metadata/table/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ func (h *discoverHandler) OnDiscovered(referrer, subject ocispec.Descriptor) err
return nil
}

// OnCompleted implements metadata.DiscoverHandler.
func (h *discoverHandler) OnCompleted() error {
// Render implements metadata.DiscoverHandler.
func (h *discoverHandler) Render() error {
if n := len(h.referrers); n > 1 {
fmt.Fprintln(h.out, "Discovered", n, "artifacts referencing", h.rawReference)
} else {
Expand Down
4 changes: 2 additions & 2 deletions cmd/oras/internal/display/metadata/template/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func (h *discoverHandler) OnDiscovered(referrer, subject ocispec.Descriptor) err
return nil
}

// OnCompleted implements metadata.DiscoverHandler.
func (h *discoverHandler) OnCompleted() error {
// Render implements metadata.DiscoverHandler.
func (h *discoverHandler) Render() error {
return output.ParseAndWrite(h.out, model.NewDiscover(h.path, h.referrers), h.template)
}
4 changes: 2 additions & 2 deletions cmd/oras/internal/display/metadata/tree/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func (h *discoverHandler) OnDiscovered(referrer, subject ocispec.Descriptor) err
return nil
}

// OnCompleted implements metadata.DiscoverHandler.
func (h *discoverHandler) OnCompleted() error {
// Render implements metadata.DiscoverHandler.
func (h *discoverHandler) Render() error {
return tree.NewPrinter(h.out).Print(h.root)
}
2 changes: 1 addition & 1 deletion cmd/oras/root/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ func runDiscover(cmd *cobra.Command, opts *discoverOptions) error {
}
}
}
return handler.OnCompleted()
return handler.Render()
}

func fetchAllReferrers(ctx context.Context, repo oras.ReadOnlyGraphTarget, desc ocispec.Descriptor, artifactType string, handler metadata.DiscoverHandler) error {
Expand Down
Loading