Refactor, resolve is now public

Author: matteosuppo

programmer/programmer.go

@@ -1,6 +1,9 @@
 package programmer
 
 import (
+	"path/filepath"
+	"regexp"
+	"strings"
 	"time"
 
 	"github.com/facchinm/go-serial"
@@ -24,6 +27,11 @@ func info(l logger, args ...interface{}) {
 	}
 }
 
+// tools can return the location of a tool in the system
+type tools interface {
+	GetLocation(command string) (string, error)
+}
+
 // Auth contains username and password used for a network upload
 type Auth struct {
 	Username string `json:"username"`
@@ -41,19 +49,49 @@ type Extra struct {
 	ParamsQuiet       string `json:"params_quiet"`
 }
 
+// Resolve replaces some symbols in the commandline with the appropriate values
+// it can return an error when looking a variable in the tools
+func Resolve(port, board, file, commandline string, extra Extra, tools tools) (string, error) {
+	commandline = strings.Replace(commandline, "{build.path}", filepath.ToSlash(filepath.Dir(file)), -1)
+	commandline = strings.Replace(commandline, "{build.project_name}", strings.TrimSuffix(filepath.Base(file), filepath.Ext(filepath.Base(file))), -1)
+	commandline = strings.Replace(commandline, "{serial.port}", port, -1)
+	commandline = strings.Replace(commandline, "{serial.port.file}", filepath.Base(port), -1)
+
+	if extra.Verbose == true {
+		commandline = strings.Replace(commandline, "{upload.verbose}", extra.ParamsVerbose, -1)
+	} else {
+		commandline = strings.Replace(commandline, "{upload.verbose}", extra.ParamsQuiet, -1)
+	}
+
+	// search for runtime variables and replace with values from globalToolsMap
+	var runtimeRe = regexp.MustCompile("\\{(.*?)\\}")
+	runtimeVars := runtimeRe.FindAllString(commandline, -1)
+
+	for _, element := range runtimeVars {
+
+		location, err := tools.GetLocation(element)
+		if err != nil {
+			return "", errors.Wrapf(err, "get location of %s", element)
+		}
+		commandline = strings.Replace(commandline, element, location, 1)
+	}
+
+	return commandline, nil
+}
+
 // Do performs a command on a port with a board attached to it
-func Do(port, board, file, commandline string, extra Extra, l logger) {
+func Do(port, board, file, commandline string, extra Extra, t tools, l logger) {
 	debug(l, port, board, file, commandline)
 	if extra.Network {
 		doNetwork()
 	} else {
-		doSerial(port, board, file, commandline, extra, l)
+		doSerial(port, board, file, commandline, extra, t, l)
 	}
 }
 
 func doNetwork() {}
 
-func doSerial(port, board, file, commandline string, extra Extra, l logger) error {
+func doSerial(port, board, file, commandline string, extra Extra, t tools, l logger) error {
 	// some boards needs to be resetted
 	if extra.Use1200bpsTouch {
 		var err error
@@ -63,11 +101,6 @@ func doSerial(port, board, file, commandline string, extra Extra, l logger) erro
 		}
 	}
 
-	// resolve commandline
-	info(l, "unresolved commandline ", commandline)
-	commandline = resolve(port, board, file, commandline, extra)
-	info(l, "resolved commandline ", commandline)
-
 	return nil
 }
 

programmer/programmer_test.go

@@ -5,15 +5,12 @@ import (
 
 	"github.com/Sirupsen/logrus"
 	"github.com/arduino/arduino-create-agent/programmer"
-	"github.com/stretchr/testify/suite"
 )
 
-type ProgrammerTestSuite struct {
-	suite.Suite
-}
+type mockTools struct{}
 
-func TestProgrammer(t *testing.T) {
-	suite.Run(t, new(ProgrammerTestSuite))
+func (mockTools) GetLocation(el string) (string, error) {
+	return "$loc" + el, nil
 }
 
 var TestSerialData = []struct {
@@ -28,12 +25,35 @@ var TestSerialData = []struct {
 		`"{runtime.tools.avrdude.path}/bin/avrdude" "-C{runtime.tools.avrdude.path}/etc/avrdude.conf" {upload.verbose} {upload.verify} -patmega32u4 -cavr109 -P{serial.port} -b57600 -D "-Uflash:w:{build.path}/{build.project_name}.hex:i"`, programmer.Extra{Use1200bpsTouch: true, WaitForUploadPort: true}},
 }
 
-func (t *ProgrammerTestSuite) TestSerial() {
+func TestSerial(t *testing.T) {
 	logger := logrus.New()
 	logger.Level = logrus.DebugLevel
 
 	for _, test := range TestSerialData {
-		programmer.Do(test.Port, test.Board, test.File, test.Commandline, test.Extra, logger)
+		programmer.Do(test.Port, test.Board, test.File, test.Commandline, test.Extra, mockTools{}, logger)
+	}
+	t.Fail()
+}
+
+var TestResolveData = []struct {
+	Port        string
+	Board       string
+	File        string
+	Commandline string
+	Extra       programmer.Extra
+	Result      string
+}{
+	{"/dev/ttyACM0", "arduino:avr:leonardo", "./programmer_test.hex",
+		`"{runtime.tools.avrdude.path}/bin/avrdude" "-C{runtime.tools.avrdude.path}/etc/avrdude.conf" {upload.verbose} {upload.verify} -patmega32u4 -cavr109 -P{serial.port} -b57600 -D "-Uflash:w:{build.path}/{build.project_name}.hex:i"`, programmer.Extra{Use1200bpsTouch: true, WaitForUploadPort: true},
+		`"$loc$loc{runtime.tools.avrdude.path}/bin/avrdude" "-C{runtime.tools.avrdude.path}/etc/avrdude.conf"  $loc{upload.verify} -patmega32u4 -cavr109 -P/dev/ttyACM0 -b57600 -D "-Uflash:w:./programmer_test.hex:i"`},
+}
+
+func TestResolve(t *testing.T) {
+	for _, test := range TestResolveData {
+		result, _ := programmer.Resolve(test.Port, test.Board, test.File, test.Commandline, test.Extra, mockTools{})
+		if result != test.Result {
+			t.Error("expected " + test.Result + ", got " + result)
+			continue
+		}
 	}
-	t.Fail("")
 }

programmer/utils.go

@@ -1,10 +1,5 @@
 package programmer
 
-import (
-	"path/filepath"
-	"strings"
-)
-
 // differ returns the first item that differ between the two input slices
 func differ(slice1 []string, slice2 []string) string {
 	m := map[string]int{}
@@ -24,18 +19,3 @@ func differ(slice1 []string, slice2 []string) string {
 
 	return ""
 }
-
-// resolve replaces some symbols in the commandline with the appropriate values
-func resolve(port, board, file, commandline string, extra Extra) string {
-	commandline = strings.Replace(commandline, "{build.path}", filepath.ToSlash(filepath.Dir(file)), -1)
-	commandline = strings.Replace(commandline, "{build.project_name}", strings.TrimSuffix(filepath.Base(file), filepath.Ext(filepath.Base(file))), -1)
-	commandline = strings.Replace(commandline, "{serial.port}", port, -1)
-	commandline = strings.Replace(commandline, "{serial.port.file}", filepath.Base(port), -1)
-
-	if extra.Verbose == true {
-		commandline = strings.Replace(commandline, "{upload.verbose}", extra.ParamsVerbose, -1)
-	} else {
-		commandline = strings.Replace(commandline, "{upload.verbose}", extra.ParamsQuiet, -1)
-	}
-	return commandline
-}

programmer/utils_test.go

@@ -1,9 +1,6 @@
 package programmer
 
-import (
-	"log"
-	"testing"
-)
+import "testing"
 
 var TestDifferData = []struct {
 	Before []string
@@ -24,28 +21,3 @@ func TestDiffer(t *testing.T) {
 		}
 	}
 }
-
-var TestResolveData = []struct {
-	Port        string
-	Board       string
-	File        string
-	Commandline string
-	Extra       Extra
-	Result      string
-}{
-	{"/dev/ttyACM0", "arduino:avr:leonardo", "./programmer_test.hex",
-		`"{runtime.tools.avrdude.path}/bin/avrdude" "-C{runtime.tools.avrdude.path}/etc/avrdude.conf" {upload.verbose} {upload.verify} -patmega32u4 -cavr109 -P{serial.port} -b57600 -D "-Uflash:w:{build.path}/{build.project_name}.hex:i"`, Extra{Use1200bpsTouch: true, WaitForUploadPort: true},
-		`"{runtime.tools.avrdude.path}/bin/avrdude" "-C{runtime.tools.avrdude.path}/etc/avrdude.conf"  {upload.verify} -patmega32u4 -cavr109 -P/dev/ttyACM0 -b57600 -D "-Uflash:w:./programmer_test.hex:i"`},
-}
-
-func TestResolve(t *testing.T) {
-	for _, test := range TestResolveData {
-		result := resolve(test.Port, test.Board, test.File, test.Commandline, test.Extra)
-		if result != test.Result {
-			log.Println(result)
-			log.Println(test.Result)
-			t.Error("expected " + test.Result + ", got " + result)
-			continue
-		}
-	}
-}