refactor the way core list is built

Author: masci

Diff for: arduino/cores/packageindex/index.go

@@ -24,7 +24,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/resources"
 	"github.com/arduino/go-paths-helper"
-	"go.bug.st/relaxed-semver"
+	semver "go.bug.st/relaxed-semver"
 )
 
 // Index represents Cores and Tools struct as seen from package_index.json file.
@@ -97,13 +97,13 @@ type indexHelp struct {
 
 // MergeIntoPackages converts the Index data into a cores.Packages and merge them
 // with the existing conents of the cores.Packages passed as parameter.
-func (index Index) MergeIntoPackages(outPackages *cores.Packages) {
+func (index Index) MergeIntoPackages(outPackages cores.Packages) {
 	for _, inPackage := range index.Packages {
 		inPackage.extractPackageIn(outPackages)
 	}
 }
 
-func (inPackage indexPackage) extractPackageIn(outPackages *cores.Packages) {
+func (inPackage indexPackage) extractPackageIn(outPackages cores.Packages) {
 	outPackage := outPackages.GetOrCreatePackage(inPackage.Name)
 	outPackage.Maintainer = inPackage.Maintainer
 	outPackage.WebsiteURL = inPackage.WebsiteURL

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

@@ -23,7 +23,7 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"go.bug.st/downloader"
-	"go.bug.st/relaxed-semver"
+	semver "go.bug.st/relaxed-semver"
 )
 
 // PlatformReference represents a tuple to identify a Platform
@@ -44,7 +44,7 @@ func (platform *PlatformReference) String() string {
 // FindPlatform returns the Platform matching the PlatformReference or nil if not found.
 // The PlatformVersion field of the reference is ignored.
 func (pm *PackageManager) FindPlatform(ref *PlatformReference) *cores.Platform {
-	targetPackage, ok := pm.GetPackages().Packages[ref.Package]
+	targetPackage, ok := pm.Packages[ref.Package]
 	if !ok {
 		return nil
 	}
@@ -71,7 +71,7 @@ func (pm *PackageManager) FindPlatformRelease(ref *PlatformReference) *cores.Pla
 // FindPlatformReleaseDependencies takes a PlatformReference and returns a set of items to download and
 // a set of outputs for non existing platforms.
 func (pm *PackageManager) FindPlatformReleaseDependencies(item *PlatformReference) (*cores.PlatformRelease, []*cores.ToolRelease, error) {
-	targetPackage, exists := pm.packages.Packages[item.Package]
+	targetPackage, exists := pm.Packages[item.Package]
 	if !exists {
 		return nil, nil, fmt.Errorf("package %s not found", item.Package)
 	}
@@ -94,7 +94,7 @@ func (pm *PackageManager) FindPlatformReleaseDependencies(item *PlatformReferenc
 	}
 
 	// replaces "latest" with latest version too
-	toolDeps, err := pm.packages.GetDepsOfPlatformRelease(release)
+	toolDeps, err := pm.Packages.GetDepsOfPlatformRelease(release)
 	if err != nil {
 		return nil, nil, fmt.Errorf("getting tool dependencies for platform %s: %s", release.String(), err)
 	}

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

@@ -127,7 +127,7 @@ func (pm *PackageManager) UninstallTool(toolRelease *cores.ToolRelease) error {
 // passed as parameter
 func (pm *PackageManager) IsToolRequired(toolRelease *cores.ToolRelease) bool {
 	// Search in all installed platforms
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, platform := range targetPackage.Platforms {
 			if platformRelease := pm.GetInstalledPlatformRelease(platform); platformRelease != nil {
 				if platformRelease.RequiresToolRelease(toolRelease) {

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

@@ -112,7 +112,7 @@ func (pm *PackageManager) LoadHardwareFromDirectory(path *paths.Path) error {
 			continue
 		}
 
-		targetPackage := pm.packages.GetOrCreatePackage(packager)
+		targetPackage := pm.Packages.GetOrCreatePackage(packager)
 		if err := pm.loadPlatforms(targetPackage, architectureParentPath); err != nil {
 			return fmt.Errorf("loading package %s: %s", packager, err)
 		}
@@ -419,7 +419,7 @@ func (pm *PackageManager) LoadToolsFromBundleDirectory(toolsPath *paths.Path) er
 		}
 
 		for packager, toolsData := range all.FirstLevelOf() {
-			targetPackage := pm.packages.GetOrCreatePackage(packager)
+			targetPackage := pm.Packages.GetOrCreatePackage(packager)
 
 			for toolName, toolVersion := range toolsData.AsMap() {
 				tool := targetPackage.GetOrCreateTool(toolName)
@@ -431,7 +431,7 @@ func (pm *PackageManager) LoadToolsFromBundleDirectory(toolsPath *paths.Path) er
 		}
 	} else {
 		// otherwise load the tools inside the unnamed package
-		unnamedPackage := pm.packages.GetOrCreatePackage("")
+		unnamedPackage := pm.Packages.GetOrCreatePackage("")
 		pm.loadToolsFromPackage(unnamedPackage, toolsPath)
 	}
 	return nil

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

@@ -38,9 +38,8 @@ import (
 // The manager also keeps track of the status of the Packages (their Platform Releases, actually)
 // installed in the system.
 type PackageManager struct {
-	Log      logrus.FieldLogger
-	packages *cores.Packages
-
+	Log         logrus.FieldLogger
+	Packages    cores.Packages
 	IndexDir    *paths.Path
 	PackagesDir *paths.Path
 	DownloadDir *paths.Path
@@ -51,28 +50,18 @@ type PackageManager struct {
 func NewPackageManager(indexDir, packagesDir, downloadDir, tempDir *paths.Path) *PackageManager {
 	return &PackageManager{
 		Log:         logrus.StandardLogger(),
-		packages:    cores.NewPackages(),
+		Packages:    cores.NewPackages(),
 		IndexDir:    indexDir,
 		PackagesDir: packagesDir,
 		DownloadDir: downloadDir,
 		TempDir:     tempDir,
 	}
 }
 
-// Clear FIXMEDOC
-func (pm *PackageManager) Clear() {
-	pm.packages = cores.NewPackages()
-}
-
-// GetPackages FIXMEDOC
-func (pm *PackageManager) GetPackages() *cores.Packages {
-	return pm.packages
-}
-
 // FindPlatformReleaseProvidingBoardsWithVidPid FIXMEDOC
 func (pm *PackageManager) FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid string) []*cores.PlatformRelease {
 	res := []*cores.PlatformRelease{}
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, targetPlatform := range targetPackage.Platforms {
 			platformRelease := targetPlatform.GetLatestRelease()
 			if platformRelease == nil {
@@ -92,7 +81,7 @@ func (pm *PackageManager) FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid
 // FindBoardsWithVidPid FIXMEDOC
 func (pm *PackageManager) FindBoardsWithVidPid(vid, pid string) []*cores.Board {
 	res := []*cores.Board{}
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, targetPlatform := range targetPackage.Platforms {
 			if platform := pm.GetInstalledPlatformRelease(targetPlatform); platform != nil {
 				for _, board := range platform.Boards {
@@ -109,7 +98,7 @@ func (pm *PackageManager) FindBoardsWithVidPid(vid, pid string) []*cores.Board {
 // FindBoardsWithID FIXMEDOC
 func (pm *PackageManager) FindBoardsWithID(id string) []*cores.Board {
 	res := []*cores.Board{}
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, targetPlatform := range targetPackage.Platforms {
 			if platform := pm.GetInstalledPlatformRelease(targetPlatform); platform != nil {
 				for _, board := range platform.Boards {
@@ -152,7 +141,7 @@ func (pm *PackageManager) ResolveFQBN(fqbn *cores.FQBN) (
 	*properties.Map, *cores.PlatformRelease, error) {
 
 	// Find package
-	targetPackage := pm.packages.Packages[fqbn.Package]
+	targetPackage := pm.Packages[fqbn.Package]
 	if targetPackage == nil {
 		return nil, nil, nil, nil, nil,
 			errors.New("unknown package " + fqbn.Package)
@@ -189,7 +178,7 @@ func (pm *PackageManager) ResolveFQBN(fqbn *cores.FQBN) (
 	coreParts := strings.Split(buildProperties.Get("build.core"), ":")
 	if len(coreParts) > 1 {
 		referredPackage := coreParts[1]
-		buildPackage := pm.packages.Packages[referredPackage]
+		buildPackage := pm.Packages[referredPackage]
 		if buildPackage == nil {
 			return targetPackage, platformRelease, board, buildProperties, nil,
 				fmt.Errorf("missing package %s:%s required for build", referredPackage, platform)
@@ -215,7 +204,7 @@ func (pm *PackageManager) LoadPackageIndexFromFile(indexPath *paths.Path) (*pack
 		return nil, fmt.Errorf("loading json index file %s: %s", indexPath, err)
 	}
 
-	index.MergeIntoPackages(pm.packages)
+	index.MergeIntoPackages(pm.Packages)
 	return index, nil
 }
 
@@ -224,7 +213,7 @@ func (pm *PackageManager) LoadPackageIndexFromFile(indexPath *paths.Path) (*pack
 func (pm *PackageManager) Package(name string) *PackageActions {
 	//TODO: perhaps these 2 structure should be merged? cores.Packages vs pkgmgr??
 	var err error
-	thePackage := pm.packages.Packages[name]
+	thePackage := pm.Packages[name]
 	if thePackage == nil {
 		err = fmt.Errorf("package '%s' not found", name)
 	}
@@ -350,7 +339,7 @@ func (pm *PackageManager) GetInstalledPlatformRelease(platform *cores.Platform)
 // GetAllInstalledToolsReleases FIXMEDOC
 func (pm *PackageManager) GetAllInstalledToolsReleases() []*cores.ToolRelease {
 	tools := []*cores.ToolRelease{}
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, tool := range targetPackage.Tools {
 			for _, release := range tool.Releases {
 				if release.IsInstalled() {
@@ -366,7 +355,7 @@ func (pm *PackageManager) GetAllInstalledToolsReleases() []*cores.ToolRelease {
 // useful to range all PlatformReleases in for loops.
 func (pm *PackageManager) InstalledPlatformReleases() []*cores.PlatformRelease {
 	platforms := []*cores.PlatformRelease{}
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, platform := range targetPackage.Platforms {
 			for _, release := range platform.GetAllInstalled() {
 				platforms = append(platforms, release)
@@ -380,7 +369,7 @@ func (pm *PackageManager) InstalledPlatformReleases() []*cores.PlatformRelease {
 // all Boards in for loops.
 func (pm *PackageManager) InstalledBoards() []*cores.Board {
 	boards := []*cores.Board{}
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, platform := range targetPackage.Platforms {
 			for _, release := range platform.GetAllInstalled() {
 				for _, board := range release.Boards {
@@ -404,7 +393,7 @@ func (pm *PackageManager) FindToolsRequiredForBoard(board *cores.Board) ([]*core
 
 	// a Platform may not specify required tools (because it's a platform that comes from a
 	// sketchbook/hardware dir without a package_index.json) then add all available tools
-	for _, targetPackage := range pm.packages.Packages {
+	for _, targetPackage := range pm.Packages {
 		for _, tool := range targetPackage.Tools {
 			rel := tool.GetLatestInstalled()
 			if rel != nil {

Diff for: arduino/cores/status.go

@@ -25,15 +25,11 @@ import (
 )
 
 // Packages represents a set of Packages
-type Packages struct {
-	Packages map[string]*Package // Maps packager name to Package
-}
+type Packages map[string]*Package // Maps packager name to Package
 
 // NewPackages creates a new Packages object
-func NewPackages() *Packages {
-	return &Packages{
-		Packages: map[string]*Package{},
-	}
+func NewPackages() Packages {
+	return map[string]*Package{}
 }
 
 // Package represents a package in the system.
@@ -44,13 +40,13 @@ type Package struct {
 	Email      string               // Email of maintainer.
 	Platforms  map[string]*Platform // The platforms in the system.
 	Tools      map[string]*Tool     // The tools in the system.
-	Packages   *Packages            `json:"-"`
+	Packages   Packages             `json:"-"`
 }
 
 // GetOrCreatePackage returns the specified Package or create an empty one
 // filling all the cross-references
-func (packages *Packages) GetOrCreatePackage(packager string) *Package {
-	if targetPackage, ok := packages.Packages[packager]; ok {
+func (packages Packages) GetOrCreatePackage(packager string) *Package {
+	if targetPackage, ok := packages[packager]; ok {
 		return targetPackage
 	}
 	targetPackage := &Package{
@@ -59,22 +55,46 @@ func (packages *Packages) GetOrCreatePackage(packager string) *Package {
 		Tools:     map[string]*Tool{},
 		Packages:  packages,
 	}
-	packages.Packages[packager] = targetPackage
+	packages[packager] = targetPackage
 	return targetPackage
 }
 
 // Names returns the array containing the name of the packages.
-func (packages *Packages) Names() []string {
-	res := make([]string, len(packages.Packages))
+func (packages Packages) Names() []string {
+	res := make([]string, len(packages))
 	i := 0
-	for n := range packages.Packages {
+	for n := range packages {
 		res[i] = n
 		i++
 	}
 	sortutil.CiAsc(res)
 	return res
 }
 
+// GetDepsOfPlatformRelease returns the deps of a specified release of a core.
+func (packages Packages) GetDepsOfPlatformRelease(release *PlatformRelease) ([]*ToolRelease, error) {
+	if release == nil {
+		return nil, errors.New("release cannot be nil")
+	}
+	ret := []*ToolRelease{}
+	for _, dep := range release.Dependencies {
+		pkg, exists := packages[dep.ToolPackager]
+		if !exists {
+			return nil, fmt.Errorf("package %s not found", dep.ToolPackager)
+		}
+		tool, exists := pkg.Tools[dep.ToolName]
+		if !exists {
+			return nil, fmt.Errorf("tool %s not found", dep.ToolName)
+		}
+		toolRelease, exists := tool.Releases[dep.ToolVersion.String()]
+		if !exists {
+			return nil, fmt.Errorf("tool version %s not found", dep.ToolVersion)
+		}
+		ret = append(ret, toolRelease)
+	}
+	return ret, nil
+}
+
 // GetOrCreatePlatform returns the Platform object with the specified architecture
 // or creates a new one if not found
 func (targetPackage *Package) GetOrCreatePlatform(architecure string) *Platform {
@@ -110,7 +130,7 @@ func (targetPackage *Package) String() string {
 }
 
 func (tdep ToolDependency) extractTool(sc Packages) (*Tool, error) {
-	pkg, exists := sc.Packages[tdep.ToolPackager]
+	pkg, exists := sc[tdep.ToolPackager]
 	if !exists {
 		return nil, errors.New("package not found")
 	}
@@ -132,27 +152,3 @@ func (tdep ToolDependency) extractRelease(sc Packages) (*ToolRelease, error) {
 	}
 	return release, nil
 }
-
-// GetDepsOfPlatformRelease returns the deps of a specified release of a core.
-func (packages *Packages) GetDepsOfPlatformRelease(release *PlatformRelease) ([]*ToolRelease, error) {
-	if release == nil {
-		return nil, errors.New("release cannot be nil")
-	}
-	ret := []*ToolRelease{}
-	for _, dep := range release.Dependencies {
-		pkg, exists := packages.Packages[dep.ToolPackager]
-		if !exists {
-			return nil, fmt.Errorf("package %s not found", dep.ToolPackager)
-		}
-		tool, exists := pkg.Tools[dep.ToolName]
-		if !exists {
-			return nil, fmt.Errorf("tool %s not found", dep.ToolName)
-		}
-		toolRelease, exists := tool.Releases[dep.ToolVersion.String()]
-		if !exists {
-			return nil, fmt.Errorf("tool version %s not found", dep.ToolVersion)
-		}
-		ret = append(ret, toolRelease)
-	}
-	return ret, nil
-}