package debug import ( "context" "os" "runtime" "github.com/containerd/console" "github.com/docker/buildx/controller" "github.com/docker/buildx/controller/control" controllerapi "github.com/docker/buildx/controller/pb" "github.com/docker/buildx/monitor" "github.com/docker/buildx/util/progress" "github.com/docker/cli/cli/command" "github.com/pkg/errors" "github.com/sirupsen/logrus" "github.com/spf13/cobra" ) // DebugConfig is a user-specified configuration for the debugger. type DebugConfig struct { // InvokeFlag is a flag to configure the launched debugger and the commaned executed on the debugger. InvokeFlag string // OnFlag is a flag to configure the timing of launching the debugger. OnFlag string } // DebuggableCmd is a command that supports debugger with recognizing the user-specified DebugConfig. type DebuggableCmd interface { // NewDebugger returns the new *cobra.Command with support for the debugger with recognizing DebugConfig. NewDebugger(*DebugConfig) *cobra.Command } func RootCmd(dockerCli command.Cli, children ...DebuggableCmd) *cobra.Command { var controlOptions control.ControlOptions var progressMode string var options DebugConfig cmd := &cobra.Command{ Use: "debug", Short: "Start debugger", Args: cobra.NoArgs, Annotations: map[string]string{ "experimentalCLI": "", }, RunE: func(cmd *cobra.Command, args []string) error { printer, err := progress.NewPrinter(context.TODO(), os.Stderr, os.Stderr, progressMode) if err != nil { return err } ctx := context.TODO() c, err := controller.NewController(ctx, controlOptions, dockerCli, printer) if err != nil { return err } defer func() { if err := c.Close(); err != nil { logrus.Warnf("failed to close server connection %v", err) } }() con := console.Current() if err := con.SetRaw(); err != nil { return errors.Errorf("failed to configure terminal: %v", err) } err = monitor.RunMonitor(ctx, "", nil, controllerapi.InvokeConfig{ Tty: true, }, c, dockerCli.In(), os.Stdout, os.Stderr, printer) con.Reset() return err }, } flags := cmd.Flags() flags.StringVar(&options.InvokeFlag, "invoke", "", "Launch a monitor with executing specified command") flags.SetAnnotation("invoke", "experimentalCLI", nil) flags.StringVar(&options.OnFlag, "on", "", "When to launch the monitor ([always, error])") flags.SetAnnotation("on", "experimentalCLI", nil) flags.StringVar(&controlOptions.Root, "root", "", "Specify root directory of server to connect for the monitor") flags.SetAnnotation("root", "experimentalCLI", nil) flags.BoolVar(&controlOptions.Detach, "detach", runtime.GOOS == "linux", "Detach buildx server for the monitor (supported only on linux)") flags.SetAnnotation("detach", "experimentalCLI", nil) flags.StringVar(&controlOptions.ServerConfig, "server-config", "", "Specify buildx server config file for the monitor (used only when launching new server)") flags.SetAnnotation("server-config", "experimentalCLI", nil) flags.StringVar(&progressMode, "progress", "auto", `Set type of progress output ("auto", "plain", "tty") for the monitor. Use plain to show container output`) for _, c := range children { cmd.AddCommand(c.NewDebugger(&options)) } return cmd }