Added globals.ParseLibraryReferenceArgs method

Author: cmaglie

cli/globals/args.go

@@ -72,3 +72,45 @@ func ParseReferenceArg(arg string, parseArch bool) (*ReferenceArg, error) {
 
 	return ret, nil
 }
+
+// LibraryReferenceArg is a command line argument that reference a library.
+type LibraryReferenceArg struct {
+	Name    string
+	Version string
+}
+
+func (r *LibraryReferenceArg) String() string {
+	if r.Version != "" {
+		return r.Name + "@" + r.Version
+	}
+	return r.Name
+}
+
+// ParseLibraryReferenceArg parse a command line argument that reference a
+// library in the form "LibName@Version" or just "LibName".
+func ParseLibraryReferenceArg(arg string) (*LibraryReferenceArg, error) {
+	tokens := strings.SplitN(arg, "@", 2)
+
+	ret := &LibraryReferenceArg{}
+	// TODO: check library Name constraints
+	// TODO: check library Version constraints
+	ret.Name = tokens[0]
+	if len(tokens) > 1 {
+		ret.Version = tokens[1]
+	}
+	return ret, nil
+}
+
+// ParseLibraryReferenceArgs is a convenient wrapper that operates on a slice of strings and
+// calls ParseLibraryReferenceArg for each of them. It returns at the first invalid argument.
+func ParseLibraryReferenceArgs(args []string) ([]*LibraryReferenceArg, error) {
+	ret := []*LibraryReferenceArg{}
+	for _, arg := range args {
+		if reference, err := ParseLibraryReferenceArg(arg); err == nil {
+			ret = append(ret, reference)
+		} else {
+			return nil, err
+		}
+	}
+	return ret, nil
+}

cli/globals/args_test.go

@@ -22,6 +22,7 @@ import (
 
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 var goodCores = []struct {
@@ -35,11 +36,11 @@ var goodCores = []struct {
 
 var goodLibs = []struct {
 	in       string
-	expected *globals.ReferenceArg
+	expected *globals.LibraryReferenceArg
 }{
-	{"mylib", &globals.ReferenceArg{"mylib", "", ""}},
-	{"mylib@1.0", &globals.ReferenceArg{"mylib", "", "1.0"}},
-	{"mylib@", &globals.ReferenceArg{"mylib", "", ""}},
+	{"mylib", &globals.LibraryReferenceArg{"mylib", ""}},
+	{"mylib@1.0", &globals.LibraryReferenceArg{"mylib", "1.0"}},
+	{"mylib@", &globals.LibraryReferenceArg{"mylib", ""}},
 }
 
 var badCores = []struct {
@@ -51,6 +52,12 @@ var badCores = []struct {
 	{"arduino:avr:avr@1.6.20", nil},
 }
 
+func TestArgsStringify(t *testing.T) {
+	for _, lib := range goodLibs {
+		require.Equal(t, lib.in, lib.expected.String())
+	}
+}
+
 func TestParseReferenceArgCores(t *testing.T) {
 	for _, tt := range goodCores {
 		actual, err := globals.ParseReferenceArg(tt.in, true)
@@ -73,15 +80,22 @@ func TestParseReferenceArgCores(t *testing.T) {
 
 func TestParseReferenceArgLibs(t *testing.T) {
 	for _, tt := range goodLibs {
-		actual, err := globals.ParseReferenceArg(tt.in, false)
+		actual, err := globals.ParseLibraryReferenceArg(tt.in)
 		assert.Nil(t, err)
 		assert.Equal(t, tt.expected, actual)
 	}
+}
 
-	// good libs are bad when requiring Arch to be present
+func TestParseLibraryReferenceArgs(t *testing.T) {
+	args := []string{}
 	for _, tt := range goodLibs {
-		_, err := globals.ParseReferenceArg(tt.in, true)
-		assert.NotNil(t, err)
+		args = append(args, tt.in)
+	}
+	refs, err := globals.ParseLibraryReferenceArgs(args)
+	require.Nil(t, err)
+	require.Len(t, refs, len(goodLibs))
+	for i, tt := range goodLibs {
+		assert.Equal(t, tt.expected, refs[i])
 	}
 }
 

cli/lib/download.go

@@ -47,7 +47,7 @@ func initDownloadCommand() *cobra.Command {
 
 func runDownloadCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateInstaceIgnorePlatformIndexErrors()
-	refs, err := globals.ParseReferenceArgs(args, false)
+	refs, err := globals.ParseLibraryReferenceArgs(args)
 	if err != nil {
 		feedback.Errorf("Invalid argument passed: %v", err)
 		os.Exit(errorcodes.ErrBadArgument)
@@ -56,7 +56,7 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
 	for _, library := range refs {
 		libraryDownloadReq := &rpc.LibraryDownloadReq{
 			Instance: instance,
-			Name:     library.PackageName,
+			Name:     library.Name,
 			Version:  library.Version,
 		}
 		_, err := lib.LibraryDownload(context.Background(), libraryDownloadReq, output.ProgressBar(),

cli/lib/install.go

@@ -47,7 +47,7 @@ func initInstallCommand() *cobra.Command {
 
 func runInstallCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateInstaceIgnorePlatformIndexErrors()
-	refs, err := globals.ParseReferenceArgs(args, false)
+	refs, err := globals.ParseLibraryReferenceArgs(args)
 	if err != nil {
 		feedback.Errorf("Arguments error: %v", err)
 		os.Exit(errorcodes.ErrBadArgument)
@@ -56,7 +56,7 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 	for _, library := range refs {
 		libraryInstallReq := &rpc.LibraryInstallReq{
 			Instance: instance,
-			Name:     library.PackageName,
+			Name:     library.Name,
 			Version:  library.Version,
 		}
 		err := lib.LibraryInstall(context.Background(), libraryInstallReq, output.ProgressBar(),

cli/lib/uninstall.go

@@ -48,7 +48,7 @@ func runUninstallCommand(cmd *cobra.Command, args []string) {
 	logrus.Info("Executing `arduino lib uninstall`")
 
 	instance := instance.CreateInstaceIgnorePlatformIndexErrors()
-	refs, err := globals.ParseReferenceArgs(args, false)
+	refs, err := globals.ParseLibraryReferenceArgs(args)
 	if err != nil {
 		feedback.Errorf("Invalid argument passed: %v", err)
 		os.Exit(errorcodes.ErrBadArgument)
@@ -57,7 +57,7 @@ func runUninstallCommand(cmd *cobra.Command, args []string) {
 	for _, library := range refs {
 		err := lib.LibraryUninstall(context.Background(), &rpc.LibraryUninstallReq{
 			Instance: instance,
-			Name:     library.PackageName,
+			Name:     library.Name,
 			Version:  library.Version,
 		}, output.TaskProgress())
 		if err != nil {