libraries: expose Dependencies field

Author: alessio-perugini

commands/service_library_search.go

@@ -21,6 +21,7 @@ import (
 	"strings"
 
 	"github.com/arduino/arduino-cli/commands/internal/instances"
+	"github.com/arduino/arduino-cli/internal/arduino/libraries"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesindex"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	semver "go.bug.st/relaxed-semver"
@@ -116,7 +117,7 @@ func getLibraryParameters(rel *librariesindex.Release) *rpc.LibraryRelease {
 	}
 }
 
-func getLibraryDependenciesParameter(deps []*librariesindex.Dependency) []*rpc.LibraryDependency {
+func getLibraryDependenciesParameter(deps []*libraries.Dependency) []*rpc.LibraryDependency {
 	res := []*rpc.LibraryDependency{}
 	for _, dep := range deps {
 		res = append(res, &rpc.LibraryDependency{

internal/arduino/libraries/libraries.go

@@ -25,6 +25,7 @@ import (
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
+	"go.bug.st/f"
 	semver "go.bug.st/relaxed-semver"
 )
 
@@ -78,6 +79,7 @@ type Library struct {
 	License                string
 	Properties             *properties.Map
 	Examples               paths.PathList
+	Dependencies           []*Dependency
 	declaredHeaders        []string
 	sourceHeaders          []string
 	CompatibleWith         map[string]bool
@@ -142,6 +144,13 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) {
 		Examples:          library.Examples.AsStrings(),
 		ProvidesIncludes:  headers,
 		CompatibleWith:    library.CompatibleWith,
+		Dependencies: f.Map(library.Dependencies, func(d *Dependency) *rpc.LibraryDependency {
+			dep := &rpc.LibraryDependency{Name: d.GetName()}
+			if d.GetConstraint() != nil {
+				dep.VersionConstraint = d.GetConstraint().String()
+			}
+			return dep
+		}),
 	}, nil
 }
 
@@ -239,3 +248,19 @@ func (library *Library) SourceHeaders() ([]string, error) {
 	}
 	return library.sourceHeaders, nil
 }
+
+// Dependency is a library dependency
+type Dependency struct {
+	Name              string
+	VersionConstraint semver.Constraint
+}
+
+// GetName returns the name of the dependency
+func (r *Dependency) GetName() string {
+	return r.Name
+}
+
+// GetConstraint returns the version Constraint of the dependecy
+func (r *Dependency) GetConstraint() semver.Constraint {
+	return r.VersionConstraint
+}

internal/arduino/libraries/librariesindex/index.go

@@ -45,7 +45,7 @@ type Library struct {
 type Release struct {
 	Author           string
 	Version          *semver.Version
-	Dependencies     []*Dependency
+	Dependencies     []*libraries.Dependency
 	Maintainer       string
 	Sentence         string
 	Paragraph        string
@@ -86,26 +86,10 @@ func (r *Release) GetVersion() *semver.Version {
 }
 
 // GetDependencies returns the dependencies of this library.
-func (r *Release) GetDependencies() []*Dependency {
+func (r *Release) GetDependencies() []*libraries.Dependency {
 	return r.Dependencies
 }
 
-// Dependency is a library dependency
-type Dependency struct {
-	Name              string
-	VersionConstraint semver.Constraint
-}
-
-// GetName returns the name of the dependency
-func (r *Dependency) GetName() string {
-	return r.Name
-}
-
-// GetConstraint returns the version Constraint of the dependecy
-func (r *Dependency) GetConstraint() semver.Constraint {
-	return r.VersionConstraint
-}
-
 func (r *Release) String() string {
 	return r.Library.Name + "@" + r.Version.String()
 }
@@ -155,7 +139,7 @@ func (idx *Index) FindLibraryUpdate(lib *libraries.Library) *Release {
 // An optional "override" releases may be passed if we want to exclude the same
 // libraries from the index (for example if we want to keep an installed library).
 func (idx *Index) ResolveDependencies(lib *Release, overrides []*Release) []*Release {
-	resolver := semver.NewResolver[*Release, *Dependency]()
+	resolver := semver.NewResolver[*Release, *libraries.Dependency]()
 
 	overridden := map[string]bool{}
 	for _, override := range overrides {

internal/arduino/libraries/librariesindex/json.go

@@ -18,6 +18,7 @@ package librariesindex
 import (
 	"errors"
 
+	"github.com/arduino/arduino-cli/internal/arduino/libraries"
 	"github.com/arduino/arduino-cli/internal/arduino/resources"
 	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
@@ -124,8 +125,8 @@ func (indexLib *indexRelease) extractReleaseIn(library *Library) {
 	}
 }
 
-func (indexLib *indexRelease) extractDependencies() []*Dependency {
-	res := []*Dependency{}
+func (indexLib *indexRelease) extractDependencies() []*libraries.Dependency {
+	res := []*libraries.Dependency{}
 	if len(indexLib.Dependencies) == 0 {
 		return res
 	}
@@ -135,13 +136,13 @@ func (indexLib *indexRelease) extractDependencies() []*Dependency {
 	return res
 }
 
-func (indexDep *indexDependency) extractDependency() *Dependency {
+func (indexDep *indexDependency) extractDependency() *libraries.Dependency {
 	var constraint semver.Constraint
 	if c, err := semver.ParseConstraint(indexDep.Version); err == nil {
 		constraint = c
 	}
 	// FIXME: else { report invalid constraint }
-	return &Dependency{
+	return &libraries.Dependency{
 		Name:              indexDep.Name,
 		VersionConstraint: constraint,
 	}

internal/arduino/libraries/loader.go

@@ -130,6 +130,21 @@ func makeNewLibrary(libraryDir *paths.Path, location LibraryLocation) (*Library,
 	library.LDflags = strings.TrimSpace(libProperties.Get("ldflags"))
 	library.Properties = libProperties
 	library.InDevelopment = libraryDir.Join(".development").Exist()
+	if dependencies := libProperties.Get("depends"); dependencies != "" {
+		for dep := range strings.SplitSeq(strings.TrimSpace(libProperties.Get("depends")), ",") {
+			var depConstraint semver.Constraint
+			depName := strings.TrimSpace(dep)
+			idx := strings.LastIndex(dep, " (")
+			if idx != -1 {
+				depName = dep[:idx]
+				depConstraint, _ = semver.ParseConstraint(dep[idx+1:])
+			}
+			library.Dependencies = append(library.Dependencies, &Dependency{
+				Name:              depName,
+				VersionConstraint: depConstraint,
+			})
+		}
+	}
 	return library, nil
 }
 

internal/cli/feedback/result/rpc.go

@@ -234,6 +234,7 @@ type Library struct {
 	ProvidesIncludes  []string                       `json:"provides_includes,omitempty"`
 	CompatibleWith    orderedmap.Map[string, bool]   `json:"compatible_with,omitempty"`
 	InDevelopment     bool                           `json:"in_development,omitempty"`
+	Dependencies      []*LibraryDependency           `json:"dependencies,omitempty"`
 }
 
 func NewLibrary(l *rpc.Library) *Library {
@@ -279,6 +280,7 @@ func NewLibrary(l *rpc.Library) *Library {
 		ProvidesIncludes:  l.GetProvidesIncludes(),
 		CompatibleWith:    libraryCompatibleWithMap,
 		InDevelopment:     l.GetInDevelopment(),
+		Dependencies:      NewLibraryDependencies(l.GetDependencies()),
 	}
 }