Add recipe calculation to debug command

Author: rsora

commands/debug/debug.go

@@ -18,7 +18,16 @@ package debug
 import (
 	"context"
 	"fmt"
+	"github.com/arduino/arduino-cli/arduino/cores"
+	"github.com/arduino/arduino-cli/arduino/sketches"
+	"github.com/arduino/arduino-cli/commands"
+	"github.com/arduino/go-paths-helper"
+	"github.com/arduino/go-properties-orderedmap"
+	"github.com/sirupsen/logrus"
 	"io"
+	"os"
+	"path/filepath"
+	"strings"
 	"time"
 
 	"github.com/arduino/arduino-cli/executils"
@@ -27,7 +36,149 @@ import (
 
 // Debug FIXMEDOC
 func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream dbg.Debug_DebugServer, out io.Writer) (*dbg.DebugResp, error) {
-	cmdArgs := []string{"gdb"}
+
+	// TODO: make a generic function to extract sketch from request
+	// and remove duplication in commands/compile.go
+	if req.GetSketchPath() == "" {
+		return nil, fmt.Errorf("missing sketchPath")
+	}
+	sketchPath := paths.New(req.GetSketchPath())
+	sketch, err := sketches.NewSketchFromPath(sketchPath)
+	if err != nil {
+		return nil, fmt.Errorf("opening sketch: %s", err)
+	}
+
+	// FIXME: make a specification on how a port is specified via command line
+	port := req.GetPort()
+	if port == "" {
+		return nil, fmt.Errorf("no upload port provided")
+	}
+
+	fqbnIn := req.GetFqbn()
+	if fqbnIn == "" && sketch != nil && sketch.Metadata != nil {
+		fqbnIn = sketch.Metadata.CPU.Fqbn
+	}
+	if fqbnIn == "" {
+		return nil, fmt.Errorf("no Fully Qualified Board Name provided")
+	}
+	fqbn, err := cores.ParseFQBN(fqbnIn)
+	if err != nil {
+		return nil, fmt.Errorf("incorrect FQBN: %s", err)
+	}
+
+	pm := commands.GetPackageManager(req.GetInstance().GetId())
+
+	// Find target board and board properties
+	_, _, board, boardProperties, _, err := pm.ResolveFQBN(fqbn)
+	if err != nil {
+		return nil, fmt.Errorf("incorrect FQBN: %s", err)
+	}
+
+	// Load programmer tool
+	uploadToolPattern, have := boardProperties.GetOk("debug.tool")
+	if !have || uploadToolPattern == "" {
+		return nil, fmt.Errorf("cannot get programmer tool: undefined 'debug.tool' property")
+	}
+
+	var referencedPlatformRelease *cores.PlatformRelease
+	if split := strings.Split(uploadToolPattern, ":"); len(split) > 2 {
+		return nil, fmt.Errorf("invalid 'debug.tool' property: %s", uploadToolPattern)
+	} else if len(split) == 2 {
+		referencedPackageName := split[0]
+		uploadToolPattern = split[1]
+		architecture := board.PlatformRelease.Platform.Architecture
+
+		if referencedPackage := pm.Packages[referencedPackageName]; referencedPackage == nil {
+			return nil, fmt.Errorf("required platform %s:%s not installed", referencedPackageName, architecture)
+		} else if referencedPlatform := referencedPackage.Platforms[architecture]; referencedPlatform == nil {
+			return nil, fmt.Errorf("required platform %s:%s not installed", referencedPackageName, architecture)
+		} else {
+			referencedPlatformRelease = pm.GetInstalledPlatformRelease(referencedPlatform)
+		}
+	}
+
+	// Build configuration for upload
+	debugProperties := properties.NewMap()
+	if referencedPlatformRelease != nil {
+		debugProperties.Merge(referencedPlatformRelease.Properties)
+	}
+	debugProperties.Merge(board.PlatformRelease.Properties)
+	debugProperties.Merge(board.PlatformRelease.RuntimeProperties())
+	debugProperties.Merge(boardProperties)
+
+	uploadToolProperties := debugProperties.SubTree("tools." + uploadToolPattern)
+	debugProperties.Merge(uploadToolProperties)
+
+	if requiredTools, err := pm.FindToolsRequiredForBoard(board); err == nil {
+		for _, requiredTool := range requiredTools {
+			logrus.WithField("tool", requiredTool).Info("Tool required for upload")
+			debugProperties.Merge(requiredTool.RuntimeProperties())
+		}
+	}
+
+	// Set properties for verbose upload
+	Verbose := req.GetVerbose()
+	if Verbose {
+		if v, ok := debugProperties.GetOk("debug.params.verbose"); ok {
+			debugProperties.Set("debug.verbose", v)
+		}
+	} else {
+		if v, ok := debugProperties.GetOk("debug.params.quiet"); ok {
+			debugProperties.Set("debug.verbose", v)
+		}
+	}
+
+	// Set path to compiled binary
+	// Make the filename without the FQBN configs part
+	fqbn.Configs = properties.NewMap()
+	fqbnSuffix := strings.Replace(fqbn.String(), ":", ".", -1)
+
+	var importPath *paths.Path
+	var importFile string
+	if req.GetImportFile() == "" {
+		importPath = sketch.FullPath
+		importFile = sketch.Name + "." + fqbnSuffix
+	} else {
+		importPath = paths.New(req.GetImportFile()).Parent()
+		importFile = paths.New(req.GetImportFile()).Base()
+	}
+
+	outputTmpFile, ok := debugProperties.GetOk("recipe.output.tmp_file")
+	outputTmpFile = debugProperties.ExpandPropsInString(outputTmpFile)
+	if !ok {
+		return nil, fmt.Errorf("property 'recipe.output.tmp_file' not defined")
+	}
+	ext := filepath.Ext(outputTmpFile)
+	if strings.HasSuffix(importFile, ext) {
+		importFile = importFile[:len(importFile)-len(ext)]
+	}
+
+	debugProperties.SetPath("build.path", importPath)
+	debugProperties.Set("build.project_name", importFile)
+	uploadFile := importPath.Join(importFile + ext)
+	if _, err := uploadFile.Stat(); err != nil {
+		if os.IsNotExist(err) {
+			return nil, fmt.Errorf("compiled sketch %s not found", uploadFile.String())
+		}
+		return nil, fmt.Errorf("cannot open sketch: %s", err)
+	}
+
+	// Set serial port property
+	debugProperties.Set("serial.port", port)
+	if strings.HasPrefix(port, "/dev/") {
+		debugProperties.Set("serial.port.file", port[5:])
+	} else {
+		debugProperties.Set("serial.port.file", port)
+	}
+
+	// Build recipe for upload
+	recipe := debugProperties.Get("debug.pattern")
+	cmdLine := debugProperties.ExpandPropsInString(recipe)
+	cmdArgs, err := properties.SplitQuotedString(cmdLine, `"'`, false)
+	if err != nil {
+		return nil, fmt.Errorf("invalid recipe '%s': %s", recipe, err)
+	}
+
 	// Run Tool
 	cmd, err := executils.Command(cmdArgs)
 	if err != nil {