Deamon implementation and refactoring

Author: cmaglie

cli/board/details.go

@@ -18,11 +18,14 @@
 package board
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/arduino/arduino-cli/cli"
-	b "github.com/arduino/arduino-cli/commands/board"
+	"github.com/arduino/arduino-cli/commands/board"
+	"github.com/arduino/arduino-cli/common/formatter"
 	"github.com/arduino/arduino-cli/output"
+	"github.com/arduino/arduino-cli/rpc"
 	"github.com/spf13/cobra"
 )
 
@@ -39,15 +42,23 @@ func initDetailsCommand() *cobra.Command {
 }
 
 func runDetailsCommand(cmd *cobra.Command, args []string) {
-	pm := cli.InitPackageManager()
-	res := b.Details(pm, &b.DetailsReq{Fqbn: args[0]})
+	instance := cli.CreateInstance()
 
-	if !cli.OutputJSON(res) {
-		outputDetailsResp(res)
+	res := board.BoardDetails(context.Background(), &rpc.BoardDetailsReq{
+		Instance: instance,
+		Fqbn:     args[0],
+	})
+
+	if cli.OutputJSONOrElse(res) {
+		if res.GetResult().Success() {
+			outputDetailsResp(res)
+		} else {
+			formatter.PrintError(res.Result, "")
+		}
 	}
 }
 
-func outputDetailsResp(details *b.DetailsResp) {
+func outputDetailsResp(details *rpc.BoardDetailsResp) {
 	table := output.NewTable()
 	table.SetColumnWidthMode(1, output.Average)
 	table.AddRow("Board name:", details.Name)

cli/commands.go renamed to cli/cli.go

@@ -18,20 +18,21 @@
 package cli
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
 
-	paths "github.com/arduino/go-paths-helper"
+	"github.com/arduino/arduino-cli/commands"
 
-	"github.com/arduino/arduino-cli/arduino/libraries"
+	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/arduino/sketches"
-	"github.com/arduino/arduino-cli/configs"
-
-	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/common/formatter"
+	"github.com/arduino/arduino-cli/configs"
+	"github.com/arduino/arduino-cli/rpc"
+	paths "github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 )
 
@@ -63,20 +64,20 @@ var GlobalFlags struct {
 	OutputJSON bool // true output in JSON, false output as Text
 }
 
-// OutputJSON outputs the JSON encoding of v if the JSON output format has been
-// selected by the user and returns true. Otherwise no output is produced and the
-// function returns false.
-func OutputJSON(v interface{}) bool {
+// OutputJSONOrElse outputs the JSON encoding of v if the JSON output format has been
+// selected by the user and returns false. Otherwise no output is produced and the
+// function returns true.
+func OutputJSONOrElse(v interface{}) bool {
 	if !GlobalFlags.OutputJSON {
-		return false
+		return true
 	}
 	d, err := json.MarshalIndent(v, "", "  ")
 	if err != nil {
 		formatter.PrintError(err, "Error during JSON encoding of the output")
 		os.Exit(ErrGeneric)
 	}
 	fmt.Print(string(d))
-	return true
+	return false
 }
 
 // AppName is the command line name of the Arduino CLI executable
@@ -95,78 +96,60 @@ func InitPackageManagerWithoutBundles() *packagemanager.PackageManager {
 	return InitPackageManager()
 }
 
-// InitPackageManager initializes the PackageManager
-// TODO: for the daemon mode, this might be called at startup, but for now only commands needing the PM will call it
-func InitPackageManager() *packagemanager.PackageManager {
-	logrus.Info("Initializing package manager")
-
-	pm := packagemanager.NewPackageManager(
-		Config.IndexesDir(),
-		Config.PackagesDir(),
-		Config.DownloadsDir(),
-		Config.DataDir.Join("tmp"))
-
+func packageManagerInitReq() *rpc.InitReq {
+	urls := []string{}
 	for _, URL := range Config.BoardManagerAdditionalUrls {
-		if err := pm.LoadPackageIndex(URL); err != nil {
-			formatter.PrintError(err, "Failed to load "+URL.String()+" package index.\n"+
-				"Try updating all indexes with `"+AppName+" core update-index`.")
-			os.Exit(ErrCoreConfig)
-		}
+		urls = append(urls, URL.String())
 	}
 
-	if err := pm.LoadHardware(Config); err != nil {
-		formatter.PrintError(err, "Error loading hardware packages.")
-		os.Exit(ErrCoreConfig)
+	req := &rpc.InitReq{
+		Configuration: &rpc.Configuration{
+			DataDir:                    Config.DataDir.String(),
+			DownloadsDir:               Config.DownloadsDir().String(),
+			BoardManagerAdditionalUrls: urls,
+		},
 	}
-
-	return pm
+	return req
 }
 
-// InitLibraryManager initializes the LibraryManager using the underlying packagemanager
-func InitLibraryManager(cfg *configs.Configuration, pm *packagemanager.PackageManager) *librariesmanager.LibrariesManager {
-	logrus.Info("Starting libraries manager")
-	lm := librariesmanager.NewLibraryManager(
-		cfg.IndexesDir(),
-		Config.DownloadsDir())
-
-	// Add IDE builtin libraries dir
-	if bundledLibsDir := Config.IDEBundledLibrariesDir(); bundledLibsDir != nil {
-		lm.AddLibrariesDir(bundledLibsDir, libraries.IDEBuiltIn)
+// CreateInstance creates and return an instance of the Arduino Core engine
+func CreateInstance() *rpc.Instance {
+	logrus.Info("Initializing package manager")
+	resp, err := commands.Init(context.Background(), packageManagerInitReq())
+	if err != nil {
+		formatter.PrintError(err, "Error initializing package manager")
+		os.Exit(rpc.ErrGeneric)
 	}
+	return resp.GetInstance()
+}
 
-	// Add sketchbook libraries dir
-	lm.AddLibrariesDir(Config.LibrariesDir(), libraries.Sketchbook)
-
-	// Add libraries dirs from installed platforms
-	if pm != nil {
-		for _, targetPackage := range pm.GetPackages().Packages {
-			for _, platform := range targetPackage.Platforms {
-				if platformRelease := pm.GetInstalledPlatformRelease(platform); platformRelease != nil {
-					lm.AddPlatformReleaseLibrariesDir(platformRelease, libraries.PlatformBuiltIn)
-				}
-			}
-		}
+// InitPackageManager initializes the PackageManager
+// TODO: for the daemon mode, this might be called at startup, but for now only commands needing the PM will call it
+func InitPackageManager() *packagemanager.PackageManager {
+	logrus.Info("Initializing package manager")
+	resp, err := commands.Init(context.Background(), packageManagerInitReq())
+	if err != nil {
+		formatter.PrintError(err, "Error initializing package manager")
+		os.Exit(rpc.ErrGeneric)
 	}
+	return commands.GetPackageManager(resp)
+}
 
-	// Auto-update index if needed
-	if err := lm.LoadIndex(); err != nil {
-		logrus.WithError(err).Warn("Error during libraries index loading, trying to auto-update index")
-		UpdateLibrariesIndex(lm)
-	}
-	if err := lm.LoadIndex(); err != nil {
-		logrus.WithError(err).Error("Error during libraries index loading")
-		formatter.PrintError(err, "Error loading libraries index")
-		os.Exit(ErrGeneric)
+// InitLibraryManager initializes the LibraryManager. If pm is nil, the library manager will not handle core-libraries.
+// TODO: for the daemon mode, this might be called at startup, but for now only commands needing the PM will call it
+func InitLibraryManager(cfg *configs.Configuration, pm *packagemanager.PackageManager) *librariesmanager.LibrariesManager {
+	req := packageManagerInitReq()
+	if pm == nil {
+		req.LibraryManagerOnly = true
 	}
 
-	// Scan for libraries
-	if err := lm.RescanLibraries(); err != nil {
-		logrus.WithError(err).Error("Error during libraries rescan")
-		formatter.PrintError(err, "Error during libraries rescan")
-		os.Exit(ErrGeneric)
+	logrus.Info("Initializing library manager")
+	resp, err := commands.Init(context.Background(), req)
+	if err != nil {
+		formatter.PrintError(err, "Error initializing library manager")
+		os.Exit(rpc.ErrGeneric)
 	}
-
-	return lm
+	return commands.GetLibraryManager(resp)
 }
 
 // UpdateLibrariesIndex updates the library_index.json

cli/commands_test.go renamed to cli/cli_test.go

@@ -0,0 +1,46 @@
+//
+
+package daemon
+
+import (
+	"fmt"
+	"log"
+	"net"
+
+	"github.com/arduino/arduino-cli/cli"
+	"github.com/arduino/arduino-cli/daemon"
+	"github.com/arduino/arduino-cli/rpc"
+	"github.com/spf13/cobra"
+	"google.golang.org/grpc"
+)
+
+// InitCommand initalize the command
+func InitCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "daemon",
+		Short:   "Run as a daemon",
+		Long:    "Running as a daemon the initialization of cores and libraries is done only once.",
+		Example: "  " + cli.AppName + " daemon",
+		Args:    cobra.NoArgs,
+		Run:     runDaemonCommand,
+		Hidden:  true,
+	}
+	return cmd
+}
+
+const (
+	port = ":50051"
+)
+
+func runDaemonCommand(cmd *cobra.Command, args []string) {
+	lis, err := net.Listen("tcp", port)
+	if err != nil {
+		log.Fatalf("failed to listen: %v", err)
+	}
+	s := grpc.NewServer()
+	rpc.RegisterArduinoCoreServer(s, &daemon.ArduinoCoreServerImpl{})
+	if err := s.Serve(lis); err != nil {
+		log.Fatalf("failed to serve: %v", err)
+	}
+	fmt.Println("Done serving")
+}