CreateBuildPathIfMissing now split into "Generate" and "Ensure exists".

This way we can emit build.path build property when using -dump-prefs

Signed-off-by: Federico Fissore <f.fissore@arduino.cc>

Author: Federico Fissore

src/arduino.cc/builder/builder.go

@@ -68,7 +68,8 @@ func (s *Builder) Run(context map[string]interface{}) error {
 	commands := []types.Command{
 		&SetupHumanLoggerIfMissing{},
 
-		&CreateBuildPathIfMissing{},
+		&GenerateBuildPathIfMissing{},
+		&EnsureBuildPathExists{},
 
 		&ContainerSetupHardwareToolsLibsSketchAndProps{},
 
@@ -115,7 +116,12 @@ type ParseHardwareAndDumpBuildProperties struct{}
 
 func (s *ParseHardwareAndDumpBuildProperties) Run(context map[string]interface{}) error {
 	commands := []types.Command{
+		&SetupHumanLoggerIfMissing{},
+
+		&GenerateBuildPathIfMissing{},
+
 		&ContainerSetupHardwareToolsLibsSketchAndProps{},
+
 		&DumpBuildProperties{},
 	}
 

src/arduino.cc/builder/ensure_buildpath_exists.go

@@ -0,0 +1,49 @@
+/*
+ * 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"
+	"os"
+)
+
+type EnsureBuildPathExists struct{}
+
+func (s *EnsureBuildPathExists) Run(context map[string]interface{}) error {
+	buildPath := context[constants.CTX_BUILD_PATH].(string)
+
+	err := os.MkdirAll(buildPath, os.FileMode(0755))
+	if err != nil {
+		return utils.WrapError(err)
+	}
+
+	return nil
+}

src/arduino.cc/builder/create_buildpath_if_missing.go renamed to src/arduino.cc/builder/generate_buildpath_if_missing.go

@@ -40,9 +40,9 @@ import (
 	"strings"
 )
 
-type CreateBuildPathIfMissing struct{}
+type GenerateBuildPathIfMissing struct{}
 
-func (s *CreateBuildPathIfMissing) Run(context map[string]interface{}) error {
+func (s *GenerateBuildPathIfMissing) Run(context map[string]interface{}) error {
 	if utils.MapHas(context, constants.CTX_BUILD_PATH) && context[constants.CTX_BUILD_PATH].(string) != constants.EMPTY_STRING {
 		return nil
 	}
@@ -56,10 +56,6 @@ func (s *CreateBuildPathIfMissing) Run(context map[string]interface{}) error {
 	if err != nil && !os.IsNotExist(err) {
 		return utils.WrapError(err)
 	}
-	err = os.MkdirAll(buildPath, os.FileMode(0755))
-	if err != nil {
-		return utils.WrapError(err)
-	}
 
 	if utils.DebugLevel(context) > 5 {
 		logger := context[constants.CTX_LOGGER].(i18n.Logger)

src/arduino.cc/builder/test/create_buildpath_if_missing_test.go renamed to src/arduino.cc/builder/test/generate_buildpath_if_missing_test.go

@@ -32,47 +32,72 @@ package test
 import (
 	"arduino.cc/builder"
 	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
 	"github.com/stretchr/testify/require"
 	"os"
 	"path/filepath"
 	"testing"
 )
 
-func TestCreateBuildPathIfMissing(t *testing.T) {
+func TestGenerateBuildPathIfMissing(t *testing.T) {
 	context := make(map[string]interface{})
 
 	context[constants.CTX_SKETCH_LOCATION] = "test"
 
-	createBuildPathIfMissing := builder.CreateBuildPathIfMissing{}
-	err := createBuildPathIfMissing.Run(context)
+	command := builder.GenerateBuildPathIfMissing{}
+	err := command.Run(context)
 	NoError(t, err)
 
 	require.Equal(t, filepath.Join(os.TempDir(), "arduino-sketch-098F6BCD4621D373CADE4E832627B4F6"), context[constants.CTX_BUILD_PATH])
-	os.RemoveAll(context[constants.CTX_BUILD_PATH].(string))
+	_, err = os.Stat(filepath.Join(os.TempDir(), "arduino-sketch-098F6BCD4621D373CADE4E832627B4F6"))
+	require.True(t, os.IsNotExist(err))
 }
 
-func TestCreateBuildPathIfEmpty(t *testing.T) {
+func TestGenerateBuildPathIfEmpty(t *testing.T) {
 	context := make(map[string]interface{})
 
 	context[constants.CTX_SKETCH_LOCATION] = "test"
 	context[constants.CTX_BUILD_PATH] = constants.EMPTY_STRING
 
-	createBuildPathIfMissing := builder.CreateBuildPathIfMissing{}
+	createBuildPathIfMissing := builder.GenerateBuildPathIfMissing{}
 	err := createBuildPathIfMissing.Run(context)
 	NoError(t, err)
 
 	require.Equal(t, filepath.Join(os.TempDir(), "arduino-sketch-098F6BCD4621D373CADE4E832627B4F6"), context[constants.CTX_BUILD_PATH])
-	os.RemoveAll(context[constants.CTX_BUILD_PATH].(string))
+	_, err = os.Stat(filepath.Join(os.TempDir(), "arduino-sketch-098F6BCD4621D373CADE4E832627B4F6"))
+	require.True(t, os.IsNotExist(err))
 }
 
-func TestDontCreateBuildPathIfPresent(t *testing.T) {
+func TestDontGenerateBuildPathIfPresent(t *testing.T) {
 	context := make(map[string]interface{})
 
 	context[constants.CTX_BUILD_PATH] = "test"
 
-	createBuildPathIfMissing := builder.CreateBuildPathIfMissing{}
+	createBuildPathIfMissing := builder.GenerateBuildPathIfMissing{}
 	err := createBuildPathIfMissing.Run(context)
 	NoError(t, err)
 
 	require.Equal(t, "test", context[constants.CTX_BUILD_PATH])
 }
+
+func TestGenerateBuildPathAndEnsureItExists(t *testing.T) {
+	context := make(map[string]interface{})
+
+	context[constants.CTX_SKETCH_LOCATION] = "test"
+
+	commands := []types.Command{
+		&builder.GenerateBuildPathIfMissing{},
+		&builder.EnsureBuildPathExists{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	defer os.RemoveAll(filepath.Join(os.TempDir(), "arduino-sketch-098F6BCD4621D373CADE4E832627B4F6"))
+
+	require.Equal(t, filepath.Join(os.TempDir(), "arduino-sketch-098F6BCD4621D373CADE4E832627B4F6"), context[constants.CTX_BUILD_PATH])
+	_, err := os.Stat(filepath.Join(os.TempDir(), "arduino-sketch-098F6BCD4621D373CADE4E832627B4F6"))
+	NoError(t, err)
+}