Adding recipes from parent platforms only when build properties are set up.

Fixes #18

Signed-off-by: Federico Fissore <f.fissore@arduino.cc>

Author: Federico Fissore

src/arduino.cc/builder/add_missing_build_properties_from_parent_platform_txt_files.go

@@ -0,0 +1,50 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package builder
+
+import (
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
+	"arduino.cc/builder/utils"
+)
+
+type AddMissingBuildPropertiesFromParentPlatformTxtFiles struct{}
+
+func (s *AddMissingBuildPropertiesFromParentPlatformTxtFiles) Run(context map[string]interface{}) error {
+	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	targetPackage := context[constants.CTX_TARGET_PACKAGE].(*types.Package)
+	buildProperties := context[constants.CTX_BUILD_PROPERTIES].(map[string]string)
+
+	buildProperties = utils.MergeMapsOfStrings(make(map[string]string), packages.Properties, targetPackage.Properties, buildProperties)
+
+	context[constants.CTX_BUILD_PROPERTIES] = buildProperties
+
+	return nil
+}

src/arduino.cc/builder/container_setup.go

@@ -51,6 +51,7 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(context map[string]i
 		&SetupBuildProperties{},
 		&LoadVIDPIDSpecificProperties{},
 		&SetCustomBuildProperties{},
+		&AddMissingBuildPropertiesFromParentPlatformTxtFiles{},
 	}
 
 	for _, command := range commands {

src/arduino.cc/builder/hardware_loader.go

@@ -41,8 +41,6 @@ import (
 type HardwareLoader struct{}
 
 func (s *HardwareLoader) Run(context map[string]interface{}) error {
-	mainHardwarePlatformTxt := make(map[string]string)
-
 	packages := &types.Packages{}
 	packages.Packages = make(map[string]*types.Package)
 	packages.Properties = make(map[string]string)
@@ -62,17 +60,11 @@ func (s *HardwareLoader) Run(context map[string]interface{}) error {
 			return utils.Errorf(context, constants.MSG_MUST_BE_A_FOLDER, folder)
 		}
 
-		if len(mainHardwarePlatformTxt) == 0 {
-			mainHardwarePlatformTxt, err = props.SafeLoad(filepath.Join(folder, constants.FILE_PLATFORM_TXT))
-			if err != nil {
-				return utils.WrapError(err)
-			}
-		}
 		hardwarePlatformTxt, err := props.SafeLoad(filepath.Join(folder, constants.FILE_PLATFORM_TXT))
 		if err != nil {
 			return utils.WrapError(err)
 		}
-		hardwarePlatformTxt = utils.MergeMapsOfStrings(make(map[string]string), mainHardwarePlatformTxt, hardwarePlatformTxt)
+		packages.Properties = utils.MergeMapsOfStrings(packages.Properties, hardwarePlatformTxt)
 
 		subfolders, err := utils.ReadDirFiltered(folder, utils.FilterDirs)
 		if err != nil {
@@ -89,7 +81,7 @@ func (s *HardwareLoader) Run(context map[string]interface{}) error {
 			}
 
 			targetPackage := getOrCreatePackage(packages, packageId)
-			err = loadPackage(targetPackage, subfolderPath, hardwarePlatformTxt)
+			err = loadPackage(targetPackage, subfolderPath)
 			if err != nil {
 				return utils.WrapError(err)
 			}
@@ -110,16 +102,17 @@ func getOrCreatePackage(packages *types.Packages, packageId string) *types.Packa
 	targetPackage := types.Package{}
 	targetPackage.PackageId = packageId
 	targetPackage.Platforms = make(map[string]*types.Platform)
+	targetPackage.Properties = make(map[string]string)
 
 	return &targetPackage
 }
 
-func loadPackage(targetPackage *types.Package, folder string, hardwarePlatformTxt map[string]string) error {
+func loadPackage(targetPackage *types.Package, folder string) error {
 	packagePlatformTxt, err := props.SafeLoad(filepath.Join(folder, constants.FILE_PLATFORM_TXT))
 	if err != nil {
 		return utils.WrapError(err)
 	}
-	packagePlatformTxt = utils.MergeMapsOfStrings(make(map[string]string), hardwarePlatformTxt, packagePlatformTxt)
+	targetPackage.Properties = utils.MergeMapsOfStrings(targetPackage.Properties, packagePlatformTxt)
 
 	subfolders, err := utils.ReadDirFiltered(folder, utils.FilterDirs)
 	if err != nil {
@@ -146,7 +139,7 @@ func loadPackage(targetPackage *types.Package, folder string, hardwarePlatformTx
 		}
 
 		platform := getOrCreatePlatform(platforms, platformId)
-		err = loadPlatform(platform, targetPackage.PackageId, subfolderPath, packagePlatformTxt)
+		err = loadPlatform(platform, targetPackage.PackageId, subfolderPath)
 		if err != nil {
 			return utils.WrapError(err)
 		}
@@ -170,7 +163,7 @@ func getOrCreatePlatform(platforms map[string]*types.Platform, platformId string
 	return &targetPlatform
 }
 
-func loadPlatform(targetPlatform *types.Platform, packageId string, folder string, packagePlatformTxt map[string]string) error {
+func loadPlatform(targetPlatform *types.Platform, packageId string, folder string) error {
 	_, err := os.Stat(filepath.Join(folder, constants.FILE_BOARDS_TXT))
 	if err != nil && !os.IsNotExist(err) {
 		return utils.WrapError(err)
@@ -189,7 +182,7 @@ func loadPlatform(targetPlatform *types.Platform, packageId string, folder strin
 
 	assignDefaultBoardToPlatform(targetPlatform)
 
-	platformProperties, err := props.SafeLoad(filepath.Join(folder, constants.FILE_PLATFORM_TXT))
+	platformTxt, err := props.SafeLoad(filepath.Join(folder, constants.FILE_PLATFORM_TXT))
 	if err != nil {
 		return utils.WrapError(err)
 	}
@@ -199,7 +192,7 @@ func loadPlatform(targetPlatform *types.Platform, packageId string, folder strin
 		return utils.WrapError(err)
 	}
 
-	targetPlatform.Properties = utils.MergeMapsOfStrings(make(map[string]string), targetPlatform.Properties, packagePlatformTxt, platformProperties, localPlatformProperties)
+	targetPlatform.Properties = utils.MergeMapsOfStrings(make(map[string]string), targetPlatform.Properties, platformTxt, localPlatformProperties)
 
 	programmersProperties, err := props.SafeLoad(filepath.Join(folder, constants.FILE_PROGRAMMERS_TXT))
 	if err != nil {

src/arduino.cc/builder/test/hardware_loader_test.go

@@ -33,6 +33,7 @@ import (
 	"arduino.cc/builder"
 	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
+	"arduino.cc/builder/utils"
 	"github.com/stretchr/testify/require"
 	"path/filepath"
 	"runtime"
@@ -69,7 +70,10 @@ func TestLoadHardware(t *testing.T) {
 
 	require.Equal(t, "AVRISP mkII", avrPlatform.Programmers["avrispmkii"][constants.PROGRAMMER_NAME])
 
-	require.Equal(t, "{path}/ctags", avrPlatform.Properties["tools.ctags.cmd.path"])
+	require.Equal(t, "{runtime.tools.ctags.path}", packages.Properties["tools.ctags.path"])
+	require.Equal(t, "\"{cmd.path}\" -u --language-force=c++ -f - --c++-kinds=svpf --fields=KSTtzns \"{source_file}\"", packages.Properties["tools.ctags.pattern"])
+	require.Equal(t, "{runtime.tools.avrdude.path}", packages.Properties["tools.avrdude.path"])
+	require.Equal(t, "-w -x c++ -E -CC", packages.Properties["preproc.macros.flags"])
 }
 
 func TestLoadHardwareMixingUserHardwareFolder(t *testing.T) {
@@ -120,12 +124,22 @@ func TestLoadHardwareMixingUserHardwareFolder(t *testing.T) {
 
 	require.Equal(t, "-w -x c++ -M -MG -MP", avrPlatform.Properties["preproc.includes.flags"])
 	require.Equal(t, "-w -x c++ -E -CC", avrPlatform.Properties["preproc.macros.flags"])
-	require.Equal(t, "{build.mbed_api_include} {build.nRF51822_api_include} {build.ble_api_include} {compiler.libsam.c.flags} {compiler.arm.cmsis.path} {build.variant_system_include}", avrPlatform.Properties["preproc.macros.compatibility_flags"])
-	require.Equal(t, "\"{compiler.path}{compiler.cpp.cmd}\" {preproc.includes.flags} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DARDUINO_ARCH_{build.arch} {compiler.cpp.extra_flags} {build.extra_flags} {includes} \"{source_file}\"", avrPlatform.Properties[constants.RECIPE_PREPROC_INCLUDES])
+	require.Equal(t, "\"{compiler.path}{compiler.cpp.cmd}\" {compiler.cpp.flags} {preproc.includes.flags} -mmcu={build.mcu} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DARDUINO_ARCH_{build.arch} {compiler.cpp.extra_flags} {build.extra_flags} {includes} \"{source_file}\"", avrPlatform.Properties[constants.RECIPE_PREPROC_INCLUDES])
+	require.False(t, utils.MapStringStringHas(avrPlatform.Properties, "preproc.macros.compatibility_flags"))
 
 	require.NotNil(t, packages.Packages["my_avr_platform"])
-	myAVRPlatform := packages.Packages["my_avr_platform"].Platforms["avr"]
-	require.Equal(t, "custom_yun", myAVRPlatform.Boards["custom_yun"].BoardId)
+	myAVRPlatform := packages.Packages["my_avr_platform"]
+	require.Equal(t, "hello world", myAVRPlatform.Properties["example"])
+	myAVRPlatformAvrArch := myAVRPlatform.Platforms["avr"]
+	require.Equal(t, "custom_yun", myAVRPlatformAvrArch.Boards["custom_yun"].BoardId)
+
+	require.False(t, utils.MapStringStringHas(myAVRPlatformAvrArch.Properties, "preproc.includes.flags"))
+
+	require.Equal(t, "{runtime.tools.ctags.path}", packages.Properties["tools.ctags.path"])
+	require.Equal(t, "\"{cmd.path}\" -u --language-force=c++ -f - --c++-kinds=svpf --fields=KSTtzns \"{source_file}\"", packages.Properties["tools.ctags.pattern"])
+	require.Equal(t, "{runtime.tools.avrdude.path}", packages.Properties["tools.avrdude.path"])
+	require.Equal(t, "-w -x c++ -E -CC", packages.Properties["preproc.macros.flags"])
+	require.Equal(t, "{build.mbed_api_include} {build.nRF51822_api_include} {build.ble_api_include} {compiler.libsam.c.flags} {compiler.arm.cmsis.path} {build.variant_system_include}", packages.Properties["preproc.macros.compatibility_flags"])
 
 	if runtime.GOOS != "windows" {
 		require.NotNil(t, packages.Packages["my_symlinked_avr_platform"])
@@ -173,7 +187,6 @@ func TestLoadHardwareWithBoardManagerFolderStructure(t *testing.T) {
 	require.Equal(t, "blend", avrRedBearPlatform.Boards["blend"].BoardId)
 	require.Equal(t, "blend", avrRedBearPlatform.Boards["blend"].Properties[constants.ID])
 	require.Equal(t, "arduino:arduino", avrRedBearPlatform.Boards["blend"].Properties[constants.BUILD_PROPERTIES_BUILD_CORE])
-
 }
 
 func TestLoadLotsOfHardware(t *testing.T) {

src/arduino.cc/builder/test/setup_build_properties_test.go

@@ -80,10 +80,6 @@ func TestSetupBuildProperties(t *testing.T) {
 	require.Equal(t, "\"{compiler.path}{compiler.c.cmd}\" {compiler.c.flags} -mmcu={build.mcu} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DARDUINO_ARCH_{build.arch} {compiler.c.extra_flags} {build.extra_flags} {includes} \"{source_file}\" -o \"{object_file}\"", buildProperties["recipe.c.o.pattern"])
 	require.Equal(t, "{path}/etc/avrdude.conf", buildProperties["tools.avrdude.config.path"])
 
-	coanProps := props.SubTree(props.SubTree(buildProperties, constants.BUILD_PROPERTIES_TOOLS_KEY), constants.COAN)
-	require.Equal(t, "{path}/coan", coanProps["cmd.path"])
-	require.Equal(t, "\"{cmd.path}\" source -m -E -P -kb {compiler.c.flags} -mmcu={build.mcu} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DARDUINO_ARCH_{build.arch} {compiler.c.extra_flags} {build.extra_flags} \"{source_file}\"", coanProps[constants.BUILD_PROPERTIES_PATTERN])
-
 	require.Equal(t, Abs(t, "downloaded_hardware/arduino/avr"), buildProperties[constants.BUILD_PROPERTIES_RUNTIME_PLATFORM_PATH])
 	require.Equal(t, Abs(t, "downloaded_hardware/arduino"), buildProperties[constants.BUILD_PROPERTIES_RUNTIME_HARDWARE_PATH])
 	require.Equal(t, "10600", buildProperties[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION])
@@ -186,3 +182,64 @@ func TestSetupBuildPropertiesUserHardware(t *testing.T) {
 	require.Equal(t, Abs(t, filepath.Join("user_hardware", "my_avr_platform", "avr")), buildProperties[constants.BUILD_PROPERTIES_RUNTIME_PLATFORM_PATH])
 	require.Equal(t, Abs(t, filepath.Join("user_hardware", "my_avr_platform")), buildProperties[constants.BUILD_PROPERTIES_RUNTIME_HARDWARE_PATH])
 }
+
+func TestSetupBuildPropertiesWithMissingPropsFromParentPlatformTxtFiles(t *testing.T) {
+	DownloadCoresAndToolsAndLibraries(t)
+
+	context := make(map[string]interface{})
+
+	buildPath := SetupBuildPath(t, context)
+	defer os.RemoveAll(buildPath)
+
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+	context[constants.CTX_HARDWARE_FOLDERS] = []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware", "user_hardware"}
+	context[constants.CTX_TOOLS_FOLDERS] = []string{"downloaded_tools", "./tools_builtin"}
+	context[constants.CTX_FQBN] = "my_avr_platform:avr:custom_yun"
+	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("sketch1", "sketch.ino")
+
+	commands := []types.Command{
+		&builder.SetupHumanLoggerIfMissing{},
+		&builder.ContainerSetupHardwareToolsLibsSketchAndProps{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	buildProperties := context[constants.CTX_BUILD_PROPERTIES].(map[string]string)
+
+	require.Equal(t, "ARDUINO", buildProperties[constants.BUILD_PROPERTIES_SOFTWARE])
+
+	require.Equal(t, "custom_yun", buildProperties[constants.ID])
+	require.Equal(t, "Arduino Yún", buildProperties["name"])
+	require.Equal(t, "0x2341", buildProperties["vid.0"])
+	require.Equal(t, "\"{compiler.path}{compiler.c.cmd}\" {compiler.c.flags} -mmcu={build.mcu} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DARDUINO_ARCH_{build.arch} {compiler.c.extra_flags} {build.extra_flags} {includes} \"{source_file}\" -o \"{object_file}\"", buildProperties["recipe.c.o.pattern"])
+	require.Equal(t, "{path}/etc/avrdude.conf", buildProperties["tools.avrdude.config.path"])
+
+	coanProps := props.SubTree(props.SubTree(buildProperties, constants.BUILD_PROPERTIES_TOOLS_KEY), constants.COAN)
+	require.Equal(t, "{path}/coan", coanProps["cmd.path"])
+	require.Equal(t, "\"{cmd.path}\" source -m -E -P -kb {compiler.c.flags} -mmcu={build.mcu} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DARDUINO_ARCH_{build.arch} {compiler.c.extra_flags} {build.extra_flags} \"{source_file}\"", coanProps[constants.BUILD_PROPERTIES_PATTERN])
+
+	require.Equal(t, Abs(t, "user_hardware/my_avr_platform/avr"), buildProperties[constants.BUILD_PROPERTIES_RUNTIME_PLATFORM_PATH])
+	require.Equal(t, Abs(t, "user_hardware/my_avr_platform"), buildProperties[constants.BUILD_PROPERTIES_RUNTIME_HARDWARE_PATH])
+	require.Equal(t, "10600", buildProperties[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION])
+	require.NotEmpty(t, buildProperties[constants.BUILD_PROPERTIES_RUNTIME_OS])
+
+	require.Equal(t, Abs(t, "./downloaded_tools/arm-none-eabi-gcc/4.8.3-2014q1"), buildProperties["runtime.tools.arm-none-eabi-gcc.path"])
+	require.Equal(t, Abs(t, "./downloaded_tools/arm-none-eabi-gcc/4.8.3-2014q1"), buildProperties["runtime.tools.arm-none-eabi-gcc-4.8.3-2014q1.path"])
+	require.Equal(t, Abs(t, "./downloaded_tools/bossac/1.3a-arduino"), buildProperties["runtime.tools.bossac-1.3a-arduino.path"])
+	require.Equal(t, Abs(t, "./downloaded_tools/bossac/1.5-arduino"), buildProperties["runtime.tools.bossac-1.5-arduino.path"])
+	require.True(t, buildProperties["runtime.tools.bossac.path"] == Abs(t, "./downloaded_tools/bossac/1.3a-arduino") || buildProperties["runtime.tools.bossac.path"] == Abs(t, "./downloaded_tools/bossac/1.5-arduino"))
+	require.Equal(t, Abs(t, "./downloaded_tools/avrdude/6.0.1-arduino5"), buildProperties["runtime.tools.avrdude.path"])
+	require.Equal(t, Abs(t, "./downloaded_tools/avrdude/6.0.1-arduino5"), buildProperties["runtime.tools.avrdude-6.0.1-arduino5.path"])
+	require.Equal(t, Abs(t, "./downloaded_tools/avr-gcc/4.8.1-arduino5"), buildProperties["runtime.tools.avr-gcc.path"])
+	require.Equal(t, Abs(t, "./downloaded_tools/avr-gcc/4.8.1-arduino5"), buildProperties["runtime.tools.avr-gcc-4.8.1-arduino5.path"])
+
+	require.Equal(t, Abs(t, filepath.Join("sketch1", "sketch.ino")), buildProperties[constants.BUILD_PROPERTIES_SOURCE_PATH])
+
+	require.True(t, utils.MapStringStringHas(buildProperties, constants.BUILD_PROPERTIES_EXTRA_TIME_UTC))
+	require.True(t, utils.MapStringStringHas(buildProperties, constants.BUILD_PROPERTIES_EXTRA_TIME_LOCAL))
+	require.True(t, utils.MapStringStringHas(buildProperties, constants.BUILD_PROPERTIES_EXTRA_TIME_ZONE))
+	require.True(t, utils.MapStringStringHas(buildProperties, constants.BUILD_PROPERTIES_EXTRA_TIME_DST))
+}

src/arduino.cc/builder/test/user_hardware/my_avr_platform/platform.txt

@@ -0,0 +1 @@
+example=hello world