Added minimum debug_fqbn computation in 'debug check' command

Author: cmaglie

arduino/cores/fqbn.go

@@ -30,6 +30,16 @@ type FQBN struct {
 	Configs      *properties.Map
 }
 
+// MustParseFQBN extract an FQBN object from the input string
+// or panics if the input is not a valid FQBN.
+func MustParseFQBN(fqbnIn string) *FQBN {
+	res, err := ParseFQBN(fqbnIn)
+	if err != nil {
+		panic(err)
+	}
+	return res
+}
+
 // ParseFQBN extract an FQBN object from the input string
 func ParseFQBN(fqbnIn string) (*FQBN, error) {
 	// Split fqbn

commands/debug/debug_info.go

@@ -19,6 +19,7 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
+	"reflect"
 	"slices"
 	"strconv"
 	"strings"
@@ -52,23 +53,40 @@ func IsDebugSupported(ctx context.Context, req *rpc.IsDebugSupportedRequest) (*r
 		return nil, &arduino.InvalidInstanceError{}
 	}
 	defer release()
-	_, err := getDebugProperties(&rpc.GetDebugConfigRequest{
+	configRequest := &rpc.GetDebugConfigRequest{
 		Instance:    req.GetInstance(),
 		Fqbn:        req.GetFqbn(),
 		SketchPath:  "",
 		Port:        req.GetPort(),
 		Interpreter: req.GetInterpreter(),
 		ImportDir:   "",
 		Programmer:  req.GetProgrammer(),
-	}, pme, true)
+	}
+	expectedOutput, err := getDebugProperties(configRequest, pme, true)
 	var x *arduino.FailedDebugError
 	if errors.As(err, &x) {
 		return &rpc.IsDebugSupportedResponse{DebuggingSupported: false}, nil
 	}
 	if err != nil {
 		return nil, err
 	}
-	return &rpc.IsDebugSupportedResponse{DebuggingSupported: true}, nil
+
+	// Compute the minimum FQBN required to get the same debug configuration.
+	// (i.e. the FQBN cleaned up of the options that do not affect the debugger configuration)
+	minimumFQBN := cores.MustParseFQBN(req.GetFqbn())
+	for _, config := range minimumFQBN.Configs.Keys() {
+		checkFQBN := minimumFQBN.Clone()
+		checkFQBN.Configs.Remove(config)
+		configRequest.Fqbn = checkFQBN.String()
+		checkOutput, err := getDebugProperties(configRequest, pme, true)
+		if err == nil && reflect.DeepEqual(expectedOutput, checkOutput) {
+			minimumFQBN.Configs.Remove(config)
+		}
+	}
+	return &rpc.IsDebugSupportedResponse{
+		DebuggingSupported: true,
+		DebugFqbn:          minimumFQBN.String(),
+	}, nil
 }
 
 func getDebugProperties(req *rpc.GetDebugConfigRequest, pme *packagemanager.Explorer, skipSketchChecks bool) (*rpc.GetDebugConfigResponse, error) {

internal/cli/feedback/result/rpc.go

@@ -1059,11 +1059,13 @@ func NewCompileDiagnosticNote(cdn *rpc.CompileDiagnosticNote) *CompileDiagnostic
 }
 
 type IsDebugSupportedResponse struct {
-	DebuggingSupported bool `json:"debugging_supported"`
+	DebuggingSupported bool   `json:"debugging_supported"`
+	DebugFQBN          string `json:"debug_fqbn,omitempty"`
 }
 
 func NewIsDebugSupportedResponse(resp *rpc.IsDebugSupportedResponse) *IsDebugSupportedResponse {
 	return &IsDebugSupportedResponse{
 		DebuggingSupported: resp.GetDebuggingSupported(),
+		DebugFQBN:          resp.GetDebugFqbn(),
 	}
 }

internal/integrationtest/debug/debug_test.go

