Reorder toolDependencies to properly generate runtime properties

Author: cmaglie

Diff for: arduino/cores/cores.go

@@ -19,11 +19,11 @@ package cores
 
 import (
 	"encoding/json"
+	"sort"
 	"strings"
 
-	paths "github.com/arduino/go-paths-helper"
-
 	"github.com/arduino/arduino-cli/arduino/resources"
+	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
 	semver "go.bug.st/relaxed-semver"
 )
@@ -79,6 +79,20 @@ func (bm *BoardManifest) HasUsbID(vid, pid string) bool {
 // ToolDependencies is a set of tool dependency
 type ToolDependencies []*ToolDependency
 
+// Sort sorts the ToolDependencies by name and (if multiple instance of the same
+// tool is required) by version.
+func (deps ToolDependencies) Sort() {
+	sort.Slice(deps, func(i, j int) bool {
+		if deps[i].ToolPackager != deps[j].ToolPackager {
+			return deps[i].ToolPackager < deps[j].ToolPackager
+		}
+		if deps[i].ToolName != deps[j].ToolName {
+			return deps[i].ToolName < deps[j].ToolName
+		}
+		return deps[i].ToolVersion.LessThan(deps[j].ToolVersion)
+	})
+}
+
 // ToolDependency is a tuple that uniquely identifies a specific version of a Tool
 type ToolDependency struct {
 	ToolName     string

Diff for: arduino/cores/packagemanager/package_manager.go

@@ -404,6 +404,7 @@ func (pm *PackageManager) FindToolsRequiredForBoard(board *cores.Board) ([]*core
 
 	// replace the default tools above with the specific required by the current platform
 	requiredTools := []*cores.ToolRelease{}
+	platform.Dependencies.Sort()
 	for _, toolDep := range platform.Dependencies {
 		pm.Log.WithField("tool", toolDep).Infof("Required tool")
 		tool := pm.FindToolDependency(toolDep)

Diff for: arduino/cores/packagemanager/package_manager_test.go

@@ -162,4 +162,11 @@ func TestFindToolsRequiredForBoard(t *testing.T) {
 	require.NotNil(t, bossac18)
 	require.Contains(t, featherTools, bossac17)
 	require.Contains(t, featherTools, bossac18)
+
+	// Check if the runtime variable is set correctly to the latest version
+	uploadProperties := properties.NewMap()
+	for _, requiredTool := range featherTools {
+		uploadProperties.Merge(requiredTool.RuntimeProperties())
+	}
+	require.Equal(t, bossac18.InstallDir.String(), uploadProperties.Get("runtime.tools.bossac.path"))
 }

Diff for: arduino/cores/packagemanager/testdata/data_dir_1/package_adafruit_index.json

@@ -3935,12 +3935,16 @@
             {
               "packager": "arduino",
               "name": "bossac",
-              "version": "1.7.0"
+              "version": "1.8.0-48-gb176eee"
             },
             {
+	      "_warning":
+
+                   "*** [email protected] is listed after [email protected] to test if the runtime propoerty `runtime.tools.bossac.path` is correctly set to the path of [email protected] ***",
+
               "packager": "arduino",
               "name": "bossac",
-              "version": "1.8.0-48-gb176eee"
+              "version": "1.7.0"
             },
             {
               "packager": "arduino",