debug_check.go

// 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 license@arduino.cc.

package debug

import (
	"context"
	"os"

	"github.com/arduino/arduino-cli/internal/cli/arguments"
	"github.com/arduino/arduino-cli/internal/cli/feedback"
	"github.com/arduino/arduino-cli/internal/cli/feedback/result"
	"github.com/arduino/arduino-cli/internal/cli/instance"
	"github.com/arduino/arduino-cli/internal/i18n"
	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
	"github.com/sirupsen/logrus"
	"github.com/spf13/cobra"
)

func newDebugCheckCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
	var (
		fqbnArg         arguments.Fqbn
		portArgs        arguments.Port
		interpreter     string
		programmer      arguments.Programmer
		debugProperties []string
	)
	debugCheckCommand := &cobra.Command{
		Use:     "check",
		Short:   i18n.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(cmd.Context(), srv, &portArgs, &fqbnArg, interpreter, &programmer, debugProperties)
		},
	}
	fqbnArg.AddToCommand(debugCheckCommand, srv)
	portArgs.AddToCommand(debugCheckCommand, srv)
	programmer.AddToCommand(debugCheckCommand, srv)
	debugCheckCommand.Flags().StringVar(&interpreter, "interpreter", "console", i18n.Tr("Debug interpreter e.g.: %s", "console, mi, mi1, mi2, mi3"))
	debugCheckCommand.Flags().StringArrayVar(&debugProperties, "debug-property", []string{},
		i18n.Tr("Override an debug property with a custom value. Can be used multiple times for multiple properties."))
	return debugCheckCommand
}

func runDebugCheckCommand(ctx context.Context, srv rpc.ArduinoCoreServiceServer, portArgs *arguments.Port,
	fqbnArg *arguments.Fqbn, interpreter string, programmerArg *arguments.Programmer, debugProperties []string,
) {
	instance := instance.CreateAndInit(ctx, srv)
	logrus.Info("Executing `arduino-cli debug`")

	port, err := portArgs.GetPort(ctx, instance, srv, "", "", nil)
	if err != nil {
		feedback.FatalError(err, feedback.ErrBadArgument)
	}
	fqbn := fqbnArg.String()
	resp, err := srv.IsDebugSupported(ctx, &rpc.IsDebugSupportedRequest{
		Instance:        instance,
		Fqbn:            fqbn,
		Port:            port,
		Interpreter:     interpreter,
		Programmer:      programmerArg.String(ctx, instance, srv, fqbn),
		DebugProperties: debugProperties,
	})
	if err != nil {
		feedback.FatalError(err, feedback.ErrGeneric)
	}
	feedback.PrintResult(&debugCheckResult{result.NewIsDebugSupportedResponse(resp)})
}

type debugCheckResult struct {
	Result *result.IsDebugSupportedResponse
}

func (d *debugCheckResult) Data() interface{} {
	return d.Result
}

func (d *debugCheckResult) String() string {
	if d.Result.DebuggingSupported {
		return i18n.Tr("The given board/programmer configuration supports debugging.")
	}
	return i18n.Tr("The given board/programmer configuration does NOT support debugging.")
}