Removed the massive code duplication in the 'upgrade' command

Author: cmaglie

cli/upgrade/upgrade.go

@@ -23,7 +23,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/cli/output"
-	"github.com/arduino/arduino-cli/commands"
+	"github.com/arduino/arduino-cli/commands/upgrade"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/sirupsen/logrus"
@@ -54,7 +54,7 @@ func runUpgradeCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli upgrade`")
 
-	err := commands.Upgrade(context.Background(), &rpc.UpgradeRequest{
+	err := upgrade.Upgrade(context.Background(), &rpc.UpgradeRequest{
 		Instance:        inst,
 		SkipPostInstall: postInstallFlags.DetectSkipPostInstallValue(),
 	}, output.NewDownloadProgressBarCB(), output.TaskProgress())

commands/daemon/daemon.go

@@ -30,6 +30,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/lib"
 	"github.com/arduino/arduino-cli/commands/monitor"
 	"github.com/arduino/arduino-cli/commands/sketch"
+	"github.com/arduino/arduino-cli/commands/upgrade"
 	"github.com/arduino/arduino-cli/commands/upload"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -208,7 +209,7 @@ func (s *ArduinoCoreServerImpl) Outdated(ctx context.Context, req *rpc.OutdatedR
 
 // Upgrade FIXMEDOC
 func (s *ArduinoCoreServerImpl) Upgrade(req *rpc.UpgradeRequest, stream rpc.ArduinoCoreService_UpgradeServer) error {
-	err := commands.Upgrade(stream.Context(), req,
+	err := upgrade.Upgrade(stream.Context(), req,
 		func(p *rpc.DownloadProgress) {
 			stream.Send(&rpc.UpgradeResponse{
 				Progress: p,

commands/instances.go

@@ -17,7 +17,6 @@ package commands
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"net/url"
 	"os"
@@ -28,7 +27,6 @@ import (
 	"github.com/arduino/arduino-cli/arduino/cores/packageindex"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/globals"
-	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
@@ -641,188 +639,6 @@ func getOutputRelease(lib *librariesindex.Release) *rpc.LibraryRelease {
 	return &rpc.LibraryRelease{}
 }
 
-// Upgrade downloads and installs outdated Cores and Libraries
-func Upgrade(ctx context.Context, req *rpc.UpgradeRequest, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) error {
-	downloaderConfig, err := httpclient.GetDownloaderConfig()
-	if err != nil {
-		return err
-	}
-
-	lm := GetLibraryManager(req.Instance.Id)
-	if lm == nil {
-		return &arduino.InvalidInstanceError{}
-	}
-
-	for _, libAlternatives := range lm.Libraries {
-		for _, library := range libAlternatives.Alternatives {
-			if library.Location != libraries.User {
-				continue
-			}
-			available := lm.Index.FindLibraryUpdate(library)
-			if available == nil {
-				continue
-			}
-
-			// Downloads latest library release
-			taskCB(&rpc.TaskProgress{Name: tr("Downloading %s", available)})
-			if err := available.Resource.Download(lm.DownloadsDir, downloaderConfig, available.String(), downloadCB); err != nil {
-				return &arduino.FailedDownloadError{Message: tr("Error downloading library"), Cause: err}
-			}
-
-			// Installs downloaded library
-			taskCB(&rpc.TaskProgress{Name: tr("Installing %s", available)})
-			libPath, libReplaced, err := lm.InstallPrerequisiteCheck(available)
-			if errors.Is(err, librariesmanager.ErrAlreadyInstalled) {
-				taskCB(&rpc.TaskProgress{Message: tr("Already installed %s", available), Completed: true})
-				continue
-			} else if err != nil {
-				return &arduino.FailedLibraryInstallError{Cause: err}
-			}
-
-			if libReplaced != nil {
-				taskCB(&rpc.TaskProgress{Message: tr("Replacing %[1]s with %[2]s", libReplaced, available)})
-			}
-
-			if err := lm.Install(available, libPath); err != nil {
-				return &arduino.FailedLibraryInstallError{Cause: err}
-			}
-
-			taskCB(&rpc.TaskProgress{Message: tr("Installed %s", available), Completed: true})
-		}
-	}
-
-	pm := GetPackageManager(req.Instance.Id)
-	if pm == nil {
-		return &arduino.InvalidInstanceError{}
-	}
-
-	for _, targetPackage := range pm.Packages {
-		for _, installed := range targetPackage.Platforms {
-			if installedRelease := pm.GetInstalledPlatformRelease(installed); installedRelease != nil {
-				latest := installed.GetLatestRelease()
-				if latest == nil || latest == installedRelease {
-					continue
-				}
-
-				ref := &packagemanager.PlatformReference{
-					Package:              installedRelease.Platform.Package.Name,
-					PlatformArchitecture: installedRelease.Platform.Architecture,
-					PlatformVersion:      installedRelease.Version,
-				}
-				// Get list of installed tools needed by the currently installed version
-				_, installedTools, err := pm.FindPlatformReleaseDependencies(ref)
-				if err != nil {
-					return &arduino.NotFoundError{Message: tr("Can't find dependencies for platform %s", ref), Cause: err}
-				}
-
-				ref = &packagemanager.PlatformReference{
-					Package:              latest.Platform.Package.Name,
-					PlatformArchitecture: latest.Platform.Architecture,
-					PlatformVersion:      latest.Version,
-				}
-
-				taskCB(&rpc.TaskProgress{Name: tr("Downloading %s", latest)})
-				_, tools, err := pm.FindPlatformReleaseDependencies(ref)
-				if err != nil {
-					return &arduino.NotFoundError{Message: tr("Can't find dependencies for platform %s", ref), Cause: err}
-				}
-
-				toolsToInstall := []*cores.ToolRelease{}
-				for _, tool := range tools {
-					if tool.IsInstalled() {
-						logrus.WithField("tool", tool).Warn("Tool already installed")
-						taskCB(&rpc.TaskProgress{Name: tr("Tool %s already installed", tool), Completed: true})
-					} else {
-						toolsToInstall = append(toolsToInstall, tool)
-					}
-				}
-
-				// Downloads platform tools
-				for _, tool := range toolsToInstall {
-					if err := pm.DownloadToolRelease(tool, nil, downloadCB); err != nil {
-						taskCB(&rpc.TaskProgress{Message: tr("Error downloading tool %s", tool)})
-						return &arduino.FailedDownloadError{Message: tr("Error downloading tool %s", tool), Cause: err}
-					}
-				}
-
-				// Downloads platform
-				if err := pm.DownloadPlatformRelease(latest, downloaderConfig, downloadCB); err != nil {
-					return &arduino.FailedDownloadError{Message: tr("Error downloading platform %s", latest), Cause: err}
-				}
-
-				logrus.Info("Updating platform " + installed.String())
-				taskCB(&rpc.TaskProgress{Name: tr("Updating platform %s", latest)})
-
-				// Installs tools
-				for _, tool := range toolsToInstall {
-					if err := pm.InstallTool(tool, taskCB); err != nil {
-						msg := tr("Error installing tool %s", tool)
-						taskCB(&rpc.TaskProgress{Message: msg})
-						return &arduino.FailedInstallError{Message: msg, Cause: err}
-					}
-				}
-
-				// Installs platform
-				err = pm.InstallPlatform(latest)
-				if err != nil {
-					logrus.WithError(err).Error("Cannot install platform")
-					msg := tr("Error installing platform %s", latest)
-					taskCB(&rpc.TaskProgress{Message: msg})
-					return &arduino.FailedInstallError{Message: msg, Cause: err}
-				}
-
-				// Uninstall previously installed release
-				err = pm.UninstallPlatform(installedRelease, taskCB)
-
-				// In case uninstall fails tries to rollback
-				if err != nil {
-					logrus.WithError(err).Error("Error updating platform.")
-					taskCB(&rpc.TaskProgress{Message: tr("Error upgrading platform: %s", err)})
-
-					// Rollback
-					if err := pm.UninstallPlatform(latest, taskCB); err != nil {
-						logrus.WithError(err).Error("Error rolling-back changes.")
-						msg := tr("Error rolling-back changes")
-						taskCB(&rpc.TaskProgress{Message: fmt.Sprintf("%s: %s", msg, err)})
-						return &arduino.FailedInstallError{Message: msg, Cause: err}
-					}
-				}
-
-				// Uninstall unused tools
-				for _, toolRelease := range installedTools {
-					if !pm.IsToolRequired(toolRelease) {
-						log := pm.Log.WithField("Tool", toolRelease)
-
-						log.Info("Uninstalling tool")
-						taskCB(&rpc.TaskProgress{Name: tr("Uninstalling %s: tool is no more required", toolRelease)})
-						if err := pm.UninstallTool(toolRelease, taskCB); err != nil {
-							log.WithError(err).Error("Error uninstalling")
-							return &arduino.FailedInstallError{Message: tr("Error uninstalling tool %s", toolRelease), Cause: err}
-						}
-
-						log.Info("Tool uninstalled")
-						taskCB(&rpc.TaskProgress{Message: tr("%s uninstalled", toolRelease), Completed: true})
-					}
-				}
-
-				// Perform post install
-				if !req.SkipPostInstall {
-					logrus.Info("Running post_install script")
-					taskCB(&rpc.TaskProgress{Message: tr("Configuring platform")})
-					if err := pm.RunPostInstallScript(latest); err != nil {
-						taskCB(&rpc.TaskProgress{Message: tr("WARNING: cannot run post install: %s", err)})
-					}
-				} else {
-					logrus.Info("Skipping platform configuration (post_install run).")
-					taskCB(&rpc.TaskProgress{Message: tr("Skipping platform configuration")})
-				}
-			}
-		}
-	}
-
-	return nil
-}
-
 // LoadSketch collects and returns all files composing a sketch
 func LoadSketch(ctx context.Context, req *rpc.LoadSketchRequest) (*rpc.LoadSketchResponse, error) {
 	// TODO: This should be a ToRpc function for the Sketch struct

commands/upgrade/upgrade.go

@@ -0,0 +1,69 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2022 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
+package upgrade
+
+import (
+	"context"
+	"strings"
+
+	"github.com/arduino/arduino-cli/commands/core"
+	"github.com/arduino/arduino-cli/commands/lib"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+)
+
+// Upgrade downloads and installs outdated Cores and Libraries
+func Upgrade(ctx context.Context, req *rpc.UpgradeRequest, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) error {
+	libraryListResponse, err := lib.LibraryList(ctx, &rpc.LibraryListRequest{
+		Instance:  req.GetInstance(),
+		Updatable: true,
+	})
+	if err != nil {
+		return err
+	}
+
+	getPlatformsResp, err := core.GetPlatforms(&rpc.PlatformListRequest{
+		Instance:      req.GetInstance(),
+		UpdatableOnly: true,
+	})
+	if err != nil {
+		return err
+	}
+
+	for _, libToUpgrade := range libraryListResponse.GetInstalledLibraries() {
+		err := lib.LibraryInstall(ctx, &rpc.LibraryInstallRequest{
+			Instance: req.GetInstance(),
+			Name:     libToUpgrade.GetLibrary().GetName(),
+		}, downloadCB, taskCB)
+		if err != nil {
+			return err
+		}
+	}
+
+	for _, platformToUpgrade := range getPlatformsResp {
+		split := strings.Split(platformToUpgrade.GetId(), ":")
+		_, err := core.PlatformUpgrade(ctx, &rpc.PlatformUpgradeRequest{
+			Instance:        req.GetInstance(),
+			PlatformPackage: split[0],
+			Architecture:    split[1],
+			SkipPostInstall: req.GetSkipPostInstall(),
+		}, downloadCB, taskCB)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}