Implementation of CLI 'monitor' command (#1495)

* Implementation of Monitor business logic

* Implementation of 'monitor' command of the CLI

* fix i18n

* Update commands/monitor/monitor.go

Co-authored-by: Silvano Cerza <[email protected]>

Co-authored-by: Silvano Cerza <[email protected]>

cli/monitor/monitor.go

@@ -17,6 +17,8 @@ package monitor
 
 import (
 	"context"
+	"errors"
+	"io"
 	"os"
 	"sort"
 	"strings"
@@ -78,8 +80,44 @@ func runMonitorCmd(cmd *cobra.Command, args []string) {
 		return
 	}
 
-	feedback.Error("Monitor functionality not yet implemented")
-	os.Exit(errorcodes.ErrGeneric)
+	tty, err := newStdInOutTerminal()
+	if err != nil {
+		feedback.Error(err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	defer tty.Close()
+
+	portProxy, _, err := monitor.Monitor(context.Background(), &rpc.MonitorRequest{
+		Instance: instance,
+		Port:     port.ToRPC(),
+		Fqbn:     "",
+	})
+	if err != nil {
+		feedback.Error(err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	defer portProxy.Close()
+
+	ctx, cancel := context.WithCancel(context.Background())
+	go func() {
+		_, err := io.Copy(tty, portProxy)
+		if err != nil && !errors.Is(err, io.EOF) {
+			feedback.Error(tr("Port closed:"), err)
+		}
+		cancel()
+	}()
+	go func() {
+		_, err := io.Copy(portProxy, tty)
+		if err != nil && !errors.Is(err, io.EOF) {
+			feedback.Error(tr("Port closed:"), err)
+		}
+		cancel()
+	}()
+
+	feedback.Print(tr("Connected to %s! Press CTRL-C to exit.", port.String()))
+
+	// Wait for port closed
+	<-ctx.Done()
 }
 
 type detailsResult struct {

cli/monitor/term.go

@@ -0,0 +1,39 @@
+// 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 monitor
+
+import (
+	"os"
+)
+
+type stdInOut struct {
+}
+
+func newStdInOutTerminal() (*stdInOut, error) {
+	return &stdInOut{}, nil
+}
+
+func (n *stdInOut) Close() error {
+	return nil
+}
+
+func (n *stdInOut) Read(buff []byte) (int, error) {
+	return os.Stdin.Read(buff)
+}
+
+func (n *stdInOut) Write(buff []byte) (int, error) {
+	return os.Stdout.Write(buff)
+}

commands/monitor/monitor.go

@@ -16,12 +16,85 @@
 package monitor
 
 import (
+	"context"
+	"io"
+
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
+	pluggableMonitor "github.com/arduino/arduino-cli/arduino/monitor"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
+// PortProxy is an io.ReadWriteCloser that maps into the monitor port of the board
+type PortProxy struct {
+	rw               io.ReadWriter
+	changeSettingsCB func(setting, value string) error
+	closeCB          func() error
+}
+
+func (p *PortProxy) Read(buff []byte) (int, error) {
+	return p.rw.Read(buff)
+}
+
+func (p *PortProxy) Write(buff []byte) (int, error) {
+	return p.rw.Write(buff)
+}
+
+// Config sets the port configuration setting to the specified value
+func (p *PortProxy) Config(setting, value string) error {
+	return p.changeSettingsCB(setting, value)
+}
+
+// Close the port
+func (p *PortProxy) Close() error {
+	return p.closeCB()
+}
+
+// Monitor opens a communication port. It returns a PortProxy to communicate with the port and a PortDescriptor
+// that describes the available configuration settings.
+func Monitor(ctx context.Context, req *rpc.MonitorRequest) (*PortProxy, *pluggableMonitor.PortDescriptor, error) {
+	pm := commands.GetPackageManager(req.GetInstance().GetId())
+	if pm == nil {
+		return nil, nil, &commands.InvalidInstanceError{}
+	}
+
+	monitorRef, err := findMonitorForProtocolAndBoard(pm, req.GetPort(), req.GetFqbn())
+	if err != nil {
+		return nil, nil, err
+	}
+
+	tool := pm.FindMonitorDependency(monitorRef)
+	if tool == nil {
+		return nil, nil, &commands.MonitorNotFoundError{Monitor: monitorRef.String()}
+	}
+
+	m := pluggableMonitor.New(monitorRef.Name, tool.InstallDir.Join(monitorRef.Name).String())
+
+	if err := m.Run(); err != nil {
+		return nil, nil, &commands.FailedMonitorError{Cause: err}
+	}
+
+	descriptor, err := m.Describe()
+	if err != nil {
+		return nil, nil, &commands.FailedMonitorError{Cause: err}
+	}
+
+	monIO, err := m.Open(req.GetPort())
+	if err != nil {
+		return nil, nil, &commands.FailedMonitorError{Cause: err}
+	}
+
+	return &PortProxy{
+		rw:               monIO,
+		changeSettingsCB: m.Configure,
+		closeCB: func() error {
+			m.Close()
+			return m.Quit()
+		},
+	}, descriptor, nil
+}
+
 func findMonitorForProtocolAndBoard(pm *packagemanager.PackageManager, port *rpc.Port, fqbn string) (*cores.MonitorDependency, error) {
 	if port == nil {
 		return nil, &commands.MissingPortError{}

i18n/data/en.po

@@ -423,6 +423,10 @@ msgstr "Configuring platform."
 msgid "Connected"
 msgstr "Connected"
 
+#: cli/monitor/monitor.go:117
+msgid "Connected to %s! Press CTRL-C to exit."
+msgstr "Connected to %s! Press CTRL-C to exit."
+
 #: cli/board/list.go:87
 #: cli/board/list.go:125
 msgid "Core"
@@ -496,7 +500,7 @@ msgstr "Debugging not supported for board %s"
 msgid "Debugging supported:"
 msgstr "Debugging supported:"
 
-#: cli/monitor/monitor.go:96
+#: cli/monitor/monitor.go:134
 msgid "Default"
 msgstr "Default"
 
@@ -782,7 +786,7 @@ msgstr "Error getting information for library %s"
 msgid "Error getting libraries info: %v"
 msgstr "Error getting libraries info: %v"
 
-#: cli/monitor/monitor.go:74
+#: cli/monitor/monitor.go:76
 msgid "Error getting port settings details: %s"
 msgstr "Error getting port settings details: %s"
 
@@ -1130,7 +1134,7 @@ msgstr "Global variables use {0} bytes of dynamic memory."
 
 #: cli/core/list.go:84
 #: cli/core/search.go:114
-#: cli/monitor/monitor.go:96
+#: cli/monitor/monitor.go:134
 #: cli/outdated/outdated.go:62
 msgid "ID"
 msgstr "ID"
@@ -1568,8 +1572,8 @@ msgstr "OS:"
 msgid "Official Arduino board:"
 msgstr "Official Arduino board:"
 
-#: cli/monitor/monitor.go:45
-#: cli/monitor/monitor.go:46
+#: cli/monitor/monitor.go:47
+#: cli/monitor/monitor.go:48
 msgid "Open a communication port with a board."
 msgstr "Open a communication port with a board."
 
@@ -1719,6 +1723,11 @@ msgstr "Platform size (bytes):"
 msgid "Port"
 msgstr "Port"
 
+#: cli/monitor/monitor.go:105
+#: cli/monitor/monitor.go:112
+msgid "Port closed:"
+msgstr "Port closed:"
+
 #: commands/errors.go:508
 msgid "Port monitor error"
 msgstr "Port monitor error"
@@ -1852,7 +1861,7 @@ msgstr "Sets a setting value."
 msgid "Sets where to save the configuration file."
 msgstr "Sets where to save the configuration file."
 
-#: cli/monitor/monitor.go:96
+#: cli/monitor/monitor.go:134
 msgid "Setting"
 msgstr "Setting"
 
@@ -1869,7 +1878,7 @@ msgstr "Show all available core versions."
 msgid "Show all build properties used instead of compiling."
 msgstr "Show all build properties used instead of compiling."
 
-#: cli/monitor/monitor.go:53
+#: cli/monitor/monitor.go:55
 msgid "Show all the settings of the communication port."
 msgstr "Show all the settings of the communication port."
 
@@ -2327,7 +2336,7 @@ msgstr "VERSION"
 msgid "VERSION_NUMBER"
 msgstr "VERSION_NUMBER"
 
-#: cli/monitor/monitor.go:96
+#: cli/monitor/monitor.go:134
 msgid "Values"
 msgstr "Values"