cli: option to write status messages on stdout (docker#10549)

ndeloof · web-flow · commit a14abb9044b8 · 2023-05-11T12:45:00.000-04:00
Signed-off-by: Nicolas De Loof &lt;nicolas.deloof@gmail.com&gt;
diff --git a/pkg/compose/build.go b/pkg/compose/build.go
@@ -52,7 +52,7 @@ func (s *composeService) Build(ctx context.Context, project *types.Project, opti
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		_, err := s.build(ctx, project, options)
 		return err
-	}, s.stderr(), "Building")
+	}, s.stdinfo(), "Building")
 }
 
 func (s *composeService) build(ctx context.Context, project *types.Project, options api.BuildOptions) (map[string]string, error) { //nolint:gocyclo
diff --git a/pkg/compose/compose.go b/pkg/compose/compose.go
@@ -21,6 +21,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"os"
 	"strconv"
 	"strings"
 
@@ -40,6 +41,15 @@ import (
 	"github.com/docker/compose/v2/pkg/api"
 )
 
+var stdioToStdout bool
+
+func init() {
+	out, ok := os.LookupEnv("COMPOSE_STATUS_STDOUT")
+	if ok {
+		stdioToStdout, _ = strconv.ParseBool(out)
+	}
+}
+
 // NewComposeService create a local implementation of the compose.Service API
 func NewComposeService(dockerCli command.Cli) api.Service {
 	return &composeService{
@@ -97,6 +107,13 @@ func (s *composeService) stderr() io.Writer {
 	return s.dockerCli.Err()
 }
 
+func (s *composeService) stdinfo() io.Writer {
+	if stdioToStdout {
+		return s.dockerCli.Out()
+	}
+	return s.dockerCli.Err()
+}
+
 func getCanonicalContainerName(c moby.Container) string {
 	if len(c.Names) == 0 {
 		// corner case, sometime happens on removal. return short ID as a safeguard value
diff --git a/pkg/compose/cp.go b/pkg/compose/cp.go
@@ -46,7 +46,7 @@ const (
 func (s *composeService) Copy(ctx context.Context, projectName string, options api.CopyOptions) error {
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.copy(ctx, projectName, options)
-	}, s.stderr(), "Copying")
+	}, s.stdinfo(), "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
@@ -51,7 +51,7 @@ import (
 func (s *composeService) Create(ctx context.Context, project *types.Project, options api.CreateOptions) error {
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.create(ctx, project, options)
-	}, s.stderr(), "Creating")
+	}, s.stdinfo(), "Creating")
 }
 
 func (s *composeService) create(ctx context.Context, project *types.Project, options api.CreateOptions) error {
diff --git a/pkg/compose/down.go b/pkg/compose/down.go
@@ -41,7 +41,7 @@ type downOp func() error
 func (s *composeService) Down(ctx context.Context, projectName string, options api.DownOptions) error {
 	return progress.Run(ctx, func(ctx context.Context) error {
 		return s.down(ctx, strings.ToLower(projectName), options)
-	}, s.stderr())
+	}, s.stdinfo())
 }
 
 func (s *composeService) down(ctx context.Context, projectName string, options api.DownOptions) error {
diff --git a/pkg/compose/kill.go b/pkg/compose/kill.go
@@ -31,7 +31,7 @@ import (
 func (s *composeService) Kill(ctx context.Context, projectName string, options api.KillOptions) error {
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.kill(ctx, strings.ToLower(projectName), options)
-	}, s.stderr(), "Killing")
+	}, s.stdinfo(), "Killing")
 }
 
 func (s *composeService) kill(ctx context.Context, projectName string, options api.KillOptions) error {
@@ -57,7 +57,8 @@ func (s *composeService) kill(ctx context.Context, projectName string, options a
 		containers = containers.filter(isService(project.ServiceNames()...))
 	}
 	if len(containers) == 0 {
-		fmt.Fprintf(s.stderr(), "no container to kill")
+		fmt.Fprintf(s.stdinfo(), "no container to kill")
+		return nil
 	}
 
 	eg, ctx := errgroup.WithContext(ctx)
diff --git a/pkg/compose/pause.go b/pkg/compose/pause.go
@@ -30,7 +30,7 @@ import (
 func (s *composeService) Pause(ctx context.Context, projectName string, options api.PauseOptions) error {
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.pause(ctx, strings.ToLower(projectName), options)
-	}, s.stderr(), "Pausing")
+	}, s.stdinfo(), "Pausing")
 }
 
 func (s *composeService) pause(ctx context.Context, projectName string, options api.PauseOptions) error {
@@ -62,7 +62,7 @@ func (s *composeService) pause(ctx context.Context, projectName string, options
 func (s *composeService) UnPause(ctx context.Context, projectName string, options api.PauseOptions) error {
 	return progress.Run(ctx, func(ctx context.Context) error {
 		return s.unPause(ctx, strings.ToLower(projectName), options)
-	}, s.stderr())
+	}, s.stdinfo())
 }
 
 func (s *composeService) unPause(ctx context.Context, projectName string, options api.PauseOptions) error {
diff --git a/pkg/compose/pull.go b/pkg/compose/pull.go
@@ -44,7 +44,7 @@ func (s *composeService) Pull(ctx context.Context, project *types.Project, optio
 	}
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.pull(ctx, project, options)
-	}, s.stderr(), "Pulling")
+	}, s.stdinfo(), "Pulling")
 }
 
 func (s *composeService) pull(ctx context.Context, project *types.Project, opts api.PullOptions) error { //nolint:gocyclo
@@ -305,7 +305,7 @@ func (s *composeService) pullRequiredImages(ctx context.Context, project *types.
 			}
 		}
 		return err
