expose Incompatible properity in the API

Author: alessio-perugini

commands/board/listall.go

@@ -68,6 +68,7 @@ func ListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListA
 				ManuallyInstalled: platform.ManuallyInstalled,
 				Indexed:           platform.Indexed,
 				MissingMetadata:   !installedPlatformRelease.HasMetadata(),
+				Incompatible:      installedPlatformRelease.IsIncompatible(),
 			}
 
 			toTest := []string{

commands/board/search.go

@@ -66,6 +66,7 @@ func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchR
 			if installedPlatformRelease != nil {
 				rpcPlatform.Installed = installedPlatformRelease.Version.String()
 				rpcPlatform.MissingMetadata = !installedPlatformRelease.HasMetadata()
+				rpcPlatform.Incompatible = installedPlatformRelease.IsIncompatible()
 			}
 
 			// Platforms that are not installed don't have a list of boards

commands/core.go

@@ -64,6 +64,7 @@ func PlatformReleaseToRPC(platformRelease *cores.PlatformRelease) *rpc.Platform
 		Type:              []string{platformRelease.Platform.Category},
 		Indexed:           platformRelease.Platform.Indexed,
 		MissingMetadata:   !platformRelease.HasMetadata(),
+		Incompatible:      platformRelease.IsIncompatible(),
 	}
 
 	return result

commands/core/search.go

@@ -75,6 +75,12 @@ func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse
 
 				if allVersions {
 					res = append(res, platform.GetAllReleases()...)
+					continue
+				}
+
+				// in case there isn't a compatible version fallback on the latest uncompatibile.
+				if latestCompatibleRelease := platform.GetLatestCompatibleRelease(); latestCompatibleRelease != nil {
+					res = append(res, latestCompatibleRelease)
 				} else {
 					res = append(res, latestRelease)
 				}

commands/core/search_test.go

@@ -26,7 +26,6 @@ import (
 )
 
 func TestPlatformSearch(t *testing.T) {
-
 	dataDir := paths.TempDir().Join("test", "data_dir")
 	downloadDir := paths.TempDir().Join("test", "staging")
 	t.Setenv("ARDUINO_DATA_DIR", dataDir.String())
@@ -64,6 +63,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 	require.Contains(t, res.SearchOutput, &rpc.Platform{
 		Id:              "Retrokits-RK002:arm",
@@ -78,6 +78,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 
 	res, stat = PlatformSearch(&rpc.PlatformSearchRequest{
@@ -101,6 +102,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 
 	// Search the Package Maintainer
@@ -125,6 +127,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 	require.Contains(t, res.SearchOutput, &rpc.Platform{
 		Id:              "Retrokits-RK002:arm",
@@ -139,6 +142,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 
 	// Search using the Package name
@@ -163,6 +167,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 	require.Contains(t, res.SearchOutput, &rpc.Platform{
 		Id:              "Retrokits-RK002:arm",
@@ -177,6 +182,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 
 	// Search using the Platform name
@@ -201,6 +207,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 	require.Contains(t, res.SearchOutput, &rpc.Platform{
 		Id:              "Retrokits-RK002:arm",
@@ -215,6 +222,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 
 	// Search using a board name
@@ -266,6 +274,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "http://www.arduino.cc/en/Reference/HomePage"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 
 	res, stat = PlatformSearch(&rpc.PlatformSearchRequest{
@@ -316,6 +325,7 @@ func TestPlatformSearch(t *testing.T) {
 		Help:            &rpc.HelpResources{Online: "http://www.arduino.cc/en/Reference/HomePage"},
 		Indexed:         true,
 		MissingMetadata: true,
+		Incompatible:    true,
 	})
 }
 

internal/integrationtest/core/core_test.go

@@ -181,8 +181,8 @@ func TestCoreSearchNoArgs(t *testing.T) {
 	for _, v := range strings.Split(strings.TrimSpace(string(stdout)), "\n") {
 		lines = append(lines, strings.Fields(strings.TrimSpace(v)))
 	}
-	// Check the presence of test:[email protected]
-	require.Contains(t, lines, []string{"test:x86", "3.0.0", "test_core"})
+	// Check the absence of test:[email protected] because it contains incompatible deps
+	require.NotContains(t, lines, []string{"test:x86", "3.0.0", "test_core"})
 	numPlatforms = len(lines) - 1
 
 	// same thing in JSON format, also check the number of platforms found is the same
@@ -1143,4 +1143,22 @@ func TestCoreHavingIncompatibleDepTools(t *testing.T) {
 	_, stderr, err = cli.Run("core", "install", "incompatible_vendor:avr", additionalURLs)
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "has no available releases for your OS")
+
+	// Core search --all shows incompatible field when a version is incompatible
+	stdout, _, err = cli.Run("core", "search", "--all", "--format", "json", additionalURLs)
+	require.NoError(t, err)
+	requirejson.Query(t, stdout,
+		`[.[] | select(.id == "foo_vendor:avr") | {latest: .latest, incompatible: .incompatible}] | sort_by(.latest)`,
+		`[
+			{"incompatible":null,"latest":"1.0.0"},
+			{"incompatible":null,"latest":"1.0.1"},
+			{"incompatible":true,"latest":"1.0.2"}
+		]`,
+	)
+
+	// Core search shows latest compatible version
+	stdout, _, err = cli.Run("core", "search", "--format", "json", additionalURLs)
+	require.NoError(t, err)
+	requirejson.Query(t, stdout, `.[] | select(.id == "foo_vendor:avr") | .latest`, `"1.0.1"`)
+	requirejson.Query(t, stdout, `.[] | select(.id == "incompatible_vendor:avr") | .incompatible`, `true`)
 }

rpc/cc/arduino/cli/commands/v1/common.pb.go

@@ -111,6 +111,8 @@ message Platform {
   // Newest available version of the platform containing all compatible
   // dependencies.
   string latest_compatible = 15;
+  // True if the platform contains an incompatible dependency.
+  bool incompatible = 16;
 }
 
 message InstalledPlatformReference {