[breaking] Refactor initialization steps (#1274)

* [breaking] Split rpc Init and remove Rescan function

* [breaking] Refactored commands package to reflect gRPC changes

* [breaking] Refactored cli package to reflect commands changes

* Fix instance creation for CLI commands that update indexes

* Fix unit tests

* Change update indexes commands to not reload instance after

* Fix installation of builtin tools

* Fix integration tests

* Fix code for linting

* Update i18n files

* Update UPGRADING.md with breaking changes

* Update comment with correct information

Co-authored-by: per1234 <accounts@perglass.com>

* Using callback instead of channel+goroutine for Init

* Enhance platform loading step

* Update client_example to reflect new gRPC changes

* Enhance Init docstring

* Enhance builtin tools installation during Init

* Fix unit test

* Fix integration tests

* [skip changelog] Fix after botched rebase

* Fix issue when using Init to rescan installed core on already initialized instance

* Update generated file from .proto

Co-authored-by: per1234 <accounts@perglass.com>
Co-authored-by: Cristian Maglie <c.maglie@arduino.cc>

Author: 3 people

arduino/cores/packagemanager/loader.go

@@ -58,6 +58,12 @@ func NewPackageManager(indexDir, packagesDir, downloadDir, tempDir *paths.Path)
 	}
 }
 
