Issue 420 - Adds progress bar for image push

carvel-dev · Aug 4, 2022 · e7166ad · e7166ad
1 parent c6fae29
commit e7166ad
Show file tree

Hide file tree

Showing 8 changed files with 195 additions and 11 deletions.
diff --git a/pkg/imgpkg/bundle/bundlefakes/fake_images_metadata_writer.go b/pkg/imgpkg/bundle/bundlefakes/fake_images_metadata_writer.go
diff --git a/pkg/imgpkg/bundle/contents.go b/pkg/imgpkg/bundle/contents.go
@@ -31,6 +31,7 @@ type Contents struct {
 type ImagesMetadataWriter interface {
 	ImagesMetadata
 	WriteImage(regname.Reference, regv1.Image) error
+	WriteImageWithProgress(regname.Reference, regv1.Image, chan regv1.Update) error
 	WriteTag(ref regname.Tag, taggagle regremote.Taggable) error
 }
 
@@ -45,7 +46,7 @@ func (b Contents) Push(uploadRef regname.Tag, registry ImagesMetadataWriter, ui
 	}
 
 	labels := map[string]string{BundleConfigLabel: "true"}
-	return plainimage.NewContents(b.paths, b.excludedPaths).Push(uploadRef, labels, registry, ui)
+	return plainimage.NewContents(b.paths, b.excludedPaths, false).Push(uploadRef, labels, registry, ui)
 }
 
 func (b Contents) PresentsAsBundle() (bool, error) {

diff --git a/pkg/imgpkg/bundle/locations_configs.go b/pkg/imgpkg/bundle/locations_configs.go
@@ -132,7 +132,7 @@ func (r LocationsConfigs) Save(reg ImagesMetadataWriter, bundleRef name.Digest,
 
 	r.ui.Tracef("Pushing image\n")
 
-	_, err = plainimage.NewContents([]string{tmpDir}, nil).Push(locRef, nil, reg, ui)
+	_, err = plainimage.NewContents([]string{tmpDir}, nil, false).Push(locRef, nil, reg, ui)
 	if err != nil {
 		// Immutable tag errors within registries are not standardized.
 		// Assume word "immutable" would be present in most cases.

diff --git a/pkg/imgpkg/cmd/push.go b/pkg/imgpkg/cmd/push.go
@@ -138,5 +138,5 @@ func (po *PushOptions) pushImage(registry registry.Registry) (string, error) {
 		return "", fmt.Errorf("Images cannot be pushed with '.imgpkg' directories, consider using --bundle (-b) option")
 	}
 
-	return plainimage.NewContents(po.FileFlags.Files, po.FileFlags.ExcludedFilePaths).Push(uploadRef, nil, registry, po.ui)
+	return plainimage.NewContents(po.FileFlags.Files, po.FileFlags.ExcludedFilePaths, false).Push(uploadRef, nil, registry, po.ui)
 }
diff --git a/pkg/imgpkg/plainimage/contents.go b/pkg/imgpkg/plainimage/contents.go
@@ -18,17 +18,21 @@ import (
 )
 
 type Contents struct {
-	paths         []string
-	excludedPaths []string
+	paths           []string
+	excludedPaths   []string
+	displayProgress bool
 }
 
 type ImagesWriter interface {
 	WriteImage(regname.Reference, regv1.Image) error
+	WriteImageWithProgress(regname.Reference, regv1.Image, chan regv1.Update) error
 	WriteTag(ref regname.Tag, taggagle regremote.Taggable) error
 }
 
-func NewContents(paths []string, excludedPaths []string) Contents {
-	return Contents{paths: paths, excludedPaths: excludedPaths}
+// NewContents constructor to build a plainimage contents responsible for creating and pushing images,
+// by setting displayProgress to 'true' printing out a progress bar using updates when writing to a registry via ggcr
+func NewContents(paths []string, excludedPaths []string, displayProgress bool) Contents {
+	return Contents{paths: paths, excludedPaths: excludedPaths, displayProgress: displayProgress}
 }
 
 func (i Contents) Push(uploadRef regname.Tag, labels map[string]string, writer ImagesWriter, ui ui.UI) (string, error) {
@@ -46,7 +50,11 @@ func (i Contents) Push(uploadRef regname.Tag, labels map[string]string, writer I
 
 	defer img.Remove()
 
-	err = writer.WriteImage(uploadRef, img)
+	if i.displayProgress {
+		err = writer.WriteImageWithProgress(uploadRef, img, nil)
+	} else {
+		err = writer.WriteImage(uploadRef, img)
+	}
 	if err != nil {
 		return "", fmt.Errorf("Writing '%s': %s", uploadRef.Name(), err)
 	}

diff --git a/pkg/imgpkg/registry/registry.go b/pkg/imgpkg/registry/registry.go
@@ -50,7 +50,8 @@ type Registry interface {
 	FirstImageExists(digests []string) (string, error)
 
 	MultiWrite(imageOrIndexesToUpload map[regname.Reference]regremote.Taggable, concurrency int, updatesCh chan regv1.Update) error
-	WriteImage(reference regname.Reference, image regv1.Image) error
+	WriteImage(regname.Reference, regv1.Image) error
+	WriteImageWithProgress(regname.Reference, regv1.Image, chan regv1.Update) error
 	WriteIndex(reference regname.Reference, index regv1.ImageIndex) error
 	WriteTag(tag regname.Tag, taggable regremote.Taggable) error
 
@@ -75,6 +76,7 @@ type ImagesReaderWriter interface {
 	ImagesReader
 	MultiWrite(imageOrIndexesToUpload map[regname.Reference]regremote.Taggable, concurrency int, updatesCh chan regv1.Update) error
 	WriteImage(regname.Reference, regv1.Image) error
+	WriteImageWithProgress(regname.Reference, regv1.Image, chan regv1.Update) error
 	WriteIndex(regname.Reference, regv1.ImageIndex) error
 	WriteTag(regname.Tag, regremote.Taggable) error
 
@@ -318,8 +320,8 @@ func (r *SimpleRegistry) MultiWrite(imageOrIndexesToUpload map[regname.Reference
 	return regremote.MultiWrite(overriddenImageOrIndexesToUploadRef, rOpts...)
 }
 
-// WriteImage Upload Image to registry
-func (r *SimpleRegistry) WriteImage(ref regname.Reference, img regv1.Image) error {
+// WriteImageWithProgress Upload Image to registry
+func (r *SimpleRegistry) WriteImageWithProgress(ref regname.Reference, img regv1.Image, updatesCh chan regv1.Update) error {
 	if err := r.validateRef(ref); err != nil {
 		return err
 	}
@@ -332,6 +334,9 @@ func (r *SimpleRegistry) WriteImage(ref regname.Reference, img regv1.Image) erro
 	if err != nil {
 		return err
 	}
+	if updatesCh != nil {
+		opts = append(opts, regremote.WithProgress(updatesCh))
+	}
 
 	err = regremote.Write(overriddenRef, img, opts...)
 	if err != nil {
@@ -341,6 +346,11 @@ func (r *SimpleRegistry) WriteImage(ref regname.Reference, img regv1.Image) erro
 	return nil
 }
 
+// WriteImage Upload Image to registry
+func (r *SimpleRegistry) WriteImage(ref regname.Reference, img regv1.Image) error {
+	return r.WriteImageWithProgress(ref, img, nil)
+}
+
 // Index Retrieve regv1.ImageIndex struct for an Index reference
 func (r *SimpleRegistry) Index(ref regname.Reference) (regv1.ImageIndex, error) {
 	if err := r.validateRef(ref); err != nil {

diff --git a/pkg/imgpkg/registry/registryfakes/fake_images_reader_writer.go b/pkg/imgpkg/registry/registryfakes/fake_images_reader_writer.go
diff --git a/pkg/imgpkg/registry/with_progress.go b/pkg/imgpkg/registry/with_progress.go
@@ -56,6 +56,15 @@ func (w *WithProgress) MultiWrite(imageOrIndexesToUpload map[regname.Reference]r
 	return w.delegate.MultiWrite(imageOrIndexesToUpload, concurrency, uploadProgress)
 }
 
+// WriteImageWithProgress Upload Image to registry
+func (w *WithProgress) WriteImageWithProgress(reference regname.Reference, image regv1.Image, _ chan regv1.Update) error {
+	uploadProgress := make(chan regv1.Update)
+	w.logger.Start(uploadProgress)
+	defer w.logger.End()
+
+	return w.delegate.WriteImageWithProgress(reference, image, uploadProgress)
+}
+
 // WriteImage Upload Image to registry
 func (w *WithProgress) WriteImage(reference regname.Reference, image regv1.Image) error {
 	return w.delegate.WriteImage(reference, image)