Use enumeration for LibraryLocation field in grpc API

cmaglie · cmaglie · commit 9b83d17e7b47 · 2020-03-02T17:52:00.000+01:00
The enumeration is also reused inside the arduino package to reduce
duplication.
diff --git a/arduino/libraries/libraries.go b/arduino/libraries/libraries.go
@@ -17,6 +17,7 @@ package libraries
 
 import (
 	"github.com/arduino/arduino-cli/arduino/cores"
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
 	semver "go.bug.st/relaxed-semver"
@@ -58,7 +59,7 @@ type Library struct {
 	InstallDir        *paths.Path
 	SourceDir         *paths.Path
 	UtilityDir        *paths.Path
-	Location          LibraryLocation
+	Location          rpc.LibraryLocation
 	ContainerPlatform *cores.PlatformRelease `json:""`
 	Layout            LibraryLayout
 	RealName          string
diff --git a/arduino/libraries/libraries_location.go b/arduino/libraries/libraries_location.go
diff --git a/arduino/libraries/librariesmanager/install.go b/arduino/libraries/librariesmanager/install.go
@@ -22,6 +22,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/arduino/utils"
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	paths "github.com/arduino/go-paths-helper"
 )
 
@@ -40,7 +41,7 @@ func (lm *LibrariesManager) InstallPrerequisiteCheck(indexLibrary *librariesinde
 	var replaced *libraries.Library
 	if installedLibs, have := lm.Libraries[saneName]; have {
 		for _, installedLib := range installedLibs.Alternatives {
-			if installedLib.Location != libraries.User {
+			if installedLib.Location != rpc.LibraryLocation_user {
 				continue
 			}
 			if installedLib.Version.Equal(indexLibrary.Version) {
diff --git a/arduino/libraries/librariesmanager/librariesmanager.go b/arduino/libraries/librariesmanager/librariesmanager.go
@@ -23,6 +23,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/arduino/utils"
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	paths "github.com/arduino/go-paths-helper"
 	"github.com/pmylund/sortutil"
 	"github.com/sirupsen/logrus"
@@ -43,7 +44,7 @@ type LibrariesManager struct {
 // LibrariesDir is a directory containing libraries
 type LibrariesDir struct {
 	Path            *paths.Path
-	Location        libraries.LibraryLocation
+	Location        rpc.LibraryLocation
 	PlatformRelease *cores.PlatformRelease
 }
 
@@ -122,7 +123,7 @@ func (sc *LibrariesManager) LoadIndex() error {
 // AddLibrariesDir adds path to the list of directories
 // to scan when searching for libraries. If a path is already
 // in the list it is ignored.
-func (sc *LibrariesManager) AddLibrariesDir(path *paths.Path, location libraries.LibraryLocation) {
+func (sc *LibrariesManager) AddLibrariesDir(path *paths.Path, location rpc.LibraryLocation) {
 	for _, dir := range sc.LibrariesDir {
 		if dir.Path.EquivalentTo(path) {
 			return
@@ -138,7 +139,7 @@ func (sc *LibrariesManager) AddLibrariesDir(path *paths.Path, location libraries
 // AddPlatformReleaseLibrariesDir add the libraries directory in the
 // specified PlatformRelease to the list of directories to scan when
 // searching for libraries.
-func (sc *LibrariesManager) AddPlatformReleaseLibrariesDir(plaftormRelease *cores.PlatformRelease, location libraries.LibraryLocation) {
+func (sc *LibrariesManager) AddPlatformReleaseLibrariesDir(plaftormRelease *cores.PlatformRelease, location rpc.LibraryLocation) {
 	path := plaftormRelease.GetLibrariesDir()
 	if path == nil {
 		return
@@ -168,7 +169,7 @@ func (sc *LibrariesManager) RescanLibraries() error {
 
 func (sc *LibrariesManager) getUserLibrariesDir() *paths.Path {
 	for _, dir := range sc.LibrariesDir {
-		if dir.Location == libraries.User {
+		if dir.Location == rpc.LibraryLocation_user {
 			return dir.Path
 		}
 	}
@@ -216,7 +217,7 @@ func (sc *LibrariesManager) FindByReference(libRef *librariesindex.Reference) *l
 	// TODO: Move "search into user" into another method...
 	if libRef.Version == nil {
 		for _, candidate := range alternatives.Alternatives {
-			if candidate.Location == libraries.User {
+			if candidate.Location == rpc.LibraryLocation_user {
 				return candidate
 			}
 		}
diff --git a/arduino/libraries/librariesresolver/cpp.go b/arduino/libraries/librariesresolver/cpp.go
@@ -23,6 +23,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/arduino/utils"
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	"github.com/schollz/closestmatch"
 	"github.com/sirupsen/logrus"
 )
@@ -152,13 +153,13 @@ func computePriority(lib *libraries.Library, header, arch string) int {
 	}
 
 	switch lib.Location {
-	case libraries.IDEBuiltIn:
+	case rpc.LibraryLocation_ide_builtin:
 		priority += 0
-	case libraries.ReferencedPlatformBuiltIn:
+	case rpc.LibraryLocation_referenced_platform_builtin:
 		priority++
-	case libraries.PlatformBuiltIn:
+	case rpc.LibraryLocation_platform_builtin:
 		priority += 2
-	case libraries.User:
+	case rpc.LibraryLocation_user:
 		priority += 3
 	default:
 		panic(fmt.Sprintf("Invalid library location: %d", lib.Location))
diff --git a/arduino/libraries/librariesresolver/cpp_test.go b/arduino/libraries/librariesresolver/cpp_test.go
@@ -19,17 +19,18 @@ import (
 	"testing"
 
 	"github.com/arduino/arduino-cli/arduino/libraries"
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	"github.com/stretchr/testify/require"
 )
 
-var l1 = &libraries.Library{Name: "Calculus Lib", Location: libraries.User}
-var l2 = &libraries.Library{Name: "Calculus Lib-master", Location: libraries.User}
-var l3 = &libraries.Library{Name: "Calculus Lib Improved", Location: libraries.User}
-var l4 = &libraries.Library{Name: "Another Calculus Lib", Location: libraries.User}
-var l5 = &libraries.Library{Name: "Yet Another Calculus Lib Improved", Location: libraries.User}
-var l6 = &libraries.Library{Name: "Calculus Unified Lib", Location: libraries.User}
-var l7 = &libraries.Library{Name: "AnotherLib", Location: libraries.User}
-var bundleServo = &libraries.Library{Name: "Servo", Location: libraries.IDEBuiltIn, Architectures: []string{"avr", "sam", "samd"}}
+var l1 = &libraries.Library{Name: "Calculus Lib", Location: rpc.LibraryLocation_user}
+var l2 = &libraries.Library{Name: "Calculus Lib-master", Location: rpc.LibraryLocation_user}
+var l3 = &libraries.Library{Name: "Calculus Lib Improved", Location: rpc.LibraryLocation_user}
+var l4 = &libraries.Library{Name: "Another Calculus Lib", Location: rpc.LibraryLocation_user}
+var l5 = &libraries.Library{Name: "Yet Another Calculus Lib Improved", Location: rpc.LibraryLocation_user}
+var l6 = &libraries.Library{Name: "Calculus Unified Lib", Location: rpc.LibraryLocation_user}
+var l7 = &libraries.Library{Name: "AnotherLib", Location: rpc.LibraryLocation_user}
+var bundleServo = &libraries.Library{Name: "Servo", Location: rpc.LibraryLocation_ide_builtin, Architectures: []string{"avr", "sam", "samd"}}
 
 func runResolver(include string, arch string, libs ...*libraries.Library) *libraries.Library {
 	libraryList := libraries.List{}
@@ -42,19 +43,19 @@ func runResolver(include string, arch string, libs ...*libraries.Library) *libra
 func TestArchitecturePriority(t *testing.T) {
 	userServo := &libraries.Library{
 		Name:          "Servo",
-		Location:      libraries.User,
+		Location:      rpc.LibraryLocation_user,
 		Architectures: []string{"avr", "sam", "samd"}}
 	userServoAllArch := &libraries.Library{
 		Name:          "Servo",
-		Location:      libraries.User,
+		Location:      rpc.LibraryLocation_user,
 		Architectures: []string{"*"}}
 	userServoNonavr := &libraries.Library{
 		Name:          "Servo",
-		Location:      libraries.User,
+		Location:      rpc.LibraryLocation_user,
 		Architectures: []string{"sam", "samd"}}
 	userAnotherServo := &libraries.Library{
 		Name:          "AnotherServo",
-		Location:      libraries.User,
+		Location:      rpc.LibraryLocation_user,
 		Architectures: []string{"avr", "sam", "samd", "esp32"}}
 
 	res := runResolver("Servo.h", "avr", bundleServo, userServo)
@@ -79,11 +80,11 @@ func TestArchitecturePriority(t *testing.T) {
 
 	userSDAllArch := &libraries.Library{
 		Name:          "SD",
-		Location:      libraries.User,
+		Location:      rpc.LibraryLocation_user,
 		Architectures: []string{"*"}}
 	builtinSDesp := &libraries.Library{
 		Name:          "SD",
-		Location:      libraries.PlatformBuiltIn,
+		Location:      rpc.LibraryLocation_platform_builtin,
 		Architectures: []string{"esp8266"}}
 	res = runResolver("SD.h", "esp8266", userSDAllArch, builtinSDesp)
 	require.Equal(t, builtinSDesp, res, "selected library")
diff --git a/arduino/libraries/loader.go b/arduino/libraries/loader.go
@@ -19,13 +19,14 @@ import (
 	"fmt"
 	"strings"
 
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	"github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
 	semver "go.bug.st/relaxed-semver"
 )
 
 // Load loads a library from the given LibraryLocation
-func Load(libDir *paths.Path, location LibraryLocation) (*Library, error) {
+func Load(libDir *paths.Path, location rpc.LibraryLocation) (*Library, error) {
 	if libDir.Join("library.properties").Exist() {
 		return makeNewLibrary(libDir, location)
 	}
@@ -39,7 +40,7 @@ func addUtilityDirectory(library *Library) {
 	}
 }
 
-func makeNewLibrary(libraryDir *paths.Path, location LibraryLocation) (*Library, error) {
+func makeNewLibrary(libraryDir *paths.Path, location rpc.LibraryLocation) (*Library, error) {
 	libProperties, err := properties.Load(libraryDir.Join("library.properties").String())
 	if err != nil {
 		return nil, fmt.Errorf("loading library.properties: %s", err)
@@ -110,7 +111,7 @@ func makeNewLibrary(libraryDir *paths.Path, location LibraryLocation) (*Library,
 	return library, nil
 }
 
-func makeLegacyLibrary(path *paths.Path, location LibraryLocation) (*Library, error) {
+func makeLegacyLibrary(path *paths.Path, location rpc.LibraryLocation) (*Library, error) {
 	library := &Library{
 		InstallDir:    path,
 		Location:      location,
diff --git a/cli/lib/list.go b/cli/lib/list.go
@@ -102,9 +102,9 @@ func (ir installedResult) String() string {
 			lastName = name
 		}
 
-		location := lib.GetLocation()
+		location := lib.GetLocation().String()
 		if lib.ContainerPlatform != "" {
-			location = lib.GetContainerPlatform()
+			location += " " + lib.GetContainerPlatform()
 		}
 
 		if libMeta.GetRelease() != nil {
diff --git a/commands/instances.go b/commands/instances.go
@@ -27,7 +27,6 @@ import (
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packageindex"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
-	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/configuration"
@@ -323,19 +322,19 @@ func createInstance(ctx context.Context, getLibOnly bool) (*createInstanceResult
 
 	// Add IDE builtin libraries dir
 	if bundledLibsDir := configuration.IDEBundledLibrariesDir(); bundledLibsDir != nil {
-		res.Lm.AddLibrariesDir(bundledLibsDir, libraries.IDEBuiltIn)
+		res.Lm.AddLibrariesDir(bundledLibsDir, rpc.LibraryLocation_ide_builtin)
 	}
 
 	// Add user libraries dir
 	libDir := configuration.LibrariesDir()
-	res.Lm.AddLibrariesDir(libDir, libraries.User)
+	res.Lm.AddLibrariesDir(libDir, rpc.LibraryLocation_user)
 
 	// Add libraries dirs from installed platforms
 	if res.Pm != nil {
 		for _, targetPackage := range res.Pm.Packages {
 			for _, platform := range targetPackage.Platforms {
 				if platformRelease := res.Pm.GetInstalledPlatformRelease(platform); platformRelease != nil {
-					res.Lm.AddPlatformReleaseLibrariesDir(platformRelease, libraries.PlatformBuiltIn)
+					res.Lm.AddPlatformReleaseLibrariesDir(platformRelease, rpc.LibraryLocation_platform_builtin)
 				}
 			}
 		}
diff --git a/commands/lib/list.go b/commands/lib/list.go
@@ -58,7 +58,7 @@ func listLibraries(lm *librariesmanager.LibrariesManager, updatable bool, all bo
 	for _, libAlternatives := range lm.Libraries {
 		for _, lib := range libAlternatives.Alternatives {
 			if !all {
-				if lib.Location != libraries.User {
+				if lib.Location != rpc.LibraryLocation_user {
 					continue
 				}
 			}
@@ -107,7 +107,7 @@ func GetOutputLibrary(lib *libraries.Library) *rpc.Library {
 		InstallDir:        insdir,
 		SourceDir:         srcdir,
 		UtilityDir:        utldir,
-		Location:          lib.Location.String(),
+		Location:          lib.Location,
 		ContainerPlatform: cntplat,
 		Layout:            lib.Layout.String(),
 		RealName:          lib.RealName,
diff --git a/legacy/builder/libraries_loader.go b/legacy/builder/libraries_loader.go
@@ -18,11 +18,11 @@ package builder
 import (
 	"os"
 
-	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesresolver"
 	"github.com/arduino/arduino-cli/legacy/builder/i18n"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
 )
 
 type LibrariesLoader struct{}
@@ -36,7 +36,7 @@ func (s *LibrariesLoader) Run(ctx *types.Context) error {
 		return i18n.WrapError(err)
 	}
 	for _, folder := range builtInLibrariesFolders {
-		lm.AddLibrariesDir(folder, libraries.IDEBuiltIn)
+		lm.AddLibrariesDir(folder, rpc.LibraryLocation_ide_builtin)
 	}
 
 	debugLevel := ctx.DebugLevel
@@ -45,16 +45,16 @@ func (s *LibrariesLoader) Run(ctx *types.Context) error {
 	actualPlatform := ctx.ActualPlatform
 	platform := ctx.TargetPlatform
 	if actualPlatform != platform {
-		lm.AddPlatformReleaseLibrariesDir(actualPlatform, libraries.ReferencedPlatformBuiltIn)
+		lm.AddPlatformReleaseLibrariesDir(actualPlatform, rpc.LibraryLocation_referenced_platform_builtin)
 	}
-	lm.AddPlatformReleaseLibrariesDir(platform, libraries.PlatformBuiltIn)
+	lm.AddPlatformReleaseLibrariesDir(platform, rpc.LibraryLocation_platform_builtin)
 
 	librariesFolders := ctx.OtherLibrariesDirs
 	if err := librariesFolders.ToAbs(); err != nil {
 		return i18n.WrapError(err)
 	}
 	for _, folder := range librariesFolders {
-		lm.AddLibrariesDir(folder, libraries.User)
+		lm.AddLibrariesDir(folder, rpc.LibraryLocation_user)
 	}
 
 	if err := lm.RescanLibraries(); err != nil {
diff --git a/rpc/commands/lib.pb.go b/rpc/commands/lib.pb.go
diff --git a/rpc/commands/lib.proto b/rpc/commands/lib.proto

Original file line number	Diff line number	Diff line change
`@@ -19,13 +19,14 @@ import (`
`19`	`19`	`"fmt"`
`20`	`20`	`"strings"`
`21`	`21`
	`22`	`+ rpc "github.com/arduino/arduino-cli/rpc/commands"`
`22`	`23`	`"github.com/arduino/go-paths-helper"`
`23`	`24`	`properties "github.com/arduino/go-properties-orderedmap"`
`24`	`25`	`semver "go.bug.st/relaxed-semver"`
`25`	`26`	`)`
`26`	`27`
`27`	`28`	`// Load loads a library from the given LibraryLocation`
`28`		`-func Load(libDir paths.Path, location LibraryLocation) (Library, error) {`
	`29`	`+func Load(libDir paths.Path, location rpc.LibraryLocation) (Library, error) {`
`29`	`30`	`if libDir.Join("library.properties").Exist() {`
`30`	`31`	`return makeNewLibrary(libDir, location)`
`31`	`32`	`}`
`@@ -39,7 +40,7 @@ func addUtilityDirectory(library *Library) {`
`39`	`40`	`}`
`40`	`41`	`}`
`41`	`42`
`42`		`-func makeNewLibrary(libraryDir paths.Path, location LibraryLocation) (Library, error) {`
	`43`	`+func makeNewLibrary(libraryDir paths.Path, location rpc.LibraryLocation) (Library, error) {`
`43`	`44`	`libProperties, err := properties.Load(libraryDir.Join("library.properties").String())`
`44`	`45`	`if err != nil {`
`45`	`46`	`return nil, fmt.Errorf("loading library.properties: %s", err)`
`@@ -110,7 +111,7 @@ func makeNewLibrary(libraryDir paths.Path, location LibraryLocation) (Library,`
`110`	`111`	`return library, nil`
`111`	`112`	`}`
`112`	`113`
`113`		`-func makeLegacyLibrary(path paths.Path, location LibraryLocation) (Library, error) {`
	`114`	`+func makeLegacyLibrary(path paths.Path, location rpc.LibraryLocation) (Library, error) {`
`114`	`115`	`library := &Library{`
`115`	`116`	`InstallDir: path,`
`116`	`117`	`Location: location,`
Original file line number	Diff line number	Diff line change
`@@ -102,9 +102,9 @@ func (ir installedResult) String() string {`
`102`	`102`	`lastName = name`
`103`	`103`	`}`
`104`	`104`
`105`		`- location := lib.GetLocation()`
	`105`	`+ location := lib.GetLocation().String()`
`106`	`106`	`if lib.ContainerPlatform != "" {`
`107`		`- location = lib.GetContainerPlatform()`
	`107`	`+ location += " " + lib.GetContainerPlatform()`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`if libMeta.GetRelease() != nil {`