Moved BuildOptionsJSON into Context structure

Signed-off-by: Cristian Maglie <c.maglie@arduino.cc>

Author: cmaglie

src/arduino.cc/builder/constants/constants.go

@@ -77,9 +77,6 @@ const CTAGS = "ctags"
 const CTX_ACTUAL_PLATFORM = "actualPlatform"
 const CTX_ARCHIVE_FILE_PATH_CORE = "archiveFileCore"
 const CTX_BUILD_CORE = "buildCore"
-const CTX_BUILD_OPTIONS = "buildOptions"
-const CTX_BUILD_OPTIONS_JSON = "buildOptionsJson"
-const CTX_BUILD_OPTIONS_PREVIOUS_JSON = "buildOptionsPreviousJson"
 const CTX_BUILD_PROPERTIES = "buildProperties"
 const CTX_COLLECTED_SOURCE_FILES_QUEUE = "collectedSourceFilesQueue"
 const CTX_FILE_PATH_TO_READ = "filePathToRead"

src/arduino.cc/builder/create_build_options_map.go

@@ -30,7 +30,6 @@
 package builder
 
 import (
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/types"
 	"encoding/json"
@@ -40,14 +39,12 @@ type CreateBuildOptionsMap struct{}
 
 func (s *CreateBuildOptionsMap) Run(context map[string]interface{}, ctx *types.Context) error {
 	buildOptions := ctx.ExtractBuildOptions()
-	context[constants.CTX_BUILD_OPTIONS] = buildOptions
-
 	bytes, err := json.MarshalIndent(buildOptions, "", "  ")
 	if err != nil {
 		return i18n.WrapError(err)
 	}
 
-	context[constants.CTX_BUILD_OPTIONS_JSON] = string(bytes)
+	ctx.BuildOptionsJson = string(bytes)
 
 	return nil
 }

src/arduino.cc/builder/load_previous_build_options.go

@@ -56,7 +56,7 @@ func (s *LoadPreviousBuildOptionsMap) Run(context map[string]interface{}, ctx *t
 		return i18n.WrapError(err)
 	}
 
-	context[constants.CTX_BUILD_OPTIONS_PREVIOUS_JSON] = string(bytes)
+	ctx.BuildOptionsJsonPrevious = string(bytes)
 
 	return nil
 }

src/arduino.cc/builder/store_build_options_map.go

