arduino#1456 - Add sketches directory to the Settings (to be used when called via gRPC)

Author: 4ntoine

cli/config/validate.go

@@ -26,6 +26,7 @@ var validMap = map[string]reflect.Kind{
 	"directories.data":              reflect.String,
 	"directories.downloads":         reflect.String,
 	"directories.user":              reflect.String,
+        "directories.sketches":          reflect.String,
 	"library.enable_unsafe_install": reflect.Bool,
 	"logging.file":                  reflect.String,
 	"logging.format":                reflect.String,

cli/sketch/new.go

@@ -17,6 +17,8 @@ package sketch
 
 import (
 	"os"
+	"strings"
+	"path/filepath"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
@@ -37,9 +39,17 @@ func initNewCommand() *cobra.Command {
 }
 
 func runNewCommand(cmd *cobra.Command, args []string) {
-	sketchDir, _, err := sk.CreateSketch(args[0])
+	// Trim to avoid issues if user creates a sketch adding the .ino extesion to the name
+	sketchName := args[0];	
+	trimmedSketchName := strings.TrimSuffix(sketchName, ".ino")
+	sketchDir, err := filepath.Abs(trimmedSketchName)
 	if err != nil {
-		feedback.Errorf("Error creating sketch: %v", err) // TODO: use `tr()`
+		feedback.Errorf(tr("Error creating sketch: %v"), err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	_, err = sk.CreateSketch(sketchDir, sketchName)
+	if err != nil {
+		feedback.Errorf(tr("Error creating sketch: %v"), err)
 		os.Exit(errorcodes.ErrGeneric)
 	}
 

commands/sketch/new.go

@@ -20,9 +20,9 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
-	"strings"
 
 	"github.com/arduino/arduino-cli/commands"
+	"github.com/arduino/arduino-cli/configuration"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
@@ -35,27 +35,22 @@ void loop() {
 `)
 
 // CreateSketch creates a new sketch
-func CreateSketch(sketchName string) (string, string, error) {
-	// Trim to avoid issues if user creates a sketch adding the .ino extesion to the name
-	trimmedSketchName := strings.TrimSuffix(sketchName, ".ino")
-	sketchDir, err := filepath.Abs(trimmedSketchName)
-	if err != nil {
-		return "", "", err
-	}
+func CreateSketch(sketchDir string, sketchName string) (string, error) {
 	if err := os.MkdirAll(sketchDir, os.FileMode(0755)); err != nil {
-		return "", "", err
+		return "", err
 	}
 	baseSketchName := filepath.Base(sketchDir)
 	sketchFile := filepath.Join(sketchDir, baseSketchName+".ino")
 	if err := ioutil.WriteFile(sketchFile, emptySketch, os.FileMode(0644)); err != nil {
-		return "", "", err
+		return "", err
 	}
-	return sketchDir, sketchFile, nil
+	return sketchFile, nil
 }
 
 // NewSketch FIXMEDOC
 func NewSketch(ctx context.Context, req *rpc.NewSketchRequest) (*rpc.NewSketchResponse, error) {
-	_, sketchFile, err := CreateSketch(req.SketchName)
+        sketchDir := configuration.Settings.GetString("directories.Sketches")
+	sketchFile, err := CreateSketch(sketchDir, req.SketchName)
 	if err != nil {
 		return nil, &commands.CantCreateSketchError{Cause: err}
 	}

configuration/configuration_test.go

@@ -93,6 +93,7 @@ func TestInit(t *testing.T) {
 	require.NotEmpty(t, settings.GetString("directories.Data"))
 	require.NotEmpty(t, settings.GetString("directories.Downloads"))
 	require.NotEmpty(t, settings.GetString("directories.User"))
+	require.NotEmpty(t, settings.GetString("directories.Sketches"))
 
 	require.Equal(t, "50051", settings.GetString("daemon.port"))
 

configuration/defaults.go

@@ -38,6 +38,8 @@ func SetDefaults(settings *viper.Viper) {
 	settings.SetDefault("directories.Data", getDefaultArduinoDataDir())
 	settings.SetDefault("directories.Downloads", filepath.Join(getDefaultArduinoDataDir(), "staging"))
 	settings.SetDefault("directories.User", getDefaultUserDir())
+        settings.SetDefault("directories.Sketches",
+filepath.Join(getDefaultUserDir(), "sketches"))
 
 	// Sketch compilation
 	settings.SetDefault("sketch.always_export_binaries", false)

docs/configuration.md

@@ -8,6 +8,7 @@
   - `data` - directory used to store Boards/Library Manager index files and Boards Manager platform installations.
   - `downloads` - directory used to stage downloaded archives during Boards/Library Manager installations.
   - `user` - the equivalent of the Arduino IDE's ["sketchbook" directory][sketchbook directory]. Library Manager
+  - `sketches` - directory used to store user sketches if called via gRPC.
     installations are made to the `libraries` subdirectory of the user directory.
 - `library` - configuration options relating to Arduino libraries.
   - `enable_unsafe_install` - set to `true` to enable the use of the `--git-url` and `--zip-file` flags with

test/test_config.py

@@ -37,6 +37,7 @@ def test_init_with_existing_custom_config(run_command, data_dir, working_dir, do
     assert data_dir == configs["directories"]["data"]
     assert downloads_dir == configs["directories"]["downloads"]
     assert data_dir == configs["directories"]["user"]
+    assert sketches_dir == configs["directories"]["sketches"]
     assert "" == configs["logging"]["file"]
     assert "text" == configs["logging"]["format"]
     assert "info" == configs["logging"]["level"]
@@ -55,6 +56,7 @@ def test_init_with_existing_custom_config(run_command, data_dir, working_dir, do
     assert [] == configs["board_manager"]["additional_urls"]
     assert "50051" == configs["daemon"]["port"]
     assert data_dir == configs["directories"]["data"]
+    assert sketches_dir == configs["directories"]["sketches"]
     assert downloads_dir == configs["directories"]["downloads"]
     assert data_dir == configs["directories"]["user"]
     assert "" == configs["logging"]["file"]
@@ -77,6 +79,7 @@ def test_init_overwrite_existing_custom_file(run_command, data_dir, working_dir,
     assert data_dir == configs["directories"]["data"]
     assert downloads_dir == configs["directories"]["downloads"]
     assert data_dir == configs["directories"]["user"]
+    assert sketches_dir == configs["directories"]["sketches"]
     assert "" == configs["logging"]["file"]
     assert "text" == configs["logging"]["format"]
     assert "info" == configs["logging"]["level"]
@@ -95,6 +98,7 @@ def test_init_overwrite_existing_custom_file(run_command, data_dir, working_dir,
     assert data_dir == configs["directories"]["data"]
     assert downloads_dir == configs["directories"]["downloads"]
     assert data_dir == configs["directories"]["user"]
+    assert sketches_dir == configs["directories"]["sketches"]
     assert "" == configs["logging"]["file"]
     assert "text" == configs["logging"]["format"]
     assert "info" == configs["logging"]["level"]