lib list command now only shows compatible libraries when specifying fqbn

silvanocerza · silvanocerza · commit 743c3e9b3c94 · 2020-09-29T14:58:02.000+02:00
diff --git a/arduino/libraries/libraries.go b/arduino/libraries/libraries.go
@@ -75,6 +75,7 @@ type Library struct {
 	Examples               paths.PathList
 	declaredHeaders        []string
 	sourceHeaders          []string
+	CompatibleWith         map[string]bool
 }
 
 func (library *Library) String() string {
diff --git a/cli/lib/list.go b/cli/lib/list.go
@@ -76,7 +76,16 @@ func runListCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errorcodes.ErrGeneric)
 	}
 
-	libs := res.GetInstalledLibrary()
+	libs := []*rpc.InstalledLibrary{}
+	if listFlags.fqbn == "" {
+		libs = res.GetInstalledLibrary()
+	} else {
+		for _, lib := range res.GetInstalledLibrary() {
+			if lib.Library.CompatibleWith[listFlags.fqbn] {
+				libs = append(libs, lib)
+			}
+		}
+	}
 
 	// To uniform the output to other commands, when there are no result
 	// print out an empty slice.
@@ -139,7 +148,6 @@ func (ir installedResult) String() string {
 			} else if len(sentence) > 40 {
 				sentence = sentence[:37] + "..."
 			}
-
 			t.AddRow(name, lib.Version, available, location, sentence)
 		}
 	}
