Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed missing ARDUINO_USER_AGENT env var setting. #2501

Merged
merged 2 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions commands/compile/compile.go
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
paths.NewPathList(req.GetLibrary()...),
outStream, errStream, req.GetVerbose(), req.GetWarnings(),
progressCB,
pme.GetEnvVarsForSpawnedProcess(),
)
if err != nil {
if strings.Contains(err.Error(), "invalid build properties") {
Expand Down
6 changes: 5 additions & 1 deletion internal/arduino/builder/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ type Builder struct {

libsDetector *detector.SketchLibrariesDetector

toolEnv []string

// This is a function used to parse the output of the compiler
// It is used to extract errors and warnings
compilerOutputParser diagnostics.CompilerOutputParserCB
Expand Down Expand Up @@ -133,6 +135,7 @@ func NewBuilder(
libraryDirs paths.PathList,
stdout, stderr io.Writer, verbose bool, warningsLevel string,
progresCB rpc.TaskProgressCB,
toolEnv []string,
) (*Builder, error) {
buildProperties := properties.NewMap()
if boardBuildProperties != nil {
Expand Down Expand Up @@ -216,6 +219,7 @@ func NewBuilder(
buildArtifacts: &buildArtifacts{},
targetPlatform: targetPlatform,
actualPlatform: actualPlatform,
toolEnv: toolEnv,
libsDetector: detector.NewSketchLibrariesDetector(
libsManager, libsResolver,
useCachedLibrariesResolution,
Expand Down Expand Up @@ -521,7 +525,7 @@ func (b *Builder) prepareCommandForRecipe(buildProperties *properties.Map, recip
}
}

command, err := paths.NewProcess(nil, parts...)
command, err := paths.NewProcess(b.toolEnv, parts...)
if err != nil {
return nil, err
}
Expand Down
60 changes: 60 additions & 0 deletions internal/integrationtest/compile_3/compile_env_var_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// This file is part of arduino-cli.
//
// Copyright 2024 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-cli.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to [email protected].

package compile_test

import (
"testing"

"github.com/arduino/arduino-cli/internal/integrationtest"
"github.com/arduino/go-paths-helper"
"github.com/stretchr/testify/require"
)

func TestCompileEnvVarOnNewProcess(t *testing.T) {
// See: https://github.com/arduino/arduino-cli/issues/2499

env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()

// Run update-index with our test index
_, _, err := cli.Run("core", "install", "arduino:[email protected]")
require.NoError(t, err)

// Prepare sketchbook and sketch
sketch, err := paths.New("testdata", "bare_minimum").Abs()
require.NoError(t, err)

// Build "printenv" helper insider testdata/printenv
printenvDir, err := paths.New("testdata", "printenv").Abs()
require.NoError(t, err)
builder, err := paths.NewProcess(nil, "go", "build")
require.NoError(t, err)
builder.SetDir(printenvDir.String())
require.NoError(t, builder.Run())
printenv := printenvDir.Join("printenv")

// Patch avr core to run printenv instead of size
plTxt, err := cli.DataDir().Join("packages", "arduino", "hardware", "avr", "1.8.6", "platform.txt").Append()
require.NoError(t, err)
_, err = plTxt.WriteString("recipe.size.pattern=" + printenv.String() + "\n")
require.NoError(t, err)
require.NoError(t, plTxt.Close())

// Run compile and get ENV
_, stderr, err := cli.Run("compile", "-v", "-b", "arduino:avr:uno", sketch.String())
require.NoError(t, err)
require.Contains(t, string(stderr), "ENV> ARDUINO_USER_AGENT=")
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
printenv
12 changes: 12 additions & 0 deletions internal/integrationtest/compile_3/testdata/printenv/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package main

import (
"fmt"
"os"
)

func main() {
for _, env := range os.Environ() {
fmt.Fprintln(os.Stderr, "ENV>", env)
}
}
Loading