remove ActualPlatform and TargetPlatform from Context

Author: alessio-perugini

arduino/builder/builder.go

@@ -72,6 +72,9 @@ type Builder struct {
 	// C++ Parsing
 	lineOffset int
 
+	targetPlatform *cores.PlatformRelease
+	actualPlatform *cores.PlatformRelease
+
 	buildArtifacts *BuildArtifacts
 
 	*BuildOptionsManager
@@ -105,6 +108,7 @@ func NewBuilder(
 	clean bool,
 	sourceOverrides map[string]string,
 	onlyUpdateCompilationDatabase bool,
+	targetPlatform, actualPlatform *cores.PlatformRelease,
 	logger *logger.BuilderLogger,
 	progressStats *progress.Struct,
 ) (*Builder, error) {
@@ -177,6 +181,8 @@ func NewBuilder(
 		Progress:                      progressStats,
 		executableSectionsSize:        []ExecutableSectionSize{},
 		buildArtifacts:                &BuildArtifacts{},
+		targetPlatform:                targetPlatform,
+		actualPlatform:                actualPlatform,
 		BuildOptionsManager: NewBuildOptionsManager(
 			hardwareDirs, builtInToolsDirs, otherLibrariesDirs,
 			builtInLibrariesDirs, buildPath,
@@ -223,3 +229,8 @@ func (b *Builder) SaveCompilationDatabase() {
 		b.compilationDatabase.SaveToFile()
 	}
 }
+
+// TargetPlatform fixdoc
+func (b *Builder) TargetPlatform() *cores.PlatformRelease {
+	return b.targetPlatform
+}

arduino/builder/core.go

@@ -24,15 +24,14 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
-	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/buildcache"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/go-paths-helper"
 	"github.com/pkg/errors"
 )
 
 // BuildCore fixdoc
-func (b *Builder) BuildCore(actualPlatform *cores.PlatformRelease) error {
+func (b *Builder) BuildCore() error {
 	if err := b.coreBuildPath.MkdirAll(); err != nil {
 		return errors.WithStack(err)
 	}
@@ -49,7 +48,7 @@ func (b *Builder) BuildCore(actualPlatform *cores.PlatformRelease) error {
 		}
 	}
 
-	archiveFile, objectFiles, err := b.compileCore(actualPlatform)
+	archiveFile, objectFiles, err := b.compileCore()
 	if err != nil {
 		return errors.WithStack(err)
 	}
@@ -58,7 +57,7 @@ func (b *Builder) BuildCore(actualPlatform *cores.PlatformRelease) error {
 	return nil
 }
 
-func (b *Builder) compileCore(actualPlatform *cores.PlatformRelease) (*paths.Path, paths.PathList, error) {
+func (b *Builder) compileCore() (*paths.Path, paths.PathList, error) {
 	coreFolder := b.buildProperties.GetPath("build.core.path")
 	variantFolder := b.buildProperties.GetPath("build.variant.path")
 	targetCoreFolder := b.buildProperties.GetPath("runtime.platform.path")
@@ -154,7 +153,7 @@ func (b *Builder) compileCore(actualPlatform *cores.PlatformRelease) (*paths.Pat
 				b.logger.Info(tr("Archiving built core (caching) in: %[1]s", targetArchivedCore))
 			} else if os.IsNotExist(err) {
 				b.logger.Info(tr("Unable to cache built core, please tell %[1]s maintainers to follow %[2]s",
-					actualPlatform,
+					b.actualPlatform,
 					"https://arduino.github.io/arduino-cli/latest/platform-specification/#recipes-to-build-the-corea-archive-file"))
 			} else {
 				b.logger.Info(tr("Error archiving built core (caching) in %[1]s: %[2]s", targetArchivedCore, err))

arduino/builder/libraries.go

@@ -21,7 +21,6 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
-	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/go-paths-helper"
@@ -289,11 +288,8 @@ func (b *Builder) RemoveUnusedCompiledLibraries(importedLibraries libraries.List
 }
 
 // WarnAboutArchIncompatibleLibraries fixdoc
-func (b *Builder) WarnAboutArchIncompatibleLibraries(
-	targetPlatform *cores.PlatformRelease,
-	importedLibraries libraries.List,
-) {
-	archs := []string{targetPlatform.Platform.Architecture}
+func (b *Builder) WarnAboutArchIncompatibleLibraries(importedLibraries libraries.List) {
+	archs := []string{b.targetPlatform.Platform.Architecture}
 	overrides, _ := b.buildProperties.GetOk("architecture.override_check")
 	if overrides != "" {
 		archs = append(archs, strings.Split(overrides, ",")...)

arduino/builder/sketch_test.go

@@ -21,7 +21,6 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
@@ -49,13 +48,7 @@ func TestMergeSketchSources(t *testing.T) {
 	}
 	mergedSources := strings.ReplaceAll(string(mergedBytes), "%s", pathToGoldenSource)
 
-	fqbn, err := cores.ParseFQBN("a:b:c")
-	require.NoError(t, err)
-
-	b, err := NewBuilder(
-		sk, nil, paths.New("testdata"), false, nil, 0, nil,
-		nil, nil, nil, nil, fqbn, false, nil, false, nil, nil)
-	require.NoError(t, err)
+	b := Builder{sketch: sk}
 
 	offset, source, err := b.sketchMergeSources(nil)
 	require.Nil(t, err)
@@ -68,13 +61,8 @@ func TestMergeSketchSourcesArduinoIncluded(t *testing.T) {
 	require.Nil(t, err)
 	require.NotNil(t, sk)
 
-	fqbn, err := cores.ParseFQBN("a:b:c")
-	require.NoError(t, err)
-
 	// ensure not to include Arduino.h when it's already there
-	b, err := NewBuilder(sk, nil, paths.New("testdata"), false, nil, 0, nil,
-		nil, nil, nil, nil, fqbn, false, nil, false, nil, nil)
-	require.NoError(t, err)
+	b := Builder{sketch: sk}
 
 	_, source, err := b.sketchMergeSources(nil)
 	require.Nil(t, err)
@@ -91,16 +79,11 @@ func TestCopyAdditionalFiles(t *testing.T) {
 	require.Nil(t, err)
 	require.Equal(t, sk1.AdditionalFiles.Len(), 1)
 
-	fqbn, err := cores.ParseFQBN("a:b:c")
-	require.NoError(t, err)
-
-	b1, err := NewBuilder(sk1, nil, paths.New("testdata"), false, nil, 0, nil,
-		nil, nil, nil, nil, fqbn, false, nil, false, nil, nil)
-	require.NoError(t, err)
+	b := Builder{sketch: sk1}
 
 	// copy the sketch over, create a fake main file we don't care about it
 	// but we need it for `SketchLoad` to succeed later
-	err = b1.sketchCopyAdditionalFiles(tmp, nil)
+	err = b.sketchCopyAdditionalFiles(tmp, nil)
 	require.Nil(t, err)
 	fakeIno := tmp.Join(fmt.Sprintf("%s.ino", tmp.Base()))
 	require.Nil(t, fakeIno.WriteFile([]byte{}))
@@ -115,7 +98,7 @@ func TestCopyAdditionalFiles(t *testing.T) {
 	require.Nil(t, err)
 
 	// copy again
-	err = b1.sketchCopyAdditionalFiles(tmp, nil)
+	err = b.sketchCopyAdditionalFiles(tmp, nil)
 	require.Nil(t, err)
 
 	// verify file hasn't changed

commands/compile/compile.go

@@ -176,8 +176,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 
 	builderCtx := &types.Context{}
 	builderCtx.PackageManager = pme
-	builderCtx.TargetPlatform = targetPlatform
-	builderCtx.ActualPlatform = buildPlatform
+	actualPlatform := buildPlatform
 
 	// FIXME: This will be redundant when arduino-builder will be part of the cli
 	builderCtx.HardwareDirs = configuration.HardwareDirectories(configuration.Settings)
@@ -206,6 +205,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		req.GetClean(),
 		req.GetSourceOverride(),
 		req.GetCreateCompilationDatabaseOnly(),
+		actualPlatform, targetPlatform,
 		builderLogger,
 		progress.New(progressCB),
 	)
@@ -231,7 +231,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	libsManager, libsResolver, verboseOut, err := detector.LibrariesLoader(
 		useCachedLibrariesResolution, libsManager,
 		builderCtx.BuiltInLibrariesDirs, libraryDir, builderCtx.OtherLibrariesDirs,
-		builderCtx.ActualPlatform, builderCtx.TargetPlatform,
+		actualPlatform, targetPlatform,
 	)
 	if err != nil {
 		return r, &arduino.CompileFailedError{Message: err.Error()}

legacy/builder/builder.go

@@ -94,7 +94,7 @@ func (s *Builder) Run(ctx *types.Context) error {
 		}),
 
 		types.BareCommand(func(ctx *types.Context) error {
-			return ctx.Builder.BuildCore(ctx.ActualPlatform)
+			return ctx.Builder.BuildCore()
 		}),
 
 		types.BareCommand(func(ctx *types.Context) error {
@@ -274,7 +274,7 @@ func findIncludes(ctx *types.Context) types.BareCommand {
 			ctx.Builder.Sketch(),
 			ctx.Builder.GetLibrariesBuildPath(),
 			ctx.Builder.GetBuildProperties(),
-			ctx.TargetPlatform.Platform.Architecture,
+			ctx.Builder.TargetPlatform().Platform.Architecture,
 		)
 	})
 }
@@ -306,7 +306,6 @@ func containerBuildOptions(ctx *types.Context) types.BareCommand {
 func warnAboutArchIncompatibleLibraries(ctx *types.Context) types.BareCommand {
 	return types.BareCommand(func(ctx *types.Context) error {
 		ctx.Builder.WarnAboutArchIncompatibleLibraries(
-			ctx.TargetPlatform,
 			ctx.SketchLibrariesDetector.ImportedLibraries(),
 		)
 		return nil

legacy/builder/test/builder_test.go

@@ -24,6 +24,7 @@ import (
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
 	"github.com/arduino/arduino-cli/arduino/builder/detector"
 	"github.com/arduino/arduino-cli/arduino/builder/logger"
+	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
@@ -106,32 +107,37 @@ func prepareBuilderTestContext(t *testing.T, ctx *types.Context, sketchPath *pat
 	ctx.Builder, err = bldr.NewBuilder(
 		sk, nil, buildPath, false, nil, 0, nil,
 		ctx.HardwareDirs, ctx.BuiltInToolsDirs, ctx.OtherLibrariesDirs,
-		ctx.BuiltInLibrariesDirs, parseFQBN(t, "a:b:c"), false, nil, false, builderLogger, nil,
+		ctx.BuiltInLibrariesDirs, parseFQBN(t, "a:b:c"), false, nil, false,
+		nil, nil, builderLogger, nil,
 	)
 	require.NoError(t, err)
+
+	var actualPlatform, targetPlatform *cores.PlatformRelease
 	if fqbnString != "" {
 		fqbn := parseFQBN(t, fqbnString)
-		_, targetPlatform, _, boardBuildProperties, buildPlatform, err := pme.ResolveFQBN(fqbn)
+		_, targetPlatfrm, _, boardBuildProperties, buildPlatform, err := pme.ResolveFQBN(fqbn)
 		require.NoError(t, err)
+		targetPlatform = targetPlatfrm
+		actualPlatform = buildPlatform
+
 		_, err = pme.FindToolsRequiredForBuild(targetPlatform, buildPlatform)
 		require.NoError(t, err)
 
+
 		ctx.Builder, err = bldr.NewBuilder(
 			sk, boardBuildProperties, buildPath, false, nil, 0, nil,
 			ctx.HardwareDirs, ctx.BuiltInToolsDirs, ctx.OtherLibrariesDirs,
-			ctx.BuiltInLibrariesDirs, fqbn, false, nil, false, builderLogger, nil)
+			ctx.BuiltInLibrariesDirs, fqbn, false, nil, false, targetPlatform,
+			actualPlatform, builderLogger, nil)
 		require.NoError(t, err)
-
 		ctx.PackageManager = pme
-		ctx.TargetPlatform = targetPlatform
-		ctx.ActualPlatform = buildPlatform
 	}
 
 	if !stepToSkip[skipLibraries] {
 		lm, libsResolver, _, err := detector.LibrariesLoader(
 			false, nil,
 			ctx.BuiltInLibrariesDirs, nil, ctx.OtherLibrariesDirs,
-			ctx.ActualPlatform, ctx.TargetPlatform,
+			actualPlatform, targetPlatform,
 		)
 		require.NoError(t, err)
 

legacy/builder/test/libraries_loader_test.go

@@ -46,10 +46,13 @@ func TestLoadLibrariesAVR(t *testing.T) {
 	ctx = prepareBuilderTestContext(t, ctx, nil, "arduino:avr:leonardo")
 	defer cleanUpBuilderTestContext(t, ctx)
 
+	_, targetPlatform, _, _, buildPlatform, err := ctx.PackageManager.ResolveFQBN(parseFQBN(t, "arduino:avr:leonardo"))
+	require.NoError(t, err)
+
 	lm, libsResolver, _, err := detector.LibrariesLoader(
 		false, nil,
 		ctx.BuiltInLibrariesDirs, nil, ctx.OtherLibrariesDirs,
-		ctx.ActualPlatform, ctx.TargetPlatform,
+		buildPlatform, targetPlatform,
 	)
 	require.NoError(t, err)
 
@@ -150,10 +153,12 @@ func TestLoadLibrariesSAM(t *testing.T) {
 	ctx = prepareBuilderTestContext(t, ctx, nil, "arduino:sam:arduino_due_x_dbg")
 	defer cleanUpBuilderTestContext(t, ctx)
 
+	_, targetPlatform, _, _, buildPlatform, err := ctx.PackageManager.ResolveFQBN(parseFQBN(t, "arduino:sam:arduino_due_x_dbg"))
+	require.NoError(t, err)
 	lm, libsResolver, _, err := detector.LibrariesLoader(
 		false, nil,
 		ctx.BuiltInLibrariesDirs, nil, ctx.OtherLibrariesDirs,
-		ctx.ActualPlatform, ctx.TargetPlatform,
+		buildPlatform, targetPlatform,
 	)
 	require.NoError(t, err)
 
@@ -227,10 +232,12 @@ func TestLoadLibrariesAVRNoDuplicateLibrariesFolders(t *testing.T) {
 	ctx = prepareBuilderTestContext(t, ctx, nil, "arduino:avr:leonardo")
 	defer cleanUpBuilderTestContext(t, ctx)
 
+	_, targetPlatform, _, _, buildPlatform, err := ctx.PackageManager.ResolveFQBN(parseFQBN(t, "arduino:avr:leonardo"))
+	require.NoError(t, err)
 	lm, _, _, err := detector.LibrariesLoader(
 		false, nil,
 		ctx.BuiltInLibrariesDirs, nil, ctx.OtherLibrariesDirs,
-		ctx.ActualPlatform, ctx.TargetPlatform,
+		buildPlatform, targetPlatform,
 	)
 	require.NoError(t, err)
 
@@ -250,10 +257,12 @@ func TestLoadLibrariesMyAVRPlatform(t *testing.T) {
 	ctx = prepareBuilderTestContext(t, ctx, nil, "my_avr_platform:avr:custom_yun")
 	defer cleanUpBuilderTestContext(t, ctx)
 
+	_, targetPlatform, _, _, buildPlatform, err := ctx.PackageManager.ResolveFQBN(parseFQBN(t, "my_avr_platform:avr:custom_yun"))
+	require.NoError(t, err)
 	lm, _, _, err := detector.LibrariesLoader(
 		false, nil,
 		ctx.BuiltInLibrariesDirs, nil, ctx.OtherLibrariesDirs,
-		ctx.ActualPlatform, ctx.TargetPlatform,
+		buildPlatform, targetPlatform,
 	)
 	require.NoError(t, err)
 

legacy/builder/types/context.go

@@ -19,7 +19,6 @@ import (
 	"github.com/arduino/arduino-cli/arduino/builder"
 	"github.com/arduino/arduino-cli/arduino/builder/detector"
 	"github.com/arduino/arduino-cli/arduino/builder/logger"
-	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	paths "github.com/arduino/go-paths-helper"
 )
@@ -37,6 +36,4 @@ type Context struct {
 	OtherLibrariesDirs   paths.PathList
 
 	PackageManager *packagemanager.Explorer
-	TargetPlatform *cores.PlatformRelease
-	ActualPlatform *cores.PlatformRelease
 }