@@ -39,10 +39,6 @@ import (
 type StoreBuildOptionsMap struct{}
 
 func (s *StoreBuildOptionsMap) Run(context map[string]interface{}, ctx *types.Context) error {
-	buildPath := ctx.BuildPath
-	buildOptionsJson := context[constants.CTX_BUILD_OPTIONS_JSON].(string)
-
-	utils.WriteFile(filepath.Join(buildPath, constants.BUILD_OPTIONS_FILE), buildOptionsJson)
-
+	utils.WriteFile(filepath.Join(ctx.BuildPath, constants.BUILD_OPTIONS_FILE), ctx.BuildOptionsJson)
 	return nil
 }

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

@@ -31,10 +31,7 @@ package test
 
 import (
 	"arduino.cc/builder"
-	"arduino.cc/builder/constants"
-	"arduino.cc/builder/props"
 	"arduino.cc/builder/types"
-	"arduino.cc/builder/utils"
 	"github.com/stretchr/testify/require"
 	"testing"
 )
@@ -57,17 +54,6 @@ func TestCreateBuildOptionsMap(t *testing.T) {
 	err := create.Run(context, ctx)
 	NoError(t, err)
 
-	buildOptions := context[constants.CTX_BUILD_OPTIONS].(props.PropertiesMap)
-	require.Equal(t, 8, len(utils.KeysOfMapOfString(buildOptions)))
-	require.Equal(t, "hardware,hardware2", buildOptions["hardwareFolders"])
-	require.Equal(t, "tools", buildOptions["toolsFolders"])
-	require.Equal(t, "", buildOptions["builtInLibrariesFolders"])
-	require.Equal(t, "", buildOptions["customBuildProperties"])
-	require.Equal(t, "libraries", buildOptions["otherLibrariesFolders"])
-	require.Equal(t, "fqbn", buildOptions["fqbn"])
-	require.Equal(t, "sketchLocation", buildOptions["sketchLocation"])
-	require.Equal(t, "ideVersion", buildOptions["runtime.ide.version"])
-
 	require.Equal(t, "{\n"+
 		"  \"builtInLibrariesFolders\": \"\",\n"+
 		"  \"customBuildProperties\": \"\",\n"+
@@ -77,5 +63,5 @@ func TestCreateBuildOptionsMap(t *testing.T) {
 		"  \"runtime.ide.version\": \"ideVersion\",\n"+
 		"  \"sketchLocation\": \"sketchLocation\",\n"+
 		"  \"toolsFolders\": \"tools\"\n"+
-		"}", context[constants.CTX_BUILD_OPTIONS_JSON].(string))
+		"}", ctx.BuildOptionsJson)
 }

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

@@ -54,7 +54,7 @@ func TestLoadPreviousBuildOptionsMap(t *testing.T) {
 	err = command.Run(context, ctx)
 	NoError(t, err)
 
-	require.Equal(t, "test", context[constants.CTX_BUILD_OPTIONS_PREVIOUS_JSON])
+	require.Equal(t, "test", ctx.BuildOptionsJsonPrevious)
 }
 
 func TestLoadPreviousBuildOptionsMapMissingFile(t *testing.T) {
@@ -68,5 +68,5 @@ func TestLoadPreviousBuildOptionsMapMissingFile(t *testing.T) {
 	err := command.Run(context, ctx)
 	NoError(t, err)
 
-	require.False(t, utils.MapHas(context, constants.CTX_BUILD_OPTIONS_PREVIOUS_JSON))
+	require.Empty(t, ctx.BuildOptionsJsonPrevious)
 }

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

@@ -31,7 +31,6 @@ package test
 
 import (
 	"arduino.cc/builder"
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/gohasissues"
 	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
@@ -48,8 +47,8 @@ func TestWipeoutBuildPathIfBuildOptionsChanged(t *testing.T) {
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
-	context[constants.CTX_BUILD_OPTIONS_PREVIOUS_JSON] = "old"
-	context[constants.CTX_BUILD_OPTIONS_JSON] = "new"
+	ctx.BuildOptionsJsonPrevious = "old"
+	ctx.BuildOptionsJson = "new"
 
 	utils.TouchFile(filepath.Join(buildPath, "should_be_deleted.txt"))
 
@@ -80,7 +79,7 @@ func TestWipeoutBuildPathIfBuildOptionsChangedNoPreviousBuildOptions(t *testing.
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
-	context[constants.CTX_BUILD_OPTIONS_JSON] = "new"
+	ctx.BuildOptionsJson = "new"
 
 	utils.TouchFile(filepath.Join(buildPath, "should_not_be_deleted.txt"))
 
@@ -111,8 +110,8 @@ func TestWipeoutBuildPathIfBuildOptionsChangedBuildOptionsMatch(t *testing.T) {
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
-	context[constants.CTX_BUILD_OPTIONS_PREVIOUS_JSON] = "options"
-	context[constants.CTX_BUILD_OPTIONS_JSON] = "options"
+	ctx.BuildOptionsJsonPrevious = "options"
+	ctx.BuildOptionsJson = "options"
 
 	utils.TouchFile(filepath.Join(buildPath, "should_not_be_deleted.txt"))
 

src/arduino.cc/builder/types/context.go

@@ -16,6 +16,10 @@ type Context struct {
 	ArduinoAPIVersion       string
 	FQBN                    string
 
+	// Build options are serialized here
+	BuildOptionsJson         string
+	BuildOptionsJsonPrevious string
+
 	BuildPath          string
 	SketchBuildPath    string
 	CoreBuildPath      string

src/arduino.cc/builder/wipeout_build_path_if_build_options_changed.go

@@ -34,7 +34,6 @@ import (
 	"arduino.cc/builder/gohasissues"
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/types"
-	"arduino.cc/builder/utils"
 	"os"
 	"path/filepath"
 	"regexp"
@@ -43,11 +42,11 @@ import (
 type WipeoutBuildPathIfBuildOptionsChanged struct{}
 
 func (s *WipeoutBuildPathIfBuildOptionsChanged) Run(context map[string]interface{}, ctx *types.Context) error {
-	if !utils.MapHas(context, constants.CTX_BUILD_OPTIONS_PREVIOUS_JSON) {
+	if ctx.BuildOptionsJsonPrevious == "" {
 		return nil
 	}
-	buildOptionsJson := context[constants.CTX_BUILD_OPTIONS_JSON].(string)
-	previousBuildOptionsJson := context[constants.CTX_BUILD_OPTIONS_PREVIOUS_JSON].(string)
+	buildOptionsJson := ctx.BuildOptionsJson
+	previousBuildOptionsJson := ctx.BuildOptionsJsonPrevious
 	logger := ctx.GetLogger()
 
 	if buildOptionsJson == previousBuildOptionsJson {