Cached core.a filename now depends on core path too

Signed-off-by: Cristian Maglie <[email protected]>

Author: cmaglie

src/arduino.cc/builder/builder_utils/utils.go

@@ -462,8 +462,14 @@ func CopyFile(src, dst string) (err error) {
 	return
 }
 
-func GetCoreArchivePath(fqbn string) string {
+// GetCachedCoreArchiveFileName returns the filename to be used to store
+// the global cached core.a.
+func GetCachedCoreArchiveFileName(fqbn, coreFolder string) string {
 	fqbnToUnderscore := strings.Replace(fqbn, ":", "_", -1)
 	fqbnToUnderscore = strings.Replace(fqbnToUnderscore, "=", "_", -1)
-	return os.TempDir() + "/core_" + fqbnToUnderscore + ".a"
+	if absCoreFolder, err := filepath.Abs(coreFolder); err == nil {
+		coreFolder = absCoreFolder
+	} // silently continue if absolute path can't be detected
+	hash := utils.MD5Sum([]byte(coreFolder))
+	return os.TempDir() + "/core_" + fqbnToUnderscore + "_" + hash + ".a"
 }

src/arduino.cc/builder/phases/core_builder.go

@@ -89,7 +89,7 @@ func compileCore(buildPath string, buildProperties properties.Map, verbose bool,
 	// Recreate the archive if ANY of the core files (including platform.txt) has changed
 	realCoreFolder := utils.GetParentFolder(coreFolder, 2)
 
-	targetArchivedCore := builder_utils.GetCoreArchivePath(buildProperties[constants.BUILD_PROPERTIES_FQBN])
+	targetArchivedCore := builder_utils.GetCachedCoreArchiveFileName(buildProperties[constants.BUILD_PROPERTIES_FQBN], realCoreFolder)
 	canUseArchivedCore := !builder_utils.CoreOrReferencedCoreHasChanged(realCoreFolder, targetCoreFolder, targetArchivedCore)
 
 	if canUseArchivedCore {

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

@@ -62,6 +62,12 @@ func TestBuilderEmptySketch(t *testing.T) {
 
 	ctx.DebugLevel = 10
 
+	// Cleanup cached core
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "avr")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
+	os.Remove(coreFile)
+
+	// Run builder
 	command := builder.Builder{}
 	err := command.Run(ctx)
 	NoError(t, err)
@@ -95,6 +101,12 @@ func TestBuilderBridge(t *testing.T) {
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
+	// Cleanup cached core
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "avr")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
+	os.Remove(coreFile)
+
+	// Run builder
 	command := builder.Builder{}
 	err := command.Run(ctx)
 	NoError(t, err)
@@ -129,14 +141,16 @@ func TestBuilderSketchWithConfig(t *testing.T) {
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
+	// Cleanup cached core
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "avr")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
+	os.Remove(coreFile)
+
+	// Run builder
 	command := builder.Builder{}
 	err := command.Run(ctx)
 	NoError(t, err)
 
-	// Cleanup cached core
-	coreFile := builder_utils.GetCoreArchivePath(ctx.FQBN)
-	os.Remove(coreFile)
-
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "HardwareSerial.cpp.o"))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
@@ -167,18 +181,21 @@ func TestBuilderBridgeTwice(t *testing.T) {
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
+	// Cleanup cached core
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "avr")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
+	os.Remove(coreFile)
+
+	// Run builder
 	command := builder.Builder{}
 	err := command.Run(ctx)
 	NoError(t, err)
 
+	// Run builder again
 	command = builder.Builder{}
 	err = command.Run(ctx)
 	NoError(t, err)
 
-	// Cleanup cached core
-	coreFile := builder_utils.GetCoreArchivePath(ctx.FQBN)
-	os.Remove(coreFile)
-
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "HardwareSerial.cpp.o"))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
@@ -211,6 +228,12 @@ func TestBuilderBridgeSAM(t *testing.T) {
 
 	ctx.WarningsLevel = "all"
 
+	// Cleanup cached core
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "sam")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
+	os.Remove(coreFile)
+
+	// Run builder
 	command := builder.Builder{}
 	err := command.Run(ctx)
 	NoError(t, err)
@@ -254,6 +277,12 @@ func TestBuilderBridgeRedBearLab(t *testing.T) {
 	buildPath := SetupBuildPath(t, ctx)
 	defer os.RemoveAll(buildPath)
 
+	// Cleanup cached core
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "avr")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
+	os.Remove(coreFile)
+
+	// Run builder
 	command := builder.Builder{}
 	err := command.Run(ctx)
 	NoError(t, err)
@@ -404,10 +433,19 @@ func TestBuilderWithBuildPathInSketchDir(t *testing.T) {
 	NoError(t, err)
 	defer os.RemoveAll(ctx.BuildPath)
 
+	// Cleanup cached core
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "avr")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
+	os.Remove(coreFile)
+
+	// Run build
 	command := builder.Builder{}
 	err = command.Run(ctx)
 	NoError(t, err)
 
+	// Cleanup cached core
+	os.Remove(coreFile)
+
 	// Run build twice, to verify the build still works when the
 	// build directory is present at the start
 	err = command.Run(ctx)
@@ -430,7 +468,8 @@ func TestBuilderCacheCoreAFile(t *testing.T) {
 	defer os.RemoveAll(ctx.BuildPath)
 
 	// Cleanup cached core
-	coreFile := builder_utils.GetCoreArchivePath(ctx.FQBN)
+	coreFolder := filepath.Join("downloaded_hardware", "arduino", "avr")
+	coreFile := builder_utils.GetCachedCoreArchiveFileName(ctx.FQBN, coreFolder)
 	os.Remove(coreFile)
 
 	// Run build
@@ -451,7 +490,7 @@ func TestBuilderCacheCoreAFile(t *testing.T) {
 	// Touch a file of the core and check if the builder invalidate the cache
 	time.Sleep(time.Second)
 	now := time.Now().Local()
-	err = os.Chtimes(filepath.Join("downloaded_hardware", "arduino", "avr", "cores", "arduino", "Arduino.h"), now, now)
+	err = os.Chtimes(filepath.Join(coreFolder, "cores", "arduino", "Arduino.h"), now, now)
 	require.NoError(t, err)
 
 	// Run build again, to verify that the builder rebuilds core.a