[breaking] replace board attach <port|fqbn> <sketch-path> with board attach -b <fqbn> | -p <port> <sketh-path>

Author: umbynos

cli/arguments/port.go

@@ -216,6 +216,11 @@ func (p *Port) GetPort(instance *rpc.Instance, sk *sketch.Sketch) (*discovery.Po
 	}
 }
 
+// GetSearchTimeout returns the timeout
+func (p *Port) GetSearchTimeout() time.Duration {
+	return p.timeout
+}
+
 // CheckFlagsConflicts is a helper function useful to report errors when 2 conflicting flags are used
 func CheckFlagsConflicts(command *cobra.Command, firstFlagName, secondFlagName string) {
 	flag1, _ := command.Flags().GetString(firstFlagName)

cli/board/attach.go

@@ -31,21 +31,24 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var searchTimeout string // Expressed in a parsable duration, is the timeout for the list and attach commands.
+var (
+	port arguments.Port
+)
 
 func initAttachCommand() *cobra.Command {
 	attachCommand := &cobra.Command{
-		Use:   fmt.Sprintf("attach <%s>|<%s> [%s]", tr("port"), tr("FQBN"), tr("sketchPath")),
+		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 serial:///dev/ttyACM0\n" +
-			"  " + os.Args[0] + " board attach serial:///dev/ttyACM0 HelloWorld\n" +
-			"  " + os.Args[0] + " board attach arduino:samd:mkr1000",
-		Args: cobra.RangeArgs(1, 2),
+		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:  runAttachCommand,
 	}
-	attachCommand.Flags().StringVar(&searchTimeout, "timeout", "5s",
-		tr("The connected devices search timeout, raise it if your board doesn't show up (e.g. to %s).", "10s"))
+	fqbn.AddToCommand(attachCommand)
+	port.AddToCommand(attachCommand)
+
 	return attachCommand
 }
 
@@ -55,16 +58,25 @@ func runAttachCommand(cmd *cobra.Command, args []string) {
 	logrus.Info("Executing `arduino-cli board attach`")
 
 	path := ""
-	if len(args) > 1 {
-		path = args[1]
+	if len(args) > 0 {
+		path = args[0]
 	}
 	sketchPath := arguments.InitSketchPath(path)
 
+	// ugly hack to allow user to specify fqbn and port as flags (consistency)
+	// a more meaningful fix would be to fix board.Attach
+	var boardURI string
+	discoveryPort, _ := port.GetPort(instance, nil)
+	if fqbn.GetFQBN() != "" {
+		boardURI = fqbn.GetFQBN()
+	} else if discoveryPort != nil {
+		boardURI = discoveryPort.Address
+	}
 	if _, err := board.Attach(context.Background(), &rpc.BoardAttachRequest{
 		Instance:      instance,
-		BoardUri:      args[0],
+		BoardUri:      boardURI,
 		SketchPath:    sketchPath.String(),
-		SearchTimeout: searchTimeout,
+		SearchTimeout: port.GetSearchTimeout().String(),
 	}, output.TaskProgress()); err != nil {
 		feedback.Errorf(tr("Attach board error: %v"), err)
 		os.Exit(errorcodes.ErrGeneric)

i18n/data/en.po

@@ -190,12 +190,12 @@ msgstr "Arduino core operations."
 msgid "Arguments error: %v"
 msgstr "Arguments error: %v"
 
-#: cli/board/attach.go:69
+#: cli/board/attach.go:81
 msgid "Attach board error: %v"
 msgstr "Attach board error: %v"
 
-#: cli/board/attach.go:39
-#: cli/board/attach.go:40
+#: cli/board/attach.go:41
+#: cli/board/attach.go:42
 #: cli/board/board.go:35
 msgid "Attaches a sketch to a board."
 msgstr "Attaches a sketch to a board."
@@ -272,7 +272,7 @@ msgstr "Can't open sketch"
 msgid "Can't set multiple values in key %v"
 msgstr "Can't set multiple values in key %v"
 
-#: cli/arguments/port.go:224
+#: cli/arguments/port.go:229
 msgid "Can't use both --%s and --%s flags at the same time."
 msgstr "Can't use both --%s and --%s flags at the same time."
 
@@ -1005,7 +1005,7 @@ msgstr "Executable to debug"
 msgid "Expected compiled sketch in directory %s, but is a file instead"
 msgstr "Expected compiled sketch in directory %s, but is a file instead"
 
-#: cli/board/attach.go:38
+#: cli/board/attach.go:40
 #: cli/board/details.go:43
 #: cli/board/list.go:90
 #: cli/board/list.go:128
@@ -2010,10 +2010,6 @@ msgstr "TOUCH: error during reset: %s"
 msgid "The TCP port the daemon will listen to"
 msgstr "The TCP port the daemon will listen to"
 
-#: cli/board/attach.go:48
-msgid "The connected devices search timeout, raise it if your board doesn't show up (e.g. to %s)."
-msgstr "The connected devices search timeout, raise it if your board doesn't show up (e.g. to %s)."
-
 #: cli/board/list.go:51
 msgid "The connected devices search timeout, raise it if your board doesn't show up e.g.: 10s"
 msgstr "The connected devices search timeout, raise it if your board doesn't show up e.g.: 10s"
@@ -3073,7 +3069,7 @@ msgstr "please use --build-property instead."
 msgid "pluggable discovery already added: %s"
 msgstr "pluggable discovery already added: %s"
 
-#: cli/board/attach.go:38
+#: cli/board/attach.go:40
 msgid "port"
 msgstr "port"
 
@@ -3214,7 +3210,7 @@ msgstr "setting DTR to OFF"
 msgid "sketch path is not valid"
 msgstr "sketch path is not valid"
 
-#: cli/board/attach.go:38
+#: cli/board/attach.go:40
 #: cli/sketch/archive.go:38
 msgid "sketchPath"
 msgstr "sketchPath"

test/test_board.py

@@ -637,7 +637,7 @@ def test_board_attach_without_sketch_json(run_command, data_dir):
     # Create a test sketch
     assert run_command(["sketch", "new", sketch_path])
 
-    assert run_command(["board", "attach", fqbn, sketch_path])
+    assert run_command(["board", "attach", "-b", fqbn, sketch_path])
 
 
 def test_board_search_with_outdated_core(run_command):