Improved specification of debug configuration

Author: cmaglie

commands/debug/debug.go

@@ -158,13 +158,18 @@ func getCommandLine(req *rpc.GetDebugConfigRequest, pme *packagemanager.Explorer
 	// Extract path to GDB Server
 	switch debugInfo.GetServer() {
 	case "openocd":
+		var openocdConf rpc.DebugOpenOCDServerConfiguration
+		if err := debugInfo.ServerConfiguration.UnmarshalTo(&openocdConf); err != nil {
+			return nil, err
+		}
+
 		serverCmd := fmt.Sprintf(`target extended-remote | "%s"`, debugInfo.ServerPath)
 
-		if cfg := debugInfo.ServerConfiguration["scripts_dir"]; cfg != "" {
+		if cfg := openocdConf.GetScriptsDir(); cfg != "" {
 			serverCmd += fmt.Sprintf(` -s "%s"`, cfg)
 		}
 
-		if script := debugInfo.ServerConfiguration["script"]; script != "" {
+		for _, script := range openocdConf.GetScripts() {
 			serverCmd += fmt.Sprintf(` --file "%s"`, script)
 		}
 

commands/debug/debug_info.go

@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/sirupsen/logrus"
+	"google.golang.org/protobuf/types/known/anypb"
 )
 
 // GetDebugConfig returns metadata to start debugging with the specified board
@@ -150,14 +151,43 @@ func getDebugProperties(req *rpc.GetDebugConfigRequest, pme *packagemanager.Expl
 
 	server := debugProperties.Get("server")
 	toolchain := debugProperties.Get("toolchain")
+
+	var serverConfiguration anypb.Any
+	switch server {
+	case "openocd":
+		openocdProperties := debugProperties.SubTree("server." + server)
+		scripts := openocdProperties.ExtractSubIndexLists("scripts")
+		if s := openocdProperties.Get("script"); s != "" {
+			// backward compatibility
+			scripts = append(scripts, s)
+		}
+		openocdConf := &rpc.DebugOpenOCDServerConfiguration{
+			Path:       openocdProperties.Get("path"),
+			ScriptsDir: openocdProperties.Get("scripts_dir"),
+			Scripts:    scripts,
+		}
+		if err := serverConfiguration.MarshalFrom(openocdConf); err != nil {
+			return nil, err
+		}
+	}
+
+	var toolchainConfiguration anypb.Any
+	switch toolchain {
+	case "gcc":
+		gccConf := &rpc.DebugGCCToolchainConfiguration{}
+		if err := toolchainConfiguration.MarshalFrom(gccConf); err != nil {
+			return nil, err
+		}
+	}
+
 	return &rpc.GetDebugConfigResponse{
 		Executable:             debugProperties.Get("executable"),
 		Server:                 server,
 		ServerPath:             debugProperties.Get("server." + server + ".path"),
-		ServerConfiguration:    debugProperties.SubTree("server." + server).AsMap(),
+		ServerConfiguration:    &serverConfiguration,
 		Toolchain:              toolchain,
 		ToolchainPath:          debugProperties.Get("toolchain.path"),
 		ToolchainPrefix:        debugProperties.Get("toolchain.prefix"),
-		ToolchainConfiguration: debugProperties.SubTree("toolchain." + toolchain).AsMap(),
+		ToolchainConfiguration: &toolchainConfiguration,
 	}, nil
 }

docs/UPGRADING.md

@@ -4,6 +4,43 @@ Here you can find a list of migration guides to handle breaking changes between
 
 ## 0.35.0
 
+### CLI `debug --info` changed JSON output.
+
+The string field `server_configuration.script` is now an array and has been renamed `scripts`, here an example:
+
+```json
+{
+  "executable": "/tmp/arduino/sketches/002050EAA7EFB9A4FC451CDFBC0FA2D3/Blink.ino.elf",
+  "toolchain": "gcc",
+  "toolchain_path": "/home/user/.arduino15/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4/bin/",
+  "toolchain_prefix": "arm-none-eabi-",
+  "server": "openocd",
+  "server_path": "/home/user/.arduino15/packages/arduino/tools/openocd/0.10.0-arduino7/bin/openocd",
+  "server_configuration": {
+    "path": "/home/user/.arduino15/packages/arduino/tools/openocd/0.10.0-arduino7/bin/openocd",
+    "scripts_dir": "/home/user/.arduino15/packages/arduino/tools/openocd/0.10.0-arduino7/share/openocd/scripts/",
+    "scripts": [
+      "/home/user/Workspace/arduino-cli/internal/integrationtest/debug/testdata/hardware/my/samd/variants/arduino:mkr1000/openocd_scripts/arduino_zero.cfg"
+    ]
+  }
+}
+```
+
+### gRPC `cc.arduino.cli.commands.v1.GetDebugConfigResponse` message has been changed.
+
+The fields `toolchain_configuration` and `server_configuration` are no more generic `map<string, string>` but they have
+changed type to `goog.protobuf.Any`, the concrete type is assigned at runtime based on the value of `toolchain` and
+`server` fields respectively.
+
+For the moment:
+
+- only `gcc` is supported for `toolchain`, and the concrete type for `toolchain_configuration` is
+  `DebugGCCToolchainConfiguration`.
+- only `openocd` is supported for `server`, and the concrete type for `server_configuration` is
+  `DebugOpenOCDServerConfiguration`
+
+More concrete type may be added in the future as more servers/toolchains support is implemented.
+
 ### gRPC service `cc.arduino.cli.debug.v1` moved to `cc.arduino.cli.commands.v1`.
 
 The gRPC service `cc.arduino.cli.debug.v1` has been removed and all gRPC messages and rpc calls have been moved to

internal/cli/debug/debug.go

@@ -19,7 +19,6 @@ import (
 	"context"
 	"os"
 	"os/signal"
-	"sort"
 
 	"github.com/arduino/arduino-cli/commands/debug"
 	"github.com/arduino/arduino-cli/commands/sketch"
@@ -29,7 +28,6 @@ import (
 	"github.com/arduino/arduino-cli/internal/cli/instance"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
-	"github.com/arduino/go-properties-orderedmap"
 	"github.com/fatih/color"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -96,7 +94,7 @@ func runDebugCommand(command *cobra.Command, args []string) {
 		if res, err := debug.GetDebugConfig(context.Background(), debugConfigRequested); err != nil {
 			feedback.Fatal(tr("Error getting Debug info: %v", err), feedback.ErrBadArgument)
 		} else {
-			feedback.PrintResult(&debugInfoResult{res})
+			feedback.PrintResult(newDebugInfoResult(res))
 		}
 
 	} else {
@@ -117,40 +115,83 @@ func runDebugCommand(command *cobra.Command, args []string) {
 }
 
 type debugInfoResult struct {
-	info *rpc.GetDebugConfigResponse
+	Executable      string `json:"executable,omitempty"`
+	Toolchain       string `json:"toolchain,omitempty"`
+	ToolchainPath   string `json:"toolchain_path,omitempty"`
+	ToolchainPrefix string `json:"toolchain_prefix,omitempty"`
+	ToolchainConfig any    `json:"toolchain_configuration,omitempty"`
+	Server          string `json:"server,omitempty"`
+	ServerPath      string `json:"server_path,omitempty"`
+	ServerConfig    any    `json:"server_configuration,omitempty"`
+}
+
+type openOcdServerConfigResult struct {
+	Path       string   `json:"path,omitempty"`
+	ScriptsDir string   `json:"scripts_dir,omitempty"`
+	Scripts    []string `json:"scripts,omitempty"`
+}
+
+func newDebugInfoResult(info *rpc.GetDebugConfigResponse) *debugInfoResult {
+	var toolchaingConfig interface{}
+	var serverConfig interface{}
+	switch info.Server {
+	case "openocd":
+		var openocdConf rpc.DebugOpenOCDServerConfiguration
+		if err := info.GetServerConfiguration().UnmarshalTo(&openocdConf); err != nil {
+			feedback.Fatal(tr("Error during Debug: %v", err), feedback.ErrGeneric)
+		}
+		serverConfig = &openOcdServerConfigResult{
+			Path:       openocdConf.Path,
+			ScriptsDir: openocdConf.ScriptsDir,
+			Scripts:    openocdConf.Scripts,
+		}
+	}
+	return &debugInfoResult{
+		Executable:      info.Executable,
+		Toolchain:       info.Toolchain,
+		ToolchainPath:   info.ToolchainPath,
+		ToolchainPrefix: info.ToolchainPrefix,
+		ToolchainConfig: toolchaingConfig,
+		Server:          info.Server,
+		ServerPath:      info.ServerPath,
+		ServerConfig:    serverConfig,
+	}
 }
 
 func (r *debugInfoResult) Data() interface{} {
-	return r.info
+	return r
 }
 
 func (r *debugInfoResult) String() string {
 	t := table.New()
 	green := color.New(color.FgHiGreen)
 	dimGreen := color.New(color.FgGreen)
-	t.AddRow(tr("Executable to debug"), table.NewCell(r.info.GetExecutable(), green))
-	t.AddRow(tr("Toolchain type"), table.NewCell(r.info.GetToolchain(), green))
-	t.AddRow(tr("Toolchain path"), table.NewCell(r.info.GetToolchainPath(), dimGreen))
-	t.AddRow(tr("Toolchain prefix"), table.NewCell(r.info.GetToolchainPrefix(), dimGreen))
-	if len(r.info.GetToolchainConfiguration()) > 0 {
-		conf := properties.NewFromHashmap(r.info.GetToolchainConfiguration())
-		keys := conf.Keys()
-		sort.Strings(keys)
-		t.AddRow(tr("Toolchain custom configurations"))
-		for _, k := range keys {
-			t.AddRow(table.NewCell(" - "+k, dimGreen), table.NewCell(conf.Get(k), dimGreen))
-		}
+	t.AddRow(tr("Executable to debug"), table.NewCell(r.Executable, green))
+	t.AddRow(tr("Toolchain type"), table.NewCell(r.Toolchain, green))
+	t.AddRow(tr("Toolchain path"), table.NewCell(r.ToolchainPath, dimGreen))
+	t.AddRow(tr("Toolchain prefix"), table.NewCell(r.ToolchainPrefix, dimGreen))
+	switch r.Toolchain {
+	case "gcc":
+		// no options available at the moment...
+	default:
 	}
-	t.AddRow(tr("GDB Server type"), table.NewCell(r.info.GetServer(), green))
-	t.AddRow(tr("GDB Server path"), table.NewCell(r.info.GetServerPath(), dimGreen))
-	if len(r.info.GetServerConfiguration()) > 0 {
-		conf := properties.NewFromHashmap(r.info.GetServerConfiguration())
-		keys := conf.Keys()
-		sort.Strings(keys)
-		t.AddRow(tr("Configuration options for %s", r.info.GetServer()))
-		for _, k := range keys {
-			t.AddRow(table.NewCell(" - "+k, dimGreen), table.NewCell(conf.Get(k), dimGreen))
+	t.AddRow(tr("Server type"), table.NewCell(r.Server, green))
+	t.AddRow(tr("Server path"), table.NewCell(r.ServerPath, dimGreen))
+
+	switch r.Server {
+	case "openocd":
+		t.AddRow(tr("Configuration options for %s", r.Server))
+		openocdConf := r.ServerConfig.(openOcdServerConfigResult)
+		if openocdConf.Path != "" {
+			t.AddRow(" - Path", table.NewCell(openocdConf.Path, dimGreen))
+		}
+		if openocdConf.ScriptsDir != "" {
+			t.AddRow(" - Scripts Directory", table.NewCell(openocdConf.ScriptsDir, dimGreen))
+		}
+		for _, script := range openocdConf.Scripts {
+			t.AddRow(" - Script", table.NewCell(script, dimGreen))
 		}
+	default:
 	}
 	return t.Render()
 }