Added FailIfBuildpathEqualsSketchPath: stops compilation when sketch (.ino) is

located in the same folder specified as build path

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

Author: Federico Fissore

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

@@ -40,10 +40,22 @@ type AddAdditionalEntriesToContext struct{}
 func (s *AddAdditionalEntriesToContext) Run(context map[string]interface{}) error {
 	if utils.MapHas(context, constants.CTX_BUILD_PATH) {
 		buildPath := context[constants.CTX_BUILD_PATH].(string)
-		preprocPath := filepath.Join(buildPath, constants.FOLDER_PREPROC)
-		sketchBuildPath := filepath.Join(buildPath, constants.FOLDER_SKETCH)
-		librariesBuildPath := filepath.Join(buildPath, constants.FOLDER_LIBRARIES)
-		coreBuildPath := filepath.Join(buildPath, constants.FOLDER_CORE)
+		preprocPath, err := filepath.Abs(filepath.Join(buildPath, constants.FOLDER_PREPROC))
+		if err != nil {
+			return utils.WrapError(err)
+		}
+		sketchBuildPath, err := filepath.Abs(filepath.Join(buildPath, constants.FOLDER_SKETCH))
+		if err != nil {
+			return utils.WrapError(err)
+		}
+		librariesBuildPath, err := filepath.Abs(filepath.Join(buildPath, constants.FOLDER_LIBRARIES))
+		if err != nil {
+			return utils.WrapError(err)
+		}
+		coreBuildPath, err := filepath.Abs(filepath.Join(buildPath, constants.FOLDER_CORE))
+		if err != nil {
+			return utils.WrapError(err)
+		}
 
 		context[constants.CTX_PREPROC_PATH] = preprocPath
 		context[constants.CTX_SKETCH_BUILD_PATH] = sketchBuildPath

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

@@ -40,6 +40,7 @@ type ContainerSetupHardwareToolsLibsSketchAndProps struct{}
 func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(context map[string]interface{}) error {
 	commands := []types.Command{
 		&AddAdditionalEntriesToContext{},
+		&FailIfBuildpathEqualsSketchPath{},
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_PREBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 		&HardwareLoader{},
 		&PlatformKeysRewriteLoader{},

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

@@ -0,0 +1,66 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package builder
+
+import (
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/utils"
+	"path/filepath"
+)
+
+type FailIfBuildpathEqualsSketchPath struct{}
+
+func (s *FailIfBuildpathEqualsSketchPath) Run(context map[string]interface{}) error {
+	if !utils.MapHas(context, constants.CTX_BUILD_PATH) || !utils.MapHas(context, constants.CTX_SKETCH_LOCATION) {
+		return nil
+	}
+
+	buildPath, err := filepath.Abs(context[constants.CTX_BUILD_PATH].(string))
+	if err != nil {
+		return utils.WrapError(err)
+	}
+
+	sketchPath, err := filepath.Abs(context[constants.CTX_SKETCH_LOCATION].(string))
+	if err != nil {
+		return utils.WrapError(err)
+	}
+	sketchPath = filepath.Dir(sketchPath)
+
+	rel, err := filepath.Rel(buildPath, sketchPath)
+	if err != nil {
+		return utils.WrapError(err)
+	}
+
+	if rel == "." {
+		return utils.Errorf(context, "Sketch cannot be located in build path. Please specify a different build path")
+	}
+
+	return nil
+}

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

@@ -0,0 +1,72 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package test
+
+import (
+	"arduino.cc/builder"
+	"arduino.cc/builder/constants"
+	"github.com/stretchr/testify/require"
+	"path/filepath"
+	"testing"
+)
+
+func TestAddAdditionalEntriesToContextNoBuildPath(t *testing.T) {
+	context := make(map[string]interface{})
+
+	command := builder.AddAdditionalEntriesToContext{}
+	NoError(t, command.Run(context))
+
+	require.Nil(t, context[constants.CTX_PREPROC_PATH])
+	require.Nil(t, context[constants.CTX_SKETCH_BUILD_PATH])
+	require.Nil(t, context[constants.CTX_LIBRARIES_BUILD_PATH])
+	require.Nil(t, context[constants.CTX_CORE_BUILD_PATH])
+
+	require.NotNil(t, context[constants.CTX_WARNINGS_LEVEL])
+	require.NotNil(t, context[constants.CTX_VERBOSE])
+	require.NotNil(t, context[constants.CTX_DEBUG_LEVEL])
+}
+
+func TestAddAdditionalEntriesToContextWithBuildPath(t *testing.T) {
+	context := make(map[string]interface{})
+
+	context[constants.CTX_BUILD_PATH] = "folder"
+
+	command := builder.AddAdditionalEntriesToContext{}
+	NoError(t, command.Run(context))
+
+	require.Equal(t, Abs(t, filepath.Join("folder", constants.FOLDER_PREPROC)), context[constants.CTX_PREPROC_PATH])
+	require.Equal(t, Abs(t, filepath.Join("folder", constants.FOLDER_SKETCH)), context[constants.CTX_SKETCH_BUILD_PATH])
+	require.Equal(t, Abs(t, filepath.Join("folder", constants.FOLDER_LIBRARIES)), context[constants.CTX_LIBRARIES_BUILD_PATH])
+	require.Equal(t, Abs(t, filepath.Join("folder", constants.FOLDER_CORE)), context[constants.CTX_CORE_BUILD_PATH])
+
+	require.NotNil(t, context[constants.CTX_WARNINGS_LEVEL])
+	require.NotNil(t, context[constants.CTX_VERBOSE])
+	require.NotNil(t, context[constants.CTX_DEBUG_LEVEL])
+}

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

@@ -0,0 +1,57 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package test
+
+import (
+	"arduino.cc/builder"
+	"arduino.cc/builder/constants"
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+func TestFailIfBuildpathEqualsSketchPath(t *testing.T) {
+	context := make(map[string]interface{})
+
+	context[constants.CTX_BUILD_PATH] = "buildPath"
+	context[constants.CTX_SKETCH_LOCATION] = "buildPath/sketch.ino"
+
+	command := builder.FailIfBuildpathEqualsSketchPath{}
+	require.Error(t, command.Run(context))
+}
+
+func TestFailIfBuildpathEqualsSketchPathSketchPathDiffers(t *testing.T) {
+	context := make(map[string]interface{})
+
+	context[constants.CTX_BUILD_PATH] = "buildPath"
+	context[constants.CTX_SKETCH_LOCATION] = "sketchPath/sketch.ino"
+
+	command := builder.FailIfBuildpathEqualsSketchPath{}
+	NoError(t, command.Run(context))
+}