Jonathan A. Sternberg
ac9050261e
Adds some entry-level and developer-friendly docs for the debug adapter. The one in `docs/dap.md` is meant for someone trying to use the debugger while the one in `docs/reference/buildx_dap_build.md` is more focused on documenting the command to be integrated in a debugger extension. Signed-off-by: Jonathan A. Sternberg <jonathan.sternberg@docker.com>
76 lines
1.8 KiB
Go
76 lines
1.8 KiB
Go
package commands
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/docker/buildx/dap"
|
|
"github.com/docker/buildx/dap/common"
|
|
"github.com/docker/buildx/util/cobrautil"
|
|
"github.com/docker/buildx/util/ioset"
|
|
"github.com/docker/buildx/util/progress"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func dapCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
|
|
var options dapOptions
|
|
cmd := &cobra.Command{
|
|
Use: "dap",
|
|
Short: "Start debug adapter protocol compatible debugger",
|
|
}
|
|
cobrautil.MarkCommandExperimental(cmd)
|
|
|
|
dapBuildCmd := buildCmd(dockerCli, rootOpts, &options)
|
|
dapBuildCmd.Args = cobra.RangeArgs(0, 1)
|
|
|
|
// Remove aliases for documentation.
|
|
dapBuildCmd.Aliases = nil
|
|
delete(dapBuildCmd.Annotations, "aliases")
|
|
|
|
cmd.AddCommand(dapBuildCmd)
|
|
return cmd
|
|
}
|
|
|
|
type dapOptions struct{}
|
|
|
|
func (d *dapOptions) New(in ioset.In) (debuggerInstance, error) {
|
|
conn := dap.NewConn(in.Stdin, in.Stdout)
|
|
return &adapterProtocolDebugger{
|
|
Adapter: dap.New[LaunchConfig](),
|
|
conn: conn,
|
|
}, nil
|
|
}
|
|
|
|
type LaunchConfig struct {
|
|
Dockerfile string `json:"dockerfile,omitempty"`
|
|
ContextPath string `json:"contextPath,omitempty"`
|
|
Target string `json:"target,omitempty"`
|
|
common.Config
|
|
}
|
|
|
|
type adapterProtocolDebugger struct {
|
|
*dap.Adapter[LaunchConfig]
|
|
conn dap.Conn
|
|
}
|
|
|
|
func (d *adapterProtocolDebugger) Start(printer *progress.Printer, opts *BuildOptions) error {
|
|
cfg, err := d.Adapter.Start(context.Background(), d.conn)
|
|
if err != nil {
|
|
return errors.Wrap(err, "debug adapter did not start")
|
|
}
|
|
|
|
if cfg.Dockerfile != "" {
|
|
opts.DockerfileName = cfg.Dockerfile
|
|
}
|
|
if cfg.ContextPath != "" {
|
|
opts.ContextPath = cfg.ContextPath
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (d *adapterProtocolDebugger) Stop() error {
|
|
defer d.conn.Close()
|
|
return d.Adapter.Stop()
|
|
}
|