[WIP] Here's the new PackageManager

lorenzo-biava · lorenzo-biava · commit 10b70eb7a8b1 · 2018-03-05T17:22:30.000+01:00
diff --git a/commands/board/attach.go b/commands/board/attach.go
@@ -84,6 +84,7 @@ func runAttachCommand(cmd *cobra.Command, args []string) {
 
 	time.Sleep(duration)
 
+	// FIXME: Replace with the PackageManager
 	homeFolder, err := configs.ArduinoHomeFolder.Get()
 	if err != nil {
 		formatter.PrintError(err, "Cannot Parse Board Index file.")
@@ -145,6 +146,7 @@ func runAttachCommand(cmd *cobra.Command, args []string) {
 	formatter.PrintResult("BOARD ATTACHED.")
 }
 
+// FIXME: Those should probably go in a "BoardManager" pkg or something
 // findSerialConnectedBoard find the board which is connected to the specified URI via serial port, using a monitor and a set of Boards
 // for the matching.
 func findSerialConnectedBoard(bs boards.Boards, monitor *discovery.Monitor, deviceURI *url.URL) *boards.Board {
diff --git a/commands/board/list.go b/commands/board/list.go
@@ -39,6 +39,7 @@ var listCommand = &cobra.Command{
 // runListCommand detects and lists the connected arduino boards
 // (either via serial or network ports).
 func runListCommand(cmd *cobra.Command, args []string) {
+	// FIXME: Replace with the PackageManager
 	packageFolder, err := configs.PackagesFolder.Get()
 	if err != nil {
 		formatter.PrintError(err, "Cannot Parse Board Index file.")
diff --git a/commands/compile/compile.go b/commands/compile/compile.go
@@ -117,6 +117,7 @@ func run(cmd *cobra.Command, args []string) {
 		}
 	}
 
+	// FIXME: Replace with the PackageManager
 	isCtagsInstalled, err := cores.IsToolInstalled(packageName, "ctags")
 	if err != nil {
 		formatter.PrintError(err, "Cannot check ctags installation.")
@@ -195,6 +196,7 @@ func run(cmd *cobra.Command, args []string) {
 		formatter.PrintError(err, "Cannot get the core version.")
 		os.Exit(commands.ErrBadCall)
 	}
+	// FIXME: this is building the CommandLine to run the builder; we should move it to a "cores.compute" pkg
 	// Add dependency tools paths to build properties with versions corresponding to specific core version.
 	var packageIndex packageindex.Index
 	packageindex.LoadIndex(&packageIndex)
diff --git a/commands/config/init.go b/commands/config/init.go
@@ -85,6 +85,7 @@ func runInitCommand(cmd *cobra.Command, args []string) {
 	logrus.Info("Done")
 }
 
+// FIXME: is this any useful?
 // ConfigsFromQuestions asks some questions to the user to properly initialize configs.
 // It does not have much sense to use it in JSON formatting, though.
 func configsFromQuestions() {
diff --git a/commands/core/args.go b/commands/core/args.go
@@ -78,6 +78,7 @@ func parsePlatformReferenceArgs(args []string) []platformReference {
 	return ret
 }
 
+// FIXME: Replace move to the PackageManager
 // findItemsToDownload takes a set of platformReference and returns a set of items to download and
 // a set of outputs for non existing platforms.
 func findItemsToDownload(sc *cores.Packages, items []platformReference) ([]*cores.PlatformRelease, []*cores.ToolRelease, []output.ProcessResult) {
diff --git a/commands/core/core.go b/commands/core/core.go
@@ -55,6 +55,8 @@ var command = &cobra.Command{
 	Example: "arduino core update-index # to update the package index file.",
 }
 
+// FIXME: Move to the PackageManager
+
 // getInstalledCores gets the installed cores and puts them in the output struct.
 func getInstalledCores(packageName string, cores *[]output.InstalledStuff) {
 	getInstalledStuff(cores, configs.CoresFolder(packageName))
@@ -118,6 +120,5 @@ func getPackagesStatusContext() (*cores.Packages, error) {
 		return &status, nil
 	}
 
-	status := index.CreateStatusContext()
-	return &status, nil
+	return index.CreateStatusContext(), nil
 }
diff --git a/commands/core/download.go b/commands/core/download.go
@@ -40,6 +40,7 @@ import (
 	"github.com/bcmi-labs/arduino-cli/cores"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	"github.com/bcmi-labs/arduino-cli/cores/packagemanager"
 )
 
 func init() {
@@ -75,6 +76,22 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
 		Tools: []output.ProcessResult{},
 	}
 
+	// FIXME: that's just a PoC; please have mercy...
+	fmt.Printf("TESTING THE FLUENT PKGMGR\n")
+
+	_, err = packagemanager.PackageManager().AddDefaultPackageIndex()
+	fmt.Printf("Loading default package index, error: %v\n", err)
+
+	tool, err := packagemanager.PackageManager().Package("not-found").Tool("avrdude").IsInstalled()
+	fmt.Printf("Tool status: %s, %v\n", tool, err)
+
+	tool, err = packagemanager.PackageManager().Package("arduino").Tool("not-found").IsInstalled()
+	fmt.Printf("Tool status: %s, %v\n", tool, err)
+
+	tool, err = packagemanager.PackageManager().Package("arduino").Tool("avrdude").IsInstalled()
+	fmt.Printf("Tool status: %s, %v\n", tool, err)
+
+
 	downloadToolsArchives(toolsToDownload, &outputResults)
 
 	downloadPlatformArchives(coresToDownload, &outputResults)
@@ -83,6 +100,9 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
 	logrus.Info("Done")
 }
 
+// FIXME: Move to the PackageManager and look for a way to uncouple of the printing logic
+// All this stuff is pkgmgr responsibility for sure
+
 func downloadToolsArchives(tools []*cores.ToolRelease, results *output.CoreProcessResults) {
 	downloads := map[string]*releases.DownloadResource{}
 	for _, tool := range tools {
diff --git a/commands/core/install.go b/commands/core/install.go
@@ -69,6 +69,7 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 
 	logrus.Info("Preparing download")
 
+	// FIXME: Isn't this the same code as in core/download.go? Should be refactored
 	coresToDownload, toolsToDownload, failOutputs := findItemsToDownload(status, parsePlatformReferenceArgs(args))
 	failOutputsCount := len(failOutputs)
 	outputResults := output.CoreProcessResults{
diff --git a/commands/core/list.go b/commands/core/list.go
@@ -75,6 +75,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
 		os.Exit(commands.ErrCoreConfig)
 	}
 
+	// FIXME: Use the PackageManager instead
 	pkgs := output.InstalledPackageList{
 		InstalledPackages: make([]output.InstalledPackage, 0, 10),
 	}
diff --git a/common/formatter/pretty_print/pretty_print_core.go b/common/formatter/pretty_print/pretty_print_core.go
@@ -34,11 +34,12 @@ import (
 	"github.com/bcmi-labs/arduino-cli/cores"
 	"github.com/bcmi-labs/arduino-cli/cores/packageindex"
 	"github.com/bcmi-labs/arduino-cli/task"
+	"github.com/bcmi-labs/arduino-cli/cores/packagemanager"
 )
 
 // DownloadCoreFileIndex shows info regarding the download of a missing (or corrupted) file index of core packages.
 func DownloadCoreFileIndex() task.Task {
-	return DownloadFileIndex(packageindex.DownloadPackagesFile)
+	return DownloadFileIndex(packagemanager.PackageManager().DownloadPackagesFile)
 }
 
 // CorruptedCoreIndexFix pretty prints messages regarding corrupted index fixes of cores.
diff --git a/cores/common.go b/cores/common.go
@@ -38,6 +38,7 @@ import (
 	"github.com/bcmi-labs/arduino-cli/configs"
 )
 
+// FIXME: Move all of these to PackageManager().Tools().isInstalled() or something like that
 // IsCoreInstalled detects if a core has been installed.
 func IsCoreInstalled(packageName string, name string) (bool, error) {
 	location, err := configs.CoresFolder(packageName).Get()
diff --git a/cores/packageindex/index.go b/cores/packageindex/index.go
@@ -110,13 +110,12 @@ type indexHelp struct {
 }
 
 // CreateStatusContext creates a status context from index data.
-func (index Index) CreateStatusContext() cores.Packages {
-	res := cores.Packages{
-		Packages: map[string]*cores.Package{},
-	}
+func (index Index) CreateStatusContext() *cores.Packages {
+	res := cores.NewPackages()
+
 	for _, p := range index.Packages {
 		res.Packages[p.Name] = p.extractPackage()
-		res.Packages[p.Name].Packages = &res
+		res.Packages[p.Name].Packages = res
 	}
 	return res
 }
diff --git a/cores/packagemanager/package_manager.go b/cores/packagemanager/package_manager.go
@@ -0,0 +1,144 @@
+package packagemanager
+
+import (
+	"sync"
+
+	"github.com/bcmi-labs/arduino-cli/cores/packageindex"
+	"fmt"
+	"github.com/bcmi-labs/arduino-cli/cores"
+	"github.com/bcmi-labs/arduino-cli/configs"
+	"os"
+	"path/filepath"
+	"github.com/juju/errors"
+)
+
+var packageManagerInstance *packageManager
+var once sync.Once
+
+// PackageManager defines the superior oracle which understands all about
+// Arduino Packages, how to parse them, download, and so on.
+//
+// The manager also keeps track of the status of the Packages (their Platform Releases, actually)
+// installed in the system.
+type packageManager struct {
+	/* FIXME
+
+		What's the typical flow?
+
+		You start by downloading AN PackageIndex (remember: multiple repositories are allowed??)
+	*/
+
+	packages *cores.Packages
+}
+
+// PackageManager return the instance of the PackageManager
+// yeah, that's a singleton by the way...
+func PackageManager() *packageManager {
+	once.Do(func() {
+		// TODO: why not just use the Go pkg init()?
+		packageManagerInstance = &packageManager{}
+		// TODO: perhaps directly use the loading from PackagesIndex file?
+		packageManagerInstance.packages = cores.NewPackages()
+	})
+
+	fmt.Println("==> Cool! You're using my new singleton PackageManager.")
+
+	return packageManagerInstance
+}
+
+// FIXME add an handler to be invoked on each verbose operation, in order to let commands display results through the formatter
+// as for the progress bars during download
+
+// FIXME this is currently hard-coded with the default PackageIndex and won't merge or check existing Packages!!
+func (pm *packageManager) AddDefaultPackageIndex() (*packageManager, error) {
+	var index packageindex.Index
+	err := packageindex.LoadIndex(&index)
+	if err != nil {
+		//TODO: The original version would automatically fix corrupted index?
+		/*status, err := prettyPrints.CorruptedCoreIndexFix(index)
+		if err != nil {
+			return pm, err
+		}
+		pm.packages = &status
+		return pm, nil*/
+
+		return pm, errors.Annotate(err, fmt.Sprintf("failed to load the package index, is probably corrupted" ))
+	}
+
+	// TODO: if this really is a singleton, a lock is needed :(
+	pm.packages = index.CreateStatusContext()
+	return pm, nil
+}
+
+// TODO: implement the generic version (with merge)
+/*func (pm *packageManager) AddPackageIndex() *packageManager {
+
+}*/
+
+// DownloadPackagesFile downloads the core packages index file from Arduino repository.
+func (pm *packageManager) DownloadPackagesFile() error {
+	return packageindex.DownloadPackagesFile()
+}
+
+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]
+	if thePackage == nil {
+		err = fmt.Errorf("package '%s' not found", name)
+	}
+	return &packageActions{
+		aPackage:     thePackage,
+		forwardError: err,
+	}
+}
+
+type packageActions struct {
+	aPackage     *cores.Package
+	forwardError error
+}
+
+func (pa *packageActions) Tool(name string) *toolActions {
+	var tool *cores.Tool
+	err := pa.forwardError
+	if err == nil {
+		tool = pa.aPackage.Tools[name]
+
+		if tool == nil {
+			err = fmt.Errorf("tool '%s' not found in package '%s'", name, pa.aPackage.Name)
+		}
+	}
+	return &toolActions{
+		tool:         tool,
+		forwardError: err,
+	}
+}
+
+type toolActions struct{
+	tool         *cores.Tool
+	forwardError error
+}
+
+func (ta *toolActions) Get() (*cores.Tool, error) {
+	err := ta.forwardError
+	if err == nil {
+		return ta.tool, nil
+	}
+	return nil, err
+}
+
+func (ta *toolActions) IsInstalled() (bool, error) {
+	err := ta.forwardError
+	if err == nil {
+		location, err := configs.ToolsFolder(ta.tool.Package.Name).Get()
+		if err != nil {
+			return false, err
+		}
+		_, err = os.Stat(filepath.Join(location, ta.tool.Name))
+		if !os.IsNotExist(err) {
+			return true, nil
+		}
+		return false, nil
+	}
+	return false, err
+}
diff --git a/cores/status.go b/cores/status.go
@@ -33,7 +33,7 @@ import (
 	"errors"
 	"fmt"
 
-	properties "github.com/arduino/go-properties-map"
+	"github.com/arduino/go-properties-map"
 	"github.com/pmylund/sortutil"
 )
 
@@ -44,6 +44,12 @@ type Packages struct {
 	Properties properties.Map `json:"-"` // TODO: used to add "ctags" properties, TO BE REMOVED
 }
 
+func NewPackages() *Packages {
+	return &Packages{
+		Packages: map[string]*Package{},
+	}
+}
+
 // Package represents a package in the system.
 type Package struct {
 	Name       string               // Name of the package.
@@ -52,7 +58,7 @@ 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:"-"`
 }
 
 // Names returns the array containing the name of the packages.

Original file line number	Diff line number	Diff line change
`@@ -117,6 +117,7 @@ func run(cmd *cobra.Command, args []string) {`
`117`	`117`	`}`
`118`	`118`	`}`
`119`	`119`
	`120`	`+ // FIXME: Replace with the PackageManager`
`120`	`121`	`isCtagsInstalled, err := cores.IsToolInstalled(packageName, "ctags")`
`121`	`122`	`if err != nil {`
`122`	`123`	`formatter.PrintError(err, "Cannot check ctags installation.")`
`@@ -195,6 +196,7 @@ func run(cmd *cobra.Command, args []string) {`
`195`	`196`	`formatter.PrintError(err, "Cannot get the core version.")`
`196`	`197`	`os.Exit(commands.ErrBadCall)`
`197`	`198`	`}`
	`199`	`+ // FIXME: this is building the CommandLine to run the builder; we should move it to a "cores.compute" pkg`
`198`	`200`	`// Add dependency tools paths to build properties with versions corresponding to specific core version.`
`199`	`201`	`var packageIndex packageindex.Index`
`200`	`202`	`packageindex.LoadIndex(&packageIndex)`
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ func runInitCommand(cmd *cobra.Command, args []string) {`
`85`	`85`	`logrus.Info("Done")`
`86`	`86`	`}`
`87`	`87`
	`88`	`+// FIXME: is this any useful?`
`88`	`89`	`// ConfigsFromQuestions asks some questions to the user to properly initialize configs.`
`89`	`90`	`// It does not have much sense to use it in JSON formatting, though.`
`90`	`91`	`func configsFromQuestions() {`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,7 @@ func parsePlatformReferenceArgs(args []string) []platformReference {`
`78`	`78`	`return ret`
`79`	`79`	`}`
`80`	`80`
	`81`	`+// FIXME: Replace move to the PackageManager`
`81`	`82`	`// findItemsToDownload takes a set of platformReference and returns a set of items to download and`
`82`	`83`	`// a set of outputs for non existing platforms.`
`83`	`84`	`func findItemsToDownload(sc cores.Packages, items []platformReference) ([]cores.PlatformRelease, []*cores.ToolRelease, []output.ProcessResult) {`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,8 @@ var command = &cobra.Command{`
`55`	`55`	`Example: "arduino core update-index # to update the package index file.",`
`56`	`56`	`}`
`57`	`57`
	`58`	`+// FIXME: Move to the PackageManager`
	`59`	`+`
`58`	`60`	`// getInstalledCores gets the installed cores and puts them in the output struct.`
`59`	`61`	`func getInstalledCores(packageName string, cores *[]output.InstalledStuff) {`
`60`	`62`	`getInstalledStuff(cores, configs.CoresFolder(packageName))`
`@@ -118,6 +120,5 @@ func getPackagesStatusContext() (*cores.Packages, error) {`
`118`	`120`	`return &status, nil`
`119`	`121`	`}`
`120`	`122`
`121`		`- status := index.CreateStatusContext()`
`122`		`- return &status, nil`
	`123`	`+ return index.CreateStatusContext(), nil`
`123`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,7 @@ func runListCommand(cmd *cobra.Command, args []string) {`
`75`	`75`	`os.Exit(commands.ErrCoreConfig)`
`76`	`76`	`}`
`77`	`77`
	`78`	`+ // FIXME: Use the PackageManager instead`
`78`	`79`	`pkgs := output.InstalledPackageList{`
`79`	`80`	`InstalledPackages: make([]output.InstalledPackage, 0, 10),`
`80`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,11 +34,12 @@ import (`
`34`	`34`	`"github.com/bcmi-labs/arduino-cli/cores"`
`35`	`35`	`"github.com/bcmi-labs/arduino-cli/cores/packageindex"`
`36`	`36`	`"github.com/bcmi-labs/arduino-cli/task"`
	`37`	`+ "github.com/bcmi-labs/arduino-cli/cores/packagemanager"`
`37`	`38`	`)`
`38`	`39`
`39`	`40`	`// DownloadCoreFileIndex shows info regarding the download of a missing (or corrupted) file index of core packages.`
`40`	`41`	`func DownloadCoreFileIndex() task.Task {`
`41`		`- return DownloadFileIndex(packageindex.DownloadPackagesFile)`
	`42`	`+ return DownloadFileIndex(packagemanager.PackageManager().DownloadPackagesFile)`
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`// CorruptedCoreIndexFix pretty prints messages regarding corrupted index fixes of cores.`