Using semantic versioning everywhere

Author: cmaglie

Gopkg.lock

@@ -30,15 +30,13 @@
 package cores
 
 import (
-	"fmt"
 	"strings"
 
 	"github.com/arduino/go-paths-helper"
 
 	properties "github.com/arduino/go-properties-map"
 	"github.com/bcmi-labs/arduino-cli/arduino/resources"
-
-	"github.com/blang/semver"
+	"go.bug.st/relaxed-semver"
 )
 
 // Platform represents a platform package.
@@ -53,7 +51,7 @@ type Platform struct {
 // PlatformRelease represents a release of a plaform package.
 type PlatformRelease struct {
 	Resource       *resources.DownloadResource
-	Version        string
+	Version        *semver.Version
 	BoardsManifest []*BoardManifest
 	Dependencies   ToolDependencies // The Dependency entries to load tools.
 	Platform       *Platform        `json:"-"`
@@ -96,19 +94,23 @@ type ToolDependencies []*ToolDependency
 // ToolDependency is a tuple that uniquely identifies a specific version of a Tool
 type ToolDependency struct {
 	ToolName     string
-	ToolVersion  string
+	ToolVersion  *semver.Version
 	ToolPackager string
 }
 
 func (dep *ToolDependency) String() string {
-	return dep.ToolPackager + ":" + dep.ToolName + "@" + dep.ToolVersion
+	return dep.ToolPackager + ":" + dep.ToolName + "@" + dep.ToolVersion.String()
 }
 
 // GetOrCreateRelease returns the specified release corresponding the provided version,
 // or creates a new one if not found.
-func (platform *Platform) GetOrCreateRelease(version string) *PlatformRelease {
-	if release, ok := platform.Releases[version]; ok {
-		return release
+func (platform *Platform) GetOrCreateRelease(version *semver.Version) (*PlatformRelease, error) {
+	tag := ""
+	if version != nil {
+		tag = version.String()
+	}
+	if release, ok := platform.Releases[tag]; ok {
+		return release, nil
 	}
 	release := &PlatformRelease{
 		Version:     version,
@@ -117,48 +119,50 @@ func (platform *Platform) GetOrCreateRelease(version string) *PlatformRelease {
 		Programmers: map[string]properties.Map{},
 		Platform:    platform,
 	}
-	platform.Releases[version] = release
-	return release
+	platform.Releases[tag] = release
+	return release, nil
 }
 
 // GetRelease returns the specified release corresponding the provided version,
 // or nil if not found.
-func (platform *Platform) GetRelease(version string) *PlatformRelease {
-	return platform.Releases[version]
+func (platform *Platform) GetRelease(version *semver.Version) *PlatformRelease {
+	return platform.Releases[version.String()]
 }
 
-// GetLatestRelease returns the latest release of this platform
+// GetLatestRelease returns the latest release of this platform, or nil if no releases
+// are available
 func (platform *Platform) GetLatestRelease() *PlatformRelease {
-	return platform.GetRelease(platform.latestReleaseVersion())
+	latestVersion := platform.latestReleaseVersion()
+	if latestVersion == nil {
+		return nil
+	}
+	return platform.GetRelease(latestVersion)
 }
 
 // GetAllReleasesVersions returns all the version numbers in this Platform Package.
-func (platform *Platform) GetAllReleasesVersions() semver.Versions {
-	versions := make(semver.Versions, 0, len(platform.Releases))
+func (platform *Platform) GetAllReleasesVersions() []*semver.Version {
+	versions := []*semver.Version{}
 	for _, release := range platform.Releases {
-		temp, err := semver.Make(release.Version)
-		if err == nil {
-			versions = append(versions, temp)
-		}
+		versions = append(versions, release.Version)
 	}
-
 	return versions
 }
 
-// latestReleaseVersion obtains latest version number.
-func (platform *Platform) latestReleaseVersion() string {
+// latestReleaseVersion obtains latest version number, or nil if no release available
+func (platform *Platform) latestReleaseVersion() *semver.Version {
 	// TODO: Cache latest version using a field in Platform
 	versions := platform.GetAllReleasesVersions()
 	if len(versions) == 0 {
-		return ""
+		return nil
 	}
 	max := versions[0]
+
 	for i := 1; i < len(versions); i++ {
-		if versions[i].GT(max) {
+		if versions[i].GreaterThan(max) {
 			max = versions[i]
 		}
 	}
-	return fmt.Sprint(max)
+	return max
 }
 
 // GetInstalled return one of the installed PlatformRelease
@@ -210,5 +214,9 @@ func (release *PlatformRelease) GetLibrariesDir() *paths.Path {
 }
 
 func (release *PlatformRelease) String() string {
-	return release.Platform.String() + "@" + release.Version
+	version := ""
+	if release.Version != nil {
+		version = release.Version.String()
+	}
+	return release.Platform.String() + "@" + version
 }

arduino/cores/cores.go

@@ -31,12 +31,12 @@ package packageindex
 
 import (
 	"encoding/json"
+	"fmt"
 
 	"github.com/arduino/go-paths-helper"
-
-	"github.com/bcmi-labs/arduino-cli/arduino/resources"
-
 	"github.com/bcmi-labs/arduino-cli/arduino/cores"
+	"github.com/bcmi-labs/arduino-cli/arduino/resources"
+	"go.bug.st/relaxed-semver"
 )
 
 // Index represents Cores and Tools struct as seen from package_index.json file.
@@ -59,7 +59,7 @@ type indexPackage struct {
 type indexPlatformRelease struct {
 	Name             string                `json:"name,required"`
 	Architecture     string                `json:"architecture"`
-	Version          string                `json:"version,required"`
+	Version          *semver.Version       `json:"version,required"`
 	Category         string                `json:"category"`
 	URL              string                `json:"url"`
 	ArchiveFileName  string                `json:"archiveFileName,required"`
@@ -72,15 +72,15 @@ type indexPlatformRelease struct {
 
 // indexToolDependency represents a single dependency of a core from a tool.
 type indexToolDependency struct {
-	Packager string `json:"packager,required"`
-	Name     string `json:"name,required"`
-	Version  string `json:"version,required"`
+	Packager string          `json:"packager,required"`
+	Name     string          `json:"name,required"`
+	Version  *semver.Version `json:"version,required"`
 }
 
 // indexToolRelease represents a single Tool from package_index.json file.
 type indexToolRelease struct {
 	Name    string                    `json:"name,required"`
-	Version string                    `json:"version,required"`
+	Version *semver.Version           `json:"version,required"`
 	Systems []indexToolReleaseFlavour `json:"systems,required"`
 }
 
@@ -130,14 +130,20 @@ func (inPackage indexPackage) extractPackageIn(outPackages *cores.Packages) {
 	}
 }
 
-func (inPlatformRelease indexPlatformRelease) extractPlatformIn(outPackage *cores.Package) {
+func (inPlatformRelease indexPlatformRelease) extractPlatformIn(outPackage *cores.Package) error {
 	outPlatform := outPackage.GetOrCreatePlatform(inPlatformRelease.Architecture)
 	// FIXME: shall we use the Name and Category of the latest release? or maybe move Name and Category in PlatformRelease?
 	outPlatform.Name = inPlatformRelease.Name
 	outPlatform.Category = inPlatformRelease.Category
 
-	size, _ := inPlatformRelease.Size.Int64()
-	outPlatformRelease := outPlatform.GetOrCreateRelease(inPlatformRelease.Version)
+	size, err := inPlatformRelease.Size.Int64()
+	if err != nil {
+		return fmt.Errorf("invalid platform archive size: %s", err)
+	}
+	outPlatformRelease, err := outPlatform.GetOrCreateRelease(inPlatformRelease.Version)
+	if err != nil {
+		return fmt.Errorf("creating release: %s", err)
+	}
 	outPlatformRelease.Resource = &resources.DownloadResource{
 		ArchiveFileName: inPlatformRelease.ArchiveFileName,
 		Checksum:        inPlatformRelease.Checksum,
@@ -146,10 +152,15 @@ func (inPlatformRelease indexPlatformRelease) extractPlatformIn(outPackage *core
 		CachePath:       "packages",
 	}
 	outPlatformRelease.BoardsManifest = inPlatformRelease.extractBoardsManifest()
-	outPlatformRelease.Dependencies = inPlatformRelease.extractDeps()
+	if deps, err := inPlatformRelease.extractDeps(); err != nil {
+		return fmt.Errorf("invalid tool dependencies: %s", err)
+	} else {
+		outPlatformRelease.Dependencies = deps
+	}
+	return nil
 }
 
-func (inPlatformRelease indexPlatformRelease) extractDeps() cores.ToolDependencies {
+func (inPlatformRelease indexPlatformRelease) extractDeps() (cores.ToolDependencies, error) {
 	ret := make(cores.ToolDependencies, len(inPlatformRelease.ToolDependencies))
 	for i, dep := range inPlatformRelease.ToolDependencies {
 		ret[i] = &cores.ToolDependency{
@@ -158,7 +169,7 @@ func (inPlatformRelease indexPlatformRelease) extractDeps() cores.ToolDependenci
 			ToolPackager: dep.Packager,
 		}
 	}
-	return ret
+	return ret, nil
 }
 
 func (inPlatformRelease indexPlatformRelease) extractBoardsManifest() []*cores.BoardManifest {

arduino/cores/packageindex/index.go

@@ -33,21 +33,21 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/cavaliercoder/grab"
-
 	"github.com/bcmi-labs/arduino-cli/arduino/cores"
 	"github.com/bcmi-labs/arduino-cli/common/formatter/output"
+	"github.com/cavaliercoder/grab"
+	"go.bug.st/relaxed-semver"
 )
 
 // PlatformReference represents a tuple to identify a Platform
 type PlatformReference struct {
 	Package              string // The package where this Platform belongs to.
 	PlatformArchitecture string
-	PlatformVersion      string
+	PlatformVersion      *semver.Version
 }
 
 func (platform *PlatformReference) String() string {
-	return platform.Package + ":" + platform.PlatformArchitecture + "@" + platform.PlatformVersion
+	return platform.Package + ":" + platform.PlatformArchitecture + "@" + platform.PlatformVersion.String()
 }
 
 // FindPlatform returns the Platform matching the PlatformReference or nil if not found.
@@ -70,7 +70,7 @@ func (pm *PackageManager) FindPlatformRelease(ref *PlatformReference) *cores.Pla
 	if platform == nil {
 		return nil
 	}
-	platformRelease, ok := platform.Releases[ref.PlatformVersion]
+	platformRelease, ok := platform.Releases[ref.PlatformVersion.String()]
 	if !ok {
 		return nil
 	}
@@ -102,7 +102,7 @@ func (pm *PackageManager) FindItemsToDownload(items []PlatformReference) (
 		added[platform.String()] = true
 
 		var release *cores.PlatformRelease
-		if item.PlatformVersion != "" {
+		if item.PlatformVersion != nil {
 			release = platform.GetRelease(item.PlatformVersion)
 			if release == nil {
 				return nil, nil, fmt.Errorf("required version %s not found for platform %s", item.PlatformVersion, platform.String())

arduino/cores/packagemanager/download.go

@@ -41,7 +41,7 @@ func (pm *PackageManager) InstallPlatform(platformRelease *cores.PlatformRelease
 		platformRelease.Platform.Package.Name,
 		"hardware",
 		platformRelease.Platform.Architecture,
-		platformRelease.Version)
+		platformRelease.Version.String())
 	return platformRelease.Resource.Install(pm.DownloadDir, pm.TempDir, destDir)
 }
 
@@ -55,6 +55,6 @@ func (pm *PackageManager) InstallTool(toolRelease *cores.ToolRelease) error {
 		toolRelease.Tool.Package.Name,
 		"tools",
 		toolRelease.Tool.Name,
-		toolRelease.Version)
+		toolRelease.Version.String())
 	return toolResource.Install(pm.DownloadDir, pm.TempDir, destDir)
 }