-	}, s.stderr())
+	}, s.stdinfo())
 }
 
 func isServiceImageToBuild(service types.ServiceConfig, services []types.ServiceConfig) bool {
diff --git a/pkg/compose/push.go b/pkg/compose/push.go
@@ -42,7 +42,7 @@ func (s *composeService) Push(ctx context.Context, project *types.Project, optio
 	}
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.push(ctx, project, options)
-	}, s.stderr(), "Pushing")
+	}, s.stdinfo(), "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
@@ -75,10 +75,10 @@ func (s *composeService) Remove(ctx context.Context, projectName string, options
 	stoppedContainers.forEach(func(c moby.Container) {
 		names = append(names, getCanonicalContainerName(c))
 	})
-	fmt.Fprintln(s.stderr(), names)
+	fmt.Fprintln(s.stdinfo(), names)
 
 	if len(names) == 0 {
-		fmt.Fprintln(s.stderr(), "No stopped containers")
+		fmt.Fprintln(s.stdinfo(), "No stopped containers")
 		return nil
 	}
 	msg := fmt.Sprintf("Going to remove %s", strings.Join(names, ", "))
@@ -95,7 +95,7 @@ func (s *composeService) Remove(ctx context.Context, projectName string, options
 	}
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.remove(ctx, stoppedContainers, options)
-	}, s.stderr(), "Removing")
+	}, s.stdinfo(), "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
@@ -31,7 +31,7 @@ import (
 func (s *composeService) Restart(ctx context.Context, projectName string, options api.RestartOptions) error {
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.restart(ctx, strings.ToLower(projectName), options)
-	}, s.stderr(), "Restarting")
+	}, s.stdinfo(), "Restarting")
 }
 
 func (s *composeService) restart(ctx context.Context, projectName string, options api.RestartOptions) error {
diff --git a/pkg/compose/start.go b/pkg/compose/start.go
@@ -38,7 +38,7 @@ import (
 func (s *composeService) Start(ctx context.Context, projectName string, options api.StartOptions) error {
 	return progress.Run(ctx, func(ctx context.Context) error {
 		return s.start(ctx, strings.ToLower(projectName), options, nil)
-	}, s.stderr())
+	}, s.stdinfo())
 }
 
 func (s *composeService) start(ctx context.Context, projectName string, options api.StartOptions, listener api.ContainerEventListener) error {
diff --git a/pkg/compose/stop.go b/pkg/compose/stop.go
@@ -28,7 +28,7 @@ import (
 func (s *composeService) Stop(ctx context.Context, projectName string, options api.StopOptions) error {
 	return progress.RunWithTitle(ctx, func(ctx context.Context) error {
 		return s.stop(ctx, strings.ToLower(projectName), options)
-	}, s.stderr(), "Stopping")
+	}, s.stdinfo(), "Stopping")
 }
 
 func (s *composeService) stop(ctx context.Context, projectName string, options api.StopOptions) error {
diff --git a/pkg/compose/up.go b/pkg/compose/up.go
@@ -40,7 +40,7 @@ func (s *composeService) Up(ctx context.Context, project *types.Project, options
 			return s.start(ctx, project.Name, options.Start, nil)
 		}
 		return nil
-	}, s.stderr())
+	}, s.stdinfo())
 	if err != nil {
 		return err
 	}