+// Clear resets the PackageManager to its initial state
+func (pm *PackageManager) Clear() {
+	pm.Packages = cores.NewPackages()
+	pm.CustomGlobalProperties = properties.NewMap()
+}
+
 // FindPlatformReleaseProvidingBoardsWithVidPid FIXMEDOC
 func (pm *PackageManager) FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid string) []*cores.PlatformRelease {
 	res := []*cores.PlatformRelease{}

arduino/cores/packagemanager/package_manager.go

@@ -228,7 +228,8 @@ func TestFindToolsRequiredForBoard(t *testing.T) {
 	loadIndex("https://dl.espressif.com/dl/package_esp32_index.json")
 	loadIndex("http://arduino.esp8266.com/stable/package_esp8266com_index.json")
 	loadIndex("https://adafruit.github.io/arduino-board-index/package_adafruit_index.json")
-	require.NoError(t, pm.LoadHardware())
+	errs := pm.LoadHardware()
+	require.Len(t, errs, 0)
 	esp32, err := pm.FindBoardWithFQBN("esp32:esp32:esp32")
 	require.NoError(t, err)
 	esptool231 := pm.FindToolDependency(&cores.ToolDependency{
@@ -319,3 +320,20 @@ func TestIdentifyBoard(t *testing.T) {
 	require.Equal(t, "[test:avr:e]", fmt.Sprintf("%v", identify("0xAB00", "0xcd00")))
 	require.Equal(t, "[test:avr:e]", fmt.Sprintf("%v", identify("0xab00", "0xCD00")))
 }
+
+func TestPackageManagerClear(t *testing.T) {
+	// Create a PackageManager and load the harware
+	packageManager := packagemanager.NewPackageManager(customHardware, customHardware, customHardware, customHardware)
+	packageManager.LoadHardwareFromDirectory(customHardware)
+
+	// Creates another PackageManager but don't load the hardware
+	emptyPackageManager := packagemanager.NewPackageManager(customHardware, customHardware, customHardware, customHardware)
+
+	// Verifies they're not equal
+	require.NotEqual(t, &packageManager, &emptyPackageManager)
+
+	// Clear the first PackageManager that contains loaded hardware
+	packageManager.Clear()
+	// Verifies both PackageManagers are now equal
+	require.Equal(t, &packageManager, &emptyPackageManager)
+}

arduino/cores/packagemanager/package_manager_test.go

@@ -27,6 +27,8 @@ import (
 	"github.com/pmylund/sortutil"
 	"github.com/sirupsen/logrus"
 	semver "go.bug.st/relaxed-semver"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 // LibrariesManager keeps the current status of the libraries in the system
@@ -160,13 +162,14 @@ func (lm *LibrariesManager) AddPlatformReleaseLibrariesDir(plaftormRelease *core
 }
 
 // RescanLibraries reload all installed libraries in the system.
-func (lm *LibrariesManager) RescanLibraries() error {
+func (lm *LibrariesManager) RescanLibraries() []*status.Status {
+	statuses := []*status.Status{}
 	for _, dir := range lm.LibrariesDir {
-		if err := lm.LoadLibrariesFromDir(dir); err != nil {
-			return fmt.Errorf("loading libs from %s: %s", dir.Path, err)
+		if errs := lm.LoadLibrariesFromDir(dir); len(errs) > 0 {
+			statuses = append(statuses, errs...)
 		}
 	}
-	return nil
+	return statuses
 }
 
 func (lm *LibrariesManager) getUserLibrariesDir() *paths.Path {
@@ -180,21 +183,25 @@ func (lm *LibrariesManager) getUserLibrariesDir() *paths.Path {
 
 // LoadLibrariesFromDir loads all libraries in the given directory. Returns
 // nil if the directory doesn't exists.
-func (lm *LibrariesManager) LoadLibrariesFromDir(librariesDir *LibrariesDir) error {
+func (lm *LibrariesManager) LoadLibrariesFromDir(librariesDir *LibrariesDir) []*status.Status {
+	statuses := []*status.Status{}
 	subDirs, err := librariesDir.Path.ReadDir()
 	if os.IsNotExist(err) {
-		return nil
+		return statuses
 	}
 	if err != nil {
-		return fmt.Errorf("reading dir %s: %s", librariesDir.Path, err)
+		s := status.Newf(codes.FailedPrecondition, "reading dir %s: %s", librariesDir.Path, err)
+		return append(statuses, s)
 	}
 	subDirs.FilterDirs()
 	subDirs.FilterOutHiddenFiles()
 
 	for _, subDir := range subDirs {
 		library, err := libraries.Load(subDir, librariesDir.Location)
 		if err != nil {
-			return fmt.Errorf("loading library from %s: %s", subDir, err)
+			s := status.Newf(codes.Internal, "loading library from %s: %s", subDir, err)
+			statuses = append(statuses, s)
+			continue
 		}
 		library.ContainerPlatform = librariesDir.PlatformRelease
 		alternatives, ok := lm.Libraries[library.Name]
@@ -204,7 +211,8 @@ func (lm *LibrariesManager) LoadLibrariesFromDir(librariesDir *LibrariesDir) err
 		}
 		alternatives.Add(library)
 	}
-	return nil
+
+	return statuses
 }
 
 // LoadLibraryFromDir loads one single library from the libRootDir.

arduino/libraries/librariesmanager/librariesmanager.go

@@ -51,11 +51,7 @@ var attachFlags struct {
 }
 
 func runAttachCommand(cmd *cobra.Command, args []string) {
-	instance, err := instance.CreateInstance()
-	if err != nil {
-		feedback.Errorf("Attach board error: %v", err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+	instance := instance.CreateAndInit()
 
 	var path *paths.Path
 	if len(args) > 1 {
@@ -64,7 +60,7 @@ func runAttachCommand(cmd *cobra.Command, args []string) {
 		path = initSketchPath(path)
 	}
 
-	if _, err = board.Attach(context.Background(), &rpc.BoardAttachRequest{
+	if _, err := board.Attach(context.Background(), &rpc.BoardAttachRequest{
 		Instance:      instance,
 		BoardUri:      args[0],
 		SketchPath:    path.String(),

cli/board/attach.go

@@ -55,11 +55,7 @@ func initDetailsCommand() *cobra.Command {
 }
 
 func runDetailsCommand(cmd *cobra.Command, args []string) {
-	inst, err := instance.CreateInstance()
-	if err != nil {
-		feedback.Errorf(tr("Error getting board details: %v"), err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+	inst := instance.CreateAndInit()
 
 	// remove once `board details <fqbn>` is removed
 	if fqbn == "" && len(args) > 0 {

cli/board/details.go

@@ -57,11 +57,7 @@ var listFlags struct {
 // runListCommand detects and lists the connected arduino boards
 func runListCommand(cmd *cobra.Command, args []string) {
 	if listFlags.watch {
-		inst, err := instance.CreateInstance()
-		if err != nil {
-			feedback.Errorf("Error detecting boards: %v", err)
-			os.Exit(errorcodes.ErrGeneric)
-		}
+		inst := instance.CreateAndInit()
 		watchList(cmd, inst)
 		os.Exit(0)
 	}
@@ -73,12 +69,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
 		time.Sleep(timeout)
 	}
 
-	inst, err := instance.CreateInstance()
-	if err != nil {
-		feedback.Errorf("Error detecting boards: %v", err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
-
+	inst := instance.CreateAndInit()
 	ports, err := board.List(inst.GetId())
 	if err != nil {
 		feedback.Errorf("Error detecting boards: %v", err)

cli/board/list.go

@@ -50,11 +50,7 @@ var showHiddenBoard bool
 
 // runListAllCommand list all installed boards
 func runListAllCommand(cmd *cobra.Command, args []string) {
-	inst, err := instance.CreateInstance()
-	if err != nil {
-		feedback.Errorf("Error listing boards: %v", err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+	inst := instance.CreateAndInit()
 
 	list, err := board.ListAll(context.Background(), &rpc.BoardListAllRequest{
 		Instance:            inst,

cli/board/listall.go

@@ -52,11 +52,7 @@ var searchFlags struct {
 }
 
 func runSearchCommand(cmd *cobra.Command, args []string) {
-	inst, err := instance.CreateInstance()
-	if err != nil {
-		feedback.Errorf("Error searching boards: %v", err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+	inst := instance.CreateAndInit()
 
 	res, err := board.Search(context.Background(), &rpc.BoardSearchRequest{
 		Instance:            inst,

cli/board/search.go

@@ -24,19 +24,15 @@ import (
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/upload"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
-	"github.com/arduino/go-paths-helper"
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 var (
-	fqbn           string
-	port           string
-	verbose        bool
-	verify         bool
-	importDir      string
-	programmer     string
-	burnBootloader bool
+	fqbn       string
+	port       string
+	verbose    bool
+	verify     bool
+	programmer string
 )
 
 // NewCommand created a new `burn-bootloader` command
@@ -60,11 +56,7 @@ func NewCommand() *cobra.Command {
 }
 
 func run(command *cobra.Command, args []string) {
-	instance, err := instance.CreateInstance()
-	if err != nil {
-		feedback.Errorf("Error during Upload: %v", err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+	instance := instance.CreateAndInit()
 
 	if _, err := upload.BurnBootloader(context.Background(), &rpc.BurnBootloaderRequest{
 		Instance:   instance,
@@ -79,18 +71,3 @@ func run(command *cobra.Command, args []string) {
 	}
 	os.Exit(0)
 }
-
-// initSketchPath returns the current working directory
-func initSketchPath(sketchPath *paths.Path) *paths.Path {
-	if sketchPath != nil {
-		return sketchPath
-	}
-
-	wd, err := paths.Getwd()
-	if err != nil {
-		feedback.Errorf("Couldn't get current working directory: %v", err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
-	logrus.Infof("Reading sketch from dir: %s", wd)
-	return wd
-}