arduino#1456 - Extract sketch creating into command and use from CLI and gRPC

Author: 4ntoine

cli/sketch/new.go

@@ -16,13 +16,11 @@
 package sketch
 
 import (
-	"io/ioutil"
 	"os"
-	"path/filepath"
-	"strings"
-
+	
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
+        sk "github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/spf13/cobra"
 )
 
@@ -38,32 +36,12 @@ func initNewCommand() *cobra.Command {
 	return newCommand
 }
 
-var emptySketch = []byte(`
-void setup() {
-}
-
-void loop() {
-}
-`)
-
 func runNewCommand(cmd *cobra.Command, args []string) {
-	// Trim to avoid issues if user creates a sketch adding the .ino extesion to the name
-	trimmedSketchName := strings.TrimSuffix(args[0], ".ino")
-	sketchDir, err := filepath.Abs(trimmedSketchName)
-	if err != nil {
-		feedback.Errorf(tr("Error creating sketch: %v"), err)
+        sketchDir, _, err := sk.CreateSketch(args[0]);
+        if err != nil {
+                feedback.Errorf(tr("Error creating sketch: %v"), err)
 		os.Exit(errorcodes.ErrGeneric)
-	}
-	if err := os.MkdirAll(sketchDir, os.FileMode(0755)); err != nil {
-		feedback.Errorf(tr("Could not create sketch directory: %v"), err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
-	sketchName := filepath.Base(sketchDir)
-	sketchFile := filepath.Join(sketchDir, sketchName+".ino")
-	if err := ioutil.WriteFile(sketchFile, emptySketch, os.FileMode(0644)); err != nil {
-		feedback.Errorf(tr("Error creating sketch: %v"), err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+        }
 
 	feedback.Print(tr("Sketch created in: %s", sketchDir))
 }

commands/daemon/daemon.go

@@ -239,6 +239,12 @@ func (s *ArduinoCoreServerImpl) Version(ctx context.Context, req *rpc.VersionReq
 	return &rpc.VersionResponse{Version: s.VersionString}, nil
 }
 
+// NewSketch FIXMEDOC
+func (s *ArduinoCoreServerImpl) NewSketch(ctx context.Context, req *rpc.NewSketchRequest) (*rpc.NewSketchResponse, error) {
+	resp, err := sketch.NewSketch(ctx, req)
+	return resp, convertErrorToRPCStatus(err)
+}
+
 // LoadSketch FIXMEDOC
 func (s *ArduinoCoreServerImpl) LoadSketch(ctx context.Context, req *rpc.LoadSketchRequest) (*rpc.LoadSketchResponse, error) {
 	resp, err := commands.LoadSketch(ctx, req)

commands/errors.go

@@ -323,6 +323,19 @@ func (e *MissingSketchPathError) ToRPCStatus() *status.Status {
 	return status.New(codes.InvalidArgument, e.Error())
 }
 
+// CantCreateSketchError is returned when the sketch cannot be created
+type CantCreateSketchError struct {
+	Cause error
+}
+
+func (e *CantCreateSketchError) Error() string {
+	return composeErrorMsg(tr("Can't create sketch"), e.Cause)
+}
+
+func (e *CantCreateSketchError) Unwrap() error {
+	return e.Cause
+}
+
 // CantOpenSketchError is returned when the sketch is not found or cannot be opened
 type CantOpenSketchError struct {
 	Cause error

commands/sketch/new.go

@@ -0,0 +1,63 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
+package sketch
+
+import (
+	"context"
+        "os"
+	"path/filepath"
+	"strings"
+        "io/ioutil"
+
+	"github.com/arduino/arduino-cli/commands"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+)
+
+var emptySketch = []byte(`
+void setup() {
+}
+
+void loop() {
+}
+`)
+
+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
+	}
+	if err := os.MkdirAll(sketchDir, os.FileMode(0755)); err != nil {
+		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 sketchDir, sketchFile, nil
+}
+
+// NewSketch FIXMEDOC
+func NewSketch(ctx context.Context, req *rpc.NewSketchRequest) (*rpc.NewSketchResponse, error) {
+	_, sketchFile, err := CreateSketch(req.SketchName);
+        if err != nil {
+               return nil, &commands.CantCreateSketchError{Cause: err}
+        }
+
+	return &rpc.NewSketchResponse{MainFile: sketchFile}, nil
+}