Refactored build properties overlaying logic

Author: cmaglie

arduino/cores/packagemanager/package_manager.go

@@ -293,26 +293,26 @@ func (pme *Explorer) ResolveFQBN(fqbn *cores.FQBN) (
 			fmt.Errorf(tr("board %s not found"), fqbn.StringWithoutConfig())
 	}
 
-	buildProperties, err := board.GetBuildProperties(fqbn.Configs)
+	boardBuildProperties, err := board.GetBuildProperties(fqbn.Configs)
 	if err != nil {
 		return targetPackage, platformRelease, board, nil, nil,
 			fmt.Errorf(tr("getting build properties for board %[1]s: %[2]s"), board, err)
 	}
 
 	// Determine the platform used for the build (in case the board refers
 	// to a core contained in another platform)
-	core := buildProperties.Get("build.core")
+	core := boardBuildProperties.Get("build.core")
 	referredCore := ""
 	if split := strings.Split(core, ":"); len(split) > 1 {
 		core, referredCore = split[1], split[0]
 	}
-	variant := buildProperties.Get("build.variant")
+	variant := boardBuildProperties.Get("build.variant")
 	referredVariant := ""
 	if split := strings.Split(variant, ":"); len(split) > 1 {
 		variant, referredVariant = split[1], split[0]
 	}
 	if referredCore != "" && referredVariant != "" && referredCore != referredVariant {
-		return targetPackage, platformRelease, board, buildProperties, nil,
+		return targetPackage, platformRelease, board, nil, nil,
 			fmt.Errorf(tr("'build.core' and 'build.variant' refer to different platforms: %[1]s and %[2]s"), core+":"+referredCore, variant+":"+referredVariant)
 	}
 
@@ -324,26 +324,34 @@ func (pme *Explorer) ResolveFQBN(fqbn *cores.FQBN) (
 	if referredPackageName != "" {
 		referredPackage := pme.packages[referredPackageName]
 		if referredPackage == nil {
-			return targetPackage, platformRelease, board, buildProperties, nil,
+			return targetPackage, platformRelease, board, nil, nil,
 				fmt.Errorf(tr("missing package %[1]s referenced by board %[2]s"), referredPackageName, fqbn)
 		}
 		referredPlatform := referredPackage.Platforms[fqbn.PlatformArch]
 		if referredPlatform == nil {
-			return targetPackage, platformRelease, board, buildProperties, nil,
+			return targetPackage, platformRelease, board, nil, nil,
 				fmt.Errorf(tr("missing platform %[1]s:%[2]s referenced by board %[3]s"), referredPackageName, fqbn.PlatformArch, fqbn)
 		}
 		referredPlatformRelease = pme.GetInstalledPlatformRelease(referredPlatform)
 		if referredPlatformRelease == nil {
-			return targetPackage, platformRelease, board, buildProperties, nil,
+			return targetPackage, platformRelease, board, nil, nil,
 				fmt.Errorf(tr("missing platform release %[1]s:%[2]s referenced by board %[3]s"), referredPackageName, fqbn.PlatformArch, fqbn)
 		}
 	}
 
-	// Runtime build properties
+	// Create the build properties map by overlaying the properties of the
+	// referenced platform propeties, the board platform properties and the
+	// board specific properties.
+	buildProperties := properties.NewMap()
 	buildPlatformRelease := platformRelease
 	if referredCore != "" {
 		buildPlatformRelease = referredPlatformRelease
 	}
+	buildProperties.Merge(buildPlatformRelease.Properties)
+	buildProperties.Merge(platformRelease.Properties)
+	buildProperties.Merge(boardBuildProperties)
+
+	// Add runtime build properties
 	buildProperties.Merge(platformRelease.RuntimeProperties())
 	buildProperties.SetPath("build.core.path", buildPlatformRelease.InstallDir.Join("cores", core))
 	buildProperties.SetPath("build.system.path", buildPlatformRelease.InstallDir.Join("system"))
@@ -389,7 +397,6 @@ func (pme *Explorer) ResolveFQBN(fqbn *cores.FQBN) (
 		buildProperties.Set("software", "ARDUINO")
 	}
 
-	// No errors... phew!
 	return targetPackage, platformRelease, board, buildProperties, buildPlatformRelease, nil
 }
 

arduino/cores/packagemanager/package_manager_test.go

@@ -141,7 +141,7 @@ func TestResolveFQBN(t *testing.T) {
 	require.Equal(t, platformRelease.Platform.String(), "referenced:avr")
 	require.NotNil(t, board)
 	require.Equal(t, board.Name(), "Referenced dummy with invalid package")
-	require.NotNil(t, props)
+	require.Nil(t, props)
 	require.Nil(t, buildPlatformRelease)
 
 	// Test a board referenced from a non-existent platform/architecture
@@ -156,7 +156,7 @@ func TestResolveFQBN(t *testing.T) {
 	require.Equal(t, platformRelease.Platform.String(), "referenced:avr")
 	require.NotNil(t, board)
 	require.Equal(t, board.Name(), "Referenced dummy with invalid platform")
-	require.NotNil(t, props)
+	require.Nil(t, props)
 	require.Nil(t, buildPlatformRelease)
 
 	// Test a board referenced from a non-existent core

legacy/builder/setup_build_properties.go

@@ -24,12 +24,7 @@ import (
 type SetupBuildProperties struct{}
 
 func (s *SetupBuildProperties) Run(ctx *types.Context) error {
-	targetPlatform := ctx.TargetPlatform
-	actualPlatform := ctx.ActualPlatform
-
 	buildProperties := properties.NewMap()
-	buildProperties.Merge(actualPlatform.Properties)
-	buildProperties.Merge(targetPlatform.Properties)
 	buildProperties.Merge(ctx.TargetBoardBuildProperties)
 
 	if ctx.BuildPath != nil {
@@ -59,7 +54,7 @@ func (s *SetupBuildProperties) Run(ctx *types.Context) error {
 	encryptProp := buildProperties.ContainsKey("build.keys.encrypt_key")
 	// we verify that all the properties for the secure boot keys are defined or none of them is defined.
 	if (keychainProp || signProp || encryptProp) && !(keychainProp && signProp && encryptProp) {
-		return errors.Errorf("%s platform does not specify correctly default sign and encryption keys", targetPlatform.Platform)
+		return errors.Errorf("%s platform does not specify correctly default sign and encryption keys", ctx.TargetPlatform.Platform)
 	}
 
 	ctx.BuildProperties = buildProperties