Added support for git-libraries in profiles

Author: cmaglie

commands/instances.go

@@ -388,6 +388,40 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 				continue
 			}
 
+			if libraryRef.GitURL != nil {
+				uid := libraryRef.InternalUniqueIdentifier()
+				libRoot := s.settings.ProfilesCacheDir().Join(uid)
+				libDir := libRoot.Join(libraryRef.Library)
+
+				if !libDir.IsDir() {
+					// Clone repo and install
+					tmpDir, err := librariesmanager.CloneLibraryGitRepository(ctx, libraryRef.GitURL.String())
+					if err != nil {
+						taskCallback(&rpc.TaskProgress{Name: i18n.Tr("Error downloading library %s", libraryRef)})
+						e := &cmderrors.FailedLibraryInstallError{Cause: err}
+						responseError(e.GRPCStatus())
+						continue
+					}
+
+					// Install library into profile cache
+					copyErr := tmpDir.CopyDirTo(libDir)
+					_ = tmpDir.RemoveAll()
+					if copyErr != nil {
+						taskCallback(&rpc.TaskProgress{Name: i18n.Tr("Error installing library %s", libraryRef)})
+						e := &cmderrors.FailedLibraryInstallError{Cause: fmt.Errorf("copying library to profile cache: %w", err)}
+						responseError(e.GRPCStatus())
+						continue
+					}
+				}
+
+				lmb.AddLibrariesDir(librariesmanager.LibrariesDir{
+					Path:            libDir,
+					Location:        libraries.Profile,
+					IsSingleLibrary: true,
+				})
+				continue
+			}
+
 			uid := libraryRef.InternalUniqueIdentifier()
 			libRoot := s.settings.ProfilesCacheDir().Join(uid)
 			libDir := libRoot.Join(libraryRef.Library)

internal/arduino/sketch/profiles.go

@@ -21,6 +21,7 @@ import (
 	"errors"
 	"fmt"
 	"net/url"
+	"path/filepath"
 	"regexp"
 	"slices"
 	"strings"
@@ -354,6 +355,7 @@ type ProfileLibraryReference struct {
 	Version      *semver.Version
 	IsDependency bool
 	InstallDir   *paths.Path
+	GitURL       *url.URL
 }
 
 // UnmarshalYAML decodes a ProfileLibraryReference from YAML source.
@@ -375,6 +377,19 @@ func (l *ProfileLibraryReference) UnmarshalYAML(unmarshal func(interface{}) erro
 			}
 			l.IsDependency = true
 			// Fallback
+		} else if gitUrl, ok := dataMap["git"]; ok {
+			if gitUrlStr, ok := gitUrl.(string); !ok {
+				return fmt.Errorf("%s: %s", i18n.Tr("invalid library reference"), dataMap)
+			} else if parsedUrl, err := url.Parse(gitUrlStr); err != nil {
+				return fmt.Errorf("%s: %w", i18n.Tr("invalid git URL"), err)
+			} else {
+				l.GitURL = parsedUrl
+				if l.Library = filepath.Base(parsedUrl.Path); l.Library == "" {
+					l.Library = "lib"
+				}
+				l.Library = strings.TrimSuffix(l.Library, ".git")
+				return nil
+			}
 		} else {
 			return fmt.Errorf("%s: %s", i18n.Tr("invalid library reference"), dataMap)
 		}
@@ -401,6 +416,9 @@ func (l *ProfileLibraryReference) AsYaml() string {
 	if l.InstallDir != nil {
 		return fmt.Sprintf("      - dir: %s\n", l.InstallDir)
 	}
+	if l.GitURL != nil {
+		return fmt.Sprintf("      - git: %s\n", l.GitURL)
+	}
 	dep := ""
 	if l.IsDependency {
 		dep = "dependency: "
@@ -412,6 +430,9 @@ func (l *ProfileLibraryReference) String() string {
 	if l.InstallDir != nil {
 		return "@dir:" + l.InstallDir.String()
 	}
+	if l.GitURL != nil {
+		return "@git:" + l.GitURL.String()
+	}
 	dep := ""
 	if l.IsDependency {
 		dep = " (dep)"
@@ -431,6 +452,14 @@ func (l *ProfileLibraryReference) Match(other *ProfileLibraryReference) bool {
 	if other.InstallDir != nil {
 		return false
 	}
+
+	if l.GitURL != nil {
+		return other.GitURL != nil && l.GitURL.String() == other.GitURL.String()
+	}
+	if other.GitURL != nil {
+		return false
+	}
+
 	if l.Library != other.Library {
 		return false
 	}
@@ -494,6 +523,15 @@ func (l *ProfileLibraryReference) InternalUniqueIdentifier() string {
 	f.Assert(l.InstallDir == nil,
 		"InternalUniqueIdentifier should not be called for library references with an install directory")
 
+	if l.GitURL != nil {
+		id := "git-" + utils.SanitizeName(l.GitURL.Host+l.GitURL.Path+"#"+l.GitURL.Fragment)
+		if len(id) > 50 {
+			id = id[:50]
+		}
+		h := sha256.Sum256([]byte(l.GitURL.String()))
+		return id + "-" + hex.EncodeToString(h[:])[:8]
+	}
+
 	id := l.Library + "@" + l.Version.String()
 	h := sha256.Sum256([]byte(id))
 	res := fmt.Sprintf("%s_%s", id, hex.EncodeToString(h[:])[:16])

internal/arduino/sketch/profiles_test.go

@@ -60,15 +60,19 @@ func TestProjectFileLibraries(t *testing.T) {
 	require.NoError(t, err)
 	require.Len(t, proj.Profiles, 1)
 	prof := proj.Profiles[0]
-	require.Len(t, prof.Libraries, 4)
+	require.Len(t, prof.Libraries, 6)
 	require.Equal(t, "[email protected]", prof.Libraries[0].String())
 	require.Equal(t, "@dir:/path/to/system/lib", prof.Libraries[1].String())
 	require.Equal(t, "@dir:path/to/sketch/lib", prof.Libraries[2].String())
 	require.Equal(t, "[email protected] (dep)", prof.Libraries[3].String())
+	require.Equal(t, "@git:https://github.com/username/HelloWorld.git#v2.13", prof.Libraries[4].String())
+	require.Equal(t, "@git:https://github.com/username/HelloWorld.git#v2.14", prof.Libraries[5].String())
 	require.Equal(t, "FlashStorage_1.2.3_e525d7c96b27788f", prof.Libraries[0].InternalUniqueIdentifier())
 	require.Panics(t, func() { prof.Libraries[1].InternalUniqueIdentifier() })
 	require.Panics(t, func() { prof.Libraries[2].InternalUniqueIdentifier() })
 	require.Equal(t, "DependencyLib_2.3.4_ecde631facb47ae5", prof.Libraries[3].InternalUniqueIdentifier())
+	require.Equal(t, "git-github.com_username_HelloWorld.git_v2.13-0c146203", prof.Libraries[4].InternalUniqueIdentifier())
+	require.Equal(t, "git-github.com_username_HelloWorld.git_v2.14-49f5df7f", prof.Libraries[5].InternalUniqueIdentifier())
 
 	orig, err := sketchProj.ReadFile()
 	require.NoError(t, err)

internal/arduino/sketch/testdata/profiles/profile_with_libraries.yml

@@ -8,5 +8,7 @@ profiles:
       - dir: /path/to/system/lib
       - dir: path/to/sketch/lib
       - dependency: DependencyLib (2.3.4)
+      - git: https://github.com/username/HelloWorld.git#v2.13
+      - git: https://github.com/username/HelloWorld.git#v2.14
 
 default_profile: giga_any