move progress UI components into cmd

Signed-off-by: Nicolas De Loof <[email protected]>

Author: ndeloof

cmd/compose/build.go

@@ -26,8 +26,8 @@ import (
 	"github.com/compose-spec/compose-go/v2/types"
 	"github.com/docker/cli/cli/command"
 	cliopts "github.com/docker/cli/opts"
+	"github.com/docker/compose/v2/cmd/display"
 	"github.com/docker/compose/v2/pkg/compose"
-	ui "github.com/docker/compose/v2/pkg/progress"
 	"github.com/spf13/cobra"
 
 	"github.com/docker/compose/v2/pkg/api"
@@ -67,8 +67,8 @@ func (opts buildOptions) toAPIBuildOptions(services []string) (api.BuildOptions,
 		builderName = os.Getenv("BUILDX_BUILDER")
 	}
 
-	uiMode := ui.Mode
-	if uiMode == ui.ModeJSON {
+	uiMode := display.Mode
+	if uiMode == display.ModeJSON {
 		uiMode = "rawjson"
 	}
 
@@ -100,7 +100,7 @@ func buildCommand(p *ProjectOptions, dockerCli command.Cli, backendOptions *Back
 		Short: "Build or rebuild services",
 		PreRunE: Adapt(func(ctx context.Context, args []string) error {
 			if opts.quiet {
-				ui.Mode = ui.ModeQuiet
+				display.Mode = display.ModeQuiet
 				devnull, err := os.Open(os.DevNull)
 				if err != nil {
 					return err
@@ -151,7 +151,7 @@ func buildCommand(p *ProjectOptions, dockerCli command.Cli, backendOptions *Back
 
 func runBuild(ctx context.Context, dockerCli command.Cli, backendOptions *BackendOptions, opts buildOptions, services []string) error {
 	if opts.print {
-		backendOptions.Add(compose.WithEventProcessor(ui.NewQuietWriter()))
+		backendOptions.Add(compose.WithEventProcessor(display.Quiet()))
 	}
 	backend, err := compose.NewComposeService(dockerCli, backendOptions.Options...)
 	if err != nil {

cmd/compose/compose.go

@@ -39,11 +39,11 @@ import (
 	"github.com/docker/cli/cli-plugins/metadata"
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/cli/pkg/kvfile"
+	"github.com/docker/compose/v2/cmd/display"
 	"github.com/docker/compose/v2/cmd/formatter"
 	"github.com/docker/compose/v2/internal/tracing"
 	"github.com/docker/compose/v2/pkg/api"
 	"github.com/docker/compose/v2/pkg/compose"
-	ui "github.com/docker/compose/v2/pkg/progress"
 	"github.com/docker/compose/v2/pkg/remote"
 	"github.com/docker/compose/v2/pkg/utils"
 	"github.com/morikuni/aec"
@@ -84,10 +84,16 @@ func rawEnv(r io.Reader, filename string, vars map[string]string, lookup func(ke
 	return nil
 }
 
+var stdioToStdout bool
+
 func init() {
 	// compose evaluates env file values for interpolation
 	// `raw` format allows to load env_file with the same parser used by docker run --env-file
 	dotenv.RegisterFormat("raw", rawEnv)
+
+	if v, ok := os.LookupEnv("COMPOSE_STATUS_STDOUT"); ok {
+		stdioToStdout, _ = strconv.ParseBool(v)
+	}
 }
 
 // Command defines a compose CLI command as a func with args
@@ -116,7 +122,7 @@ func AdaptCmd(fn CobraCommand) func(cmd *cobra.Command, args []string) error {
 				StatusCode: 130,
 			}
 		}
-		if ui.Mode == ui.ModeJSON {
+		if display.Mode == display.ModeJSON {
 			err = makeJSONError(err)
 		}
 		return err
@@ -486,49 +492,49 @@ func RootCommand(dockerCli command.Cli, backendOptions *BackendOptions) *cobra.C
 			formatter.SetANSIMode(dockerCli, ansi)
 
 			if noColor, ok := os.LookupEnv("NO_COLOR"); ok && noColor != "" {
-				ui.NoColor()
+				display.NoColor()
 				formatter.SetANSIMode(dockerCli, formatter.Never)
 			}
 
 			switch ansi {
 			case "never":
-				ui.Mode = ui.ModePlain
+				display.Mode = display.ModePlain
 			case "always":
-				ui.Mode = ui.ModeTTY
+				display.Mode = display.ModeTTY
 			}
 
-			var ep ui.EventProcessor
+			var ep api.EventProcessor
 			switch opts.Progress {
-			case "", ui.ModeAuto:
+			case "", display.ModeAuto:
 				switch {
 				case ansi == "never":
-					ui.Mode = ui.ModePlain
-					ep = ui.NewPlainWriter(dockerCli.Err())
+					display.Mode = display.ModePlain
+					ep = display.Plain(dockerCli.Err())
 				case dockerCli.Out().IsTerminal():
-					ep = ui.NewTTYWriter(dockerCli.Err())
+					ep = display.Full(dockerCli.Err(), stdinfo(dockerCli))
 				default:
-					ep = ui.NewPlainWriter(dockerCli.Err())
+					ep = display.Plain(dockerCli.Err())
 				}
-			case ui.ModeTTY:
+			case display.ModeTTY:
 				if ansi == "never" {
 					return fmt.Errorf("can't use --progress tty while ANSI support is disabled")
 				}
-				ui.Mode = ui.ModeTTY
-				ep = ui.NewTTYWriter(dockerCli.Err())
+				display.Mode = display.ModeTTY
+				ep = display.Full(dockerCli.Err(), stdinfo(dockerCli))
 
-			case ui.ModePlain:
+			case display.ModePlain:
 				if ansi == "always" {
 					return fmt.Errorf("can't use --progress plain while ANSI support is forced")
 				}
-				ui.Mode = ui.ModePlain
-				ep = ui.NewPlainWriter(dockerCli.Err())
-			case ui.ModeQuiet, "none":
-				ui.Mode = ui.ModeQuiet
-				ep = ui.NewQuietWriter()
-			case ui.ModeJSON:
-				ui.Mode = ui.ModeJSON
+				display.Mode = display.ModePlain
+				ep = display.Plain(dockerCli.Err())
+			case display.ModeQuiet, "none":
+				display.Mode = display.ModeQuiet
+				ep = display.Quiet()
+			case display.ModeJSON:
+				display.Mode = display.ModeJSON
 				logrus.SetFormatter(&logrus.JSONFormatter{})
-				ep = ui.NewJSONWriter(dockerCli.Err())
+				ep = display.JSON(dockerCli.Err())
 			default:
 				return fmt.Errorf("unsupported --progress value %q", opts.Progress)
 			}
@@ -658,6 +664,13 @@ func RootCommand(dockerCli command.Cli, backendOptions *BackendOptions) *cobra.C
 	return c
 }
 
+func stdinfo(dockerCli command.Cli) io.Writer {
+	if stdioToStdout {
+		return dockerCli.Out()
+	}
+	return dockerCli.Err()
+}
+
 func setEnvWithDotEnv(opts ProjectOptions) error {
 	options, err := cli.NewProjectOptions(opts.ConfigPaths,
 		cli.WithWorkingDirectory(opts.ProjectDir),
@@ -683,9 +696,9 @@ func setEnvWithDotEnv(opts ProjectOptions) error {
 }
 
 var printerModes = []string{
-	ui.ModeAuto,
-	ui.ModeTTY,
-	ui.ModePlain,
-	ui.ModeJSON,
-	ui.ModeQuiet,
+	display.ModeAuto,
+	display.ModeTTY,
+	display.ModePlain,
+	display.ModeJSON,
+	display.ModeQuiet,
 }

cmd/compose/kill.go

@@ -18,6 +18,8 @@ package compose
 
 import (
 	"context"
+	"errors"
+	"fmt"
 	"os"
 
 	"github.com/docker/cli/cli/command"
@@ -65,10 +67,15 @@ func runKill(ctx context.Context, dockerCli command.Cli, backendOptions *Backend
 	if err != nil {
 		return err
 	}
-	return backend.Kill(ctx, name, api.KillOptions{
+	err = backend.Kill(ctx, name, api.KillOptions{
 		RemoveOrphans: opts.removeOrphans,
 		Project:       project,
 		Services:      services,
 		Signal:        opts.signal,
 	})
+	if errors.Is(err, api.ErrNoResources) {
+		_, _ = fmt.Fprintln(stdinfo(dockerCli), "No container to kill")
+		return nil
+	}
+	return err
 }

cmd/compose/logs.go

@@ -22,7 +22,6 @@ import (
 
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/compose/v2/pkg/compose"
-	"github.com/docker/compose/v2/pkg/progress"
 	"github.com/spf13/cobra"
 
 	"github.com/docker/compose/v2/cmd/formatter"
@@ -107,28 +106,28 @@ func runLogs(ctx context.Context, dockerCli command.Cli, backendOptions *Backend
 var _ api.LogConsumer = &logConsumer{}
 
 type logConsumer struct {
-	events progress.EventProcessor
+	events api.EventProcessor
 }
 
 func (l logConsumer) Log(containerName, message string) {
-	l.events.On(progress.Event{
+	l.events.On(api.Resource{
 		ID:   containerName,
 		Text: message,
 	})
 }
 
 func (l logConsumer) Err(containerName, message string) {
-	l.events.On(progress.Event{
+	l.events.On(api.Resource{
 		ID:     containerName,
-		Status: progress.Error,
+		Status: api.Error,
 		Text:   message,
 	})
 }
 
 func (l logConsumer) Status(containerName, message string) {
-	l.events.On(progress.Event{
+	l.events.On(api.Resource{
 		ID:     containerName,
-		Status: progress.Error,
+		Status: api.Error,
 		Text:   message,
 	})
 }

cmd/compose/options.go

@@ -30,9 +30,9 @@ import (
 	"github.com/compose-spec/compose-go/v2/template"
 	"github.com/compose-spec/compose-go/v2/types"
 	"github.com/docker/cli/cli/command"
+	"github.com/docker/compose/v2/cmd/display"
 	"github.com/docker/compose/v2/cmd/prompt"
 	"github.com/docker/compose/v2/internal/tracing"
-	ui "github.com/docker/compose/v2/pkg/progress"
 )
 
 func applyPlatforms(project *types.Project, buildForSinglePlatform bool) error {
@@ -247,7 +247,7 @@ func displayInterpolationVariables(writer io.Writer, varsInfo []varInfo) {
 
 func displayLocationRemoteStack(dockerCli command.Cli, project *types.Project, options buildOptions) {
 	mainComposeFile := options.ProjectOptions.ConfigPaths[0] //nolint:staticcheck
-	if ui.Mode != ui.ModeQuiet && ui.Mode != ui.ModeJSON {
+	if display.Mode != display.ModeQuiet && display.Mode != display.ModeJSON {
 		_, _ = fmt.Fprintf(dockerCli.Out(), "Your compose stack %q is stored in %q\n", mainComposeFile, project.WorkingDir)
 	}
 }

cmd/compose/remove.go

@@ -18,6 +18,8 @@ package compose
 
 import (
 	"context"
+	"errors"
+	"fmt"
 
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/compose/v2/pkg/api"
@@ -70,11 +72,16 @@ func runRemove(ctx context.Context, dockerCli command.Cli, backendOptions *Backe
 	if err != nil {
 		return err
 	}
-	return backend.Remove(ctx, name, api.RemoveOptions{
+	err = backend.Remove(ctx, name, api.RemoveOptions{
 		Services: services,
 		Force:    opts.force,
 		Volumes:  opts.volumes,
 		Project:  project,
 		Stop:     opts.stop,
 	})
+	if errors.Is(err, api.ErrNoResources) {
+		_, _ = fmt.Fprintln(stdinfo(dockerCli), "No stopped containers")
+		return nil
+	}
+	return err
 }

cmd/compose/run.go

@@ -25,8 +25,8 @@ import (
 	composecli "github.com/compose-spec/compose-go/v2/cli"
 	"github.com/compose-spec/compose-go/v2/dotenv"
 	"github.com/compose-spec/compose-go/v2/format"
+	"github.com/docker/compose/v2/cmd/display"
 	"github.com/docker/compose/v2/pkg/compose"
-	"github.com/docker/compose/v2/pkg/progress"
 	xprogress "github.com/moby/buildkit/util/progress/progressui"
 	"github.com/sirupsen/logrus"
 
@@ -193,7 +193,7 @@ func runCommand(p *ProjectOptions, dockerCli command.Cli, backendOptions *Backen
 			}
 
 			if options.quiet {
-				progress.Mode = progress.ModeQuiet
+				display.Mode = display.ModeQuiet
 				devnull, err := os.Open(os.DevNull)
 				if err != nil {
 					return err

cmd/compose/up.go

@@ -26,8 +26,8 @@ import (
 
 	"github.com/compose-spec/compose-go/v2/types"
 	"github.com/docker/cli/cli/command"
+	"github.com/docker/compose/v2/cmd/display"
 	"github.com/docker/compose/v2/pkg/compose"
-	ui "github.com/docker/compose/v2/pkg/progress"
 	xprogress "github.com/moby/buildkit/util/progress/progressui"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -341,7 +341,7 @@ func runUp(
 			WaitTimeout:    timeout,
 			Watch:          upOptions.watch,
 			Services:       services,
-			NavigationMenu: upOptions.navigationMenu && ui.Mode != "plain" && dockerCli.In().IsTerminal(),
+			NavigationMenu: upOptions.navigationMenu && display.Mode != "plain" && dockerCli.In().IsTerminal(),
 		},
 	})
 }

pkg/progress/colors.go cmd/display/colors.gopkg/progress/colors.go renamed to cmd/display/colors.go

@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-package progress
+package display
 
 import (
 	"github.com/morikuni/aec"

pkg/progress/json.go cmd/display/json.gopkg/progress/json.go renamed to cmd/display/json.go

@@ -14,16 +14,18 @@
    limitations under the License.
 */
 
-package progress
+package display
 
 import (
 	"context"
 	"encoding/json"
 	"fmt"
 	"io"
+
+	"github.com/docker/compose/v2/pkg/api"
 )
 
-func NewJSONWriter(out io.Writer) EventProcessor {
+func JSON(out io.Writer) api.EventProcessor {
 	return &jsonWriter{
 		out: out,
 	}
@@ -50,7 +52,7 @@ type jsonMessage struct {
 func (p *jsonWriter) Start(ctx context.Context, operation string) {
 }
 
-func (p *jsonWriter) Event(e Event) {
+func (p *jsonWriter) Event(e api.Resource) {
 	message := &jsonMessage{
 		DryRun:   p.dryRun,
 		Tail:     false,
@@ -69,7 +71,7 @@ func (p *jsonWriter) Event(e Event) {
 	}
 }
 
-func (p *jsonWriter) On(events ...Event) {
+func (p *jsonWriter) On(events ...api.Resource) {
 	for _, e := range events {
 		p.Event(e)
 	}