Added checks for multiple library installation

Author: cmaglie

arduino/errors.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/arduino/go-paths-helper"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -810,3 +811,26 @@ func (e *MultiplePlatformsError) Error() string {
 func (e *MultiplePlatformsError) ToRPCStatus() *status.Status {
 	return status.New(codes.InvalidArgument, e.Error())
 }
+
+// MultipleLibraryInstallDetected is returned when the user request an
+// operation on a library but multiple libraries with the same name
+// (in library.properties) are detected.
+type MultipleLibraryInstallDetected struct {
+	LibName string
+	LibsDir paths.PathList
+	Message string
+}
+
+func (e *MultipleLibraryInstallDetected) Error() string {
+	res := tr("The library %s has multiple installations:", e.LibName) + "\n"
+	for _, lib := range e.LibsDir {
+		res += fmt.Sprintf("- %s\n", lib)
+	}
+	res += e.Message
+	return res
+}
+
+// ToRPCStatus converts the error into a *status.Status
+func (e *MultipleLibraryInstallDetected) ToRPCStatus() *status.Status {
+	return status.New(codes.InvalidArgument, e.Error())
+}

arduino/libraries/librariesmanager/install.go

@@ -22,6 +22,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/globals"
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
@@ -49,31 +50,42 @@ var (
 // install path, where the library should be installed and the possible library that is already
 // installed on the same folder and it's going to be replaced by the new one.
 func (lm *LibrariesManager) InstallPrerequisiteCheck(indexLibrary *librariesindex.Release, installLocation libraries.LibraryLocation) (*paths.Path, *libraries.Library, error) {
-	var replaced *libraries.Library
+	installDir := lm.getLibrariesDir(installLocation)
+	if installDir == nil {
+		if installLocation == libraries.User {
+			return nil, nil, fmt.Errorf(tr("User directory not set"))
+		}
+		return nil, nil, fmt.Errorf(tr("Builtin libraries directory not set"))
+	}
+
 	name := indexLibrary.Library.Name
-	if installedLibs, have := lm.Libraries[name]; have {
-		for _, installedLib := range installedLibs {
-			if installedLib.Location != installLocation {
-				continue
-			}
-			if installedLib.Version != nil && installedLib.Version.Equal(indexLibrary.Version) {
-				return installedLib.InstallDir, nil, ErrAlreadyInstalled
-			}
-			replaced = installedLib
+	libs := lm.FindByReference(&librariesindex.Reference{Name: name}, installLocation)
+	for _, lib := range libs {
+		if lib.Version != nil && lib.Version.Equal(indexLibrary.Version) {
+			return lib.InstallDir, nil, ErrAlreadyInstalled
 		}
 	}
 
-	libsDir := lm.getLibrariesDir(installLocation)
-	if libsDir == nil {
-		if installLocation == libraries.User {
-			return nil, nil, fmt.Errorf(tr("User directory not set"))
+	if len(libs) > 1 {
+		libsDir := paths.NewPathList()
+		for _, lib := range libs {
+			libsDir.Add(lib.InstallDir)
+		}
+		return nil, nil, &arduino.MultipleLibraryInstallDetected{
+			LibName: name,
+			LibsDir: libsDir,
+			Message: tr("Automatic library install can't be performed in this case, please manually remove all duplicates and retry."),
 		}
-		return nil, nil, fmt.Errorf(tr("Builtin libraries directory not set"))
 	}
 
-	libPath := libsDir.Join(utils.SanitizeName(indexLibrary.Library.Name))
-	if replaced != nil && replaced.InstallDir.EquivalentTo(libPath) {
+	var replaced *libraries.Library
+	if len(libs) == 1 {
+		replaced = libs[0]
+	}
 
+	libPath := installDir.Join(utils.SanitizeName(indexLibrary.Library.Name))
+	if replaced != nil && replaced.InstallDir.EquivalentTo(libPath) {
+		return libPath, replaced, nil
 	} else if libPath.IsDir() {
 		return nil, nil, fmt.Errorf(tr("destination dir %s already exists, cannot install"), libPath)
 	}

commands/lib/uninstall.go

@@ -22,6 +22,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/arduino/go-paths-helper"
 )
 
 // LibraryUninstall FIXMEDOC
@@ -36,11 +37,23 @@ func LibraryUninstall(ctx context.Context, req *rpc.LibraryUninstallRequest, tas
 
 	if len(libs) == 0 {
 		taskCB(&rpc.TaskProgress{Message: tr("Library %s is not installed", req.Name), Completed: true})
-	} else {
-		taskCB(&rpc.TaskProgress{Name: tr("Uninstalling %s", libs[0])})
+		return nil
+	}
+
+	if len(libs) == 1 {
+		taskCB(&rpc.TaskProgress{Name: tr("Uninstalling %s", libs)})
 		lm.Uninstall(libs[0])
 		taskCB(&rpc.TaskProgress{Completed: true})
+		return nil
 	}
 
-	return nil
+	libsDir := paths.NewPathList()
+	for _, lib := range libs {
+		libsDir.Add(lib.InstallDir)
+	}
+	return &arduino.MultipleLibraryInstallDetected{
+		LibName: libs[0].RealName,
+		LibsDir: libsDir,
+		Message: tr("Automatic library uninstall can't be performed in this case, please manually remove them."),
+	}
 }

internal/integrationtest/lib/lib_test.go

@@ -64,3 +64,32 @@ func TestLibUpgradeCommand(t *testing.T) {
 	require.NoError(t, err)
 	requirejson.Query(t, stdOut, `.[].library | select(.name=="Servo") | .version`, servoVersion)
 }
+
+func TestLibInstallMultipleSameLibrary(t *testing.T) {
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+	cliEnv := cli.GetDefaultEnv()
+	cliEnv["ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL"] = "true"
+
+	// Check that 'lib install' didn't create a double install
+	// https://github.com/arduino/arduino-cli/issues/1870
+	_, _, err := cli.RunWithCustomEnv(cliEnv, "lib", "install", "--git-url", "https://github.com/arduino-libraries/SigFox#1.0.3")
+	require.NoError(t, err)
+	_, _, err = cli.Run("lib", "install", "Arduino SigFox for MKRFox1200")
+	require.NoError(t, err)
+	jsonOut, _, err := cli.Run("lib", "list", "--format", "json")
+	require.NoError(t, err)
+	requirejson.Len(t, jsonOut, 1, "A duplicate library install has been detected")
+
+	// Check that 'lib upgrade' didn't create a double install
+	// https://github.com/arduino/arduino-cli/issues/1870
+	_, _, err = cli.Run("lib", "uninstall", "Arduino SigFox for MKRFox1200")
+	require.NoError(t, err)
+	_, _, err = cli.RunWithCustomEnv(cliEnv, "lib", "install", "--git-url", "https://github.com/arduino-libraries/SigFox#1.0.3")
+	require.NoError(t, err)
+	_, _, err = cli.Run("lib", "upgrade", "Arduino SigFox for MKRFox1200")
+	require.NoError(t, err)
+	jsonOut, _, err = cli.Run("lib", "list", "--format", "json")
+	require.NoError(t, err)
+	requirejson.Len(t, jsonOut, 1, "A duplicate library install has been detected")
+}