progress: make title configurable (docker#10507)

glours · web-flow · commit 03f4c0e6311f · 2023-05-02T14:15:35.000-04:00
Signed-off-by: Guillaume Lours &lt;705411+glours@users.noreply.github.com&gt;
diff --git a/pkg/compose/build.go b/pkg/compose/build.go
@@ -47,10 +47,10 @@ func (s *composeService) Build(ctx context.Context, project *types.Project, opti
 	if err != nil {
 		return err
 	}
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		_, err := s.build(ctx, project, options)
 		return err
-	}, s.stderr())
+	}, s.stderr(), "Building")
 }
 
 //nolint:gocyclo
diff --git a/pkg/compose/cp.go b/pkg/compose/cp.go
@@ -44,9 +44,9 @@ const (
 )
 
 func (s *composeService) Copy(ctx context.Context, projectName string, options api.CopyOptions) error {
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.copy(ctx, projectName, options)
-	}, s.stderr())
+	}, s.stderr(), "Copying")
 }
 
 func (s *composeService) copy(ctx context.Context, projectName string, options api.CopyOptions) error {
diff --git a/pkg/compose/create.go b/pkg/compose/create.go
@@ -49,9 +49,9 @@ import (
 )
 
 func (s *composeService) Create(ctx context.Context, project *types.Project, options api.CreateOptions) error {
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.create(ctx, project, options)
-	}, s.stderr())
+	}, s.stderr(), "Creating")
 }
 
 func (s *composeService) create(ctx context.Context, project *types.Project, options api.CreateOptions) error {
diff --git a/pkg/compose/kill.go b/pkg/compose/kill.go
@@ -29,9 +29,9 @@ import (
 )
 
 func (s *composeService) Kill(ctx context.Context, projectName string, options api.KillOptions) error {
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.kill(ctx, strings.ToLower(projectName), options)
-	}, s.stderr())
+	}, s.stderr(), "Killing")
 }
 
 func (s *composeService) kill(ctx context.Context, projectName string, options api.KillOptions) error {
diff --git a/pkg/compose/pause.go b/pkg/compose/pause.go
@@ -28,9 +28,9 @@ import (
 )
 
 func (s *composeService) Pause(ctx context.Context, projectName string, options api.PauseOptions) error {
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.pause(ctx, strings.ToLower(projectName), options)
-	}, s.stderr())
+	}, s.stderr(), "Pausing")
 }
 
 func (s *composeService) pause(ctx context.Context, projectName string, options api.PauseOptions) error {
diff --git a/pkg/compose/pull.go b/pkg/compose/pull.go
@@ -42,9 +42,9 @@ func (s *composeService) Pull(ctx context.Context, project *types.Project, optio
 	if options.Quiet {
 		return s.pull(ctx, project, options)
 	}
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.pull(ctx, project, options)
-	}, s.stderr())
+	}, s.stderr(), "Pulling")
 }
 
 func (s *composeService) pull(ctx context.Context, project *types.Project, opts api.PullOptions) error { //nolint:gocyclo
diff --git a/pkg/compose/push.go b/pkg/compose/push.go
@@ -40,9 +40,9 @@ func (s *composeService) Push(ctx context.Context, project *types.Project, optio
 	if options.Quiet {
 		return s.push(ctx, project, options)
 	}
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.push(ctx, project, options)
-	}, s.stderr())
+	}, s.stderr(), "Pushing")
 }
 
 func (s *composeService) push(ctx context.Context, project *types.Project, options api.PushOptions) error {
diff --git a/pkg/compose/remove.go b/pkg/compose/remove.go
@@ -93,9 +93,9 @@ func (s *composeService) Remove(ctx context.Context, projectName string, options
 			return nil
 		}
 	}
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.remove(ctx, stoppedContainers, options)
-	}, s.stderr())
+	}, s.stderr(), "Removing")
 }
 
 func (s *composeService) remove(ctx context.Context, containers Containers, options api.RemoveOptions) error {
diff --git a/pkg/compose/restart.go b/pkg/compose/restart.go
@@ -29,9 +29,9 @@ import (
 )
 
 func (s *composeService) Restart(ctx context.Context, projectName string, options api.RestartOptions) error {
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.restart(ctx, strings.ToLower(projectName), options)
-	}, s.stderr())
+	}, s.stderr(), "Restarting")
 }
 
 func (s *composeService) restart(ctx context.Context, projectName string, options api.RestartOptions) error {
diff --git a/pkg/compose/stop.go b/pkg/compose/stop.go
@@ -26,9 +26,9 @@ import (
 )
 
 func (s *composeService) Stop(ctx context.Context, projectName string, options api.StopOptions) error {
-	return progress.Run(ctx, func(ctx context.Context) error {
+	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.stop(ctx, strings.ToLower(projectName), options)
-	}, s.stderr())
+	}, s.stderr(), "Stopping")
 }
 
 func (s *composeService) stop(ctx context.Context, projectName string, options api.StopOptions) error {
diff --git a/pkg/progress/tty.go b/pkg/progress/tty.go
@@ -43,6 +43,7 @@ type ttyWriter struct {
 	tailEvents      []string
 	dryRun          bool
 	skipChildEvents bool
+	progressTitle   string
 }
 
 func (w *ttyWriter) Start(ctx context.Context) error {
@@ -149,7 +150,7 @@ func (w *ttyWriter) print() { //nolint:gocyclo
 	fmt.Fprint(w.out, aec.Hide)
 	defer fmt.Fprint(w.out, aec.Show)
 
-	firstLine := fmt.Sprintf("[+] Running %d/%d", numDone(w.events), w.numLines)
+	firstLine := fmt.Sprintf("[+] %s %d/%d", w.progressTitle, numDone(w.events), w.numLines)
 	if w.numLines != 0 && numDone(w.events) == w.numLines {
 		firstLine = DoneColor(firstLine)
 	}
diff --git a/pkg/progress/writer.go b/pkg/progress/writer.go
@@ -61,14 +61,21 @@ type progressFuncWithStatus func(context.Context) (string, error)
 func Run(ctx context.Context, pf progressFunc, out io.Writer) error {
 	_, err := RunWithStatus(ctx, func(ctx context.Context) (string, error) {
 		return "", pf(ctx)
-	}, out)
+	}, out, "Running")
+	return err
+}
+
+func RunWithTitle(ctx context.Context, pf progressFunc, out io.Writer, progressTitle string) error {
+	_, err := RunWithStatus(ctx, func(ctx context.Context) (string, error) {
+		return "", pf(ctx)
+	}, out, progressTitle)
 	return err
 }
 
 // RunWithStatus will run a writer and the progress function in parallel and return a status
-func RunWithStatus(ctx context.Context, pf progressFuncWithStatus, out io.Writer) (string, error) {
+func RunWithStatus(ctx context.Context, pf progressFuncWithStatus, out io.Writer, progressTitle string) (string, error) {
 	eg, _ := errgroup.WithContext(ctx)
-	w, err := NewWriter(ctx, out)
+	w, err := NewWriter(ctx, out, progressTitle)
 	var result string
 	if err != nil {
 		return "", err
@@ -105,17 +112,17 @@ const (
 var Mode = ModeAuto
 
 // NewWriter returns a new multi-progress writer
-func NewWriter(ctx context.Context, out io.Writer) (Writer, error) {
+func NewWriter(ctx context.Context, out io.Writer, progressTitle string) (Writer, error) {
 	_, isTerminal := term.GetFdInfo(out)
 	dryRun, ok := ctx.Value(api.DryRunKey{}).(bool)
 	if !ok {
 		dryRun = false
 	}
 	if Mode == ModeAuto && isTerminal {
-		return newTTYWriter(out.(console.File), dryRun)
+		return newTTYWriter(out.(console.File), dryRun, progressTitle)
 	}
 	if Mode == ModeTTY {
-		return newTTYWriter(out.(console.File), dryRun)
+		return newTTYWriter(out.(console.File), dryRun, progressTitle)
 	}
 	return &plainWriter{
 		out:    out,
@@ -124,19 +131,20 @@ func NewWriter(ctx context.Context, out io.Writer) (Writer, error) {
 	}, nil
 }
 
-func newTTYWriter(out console.File, dryRun bool) (Writer, error) {
+func newTTYWriter(out console.File, dryRun bool, progressTitle string) (Writer, error) {
 	con, err := console.ConsoleFromFile(out)
 	if err != nil {
 		return nil, err
 	}
 
 	return &ttyWriter{
-		out:      con,
-		eventIDs: []string{},
-		events:   map[string]Event{},
-		repeated: false,
-		done:     make(chan bool),
-		mtx:      &sync.Mutex{},
-		dryRun:   dryRun,
+		out:           con,
+		eventIDs:      []string{},
+		events:        map[string]Event{},
+		repeated:      false,
+		done:          make(chan bool),
+		mtx:           &sync.Mutex{},
+		dryRun:        dryRun,
+		progressTitle: progressTitle,
 	}, nil
 }

Original file line number	Diff line number	Diff line change
`@@ -47,10 +47,10 @@ func (s composeService) Build(ctx context.Context, project types.Project, opti`
`47`	`47`	`if err != nil {`
`48`	`48`	`return err`
`49`	`49`	`}`
`50`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`50`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`51`	`51`	`_, err := s.build(ctx, project, options)`
`52`	`52`	`return err`
`53`		`- }, s.stderr())`
	`53`	`+ }, s.stderr(), "Building")`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`//nolint:gocyclo`
Original file line number	Diff line number	Diff line change
`@@ -44,9 +44,9 @@ const (`
`44`	`44`	`)`
`45`	`45`
`46`	`46`	`func (s *composeService) Copy(ctx context.Context, projectName string, options api.CopyOptions) error {`
`47`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`47`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`48`	`48`	`return s.copy(ctx, projectName, options)`
`49`		`- }, s.stderr())`
	`49`	`+ }, s.stderr(), "Copying")`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`func (s *composeService) copy(ctx context.Context, projectName string, options api.CopyOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -49,9 +49,9 @@ import (`
`49`	`49`	`)`
`50`	`50`
`51`	`51`	`func (s composeService) Create(ctx context.Context, project types.Project, options api.CreateOptions) error {`
`52`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`52`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`53`	`53`	`return s.create(ctx, project, options)`
`54`		`- }, s.stderr())`
	`54`	`+ }, s.stderr(), "Creating")`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`func (s composeService) create(ctx context.Context, project types.Project, options api.CreateOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,9 @@ import (`
`29`	`29`	`)`
`30`	`30`
`31`	`31`	`func (s *composeService) Kill(ctx context.Context, projectName string, options api.KillOptions) error {`
`32`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`32`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`33`	`33`	`return s.kill(ctx, strings.ToLower(projectName), options)`
`34`		`- }, s.stderr())`
	`34`	`+ }, s.stderr(), "Killing")`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`func (s *composeService) kill(ctx context.Context, projectName string, options api.KillOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,9 @@ import (`
`28`	`28`	`)`
`29`	`29`
`30`	`30`	`func (s *composeService) Pause(ctx context.Context, projectName string, options api.PauseOptions) error {`
`31`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`31`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`32`	`32`	`return s.pause(ctx, strings.ToLower(projectName), options)`
`33`		`- }, s.stderr())`
	`33`	`+ }, s.stderr(), "Pausing")`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`func (s *composeService) pause(ctx context.Context, projectName string, options api.PauseOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,9 @@ func (s composeService) Pull(ctx context.Context, project types.Project, optio`
`42`	`42`	`if options.Quiet {`
`43`	`43`	`return s.pull(ctx, project, options)`
`44`	`44`	`}`
`45`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`45`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`46`	`46`	`return s.pull(ctx, project, options)`
`47`		`- }, s.stderr())`
	`47`	`+ }, s.stderr(), "Pulling")`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`func (s composeService) pull(ctx context.Context, project types.Project, opts api.PullOptions) error { //nolint:gocyclo`
Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,9 @@ func (s composeService) Push(ctx context.Context, project types.Project, optio`
`40`	`40`	`if options.Quiet {`
`41`	`41`	`return s.push(ctx, project, options)`
`42`	`42`	`}`
`43`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`43`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`44`	`44`	`return s.push(ctx, project, options)`
`45`		`- }, s.stderr())`
	`45`	`+ }, s.stderr(), "Pushing")`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`func (s composeService) push(ctx context.Context, project types.Project, options api.PushOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -93,9 +93,9 @@ func (s *composeService) Remove(ctx context.Context, projectName string, options`
`93`	`93`	`return nil`
`94`	`94`	`}`
`95`	`95`	`}`
`96`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`96`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`97`	`97`	`return s.remove(ctx, stoppedContainers, options)`
`98`		`- }, s.stderr())`
	`98`	`+ }, s.stderr(), "Removing")`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`func (s *composeService) remove(ctx context.Context, containers Containers, options api.RemoveOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,9 @@ import (`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`func (s *composeService) Stop(ctx context.Context, projectName string, options api.StopOptions) error {`
`29`		`- return progress.Run(ctx, func(ctx context.Context) error {`
	`29`	`+ return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`30`	`30`	`return s.stop(ctx, strings.ToLower(projectName), options)`
`31`		`- }, s.stderr())`
	`31`	`+ }, s.stderr(), "Stopping")`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`func (s *composeService) stop(ctx context.Context, projectName string, options api.StopOptions) error {`