Add fuzzy search to board listall command

Author: silvanocerza

commands/board/listall.go

@@ -22,27 +22,32 @@ import (
 
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	"github.com/lithammer/fuzzysearch/fuzzy"
 )
 
+// maximumSearchDistance is the maximum Levenshtein distance accepted when using fuzzy search.
+// This value is completely arbitrary and picked randomly.
+const maximumSearchDistance = 20
+
 // ListAll FIXMEDOC
 func ListAll(ctx context.Context, req *rpc.BoardListAllReq) (*rpc.BoardListAllResp, error) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
 		return nil, errors.New("invalid instance")
 	}
 
-	args := req.GetSearchArgs()
-	match := func(name string) bool {
-		if len(args) == 0 {
+	searchArgs := strings.Join(req.SearchArgs, " ")
+
+	match := func(toTest []string) bool {
+		if len(searchArgs) == 0 {
 			return true
 		}
-		name = strings.ToLower(name)
-		for _, term := range args {
-			if !strings.Contains(name, strings.ToLower(term)) {
-				return false
+		for _, rank := range fuzzy.RankFindNormalizedFold(searchArgs, toTest) {
+			if rank.Distance < maximumSearchDistance {
+				return true
 			}
 		}
-		return true
+		return false
 	}
 
 	list := &rpc.BoardListAllResp{Boards: []*rpc.BoardListItem{}}
@@ -75,13 +80,26 @@ func ListAll(ctx context.Context, req *rpc.BoardListAllReq) (*rpc.BoardListAllRe
 				ManuallyInstalled: platform.ManuallyInstalled,
 			}
 
+			toTest := []string{
+				platform.String(),
+				platform.Name,
+				platform.Architecture,
+				targetPackage.Name,
+				targetPackage.Maintainer,
+			}
+
 			for _, board := range installedPlatformRelease.Boards {
-				if !match(board.Name()) {
+				if !req.GetIncludeHiddenBoards() && board.IsHidden() {
 					continue
 				}
-				if !req.GetIncludeHiddenBoards() && board.IsHidden() {
+
+				toTest := toTest
+				toTest = append(toTest, strings.Split(board.Name(), " ")...)
+				toTest = append(toTest, board.FQBN())
+				if !match(toTest) {
 					continue
 				}
+
 				list.Boards = append(list.Boards, &rpc.BoardListItem{
 					Name:     board.Name(),
 					FQBN:     board.FQBN(),

test/test_board.py

@@ -455,6 +455,34 @@ def test_board_listall_with_manually_installed_platform(run_command, data_dir):
     assert "Arduino SAMD (32-bits ARM Cortex-M0+) Boards" == platform["Name"]
 
 
+def test_board_listall_fuzzy_search(run_command, data_dir):
+    assert run_command("update")
+
+    # Install from platform manager
+    assert run_command("core install arduino:avr@1.8.3")
+
+    # Manually installs a core in sketchbooks hardware folder
+    git_url = "https://github.com/arduino/ArduinoCore-samd.git"
+    repo_dir = Path(data_dir, "hardware", "arduino-beta-development", "samd")
+    assert Repo.clone_from(git_url, repo_dir, multi_options=["-b 1.8.11"])
+
+    res = run_command("board listall --format json samd")
+    assert res.ok
+    data = json.loads(res.stdout)
+    boards = {b["FQBN"]: b for b in data["boards"]}
+    assert len(boards) == 17
+    assert "arduino-beta-development:samd:mkr1000" in boards
+    assert "arduino:avr:uno" not in boards
+
+    res = run_command("board listall --format json avr")
+    assert res.ok
+    data = json.loads(res.stdout)
+    boards = {b["FQBN"]: b for b in data["boards"]}
+    assert len(boards) == 26
+    assert "arduino:avr:uno" in boards
+    assert "arduino-beta-development:samd:mkr1000" not in boards
+
+
 def test_board_details(run_command):
     run_command("core update-index")
     # Download samd core pinned to 1.8.6