@@ -38,6 +38,12 @@ func TestDebug(t *testing.T) {
 	_, _, err = cli.Run("core", "install", "arduino:samd")
 	require.NoError(t, err)
 
+	// Install custom core
+	customHw, err := paths.New("testdata", "hardware").Abs()
+	require.NoError(t, err)
+	err = customHw.CopyDirTo(cli.SketchbookDir().Join("hardware"))
+	require.NoError(t, err)
+
 	integrationtest.CLISubtests{
 		{"Start", testDebuggerStarts},
 		{"WithPdeSketchStarts", testDebuggerWithPdeSketchStarts},
@@ -102,12 +108,6 @@ func testAllDebugInformation(t *testing.T, env *integrationtest.Environment, cli
 	_, _, err := cli.Run("sketch", "new", sketchPath.String())
 	require.NoError(t, err)
 
-	// Install custom core
-	customHw, err := paths.New("testdata", "hardware").Abs()
-	require.NoError(t, err)
-	err = customHw.CopyDirTo(cli.SketchbookDir().Join("hardware"))
-	require.NoError(t, err)
-
 	// Build sketch
 	_, _, err = cli.Run("compile", "-b", "my:samd:my", sketchPath.String(), "--format", "json")
 	require.NoError(t, err)
@@ -354,4 +354,25 @@ func testDebugCheck(t *testing.T, env *integrationtest.Environment, cli *integra
 	out, _, err = cli.Run("debug", "check", "-b", "arduino:avr:uno", "-P", "atmel_ice", "--format", "json")
 	require.NoError(t, err)
 	requirejson.Query(t, out, `.debugging_supported`, `false`)
+
+	// Test minimum FQBN compute
+	out, _, err = cli.Run("debug", "check", "-b", "my:samd:my5", "-P", "atmel_ice", "--format", "json")
+	require.NoError(t, err)
+	requirejson.Contains(t, out, `{ "debugging_supported" : false }`)
+
+	out, _, err = cli.Run("debug", "check", "-b", "my:samd:my5:dbg=on", "-P", "atmel_ice", "--format", "json")
+	require.NoError(t, err)
+	requirejson.Contains(t, out, `{ "debugging_supported" : true, "debug_fqbn" : "my:samd:my5:dbg=on" }`)
+
+	out, _, err = cli.Run("debug", "check", "-b", "my:samd:my5:dbg=on,cpu=150m", "-P", "atmel_ice", "--format", "json")
+	require.NoError(t, err)
+	requirejson.Contains(t, out, `{ "debugging_supported" : true, "debug_fqbn" : "my:samd:my5:dbg=on" }`)
+
+	out, _, err = cli.Run("debug", "check", "-b", "my:samd:my6", "-P", "atmel_ice", "--format", "json")
+	require.NoError(t, err)
+	requirejson.Contains(t, out, `{ "debugging_supported" : true, "debug_fqbn" : "my:samd:my6" }`)
+
+	out, _, err = cli.Run("debug", "check", "-b", "my:samd:my6:dbg=on", "-P", "atmel_ice", "--format", "json")
+	require.NoError(t, err)
+	requirejson.Contains(t, out, `{ "debugging_supported" : true, "debug_fqbn" : "my:samd:my6" }`)
 }

internal/integrationtest/debug/testdata/hardware/my/samd/boards.txt

@@ -112,3 +112,39 @@ my4.build.mcu=test2
 # this one will be overwritten by additional_config
 my4.debug.svd_file=svd-file
 my4.debug.additional_config=build.debug.config.{build.mcu}
+
+# menu options for the following boards
+menu.dbg=Debugger
+menu.cpu=CPU Speed
+
+# This does not support debug by default but only after selecting a menu option
+my5.name=5th Board
+my5.build.core=arduino:arduino
+my5.build.variant=arduino:mkr1000
+my5.debug.toolchain.path=gcc-path
+my5.debug.toolchain.prefix=gcc-prefix
+my5.debug.server.openocd.path=openocd-path
+my5.debug.server.openocd.scripts_dir=openocd-scripts-dir
+my5.debug.server.openocd.script=single-script
+my5.debug.executable=
+my5.menu.dbg.off=Debug Disabled
+my5.menu.dbg.on=Debug Enabled
+my5.menu.dbg.on.debug.executable=YES
+my5.menu.cpu.100m=100Mhz
+my5.menu.cpu.150m=150Mhz
+
+# this one has debugger enabled by default
+my6.name=5th Board
+my6.build.core=arduino:arduino
+my6.build.variant=arduino:mkr1000
+my6.debug.toolchain.path=gcc-path
+my6.debug.toolchain.prefix=gcc-prefix
+my6.debug.server.openocd.path=openocd-path
+my6.debug.server.openocd.scripts_dir=openocd-scripts-dir
+my6.debug.server.openocd.script=single-script
+my6.debug.executable=
+my6.menu.dbg.on=Debug Enabled
+my6.menu.dbg.on.debug.executable=YES
+my6.menu.dbg.off=Debug Disabled
+my6.menu.cpu.100m=100Mhz
+my6.menu.cpu.150m=150Mhz