move PrepareCommandForRecipe in builder struct

alessio-perugini · alessio-perugini · commit 22a0249d6f43 · 2023-09-26T18:19:41.000+02:00
diff --git a/arduino/builder/archive_compiled_files.go b/arduino/builder/archive_compiled_files.go
@@ -47,7 +47,7 @@ func (b *Builder) archiveCompiledFiles(buildPath *paths.Path, archiveFile *paths
 		properties.SetPath("archive_file_path", archiveFilePath)
 		properties.SetPath("object_file", objectFile)
 
-		command, err := utils.PrepareCommandForRecipe(properties, "recipe.ar.pattern", false)
+		command, err := b.prepareCommandForRecipe(properties, "recipe.ar.pattern", false)
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
diff --git a/arduino/builder/builder.go b/arduino/builder/builder.go
@@ -19,6 +19,9 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"os"
+	"path/filepath"
+	"strings"
 
 	"github.com/arduino/arduino-cli/arduino/builder/internal/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/internal/detector"
@@ -28,6 +31,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/arduino/sketch"
+	"github.com/arduino/arduino-cli/executils"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
@@ -480,3 +484,47 @@ func (b *Builder) build() error {
 	}
 	return nil
 }
+
+func (b *Builder) prepareCommandForRecipe(buildProperties *properties.Map, recipe string, removeUnsetProperties bool) (*executils.Process, error) {
+	pattern := buildProperties.Get(recipe)
+	if pattern == "" {
+		return nil, fmt.Errorf(tr("%[1]s pattern is missing"), recipe)
+	}
+
+	commandLine := buildProperties.ExpandPropsInString(pattern)
+	if removeUnsetProperties {
+		commandLine = properties.DeleteUnexpandedPropsFromString(commandLine)
+	}
+
+	parts, err := properties.SplitQuotedString(commandLine, `"'`, false)
+	if err != nil {
+		return nil, err
+	}
+
+	// if the overall commandline is too long for the platform
+	// try reducing the length by making the filenames relative
+	// and changing working directory to build.path
+	var relativePath string
+	if len(commandLine) > 30000 {
+		relativePath = buildProperties.Get("build.path")
+		for i, arg := range parts {
+			if _, err := os.Stat(arg); os.IsNotExist(err) {
+				continue
+			}
+			rel, err := filepath.Rel(relativePath, arg)
+			if err == nil && !strings.Contains(rel, "..") && len(rel) < len(arg) {
+				parts[i] = rel
+			}
+		}
+	}
+
+	command, err := executils.NewProcess(nil, parts...)
+	if err != nil {
+		return nil, err
+	}
+	if relativePath != "" {
+		command.SetDir(relativePath)
+	}
+
+	return command, nil
+}
diff --git a/arduino/builder/compilation.go b/arduino/builder/compilation.go
@@ -125,7 +125,7 @@ func (b *Builder) compileFileWithRecipe(
 		return nil, errors.WithStack(err)
 	}
 
