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

Jump to bottom

Adds progress bar for image push #421

Merged
merged 3 commits into from
Aug 11, 2022
Merged

Adds progress bar for image push #421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41f257a
Issue 420 - Adds progress bar for image push
shaheerkootteeri Jul 27, 2022
bbcc0d1
fixes the end to E2E test failures
shaheerkootteeri Aug 8, 2022
75cdcd7
adds review comments
shaheerkootteeri Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
94 changes: 86 additions & 8 deletions pkg/imgpkg/bundle/bundlefakes/fake_images_metadata_writer.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion pkg/imgpkg/bundle/contents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ import (
regname "github.com/google/go-containerregistry/pkg/name"
regv1 "github.com/google/go-containerregistry/pkg/v1"
regremote "github.com/google/go-containerregistry/pkg/v1/remote"
"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/internal/util"
"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/plainimage"
"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/registry"
)

const (
Expand All @@ -30,8 +32,9 @@ type Contents struct {
//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 . ImagesMetadataWriter
type ImagesMetadataWriter interface {
ImagesMetadata
WriteImage(regname.Reference, regv1.Image) error
WriteImage(regname.Reference, regv1.Image, chan regv1.Update) error
WriteTag(ref regname.Tag, taggagle regremote.Taggable) error
CloneWithLogger(logger util.ProgressLogger) registry.Registry
}

func NewContents(paths []string, excludedPaths []string) Contents {
Expand Down
2 changes: 1 addition & 1 deletion pkg/imgpkg/bundle/locations_configs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).Push(locRef, nil, reg.CloneWithLogger(util.NewNoopProgressBar()), ui)
if err != nil {
// Immutable tag errors within registries are not standardized.
// Assume word "immutable" would be present in most cases.
Expand Down
45 changes: 32 additions & 13 deletions pkg/imgpkg/internal/util/progress_logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,40 @@ import (
"github.com/mattn/go-isatty"
)

// ProgressLogger Progress bar
type ProgressLogger interface {
Start(progress <-chan regv1.Update)
Start(ctx context.Context, progress <-chan regv1.Update)
End()
}

// NewProgressBar constructor to build a ProgressLogger responsible for printing out a progress bar using updates when
// writing to a registry via ggcr
func NewProgressBar(ui goui.UI, finalMessage, errorMessagePrefix string) ProgressLogger {
ctx, cancel := context.WithCancel(context.Background())
if isatty.IsTerminal(os.Stdout.Fd()) {
return &ProgressBarLogger{ctx: ctx, cancelFunc: cancel, ui: ui, finalMessage: finalMessage, errorMessagePrefix: errorMessagePrefix}
return &ProgressBarLogger{ui: ui, finalMessage: finalMessage, errorMessagePrefix: errorMessagePrefix}
}

return &ProgressBarNoTTYLogger{ui: ui, ctx: ctx, cancelFunc: cancel, finalMessage: finalMessage}
return &ProgressBarNoTTYLogger{ui: ui, finalMessage: finalMessage}
}

// NewNoopProgressBar constructs a Noop Progress bar that will not display anything
func NewNoopProgressBar() ProgressLogger {
return &ProgressBarNoTTYLogger{}
}

// ProgressBarLogger display progress bar on output
type ProgressBarLogger struct {
ctx context.Context
cancelFunc context.CancelFunc
bar *pb.ProgressBar
ui goui.UI
finalMessage string
errorMessagePrefix string
}

func (l *ProgressBarLogger) Start(progressChan <-chan regv1.Update) {
// Start the display of the Progress Bar
func (l *ProgressBarLogger) Start(ctx context.Context, progressChan <-chan regv1.Update) {
ctx, cancelFunc := context.WithCancel(ctx)
l.cancelFunc = cancelFunc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

im assuming we are not using ProgressBarLogger concurrently?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No we are not using

// Add a new empty line to separate the progress bar from prior output
fmt.Println()
l.bar = pb.New64(0)
Expand All @@ -48,7 +56,7 @@ func (l *ProgressBarLogger) Start(progressChan <-chan regv1.Update) {
go func() {
for {
select {
case <-l.ctx.Done():
case <-ctx.Done():
return
case update := <-progressChan:
if update.Error != nil {
Expand All @@ -70,32 +78,43 @@ func (l *ProgressBarLogger) Start(progressChan <-chan regv1.Update) {
}()
}

// End stops the progress bar and writes the final message
func (l *ProgressBarLogger) End() {
l.cancelFunc()
if l.cancelFunc != nil {
l.cancelFunc()
}
l.bar.Finish()
l.ui.BeginLinef("\n%s", l.finalMessage)
}

// ProgressBarNoTTYLogger does not display the progress bar
type ProgressBarNoTTYLogger struct {
ctx context.Context
cancelFunc context.CancelFunc
ui goui.UI
finalMessage string
}

func (l *ProgressBarNoTTYLogger) Start(progressChan <-chan regv1.Update) {
// Start consuming the progress channel but does not display anything
func (l *ProgressBarNoTTYLogger) Start(ctx context.Context, progressChan <-chan regv1.Update) {
ctx, cancelFunc := context.WithCancel(ctx)
l.cancelFunc = cancelFunc
go func() {
for {
select {
case <-l.ctx.Done():
case <-ctx.Done():
return
case <-progressChan:
}
}
}()
}

// End Write the final message
func (l *ProgressBarNoTTYLogger) End() {
l.cancelFunc()
l.ui.BeginLinef(l.finalMessage)
if l.cancelFunc != nil {
l.cancelFunc()
}
if l.ui != nil && l.finalMessage != "" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to check on l.ui != nil here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the case of a NOOP progress logger as part of the bundle push , we are not passing any UI as there will not be any progress bar displaying. However we could have the same accepting ui as well and we would need the nil check to decide if possible to display final message.

l.ui.BeginLinef(l.finalMessage)
}
}
5 changes: 3 additions & 2 deletions pkg/imgpkg/plainimage/contents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type Contents struct {
}

type ImagesWriter interface {
WriteImage(regname.Reference, regv1.Image) error
WriteImage(regname.Reference, regv1.Image, chan regv1.Update) error
WriteTag(ref regname.Tag, taggagle regremote.Taggable) error
}

Expand All @@ -46,7 +46,8 @@ func (i Contents) Push(uploadRef regname.Tag, labels map[string]string, writer I

defer img.Remove()

err = writer.WriteImage(uploadRef, img)
err = writer.WriteImage(uploadRef, img, nil)

if err != nil {
return "", fmt.Errorf("Writing '%s': %s", uploadRef.Name(), err)
}
Expand Down
25 changes: 21 additions & 4 deletions pkg/imgpkg/registry/registry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
regv1 "github.com/google/go-containerregistry/pkg/v1"
regremote "github.com/google/go-containerregistry/pkg/v1/remote"
"github.com/google/go-containerregistry/pkg/v1/remote/transport"
"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/internal/util"
"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/registry/auth"
)

Expand Down Expand Up @@ -50,13 +51,14 @@ 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, chan regv1.Update) error
WriteIndex(reference regname.Reference, index regv1.ImageIndex) error
WriteTag(tag regname.Tag, taggable regremote.Taggable) error

ListTags(repo regname.Repository) ([]string, error)

CloneWithSingleAuth(imageRef regname.Tag) (Registry, error)
CloneWithLogger(logger util.ProgressLogger) Registry
}

// ImagesReader Interface for Reading Images
Expand All @@ -74,11 +76,12 @@ type ImagesReader interface {
type ImagesReaderWriter interface {
ImagesReader
MultiWrite(imageOrIndexesToUpload map[regname.Reference]regremote.Taggable, concurrency int, updatesCh chan regv1.Update) error
WriteImage(regname.Reference, regv1.Image) error
WriteImage(regname.Reference, regv1.Image, chan regv1.Update) error
WriteIndex(regname.Reference, regv1.ImageIndex) error
WriteTag(regname.Tag, regremote.Taggable) error

CloneWithSingleAuth(imageRef regname.Tag) (Registry, error)
CloneWithLogger(logger util.ProgressLogger) Registry
}

var _ Registry = &SimpleRegistry{}
Expand Down Expand Up @@ -190,6 +193,18 @@ func (r SimpleRegistry) CloneWithSingleAuth(imageRef regname.Tag) (Registry, err
}, nil
}

// CloneWithLogger Clones the provided registry updating the progress logger to NoTTYLogger
// that does not display the progress bar
func (r SimpleRegistry) CloneWithLogger(_ util.ProgressLogger) Registry {
return &SimpleRegistry{
remoteOpts: r.remoteOpts,
refOpts: r.refOpts,
keychain: r.keychain,
roundTrippers: r.roundTrippers,
transportAccess: &sync.Mutex{},
}
}

// readOpts Returns the readOpts + the keychain
func (r *SimpleRegistry) readOpts(ref regname.Reference) ([]regremote.Option, error) {
rt, err := r.transport(ref, ref.Scope(transport.PullScope))
Expand Down Expand Up @@ -319,7 +334,7 @@ func (r *SimpleRegistry) MultiWrite(imageOrIndexesToUpload map[regname.Reference
}

// WriteImage Upload Image to registry
func (r *SimpleRegistry) WriteImage(ref regname.Reference, img regv1.Image) error {
func (r *SimpleRegistry) WriteImage(ref regname.Reference, img regv1.Image, updatesCh chan regv1.Update) error {
if err := r.validateRef(ref); err != nil {
return err
}
Expand All @@ -332,7 +347,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 {
return fmt.Errorf("Writing image: %s", err)
Expand Down