-
-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added
debug check command to check if a combination of board/progra…
…mmer supports debugging. (#2443) * Moved rcp message to proper position * Added gRPC command to check for debugger support * Made debug flags var non-global * Implementation of 'debug check' command * Implementation of cli command 'debug check' * added integration test * Renamed field for clarity * Added minimum debug_fqbn computation in 'debug check' command
- Loading branch information
Showing
13 changed files
with
844 additions
and
304 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| // This file is part of arduino-cli. | ||
| // | ||
| // Copyright 2023 ARDUINO SA (http://www.arduino.cc/) | ||
| // | ||
| // This software is released under the GNU General Public License version 3, | ||
| // which covers the main part of arduino-cli. | ||
| // The terms of this license can be found at: | ||
| // https://www.gnu.org/licenses/gpl-3.0.en.html | ||
| // | ||
| // You can be released from the requirements of the above licenses by purchasing | ||
| // a commercial license. Buying such a license is mandatory if you want to | ||
| // modify or otherwise use the software for commercial activities involving the | ||
| // Arduino software without disclosing the source code of your own applications. | ||
| // To purchase a commercial license, send an email to [email protected]. | ||
|
|
||
| package debug | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
|
|
||
| "github.com/arduino/arduino-cli/commands/debug" | ||
| "github.com/arduino/arduino-cli/internal/cli/arguments" | ||
| "github.com/arduino/arduino-cli/internal/cli/feedback" | ||
| "github.com/arduino/arduino-cli/internal/cli/instance" | ||
| rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1" | ||
| "github.com/sirupsen/logrus" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func newDebugCheckCommand() *cobra.Command { | ||
| var ( | ||
| fqbnArg arguments.Fqbn | ||
| portArgs arguments.Port | ||
| interpreter string | ||
| programmer arguments.Programmer | ||
| ) | ||
| debugCheckCommand := &cobra.Command{ | ||
| Use: "check", | ||
| Short: tr("Check if the given board/programmer combination supports debugging."), | ||
| Example: " " + os.Args[0] + " debug check -b arduino:samd:mkr1000 -P atmel_ice", | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| runDebugCheckCommand(&portArgs, &fqbnArg, interpreter, &programmer) | ||
| }, | ||
| } | ||
| fqbnArg.AddToCommand(debugCheckCommand) | ||
| portArgs.AddToCommand(debugCheckCommand) | ||
| programmer.AddToCommand(debugCheckCommand) | ||
| debugCheckCommand.Flags().StringVar(&interpreter, "interpreter", "console", tr("Debug interpreter e.g.: %s", "console, mi, mi1, mi2, mi3")) | ||
| return debugCheckCommand | ||
| } | ||
|
|
||
| func runDebugCheckCommand(portArgs *arguments.Port, fqbnArg *arguments.Fqbn, interpreter string, programmerArg *arguments.Programmer) { | ||
| instance := instance.CreateAndInit() | ||
| logrus.Info("Executing `arduino-cli debug`") | ||
|
|
||
| port, err := portArgs.GetPort(instance, "", "") | ||
| if err != nil { | ||
| feedback.FatalError(err, feedback.ErrBadArgument) | ||
| } | ||
| fqbn := fqbnArg.String() | ||
| resp, err := debug.IsDebugSupported(context.Background(), &rpc.IsDebugSupportedRequest{ | ||
| Instance: instance, | ||
| Fqbn: fqbn, | ||
| Port: port, | ||
| Interpreter: interpreter, | ||
| Programmer: programmerArg.String(instance, fqbn), | ||
| }) | ||
| if err != nil { | ||
| feedback.FatalError(err, feedback.ErrGeneric) | ||
| } | ||
| feedback.PrintResult(&debugCheckResult{&isDebugSupportedResponse{ | ||
| DebuggingSupported: resp.GetDebuggingSupported(), | ||
| DebugFQBN: resp.GetDebugFqbn(), | ||
| }}) | ||
| } | ||
|
|
||
| type isDebugSupportedResponse struct { | ||
| DebuggingSupported bool `json:"debugging_supported"` | ||
| DebugFQBN string `json:"debug_fqbn,omitempty"` | ||
| } | ||
|
|
||
| type debugCheckResult struct { | ||
| Result *isDebugSupportedResponse | ||
| } | ||
|
|
||
| func (d *debugCheckResult) Data() interface{} { | ||
| return d.Result | ||
| } | ||
|
|
||
| func (d *debugCheckResult) String() string { | ||
| if d.Result.DebuggingSupported { | ||
| return tr("The given board/programmer configuration supports debugging.") | ||
| } | ||
| return tr("The given board/programmer configuration does NOT support debugging.") | ||
| } |
Oops, something went wrong.