feat: filter boards by fqbn in connected list

Author: Luca Bianconi

Diff for: commands/board/list.go

@@ -205,6 +205,15 @@ func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartError
 	}
 	defer release()
 
+	var fqbnFilter *cores.FQBN
+	if f := req.GetFqbn(); f != "" {
+		var err error
+		fqbnFilter, err = cores.ParseFQBN(f)
+		if err != nil {
+			return nil, nil, &arduino.InvalidFQBNError{Cause: err}
+		}
+	}
+
 	dm := pme.DiscoveryManager()
 	discoveryStartErrors = dm.Start()
 	time.Sleep(time.Duration(req.GetTimeout()) * time.Millisecond)
@@ -222,11 +231,23 @@ func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartError
 			Port:           port.ToRPC(),
 			MatchingBoards: boards,
 		}
-		retVal = append(retVal, b)
+
+		if fqbnFilter == nil || hasMatchingBoard(b, fqbnFilter) {
+			retVal = append(retVal, b)
+		}
 	}
 	return retVal, discoveryStartErrors, nil
 }
 
+func hasMatchingBoard(b *rpc.DetectedPort, requestedFqbn *cores.FQBN) bool {
+	for _, detectedBoard := range b.MatchingBoards {
+		if detectedBoard.Fqbn == requestedFqbn.String() {
+			return true
+		}
+	}
+	return false
+}
+
 // Watch returns a channel that receives boards connection and disconnection events.
 // It also returns a callback function that must be used to stop and dispose the watch.
 func Watch(req *rpc.BoardListWatchRequest) (<-chan *rpc.BoardListWatchResponse, func(), error) {

Diff for: internal/cli/arguments/fqbn.go

@@ -33,14 +33,27 @@ type Fqbn struct {
 	boardOptions []string // List of boards specific options separated by commas. Or can be used multiple times for multiple options.
 }
 
-// AddToCommand adds the flags used to set fqbn to the specified Command
+// AddToCommand adds the flags used to set fqbn and the board options to the specified Command
 func (f *Fqbn) AddToCommand(cmd *cobra.Command) {
+	f.addToCommand(cmd, true)
+}
+
+// AddToCommand adds the flags used to set fqbn to the specified Command, board options flag is not provided
+func (f *Fqbn) AddToCommandWithoutBoardOptions(cmd *cobra.Command) {
+	f.addToCommand(cmd, false)
+}
+
+func (f *Fqbn) addToCommand(cmd *cobra.Command, enableBoardOptions bool) bool {
 	cmd.Flags().StringVarP(&f.fqbn, "fqbn", "b", "", tr("Fully Qualified Board Name, e.g.: arduino:avr:uno"))
 	cmd.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		return GetInstalledBoards(), cobra.ShellCompDirectiveDefault
 	})
-	cmd.Flags().StringSliceVar(&f.boardOptions, "board-options", []string{},
-		tr("List of board options separated by commas. Or can be used multiple times for multiple options."))
+
+	if enableBoardOptions {
+		cmd.Flags().StringSliceVar(&f.boardOptions, "board-options", []string{},
+			tr("List of board options separated by commas. Or can be used multiple times for multiple options."))
+	}
+	return false
 }
 
 // String returns the fqbn with the board options if there are any

Diff for: internal/cli/board/list.go

@@ -20,6 +20,7 @@ import (
 	"os"
 	"sort"
 
+	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/commands/board"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
@@ -47,6 +48,7 @@ func initListCommand() *cobra.Command {
 	}
 
 	timeoutArg.AddToCommand(listCommand)
+	fqbn.AddToCommandWithoutBoardOptions(listCommand)
 	listCommand.Flags().BoolVarP(&watch, "watch", "w", false, tr("Command keeps running and prints list of connected boards whenever there is a change."))
 
 	return listCommand
@@ -66,8 +68,12 @@ func runListCommand(cmd *cobra.Command, args []string) {
 	ports, discvoeryErrors, err := board.List(&rpc.BoardListRequest{
 		Instance: inst,
 		Timeout:  timeoutArg.Get().Milliseconds(),
+		Fqbn:     fqbn.String(),
 	})
 	if err != nil {
+		if _, isFqbnError := err.(*arduino.InvalidFQBNError); isFqbnError {
+			feedback.Fatal(tr(err.Error()), feedback.ErrBadArgument)
+		}
 		feedback.Warning(tr("Error detecting boards: %v", err))
 	}
 	for _, err := range discvoeryErrors {

Diff for: internal/integrationtest/board/board_test.go

@@ -91,6 +91,39 @@ func TestBoardList(t *testing.T) {
 		MustBeEmpty()
 }
 
+func TestBoardListWithFqbnFilter(t *testing.T) {
+	if os.Getenv("CI") != "" {
+		t.Skip("VMs have no serial ports")
+	}
+
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	_, _, err := cli.Run("core", "update-index")
+	require.NoError(t, err)
+	stdout, _, err := cli.Run("board", "list", "-b", "arduino:avr:uno", "--format", "json")
+	require.NoError(t, err)
+	// this is a bit of a passpartout test, it actually filters the "bluetooth boards" locally
+	// but it would succeed even if the filtering wasn't working properly
+	// TODO: find a way to simulate connected boards or create a unit test which
+	// mocks or initializes multiple components
+	requirejson.Parse(t, stdout).
+		MustBeEmpty()
+}
+
+func TestBoardListWithFqbnFilterInvalid(t *testing.T) {
+	if os.Getenv("CI") != "" {
+		t.Skip("VMs have no serial ports")
+	}
+
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	_, stderr, err := cli.Run("board", "list", "-b", "yadayada", "--format", "json")
+	require.Error(t, err)
+	requirejson.Query(t, stderr, ".error", `"Invalid FQBN: not an FQBN: yadayada"`)
+}
+
 func TestBoardListWithInvalidDiscovery(t *testing.T) {
 	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
 	defer env.CleanUp()