[breaking] Removed redundant and useless commands from gRPC API (#1891)

* Removed redundant and useless commands from gRPC interface

* Moved some flags in the command creation

This will turn out useful in the following commits

* Made some cli procedures available for other packages

Unfortunately we cannot limit the availability of the cli.core.* package
to the cli.* packages, but they are now available as public API.

* Moved 'lib list' flags into command creation

* Moved 'core list' flags into command creation

* Made 'lib list' procedure public

* Made 'core list' procedure public

* instance.Init no longer return errors array.

They are printed directly inside the function through the feedback
package.

* Ultra-simplified 'outdated' 'update' and 'upgrade'

* Moved 'update' flags in command creation

* Fixed integration tests

* Updated docs

* Fixed integration tests

cli/core/install.go

@@ -31,12 +31,9 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var (
-	postInstallFlags arguments.PostInstallFlags
-	noOverwrite      bool
-)
-
 func initInstallCommand() *cobra.Command {
+	var noOverwrite bool
+	var postInstallFlags arguments.PostInstallFlags
 	installCommand := &cobra.Command{
 		Use:   fmt.Sprintf("install %s:%s[@%s]...", tr("PACKAGER"), tr("ARCH"), tr("VERSION")),
 		Short: tr("Installs one or more cores and corresponding tool dependencies."),
@@ -49,7 +46,9 @@ func initInstallCommand() *cobra.Command {
 		PreRun: func(cmd *cobra.Command, args []string) {
 			arguments.CheckFlagsConflicts(cmd, "run-post-install", "skip-post-install")
 		},
-		Run: runInstallCommand,
+		Run: func(cmd *cobra.Command, args []string) {
+			runInstallCommand(args, postInstallFlags, noOverwrite)
+		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			return arguments.GetInstallableCores(), cobra.ShellCompDirectiveDefault
 		},
@@ -59,7 +58,7 @@ func initInstallCommand() *cobra.Command {
 	return installCommand
 }
 
-func runInstallCommand(cmd *cobra.Command, args []string) {
+func runInstallCommand(args []string, postInstallFlags arguments.PostInstallFlags, noOverwrite bool) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli core install`")
 

cli/core/list.go

@@ -29,29 +29,32 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var (
-	updatableOnly bool
-	all           bool
-)
-
 func initListCommand() *cobra.Command {
+	var updatableOnly bool
+	var all bool
 	listCommand := &cobra.Command{
 		Use:     "list",
 		Short:   tr("Shows the list of installed platforms."),
 		Long:    tr("Shows the list of installed platforms."),
 		Example: "  " + os.Args[0] + " core list",
 		Args:    cobra.NoArgs,
-		Run:     runListCommand,
+		Run: func(cmd *cobra.Command, args []string) {
+			runListCommand(args, all, updatableOnly)
+		},
 	}
 	listCommand.Flags().BoolVar(&updatableOnly, "updatable", false, tr("List updatable platforms."))
 	listCommand.Flags().BoolVar(&all, "all", false, tr("If set return all installable and installed cores, including manually installed."))
 	return listCommand
 }
 
-func runListCommand(cmd *cobra.Command, args []string) {
+func runListCommand(args []string, all bool, updatableOnly bool) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli core list`")
+	List(inst, all, updatableOnly)
+}
 
+// List print a list of installed platforms.
+func List(inst *rpc.Instance, all bool, updatableOnly bool) {
 	platforms, err := core.GetPlatforms(&rpc.PlatformListRequest{
 		Instance:      inst,
 		UpdatableOnly: updatableOnly,

cli/core/search.go

@@ -73,9 +73,7 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
 		}
 	}
 
-	for _, err := range instance.Init(inst) {
-		feedback.Errorf(tr("Error initializing instance: %v"), err)
-	}
+	instance.Init(inst)
 
 	arguments := strings.ToLower(strings.Join(args, " "))
 	logrus.Infof("Executing `arduino-cli core search` with args: '%s'", arguments)

cli/core/update_index.go

@@ -44,7 +44,11 @@ func initUpdateIndexCommand() *cobra.Command {
 func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateInstanceAndRunFirstUpdate()
 	logrus.Info("Executing `arduino-cli core update-index`")
+	UpdateIndex(inst)
+}
 
+// UpdateIndex updates the index of platforms.
+func UpdateIndex(inst *rpc.Instance) {
 	err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexRequest{Instance: inst}, output.ProgressBar())
 	if err != nil {
 		feedback.Error(err)

cli/core/upgrade.go

@@ -34,6 +34,7 @@ import (
 )
 
 func initUpgradeCommand() *cobra.Command {
+	var postInstallFlags arguments.PostInstallFlags
 	upgradeCommand := &cobra.Command{
 		Use:   fmt.Sprintf("upgrade [%s:%s] ...", tr("PACKAGER"), tr("ARCH")),
 		Short: tr("Upgrades one or all installed platforms to the latest version."),
@@ -43,16 +44,22 @@ func initUpgradeCommand() *cobra.Command {
 			"  " + os.Args[0] + " core upgrade\n\n" +
 			"  # " + tr("upgrade arduino:samd to the latest version") + "\n" +
 			"  " + os.Args[0] + " core upgrade arduino:samd",
-		Run: runUpgradeCommand,
+		Run: func(cmd *cobra.Command, args []string) {
+			runUpgradeCommand(args, postInstallFlags.DetectSkipPostInstallValue())
+		},
 	}
 	postInstallFlags.AddToCommand(upgradeCommand)
 	return upgradeCommand
 }
 
-func runUpgradeCommand(cmd *cobra.Command, args []string) {
+func runUpgradeCommand(args []string, skipPostInstall bool) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli core upgrade`")
+	Upgrade(inst, args, skipPostInstall)
+}
 
+// Upgrade upgrades one or all installed platforms to the latest version.
+func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool) {
 	// if no platform was passed, upgrade allthethings
 	if len(args) == 0 {
 		targets, err := core.GetPlatforms(&rpc.PlatformListRequest{
@@ -93,7 +100,7 @@ func runUpgradeCommand(cmd *cobra.Command, args []string) {
 			Instance:        inst,
 			PlatformPackage: platformRef.PackageName,
 			Architecture:    platformRef.Architecture,
-			SkipPostInstall: postInstallFlags.DetectSkipPostInstallValue(),
+			SkipPostInstall: skipPostInstall,
 		}
 
 		if _, err := core.PlatformUpgrade(context.Background(), r, output.ProgressBar(), output.TaskProgress()); err != nil {

cli/instance/instance.go

@@ -17,7 +17,6 @@ package instance
 
 import (
 	"context"
-	"errors"
 	"os"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
@@ -50,10 +49,7 @@ func CreateAndInitWithProfile(profileName string, sketchPath *paths.Path) (*rpc.
 		feedback.Errorf(tr("Error creating instance: %v"), err)
 		os.Exit(errorcodes.ErrGeneric)
 	}
-	profile, errs := InitWithProfile(instance, profileName, sketchPath)
-	for _, err := range errs {
-		feedback.Errorf(tr("Error initializing instance: %v"), err)
-	}
+	profile := InitWithProfile(instance, profileName, sketchPath)
 	return instance, profile
 }
 
@@ -71,20 +67,18 @@ func Create() (*rpc.Instance, error) {
 // platform or library that we failed to load.
 // Package and library indexes files are automatically updated if the
 // CLI is run for the first time.
-func Init(instance *rpc.Instance) []error {
-	_, errs := InitWithProfile(instance, "", nil)
-	return errs
+func Init(instance *rpc.Instance) {
+	InitWithProfile(instance, "", nil)
 }
 
 // InitWithProfile initializes instance by loading libraries and platforms specified in the given profile of the given sketch.
 // In case of loading failures return a list of errors for each platform or library that we failed to load.
 // Required Package and library indexes files are automatically downloaded.
-func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *paths.Path) (*rpc.Profile, []error) {
-	errs := []error{}
-
+func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *paths.Path) *rpc.Profile {
 	// In case the CLI is executed for the first time
 	if err := FirstUpdate(instance); err != nil {
-		return nil, append(errs, err)
+		feedback.Errorf(tr("Error initializing instance: %v"), err)
+		return nil
 	}
 
 	downloadCallback := output.ProgressBar()
@@ -98,7 +92,7 @@ func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *pat
 	var profile *rpc.Profile
 	err := commands.Init(initReq, func(res *rpc.InitResponse) {
 		if st := res.GetError(); st != nil {
-			errs = append(errs, errors.New(st.Message))
+			feedback.Errorf(tr("Error initializing instance: %v"), st.Message)
 		}
 
 		if progress := res.GetInitProgress(); progress != nil {
@@ -115,10 +109,10 @@ func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *pat
 		}
 	})
 	if err != nil {
-		errs = append(errs, err)
+		feedback.Errorf(tr("Error initializing instance: %v"), err)
 	}
 
-	return profile, errs
+	return profile
 }
 
 // FirstUpdate downloads libraries and packages indexes if they don't exist.

cli/lib/list.go

@@ -32,12 +32,9 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var (
-	all       bool
-	updatable bool
-)
-
 func initListCommand() *cobra.Command {
+	var all bool
+	var updatable bool
 	listCommand := &cobra.Command{
 		Use:   fmt.Sprintf("list [%s]", tr("LIBNAME")),
 		Short: tr("Shows a list of installed libraries."),
@@ -48,18 +45,24 @@ library. By default the libraries provided as built-in by platforms/core are
 not listed, they can be listed by adding the --all flag.`),
 		Example: "  " + os.Args[0] + " lib list",
 		Args:    cobra.MaximumNArgs(1),
-		Run:     runListCommand,
+		Run: func(cmd *cobra.Command, args []string) {
+			runListCommand(args, all, updatable)
+		},
 	}
 	listCommand.Flags().BoolVar(&all, "all", false, tr("Include built-in libraries (from platforms and IDE) in listing."))
 	fqbn.AddToCommand(listCommand)
 	listCommand.Flags().BoolVar(&updatable, "updatable", false, tr("List updatable libraries."))
 	return listCommand
 }
 
-func runListCommand(cmd *cobra.Command, args []string) {
+func runListCommand(args []string, all bool, updatable bool) {
 	instance := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli lib list`")
+	List(instance, args, all, updatable)
+}
 
+// List lists all the installed libraries.
+func List(instance *rpc.Instance, args []string, all bool, updatable bool) {
 	name := ""
 	if len(args) > 0 {
 		name = args[0]
@@ -94,13 +97,17 @@ func runListCommand(cmd *cobra.Command, args []string) {
 		libs = []*rpc.InstalledLibrary{}
 	}
 
-	feedback.PrintResult(installedResult{libs})
+	feedback.PrintResult(installedResult{
+		onlyUpdates:   updatable,
+		installedLibs: libs,
+	})
 	logrus.Info("Done")
 }
 
 // output from this command requires special formatting, let's create a dedicated
 // feedback.Result implementation
 type installedResult struct {
+	onlyUpdates   bool
 	installedLibs []*rpc.InstalledLibrary
 }
 
@@ -109,9 +116,9 @@ func (ir installedResult) Data() interface{} {
 }
 
 func (ir installedResult) String() string {
-	if ir.installedLibs == nil || len(ir.installedLibs) == 0 {
-		if updatable {
-			return tr("No updates available.")
+	if len(ir.installedLibs) == 0 {
+		if ir.onlyUpdates {
+			return tr("No libraries update is available.")
 		}
 		return tr("No libraries installed.")
 	}

cli/lib/search.go

@@ -69,9 +69,7 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errorcodes.ErrGeneric)
 	}
 
-	for _, err := range instance.Init(inst) {
-		feedback.Errorf(tr("Error initializing instance: %v"), err)
-	}
+	instance.Init(inst)
 
 	searchResp, err := lib.LibrarySearch(context.Background(), &rpc.LibrarySearchRequest{
 		Instance: inst,

cli/lib/update_index.go

@@ -44,7 +44,11 @@ func initUpdateIndexCommand() *cobra.Command {
 func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateInstanceAndRunFirstUpdate()
 	logrus.Info("Executing `arduino-cli lib update-index`")
+	UpdateIndex(inst)
+}
 
+// UpdateIndex updates the index of libraries.
+func UpdateIndex(inst *rpc.Instance) {
 	err := commands.UpdateLibrariesIndex(context.Background(), &rpc.UpdateLibrariesIndexRequest{
 		Instance: inst,
 	}, output.ProgressBar())

cli/lib/upgrade.go

@@ -46,13 +46,17 @@ func initUpgradeCommand() *cobra.Command {
 func runUpgradeCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli lib upgrade`")
+	Upgrade(instance, args)
+}
 
+// Upgrade upgrades the specified libraries
+func Upgrade(instance *rpc.Instance, libraries []string) {
 	var upgradeErr error
-	if len(args) == 0 {
+	if len(libraries) == 0 {
 		req := &rpc.LibraryUpgradeAllRequest{Instance: instance}
 		upgradeErr = lib.LibraryUpgradeAll(req, output.ProgressBar(), output.TaskProgress())
 	} else {
-		for _, libName := range args {
+		for _, libName := range libraries {
 			req := &rpc.LibraryUpgradeRequest{
 				Instance: instance,
 				Name:     libName,