Skip to content

Commit

Permalink
resolved comments
Browse files Browse the repository at this point in the history
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
  • Loading branch information
Xiaoxuan Wang committed Oct 9, 2024
1 parent 8ea9b14 commit 16cf5ab
Show file tree
Hide file tree
Showing 11 changed files with 229 additions and 192 deletions.
26 changes: 6 additions & 20 deletions cmd/oras/internal/display/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -180,22 +180,15 @@ func NewManifestIndexCreateHandler(outputPath string, printer *output.Printer, p
metadata.ManifestIndexCreateHandler,
content.ManifestIndexCreateHandler,
error) {
var statusHandler status.ManifestIndexCreateHandler
var metadataHandler metadata.ManifestIndexCreateHandler
var contentHandler content.ManifestIndexCreateHandler
statusHandler := status.NewTextManifestIndexCreateHandler(printer)
metadataHandler := text.NewManifestIndexCreateHandler(printer)
contentHandler := content.NewManifestIndexCreateHandler(printer, pretty, outputPath)
switch outputPath {
case "":
statusHandler = status.NewTextManifestIndexCreateHandler(printer)
metadataHandler = text.NewManifestIndexCreateHandler(printer)
contentHandler = content.NewDiscardHandler()
case "-":
statusHandler = status.NewDiscardHandler()
metadataHandler = metadata.NewDiscardHandler()
contentHandler = content.NewManifestIndexCreateHandler(printer, pretty, outputPath)
default:
statusHandler = status.NewTextManifestIndexCreateHandler(printer)
metadataHandler = text.NewManifestIndexCreateHandler(printer)
contentHandler = content.NewManifestIndexCreateHandler(printer, pretty, outputPath)
}
return statusHandler, metadataHandler, contentHandler, nil
}
Expand All @@ -206,22 +199,15 @@ func NewManifestIndexUpdateHandler(outputPath string, printer *output.Printer, p
metadata.ManifestIndexUpdateHandler,
content.ManifestIndexUpdateHandler,
error) {
var statusHandler status.ManifestIndexUpdateHandler
var metadataHandler metadata.ManifestIndexUpdateHandler
var contentHandler content.ManifestIndexUpdateHandler
statusHandler := status.NewTextManifestIndexUpdateHandler(printer)
metadataHandler := text.NewManifestIndexUpdateHandler(printer)
contentHandler := content.NewManifestIndexCreateHandler(printer, pretty, outputPath)
switch outputPath {
case "":
statusHandler = status.NewTextManifestIndexUpdateHandler(printer)
metadataHandler = text.NewManifestIndexCreateHandler(printer)
contentHandler = content.NewDiscardHandler()
case "-":
statusHandler = status.NewDiscardHandler()
metadataHandler = metadata.NewDiscardHandler()
contentHandler = content.NewManifestIndexCreateHandler(printer, pretty, outputPath)
default:
statusHandler = status.NewTextManifestIndexUpdateHandler(printer)
metadataHandler = text.NewManifestIndexCreateHandler(printer)
contentHandler = content.NewManifestIndexCreateHandler(printer, pretty, outputPath)
}
return statusHandler, metadataHandler, contentHandler, nil
}
Expand Down
32 changes: 31 additions & 1 deletion cmd/oras/internal/display/metadata/discard.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,36 @@ func (discard) OnTagged(ocispec.Descriptor, string) error {
}

