Introduce arduino-cli commands (#7)

* Wrap arduino-cli commands into a client

* Implement grpc client for arduino-cli commands

* Rename arduino interface Client to Commander

* Implement binary upload

Author: Paolo Calao

arduino/commander.go

@@ -0,0 +1,13 @@
+package arduino
+
+import (
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+)
+
+// Commander of arduino package allows to call
+// the arduino-cli commands in a programmatic way
+type Commander interface {
+	BoardList() ([]*rpc.DetectedPort, error)
+	UploadBin(fqbn, path, port string) error
+	Compile() error
+}

arduino/grpc/board.go

@@ -0,0 +1,26 @@
+package grpc
+
+import (
+	"context"
+	"fmt"
+
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+)
+
+type boardHandler struct {
+	*service
+}
+
+// BoardList executes the 'arduino-cli board list' command
+// and returns its result.
+func (b boardHandler) BoardList() ([]*rpc.DetectedPort, error) {
+	boardListResp, err := b.serviceClient.BoardList(context.Background(),
+		&rpc.BoardListRequest{Instance: b.instance})
+
+	if err != nil {
+		err = fmt.Errorf("%s: %w", "Board list error", err)
+		return nil, err
+	}
+
+	return boardListResp.GetPorts(), nil
+}

arduino/grpc/client.go

@@ -0,0 +1,97 @@
+package grpc
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"time"
+
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/arduino/arduino-cli/rpc/cc/arduino/cli/settings/v1"
+	"github.com/bcmi-labs/iot-cloud-cli/arduino"
+	"google.golang.org/grpc"
+)
+
+type service struct {
+	serviceClient  rpc.ArduinoCoreServiceClient
+	settingsClient settings.SettingsServiceClient
+	instance       *rpc.Instance
+}
+
+type client struct {
+	boardHandler
+	compileHandler
+}
+
+// NewClient instantiates and returns a new grpc client that allows to
+// programmatically call arduino-cli commands.
+// It exploits the grpc interface of the arduino-cli.
+// It returns: the client instance, a callback to close the client and an error
+func NewClient() (arduino.Commander, func() error, error) {
+	// Establish a connection with the gRPC server, started with the command:
+	// arduino-cli daemon
+	conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure(), grpc.WithBlock(), grpc.WithTimeout(time.Second))
+	if err != nil {
+		err = fmt.Errorf("%s: %w", "cannot connect to arduino-cli rpc server, you can start it by running `arduino-cli daemon`", err)
+		return nil, func() error { return nil }, err
+	}
+
+	serv := &service{}
+	// Create an instance of the gRPC clients.
+	serv.serviceClient = rpc.NewArduinoCoreServiceClient(conn)
+	serv.settingsClient = settings.NewSettingsServiceClient(conn)
+	serv.instance, err = initInstance(serv.serviceClient)
+	if err != nil {
+		conn.Close()
+		err = fmt.Errorf("%s: %w", "creating arduino-cli instance", err)
+		return nil, func() error { return nil }, err
+	}
+
+	cl := &client{}
+	cl.boardHandler = boardHandler{serv}
+	cl.compileHandler = compileHandler{serv}
+
+	return cl, conn.Close, nil
+}
+
+func initInstance(client rpc.ArduinoCoreServiceClient) (*rpc.Instance, error) {
+	initRespStream, err := client.Init(context.Background(), &rpc.InitRequest{})
+	if err != nil {
+		err = fmt.Errorf("%s: %w", "Error creating server instance", err)
+		return nil, err
+	}
+
+	var instance *rpc.Instance
+	// Loop and consume the server stream until all the setup procedures are done.
+	for {
+		initResp, err := initRespStream.Recv()
+		// The server is done.
+		if err == io.EOF {
+			break
+		}
+
+		// There was an error.
+		if err != nil {
+			err = fmt.Errorf("%s: %w", "init error", err)
+			return nil, err
+		}
+
+		// The server sent us a valid instance, let's print its ID.
+		if initResp.GetInstance() != nil {
+			instance = initResp.GetInstance()
+			//fmt.Printf("Got a new instance with ID: %v", instance.GetId())
+		}
+
+		// When a download is ongoing, log the progress
+		if initResp.GetDownloadProgress() != nil {
+			fmt.Printf("DOWNLOAD: %s", initResp.GetDownloadProgress())
+		}
+
+		// When an overall task is ongoing, log the progress
+		if initResp.GetTaskProgress() != nil {
+			fmt.Printf("TASK: %s", initResp.GetTaskProgress())
+		}
+	}
+
+	return instance, nil
+}

arduino/grpc/compile.go

@@ -0,0 +1,57 @@
+package grpc
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"path/filepath"
+
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+)
+
+type compileHandler struct {
+	*service
+}
+
+// Compile executes the 'arduino-cli compile' command
+// and returns its result.
+func (c compileHandler) Compile() error {
+	return nil
+}
+
+// Upload executes the 'arduino-cli upload -i' command
+// and returns its result.
+func (c compileHandler) UploadBin(fqbn, bin, port string) error {
+	stream, err := c.serviceClient.Upload(context.Background(),
+		&rpc.UploadRequest{
+			Instance:   c.instance,
+			Fqbn:       fqbn,
+			SketchPath: filepath.Dir(bin),
+			ImportFile: bin,
+			Port:       port,
+			Verbose:    true,
+		})
+
+	if err != nil {
+		err = fmt.Errorf("%s: %w", "uploading", err)
+		return err
+	}
+
+	// Wait for the upload to complete
+	for {
+		resp, err := stream.Recv()
+		if err != nil {
+			if err == io.EOF {
+				break
+			}
+			err = fmt.Errorf("%s: %w", "errors during upload", err)
+			return err
+		}
+		if resp.ErrStream != nil {
+			err = fmt.Errorf("%s: %w", "errors during upload", err)
+			return err
+		}
+	}
+
+	return nil
+}

go.mod

@@ -3,11 +3,16 @@ module github.com/bcmi-labs/iot-cloud-cli
 go 1.15
 
 require (
+	github.com/arduino/arduino-cli v0.0.0-20210607095659-16f41352eac3
 	github.com/bcmi-labs/oniudra-cli v0.15.8
 	github.com/eclipse/paho.mqtt.golang v1.3.2
 	github.com/juju/errors v0.0.0-20200330140219-3fe23663418f
 	github.com/sirupsen/logrus v1.8.1
 	github.com/spf13/cobra v1.1.3
+	golang.org/x/net v0.0.0-20210505024714-0287a6fb4125 // indirect
+	golang.org/x/sys v0.0.0-20210503173754-0981d6026fa6 // indirect
+	google.golang.org/genproto v0.0.0-20210504143626-3b2ad6ccc450 // indirect
+	google.golang.org/grpc v1.39.0
 )
 
 replace github.com/cisco/senml => github.com/bcmi-labs/senml v0.1.0