Improved behaviour of 'lib install --no-overwrite' flag

Previously the --no-overwrite flag would fail to install if a library
dependency was already installed but not at the latest version.
After this change the already present library may be accepted as a
dependency if it match the version constraints of the installed library.

Author: cmaglie

arduino/libraries/librariesindex/index.go

@@ -144,11 +144,24 @@ func (idx *Index) FindLibraryUpdate(lib *libraries.Library) *Release {
 	return nil
 }
 
-// ResolveDependencies returns the dependencies of a library release.
-func (idx *Index) ResolveDependencies(lib *Release) []*Release {
-	// Create and populate the library resolver
+// ResolveDependencies resolve the dependencies of a library release and returns a
+// possible solution (the set of library releases to install together with the library).
+// An optional "override" releases may be passed if we want to exclude the same
+// libraries from the index (for example if we want to keep an installed library).
+func (idx *Index) ResolveDependencies(lib *Release, overrides []*Release) []*Release {
 	resolver := semver.NewResolver[*Release, *Dependency]()
-	for _, indexLib := range idx.Libraries {
+
+	overridden := map[string]bool{}
+	for _, override := range overrides {
+		resolver.AddRelease(override)
+		overridden[override.GetName()] = true
+	}
+
+	// Create and populate the library resolver
+	for libName, indexLib := range idx.Libraries {
+		if _, ok := overridden[libName]; ok {
+			continue
+		}
 		for _, indexLibRelease := range indexLib.Releases {
 			resolver.AddRelease(indexLibRelease)
 		}

arduino/libraries/librariesindex/index_test.go

@@ -90,7 +90,7 @@ func TestIndexer(t *testing.T) {
 	rtcInexistent2 := index.FindLibraryUpdate(&libraries.Library{Name: "RTCZero-blah", Version: semver.MustParse("1.0.0")})
 	require.Nil(t, rtcInexistent2)
 
-	resolve1 := index.ResolveDependencies(alp.Releases["1.2.1"])
+	resolve1 := index.ResolveDependencies(alp.Releases["1.2.1"], nil)
 	require.Len(t, resolve1, 2)
 	require.Contains(t, resolve1, alp.Releases["1.2.1"])
 	require.Contains(t, resolve1, rtc.Releases["1.6.0"])
@@ -108,7 +108,7 @@ func TestIndexer(t *testing.T) {
 	require.NotNil(t, http040)
 	require.Equal(t, "[email protected]", http040.String())
 
-	resolve2 := index.ResolveDependencies(oauth010)
+	resolve2 := index.ResolveDependencies(oauth010, nil)
 	require.Len(t, resolve2, 4)
 	require.Contains(t, resolve2, oauth010)
 	require.Contains(t, resolve2, eccx135)

arduino/libraries/librariesmanager/librariesmanager.go

@@ -225,6 +225,20 @@ func (lm *LibrariesManager) FindByReference(libRef *librariesindex.Reference, in
 	return alternatives.FilterByVersionAndInstallLocation(libRef.Version, installLocation)
 }
 
+// FindAllInstalled returns all the installed libraries
+func (lm *LibrariesManager) FindAllInstalled() libraries.List {
+	var res libraries.List
+	for _, libAlternatives := range lm.Libraries {
+		for _, libRelease := range libAlternatives {
+			if libRelease.InstallDir == nil {
+				continue
+			}
+			res.Add(libRelease)
+		}
+	}
+	return res
+}
+
 func (lm *LibrariesManager) clearLibraries() {
 	for k := range lm.Libraries {
 		delete(lm.Libraries, k)

commands/lib/install.go

@@ -47,9 +47,10 @@ func LibraryInstall(ctx context.Context, req *rpc.LibraryInstallRequest, downloa
 		}
 	} else {
 		res, err := LibraryResolveDependencies(ctx, &rpc.LibraryResolveDependenciesRequest{
-			Instance: req.GetInstance(),
-			Name:     req.GetName(),
-			Version:  req.GetVersion(),
+			Instance:                      req.GetInstance(),
+			Name:                          req.GetName(),
+			Version:                       req.GetVersion(),
+			DoNotUpdateInstalledLibraries: req.GetNoOverwrite(),
 		})
 		if err != nil {
 			return err

commands/lib/resolve_deps.go

@@ -22,6 +22,7 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/libraries"
+	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
@@ -46,7 +47,21 @@ func LibraryResolveDependencies(ctx context.Context, req *rpc.LibraryResolveDepe
 	}
 
 	// Resolve all dependencies...
-	deps := lm.Index.ResolveDependencies(reqLibRelease)
+	var overrides []*librariesindex.Release
+	if req.GetDoNotUpdateInstalledLibraries() {
+		libs := lm.FindAllInstalled()
+		libs = libs.FilterByVersionAndInstallLocation(nil, libraries.User)
+		for _, lib := range libs {
+			release := lm.Index.FindRelease(&librariesindex.Reference{
+				Name:    lib.Name,
+				Version: lib.Version,
+			})
+			if release != nil {
+				overrides = append(overrides, release)
+			}
+		}
+	}
+	deps := lm.Index.ResolveDependencies(reqLibRelease, overrides)
 
 	// If no solution has been found
 	if len(deps) == 0 {

internal/cli/lib/check_deps.go

@@ -33,6 +33,7 @@ import (
 )
 
 func initDepsCommand() *cobra.Command {
+	var noOverwrite bool
 	depsCommand := &cobra.Command{
 		Use:   fmt.Sprintf("deps %s[@%s]...", tr("LIBRARY"), tr("VERSION_NUMBER")),
 		Short: tr("Check dependencies status for the specified library."),
@@ -41,15 +42,18 @@ func initDepsCommand() *cobra.Command {
 			"  " + os.Args[0] + " lib deps AudioZero       # " + tr("for the latest version.") + "\n" +
 			"  " + os.Args[0] + " lib deps [email protected] # " + tr("for the specific version."),
 		Args: cobra.ExactArgs(1),
-		Run:  runDepsCommand,
+		Run: func(cmd *cobra.Command, args []string) {
+			runDepsCommand(args, noOverwrite)
+		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			return arguments.GetInstalledLibraries(), cobra.ShellCompDirectiveDefault
 		},
 	}
+	depsCommand.Flags().BoolVar(&noOverwrite, "no-overwrite", false, tr("Do not try to update library dependencies if already installed."))
 	return depsCommand
 }
 
-func runDepsCommand(cmd *cobra.Command, args []string) {
+func runDepsCommand(args []string, noOverwrite bool) {
 	instance := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli lib deps`")
 	libRef, err := ParseLibraryReferenceArgAndAdjustCase(instance, args[0])
@@ -58,9 +62,10 @@ func runDepsCommand(cmd *cobra.Command, args []string) {
 	}
 
 	deps, err := lib.LibraryResolveDependencies(context.Background(), &rpc.LibraryResolveDependenciesRequest{
-		Instance: instance,
-		Name:     libRef.Name,
-		Version:  libRef.Version,
+		Instance:                      instance,
+		Name:                          libRef.Name,
+		Version:                       libRef.Version,
+		DoNotUpdateInstalledLibraries: noOverwrite,
 	})
 	if err != nil {
 		feedback.Fatal(tr("Error resolving dependencies for %[1]s: %[2]s", libRef, err), feedback.ErrGeneric)