// OnCompleted implements ManifestIndexCreateHandler.
func (discard) OnCompleted(digest.Digest) error {
func (discard) OnCompleted(ocispec.Descriptor) error {
return nil
}

// OnIndexPacked implements ManifestIndexCreateHandler.
func (discard) OnIndexPacked(string) error {
return nil
}

// OnIndexPushed implements ManifestIndexCreateHandler.
func (discard) OnIndexPushed(string) error {
return nil

Check warning on line 52 in cmd/oras/internal/display/metadata/discard.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/internal/display/metadata/discard.go#L51-L52

Added lines #L51 - L52 were not covered by tests
}

// OnManifestRemoved implements ManifestIndexUpdateHandler.
func (discard) OnManifestRemoved(digest.Digest) error {
return nil

Check warning on line 57 in cmd/oras/internal/display/metadata/discard.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/internal/display/metadata/discard.go#L56-L57

Added lines #L56 - L57 were not covered by tests
}

// OnManifestAdded implements ManifestIndexUpdateHandler.
func (discard) OnManifestAdded(string, digest.Digest) error {
return nil
}

// OnIndexMerged implements ManifestIndexUpdateHandler.
func (discard) OnIndexMerged(string, digest.Digest) error {
return nil

Check warning on line 67 in cmd/oras/internal/display/metadata/discard.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/internal/display/metadata/discard.go#L66-L67

Added lines #L66 - L67 were not covered by tests
}

// OnIndexUpdated implements ManifestIndexUpdateHandler.
func (discard) OnIndexUpdated(digest.Digest) error {
return nil
}
14 changes: 12 additions & 2 deletions cmd/oras/internal/display/metadata/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,21 @@ type ManifestPushHandler interface {
// ManifestIndexCreateHandler handles metadata output for index create events.
type ManifestIndexCreateHandler interface {
TaggedHandler
OnCompleted(digest digest.Digest) error
OnIndexPacked(shortDigest string) error
OnIndexPushed(path string) error
OnCompleted(desc ocispec.Descriptor) error
}

// ManifestIndexUpdateHandler handles metadata output for index update events.
type ManifestIndexUpdateHandler ManifestIndexCreateHandler
type ManifestIndexUpdateHandler interface {
TaggedHandler
OnManifestRemoved(digest digest.Digest) error
OnManifestAdded(manifestRef string, digest digest.Digest) error
OnIndexMerged(indexRef string, digest digest.Digest) error
OnIndexUpdated(digest digest.Digest) error
OnIndexPushed(path string) error
OnCompleted(desc ocispec.Descriptor) error
}

// CopyHandler handles metadata output for cp events.
type CopyHandler interface {
Expand Down
108 changes: 108 additions & 0 deletions cmd/oras/internal/display/metadata/text/manifest_index.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/*
Copyright The ORAS Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package text

import (
"github.com/opencontainers/go-digest"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
"oras.land/oras/cmd/oras/internal/display/metadata"
"oras.land/oras/cmd/oras/internal/output"
"oras.land/oras/internal/contentutil"
)

// ManifestIndexCreateHandler handles text metadata output for index create events.
type ManifestIndexCreateHandler struct {
printer *output.Printer
}

// NewManifestIndexCreateHandler returns a new handler for index create events.
func NewManifestIndexCreateHandler(printer *output.Printer) metadata.ManifestIndexCreateHandler {
return &ManifestIndexCreateHandler{
printer: printer,
}
}

// OnIndexPacked implements metadata.ManifestIndexCreateHandler.
func (h *ManifestIndexCreateHandler) OnIndexPacked(shortDigest string) error {
return h.printer.Println("Packed", shortDigest, ocispec.MediaTypeImageIndex)
}

// OnIndexPushed implements metadata.ManifestIndexCreateHandler.
func (h *ManifestIndexCreateHandler) OnIndexPushed(path string) error {
return h.printer.Println("Pushed", path)
}

// OnTagged implements metadata.TaggedHandler.
func (h *ManifestIndexCreateHandler) OnTagged(_ ocispec.Descriptor, tag string) error {
return h.printer.Println("Tagged", tag)
}

// OnCompleted implements metadata.ManifestIndexCreateHandler.
func (h *ManifestIndexCreateHandler) OnCompleted(desc ocispec.Descriptor) error {
return h.printer.Println("Digest:", desc.Digest)
}

type ManifestIndexUpdateHandler struct {
printer *output.Printer
}

// NewManifestIndexUpdateHandler returns a new handler for index update events.
func NewManifestIndexUpdateHandler(printer *output.Printer) metadata.ManifestIndexUpdateHandler {
return &ManifestIndexUpdateHandler{
printer: printer,
}
}

// OnManifestRemoved implements metadata.ManifestIndexUpdateHandler.
func (miuh ManifestIndexUpdateHandler) OnManifestRemoved(digest digest.Digest) error {
return miuh.printer.Println("Removed", digest)
}

// OnManifestAdded implements metadata.ManifestIndexUpdateHandler.
func (miuh ManifestIndexUpdateHandler) OnManifestAdded(ref string, digest digest.Digest) error {
if contentutil.IsDigest(ref) {
return miuh.printer.Println("Added", ref)
}
return miuh.printer.Println("Added", digest, ref)

Check warning on line 79 in cmd/oras/internal/display/metadata/text/manifest_index.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/internal/display/metadata/text/manifest_index.go#L79

Added line #L79 was not covered by tests
}

// OnIndexMerged implements metadata.ManifestIndexUpdateHandler.
func (miuh ManifestIndexUpdateHandler) OnIndexMerged(ref string, digest digest.Digest) error {
if contentutil.IsDigest(ref) {
return miuh.printer.Println("Merged", ref)

Check warning on line 85 in cmd/oras/internal/display/metadata/text/manifest_index.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/internal/display/metadata/text/manifest_index.go#L85

Added line #L85 was not covered by tests
}
return miuh.printer.Println("Merged", digest, ref)
}

// OnIndexUpdated implements metadata.ManifestIndexUpdateHandler.
func (miuh ManifestIndexUpdateHandler) OnIndexUpdated(digest digest.Digest) error {
return miuh.printer.Println("Updated", digest)
}

// OnIndexPushed implements metadata.ManifestIndexUpdateHandler.
func (miuh ManifestIndexUpdateHandler) OnIndexPushed(indexRef string) error {
return miuh.printer.Println("Pushed", indexRef)
}

// OnTagged implements metadata.TaggedHandler.
func (h *ManifestIndexUpdateHandler) OnTagged(_ ocispec.Descriptor, tag string) error {
return h.printer.Println("Tagged", tag)
}

// OnCompleted implements metadata.ManifestIndexUpdateHandler.
func (h *ManifestIndexUpdateHandler) OnCompleted(desc ocispec.Descriptor) error {
return h.printer.Println("Digest:", desc.Digest)
}
45 changes: 0 additions & 45 deletions cmd/oras/internal/display/metadata/text/manifest_index_create.go

This file was deleted.

7 changes: 0 additions & 7 deletions cmd/oras/internal/display/status/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,6 @@ type CopyHandler interface {
type ManifestIndexCreateHandler interface {
OnSourceManifestFetching(source string) error
OnSourceManifestFetched(source string) error
OnIndexPacked(shortDigest string) error
OnIndexPushed(path string) error
}

// ManifestIndexUpdateHandler handles status output for manifest index update command.
Expand All @@ -78,9 +76,4 @@ type ManifestIndexUpdateHandler interface {
OnIndexFetched(indexRef string, digest digest.Digest) error
OnManifestFetching(manifestRef string) error
OnManifestFetched(manifestRef string, digest digest.Digest) error
OnManifestRemoved(digest digest.Digest) error
OnManifestAdded(manifestRef string, digest digest.Digest) error
OnIndexMerged(indexRef string, digest digest.Digest) error
OnIndexUpdated(digest digest.Digest) error
OnIndexPushed(path string) error
}
41 changes: 0 additions & 41 deletions cmd/oras/internal/display/status/text.go
Original file line number Diff line number Diff line change
Expand Up @@ -197,16 +197,6 @@ func (mich TextManifestIndexCreateHandler) OnSourceManifestFetched(source string
return mich.printer.Println(IndexPromptFetched, source)
}

// OnIndexPacked implements ManifestIndexCreateHandler.
func (mich TextManifestIndexCreateHandler) OnIndexPacked(shortDigest string) error {
return mich.printer.Println(IndexPromptPacked, shortDigest, ocispec.MediaTypeImageIndex)
}

// OnIndexPushed implements ManifestIndexCreateHandler.
func (mich TextManifestIndexCreateHandler) OnIndexPushed(path string) error {
return mich.printer.Println(IndexPromptPushed, path)
}

// NewTextManifestIndexCreateHandler returns a new handler for manifest index create command.
func NewTextManifestIndexCreateHandler(printer *output.Printer) ManifestIndexCreateHandler {
tmich := TextManifestIndexCreateHandler{
Expand Down Expand Up @@ -246,37 +236,6 @@ func (miuh TextManifestIndexUpdateHandler) OnManifestFetched(ref string, digest
return miuh.printer.Println(IndexPromptFetched, digest, ref)

Check warning on line 236 in cmd/oras/internal/display/status/text.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/internal/display/status/text.go#L236

Added line #L236 was not covered by tests
}

// OnManifestRemoved implements ManifestIndexUpdateHandler.
func (miuh TextManifestIndexUpdateHandler) OnManifestRemoved(digest digest.Digest) error {
return miuh.printer.Println(IndexPromptRemoved, digest)
}

// OnManifestAdded implements ManifestIndexUpdateHandler.
func (miuh TextManifestIndexUpdateHandler) OnManifestAdded(ref string, digest digest.Digest) error {
if contentutil.IsDigest(ref) {
return miuh.printer.Println(IndexPromptAdded, ref)
}
return miuh.printer.Println(IndexPromptAdded, digest, ref)
}

// OnIndexMerged implements ManifestIndexUpdateHandler.
func (miuh TextManifestIndexUpdateHandler) OnIndexMerged(ref string, digest digest.Digest) error {
if contentutil.IsDigest(ref) {
return miuh.printer.Println(IndexPromptMerged, ref)
}
return miuh.printer.Println(IndexPromptMerged, digest, ref)
}

// OnIndexUpdated implements ManifestIndexUpdateHandler.
func (miuh TextManifestIndexUpdateHandler) OnIndexUpdated(digest digest.Digest) error {
return miuh.printer.Println(IndexPromptUpdated, digest)
}

// OnIndexPushed implements ManifestIndexUpdateHandler.
func (miuh TextManifestIndexUpdateHandler) OnIndexPushed(indexRef string) error {
return miuh.printer.Println(IndexPromptPushed, indexRef)
}

// NewTextManifestIndexUpdateHandler returns a new handler for manifest index create command.
func NewTextManifestIndexUpdateHandler(printer *output.Printer) ManifestIndexUpdateHandler {
miuh := TextManifestIndexUpdateHandler{
Expand Down
6 changes: 0 additions & 6 deletions cmd/oras/internal/display/status/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,6 @@ const (
const (
IndexPromptFetching = "Fetching "
IndexPromptFetched = "Fetched "
IndexPromptAdded = "Added "
IndexPromptMerged = "Merged "
IndexPromptRemoved = "Removed "
IndexPromptPacked = "Packed "
IndexPromptPushed = "Pushed "
IndexPromptUpdated = "Updated "
)

// DeduplicatedFilter filters out deduplicated descriptors.
Expand Down
6 changes: 3 additions & 3 deletions cmd/oras/root/manifest/index/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +132,18 @@ func createIndex(cmd *cobra.Command, opts createOptions) error {
return err
}
desc := content.NewDescriptorFromBytes(ocispec.MediaTypeImageIndex, indexBytes)
if err := displayStatus.OnIndexPacked(descriptor.ShortDigest(desc)); err != nil {
if err := displayMetadata.OnIndexPacked(descriptor.ShortDigest(desc)); err != nil {
return err

Check warning on line 136 in cmd/oras/root/manifest/index/create.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/root/manifest/index/create.go#L136

Added line #L136 was not covered by tests
}
if err := displayContent.OnContentCreated(indexBytes); err != nil {
return err

Check warning on line 139 in cmd/oras/root/manifest/index/create.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/root/manifest/index/create.go#L139

Added line #L139 was not covered by tests
}
if opts.outputPath == "" {
if err := pushIndex(ctx, displayStatus.OnIndexPushed, displayMetadata.OnTagged, target, desc, indexBytes, opts.Reference, opts.extraRefs, opts.AnnotatedReference()); err != nil {
if err := pushIndex(ctx, displayMetadata.OnIndexPushed, displayMetadata.OnTagged, target, desc, indexBytes, opts.Reference, opts.extraRefs, opts.AnnotatedReference()); err != nil {
return err

Check warning on line 143 in cmd/oras/root/manifest/index/create.go

View check run for this annotation

Codecov / codecov/patch

cmd/oras/root/manifest/index/create.go#L143

Added line #L143 was not covered by tests
}
}
return displayMetadata.OnCompleted(desc.Digest)
return displayMetadata.OnCompleted(desc)
}

func fetchSourceManifests(ctx context.Context, displayStatus status.ManifestIndexCreateHandler, target oras.ReadOnlyTarget, sources []string) ([]ocispec.Descriptor, error) {
Expand Down
Loading

0 comments on commit 16cf5ab

Please sign in to comment.