Update single libraries (#315)

masci · web-flow · commit 36e36cfa41d1 · 2019-08-01T15:08:13.000+02:00
* no need to pass around the whole request object

* always show available versions on list

* refactor libraries API, let upgrade single libraries

* fixed examples

* forgot
diff --git a/cli/instance/instance.go b/cli/instance/instance.go
@@ -45,7 +45,7 @@ func initInstance() *rpc.InitResp {
 	if resp.GetLibrariesIndexError() != "" {
 		commands.UpdateLibrariesIndex(context.Background(),
 			&rpc.UpdateLibrariesIndexReq{Instance: resp.GetInstance()}, output.ProgressBar())
-		rescResp, err := commands.Rescan(context.Background(), &rpc.RescanReq{Instance: resp.GetInstance()})
+		rescResp, err := commands.Rescan(resp.GetInstance().GetId())
 		if rescResp.GetLibrariesIndexError() != "" {
 			formatter.PrintErrorMessage("Error loading library index: " + rescResp.GetLibrariesIndexError())
 			os.Exit(errorcodes.ErrGeneric)
diff --git a/cli/lib/upgrade.go b/cli/lib/upgrade.go
@@ -26,34 +26,41 @@ import (
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/lib"
 	"github.com/arduino/arduino-cli/common/formatter"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
-	"golang.org/x/net/context"
 )
 
 func initUpgradeCommand() *cobra.Command {
 	listCommand := &cobra.Command{
 		Use:   "upgrade",
 		Short: "Upgrades installed libraries.",
-		Long: "This command ungrades all installed libraries to the latest available version." +
-			"To upgrade a single library use the 'install' command.",
-		Example: "  " + os.Args[0] + " lib upgrade",
-		Args:    cobra.NoArgs,
-		Run:     runUpgradeCommand,
+		Long: "This command upgrades an installed library to the latest available version. " +
+			"Multiple libraries can be passed separated by a space. If no arguments are provided, " +
+			"the command will upgrade all the installed libraries where an update is available.",
+		Example: "  " + os.Args[0] + " lib upgrade \n" +
+			"  " + os.Args[0] + " lib upgrade Audio\n" +
+			"  " + os.Args[0] + " lib upgrade Audio ArduinoJson",
+		Args: cobra.ArbitraryArgs,
+		Run:  runUpgradeCommand,
 	}
 	return listCommand
 }
 
 func runUpgradeCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateInstaceIgnorePlatformIndexErrors()
 
-	err := lib.LibraryUpgradeAll(context.Background(), &rpc.LibraryUpgradeAllReq{
-		Instance: instance,
-	}, output.ProgressBar(), output.TaskProgress(), globals.HTTPClientHeader)
-	if err != nil {
-		formatter.PrintError(err, "Error upgrading libraries")
-		os.Exit(errorcodes.ErrGeneric)
+	if len(args) == 0 {
+		err := lib.LibraryUpgradeAll(instance.Id, output.ProgressBar(), output.TaskProgress(), globals.HTTPClientHeader)
+		if err != nil {
+			formatter.PrintError(err, "Error upgrading libraries")
+			os.Exit(errorcodes.ErrGeneric)
+		}
+	} else {
+		err := lib.LibraryUpgrade(instance.Id, args, output.ProgressBar(), output.TaskProgress(), globals.HTTPClientHeader)
+		if err != nil {
+			formatter.PrintError(err, "Error upgrading libraries")
+			os.Exit(errorcodes.ErrGeneric)
+		}
 	}
 
 	logrus.Info("Done")
diff --git a/commands/core/install.go b/commands/core/install.go
@@ -57,7 +57,7 @@ func PlatformInstall(ctx context.Context, req *rpc.PlatformInstallReq,
 		return nil, err
 	}
 
-	_, err = commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance})
+	_, err = commands.Rescan(req.GetInstance().GetId())
 	if err != nil {
 		return nil, err
 	}
diff --git a/commands/core/uninstall.go b/commands/core/uninstall.go
@@ -69,7 +69,7 @@ func PlatformUninstall(ctx context.Context, req *rpc.PlatformUninstallReq, taskC
 		}
 	}
 
-	_, err = commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance})
+	_, err = commands.Rescan(req.GetInstance().GetId())
 	if err != nil {
 		return nil, err
 	}
diff --git a/commands/core/upgrade.go b/commands/core/upgrade.go
@@ -52,7 +52,7 @@ func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeReq,
 		return nil, err
 	}
 