diff --git a/commands/lib/list.go b/commands/lib/list.go
@@ -50,57 +50,67 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListReq) (*rpc.LibraryList
 
 	instaledLib := []*rpc.InstalledLibrary{}
 	res := listLibraries(lm, req.GetUpdatable(), req.GetAll())
-	if len(res) > 0 {
-		if f := req.GetFqbn(); f != "" {
-			fqbn, err := cores.ParseFQBN(req.GetFqbn())
-			if err != nil {
-				return nil, fmt.Errorf("parsing fqbn: %s", err)
-			}
-			_, boardPlatform, _, _, refBoardPlatform, err := pm.ResolveFQBN(fqbn)
-			if err != nil {
-				return nil, fmt.Errorf("loading board data: %s", err)
-			}
+	if f := req.GetFqbn(); f != "" {
+		fqbn, err := cores.ParseFQBN(req.GetFqbn())
+		if err != nil {
+			return nil, fmt.Errorf("parsing fqbn: %s", err)
+		}
+		_, boardPlatform, _, _, refBoardPlatform, err := pm.ResolveFQBN(fqbn)
+		if err != nil {
+			return nil, fmt.Errorf("loading board data: %s", err)
+		}
 
-			filteredRes := map[string]*installedLib{}
-			for _, lib := range res {
-				if cp := lib.Library.ContainerPlatform; cp != nil {
-					if cp != boardPlatform && cp != refBoardPlatform {
-						// Filter all libraries from extraneous platforms
-						continue
-					}
+		filteredRes := map[string]*installedLib{}
+		for _, lib := range res {
+			if cp := lib.Library.ContainerPlatform; cp != nil {
+				if cp != boardPlatform && cp != refBoardPlatform {
+					// Filter all libraries from extraneous platforms
+					continue
 				}
-				if latest, has := filteredRes[lib.Library.Name]; has {
-					if latest.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) >= lib.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) {
-						continue
-					}
+			}
+			if latest, has := filteredRes[lib.Library.Name]; has {
+				if latest.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) >= lib.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) {
+					continue
 				}
-				filteredRes[lib.Library.Name] = lib
 			}
 
-			res = []*installedLib{}
-			for _, lib := range filteredRes {
-				res = append(res, lib)
+			// Check if library is compatible with board specified by FBQN
+			compatible := false
+			for _, arch := range lib.Library.Architectures {
+				compatible = (arch == fqbn.PlatformArch || arch == "*")
+				if compatible {
+					break
+				}
+			}
+			lib.Library.CompatibleWith = map[string]bool{
+				f: compatible,
 			}
+
+			filteredRes[lib.Library.Name] = lib
 		}
 
-		for _, lib := range res {
-			if nameFilter != "" && strings.ToLower(lib.Library.Name) != nameFilter {
-				continue
-			}
-			libtmp, err := GetOutputLibrary(lib.Library)
-			if err != nil {
-				return nil, err
-			}
-			release := GetOutputRelease(lib.Available)
-			instaledLib = append(instaledLib, &rpc.InstalledLibrary{
-				Library: libtmp,
-				Release: release,
-			})
+		res = []*installedLib{}
+		for _, lib := range filteredRes {
+			res = append(res, lib)
 		}
+	}
 
-		return &rpc.LibraryListResp{InstalledLibrary: instaledLib}, nil
+	for _, lib := range res {
+		if nameFilter != "" && strings.ToLower(lib.Library.Name) != nameFilter {
+			continue
+		}
+		libtmp, err := GetOutputLibrary(lib.Library)
+		if err != nil {
+			return nil, err
+		}
+		release := GetOutputRelease(lib.Available)
+		instaledLib = append(instaledLib, &rpc.InstalledLibrary{
+			Library: libtmp,
+			Release: release,
+		})
 	}
-	return &rpc.LibraryListResp{}, nil
+
+	return &rpc.LibraryListResp{InstalledLibrary: instaledLib}, nil
 }
 
 // listLibraries returns the list of installed libraries. If updatable is true it
@@ -171,6 +181,7 @@ func GetOutputLibrary(lib *libraries.Library) (*rpc.Library, error) {
 		License:           lib.License,
 		Examples:          lib.Examples.AsStrings(),
 		ProvidesIncludes:  lib.DeclaredHeaders(),
+		CompatibleWith:    lib.CompatibleWith,
 	}, nil
 }
 
diff --git a/rpc/commands/lib.pb.go b/rpc/commands/lib.pb.go
diff --git a/rpc/commands/lib.proto b/rpc/commands/lib.proto
@@ -271,6 +271,8 @@ message Library {
     // Value of the `includes` field in library.properties or, if missing, the list of
     // include files available on the library source root directory.
     repeated string provides_includes = 27;
+    // Map of FQBNs that specifies if library is compatible with this library
+    map<string, bool> compatible_with = 28;
 }
 
 enum LibraryLayout {
@@ -287,7 +289,7 @@ enum LibraryLocation {
     user = 1;
     // In the `libraries` subdirectory of a platform.
     platform_builtin = 2;
-    // When `LibraryLocation` is used in a context where a board is specified, 
+    // When `LibraryLocation` is used in a context where a board is specified,
     // this indicates the library is in the `libraries` subdirectory of a
     // platform referenced by the board's platform.
     referenced_platform_builtin = 3;
diff --git a/test/test_lib.py b/test/test_lib.py

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,7 @@ type Library struct {`
`75`	`75`	`Examples paths.PathList`
`76`	`76`	`declaredHeaders []string`
`77`	`77`	`sourceHeaders []string`
	`78`	`+ CompatibleWith map[string]bool`
`78`	`79`	`}`
`79`	`80`
`80`	`81`	`func (library *Library) String() string {`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,16 @@ func runListCommand(cmd *cobra.Command, args []string) {`
`76`	`76`	`os.Exit(errorcodes.ErrGeneric)`
`77`	`77`	`}`
`78`	`78`
`79`		`- libs := res.GetInstalledLibrary()`
	`79`	`+ libs := []*rpc.InstalledLibrary{}`
	`80`	`+ if listFlags.fqbn == "" {`
	`81`	`+ libs = res.GetInstalledLibrary()`
	`82`	`+ } else {`
	`83`	`+ for _, lib := range res.GetInstalledLibrary() {`
	`84`	`+ if lib.Library.CompatibleWith[listFlags.fqbn] {`
	`85`	`+ libs = append(libs, lib)`
	`86`	`+ }`
	`87`	`+ }`
	`88`	`+ }`
`80`	`89`
`81`	`90`	`// To uniform the output to other commands, when there are no result`
`82`	`91`	`// print out an empty slice.`
`@@ -139,7 +148,6 @@ func (ir installedResult) String() string {`
`139`	`148`	`} else if len(sentence) > 40 {`
`140`	`149`	`sentence = sentence[:37] + "..."`
`141`	`150`	`}`
`142`		`-`
`143`	`151`	`t.AddRow(name, lib.Version, available, location, sentence)`
`144`	`152`	`}`
`145`	`153`	`}`