Moved Tools, Hardware and USBVidPid in Context

cmaglie · cmaglie · commit 6784cbfa2dc6 · 2016-05-03T11:45:30.000+02:00
Probably a better name for the Packages structure is Hardware, something
to see later.

Signed-off-by: Cristian Maglie &lt;c.maglie@arduino.cc&gt;
diff --git a/src/arduino.cc/arduino-builder/main.go b/src/arduino.cc/arduino-builder/main.go
@@ -41,7 +41,6 @@ import (
 	"syscall"
 
 	"arduino.cc/builder"
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/gohasissues"
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/props"
@@ -258,8 +257,9 @@ func main() {
 	}
 	ctx.BuildPath = buildPath
 
+	// FLAG_VID_PID
 	if *vidPidFlag != "" {
-		context[constants.CTX_VIDPID] = *vidPidFlag
+		ctx.USBVidPid = *vidPidFlag
 	}
 
 	if flag.NArg() > 0 {
diff --git a/src/arduino.cc/builder/add_build_board_property_if_missing.go b/src/arduino.cc/builder/add_build_board_property_if_missing.go
@@ -39,7 +39,7 @@ import (
 type AddBuildBoardPropertyIfMissing struct{}
 
 func (s *AddBuildBoardPropertyIfMissing) Run(context map[string]interface{}, ctx *types.Context) error {
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 	logger := ctx.GetLogger()
 
 	for _, aPackage := range packages.Packages {
diff --git a/src/arduino.cc/builder/add_missing_build_properties_from_parent_platform_txt_files.go b/src/arduino.cc/builder/add_missing_build_properties_from_parent_platform_txt_files.go
@@ -30,14 +30,13 @@
 package builder
 
 import (
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
 )
 
 type AddMissingBuildPropertiesFromParentPlatformTxtFiles struct{}
 
 func (s *AddMissingBuildPropertiesFromParentPlatformTxtFiles) Run(context map[string]interface{}, ctx *types.Context) error {
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 	targetPackage := ctx.TargetPackage
 	buildProperties := ctx.BuildProperties
 
diff --git a/src/arduino.cc/builder/constants/constants.go b/src/arduino.cc/builder/constants/constants.go
@@ -77,7 +77,6 @@ const CTX_ARCHIVE_FILE_PATH_CORE = "archiveFileCore"
 const CTX_BUILD_CORE = "buildCore"
 const CTX_FILE_PATH_TO_READ = "filePathToRead"
 const CTX_GCC_MINUS_M_OUTPUT = "gccMinusMOutput"
-const CTX_HARDWARE = "hardware"
 const CTX_HARDWARE_REWRITE_RESULTS = "hardwareRewriteResults"
 const CTX_INCLUDE_SECTION = "includeSection"
 const CTX_INCLUDES_JUST_FOUND = "includesJustFound"
@@ -86,8 +85,6 @@ const CTX_OBJECT_FILES_CORE = "objectFilesCore"
 const CTX_OBJECT_FILES_LIBRARIES = "objectFilesLibraries"
 const CTX_OBJECT_FILES_SKETCH = "objectFilesSketch"
 const CTX_PLATFORM_KEYS_REWRITE = "platformKeysRewrite"
-const CTX_TOOLS = "tools"
-const CTX_VIDPID = "VIDPID"
 const EMPTY_STRING = ""
 const FILE_BOARDS_LOCAL_TXT = "boards.local.txt"
 const FILE_BOARDS_TXT = "boards.txt"
diff --git a/src/arduino.cc/builder/hardware_loader.go b/src/arduino.cc/builder/hardware_loader.go
@@ -92,7 +92,7 @@ func (s *HardwareLoader) Run(context map[string]interface{}, ctx *types.Context)
 		}
 	}
 
-	context[constants.CTX_HARDWARE] = packages
+	ctx.Hardware = packages
 
 	return nil
 }
diff --git a/src/arduino.cc/builder/load_vid_pid_specific_properties.go b/src/arduino.cc/builder/load_vid_pid_specific_properties.go
@@ -34,19 +34,18 @@ import (
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/props"
 	"arduino.cc/builder/types"
-	"arduino.cc/builder/utils"
 	"strconv"
 	"strings"
 )
 
 type LoadVIDPIDSpecificProperties struct{}
 
 func (s *LoadVIDPIDSpecificProperties) Run(context map[string]interface{}, ctx *types.Context) error {
-	if !utils.MapHas(context, constants.CTX_VIDPID) {
+	if ctx.USBVidPid == "" {
 		return nil
 	}
 
-	vidPid := context[constants.CTX_VIDPID].(string)
+	vidPid := ctx.USBVidPid
 	vidPid = strings.ToLower(vidPid)
 	vidPidParts := strings.Split(vidPid, "_")
 	vid := vidPidParts[0]
diff --git a/src/arduino.cc/builder/rewrite_hardware_keys.go b/src/arduino.cc/builder/rewrite_hardware_keys.go
@@ -42,7 +42,7 @@ func (s *RewriteHardwareKeys) Run(context map[string]interface{}, ctx *types.Con
 		return nil
 	}
 
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 	platformKeysRewrite := context[constants.CTX_PLATFORM_KEYS_REWRITE].(types.PlatforKeysRewrite)
 	hardwareRewriteResults := context[constants.CTX_HARDWARE_REWRITE_RESULTS].(map[*types.Platform][]types.PlatforKeyRewrite)
 
diff --git a/src/arduino.cc/builder/setup_build_properties.go b/src/arduino.cc/builder/setup_build_properties.go
@@ -43,7 +43,7 @@ import (
 type SetupBuildProperties struct{}
 
 func (s *SetupBuildProperties) Run(context map[string]interface{}, ctx *types.Context) error {
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 
 	targetPlatform := ctx.TargetPlatform
 	actualPlatform := ctx.ActualPlatform
@@ -86,7 +86,7 @@ func (s *SetupBuildProperties) Run(context map[string]interface{}, ctx *types.Co
 		buildProperties[constants.BUILD_PROPERTIES_BUILD_VARIANT_PATH] = filepath.Join(variantPlatform.Folder, constants.FOLDER_VARIANTS, variant)
 	}
 
-	tools := context[constants.CTX_TOOLS].([]*types.Tool)
+	tools := ctx.Tools
 	for _, tool := range tools {
 		buildProperties[constants.BUILD_PROPERTIES_RUNTIME_TOOLS_PREFIX+tool.Name+constants.BUILD_PROPERTIES_RUNTIME_TOOLS_SUFFIX] = tool.Folder
 		buildProperties[constants.BUILD_PROPERTIES_RUNTIME_TOOLS_PREFIX+tool.Name+"-"+tool.Version+constants.BUILD_PROPERTIES_RUNTIME_TOOLS_SUFFIX] = tool.Folder
diff --git a/src/arduino.cc/builder/target_board_resolver.go b/src/arduino.cc/builder/target_board_resolver.go
@@ -47,7 +47,7 @@ func (s *TargetBoardResolver) Run(context map[string]interface{}, ctx *types.Con
 	targetPlatformName := fqbnParts[1]
 	targetBoardName := fqbnParts[2]
 
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 
 	logger := ctx.GetLogger()
 
diff --git a/src/arduino.cc/builder/test/hardware_loader_test.go b/src/arduino.cc/builder/test/hardware_loader_test.go
@@ -55,7 +55,7 @@ func TestLoadHardware(t *testing.T) {
 		NoError(t, err)
 	}
 
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 	require.Equal(t, 2, len(packages.Packages))
 	require.NotNil(t, packages.Packages["arduino"])
 	require.Equal(t, 2, len(packages.Packages["arduino"].Platforms))
@@ -103,7 +103,7 @@ func TestLoadHardwareMixingUserHardwareFolder(t *testing.T) {
 		NoError(t, err)
 	}
 
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 
 	if runtime.GOOS == "windows" {
 		//a package is a symlink, and windows does not support them
@@ -171,7 +171,7 @@ func TestLoadHardwareWithBoardManagerFolderStructure(t *testing.T) {
 		NoError(t, err)
 	}
 
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 	require.Equal(t, 3, len(packages.Packages))
 	require.NotNil(t, packages.Packages["arduino"])
 	require.Equal(t, 1, len(packages.Packages["arduino"].Platforms))
@@ -220,7 +220,7 @@ func TestLoadLotsOfHardware(t *testing.T) {
 		NoError(t, err)
 	}
 
-	packages := context[constants.CTX_HARDWARE].(*types.Packages)
+	packages := ctx.Hardware
 
 	if runtime.GOOS == "windows" {
 		//a package is a symlink, and windows does not support them
diff --git a/src/arduino.cc/builder/test/load_vid_pid_specific_properties_test.go b/src/arduino.cc/builder/test/load_vid_pid_specific_properties_test.go
@@ -31,7 +31,6 @@ package test
 
 import (
 	"arduino.cc/builder"
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
 	"github.com/stretchr/testify/require"
 	"os"
@@ -85,7 +84,7 @@ func TestLoadVIDPIDSpecificProperties(t *testing.T) {
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
-	context[constants.CTX_VIDPID] = "0x2341_0x0237"
+	ctx.USBVidPid = "0x2341_0x0237"
 
 	commands := []types.Command{
 		&builder.ContainerSetupHardwareToolsLibsSketchAndProps{},
diff --git a/src/arduino.cc/builder/test/rewrite_hardware_keys_test.go b/src/arduino.cc/builder/test/rewrite_hardware_keys_test.go
@@ -53,7 +53,7 @@ func TestRewriteHardwareKeys(t *testing.T) {
 	platform.Properties[constants.PLATFORM_NAME] = "A test platform"
 	platform.Properties[constants.BUILD_PROPERTIES_COMPILER_PATH] = "{runtime.ide.path}/hardware/tools/avr/bin/"
 
-	context[constants.CTX_HARDWARE] = packages
+	ctx.Hardware = packages
 
 	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}}
@@ -89,7 +89,7 @@ func TestRewriteHardwareKeysWithRewritingDisabled(t *testing.T) {
 	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] = packages
+	ctx.Hardware = packages
 
 	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}}
diff --git a/src/arduino.cc/builder/test/tools_loader_test.go b/src/arduino.cc/builder/test/tools_loader_test.go
@@ -31,7 +31,6 @@ package test
 
 import (
 	"arduino.cc/builder"
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
 	"github.com/stretchr/testify/require"
 	"sort"
@@ -65,7 +64,7 @@ func TestLoadTools(t *testing.T) {
 	err := loader.Run(context, ctx)
 	NoError(t, err)
 
-	tools := context[constants.CTX_TOOLS].([]*types.Tool)
+	tools := ctx.Tools
 	require.Equal(t, 7, len(tools))
 
 	sort.Sort(ByToolIDAndVersion(tools))
@@ -104,7 +103,7 @@ func TestLoadToolsWithBoardManagerFolderStructure(t *testing.T) {
 	err := loader.Run(context, ctx)
 	NoError(t, err)
 
-	tools := context[constants.CTX_TOOLS].([]*types.Tool)
+	tools := ctx.Tools
 	require.Equal(t, 3, len(tools))
 
 	sort.Sort(ByToolIDAndVersion(tools))
@@ -131,7 +130,7 @@ func TestLoadLotsOfTools(t *testing.T) {
 	err := loader.Run(context, ctx)
 	NoError(t, err)
 
-	tools := context[constants.CTX_TOOLS].([]*types.Tool)
+	tools := ctx.Tools
 	require.Equal(t, 9, len(tools))
 
 	require.Equal(t, "arm-none-eabi-gcc", tools[0].Name)
diff --git a/src/arduino.cc/builder/tools_loader.go b/src/arduino.cc/builder/tools_loader.go
@@ -72,7 +72,7 @@ func (s *ToolsLoader) Run(context map[string]interface{}, ctx *types.Context) er
 		}
 	}
 
-	context[constants.CTX_TOOLS] = tools
+	ctx.Tools = tools
 
 	return nil
 }
diff --git a/src/arduino.cc/builder/types/context.go b/src/arduino.cc/builder/types/context.go
@@ -20,10 +20,13 @@ type Context struct {
 	BuildOptionsJson         string
 	BuildOptionsJsonPrevious string
 
+	Hardware       *Packages
+	Tools          []*Tool
 	TargetBoard    *Board
 	TargetPackage  *Package
 	TargetPlatform *Platform
 	ActualPlatform *Platform
+	USBVidPid      string
 
 	BuildProperties    props.PropertiesMap
 	BuildPath          string

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ func (s HardwareLoader) Run(context map[string]interface{}, ctx types.Context)`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`
`95`		`- context[constants.CTX_HARDWARE] = packages`
	`95`	`+ ctx.Hardware = packages`
`96`	`96`
`97`	`97`	`return nil`
`98`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ func (s RewriteHardwareKeys) Run(context map[string]interface{}, ctx types.Con`
`42`	`42`	`return nil`
`43`	`43`	`}`
`44`	`44`
`45`		`- packages := context[constants.CTX_HARDWARE].(*types.Packages)`
	`45`	`+ packages := ctx.Hardware`
`46`	`46`	`platformKeysRewrite := context[constants.CTX_PLATFORM_KEYS_REWRITE].(types.PlatforKeysRewrite)`
`47`	`47`	`hardwareRewriteResults := context[constants.CTX_HARDWARE_REWRITE_RESULTS].(map[*types.Platform][]types.PlatforKeyRewrite)`
`48`	`48`