Implement debug command

Author: rsora

cli/cli.go

@@ -17,6 +17,7 @@ package cli
 
 import (
 	"fmt"
+	"github.com/arduino/arduino-cli/cli/debug"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -77,6 +78,7 @@ func createCliCommandTree(cmd *cobra.Command) {
 	cmd.AddCommand(lib.NewCommand())
 	cmd.AddCommand(sketch.NewCommand())
 	cmd.AddCommand(upload.NewCommand())
+	cmd.AddCommand(debug.NewCommand())
 	cmd.AddCommand(version.NewCommand())
 
 	cmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Print the logs on the standard output.")

cli/debug/debug.go

@@ -0,0 +1,98 @@
+// 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 license@arduino.cc.
+
+package debug
+
+import (
+	"context"
+	"os"
+
+	"github.com/arduino/arduino-cli/cli/errorcodes"
+	"github.com/arduino/arduino-cli/cli/feedback"
+	"github.com/arduino/arduino-cli/cli/instance"
+	"github.com/arduino/arduino-cli/commands/debug"
+	dbg "github.com/arduino/arduino-cli/rpc/debug"
+	"github.com/arduino/go-paths-helper"
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+var (
+	fqbn       string
+	port       string
+	verbose    bool
+	verify     bool
+	importFile string
+)
+
+// NewCommand created a new `upload` command
+func NewCommand() *cobra.Command {
+	debugCommand := &cobra.Command{
+		Use:     "debug",
+		Short:   "Debug Arduino sketches.",
+		Long:    "Debug Arduino sketches.",
+		Example: "  " + os.Args[0] + " debug /home/user/Arduino/MySketch",
+		Args:    cobra.MaximumNArgs(1),
+		Run:     run,
+	}
+
+	debugCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
+	debugCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
+	debugCommand.Flags().StringVarP(&importFile, "input", "i", "", "Input file to be uploaded.")
+
+	debugCommand.MarkFlagRequired("port")
+
+	return debugCommand
+}
+
+func run(command *cobra.Command, args []string) {
+	instance, err := instance.CreateInstance()
+	if err != nil {
+		feedback.Errorf("Error during Debug: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+
+	var path *paths.Path
+	if len(args) > 0 {
+		path = paths.New(args[0])
+	}
+	sketchPath := initSketchPath(path)
+
+	if _, err := debug.Debug(context.Background(), &dbg.DebugConfigReq{
+		Instance:   &dbg.Instance{Id: instance.GetId()},
+		Fqbn:       fqbn,
+		SketchPath: sketchPath.String(),
+		Port:       port,
+		ImportFile: importFile,
+	}, os.Stdin, os.Stdout); err != nil {
+		feedback.Errorf("Error during Upload: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+}
+
+// initSketchPath returns the current working directory
+func initSketchPath(sketchPath *paths.Path) *paths.Path {
+	if sketchPath != nil {
+		return sketchPath
+	}
+
+	wd, err := paths.Getwd()
+	if err != nil {
+		feedback.Errorf("Couldn't get current working directory: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	logrus.Infof("Reading sketch from dir: %s", wd)
+	return wd
+}

commands/daemon/debug.go

@@ -17,8 +17,9 @@ package daemon
 
 import (
 	"fmt"
-
 	cmd "github.com/arduino/arduino-cli/commands/debug"
+	"io"
+
 	dbg "github.com/arduino/arduino-cli/rpc/debug"
 )
 
@@ -42,8 +43,19 @@ func (s *DebugService) Debug(stream dbg.Debug_DebugServer) error {
 		return fmt.Errorf("first message must contain debug request, not data")
 	}
 
+	r, w := io.Pipe()
+	go func() {
+		for {
+			if command, err := stream.Recv(); err != nil {
+				return
+			} else if _, err := w.Write(command.GetData()); err != nil {
+				return
+			}
+		}
+	}()
+
 	// launch debug recipe attaching stdin and out to grpc streaming
-	resp, err := cmd.Debug(stream.Context(), req, stream, feedStream(func(data []byte) {
+	resp, err := cmd.Debug(stream.Context(), req, r, feedStream(func(data []byte) {
 		stream.Send(&dbg.DebugResp{Data: data})
 	}))
 	if err != nil {

commands/debug/debug.go

@@ -36,7 +36,7 @@ import (
 )
 
 // Debug FIXMEDOC
-func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream dbg.Debug_DebugServer, out io.Writer) (*dbg.DebugResp, error) {
+func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream io.Reader, out io.Writer) (*dbg.DebugResp, error) {
 
 	// TODO: make a generic function to extract sketch from request
 	// and remove duplication in commands/compile.go
@@ -208,14 +208,7 @@ func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream dbg.Debug_Debu
 
 	// now we can read the other commands and re-route to the Debug Client...
 	go func() {
-		for {
-			if command, err := inStream.Recv(); err != nil {
-				break
-			} else if _, err := in.Write(command.GetData()); err != nil {
-				break
-			}
-		}
-
+		io.Copy(in, inStream)
 		// In any case, try process termination after a second to avoid leaving
 		// zombie process.
 		time.Sleep(time.Second)