fix: add board options to fqbn filter

Author: Luca Bianconi

Diff for: arduino/cores/fqbn.go

@@ -76,6 +76,29 @@ func (fqbn *FQBN) String() string {
 	return res
 }
 
+// Match check if the target FQBN corresponds to the receiver one.
+// The core parts are checked for exact equality while board options are loosely
+// matched: the set of boards options of the target must be fully contained within
+// the one of the receiver and their values must be equal.
+func (fqbn *FQBN) Match(target *FQBN) bool {
+	if fqbn.StringWithoutConfig() != target.StringWithoutConfig() {
+		return false
+	}
+	searchedProperties := target.Configs.Clone()
+	actualConfigs := fqbn.Configs.AsMap()
+	for neededKey, neededValue := range searchedProperties.AsMap() {
+		targetValue, hasKey := actualConfigs[neededKey]
+		if !hasKey {
+			return false
+		}
+		if targetValue != neededValue {
+			return false
+		}
+	}
+
+	return true
+}
+
 // StringWithoutConfig returns the FQBN without the Config part
 func (fqbn *FQBN) StringWithoutConfig() string {
 	return fqbn.Package + ":" + fqbn.PlatformArch + ":" + fqbn.BoardID

Diff for: arduino/cores/fqbn_test.go

@@ -121,3 +121,37 @@ func TestFQBN(t *testing.T) {
 		"properties.Map{\n  \"cpu\": \"atmega\",\n  \"speed\": \"1000\",\n  \"extra\": \"core=arduino\",\n}",
 		f.Configs.Dump())
 }
+
+func TestMatch(t *testing.T) {
+	expectedMatches := [][]string{
+		{"arduino:avr:uno", "arduino:avr:uno"},
+		{"arduino:avr:uno", "arduino:avr:uno:opt1=1,opt2=2"},
+		{"arduino:avr:uno:opt1=1", "arduino:avr:uno:opt1=1,opt2=2"},
+		{"arduino:avr:uno:opt1=1,opt2=2", "arduino:avr:uno:opt1=1,opt2=2"},
+		{"arduino:avr:uno:opt3=3,opt1=1,opt2=2", "arduino:avr:uno:opt2=2,opt3=3,opt1=1,opt4=4"},
+	}
+
+	for _, pair := range expectedMatches {
+		a, err := ParseFQBN(pair[0])
+		require.NoError(t, err)
+		b, err := ParseFQBN(pair[1])
+		require.NoError(t, err)
+		require.True(t, b.Match(a))
+	}
+
+	expectedMismatches := [][]string{
+		{"arduino:avr:uno", "arduino:avr:due"},
+		{"arduino:avr:uno", "arduino:avr:due:opt1=1,opt2=2"},
+		{"arduino:avr:uno:opt1=1", "arduino:avr:uno"},
+		{"arduino:avr:uno:opt1=1,opt2=", "arduino:avr:uno:opt1=1,opt2=3"},
+		{"arduino:avr:uno:opt1=1,opt2=2", "arduino:avr:uno:opt2=2"},
+	}
+
+	for _, pair := range expectedMismatches {
+		a, err := ParseFQBN(pair[0])
+		require.NoError(t, err)
+		b, err := ParseFQBN(pair[1])
+		require.NoError(t, err)
+		require.False(t, b.Match(a))
+	}
+}

Diff for: commands/board/list.go

@@ -239,9 +239,13 @@ func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartError
 	return retVal, discoveryStartErrors, nil
 }
 
-func hasMatchingBoard(b *rpc.DetectedPort, requestedFqbn *cores.FQBN) bool {
+func hasMatchingBoard(b *rpc.DetectedPort, fqbnFilter *cores.FQBN) bool {
 	for _, detectedBoard := range b.MatchingBoards {
-		if detectedBoard.Fqbn == requestedFqbn.String() {
+		detectedFqbn, err := cores.ParseFQBN(detectedBoard.Fqbn)
+		if err != nil {
+			continue
+		}
+		if detectedFqbn.Match(fqbnFilter) {
 			return true
 		}
 	}

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

@@ -33,27 +33,14 @@ 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 and the board options to the specified Command
+// AddToCommand adds the flags used to set fqbn to the specified Command
 func (f *Fqbn) AddToCommand(cmd *cobra.Command) {
-	f.configureForCommand(cmd, true)
-}
-
-// AddToCommandWithoutBoardOptions 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.configureForCommand(cmd, false)
-}
-
-func (f *Fqbn) configureForCommand(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
 	})
-
-	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
+	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."))
 }
 
 // String returns the fqbn with the board options if there are any

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

@@ -49,7 +49,7 @@ func initListCommand() *cobra.Command {
 	}
 
 	timeoutArg.AddToCommand(listCommand)
-	fqbn.AddToCommandWithoutBoardOptions(listCommand)
+	fqbn.AddToCommand(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