Factored function for cloning libraries repositories

Author: cmaglie

commands/service_library_install.go

@@ -267,9 +267,8 @@ func (s *arduinoCoreServerImpl) GitLibraryInstall(req *rpc.GitLibraryInstallRequ
 	lmi, release := lm.NewInstaller()
 	defer release()
 
-	// TODO: pass context
-	// ctx := stream.Context()
-	if err := lmi.InstallGitLib(req.GetUrl(), req.GetOverwrite()); err != nil {
+	ctx := stream.Context()
+	if err := lmi.InstallGitLib(ctx, req.GetUrl(), req.GetOverwrite()); err != nil {
 		return &cmderrors.FailedLibraryInstallError{Cause: err}
 	}
 	taskCB(&rpc.TaskProgress{Message: i18n.Tr("Library installed"), Completed: true})

internal/arduino/libraries/librariesmanager/install.go

@@ -200,54 +200,64 @@ func (lmi *Installer) InstallZipLib(ctx context.Context, archivePath *paths.Path
 }
 
 // InstallGitLib installs a library hosted on a git repository on the specified path.
-func (lmi *Installer) InstallGitLib(argURL string, overwrite bool) error {
-	libraryName, gitURL, ref, err := parseGitArgURL(argURL)
+func (lmi *Installer) InstallGitLib(ctx context.Context, argURL string, overwrite bool) error {
+	tmpInstallPath, err := CloneLibraryGitRepository(ctx, argURL)
 	if err != nil {
 		return err
 	}
+	defer tmpInstallPath.RemoveAll()
+
+	// Install extracted library in the destination directory
+	if err := lmi.importLibraryFromDirectory(tmpInstallPath, overwrite); err != nil {
+		return errors.New(i18n.Tr("moving extracted archive to destination dir: %s", err))
+	}
+
+	return nil
+}
+
+// CloneLibraryGitRepository clones a git repository containing a library
+// into a temporary directory and returns the path to the cloned library.
+func CloneLibraryGitRepository(ctx context.Context, argURL string) (*paths.Path, error) {
+	libraryName, gitURL, ref, err := parseGitArgURL(argURL)
+	if err != nil {
+		return nil, err
+	}
 
 	// Clone library in a temporary directory
 	tmp, err := paths.MkTempDir("", "")
 	if err != nil {
-		return err
+		return nil, err
 	}
-	defer tmp.RemoveAll()
 	tmpInstallPath := tmp.Join(libraryName)
 
-	if _, err := git.PlainClone(tmpInstallPath.String(), false, &git.CloneOptions{
+	if _, err := git.PlainCloneContext(ctx, tmpInstallPath.String(), false, &git.CloneOptions{
 		URL:           gitURL,
 		ReferenceName: plumbing.ReferenceName(ref),
 	}); err != nil {
 		if err.Error() != "reference not found" {
-			return err
+			return nil, err
 		}
 
 		// We did not find the requested reference, let's do a PlainClone and use
 		// "ResolveRevision" to find and checkout the requested revision
-		if repo, err := git.PlainClone(tmpInstallPath.String(), false, &git.CloneOptions{
+		if repo, err := git.PlainCloneContext(ctx, tmpInstallPath.String(), false, &git.CloneOptions{
 			URL: gitURL,
 		}); err != nil {
-			return err
+			return nil, err
 		} else if h, err := repo.ResolveRevision(plumbing.Revision(ref)); err != nil {
-			return err
+			return nil, err
 		} else if w, err := repo.Worktree(); err != nil {
-			return err
+			return nil, err
 		} else if err := w.Checkout(&git.CheckoutOptions{
 			Force: true, // workaround for: https://github.com/go-git/go-git/issues/1411
 			Hash:  plumbing.NewHash(h.String())}); err != nil {
-			return err
+			return nil, err
 		}
 	}
 
 	// We don't want the installed library to be a git repository thus we delete this folder
 	tmpInstallPath.Join(".git").RemoveAll()
-
-	// Install extracted library in the destination directory
-	if err := lmi.importLibraryFromDirectory(tmpInstallPath, overwrite); err != nil {
-		return errors.New(i18n.Tr("moving extracted archive to destination dir: %s", err))
-	}
-
-	return nil
+	return tmpInstallPath, nil
 }
 
 // parseGitArgURL tries to recover a library name from a git URL.