-	command, err := utils.PrepareCommandForRecipe(properties, recipe, false)
+	command, err := b.prepareCommandForRecipe(properties, recipe, false)
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
diff --git a/arduino/builder/export_cmake.go b/arduino/builder/export_cmake.go
@@ -275,9 +275,9 @@ func (b *Builder) exportProjectCMake(importedLibraries libraries.List, includeFo
 	var dynamicLibsFromGccMinusL []string
 	var linkDirectories []string
 
-	extractCompileFlags(b.buildProperties, "recipe.c.combine.pattern", &defines, &dynamicLibsFromGccMinusL, &linkerflags, &linkDirectories)
-	extractCompileFlags(b.buildProperties, "recipe.c.o.pattern", &defines, &dynamicLibsFromGccMinusL, &linkerflags, &linkDirectories)
-	extractCompileFlags(b.buildProperties, "recipe.cpp.o.pattern", &defines, &dynamicLibsFromGccMinusL, &linkerflags, &linkDirectories)
+	b.extractCompileFlags(b.buildProperties, "recipe.c.combine.pattern", &defines, &dynamicLibsFromGccMinusL, &linkerflags, &linkDirectories)
+	b.extractCompileFlags(b.buildProperties, "recipe.c.o.pattern", &defines, &dynamicLibsFromGccMinusL, &linkerflags, &linkDirectories)
+	b.extractCompileFlags(b.buildProperties, "recipe.cpp.o.pattern", &defines, &dynamicLibsFromGccMinusL, &linkerflags, &linkDirectories)
 
 	// Extract folders with .h in them for adding in include list
 	headerFiles, _ := utils.FindFilesInFolder(cmakeFolder, true, validHeaderExtensions...)
@@ -348,7 +348,7 @@ func (b *Builder) exportProjectCMake(importedLibraries libraries.List, includeFo
 	return nil
 }
 
-func extractCompileFlags(buildProperties *properties.Map, recipe string, defines, dynamicLibs, linkerflags, linkDirectories *[]string) {
+func (b *Builder) extractCompileFlags(buildProperties *properties.Map, recipe string, defines, dynamicLibs, linkerflags, linkDirectories *[]string) {
 	appendIfNotPresent := func(target []string, elements ...string) []string {
 		for _, element := range elements {
 			if !slices.Contains(target, element) {
@@ -358,7 +358,7 @@ func extractCompileFlags(buildProperties *properties.Map, recipe string, defines
 		return target
 	}
 
-	command, _ := utils.PrepareCommandForRecipe(buildProperties, recipe, true)
+	command, _ := b.prepareCommandForRecipe(buildProperties, recipe, true)
 
 	for _, arg := range command.GetArgs() {
 		if strings.HasPrefix(arg, "-D") {
diff --git a/arduino/builder/internal/utils/utils.go b/arduino/builder/internal/utils/utils.go
@@ -19,15 +19,13 @@ import (
 	"bytes"
 	"io"
 	"os"
-	"path/filepath"
 	"strings"
 	"unicode"
 
 	"github.com/arduino/arduino-cli/executils"
 	"github.com/arduino/arduino-cli/i18n"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/go-paths-helper"
-	"github.com/arduino/go-properties-orderedmap"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/text/runes"
@@ -295,48 +293,3 @@ func DirContentIsOlderThan(dir *paths.Path, target *paths.Path, extensions ...st
 	}
 	return true, nil
 }
-
-// PrepareCommandForRecipe fixdoc
-func PrepareCommandForRecipe(buildProperties *properties.Map, recipe string, removeUnsetProperties bool) (*executils.Process, error) {
-	pattern := buildProperties.Get(recipe)
-	if pattern == "" {
-		return nil, errors.Errorf(tr("%[1]s pattern is missing"), recipe)
-	}
-
-	commandLine := buildProperties.ExpandPropsInString(pattern)
-	if removeUnsetProperties {
-		commandLine = properties.DeleteUnexpandedPropsFromString(commandLine)
-	}
-
-	parts, err := properties.SplitQuotedString(commandLine, `"'`, false)
-	if err != nil {
-		return nil, errors.WithStack(err)
-	}
-
-	// if the overall commandline is too long for the platform
-	// try reducing the length by making the filenames relative
-	// and changing working directory to build.path
-	var relativePath string
-	if len(commandLine) > 30000 {
-		relativePath = buildProperties.Get("build.path")
-		for i, arg := range parts {
-			if _, err := os.Stat(arg); os.IsNotExist(err) {
-				continue
-			}
-			rel, err := filepath.Rel(relativePath, arg)
-			if err == nil && !strings.Contains(rel, "..") && len(rel) < len(arg) {
-				parts[i] = rel
-			}
-		}
-	}
-
-	command, err := executils.NewProcess(nil, parts...)
-	if err != nil {
-		return nil, errors.WithStack(err)
-	}
-	if relativePath != "" {
-		command.SetDir(relativePath)
-	}
-
-	return command, nil
-}
diff --git a/arduino/builder/libraries.go b/arduino/builder/libraries.go
@@ -21,7 +21,6 @@ import (
 	"time"
 
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
-	"github.com/arduino/arduino-cli/arduino/builder/internal/utils"
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/go-paths-helper"
@@ -68,7 +67,7 @@ func (b *Builder) findExpectedPrecompiledLibFolder(
 	// Add fpu specifications if they exist
 	// To do so, resolve recipe.cpp.o.pattern,
 	// search for -mfpu=xxx -mfloat-abi=yyy and add to a subfolder
-	command, _ := utils.PrepareCommandForRecipe(buildProperties, "recipe.cpp.o.pattern", true)
+	command, _ := b.prepareCommandForRecipe(buildProperties, "recipe.cpp.o.pattern", true)
 	fpuSpecs := ""
 	for _, el := range command.GetArgs() {
 		if strings.Contains(el, FpuCflag) {
diff --git a/arduino/builder/linker.go b/arduino/builder/linker.go
@@ -72,7 +72,7 @@ func (b *Builder) link() error {
 			properties.SetPath("archive_file_path", archive)
 			properties.SetPath("object_file", object)
 
-			command, err := utils.PrepareCommandForRecipe(properties, "recipe.ar.pattern", false)
+			command, err := b.prepareCommandForRecipe(properties, "recipe.ar.pattern", false)
 			if err != nil {
 				return errors.WithStack(err)
 			}
@@ -96,7 +96,7 @@ func (b *Builder) link() error {
 	properties.Set("archive_file_path", b.buildArtifacts.coreArchiveFilePath.String())
 	properties.Set("object_files", objectFileList)
 
-	command, err := utils.PrepareCommandForRecipe(properties, "recipe.c.combine.pattern", false)
+	command, err := b.prepareCommandForRecipe(properties, "recipe.c.combine.pattern", false)
 	if err != nil {
 		return err
 	}
diff --git a/arduino/builder/recipe.go b/arduino/builder/recipe.go
@@ -39,7 +39,7 @@ func (b *Builder) RunRecipe(prefix, suffix string, skipIfOnlyUpdatingCompilation
 	for _, recipe := range recipes {
 		logrus.Debugf(fmt.Sprintf("Running recipe: %s", recipe))
 
-		command, err := utils.PrepareCommandForRecipe(properties, recipe, false)
+		command, err := b.prepareCommandForRecipe(properties, recipe, false)
 		if err != nil {
 			return errors.WithStack(err)
 		}
diff --git a/arduino/builder/sizer.go b/arduino/builder/sizer.go
@@ -72,7 +72,7 @@ func (b *Builder) size() error {
 }
 
 func (b *Builder) checkSizeAdvanced() (ExecutablesFileSections, error) {
-	command, err := utils.PrepareCommandForRecipe(b.buildProperties, "recipe.advanced_size.pattern", false)
+	command, err := b.prepareCommandForRecipe(b.buildProperties, "recipe.advanced_size.pattern", false)
 	if err != nil {
 		return nil, errors.New(tr("Error while determining sketch size: %s", err))
 	}
@@ -204,7 +204,7 @@ func (b *Builder) checkSize() (ExecutablesFileSections, error) {
 }
 
 func (b *Builder) execSizeRecipe(properties *properties.Map) (textSize int, dataSize int, eepromSize int, resErr error) {
-	command, err := utils.PrepareCommandForRecipe(properties, "recipe.size.pattern", false)
+	command, err := b.prepareCommandForRecipe(properties, "recipe.size.pattern", false)
 	if err != nil {
 		resErr = fmt.Errorf(tr("Error while determining sketch size: %s"), err)
 		return

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func (b Builder) archiveCompiledFiles(buildPath paths.Path, archiveFile *paths`
`47`	`47`	`properties.SetPath("archive_file_path", archiveFilePath)`
`48`	`48`	`properties.SetPath("object_file", objectFile)`
`49`	`49`
`50`		`- command, err := utils.PrepareCommandForRecipe(properties, "recipe.ar.pattern", false)`
	`50`	`+ command, err := b.prepareCommandForRecipe(properties, "recipe.ar.pattern", false)`
`51`	`51`	`if err != nil {`
`52`	`52`	`return nil, errors.WithStack(err)`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ func (b *Builder) compileFileWithRecipe(`
`125`	`125`	`return nil, errors.WithStack(err)`
`126`	`126`	`}`
`127`	`127`
`128`		`- command, err := utils.PrepareCommandForRecipe(properties, recipe, false)`
	`128`	`+ command, err := b.prepareCommandForRecipe(properties, recipe, false)`
`129`	`129`	`if err != nil {`
`130`	`130`	`return nil, errors.WithStack(err)`
`131`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func (b *Builder) RunRecipe(prefix, suffix string, skipIfOnlyUpdatingCompilation`
`39`	`39`	`for _, recipe := range recipes {`
`40`	`40`	`logrus.Debugf(fmt.Sprintf("Running recipe: %s", recipe))`
`41`	`41`
`42`		`- command, err := utils.PrepareCommandForRecipe(properties, recipe, false)`
	`42`	`+ command, err := b.prepareCommandForRecipe(properties, recipe, false)`
`43`	`43`	`if err != nil {`
`44`	`44`	`return errors.WithStack(err)`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ func (b *Builder) size() error {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`func (b *Builder) checkSizeAdvanced() (ExecutablesFileSections, error) {`
`75`		`- command, err := utils.PrepareCommandForRecipe(b.buildProperties, "recipe.advanced_size.pattern", false)`
	`75`	`+ command, err := b.prepareCommandForRecipe(b.buildProperties, "recipe.advanced_size.pattern", false)`
`76`	`76`	`if err != nil {`
`77`	`77`	`return nil, errors.New(tr("Error while determining sketch size: %s", err))`
`78`	`78`	`}`
`@@ -204,7 +204,7 @@ func (b *Builder) checkSize() (ExecutablesFileSections, error) {`
`204`	`204`	`}`
`205`	`205`
`206`	`206`	`func (b Builder) execSizeRecipe(properties properties.Map) (textSize int, dataSize int, eepromSize int, resErr error) {`
`207`		`- command, err := utils.PrepareCommandForRecipe(properties, "recipe.size.pattern", false)`
	`207`	`+ command, err := b.prepareCommandForRecipe(properties, "recipe.size.pattern", false)`
`208`	`208`	`if err != nil {`
`209`	`209`	`resErr = fmt.Errorf(tr("Error while determining sketch size: %s"), err)`
`210`	`210`	`return`