Added gRPC support for git-libraries in profiles

Author: cmaglie

commands/service_profile_lib_add.go

@@ -18,6 +18,7 @@ package commands
 import (
 	"cmp"
 	"context"
+	"net/url"
 	"slices"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
@@ -59,6 +60,15 @@ func (s *arduinoCoreServerImpl) ProfileLibAdd(ctx context.Context, req *rpc.Prof
 		addedLib := &sketch.ProfileLibraryReference{InstallDir: path}
 		profile.Libraries = append(profile.Libraries, addedLib)
 		addedLibs = append(addedLibs, addedLib)
+	} else if reqGitLib := req.GetLibrary().GetGitLibrary(); reqGitLib != nil {
+		// Add a git library
+		gitURL, err := url.Parse(reqGitLib.GetUrl())
+		if err != nil {
+			return nil, &cmderrors.InvalidURLError{Cause: err}
+		}
+		addedLib := &sketch.ProfileLibraryReference{GitURL: gitURL}
+		profile.Libraries = append(profile.Libraries, addedLib)
+		addedLibs = append(addedLibs, addedLib)
 	} else if reqIndexLib := req.GetLibrary().GetIndexLibrary(); reqIndexLib != nil {
 		// Obtain the library index from the manager
 		li, err := instances.GetLibrariesIndex(req.GetInstance())

internal/arduino/sketch/profiles.go

@@ -480,6 +480,15 @@ func (l *ProfileLibraryReference) ToRpc() *rpc.ProfileLibraryReference {
 			},
 		}
 	}
+	if l.GitURL != nil {
+		return &rpc.ProfileLibraryReference{
+			Library: &rpc.ProfileLibraryReference_GitLibrary_{
+				GitLibrary: &rpc.ProfileLibraryReference_GitLibrary{
+					Url: l.GitURL.String(),
+				},
+			},
+		}
+	}
 	return &rpc.ProfileLibraryReference{
 		Library: &rpc.ProfileLibraryReference_IndexLibrary_{
 			IndexLibrary: &rpc.ProfileLibraryReference_IndexLibrary{
@@ -500,6 +509,13 @@ func FromRpcProfileLibraryReference(l *rpc.ProfileLibraryReference) (*ProfileLib
 		}
 		return &ProfileLibraryReference{InstallDir: path}, nil
 	}
+	if gitLib := l.GetGitLibrary(); gitLib != nil {
+		gitURL, err := url.Parse(gitLib.GetUrl())
+		if err != nil {
+			return nil, &cmderrors.InvalidURLError{Cause: err}
+		}
+		return &ProfileLibraryReference{GitURL: gitURL}, nil
+	}
 	if indexLib := l.GetIndexLibrary(); indexLib != nil {
 		var version *semver.Version
 		if indexLib.GetVersion() != "" {

internal/cli/feedback/result/rpc.go

@@ -1126,6 +1126,22 @@ func NewIndexUpdateReport_Status(r rpc.IndexUpdateReport_Status) IndexUpdateRepo
 	}
 }
 
+type ProfileLibraryReference_GitLibraryResult struct {
+	Url string `json:"url,omitempty"`
+}
+
+func NewProfileLibraryReference_GitLibraryResult(resp *rpc.ProfileLibraryReference_GitLibrary) *ProfileLibraryReference_GitLibraryResult {
+	return &ProfileLibraryReference_GitLibraryResult{
+		Url: resp.GetUrl(),
+	}
+}
+
+func (*ProfileLibraryReference_GitLibraryResult) isProfileLibraryReference() {}
+
+func (l *ProfileLibraryReference_GitLibraryResult) String() string {
+	return fmt.Sprintf("git: %s", l.Url)
+}
+
 type ProfileLibraryReference_LocalLibraryResult struct {
 	Path string `json:"path,omitempty"`
 }
@@ -1182,6 +1198,12 @@ func NewProfileLibraryReference(resp *rpc.ProfileLibraryReference) *ProfileLibra
 			Kind:    "index",
 		}
 	}
+	if lib := resp.GetGitLibrary(); lib != nil {
+		return &ProfileLibraryReference{
+			Library: NewProfileLibraryReference_GitLibraryResult(lib),
+			Kind:    "git",
+		}
+	}
 	if lib := resp.GetLocalLibrary(); lib != nil {
 		return &ProfileLibraryReference{
 			Library: NewProfileLibraryReference_LocalLibraryResult(lib),

internal/cli/feedback/result/rpc_test.go

@@ -238,6 +238,10 @@ func TestAllFieldAreMapped(t *testing.T) {
 	profileLibraryReference_IndexLibraryResult := result.NewProfileLibraryReference_IndexLibraryResult(profileLibraryReference_IndexLibraryRpc)
 	mustContainsAllPropertyOfRpcStruct(t, profileLibraryReference_IndexLibraryRpc, profileLibraryReference_IndexLibraryResult)
 
+	profileLibraryReference_GitLibraryRpc := &rpc.ProfileLibraryReference_GitLibrary{}
+	profileLibraryReference_GitLibraryResult := result.NewProfileLibraryReference_GitLibraryResult(profileLibraryReference_GitLibraryRpc)
+	mustContainsAllPropertyOfRpcStruct(t, profileLibraryReference_GitLibraryRpc, profileLibraryReference_GitLibraryResult)
+
 	profileLibraryReference_LocalLibraryRpc := &rpc.ProfileLibraryReference_LocalLibrary{}
 	profileLibraryReference_LocalLibraryResult := result.NewProfileLibraryReference_LocalLibraryResult(profileLibraryReference_LocalLibraryRpc)
 	mustContainsAllPropertyOfRpcStruct(t, profileLibraryReference_LocalLibraryRpc, profileLibraryReference_LocalLibraryResult)

rpc/cc/arduino/cli/commands/v1/common.pb.go

@@ -251,10 +251,16 @@ message ProfileLibraryReference {
     // Absolute path to the library.
     string path = 1;
   }
+  message GitLibrary {
+    // URL to the git repo (the revision reference is in the fragment part of the URL).
+    string url = 1;
+  }
   oneof library {
     // The library is installed from the Library Index.
     IndexLibrary index_library = 1;
     // The library is a local library.
     LocalLibrary local_library = 2;
+    // The library is installed from a git repository.
+    GitLibrary git_library = 3;
   }
 }