add Attach command stream support

Author: Rocketct

cli/board/attach.go

@@ -59,11 +59,11 @@ func runAttachCommand(cmd *cobra.Command, args []string) {
 	}
 	_, err := board.BoardAttach(context.Background(), &rpc.BoardAttachReq{
 		Instance:      instance,
-		BoardURI:      args[0],
+		BoardUri:      args[0],
 		SketchPath:    path,
 		BoardFlavour:  attachFlags.boardFlavour,
 		SearchTimeout: attachFlags.searchTimeout,
-	})
+	}, cli.OutputTaskProgress())
 	if err != nil {
 		formatter.PrintError(err, "attach board error")
 		os.Exit(cli.ErrGeneric)

commands/board/attach.go

@@ -29,13 +29,12 @@ import (
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/sketches"
 	"github.com/arduino/arduino-cli/commands"
-	"github.com/arduino/arduino-cli/common/formatter"
 	"github.com/arduino/arduino-cli/rpc"
 	discovery "github.com/arduino/board-discovery"
 	paths "github.com/arduino/go-paths-helper"
 )
 
-func BoardAttach(ctx context.Context, req *rpc.BoardAttachReq) (*rpc.BoardAttachResp, error) {
+func BoardAttach(ctx context.Context, req *rpc.BoardAttachReq, taskCB commands.TaskProgressCB) (*rpc.BoardAttachResp, error) {
 
 	pm := commands.GetPackageManager(req)
 	if pm == nil {
@@ -49,10 +48,8 @@ func BoardAttach(ctx context.Context, req *rpc.BoardAttachReq) (*rpc.BoardAttach
 	if err != nil {
 		return nil, fmt.Errorf("opening sketch: %s", err)
 	}
-	if sketch.Metadata == nil {
-		formatter.Print("sketch errrorrrerereererer")
-	}
-	boardURI := req.GetBoardURI()
+
+	boardURI := req.GetBoardUri()
 	fqbn, err := cores.ParseFQBN(boardURI)
 	if err != nil && !strings.HasPrefix(boardURI, "serial") {
 		boardURI = "serial://" + boardURI
@@ -80,7 +77,6 @@ func BoardAttach(ctx context.Context, req *rpc.BoardAttachReq) (*rpc.BoardAttach
 
 		duration, err := time.ParseDuration(req.GetSearchTimeout())
 		if err != nil {
-			//logrus.WithError(err).Warnf("Invalid interval `%s` provided, using default (5s).", req.GetSearchTimeout())
 			duration = time.Second * 5
 		}
 
@@ -94,8 +90,10 @@ func BoardAttach(ctx context.Context, req *rpc.BoardAttachReq) (*rpc.BoardAttach
 		if board == nil {
 			return nil, fmt.Errorf("no supported board found at %s", deviceURI.String())
 		}
-		formatter.Print("Board found: " + board.Name())
+		taskCB(&rpc.TaskProgress{Name: "Board found: " + board.Name()})
 
+		// TODO: should be stoped the monitor: when running as a pure CLI  is released
+		// by the OS, when run as daemon the resource's state is unknown and could be leaked.
 		sketch.Metadata.CPU = sketches.BoardMetadata{
 			Fqbn: board.FQBN(),
 			Name: board.Name(),
@@ -104,14 +102,9 @@ func BoardAttach(ctx context.Context, req *rpc.BoardAttachReq) (*rpc.BoardAttach
 
 	err = sketch.ExportMetadata()
 	if err != nil {
-<<<<<<< HEAD
 		return nil, fmt.Errorf("cannot export sketch metadata: %s", err)
-=======
-		formatter.PrintError(err, "Cannot export sketch metadata.")
-		os.Exit(commands.ErrGeneric)
->>>>>>> 5358b8ed08945f8db0242c77427e79e44f03c7d9
 	}
-	formatter.PrintResult("Selected fqbn: " + sketch.Metadata.CPU.Fqbn)
+	taskCB(&rpc.TaskProgress{Name: "Selected fqbn: " + sketch.Metadata.CPU.Fqbn, Completed: true})
 	return &rpc.BoardAttachResp{}, nil
 }
 

daemon/client/client.go

@@ -88,7 +88,7 @@ func main() {
 	fmt.Println("=== calling PlatformSearch(samd)")
 	searchResp, err := client.PlatformSearch(context.Background(), &rpc.PlatformSearchReq{
 		Instance:   instance,
-		SearchArgs: "samd",
+		SearchArgs: "uno",
 	})
 	if err != nil {
 		fmt.Printf("Search error: %s\n", err)
@@ -196,15 +196,30 @@ func main() {
 
 	// BOARDS ATTACH
 	fmt.Println("=== calling BoardAttach(serial:///dev/ttyACM0)")
-	_, err = client.BoardAttach(context.Background(), &rpc.BoardAttachReq{
+	boardattachresp, err := client.BoardAttach(context.Background(), &rpc.BoardAttachReq{
 		Instance:   instance,
-		BoardURI:   "serial:///dev/ttyACM0",
-		SketchPath: "/home/riccardo/Arduino/MyFirstSketch",
+		BoardUri:   "/dev/ttyACM0",
+		SketchPath: os.Args[2],
 	})
 	if err != nil {
-		fmt.Printf("attach error : %s\n", err)
+		fmt.Printf("Attach error: %s\n", err)
 		os.Exit(1)
 	}
+	for {
+		attachResp, err := boardattachresp.Recv()
+		if err == io.EOF {
+			fmt.Printf("---> %+v\n", attachResp)
+			fmt.Println()
+			break
+		}
+		if err != nil {
+			fmt.Printf("Attach error: %s\n", err)
+			os.Exit(1)
+		}
+		if attachResp.GetTaskProgress() != nil {
+			fmt.Printf(">> TASK: %s\n", attachResp.GetTaskProgress())
+		}
+	}
 
 	// COMPILE
 	fmt.Println("=== calling Compile(arduino:samd:mkr1000, VERBOSE, " + os.Args[2] + ")")

daemon/daemon.go

@@ -60,8 +60,15 @@ func (s *ArduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.Board
 	return board.BoardDetails(ctx, req)
 }
 
-func (s *ArduinoCoreServerImpl) BoardAttach(ctx context.Context, req *rpc.BoardAttachReq) (*rpc.BoardAttachResp, error) {
-	return board.BoardAttach(ctx, req)
+func (s *ArduinoCoreServerImpl) BoardAttach(req *rpc.BoardAttachReq, stream rpc.ArduinoCore_BoardAttachServer) error {
+
+	resp, err := board.BoardAttach(stream.Context(), req,
+		func(p *rpc.TaskProgress) { stream.Send(&rpc.BoardAttachResp{TaskProgress: p}) },
+	)
+	if err != nil {
+		return err
+	}
+	return stream.Send(resp)
 }
 
 func (s *ArduinoCoreServerImpl) Destroy(ctx context.Context, req *rpc.DestroyReq) (*rpc.DestroyResp, error) {

rpc/board.pb.go

@@ -54,11 +54,12 @@ message RequiredTool {
 
 message BoardAttachReq {
   Instance instance = 1;
-  string boardURI = 2;
-  string sketchPath = 3;
-  string boardFlavour = 4;
-  string searchTimeout = 5;
+  string board_uri = 2;
+  string sketch_path = 3;
+  string board_flavour = 4;
+  string search_timeout = 5;
 }
 
 message BoardAttachResp {
+  TaskProgress task_progress = 1;
 }