@@ -59,7 +59,7 @@ func (s *composeService) Up(ctx context.Context, project *types.Project, options
 	signal.Notify(signalChan, syscall.SIGINT, syscall.SIGTERM)
 
 	stopFunc := func() error {
-		fmt.Fprintln(s.stderr(), "Aborting on container exit...")
+		fmt.Fprintln(s.stdinfo(), "Aborting on container exit...")
 		ctx := context.Background()
 		return progress.Run(ctx, func(ctx context.Context) error {
 			go func() {
@@ -74,7 +74,7 @@ func (s *composeService) Up(ctx context.Context, project *types.Project, options
 				Services: options.Create.Services,
 				Project:  project,
 			})
-		}, s.stderr())
+		}, s.stdinfo())
 	}
 
 	var isTerminated bool
@@ -83,7 +83,7 @@ func (s *composeService) Up(ctx context.Context, project *types.Project, options
 		<-signalChan
 		isTerminated = true
 		printer.Cancel()
-		fmt.Fprintln(s.stderr(), "Gracefully stopping... (press Ctrl+C again to force)")
+		fmt.Fprintln(s.stdinfo(), "Gracefully stopping... (press Ctrl+C again to force)")
 		eg.Go(stopFunc)
 	}()
 
diff --git a/pkg/compose/watch.go b/pkg/compose/watch.go
@@ -155,7 +155,7 @@ func (s *composeService) Watch(ctx context.Context, project *types.Project, serv
 			return err
 		}
 
-		fmt.Fprintf(s.stderr(), "watching %s\n", bc)
+		fmt.Fprintf(s.stdinfo(), "watching %s\n", bc)
 		err = watcher.Start()
 		if err != nil {
 			return err
@@ -207,7 +207,7 @@ WATCH:
 						continue
 					}
 
