Added SetSketchDefaults gRPC call

This allows to finally remove wrong access to `sketch.Sketch` from `cli`
package.

Author: cmaglie

arduino/errors.go

@@ -516,6 +516,19 @@ func (e *CantCreateSketchError) Unwrap() error {
 	return e.Cause
 }
 
+// CantUpdateSketchError is returned when the sketch cannot be updated
+type CantUpdateSketchError struct {
+	Cause error
+}
+
+func (e *CantUpdateSketchError) Error() string {
+	return composeErrorMsg(tr("Can't update sketch"), e.Cause)
+}
+
+func (e *CantUpdateSketchError) Unwrap() error {
+	return e.Cause
+}
+
 // CantOpenSketchError is returned when the sketch is not found or cannot be opened
 type CantOpenSketchError struct {
 	Cause error

commands/daemon/daemon.go

@@ -202,6 +202,12 @@ func (s *ArduinoCoreServerImpl) LoadSketch(ctx context.Context, req *rpc.LoadSke
 	return resp, convertErrorToRPCStatus(err)
 }
 
+// SetSketchDefaults FIXMEDOC
+func (s *ArduinoCoreServerImpl) SetSketchDefaults(ctx context.Context, req *rpc.SetSketchDefaultsRequest) (*rpc.SetSketchDefaultsResponse, error) {
+	resp, err := sketch.SetSketchDefaults(ctx, req)
+	return resp, convertErrorToRPCStatus(err)
+}
+
 // Compile FIXMEDOC
 func (s *ArduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.ArduinoCoreService_CompileServer) error {
 	syncSend := NewSynchronizedSend(stream.Send)

commands/sketch/set_defaults.go

@@ -0,0 +1,57 @@
+// 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"
+
+	"github.com/arduino/arduino-cli/arduino"
+	"github.com/arduino/arduino-cli/arduino/sketch"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	paths "github.com/arduino/go-paths-helper"
+)
+
+// SetSketchDefaults updates the sketch project file (sketch.yaml) with the given defaults
+// for the values `default_fqbn`, `default_port`, and `default_protocol`.
+func SetSketchDefaults(ctx context.Context, req *rpc.SetSketchDefaultsRequest) (*rpc.SetSketchDefaultsResponse, error) {
+	sk, err := sketch.New(paths.New(req.SketchPath))
+	if err != nil {
+		return nil, &arduino.CantOpenSketchError{Cause: err}
+	}
+
+	oldAddress, oldProtocol := sk.GetDefaultPortAddressAndProtocol()
+	res := &rpc.SetSketchDefaultsResponse{
+		DefaultFqbn:         sk.GetDefaultFQBN(),
+		DefaultPortAddress:  oldAddress,
+		DefaultPortProtocol: oldProtocol,
+	}
+
+	if fqbn := req.GetDefaultFqbn(); fqbn != "" {
+		if err := sk.SetDefaultFQBN(fqbn); err != nil {
+			return nil, &arduino.CantUpdateSketchError{Cause: err}
+		}
+		res.DefaultFqbn = fqbn
+	}
+	if newAddress, newProtocol := req.GetDefaultPortAddress(), req.GetDefaultPortProtocol(); newAddress != "" {
+		if err := sk.SetDefaultPort(newAddress, newProtocol); err != nil {
+			return nil, &arduino.CantUpdateSketchError{Cause: err}
+		}
+		res.DefaultPortAddress = newAddress
+		res.DefaultPortProtocol = newProtocol
+	}
+
+	return res, nil
+}

internal/cli/arguments/sketch.go

@@ -42,16 +42,6 @@ func InitSketchPath(path string) (sketchPath *paths.Path) {
 	return sketchPath
 }
 
-// NewSketch is a helper function useful to create a sketch instance
-// TODO: Remove this function, we should not access sketch:Sketch directly
-func NewSketch(sketchPath *paths.Path) *sketch.Sketch {
-	sketch, err := sketch.New(sketchPath)
-	if err != nil {
-		feedback.Fatal(tr("Error opening sketch: %v", err), feedback.ErrGeneric)
-	}
-	return sketch
-}
-
 // WarnDeprecatedFiles warns the user that a type of sketch files are deprecated
 func WarnDeprecatedFiles(sketchPath *paths.Path) {
 	// .pde files are still supported but deprecated, this warning urges the user to rename them

internal/cli/board/attach.go

@@ -16,11 +16,14 @@
 package board
 
 import (
+	"context"
 	"fmt"
 	"os"
 
+	"github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/spf13/cobra"
 )
 
@@ -51,39 +54,28 @@ func initAttachCommand() *cobra.Command {
 
 func runAttachCommand(path string, port *arguments.Port, fqbn string) {
 	sketchPath := arguments.InitSketchPath(path)
-	sk := arguments.NewSketch(sketchPath)
 
-	var currentPort *boardAttachPortResult
-	if currentAddress, currentProtocol := sk.GetDefaultPortAddressAndProtocol(); currentAddress != "" {
-		currentPort = &boardAttachPortResult{
-			Address:  currentAddress,
-			Protocol: currentProtocol,
-		}
-	}
-	current := &boardAttachResult{
-		Port: currentPort,
-		Fqbn: sk.GetDefaultFQBN(),
+	portAddress, portProtocol, _ := port.GetPortAddressAndProtocol(nil, "", "")
+	newDefaults, err := sketch.SetSketchDefaults(context.Background(), &rpc.SetSketchDefaultsRequest{
+		SketchPath:          sketchPath.String(),
+		DefaultFqbn:         fqbn,
+		DefaultPortAddress:  portAddress,
+		DefaultPortProtocol: portProtocol,
+	})
+	if err != nil {
+		feedback.FatalError(err, feedback.ErrGeneric)
 	}
 
-	defaultAddress, defaultProtocol := sk.GetDefaultPortAddressAndProtocol()
-	address, protocol, _ := port.GetPortAddressAndProtocol(nil, defaultAddress, defaultProtocol)
-	if address != "" {
-		if err := sk.SetDefaultPort(address, protocol); err != nil {
-			feedback.Fatal(fmt.Sprintf("%s: %s", tr("Error saving sketch metadata"), err), feedback.ErrGeneric)
-		}
-		current.Port = &boardAttachPortResult{
-			Address:  address,
-			Protocol: protocol,
-		}
+	res := &boardAttachResult{
+		Fqbn: newDefaults.GetDefaultFqbn(),
 	}
-	if fqbn != "" {
-		if err := sk.SetDefaultFQBN(fqbn); err != nil {
-			feedback.Fatal(fmt.Sprintf("%s: %s", tr("Error saving sketch metadata"), err), feedback.ErrGeneric)
+	if newDefaults.GetDefaultPortAddress() != "" {
+		res.Port = &boardAttachPortResult{
+			Address:  newDefaults.GetDefaultPortAddress(),
+			Protocol: newDefaults.GetDefaultPortProtocol(),
 		}
-		current.Fqbn = fqbn
 	}
-
-	feedback.PrintResult(current)
+	feedback.PrintResult(res)
 }
 
 type boardAttachPortResult struct {

internal/integrationtest/board/board_test.go

@@ -510,23 +510,55 @@ func TestBoardSearch(t *testing.T) {
 	]`)
 }
 
-func TestBoardAttachWithoutSketchJson(t *testing.T) {
+func TestBoardAttach(t *testing.T) {
 	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
 	defer env.CleanUp()
 
-	_, _, err := cli.Run("update")
-	require.NoError(t, err)
-
-	sketchName := "BoardAttachWithoutSketchJson"
+	sketchName := "BoardAttach"
 	sketchPath := cli.SketchbookDir().Join(sketchName)
-	fqbn := "arduino:avr:uno"
+	sketchProjectFlie := sketchPath.Join("sketch.yaml")
 
 	// Create a test sketch
-	_, _, err = cli.Run("sketch", "new", sketchPath.String())
+	_, _, err := cli.Run("sketch", "new", sketchPath.String())
 	require.NoError(t, err)
 
-	_, _, err = cli.Run("board", "attach", "-b", fqbn, sketchPath.String())
-	require.NoError(t, err)
+	{
+		stdout, _, err := cli.Run("board", "attach", "-b", "arduino:avr:uno", sketchPath.String(), "--format", "json")
+		require.NoError(t, err)
+		requirejson.Query(t, stdout, ".fqbn", `"arduino:avr:uno"`)
+
+		yamlData, err := sketchProjectFlie.ReadFile()
+		require.NoError(t, err)
+		require.Contains(t, string(yamlData), "default_fqbn: arduino:avr:uno")
+		require.NotContains(t, string(yamlData), "default_port:")
+		require.NotContains(t, string(yamlData), "default_protocol:")
+	}
+	{
+		stdout, _, err := cli.Run("board", "attach", "-p", "/dev/ttyACM0", "-l", "serial", sketchPath.String(), "--format", "json")
+		require.NoError(t, err)
+		requirejson.Query(t, stdout, ".fqbn", `"arduino:avr:uno"`)
+		requirejson.Query(t, stdout, ".port.address", `"/dev/ttyACM0"`)
+		requirejson.Query(t, stdout, ".port.protocol", `"serial"`)
+
+		yamlData, err := sketchProjectFlie.ReadFile()
+		require.NoError(t, err)
+		require.Contains(t, string(yamlData), "default_fqbn: arduino:avr:uno")
+		require.Contains(t, string(yamlData), "default_port: /dev/ttyACM0")
+		require.Contains(t, string(yamlData), "default_protocol: serial")
+	}
+	{
+		stdout, _, err := cli.Run("board", "attach", "-p", "/dev/ttyACM0", sketchPath.String(), "--format", "json")
+		require.NoError(t, err)
+		requirejson.Query(t, stdout, ".fqbn", `"arduino:avr:uno"`)
+		requirejson.Query(t, stdout, ".port.address", `"/dev/ttyACM0"`)
+		requirejson.Query(t, stdout, ".port.protocol", `null`)
+
+		yamlData, err := sketchProjectFlie.ReadFile()
+		require.NoError(t, err)
+		require.Contains(t, string(yamlData), "default_fqbn: arduino:avr:uno")
+		require.Contains(t, string(yamlData), "default_port: /dev/ttyACM0")
+		require.NotContains(t, string(yamlData), "default_protocol:")
+	}
 }
 
 func TestBoardSearchWithOutdatedCore(t *testing.T) {