Implemented rewriting=disabled (missing feature): skips platform keys rewriting

Signed-off-by: Federico Fissore <[email protected]>

Author: Federico Fissore

Diff for: src/arduino.cc/builder/constants/constants.go

@@ -65,7 +65,6 @@ const BUILD_PROPERTIES_TOOLS_KEY = "tools"
 const BUILD_PROPERTIES_VID = "vid"
 const COAN = "coan"
 const CTAGS = "ctags"
-const CTX_LIBRARY_DISCOVERY_RECURSION_DEPTH = "libraryDiscoveryRecursionDepth"
 const CTX_ACTUAL_PLATFORM = "actualPlatform"
 const CTX_BUILD_CORE = "buildCore"
 const CTX_BUILD_OPTIONS = "buildOptions"
@@ -93,6 +92,7 @@ const CTX_INCLUDES = "includes"
 const CTX_LIBRARIES_BUILD_PATH = "librariesBuildPath"
 const CTX_LIBRARIES_FOLDERS = "librariesFolders"
 const CTX_LIBRARIES = "libraries"
+const CTX_LIBRARY_DISCOVERY_RECURSION_DEPTH = "libraryDiscoveryRecursionDepth"
 const CTX_LINE_OFFSET = "lineOffset"
 const CTX_LOGGER = "logger"
 const CTX_OBJECT_FILES_CORE = "objectFilesCore"
@@ -231,6 +231,8 @@ const RECIPE_CPP_PATTERN = "recipe.cpp.o.pattern"
 const RECIPE_PREPROC_INCLUDES = "recipe.preproc.includes"
 const RECIPE_PREPROC_MACROS = "recipe.preproc.macros"
 const RECIPE_S_PATTERN = "recipe.S.o.pattern"
+const REWRITING_DISABLED = "disabled"
+const REWRITING = "rewriting"
 const SPACE = " "
 const TOOL_NAME = "name"
 const TOOL_URL = "url"

Diff for: src/arduino.cc/builder/rewrite_hardware_keys.go

@@ -52,11 +52,13 @@ func (s *RewriteHardwareKeys) Run(context map[string]interface{}) error {
 
 	for _, aPackage := range hardware {
 		for _, platform := range aPackage.Platforms {
-			for _, rewrite := range platformKeysRewrite.Rewrites {
-				if platform.Properties[rewrite.Key] != constants.EMPTY_STRING && platform.Properties[rewrite.Key] == rewrite.OldValue {
-					platform.Properties[rewrite.Key] = rewrite.NewValue
-					if warn {
-						logger.Fprintln(os.Stderr, constants.MSG_WARNING_PLATFORM_OLD_VALUES, platform.Properties[constants.PLATFORM_NAME], rewrite.Key+"="+rewrite.OldValue, rewrite.Key+"="+rewrite.NewValue)
+			if platform.Properties[constants.REWRITING] != constants.REWRITING_DISABLED {
+				for _, rewrite := range platformKeysRewrite.Rewrites {
+					if platform.Properties[rewrite.Key] != constants.EMPTY_STRING && platform.Properties[rewrite.Key] == rewrite.OldValue {
+						platform.Properties[rewrite.Key] = rewrite.NewValue
+						if warn {
+							logger.Fprintln(os.Stderr, constants.MSG_WARNING_PLATFORM_OLD_VALUES, platform.Properties[constants.PLATFORM_NAME], rewrite.Key+"="+rewrite.OldValue, rewrite.Key+"="+rewrite.NewValue)
+						}
 					}
 				}
 			}

Diff for: src/arduino.cc/builder/test/rewrite_hardware_keys_test.go

@@ -70,3 +70,39 @@ func TestRewriteHardwareKeys(t *testing.T) {
 
 	require.Equal(t, "{runtime.tools.avr-gcc.path}/bin/", platform.Properties[constants.BUILD_PROPERTIES_COMPILER_PATH])
 }
+
+func TestRewriteHardwareKeysWithRewritingDisabled(t *testing.T) {
+	context := make(map[string]interface{})
+
+	hardware := make(map[string]*types.Package)
+	aPackage := &types.Package{PackageId: "dummy"}
+	hardware["dummy"] = aPackage
+	aPackage.Platforms = make(map[string]*types.Platform)
+
+	platform := &types.Platform{PlatformId: "dummy"}
+	aPackage.Platforms["dummy"] = platform
+	platform.Properties = make(map[string]string)
+	platform.Properties[constants.PLATFORM_NAME] = "A test platform"
+	platform.Properties[constants.BUILD_PROPERTIES_COMPILER_PATH] = "{runtime.ide.path}/hardware/tools/avr/bin/"
+	platform.Properties[constants.REWRITING] = constants.REWRITING_DISABLED
+
+	context[constants.CTX_HARDWARE] = hardware
+
+	rewrite := types.PlatforKeyRewrite{Key: constants.BUILD_PROPERTIES_COMPILER_PATH, OldValue: "{runtime.ide.path}/hardware/tools/avr/bin/", NewValue: "{runtime.tools.avr-gcc.path}/bin/"}
+	platformKeysRewrite := types.PlatforKeysRewrite{Rewrites: []types.PlatforKeyRewrite{rewrite}}
+
+	context[constants.CTX_PLATFORM_KEYS_REWRITE] = platformKeysRewrite
+
+	commands := []types.Command{
+		&builder.SetupHumanLoggerIfMissing{},
+		&builder.AddAdditionalEntriesToContext{},
+		&builder.RewriteHardwareKeys{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	require.Equal(t, "{runtime.ide.path}/hardware/tools/avr/bin/", platform.Properties[constants.BUILD_PROPERTIES_COMPILER_PATH])
+}