-					fmt.Fprintf(s.stderr(), "change detected on %s\n", hostPath)
+					fmt.Fprintf(s.stdinfo(), "change detected on %s\n", hostPath)
 
 					f := fileMapping{
 						HostPath: hostPath,
@@ -283,7 +283,7 @@ func (s *composeService) makeRebuildFn(ctx context.Context, project *types.Proje
 		}
 
 		fmt.Fprintf(
-			s.stderr(),
+			s.stdinfo(),
 			"Rebuilding %s after changes were detected:%s\n",
 			strings.Join(serviceNames, ", "),
 			strings.Join(append([]string{""}, allPaths.Elements()...), "\n  - "),
@@ -319,7 +319,7 @@ func (s *composeService) makeSyncFn(ctx context.Context, project *types.Project,
 					if err != nil {
 						return err
 					}
-					fmt.Fprintf(s.stderr(), "%s updated\n", opt.ContainerPath)
+					fmt.Fprintf(s.stdinfo(), "%s updated\n", opt.ContainerPath)
 				} else if errors.Is(statErr, fs.ErrNotExist) {
 					_, err := s.Exec(ctx, project.Name, api.RunOptions{
 						Service: opt.Service,
@@ -329,7 +329,7 @@ func (s *composeService) makeSyncFn(ctx context.Context, project *types.Project,
 					if err != nil {
 						logrus.Warnf("failed to delete %q from %s: %v", opt.ContainerPath, opt.Service, err)
 					}
-					fmt.Fprintf(s.stderr(), "%s deleted from container\n", opt.ContainerPath)
+					fmt.Fprintf(s.stdinfo(), "%s deleted from container\n", opt.ContainerPath)
 				}
 			}
 		}

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ func (s composeService) Build(ctx context.Context, project types.Project, opti`
`52`	`52`	`return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`53`	`53`	`_, err := s.build(ctx, project, options)`
`54`	`54`	`return err`
`55`		`- }, s.stderr(), "Building")`
	`55`	`+ }, s.stdinfo(), "Building")`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`func (s composeService) build(ctx context.Context, project types.Project, options api.BuildOptions) (map[string]string, error) { //nolint:gocyclo`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ const (`
`46`	`46`	`func (s *composeService) Copy(ctx context.Context, projectName string, options api.CopyOptions) error {`
`47`	`47`	`return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`48`	`48`	`return s.copy(ctx, projectName, options)`
`49`		`- }, s.stderr(), "Copying")`
	`49`	`+ }, s.stdinfo(), "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
`@@ -51,7 +51,7 @@ import (`
`51`	`51`	`func (s composeService) Create(ctx context.Context, project types.Project, options api.CreateOptions) error {`
`52`	`52`	`return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`53`	`53`	`return s.create(ctx, project, options)`
`54`		`- }, s.stderr(), "Creating")`
	`54`	`+ }, s.stdinfo(), "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
`@@ -41,7 +41,7 @@ type downOp func() error`
`41`	`41`	`func (s *composeService) Down(ctx context.Context, projectName string, options api.DownOptions) error {`
`42`	`42`	`return progress.Run(ctx, func(ctx context.Context) error {`
`43`	`43`	`return s.down(ctx, strings.ToLower(projectName), options)`
`44`		`- }, s.stderr())`
	`44`	`+ }, s.stdinfo())`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`func (s *composeService) down(ctx context.Context, projectName string, options api.DownOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ import (`
`31`	`31`	`func (s *composeService) Kill(ctx context.Context, projectName string, options api.KillOptions) error {`
`32`	`32`	`return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`33`	`33`	`return s.kill(ctx, strings.ToLower(projectName), options)`
`34`		`- }, s.stderr(), "Killing")`
	`34`	`+ }, s.stdinfo(), "Killing")`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`func (s *composeService) kill(ctx context.Context, projectName string, options api.KillOptions) error {`
`@@ -57,7 +57,8 @@ func (s *composeService) kill(ctx context.Context, projectName string, options a`
`57`	`57`	`containers = containers.filter(isService(project.ServiceNames()...))`
`58`	`58`	`}`
`59`	`59`	`if len(containers) == 0 {`
`60`		`- fmt.Fprintf(s.stderr(), "no container to kill")`
	`60`	`+ fmt.Fprintf(s.stdinfo(), "no container to kill")`
	`61`	`+ return nil`
`61`	`62`	`}`
`62`	`63`
`63`	`64`	`eg, ctx := errgroup.WithContext(ctx)`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ func (s composeService) Pull(ctx context.Context, project types.Project, optio`
`44`	`44`	`}`
`45`	`45`	`return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`46`	`46`	`return s.pull(ctx, project, options)`
`47`		`- }, s.stderr(), "Pulling")`
	`47`	`+ }, s.stdinfo(), "Pulling")`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`func (s composeService) pull(ctx context.Context, project types.Project, opts api.PullOptions) error { //nolint:gocyclo`
`@@ -305,7 +305,7 @@ func (s composeService) pullRequiredImages(ctx context.Context, project types.`
`305`	`305`	`}`
`306`	`306`	`}`
`307`	`307`	`return err`
`308`		`- }, s.stderr())`
	`308`	`+ }, s.stdinfo())`
`309`	`309`	`}`
`310`	`310`
`311`	`311`	`func isServiceImageToBuild(service types.ServiceConfig, services []types.ServiceConfig) bool {`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ func (s composeService) Push(ctx context.Context, project types.Project, optio`
`42`	`42`	`}`
`43`	`43`	`return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`44`	`44`	`return s.push(ctx, project, options)`
`45`		`- }, s.stderr(), "Pushing")`
	`45`	`+ }, s.stdinfo(), "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
`@@ -75,10 +75,10 @@ func (s *composeService) Remove(ctx context.Context, projectName string, options`
`75`	`75`	`stoppedContainers.forEach(func(c moby.Container) {`
`76`	`76`	`names = append(names, getCanonicalContainerName(c))`
`77`	`77`	`})`
`78`		`- fmt.Fprintln(s.stderr(), names)`
	`78`	`+ fmt.Fprintln(s.stdinfo(), names)`
`79`	`79`
`80`	`80`	`if len(names) == 0 {`
`81`		`- fmt.Fprintln(s.stderr(), "No stopped containers")`
	`81`	`+ fmt.Fprintln(s.stdinfo(), "No stopped containers")`
`82`	`82`	`return nil`
`83`	`83`	`}`
`84`	`84`	`msg := fmt.Sprintf("Going to remove %s", strings.Join(names, ", "))`
`@@ -95,7 +95,7 @@ func (s *composeService) Remove(ctx context.Context, projectName string, options`
`95`	`95`	`}`
`96`	`96`	`return progress.RunWithTitle(ctx, func(ctx context.Context) error {`
`97`	`97`	`return s.remove(ctx, stoppedContainers, options)`
`98`		`- }, s.stderr(), "Removing")`
	`98`	`+ }, s.stdinfo(), "Removing")`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`func (s *composeService) remove(ctx context.Context, containers Containers, options api.RemoveOptions) error {`