-	if _, err := commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {
+	if _, err := commands.Rescan(req.GetInstance().GetId()); err != nil {
 		return nil, err
 	}
 
diff --git a/commands/daemon/daemon.go b/commands/daemon/daemon.go
@@ -76,7 +76,7 @@ func (s *ArduinoCoreServerImpl) Destroy(ctx context.Context, req *rpc.DestroyReq
 
 // Rescan FIXMEDOC
 func (s *ArduinoCoreServerImpl) Rescan(ctx context.Context, req *rpc.RescanReq) (*rpc.RescanResp, error) {
-	return commands.Rescan(ctx, req)
+	return commands.Rescan(req.GetInstance().GetId())
 }
 
 // UpdateIndex FIXMEDOC
@@ -277,7 +277,7 @@ func (s *ArduinoCoreServerImpl) LibraryUninstall(req *rpc.LibraryUninstallReq, s
 
 // LibraryUpgradeAll FIXMEDOC
 func (s *ArduinoCoreServerImpl) LibraryUpgradeAll(req *rpc.LibraryUpgradeAllReq, stream rpc.ArduinoCore_LibraryUpgradeAllServer) error {
-	err := lib.LibraryUpgradeAll(stream.Context(), req,
+	err := lib.LibraryUpgradeAll(req.GetInstance().GetId(),
 		func(p *rpc.DownloadProgress) { stream.Send(&rpc.LibraryUpgradeAllResp{Progress: p}) },
 		func(p *rpc.TaskProgress) { stream.Send(&rpc.LibraryUpgradeAllResp{TaskProgress: p}) },
 		s.DownloaderHeaders,
diff --git a/commands/instances.go b/commands/instances.go
@@ -75,9 +75,9 @@ func GetPackageManager(req InstanceContainer) *packagemanager.PackageManager {
 	return i.PackageManager
 }
 
-// GetLibraryManager FIXMEDOC
-func GetLibraryManager(req InstanceContainer) *librariesmanager.LibrariesManager {
-	i, ok := instances[req.GetInstance().GetId()]
+// GetLibraryManager returns the library manager for the given instance ID
+func GetLibraryManager(instanceID int32) *librariesmanager.LibrariesManager {
+	i, ok := instances[instanceID]
 	if !ok {
 		return nil
 	}
@@ -231,7 +231,7 @@ func Destroy(ctx context.Context, req *rpc.DestroyReq) (*rpc.DestroyResp, error)
 // UpdateLibrariesIndex updates the library_index.json
 func UpdateLibrariesIndex(ctx context.Context, req *rpc.UpdateLibrariesIndexReq, downloadCB func(*rpc.DownloadProgress)) error {
 	logrus.Info("Updating libraries index")
-	lm := GetLibraryManager(req)
+	lm := GetLibraryManager(req.GetInstance().GetId())
 	if lm == nil {
 		return fmt.Errorf("invalid handle")
 	}
@@ -243,7 +243,7 @@ func UpdateLibrariesIndex(ctx context.Context, req *rpc.UpdateLibrariesIndexReq,
 	if d.Error() != nil {
 		return d.Error()
 	}
-	if _, err := Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {
+	if _, err := Rescan(req.GetInstance().GetId()); err != nil {
 		return fmt.Errorf("rescanning filesystem: %s", err)
 	}
 	return nil
@@ -293,21 +293,20 @@ func UpdateIndex(ctx context.Context, req *rpc.UpdateIndexReq, downloadCB Downlo
 			return nil, fmt.Errorf("saving downloaded index %s: %s", URL, err)
 		}
 	}
-	if _, err := Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {
+	if _, err := Rescan(id); err != nil {
 		return nil, fmt.Errorf("rescanning filesystem: %s", err)
 	}
 	return &rpc.UpdateIndexResp{}, nil
 }
 
-// Rescan FIXMEDOC
-func Rescan(ctx context.Context, req *rpc.RescanReq) (*rpc.RescanResp, error) {
-	id := req.GetInstance().GetId()
-	coreInstance, ok := instances[id]
+// Rescan restart discoveries for the given instance
+func Rescan(instanceID int32) (*rpc.RescanResp, error) {
+	coreInstance, ok := instances[instanceID]
 	if !ok {
 		return nil, fmt.Errorf("invalid handle")
 	}
 
-	pm, lm, reqPltIndex, reqLibIndex, err := createInstance(ctx, coreInstance.config, coreInstance.getLibOnly)
+	pm, lm, reqPltIndex, reqLibIndex, err := createInstance(context.Background(), coreInstance.config, coreInstance.getLibOnly)
 	if err != nil {
 		return nil, fmt.Errorf("rescanning filesystem: %s", err)
 	}
diff --git a/commands/lib/download.go b/commands/lib/download.go
@@ -34,7 +34,7 @@ func LibraryDownload(ctx context.Context, req *rpc.LibraryDownloadReq, downloadC
 	downloaderHeaders http.Header) (*rpc.LibraryDownloadResp, error) {
 	logrus.Info("Executing `arduino lib download`")
 
-	lm := commands.GetLibraryManager(req)
+	lm := commands.GetLibraryManager(req.GetInstance().GetId())
 
 	logrus.Info("Preparing download")
 
diff --git a/commands/lib/install.go b/commands/lib/install.go
@@ -33,7 +33,7 @@ import (
 func LibraryInstall(ctx context.Context, req *rpc.LibraryInstallReq,
 	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB, downloaderHeaders http.Header) error {
 
-	lm := commands.GetLibraryManager(req)
+	lm := commands.GetLibraryManager(req.GetInstance().GetId())
 
 	libRelease, err := findLibraryIndexRelease(lm, req)
 	if err != nil {
@@ -48,7 +48,7 @@ func LibraryInstall(ctx context.Context, req *rpc.LibraryInstallReq,
 		return err
 	}
 
-	if _, err := commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {
+	if _, err := commands.Rescan(req.GetInstance().GetId()); err != nil {
 		return fmt.Errorf("rescanning libraries: %s", err)
 	}
 	return nil
diff --git a/commands/lib/list.go b/commands/lib/list.go
@@ -34,7 +34,7 @@ type installedLib struct {
 
 // LibraryList FIXMEDOC
 func LibraryList(ctx context.Context, req *rpc.LibraryListReq) (*rpc.LibraryListResp, error) {
-	lm := commands.GetLibraryManager(req)
+	lm := commands.GetLibraryManager(req.GetInstance().GetId())
 
 	instaledLib := []*rpc.InstalledLibrary{}
 	res := listLibraries(lm, req.GetUpdatable(), req.GetAll())
@@ -64,12 +64,9 @@ func listLibraries(lm *librariesmanager.LibrariesManager, updatable bool, all bo
 					continue
 				}
 			}
-			var available *librariesindex.Release
-			if updatable {
-				available = lm.Index.FindLibraryUpdate(lib)
-				if available == nil {
-					continue
-				}
+			available := lm.Index.FindLibraryUpdate(lib)
+			if updatable && available == nil {
+				continue
 			}
 			res = append(res, &installedLib{
 				Library:   lib,
diff --git a/commands/lib/search.go b/commands/lib/search.go
@@ -29,7 +29,7 @@ import (
 
 // LibrarySearch FIXMEDOC
 func LibrarySearch(ctx context.Context, req *rpc.LibrarySearchReq) (*rpc.LibrarySearchResp, error) {
-	lm := commands.GetLibraryManager(req)
+	lm := commands.GetLibraryManager(req.GetInstance().GetId())
 	if lm == nil {
 		return nil, errors.New("invalid instance")
 	}
diff --git a/commands/lib/uninstall.go b/commands/lib/uninstall.go
@@ -27,7 +27,7 @@ import (
 
 // LibraryUninstall FIXMEDOC
 func LibraryUninstall(ctx context.Context, req *rpc.LibraryUninstallReq, taskCB commands.TaskProgressCB) error {
-	lm := commands.GetLibraryManager(req)
+	lm := commands.GetLibraryManager(req.GetInstance().GetId())
 	ref, err := createLibIndexReference(lm, req)
 	if err != nil {
 		return err
diff --git a/commands/lib/upgrade.go b/commands/lib/upgrade.go
@@ -18,33 +18,78 @@
 package lib
 
 import (
-	"context"
 	"fmt"
 	"net/http"
 
+	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/commands"
-	rpc "github.com/arduino/arduino-cli/rpc/commands"
 )
 
-// LibraryUpgradeAll FIXMEDOC
-func LibraryUpgradeAll(ctx context.Context, req *rpc.LibraryUpgradeAllReq, downloadCB commands.DownloadProgressCB,
+// LibraryUpgradeAll upgrades all the available libraries
+func LibraryUpgradeAll(instanceID int32, downloadCB commands.DownloadProgressCB,
+	taskCB commands.TaskProgressCB, headers http.Header) error {
+	// get the library manager
+	lm := commands.GetLibraryManager(instanceID)
+
+	if err := upgrade(lm, listLibraries(lm, true, true), downloadCB, taskCB, headers); err != nil {
+		return err
+	}
+
+	if _, err := commands.Rescan(instanceID); err != nil {
+		return fmt.Errorf("rescanning libraries: %s", err)
+	}
+
+	return nil
+}
+
+// LibraryUpgrade upgrades only the given libraries
+func LibraryUpgrade(instanceID int32, libraryNames []string, downloadCB commands.DownloadProgressCB,
+	taskCB commands.TaskProgressCB, headers http.Header) error {
+	// get the library manager
+	lm := commands.GetLibraryManager(instanceID)
+
+	// get the libs to upgrade
+	libs := filterByName(listLibraries(lm, true, true), libraryNames)
+
+	// do it
+	return upgrade(lm, libs, downloadCB, taskCB, headers)
+}
+
+func upgrade(lm *librariesmanager.LibrariesManager, libs []*installedLib, downloadCB commands.DownloadProgressCB,
 	taskCB commands.TaskProgressCB, downloaderHeaders http.Header) error {
-	lm := commands.GetLibraryManager(req)
 
-	// Obtain the list of upgradable libraries
-	list := listLibraries(lm, true, true)
+	// Go through the list and download them
 
-	for _, upgradeDesc := range list {
-		if err := downloadLibrary(lm, upgradeDesc.Available, downloadCB, taskCB, downloaderHeaders); err != nil {
+	for _, lib := range libs {
+		if err := downloadLibrary(lm, lib.Available, downloadCB, taskCB, downloaderHeaders); err != nil {
 			return err
 		}
 	}
-	for _, upgradeDesc := range list {
-		installLibrary(lm, upgradeDesc.Available, taskCB)
-	}
 
-	if _, err := commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {
-		return fmt.Errorf("rescanning libraries: %s", err)
+	// Go through the list and install them
+	for _, lib := range libs {
+		if err := installLibrary(lm, lib.Available, taskCB); err != nil {
+			return err
+		}
 	}
+
 	return nil
 }
+
+func filterByName(libs []*installedLib, names []string) []*installedLib {
+	// put the names in a map to ease lookup
+	queryMap := make(map[string]struct{})
+	for _, name := range names {
+		queryMap[name] = struct{}{}
+	}
+
+	ret := []*installedLib{}
+	for _, lib := range libs {
+		// skip if library name wasn't in the query
+		if _, found := queryMap[lib.Library.Name]; found {
+			ret = append(ret, lib)
+		}
+	}
+
+	return ret
+}

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func PlatformInstall(ctx context.Context, req *rpc.PlatformInstallReq,`
`57`	`57`	`return nil, err`
`58`	`58`	`}`
`59`	`59`
`60`		`- _, err = commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance})`
	`60`	`+ _, err = commands.Rescan(req.GetInstance().GetId())`
`61`	`61`	`if err != nil {`
`62`	`62`	`return nil, err`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ func PlatformUninstall(ctx context.Context, req *rpc.PlatformUninstallReq, taskC`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`
`72`		`- _, err = commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance})`
	`72`	`+ _, err = commands.Rescan(req.GetInstance().GetId())`
`73`	`73`	`if err != nil {`
`74`	`74`	`return nil, err`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeReq,`
`52`	`52`	`return nil, err`
`53`	`53`	`}`
`54`	`54`
`55`		`- if _, err := commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {`
	`55`	`+ if _, err := commands.Rescan(req.GetInstance().GetId()); err != nil {`
`56`	`56`	`return nil, err`
`57`	`57`	`}`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -75,9 +75,9 @@ func GetPackageManager(req InstanceContainer) *packagemanager.PackageManager {`
`75`	`75`	`return i.PackageManager`
`76`	`76`	`}`
`77`	`77`
`78`		`-// GetLibraryManager FIXMEDOC`
`79`		`-func GetLibraryManager(req InstanceContainer) *librariesmanager.LibrariesManager {`
`80`		`- i, ok := instances[req.GetInstance().GetId()]`
	`78`	`+// GetLibraryManager returns the library manager for the given instance ID`
	`79`	`+func GetLibraryManager(instanceID int32) *librariesmanager.LibrariesManager {`
	`80`	`+ i, ok := instances[instanceID]`
`81`	`81`	`if !ok {`
`82`	`82`	`return nil`
`83`	`83`	`}`
`@@ -231,7 +231,7 @@ func Destroy(ctx context.Context, req rpc.DestroyReq) (rpc.DestroyResp, error)`
`231`	`231`	`// UpdateLibrariesIndex updates the library_index.json`
`232`	`232`	`func UpdateLibrariesIndex(ctx context.Context, req rpc.UpdateLibrariesIndexReq, downloadCB func(rpc.DownloadProgress)) error {`
`233`	`233`	`logrus.Info("Updating libraries index")`
`234`		`- lm := GetLibraryManager(req)`
	`234`	`+ lm := GetLibraryManager(req.GetInstance().GetId())`
`235`	`235`	`if lm == nil {`
`236`	`236`	`return fmt.Errorf("invalid handle")`
`237`	`237`	`}`
`@@ -243,7 +243,7 @@ func UpdateLibrariesIndex(ctx context.Context, req *rpc.UpdateLibrariesIndexReq,`
`243`	`243`	`if d.Error() != nil {`
`244`	`244`	`return d.Error()`
`245`	`245`	`}`
`246`		`- if _, err := Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {`
	`246`	`+ if _, err := Rescan(req.GetInstance().GetId()); err != nil {`
`247`	`247`	`return fmt.Errorf("rescanning filesystem: %s", err)`
`248`	`248`	`}`
`249`	`249`	`return nil`
`@@ -293,21 +293,20 @@ func UpdateIndex(ctx context.Context, req *rpc.UpdateIndexReq, downloadCB Downlo`
`293`	`293`	`return nil, fmt.Errorf("saving downloaded index %s: %s", URL, err)`
`294`	`294`	`}`
`295`	`295`	`}`
`296`		`- if _, err := Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {`
	`296`	`+ if _, err := Rescan(id); err != nil {`
`297`	`297`	`return nil, fmt.Errorf("rescanning filesystem: %s", err)`
`298`	`298`	`}`
`299`	`299`	`return &rpc.UpdateIndexResp{}, nil`
`300`	`300`	`}`
`301`	`301`
`302`		`-// Rescan FIXMEDOC`
`303`		`-func Rescan(ctx context.Context, req rpc.RescanReq) (rpc.RescanResp, error) {`
`304`		`- id := req.GetInstance().GetId()`
`305`		`- coreInstance, ok := instances[id]`
	`302`	`+// Rescan restart discoveries for the given instance`
	`303`	`+func Rescan(instanceID int32) (*rpc.RescanResp, error) {`
	`304`	`+ coreInstance, ok := instances[instanceID]`
`306`	`305`	`if !ok {`
`307`	`306`	`return nil, fmt.Errorf("invalid handle")`
`308`	`307`	`}`
`309`	`308`
`310`		`- pm, lm, reqPltIndex, reqLibIndex, err := createInstance(ctx, coreInstance.config, coreInstance.getLibOnly)`
	`309`	`+ pm, lm, reqPltIndex, reqLibIndex, err := createInstance(context.Background(), coreInstance.config, coreInstance.getLibOnly)`
`311`	`310`	`if err != nil {`
`312`	`311`	`return nil, fmt.Errorf("rescanning filesystem: %s", err)`
`313`	`312`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ import (`
`33`	`33`	`func LibraryInstall(ctx context.Context, req *rpc.LibraryInstallReq,`
`34`	`34`	`downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB, downloaderHeaders http.Header) error {`
`35`	`35`
`36`		`- lm := commands.GetLibraryManager(req)`
	`36`	`+ lm := commands.GetLibraryManager(req.GetInstance().GetId())`
`37`	`37`
`38`	`38`	`libRelease, err := findLibraryIndexRelease(lm, req)`
`39`	`39`	`if err != nil {`
`@@ -48,7 +48,7 @@ func LibraryInstall(ctx context.Context, req *rpc.LibraryInstallReq,`
`48`	`48`	`return err`
`49`	`49`	`}`
`50`	`50`
`51`		`- if _, err := commands.Rescan(ctx, &rpc.RescanReq{Instance: req.Instance}); err != nil {`
	`51`	`+ if _, err := commands.Rescan(req.GetInstance().GetId()); err != nil {`
`52`	`52`	`return fmt.Errorf("rescanning libraries: %s", err)`
`53`	`53`	`}`
`54`	`54`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ import (`
`29`	`29`
`30`	`30`	`// LibrarySearch FIXMEDOC`
`31`	`31`	`func LibrarySearch(ctx context.Context, req rpc.LibrarySearchReq) (rpc.LibrarySearchResp, error) {`
`32`		`- lm := commands.GetLibraryManager(req)`
	`32`	`+ lm := commands.GetLibraryManager(req.GetInstance().GetId())`
`33`	`33`	`if lm == nil {`
`34`	`34`	`return nil, errors.New("invalid instance")`
`35`	`35`	`}`