Fix sketch new default overwriting behavior (#1993)

* Check .ino sketch file exists in path before creating a new one

Running "arduino-cli sketch new ." from a sketch directory overwrites an existing .ino sketch file, without asking for confirmation. This fix introduces a check to verify if the specified path already
contains a .ino sketch file. If it does, an error is returned, otherwise a new sketch is created as usual.

* Add test to check if sketch new does not overwrite an already existing .ino sketch file

* Add --overwrite flag to sketch new command

Using the "--overwrite" flag, allows to create a new sketch overwriting an existing one.

Author: MatteoPologruto

cli/sketch/new.go

@@ -31,18 +31,23 @@ import (
 )
 
 func initNewCommand() *cobra.Command {
+	var overwrite bool
+
 	newCommand := &cobra.Command{
 		Use:     "new",
 		Short:   tr("Create a new Sketch"),
 		Long:    tr("Create a new Sketch"),
 		Example: "  " + os.Args[0] + " sketch new MultiBlinker",
 		Args:    cobra.ExactArgs(1),
-		Run:     runNewCommand,
+		Run:     func(cmd *cobra.Command, args []string) { runNewCommand(args, overwrite) },
 	}
+
+	newCommand.Flags().BoolVarP(&overwrite, "overwrite", "f", false, tr("Overwrites an existing .ino sketch."))
+
 	return newCommand
 }
 
-func runNewCommand(cmd *cobra.Command, args []string) {
+func runNewCommand(args []string, overwrite bool) {
 	logrus.Info("Executing `arduino-cli sketch new`")
 	// Trim to avoid issues if user creates a sketch adding the .ino extesion to the name
 	sketchName := args[0]
@@ -56,6 +61,7 @@ func runNewCommand(cmd *cobra.Command, args []string) {
 		Instance:   nil,
 		SketchName: sketchDirPath.Base(),
 		SketchDir:  sketchDirPath.Parent().String(),
+		Overwrite:  overwrite,
 	})
 	if err != nil {
 		feedback.Errorf(tr("Error creating sketch: %v"), err)

commands/sketch/new.go

@@ -17,6 +17,7 @@ package sketch
 
 import (
 	"context"
+	"errors"
 
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/globals"
@@ -47,6 +48,11 @@ func NewSketch(ctx context.Context, req *rpc.NewSketchRequest) (*rpc.NewSketchRe
 	}
 	sketchName := sketchDirPath.Base()
 	sketchMainFilePath := sketchDirPath.Join(sketchName + globals.MainFileValidExtension)
+	if !req.Overwrite {
+		if sketchMainFilePath.Exist() {
+			return nil, &arduino.CantCreateSketchError{Cause: errors.New(tr(".ino file already exists"))}
+		}
+	}
 	if err := sketchMainFilePath.WriteFile(emptySketch); err != nil {
 		return nil, &arduino.CantCreateSketchError{Cause: err}
 	}

internal/integrationtest/sketch/sketch_test.go

@@ -362,3 +362,29 @@ func TestSketchArchiveCaseMismatchFails(t *testing.T) {
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Error archiving: Can't open sketch:")
 }
+
+func TestSketchNewDotArgOverwrite(t *testing.T) {
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	sketchNew := "SketchNewDotArgOverwrite"
+	sketchPath := cli.SketchbookDir().Join(sketchNew)
+	require.NoError(t, sketchPath.MkdirAll())
+
+	cli.SetWorkingDir(sketchPath)
+	require.NoFileExists(t, sketchPath.Join(sketchNew+".ino").String())
+	// Create a new sketch
+	_, _, err := cli.Run("sketch", "new", ".")
+	require.NoError(t, err)
+
+	require.FileExists(t, sketchPath.Join(sketchNew+".ino").String())
+	// Tries to overwrite the existing sketch with a new one, but it should fail
+	_, stderr, err := cli.Run("sketch", "new", ".")
+	require.Error(t, err)
+	require.Contains(t, string(stderr), ".ino file already exists")
+
+	// Create a new sketch, overwriting the existing one
+	_, _, err = cli.Run("sketch", "new", ".", "--overwrite")
+	require.NoError(t, err)
+	require.FileExists(t, sketchPath.Join(sketchNew+".ino").String())
+}

rpc/cc/arduino/cli/commands/v1/commands.pb.go

@@ -255,6 +255,8 @@ message NewSketchRequest {
   // Default Sketchbook directory "directories.User" is used if sketch_dir is
   // empty.
   string sketch_dir = 3;
+  // Specificies if an existing .ino sketch should be overwritten
+  bool overwrite = 4;
 }
 
 message NewSketchResponse {