Removed the massive code duplication in the 'outdated' command

Author: cmaglie

cli/outdated/outdated.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
-	"github.com/arduino/arduino-cli/commands"
+	"github.com/arduino/arduino-cli/commands/outdated"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
@@ -50,7 +50,7 @@ func runOutdatedCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli outdated`")
 
-	outdatedResp, err := commands.Outdated(context.Background(), &rpc.OutdatedRequest{
+	outdatedResp, err := outdated.Outdated(context.Background(), &rpc.OutdatedRequest{
 		Instance: inst,
 	})
 	if err != nil {

cli/update/update.go

@@ -24,6 +24,7 @@ import (
 	"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/outdated"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
@@ -70,7 +71,7 @@ func runUpdateCommand(cmd *cobra.Command, args []string) {
 			feedback.Errorf(tr("Error initializing instance: %v"), err)
 		}
 
-		outdatedResp, err := commands.Outdated(context.Background(), &rpc.OutdatedRequest{
+		outdatedResp, err := outdated.Outdated(context.Background(), &rpc.OutdatedRequest{
 			Instance: inst,
 		})
 		if err != nil {

commands/daemon/daemon.go

@@ -29,6 +29,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/core"
 	"github.com/arduino/arduino-cli/commands/lib"
 	"github.com/arduino/arduino-cli/commands/monitor"
+	"github.com/arduino/arduino-cli/commands/outdated"
 	"github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/commands/upgrade"
 	"github.com/arduino/arduino-cli/commands/upload"
@@ -203,7 +204,7 @@ func (s *ArduinoCoreServerImpl) UpdateCoreLibrariesIndex(req *rpc.UpdateCoreLibr
 
 // Outdated FIXMEDOC
 func (s *ArduinoCoreServerImpl) Outdated(ctx context.Context, req *rpc.OutdatedRequest) (*rpc.OutdatedResponse, error) {
-	resp, err := commands.Outdated(ctx, req)
+	resp, err := outdated.Outdated(ctx, req)
 	return resp, convertErrorToRPCStatus(err)
 }
 

commands/instances.go

@@ -521,124 +521,6 @@ func UpdateCoreLibrariesIndex(ctx context.Context, req *rpc.UpdateCoreLibrariesI
 	return nil
 }
 
-// Outdated returns a list struct containing both Core and Libraries that can be updated
-func Outdated(ctx context.Context, req *rpc.OutdatedRequest) (*rpc.OutdatedResponse, error) {
-	id := req.GetInstance().GetId()
-
-	lm := GetLibraryManager(id)
-	if lm == nil {
-		return nil, &arduino.InvalidInstanceError{}
-	}
-
-	outdatedLibraries := []*rpc.InstalledLibrary{}
-	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
-			}
-
-			outdatedLibraries = append(outdatedLibraries, &rpc.InstalledLibrary{
-				Library: getOutputLibrary(library),
-				Release: getOutputRelease(available),
-			})
-		}
-	}
-
-	pm := GetPackageManager(id)
-	if pm == nil {
-		return nil, &arduino.InvalidInstanceError{}
-	}
-
-	outdatedPlatforms := []*rpc.Platform{}
-	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
-				}
-				rpcPlatform := PlatformReleaseToRPC(latest)
-				rpcPlatform.Installed = installedRelease.Version.String()
-
-				outdatedPlatforms = append(
-					outdatedPlatforms,
-					rpcPlatform,
-				)
-			}
-		}
-	}
-
-	return &rpc.OutdatedResponse{
-		OutdatedLibraries: outdatedLibraries,
-		OutdatedPlatforms: outdatedPlatforms,
-	}, nil
-}
-
-func getOutputLibrary(lib *libraries.Library) *rpc.Library {
-	insdir := ""
-	if lib.InstallDir != nil {
-		insdir = lib.InstallDir.String()
-	}
-	srcdir := ""
-	if lib.SourceDir != nil {
-		srcdir = lib.SourceDir.String()
-	}
-	utldir := ""
-	if lib.UtilityDir != nil {
-		utldir = lib.UtilityDir.String()
-	}
-	cntplat := ""
-	if lib.ContainerPlatform != nil {
-		cntplat = lib.ContainerPlatform.String()
-	}
-
-	return &rpc.Library{
-		Name:              lib.Name,
-		Author:            lib.Author,
-		Maintainer:        lib.Maintainer,
-		Sentence:          lib.Sentence,
-		Paragraph:         lib.Paragraph,
-		Website:           lib.Website,
-		Category:          lib.Category,
-		Architectures:     lib.Architectures,
-		Types:             lib.Types,
-		InstallDir:        insdir,
-		SourceDir:         srcdir,
-		UtilityDir:        utldir,
-		Location:          lib.Location.ToRPCLibraryLocation(),
-		ContainerPlatform: cntplat,
-		Layout:            lib.Layout.ToRPCLibraryLayout(),
-		RealName:          lib.RealName,
-		DotALinkage:       lib.DotALinkage,
-		Precompiled:       lib.Precompiled,
-		LdFlags:           lib.LDflags,
-		IsLegacy:          lib.IsLegacy,
-		Version:           lib.Version.String(),
-		License:           lib.License,
-	}
-}
-
-func getOutputRelease(lib *librariesindex.Release) *rpc.LibraryRelease {
-	if lib != nil {
-		return &rpc.LibraryRelease{
-			Author:        lib.Author,
-			Version:       lib.Version.String(),
-			Maintainer:    lib.Maintainer,
-			Sentence:      lib.Sentence,
-			Paragraph:     lib.Paragraph,
-			Website:       lib.Website,
-			Category:      lib.Category,
-			Architectures: lib.Architectures,
-			Types:         lib.Types,
-		}
-	}
-	return &rpc.LibraryRelease{}
-}
-
 // 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/outdated/outdated.go

@@ -0,0 +1,48 @@
+// 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 outdated
+
+import (
+	"context"
+
+	"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"
+)
+
+// Outdated returns a list struct containing both Core and Libraries that can be updated
+func Outdated(ctx context.Context, req *rpc.OutdatedRequest) (*rpc.OutdatedResponse, error) {
+	libraryListResponse, err := lib.LibraryList(ctx, &rpc.LibraryListRequest{
+		Instance:  req.GetInstance(),
+		Updatable: true,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	getPlatformsResp, err := core.GetPlatforms(&rpc.PlatformListRequest{
+		Instance:      req.GetInstance(),
+		UpdatableOnly: true,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return &rpc.OutdatedResponse{
+		OutdatedLibraries: libraryListResponse.GetInstalledLibraries(),
+		OutdatedPlatforms: getPlatformsResp,
+	}, nil
+}

commands/upgrade/upgrade.go

@@ -21,28 +21,18 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/core"
 	"github.com/arduino/arduino-cli/commands/lib"
+	"github.com/arduino/arduino-cli/commands/outdated"
 	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,
-	})
+	outdatedResp, err := outdated.Outdated(ctx, &rpc.OutdatedRequest{Instance: req.GetInstance()})
 	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() {
+	for _, libToUpgrade := range outdatedResp.GetOutdatedLibraries() {
 		err := lib.LibraryInstall(ctx, &rpc.LibraryInstallRequest{
 			Instance: req.GetInstance(),
 			Name:     libToUpgrade.GetLibrary().GetName(),
@@ -52,7 +42,7 @@ func Upgrade(ctx context.Context, req *rpc.UpgradeRequest, downloadCB rpc.Downlo
 		}
 	}
 
-	for _, platformToUpgrade := range getPlatformsResp {
+	for _, platformToUpgrade := range outdatedResp.GetOutdatedPlatforms() {
 		split := strings.Split(platformToUpgrade.GetId(), ":")
 		_, err := core.PlatformUpgrade(ctx, &rpc.PlatformUpgradeRequest{
 			Instance:        req.GetInstance(),