Wipe build directory if any additional file has been added/removed from the previous run

Author: facchinm

test/create_build_options_map_test.go

@@ -54,6 +54,7 @@ func TestCreateBuildOptionsMap(t *testing.T) {
 	NoError(t, err)
 
 	require.Equal(t, "{\n"+
+		"  \"additionalFiles\": \"\",\n"+
 		"  \"builtInLibrariesFolders\": \"\",\n"+
 		"  \"customBuildProperties\": \"\",\n"+
 		"  \"fqbn\": \"fqbn\",\n"+

test/store_build_options_map_test.go

@@ -74,6 +74,7 @@ func TestStoreBuildOptionsMap(t *testing.T) {
 	NoError(t, err)
 
 	require.Equal(t, "{\n"+
+		"  \"additionalFiles\": \"\",\n"+
 		"  \"builtInLibrariesFolders\": \"built-in libraries\",\n"+
 		"  \"customBuildProperties\": \"custom=prop\",\n"+
 		"  \"fqbn\": \"fqbn\",\n"+

types/context.go

@@ -1,6 +1,7 @@
 package types
 
 import (
+	"path/filepath"
 	"strings"
 
 	"github.com/arduino/arduino-builder/i18n"
@@ -103,6 +104,14 @@ type Context struct {
 
 func (ctx *Context) ExtractBuildOptions() properties.Map {
 	opts := make(properties.Map)
+	var additionalFilesRelative []string
+	if ctx.Sketch != nil {
+		for _, sketch := range ctx.Sketch.AdditionalFiles {
+			absPath := filepath.Dir(ctx.SketchLocation)
+			relPath := strings.TrimPrefix(sketch.Name, absPath)
+			additionalFilesRelative = append(additionalFilesRelative, relPath)
+		}
+	}
 	opts["hardwareFolders"] = strings.Join(ctx.HardwareFolders, ",")
 	opts["toolsFolders"] = strings.Join(ctx.ToolsFolders, ",")
 	opts["builtInLibrariesFolders"] = strings.Join(ctx.BuiltInLibrariesFolders, ",")
@@ -111,6 +120,7 @@ func (ctx *Context) ExtractBuildOptions() properties.Map {
 	opts["fqbn"] = ctx.FQBN
 	opts["runtime.ide.version"] = ctx.ArduinoAPIVersion
 	opts["customBuildProperties"] = strings.Join(ctx.CustomBuildProperties, ",")
+	opts["additionalFiles"] = strings.Join(additionalFilesRelative, ",")
 	return opts
 }
 

wipeout_build_path_if_build_options_changed.go

@@ -33,6 +33,7 @@ import (
 	"encoding/json"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/arduino/arduino-builder/builder_utils"
 	"github.com/arduino/arduino-builder/constants"
@@ -85,6 +86,10 @@ func (s *WipeoutBuildPathIfBuildOptionsChanged) Run(ctx *types.Context) error {
 	if err != nil {
 		return i18n.WrapError(err)
 	}
+	// if build path is inside the sketch folder, also wipe ctx.AdditionalFiles
+	if strings.Contains(ctx.BuildPath, filepath.Dir(ctx.SketchLocation)) {
+		ctx.Sketch.AdditionalFiles = ctx.Sketch.AdditionalFiles[:0]
+	}
 	for _, file := range files {
 		os.RemoveAll(filepath.Join(buildPath, file.Name()))
 	}