Re-Implementation of 'board attach' command

Author: cmaglie

Diff for: arduino/sketch/sketch.go

@@ -49,9 +49,10 @@ type Metadata struct {
 
 // BoardMetadata represents the board metadata for the sketch
 type BoardMetadata struct {
-	Fqbn string `json:"fqbn"`
-	Name string `json:"name,omitempty"`
-	Port string `json:"port,omitempty"`
+	Fqbn     string `json:"fqbn"`
+	Name     string `json:"name,omitempty"`
+	Port     string `json:"port,omitempty"`
+	Protocol string `json:"protocol,omitempty"`
 }
 
 var tr = i18n.Tr

Diff for: cli/arguments/port.go

@@ -29,7 +29,6 @@ import (
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/commands/board"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
-	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -57,11 +56,12 @@ func (p *Port) AddToCommand(cmd *cobra.Command) {
 }
 
 // GetPortAddressAndProtocol returns only the port address and the port protocol
-// without any other port metadata obtained from the discoveries. This method allows
-// to bypass the discoveries unless the protocol is not specified: in this
-// case the discoveries are needed to autodetect the protocol.
+// without any other port metadata obtained from the discoveries.
+// This method allows will bypass the discoveries if:
+// - a nil instance is passed: in this case the plain port and protocol arguments are returned (even if empty)
+// - a protocol is specified: in this case the discoveries are not needed to autodetect the protocol.
 func (p *Port) GetPortAddressAndProtocol(instance *rpc.Instance, sk *sketch.Sketch) (string, string, error) {
-	if p.protocol != "" {
+	if p.protocol != "" || instance == nil {
 		return p.address, p.protocol, nil
 	}
 	port, err := p.GetPort(instance, sk)
@@ -81,13 +81,17 @@ func (p *Port) GetPort(instance *rpc.Instance, sk *sketch.Sketch) (*discovery.Po
 	protocol := p.protocol
 
 	if address == "" && sk != nil && sk.Metadata != nil {
+		// This is for compatibility with old sketch.json where the address
+		// for serial ports was stored as URL like serial:///dev/ttyACM0, so we
+		// check if we have a URI and the scheme is "serial". In all other
+		// cases we pick the address as is.
 		deviceURI, err := url.Parse(sk.Metadata.CPU.Port)
-		if err != nil {
-			return nil, errors.Errorf("invalid Device URL format: %s", err)
-		}
-		if deviceURI.Scheme == "serial" {
+		if err == nil && deviceURI.Scheme == "serial" {
 			address = deviceURI.Host + deviceURI.Path
+		} else {
+			address = sk.Metadata.CPU.Port
 		}
+		protocol = sk.Metadata.CPU.Protocol
 	}
 	if address == "" {
 		// If no address is provided we assume the user is trying to upload

Diff for: cli/board/attach.go

@@ -0,0 +1,75 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 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 board
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/arduino/arduino-cli/cli/arguments"
+	"github.com/arduino/arduino-cli/cli/errorcodes"
+	"github.com/arduino/arduino-cli/cli/feedback"
+	"github.com/spf13/cobra"
+)
+
+func initAttachCommand() *cobra.Command {
+	var port arguments.Port
+	attachCommand := &cobra.Command{
+		Use:   fmt.Sprintf("attach [-p <%s>] [-b <%s>] [%s]", tr("port"), tr("FQBN"), tr("sketchPath")),
+		Short: tr("Attaches a sketch to a board."),
+		Long:  tr("Attaches a sketch to a board."),
+		Example: "  " + os.Args[0] + " board attach -p /dev/ttyACM0\n" +
+			"  " + os.Args[0] + " board attach -p /dev/ttyACM0 HelloWorld\n" +
+			"  " + os.Args[0] + " board attach -b arduino:samd:mkr1000",
+		Args: cobra.MaximumNArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			sketchPath := ""
+			if len(args) > 0 {
+				sketchPath = args[0]
+			}
+			runAttachCommand(sketchPath, &port, fqbn.String())
+		},
+	}
+	fqbn.AddToCommand(attachCommand)
+	port.AddToCommand(attachCommand)
+
+	return attachCommand
+}
+
+func runAttachCommand(path string, port *arguments.Port, fqbn string) {
+	sketchPath := arguments.InitSketchPath(path)
+	sk := arguments.NewSketch(sketchPath)
+
+	address, protocol, _ := port.GetPortAddressAndProtocol(nil, sk)
+	if address != "" {
+		sk.Metadata.CPU.Port = address
+		sk.Metadata.CPU.Protocol = protocol
+		msg := fmt.Sprintf("%s: %s", tr("Set port to"), address)
+		if protocol != "" {
+			msg += " / " + protocol
+		}
+		feedback.Print(msg)
+	}
+	if fqbn != "" {
+		sk.Metadata.CPU.Fqbn = fqbn
+		msg := fmt.Sprintf("%s: %s", tr("Set FQBN to"), fqbn)
+		feedback.Print(msg)
+	}
+	if err := sk.ExportMetadata(); err != nil {
+		feedback.Errorf("%s: %s", tr("Error saving sketch metadata"), err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+}

Diff for: cli/board/board.go

@@ -34,6 +34,7 @@ func NewCommand() *cobra.Command {
 			"  " + os.Args[0] + " board list",
 	}
 
+	boardCommand.AddCommand(initAttachCommand())
 	boardCommand.AddCommand(initDetailsCommand())
 	boardCommand.AddCommand(initListCommand())
 	boardCommand.AddCommand(initListAllCommand())