Add overwrite option to zip and git lib install for gRPC interface (#1214)

* Add overwrite option to zip and git lib install for gRPC interface

* Fix extraction tmp dir and install dir deletion on failure

* [skip changelog] Made libraries dir creation more explicit

Author: silvanocerza

arduino/libraries/librariesmanager/install.go

@@ -94,7 +94,7 @@ func (lm *LibrariesManager) Uninstall(lib *libraries.Library) error {
 }
 
 //InstallZipLib  installs a Zip library on the specified path.
-func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath string) error {
+func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath string, overwrite bool) error {
 	libsDir := lm.getUserLibrariesDir()
 	if libsDir == nil {
 		return fmt.Errorf("User directory not set")
@@ -104,6 +104,8 @@ func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath strin
 	if err != nil {
 		return err
 	}
+	// Deletes temp dir used to extract archive when finished
+	defer tmpDir.RemoveAll()
 
 	file, err := os.Open(archivePath)
 	if err != nil {
@@ -126,11 +128,26 @@ func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath strin
 		return fmt.Errorf("archive is not valid: multiple files found in zip file top level")
 	}
 
-	libraryName := paths[0].Base()
+	extractionPath := paths[0]
+	libraryName := extractionPath.Base()
 	installPath := libsDir.Join(libraryName)
 
-	// Deletes libraries folder if already installed
-	if _, ok := lm.Libraries[libraryName]; ok {
+	if err := libsDir.MkdirAll(); err != nil {
+		return err
+	}
+	defer func() {
+		// Clean up install dir if installation failed
+		files, err := installPath.ReadDir()
+		if err == nil && len(files) == 0 {
+			installPath.RemoveAll()
+		}
+	}()
+
+	// Delete library folder if already installed
+	if installPath.IsDir() {
+		if !overwrite {
+			return fmt.Errorf("library %s already installed", libraryName)
+		}
 		logrus.
 			WithField("library name", libraryName).
 			WithField("install path", installPath).
@@ -144,15 +161,16 @@ func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath strin
 		WithField("zip file", archivePath).
 		Trace("Installing library")
 
-	if err := tmpDir.Join(libraryName).CopyDirTo(installPath); err != nil {
-		return fmt.Errorf("copying library: %w", err)
+	// Copy extracted library in the destination directory
+	if err := extractionPath.CopyDirTo(installPath); err != nil {
+		return fmt.Errorf("moving extracted archive to destination dir: %s", err)
 	}
 
 	return nil
 }
 
 //InstallGitLib  installs a library hosted on a git repository on the specified path.
-func (lm *LibrariesManager) InstallGitLib(gitURL string) error {
+func (lm *LibrariesManager) InstallGitLib(gitURL string, overwrite bool) error {
 	libsDir := lm.getUserLibrariesDir()
 	if libsDir == nil {
 		return fmt.Errorf("User directory not set")
@@ -170,6 +188,9 @@ func (lm *LibrariesManager) InstallGitLib(gitURL string) error {
 
 	// Deletes libraries folder if already installed
 	if _, ok := lm.Libraries[libraryName]; ok {
+		if !overwrite {
+			return fmt.Errorf("library %s already installed", libraryName)
+		}
 		logrus.
 			WithField("library name", libraryName).
 			WithField("install path", installPath).

cli/lib/install.go

@@ -76,11 +76,11 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 
 	if installFlags.zipPath {
 		for _, path := range args {
-			ziplibraryInstallReq := &rpc.ZipLibraryInstallReq{
-				Instance: instance,
-				Path:     path,
-			}
-			err := lib.ZipLibraryInstall(context.Background(), ziplibraryInstallReq, output.TaskProgress())
+			err := lib.ZipLibraryInstall(context.Background(), &rpc.ZipLibraryInstallReq{
+				Instance:  instance,
+				Path:      path,
+				Overwrite: true,
+			}, output.TaskProgress())
 			if err != nil {
 				feedback.Errorf("Error installing Zip Library: %v", err)
 				os.Exit(errorcodes.ErrGeneric)
@@ -99,11 +99,11 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 				}
 				url = wd.String()
 			}
-			gitlibraryInstallReq := &rpc.GitLibraryInstallReq{
-				Instance: instance,
-				Url:      url,
-			}
-			err := lib.GitLibraryInstall(context.Background(), gitlibraryInstallReq, output.TaskProgress())
+			err := lib.GitLibraryInstall(context.Background(), &rpc.GitLibraryInstallReq{
+				Instance:  instance,
+				Url:       url,
+				Overwrite: true,
+			}, output.TaskProgress())
 			if err != nil {
 				feedback.Errorf("Error installing Git Library: %v", err)
 				os.Exit(errorcodes.ErrGeneric)

commands/lib/install.go

@@ -111,8 +111,7 @@ func installLibrary(lm *librariesmanager.LibrariesManager, libRelease *libraries
 //ZipLibraryInstall FIXMEDOC
 func ZipLibraryInstall(ctx context.Context, req *rpc.ZipLibraryInstallReq, taskCB commands.TaskProgressCB) error {
 	lm := commands.GetLibraryManager(req.GetInstance().GetId())
-	archivePath := req.GetPath()
-	if err := lm.InstallZipLib(ctx, archivePath); err != nil {
+	if err := lm.InstallZipLib(ctx, req.Path, req.Overwrite); err != nil {
 		return err
 	}
 	taskCB(&rpc.TaskProgress{Message: "Installed Archived Library", Completed: true})
@@ -122,8 +121,7 @@ func ZipLibraryInstall(ctx context.Context, req *rpc.ZipLibraryInstallReq, taskC
 //GitLibraryInstall FIXMEDOC
 func GitLibraryInstall(ctx context.Context, req *rpc.GitLibraryInstallReq, taskCB commands.TaskProgressCB) error {
 	lm := commands.GetLibraryManager(req.GetInstance().GetId())
-	url := req.GetUrl()
-	if err := lm.InstallGitLib(url); err != nil {
+	if err := lm.InstallGitLib(req.Url, req.Overwrite); err != nil {
 		return err
 	}
 	taskCB(&rpc.TaskProgress{Message: "Installed Library from Git URL", Completed: true})

rpc/commands/lib.pb.go

@@ -302,6 +302,8 @@ message ZipLibraryInstallReq {
     Instance instance = 1;
     //Path to the archived library
     string Path = 2;
+    // Set to true to overwrite an already installed library with the same name. Defaults to false.
+    bool overwrite = 3;
 }
 
 message ZipLibraryInstallResp {
@@ -314,6 +316,8 @@ message GitLibraryInstallReq {
     Instance instance = 1;
     // URL to the repository containing the library
     string url = 2;
+    // Set to true to overwrite an already installed library with the same name. Defaults to false.
+    bool overwrite = 3;
 }
 
 message GitLibraryInstallResp {