Add loading of PluggableDiscoveries when loading a platform release

Author: silvanocerza

arduino/cores/packagemanager/loader.go

@@ -323,6 +323,14 @@ func (pm *PackageManager) loadPlatformRelease(platform *cores.PlatformRelease, p
 
 	if platform.Properties.SubTree("discovery").Size() > 0 {
 		platform.PluggableDiscoveryAware = true
+
+		discoveries, err := pm.LoadDiscoveries(platform)
+		if err != nil {
+			return fmt.Errorf("loading discovery properties: %s", err)
+		}
+		for _, discovery := range discoveries {
+			pm.discoveryManager.Add(discovery)
+		}
 	}
 
 	if platform.Platform.Name == "" {
@@ -591,3 +599,83 @@ func (pm *PackageManager) LoadToolsFromBundleDirectory(toolsPath *paths.Path) er
 	}
 	return nil
 }
+
+// LoadDiscoveries returns a list of PluggableDiscoveries supported by the specfied PlatformRelease.
+// Returns error if:
+// * A PluggableDiscovery instance can't be created
+// * Tools required by the PlatformRelease cannot be found
+// * Command line to start PluggableDiscovery has malformed or mismatched quotes
+func (pm *PackageManager) LoadDiscoveries(release *cores.PlatformRelease) ([]*discovery.PluggableDiscovery, error) {
+	res := []*discovery.PluggableDiscovery{}
+	discoveryProperties := release.Properties.SubTree("discovery").Clone()
+
+	if discoveryProperties.Size() == 0 {
+		return res, nil
+	}
+
+	// Handles discovery properties formatted like so:
+	//
+	// Case 1:
+	//    "discovery.required": "PLATFORM:DISCOVERY_NAME",
+	//
+	// Case 2:
+	//    "discovery.required.0": "PLATFORM:DISCOVERY_ID_1",
+	//    "discovery.required.1": "PLATFORM:DISCOVERY_ID_2",
+	//
+	// If both indexed and unindexed properties are found the unindexed are ignored
+	for _, id := range discoveryProperties.ExtractSubIndexLists("required") {
+		tool := release.Platform.Package.Tools[id]
+		toolRelease := tool.GetLatestInstalled()
+		discoveryPath := toolRelease.InstallDir.Join(tool.Name).String()
+		d, err := discovery.New(id, discoveryPath)
+		if err != nil {
+			return nil, fmt.Errorf("creating discovery: %s", err)
+		}
+		res = append(res, d)
+	}
+
+	// "discovery.teensy.pattern": "\"{runtime.tools.teensy_ports.path}/hardware/tools/teensy_ports\" -J2",
+	discoveryIDs := discoveryProperties.FirstLevelOf()
+	delete(discoveryIDs, "required")
+	// Get the list of tools only we if have there are discoveries that use Direct discovery integration.
+	// See:
+	// https://github.com/arduino/tooling-rfcs/blob/main/RFCs/0002-pluggable-discovery.md#direct-discovery-integration-not-recommended
+	// We need the tools only in that case since we might need some tool's
+	// runtime properties to expand the discovery pattern to run it correctly.
+	var tools []*cores.ToolRelease
+	if len(discoveryIDs) > 0 {
+		var err error
+		tools, err = pm.FindToolsRequiredFromPlatformRelease(release)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	// Handles discovery properties formatted like so:
+	//
+	// discovery.DISCOVERY_ID.pattern: "COMMAND_TO_EXECUTE"
+	for discoveryID, props := range discoveryIDs {
+		pattern, ok := props.GetOk("pattern")
+		if !ok {
+			return nil, fmt.Errorf("can't find pattern for discovery with id %s", discoveryID)
+		}
+		configuration := release.Properties.Clone()
+		configuration.Merge(release.RuntimeProperties())
+		configuration.Merge(props)
+
+		for _, tool := range tools {
+			configuration.Merge(tool.RuntimeProperties())
+		}
+
+		cmd := configuration.ExpandPropsInString(pattern)
+		if cmdArgs, err := properties.SplitQuotedString(cmd, `"'`, true); err != nil {
+			return nil, err
+		} else if d, err := discovery.New(discoveryID, cmdArgs...); err != nil {
+			return nil, err
+		} else {
+			res = append(res, d)
+		}
+	}
+
+	return res, nil
+}

arduino/cores/packagemanager/loader_test.go

@@ -18,8 +18,10 @@ package packagemanager
 import (
 	"testing"
 
+	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/stretchr/testify/require"
+	semver "go.bug.st/relaxed-semver"
 )
 
 func TestVidPidConvertionToPluggableDiscovery(t *testing.T) {
@@ -103,3 +105,73 @@ arduino_zero_native.pid.3=0x024d
   "upload_port.3.pid": "0x024d",
 }`, zero4.Dump())
 }
+
+func TestLoadDiscoveries(t *testing.T) {
+	// Create all the necessary data to load discoveries
+	fakePath := paths.New("fake-path")
+	packageManager := NewPackageManager(fakePath, fakePath, fakePath, fakePath)
+	pack := packageManager.Packages.GetOrCreatePackage("arduino")
+	// ble-discovery tool
+	tool := pack.GetOrCreateTool("arduino:ble-discovery")
+	toolRelease := tool.GetOrCreateRelease(semver.ParseRelaxed("1.0.0"))
+	// We set this to fake the tool is installed
+	toolRelease.InstallDir = fakePath
+	tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))
+
+	// serial-discovery tool
+	tool = pack.GetOrCreateTool("arduino:serial-discovery")
+	tool.GetOrCreateRelease(semver.ParseRelaxed("1.0.0"))
+	toolRelease = tool.GetOrCreateRelease(semver.ParseRelaxed("0.1.0"))
+	// We set this to fake the tool is installed
+	toolRelease.InstallDir = fakePath
+
+	platform := pack.GetOrCreatePlatform("avr")
+	release := platform.GetOrCreateRelease(semver.MustParse("1.0.0"))
+
+	release.Properties = properties.NewFromHashmap(map[string]string{
+		"discovery.required": "arduino:ble-discovery",
+	})
+
+	discoveries, err := packageManager.LoadDiscoveries(release)
+	require.Len(t, discoveries, 1)
+	require.NoError(t, err)
+	require.Equal(t, discoveries[0].GetID(), "arduino:ble-discovery")
+
+	release.Properties = properties.NewFromHashmap(map[string]string{
+		"discovery.required.0": "arduino:ble-discovery",
+		"discovery.required.1": "arduino:serial-discovery",
+	})
+
+	discoveries, err = packageManager.LoadDiscoveries(release)
+	require.Len(t, discoveries, 2)
+	require.NoError(t, err)
+	require.Equal(t, discoveries[0].GetID(), "arduino:ble-discovery")
+	require.Equal(t, discoveries[1].GetID(), "arduino:serial-discovery")
+
+	release.Properties = properties.NewFromHashmap(map[string]string{
+		"discovery.required.0":     "arduino:ble-discovery",
+		"discovery.required.1":     "arduino:serial-discovery",
+		"discovery.teensy.pattern": "\"{runtime.tools.teensy_ports.path}/hardware/tools/teensy_ports\" -J2",
+	})
+
+	discoveries, err = packageManager.LoadDiscoveries(release)
+	require.Len(t, discoveries, 3)
+	require.NoError(t, err)
+	require.Equal(t, discoveries[0].GetID(), "arduino:ble-discovery")
+	require.Equal(t, discoveries[1].GetID(), "arduino:serial-discovery")
+	require.Equal(t, discoveries[2].GetID(), "teensy")
+
+	release.Properties = properties.NewFromHashmap(map[string]string{
+		"discovery.required":       "arduino:some-discovery",
+		"discovery.required.0":     "arduino:ble-discovery",
+		"discovery.required.1":     "arduino:serial-discovery",
+		"discovery.teensy.pattern": "\"{runtime.tools.teensy_ports.path}/hardware/tools/teensy_ports\" -J2",
+	})
+
+	discoveries, err = packageManager.LoadDiscoveries(release)
+	require.Len(t, discoveries, 3)
+	require.NoError(t, err)
+	require.Equal(t, discoveries[0].GetID(), "arduino:ble-discovery")
+	require.Equal(t, discoveries[1].GetID(), "arduino:serial-discovery")
+	require.Equal(t, discoveries[2].GetID(), "teensy")
+}

arduino/cores/packagemanager/package_manager.go

@@ -439,6 +439,39 @@ func (pm *PackageManager) InstalledBoards() []*cores.Board {
 	return boards
 }
 
+func (pm *PackageManager) FindToolsRequiredFromPlatformRelease(platform *cores.PlatformRelease) ([]*cores.ToolRelease, error) {
+	pm.Log.Infof("Searching tools required for platform %s", platform)
+
+	// maps "PACKAGER:TOOL" => ToolRelease
+	foundTools := map[string]*cores.ToolRelease{}
+	// A Platform may not specify required tools (because it's a platform that comes from a
+	// user/hardware dir without a package_index.json) then add all available tools
+	for _, targetPackage := range pm.Packages {
+		for _, tool := range targetPackage.Tools {
+			rel := tool.GetLatestInstalled()
+			if rel != nil {
+				foundTools[rel.Tool.Name] = rel
+			}
+		}
+	}
+	// replace the default tools above with the specific required by the current platform
+	requiredTools := []*cores.ToolRelease{}
+	platform.ToolDependencies.Sort()
+	for _, toolDep := range platform.ToolDependencies {
+		pm.Log.WithField("tool", toolDep).Infof("Required tool")
+		tool := pm.FindToolDependency(toolDep)
+		if tool == nil {
+			return nil, fmt.Errorf("tool release not found: %s", toolDep)
+		}
+		requiredTools = append(requiredTools, tool)
+		delete(foundTools, tool.Tool.Name)
+	}
+	for _, toolRel := range foundTools {
+		requiredTools = append(requiredTools, toolRel)
+	}
+	return requiredTools, nil
+}
+
 // FindToolsRequiredForBoard FIXMEDOC
 func (pm *PackageManager) FindToolsRequiredForBoard(board *cores.Board) ([]*cores.ToolRelease, error) {
 	pm.Log.Infof("Searching tools required for board %s", board)

go.mod

@@ -5,7 +5,7 @@ go 1.14
 require (
 	github.com/arduino/board-discovery v0.0.0-20180823133458-1ba29327fb0c
 	github.com/arduino/go-paths-helper v1.6.0
-	github.com/arduino/go-properties-orderedmap v1.3.0
+	github.com/arduino/go-properties-orderedmap v1.5.0
 	github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b
 	github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b
 	github.com/cmaglie/go.rice v1.0.3 // This one must be kept until https://github.com/GeertJohan/go.rice/pull/159 is merged

go.sum

@@ -22,6 +22,8 @@ github.com/arduino/go-paths-helper v1.6.0 h1:S7/d7DqB9XlnvF9KrgSiGmo2oWKmYW6O/DT
 github.com/arduino/go-paths-helper v1.6.0/go.mod h1:V82BWgAAp4IbmlybxQdk9Bpkz8M4Qyx+RAFKaG9NuvU=
 github.com/arduino/go-properties-orderedmap v1.3.0 h1:4No/vQopB36e7WUIk6H6TxiSEJPiMrVOCZylYmua39o=
 github.com/arduino/go-properties-orderedmap v1.3.0/go.mod h1:DKjD2VXY/NZmlingh4lSFMEYCVubfeArCsGPGDwb2yk=
+github.com/arduino/go-properties-orderedmap v1.5.0 h1:istmr13qQN3nneuU3lsqlMvI6jqB3u8QUfVU1tX/t/8=
+github.com/arduino/go-properties-orderedmap v1.5.0/go.mod h1:DKjD2VXY/NZmlingh4lSFMEYCVubfeArCsGPGDwb2yk=
 github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b h1:9hDi4F2st6dbLC3y4i02zFT5quS4X6iioWifGlVwfy4=
 github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b/go.mod h1:uwGy5PpN4lqW97FiLnbcx+xx8jly5YuPMJWfVwwjJiQ=
 github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b h1:3PjgYG5gVPA7cipp7vIR2lF96KkEJIFBJ+ANnuv6J20=