Propagate 'user-agent' info to tools via environment vars

cmaglie · cmaglie · commit eb7c45669c00 · 2022-01-27T17:44:14.000+01:00
diff --git a/arduino/cores/packagemanager/install_uninstall.go b/arduino/cores/packagemanager/install_uninstall.go
@@ -70,7 +70,7 @@ func (pm *PackageManager) RunPostInstallScript(platformRelease *cores.PlatformRe
 	}
 	postInstall := platformRelease.InstallDir.Join(postInstallFilename)
 	if postInstall.Exist() && postInstall.IsNotDir() {
-		cmd, err := executils.NewProcessFromPath(nil, postInstall)
+		cmd, err := executils.NewProcessFromPath(pm.GetEnvVarsForSpawnedProcess(), postInstall)
 		if err != nil {
 			return err
 		}
diff --git a/arduino/cores/packagemanager/package_manager.go b/arduino/cores/packagemanager/package_manager.go
@@ -65,6 +65,14 @@ func NewPackageManager(indexDir, packagesDir, downloadDir, tempDir *paths.Path,
 	}
 }
 
+// GetEnvVarsForSpawnedProcess produces a set of environment variables that
+// must be set to all processes spawned from the arduino-cli.
+func (pm *PackageManager) GetEnvVarsForSpawnedProcess() []string {
+	return []string{
+		"ARDUINO_USER_AGENT=" + pm.userAgent,
+	}
+}
+
 // Clear resets the PackageManager to its initial state
 func (pm *PackageManager) Clear() {
 	pm.Packages = cores.NewPackages()
diff --git a/commands/debug/debug.go b/commands/debug/debug.go
@@ -62,7 +62,7 @@ func Debug(ctx context.Context, req *dbg.DebugConfigRequest, inStream io.Reader,
 	}
 	entry.Debug("Executing debugger")
 
-	cmd, err := executils.NewProcess(nil, commandLine...)
+	cmd, err := executils.NewProcess(pm.GetEnvVarsForSpawnedProcess(), commandLine...)
 	if err != nil {
 		return nil, &arduino.FailedDebugError{Message: tr("Cannot execute debug tool"), Cause: err}
 	}
diff --git a/commands/upload/upload.go b/commands/upload/upload.go
@@ -531,19 +531,20 @@ func runProgramAction(pm *packagemanager.PackageManager,
 	}
 
 	// Run recipes for upload
+	toolEnv := pm.GetEnvVarsForSpawnedProcess()
 	if burnBootloader {
-		if err := runTool("erase.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {
+		if err := runTool("erase.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {
 			return &arduino.FailedUploadError{Message: tr("Failed chip erase"), Cause: err}
 		}
-		if err := runTool("bootloader.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {
+		if err := runTool("bootloader.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {
 			return &arduino.FailedUploadError{Message: tr("Failed to burn bootloader"), Cause: err}
 		}
 	} else if programmer != nil {
-		if err := runTool("program.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {
+		if err := runTool("program.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {
 			return &arduino.FailedUploadError{Message: tr("Failed programming"), Cause: err}
 		}
 	} else {
-		if err := runTool("upload.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {
+		if err := runTool("upload.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {
 			return &arduino.FailedUploadError{Message: tr("Failed uploading"), Cause: err}
 		}
 	}
@@ -552,7 +553,7 @@ func runProgramAction(pm *packagemanager.PackageManager,
 	return nil
 }
 
-func runTool(recipeID string, props *properties.Map, outStream, errStream io.Writer, verbose bool, dryRun bool) error {
+func runTool(recipeID string, props *properties.Map, outStream, errStream io.Writer, verbose bool, dryRun bool, toolEnv []string) error {
 	recipe, ok := props.GetOk(recipeID)
 	if !ok {
 		return fmt.Errorf(tr("recipe not found '%s'"), recipeID)
@@ -577,7 +578,7 @@ func runTool(recipeID string, props *properties.Map, outStream, errStream io.Wri
 	if dryRun {
 		return nil
 	}
-	cmd, err := executils.NewProcess(nil, cmdArgs...)
+	cmd, err := executils.NewProcess(toolEnv, cmdArgs...)
 	if err != nil {
 		return fmt.Errorf(tr("cannot execute upload tool: %s"), err)
 	}
diff --git a/legacy/builder/builder_utils/utils.go b/legacy/builder/builder_utils/utils.go
@@ -237,7 +237,7 @@ func compileFileWithRecipe(ctx *types.Context, sourcePath *paths.Path, source *p
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
-	command, err := PrepareCommandForRecipe(properties, recipe, false)
+	command, err := PrepareCommandForRecipe(properties, recipe, false, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
@@ -469,7 +469,7 @@ func ArchiveCompiledFiles(ctx *types.Context, buildPath *paths.Path, archiveFile
 		properties.SetPath(constants.BUILD_PROPERTIES_ARCHIVE_FILE_PATH, archiveFilePath)
 		properties.SetPath(constants.BUILD_PROPERTIES_OBJECT_FILE, objectFile)
 
-		command, err := PrepareCommandForRecipe(properties, constants.RECIPE_AR_PATTERN, false)
+		command, err := PrepareCommandForRecipe(properties, constants.RECIPE_AR_PATTERN, false, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
@@ -485,7 +485,7 @@ func ArchiveCompiledFiles(ctx *types.Context, buildPath *paths.Path, archiveFile
 
 const COMMANDLINE_LIMIT = 30000
 
-func PrepareCommandForRecipe(buildProperties *properties.Map, recipe string, removeUnsetProperties bool) (*exec.Cmd, error) {
+func PrepareCommandForRecipe(buildProperties *properties.Map, recipe string, removeUnsetProperties bool, toolEnv []string) (*exec.Cmd, error) {
 	pattern := buildProperties.Get(recipe)
 	if pattern == "" {
 		return nil, errors.Errorf(tr("%[1]s pattern is missing"), recipe)
@@ -501,6 +501,8 @@ func PrepareCommandForRecipe(buildProperties *properties.Map, recipe string, rem
 		return nil, errors.WithStack(err)
 	}
 	command := exec.Command(parts[0], parts[1:]...)
+	command.Env = append(command.Env, os.Environ()...)
+	command.Env = append(command.Env, toolEnv...)
 
 	// if the overall commandline is too long for the platform
 	// try reducing the length by making the filenames relative
diff --git a/legacy/builder/create_cmake_rule.go b/legacy/builder/create_cmake_rule.go
@@ -237,7 +237,7 @@ func canExportCmakeProject(ctx *types.Context) bool {
 }
 
 func extractCompileFlags(ctx *types.Context, recipe string, defines, dynamicLibs, linkerflags, linkDirectories *[]string) {
-	command, _ := builder_utils.PrepareCommandForRecipe(ctx.BuildProperties, recipe, true)
+	command, _ := builder_utils.PrepareCommandForRecipe(ctx.BuildProperties, recipe, true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 
 	for _, arg := range command.Args {
 		if strings.HasPrefix(arg, "-D") {
diff --git a/legacy/builder/ctags_runner.go b/legacy/builder/ctags_runner.go
@@ -16,6 +16,7 @@
 package builder
 
 import (
+	"os"
 	"os/exec"
 
 	"github.com/arduino/arduino-cli/legacy/builder/constants"
@@ -47,6 +48,9 @@ func (s *CTagsRunner) Run(ctx *types.Context) error {
 		return errors.WithStack(err)
 	}
 	command := exec.Command(parts[0], parts[1:]...)
+	command.Env = append(command.Env, os.Environ()...)
+	command.Env = append(command.Env, ctx.PackageManager.GetEnvVarsForSpawnedProcess()...)
+
 	sourceBytes, _, err := utils.ExecCommand(ctx, command, utils.Capture /* stdout */, utils.Ignore /* stderr */)
 	if err != nil {
 		return errors.WithStack(err)
diff --git a/legacy/builder/gcc_preproc_runner.go b/legacy/builder/gcc_preproc_runner.go
@@ -69,7 +69,7 @@ func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath *paths
 		properties.Set(constants.RECIPE_PREPROC_MACROS, GeneratePreprocPatternFromCompile(properties.Get(constants.RECIPE_CPP_PATTERN)))
 	}
 
-	cmd, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_PREPROC_MACROS, true)
+	cmd, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_PREPROC_MACROS, true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
diff --git a/legacy/builder/phases/libraries_builder.go b/legacy/builder/phases/libraries_builder.go
@@ -65,7 +65,7 @@ func findExpectedPrecompiledLibFolder(ctx *types.Context, library *libraries.Lib
 	// 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, _ := builder_utils.PrepareCommandForRecipe(ctx.BuildProperties, constants.RECIPE_CPP_PATTERN, true)
+	command, _ := builder_utils.PrepareCommandForRecipe(ctx.BuildProperties, constants.RECIPE_CPP_PATTERN, true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 	fpuSpecs := ""
 	for _, el := range strings.Split(command.String(), " ") {
 		if strings.Contains(el, FPU_CFLAG) {
diff --git a/legacy/builder/phases/linker.go b/legacy/builder/phases/linker.go
@@ -92,7 +92,7 @@ func link(ctx *types.Context, objectFiles paths.PathList, coreDotARelPath *paths
 			properties.SetPath("archive_file_path", archive)
 			properties.SetPath("object_file", object)
 
-			command, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_AR_PATTERN, false)
+			command, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_AR_PATTERN, false, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 			if err != nil {
 				return errors.WithStack(err)
 			}
@@ -113,7 +113,7 @@ func link(ctx *types.Context, objectFiles paths.PathList, coreDotARelPath *paths
 	properties.Set(constants.BUILD_PROPERTIES_ARCHIVE_FILE_PATH, coreArchiveFilePath.String())
 	properties.Set("object_files", objectFileList)
 
-	command, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_C_COMBINE_PATTERN, false)
+	command, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_C_COMBINE_PATTERN, false, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 	if err != nil {
 		return err
 	}
diff --git a/legacy/builder/phases/sizer.go b/legacy/builder/phases/sizer.go
@@ -135,7 +135,7 @@ func checkSize(ctx *types.Context, buildProperties *properties.Map) error {
 }
 
 func execSizeRecipe(ctx *types.Context, properties *properties.Map) (textSize int, dataSize int, eepromSize int, resErr error) {
-	command, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_SIZE_PATTERN, false)
+	command, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_SIZE_PATTERN, false, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 	if err != nil {
 		resErr = fmt.Errorf(tr("Error while determining sketch size: %s"), err)
 		return
diff --git a/legacy/builder/preprocess_sketch.go b/legacy/builder/preprocess_sketch.go
@@ -17,6 +17,7 @@ package builder
 
 import (
 	"fmt"
+	"os"
 	"os/exec"
 	"path/filepath"
 	"runtime"
@@ -109,6 +110,8 @@ func (s *ArduinoPreprocessorRunner) Run(ctx *types.Context) error {
 		return errors.WithStack(err)
 	}
 	command := exec.Command(parts[0], parts[1:]...)
+	command.Env = append(command.Env, os.Environ()...)
+	command.Env = append(command.Env, ctx.PackageManager.GetEnvVarsForSpawnedProcess()...)
 
 	if runtime.GOOS == "windows" {
 		// chdir in the uppermost directory to avoid UTF-8 bug in clang (https://github.com/arduino/arduino-preprocessor/issues/2)
diff --git a/legacy/builder/recipe_runner.go b/legacy/builder/recipe_runner.go
@@ -44,7 +44,7 @@ func (s *RecipeByPrefixSuffixRunner) Run(ctx *types.Context) error {
 	for _, recipe := range recipes {
 		logrus.Debugf(fmt.Sprintf("Running recipe: %s", recipe))
 
-		command, err := builder_utils.PrepareCommandForRecipe(properties, recipe, false)
+		command, err := builder_utils.PrepareCommandForRecipe(properties, recipe, false, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 		if err != nil {
 			return errors.WithStack(err)
 		}

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ func (pm PackageManager) RunPostInstallScript(platformRelease cores.PlatformRe`
`70`	`70`	`}`
`71`	`71`	`postInstall := platformRelease.InstallDir.Join(postInstallFilename)`
`72`	`72`	`if postInstall.Exist() && postInstall.IsNotDir() {`
`73`		`- cmd, err := executils.NewProcessFromPath(nil, postInstall)`
	`73`	`+ cmd, err := executils.NewProcessFromPath(pm.GetEnvVarsForSpawnedProcess(), postInstall)`
`74`	`74`	`if err != nil {`
`75`	`75`	`return err`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,14 @@ func NewPackageManager(indexDir, packagesDir, downloadDir, tempDir *paths.Path,`
`65`	`65`	`}`
`66`	`66`	`}`
`67`	`67`
	`68`	`+// GetEnvVarsForSpawnedProcess produces a set of environment variables that`
	`69`	`+// must be set to all processes spawned from the arduino-cli.`
	`70`	`+func (pm *PackageManager) GetEnvVarsForSpawnedProcess() []string {`
	`71`	`+ return []string{`
	`72`	`+ "ARDUINO_USER_AGENT=" + pm.userAgent,`
	`73`	`+ }`
	`74`	`+}`
	`75`	`+`
`68`	`76`	`// Clear resets the PackageManager to its initial state`
`69`	`77`	`func (pm *PackageManager) Clear() {`
`70`	`78`	`pm.Packages = cores.NewPackages()`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ func Debug(ctx context.Context, req *dbg.DebugConfigRequest, inStream io.Reader,`
`62`	`62`	`}`
`63`	`63`	`entry.Debug("Executing debugger")`
`64`	`64`
`65`		`- cmd, err := executils.NewProcess(nil, commandLine...)`
	`65`	`+ cmd, err := executils.NewProcess(pm.GetEnvVarsForSpawnedProcess(), commandLine...)`
`66`	`66`	`if err != nil {`
`67`	`67`	`return nil, &arduino.FailedDebugError{Message: tr("Cannot execute debug tool"), Cause: err}`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -531,19 +531,20 @@ func runProgramAction(pm *packagemanager.PackageManager,`
`531`	`531`	`}`
`532`	`532`
`533`	`533`	`// Run recipes for upload`
	`534`	`+ toolEnv := pm.GetEnvVarsForSpawnedProcess()`
`534`	`535`	`if burnBootloader {`
`535`		`- if err := runTool("erase.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {`
	`536`	`+ if err := runTool("erase.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {`
`536`	`537`	`return &arduino.FailedUploadError{Message: tr("Failed chip erase"), Cause: err}`
`537`	`538`	`}`
`538`		`- if err := runTool("bootloader.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {`
	`539`	`+ if err := runTool("bootloader.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {`
`539`	`540`	`return &arduino.FailedUploadError{Message: tr("Failed to burn bootloader"), Cause: err}`
`540`	`541`	`}`
`541`	`542`	`} else if programmer != nil {`
`542`		`- if err := runTool("program.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {`
	`543`	`+ if err := runTool("program.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {`
`543`	`544`	`return &arduino.FailedUploadError{Message: tr("Failed programming"), Cause: err}`
`544`	`545`	`}`
`545`	`546`	`} else {`
`546`		`- if err := runTool("upload.pattern", uploadProperties, outStream, errStream, verbose, dryRun); err != nil {`
	`547`	`+ if err := runTool("upload.pattern", uploadProperties, outStream, errStream, verbose, dryRun, toolEnv); err != nil {`
`547`	`548`	`return &arduino.FailedUploadError{Message: tr("Failed uploading"), Cause: err}`
`548`	`549`	`}`
`549`	`550`	`}`
`@@ -552,7 +553,7 @@ func runProgramAction(pm *packagemanager.PackageManager,`
`552`	`553`	`return nil`
`553`	`554`	`}`
`554`	`555`
`555`		`-func runTool(recipeID string, props *properties.Map, outStream, errStream io.Writer, verbose bool, dryRun bool) error {`
	`556`	`+func runTool(recipeID string, props *properties.Map, outStream, errStream io.Writer, verbose bool, dryRun bool, toolEnv []string) error {`
`556`	`557`	`recipe, ok := props.GetOk(recipeID)`
`557`	`558`	`if !ok {`
`558`	`559`	`return fmt.Errorf(tr("recipe not found '%s'"), recipeID)`
`@@ -577,7 +578,7 @@ func runTool(recipeID string, props *properties.Map, outStream, errStream io.Wri`
`577`	`578`	`if dryRun {`
`578`	`579`	`return nil`
`579`	`580`	`}`
`580`		`- cmd, err := executils.NewProcess(nil, cmdArgs...)`
	`581`	`+ cmd, err := executils.NewProcess(toolEnv, cmdArgs...)`
`581`	`582`	`if err != nil {`
`582`	`583`	`return fmt.Errorf(tr("cannot execute upload tool: %s"), err)`
`583`	`584`	`}`
Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,7 @@ func canExportCmakeProject(ctx *types.Context) bool {`
`237`	`237`	`}`
`238`	`238`
`239`	`239`	`func extractCompileFlags(ctx types.Context, recipe string, defines, dynamicLibs, linkerflags, linkDirectories []string) {`
`240`		`- command, _ := builder_utils.PrepareCommandForRecipe(ctx.BuildProperties, recipe, true)`
	`240`	`+ command, _ := builder_utils.PrepareCommandForRecipe(ctx.BuildProperties, recipe, true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())`
`241`	`241`
`242`	`242`	`for _, arg := range command.Args {`
`243`	`243`	`if strings.HasPrefix(arg, "-D") {`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ func prepareGCCPreprocRecipeProperties(ctx types.Context, sourceFilePath paths`
`69`	`69`	`properties.Set(constants.RECIPE_PREPROC_MACROS, GeneratePreprocPatternFromCompile(properties.Get(constants.RECIPE_CPP_PATTERN)))`
`70`	`70`	`}`
`71`	`71`
`72`		`- cmd, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_PREPROC_MACROS, true)`
	`72`	`+ cmd, err := builder_utils.PrepareCommandForRecipe(properties, constants.RECIPE_PREPROC_MACROS, true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())`
`73`	`73`	`if err != nil {`
`74`	`74`	`return nil, errors.WithStack(err)`
`75`	`75`	`}`