Change gRPC upload functions to use new Port message

Author: silvanocerza

cli/burnbootloader/burnbootloader.go

@@ -19,6 +19,7 @@ import (
 	"context"
 	"os"
 
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
@@ -29,7 +30,7 @@ import (
 
 var (
 	fqbn       string
-	port       string
+	port       arguments.Port
 	verbose    bool
 	verify     bool
 	programmer string
@@ -48,7 +49,7 @@ func NewCommand() *cobra.Command {
 	}
 
 	burnBootloaderCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
-	burnBootloaderCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
+	port.AddToCommand(burnBootloaderCommand)
 	burnBootloaderCommand.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
 	burnBootloaderCommand.Flags().BoolVarP(&verbose, "verbose", "v", false, "Turns on verbose mode.")
 	burnBootloaderCommand.Flags().StringVarP(&programmer, "programmer", "P", "", "Use the specified programmer to upload.")
@@ -61,10 +62,17 @@ func NewCommand() *cobra.Command {
 func run(command *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
 
+	// We don't need a Sketch to upload a board's bootloader
+	discoveryPort, err := port.GetPort(instance, nil)
+	if err != nil {
+		feedback.Errorf("Error during Upload: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+
 	if _, err := upload.BurnBootloader(context.Background(), &rpc.BurnBootloaderRequest{
 		Instance:   instance,
 		Fqbn:       fqbn,
-		Port:       port,
+		Port:       discoveryPort.ToRPC(),
 		Verbose:    verbose,
 		Verify:     verify,
 		Programmer: programmer,

cli/compile/compile.go

@@ -21,6 +21,7 @@ import (
 	"encoding/json"
 	"os"
 
+	"github.com/arduino/arduino-cli/arduino/discovery"
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/feedback"
@@ -37,25 +38,25 @@ import (
 )
 
 var (
-	fqbn                    string   // Fully Qualified Board Name, e.g.: arduino:avr:uno.
-	showProperties          bool     // Show all build preferences used instead of compiling.
-	preprocess              bool     // Print preprocessed code to stdout.
-	buildCachePath          string   // Builds of 'core.a' are saved into this path to be cached and reused.
-	buildPath               string   // Path where to save compiled files.
-	buildProperties         []string // List of custom build properties separated by commas. Or can be used multiple times for multiple properties.
-	warnings                string   // Used to tell gcc which warning level to use.
-	verbose                 bool     // Turns on verbose mode.
-	quiet                   bool     // Suppresses almost every output.
-	vidPid                  string   // VID/PID specific build properties.
-	uploadAfterCompile      bool     // Upload the binary after the compilation.
-	port                    string   // Upload port, e.g.: COM10 or /dev/ttyACM0.
-	verify                  bool     // Upload, verify uploaded binary after the upload.
-	exportDir               string   // The compiled binary is written to this file
-	optimizeForDebug        bool     // Optimize compile output for debug, not for release
-	programmer              string   // Use the specified programmer to upload
-	clean                   bool     // Cleanup the build folder and do not use any cached build
-	compilationDatabaseOnly bool     // Only create compilation database without actually compiling
-	sourceOverrides         string   // Path to a .json file that contains a set of replacements of the sketch source code.
+	fqbn                    string         // Fully Qualified Board Name, e.g.: arduino:avr:uno.
+	showProperties          bool           // Show all build preferences used instead of compiling.
+	preprocess              bool           // Print preprocessed code to stdout.
+	buildCachePath          string         // Builds of 'core.a' are saved into this path to be cached and reused.
+	buildPath               string         // Path where to save compiled files.
+	buildProperties         []string       // List of custom build properties separated by commas. Or can be used multiple times for multiple properties.
+	warnings                string         // Used to tell gcc which warning level to use.
+	verbose                 bool           // Turns on verbose mode.
+	quiet                   bool           // Suppresses almost every output.
+	vidPid                  string         // VID/PID specific build properties.
+	uploadAfterCompile      bool           // Upload the binary after the compilation.
+	port                    arguments.Port // Upload port, e.g.: COM10 or /dev/ttyACM0.
+	verify                  bool           // Upload, verify uploaded binary after the upload.
+	exportDir               string         // The compiled binary is written to this file
+	optimizeForDebug        bool           // Optimize compile output for debug, not for release
+	programmer              string         // Use the specified programmer to upload
+	clean                   bool           // Cleanup the build folder and do not use any cached build
+	compilationDatabaseOnly bool           // Only create compilation database without actually compiling
+	sourceOverrides         string         // Path to a .json file that contains a set of replacements of the sketch source code.
 	// library and libraries sound similar but they're actually different.
 	// library expects a path to the root folder of one single library.
 	// libraries expects a path to a directory containing multiple libraries, similarly to the <directories.user>/libraries path.
@@ -94,7 +95,7 @@ func NewCommand() *cobra.Command {
 	command.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
 	command.Flags().BoolVar(&quiet, "quiet", false, "Optional, suppresses almost every output.")
 	command.Flags().BoolVarP(&uploadAfterCompile, "upload", "u", false, "Upload the binary after the compilation.")
-	command.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
+	port.AddToCommand(command)
 	command.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
 	command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if board supports them.")
 	command.Flags().StringSliceVar(&library, "library", []string{},
@@ -186,11 +187,23 @@ func run(cmd *cobra.Command, args []string) {
 	}
 
 	if err == nil && uploadAfterCompile {
+
+		var sk *sketch.Sketch
+		sk, err = sketch.New(sketchPath)
+		if err != nil {
+
+		}
+		var discoveryPort *discovery.Port
+		discoveryPort, err = port.GetPort(inst, sk)
+		if err != nil {
+
+		}
+
 		uploadRequest := &rpc.UploadRequest{
 			Instance:   inst,
 			Fqbn:       fqbn,
 			SketchPath: sketchPath.String(),
-			Port:       port,
+			Port:       discoveryPort.ToRPC(),
 			Verbose:    verbose,
 			Verify:     verify,
 			ImportDir:  buildPath,

cli/upload/upload.go

@@ -31,7 +31,7 @@ import (
 
 var (
 	fqbn       string
-	port       string
+	port       arguments.Port
 	verbose    bool
 	verify     bool
 	importDir  string
@@ -53,7 +53,7 @@ func NewCommand() *cobra.Command {
 	}
 
 	uploadCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
-	uploadCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
+	port.AddToCommand(uploadCommand)
 	uploadCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Directory containing binaries to upload.")
 	uploadCommand.Flags().StringVarP(&importFile, "input-file", "i", "", "Binary file to upload.")
 	uploadCommand.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
@@ -88,11 +88,22 @@ func run(command *cobra.Command, args []string) {
 		}
 	}
 
+	sk, err := sketch.New(sketchPath)
+	if err != nil {
+		feedback.Errorf("Error during Upload: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	discoveryPort, err := port.GetPort(instance, sk)
+	if err != nil {
+		feedback.Errorf("Error during Upload: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+
 	if _, err := upload.Upload(context.Background(), &rpc.UploadRequest{
 		Instance:   instance,
 		Fqbn:       fqbn,
 		SketchPath: sketchPath.String(),
-		Port:       port,
+		Port:       discoveryPort.ToRPC(),
 		Verbose:    verbose,
 		Verify:     verify,
 		ImportFile: importFile,

commands/upload/upload.go

@@ -19,7 +19,6 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"net/url"
 	"path/filepath"
 	"strings"
 
@@ -37,6 +36,22 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+// getToolId returns the ID of the tool that supports the action and protocol combination by searching in props.
+// Returns error if tool cannot be found.
+func getToolId(props *properties.Map, action, protocol string) (string, error) {
+	toolProperty := fmt.Sprintf("%s.tool.%s", action, protocol)
+	defaultToolProperty := fmt.Sprintf("%s.tool.default", action)
+
+	if t, ok := props.GetOk(toolProperty); ok {
+		return t, nil
+	} else if t, ok := props.GetOk(defaultToolProperty); ok {
+		// Fallback for platform that don't support the specified protocol for specified action:
+		// https://github.com/arduino/tooling-rfcs/blob/main/RFCs/0002-pluggable-discovery.md#support-for-default-fallback-allows-upload-without-a-port
+		return t, nil
+	}
+	return "", fmt.Errorf("cannot find tool: undefined '%s' property", toolProperty)
+}
+
 // Upload FIXMEDOC
 func Upload(ctx context.Context, req *rpc.UploadRequest, outStream io.Writer, errStream io.Writer) (*rpc.UploadResponse, error) {
 	logrus.Tracef("Upload %s on %s started", req.GetSketchPath(), req.GetFqbn())
@@ -95,7 +110,7 @@ func UsingProgrammer(ctx context.Context, req *rpc.UploadUsingProgrammerRequest,
 
 func runProgramAction(pm *packagemanager.PackageManager,
 	sk *sketch.Sketch,
-	importFile, importDir, fqbnIn, port string,
+	importFile, importDir, fqbnIn string, port *rpc.Port,
 	programmerID string,
 	verbose, verify, burnBootloader bool,
 	outStream, errStream io.Writer,
@@ -105,16 +120,6 @@ func runProgramAction(pm *packagemanager.PackageManager,
 		return fmt.Errorf("no programmer specified for burning bootloader")
 	}
 
-	// FIXME: make a specification on how a port is specified via command line
-	if port == "" && sk != nil && sk.Metadata != nil {
-		deviceURI, err := url.Parse(sk.Metadata.CPU.Port)
-		if err != nil {
-			return fmt.Errorf("invalid Device URL format: %s", err)
-		}
-		if deviceURI.Scheme == "serial" {
-			port = deviceURI.Host + deviceURI.Path
-		}
-	}
 	logrus.WithField("port", port).Tracef("Upload port")
 
 	if fqbnIn == "" && sk != nil && sk.Metadata != nil {
@@ -154,28 +159,23 @@ func runProgramAction(pm *packagemanager.PackageManager,
 	}
 
 	// Determine upload tool
-	var uploadToolID string
-	{
-		toolProperty := "upload.tool"
-		if burnBootloader {
-			toolProperty = "bootloader.tool"
-		} else if programmer != nil {
-			toolProperty = "program.tool"
-		}
-
-		// create a temporary configuration only for the selection of upload tool
-		props := properties.NewMap()
-		props.Merge(boardPlatform.Properties)
-		props.Merge(boardPlatform.RuntimeProperties())
-		props.Merge(boardProperties)
-		if programmer != nil {
-			props.Merge(programmer.Properties)
-		}
-		if t, ok := props.GetOk(toolProperty); ok {
-			uploadToolID = t
-		} else {
-			return fmt.Errorf("cannot get programmer tool: undefined '%s' property", toolProperty)
-		}
+	// create a temporary configuration only for the selection of upload tool
+	props := properties.NewMap()
+	props.Merge(boardPlatform.Properties)
+	props.Merge(boardPlatform.RuntimeProperties())
+	props.Merge(boardProperties)
+	if programmer != nil {
+		props.Merge(programmer.Properties)
+	}
+	action := "upload"
+	if burnBootloader {
+		action = "bootloader"
+	} else if programmer != nil {
+		action = "program"
+	}
+	uploadToolID, err := getToolId(props, action, port.Protocol)
+	if err != nil {
+		return err
 	}
 
 	var uploadToolPlatform *cores.PlatformRelease
@@ -299,7 +299,7 @@ func runProgramAction(pm *packagemanager.PackageManager,
 		wait := false
 		portToTouch := ""
 		if touch {
-			portToTouch = port
+			portToTouch = port.Address
 			// Waits for upload port only if a 1200bps touch is done
 			wait = uploadProperties.GetBoolean("upload.wait_for_upload_port")
 		}
@@ -349,18 +349,18 @@ func runProgramAction(pm *packagemanager.PackageManager,
 			outStream.Write([]byte(fmt.Sprintln()))
 		} else {
 			if newPort != "" {
-				actualPort = newPort
+				actualPort.Address = newPort
 			}
 		}
 	}
 
-	if actualPort != "" {
+	if actualPort.Address != "" {
 		// Set serial port property
-		uploadProperties.Set("serial.port", actualPort)
-		if strings.HasPrefix(actualPort, "/dev/") {
-			uploadProperties.Set("serial.port.file", actualPort[5:])
-		} else {
-			uploadProperties.Set("serial.port.file", actualPort)
+		uploadProperties.Set("serial.port", actualPort.Address)
+		if actualPort.Protocol == "serial" {
+			// This must be done only for serial ports
+			portFile := strings.TrimPrefix(actualPort.Address, "/dev/")
+			uploadProperties.Set("serial.port.file", portFile)
 		}
 	}