Added --timestamp option to monitor command. (#2336)

internal/cli/monitor/monitor.go

@@ -24,6 +24,7 @@ import (
 	"os"
 	"sort"
 	"strings"
+	"time"
 
 	"github.com/arduino/arduino-cli/commands/monitor"
 	"github.com/arduino/arduino-cli/configuration"
@@ -44,12 +45,13 @@ var tr = i18n.Tr
 // NewCommand created a new `monitor` command
 func NewCommand() *cobra.Command {
 	var (
-		raw      bool
-		portArgs arguments.Port
-		describe bool
-		configs  []string
-		quiet    bool
-		fqbn     arguments.Fqbn
+		raw       bool
+		portArgs  arguments.Port
+		describe  bool
+		configs   []string
+		quiet     bool
+		timestamp bool
+		fqbn      arguments.Fqbn
 	)
 	monitorCommand := &cobra.Command{
 		Use:   "monitor",
@@ -59,20 +61,21 @@ func NewCommand() *cobra.Command {
 			"  " + os.Args[0] + " monitor -p /dev/ttyACM0\n" +
 			"  " + os.Args[0] + " monitor -p /dev/ttyACM0 --describe",
 		Run: func(cmd *cobra.Command, args []string) {
-			runMonitorCmd(&portArgs, &fqbn, configs, describe, quiet, raw)
+			runMonitorCmd(&portArgs, &fqbn, configs, describe, timestamp, quiet, raw)
 		},
 	}
 	portArgs.AddToCommand(monitorCommand)
 	monitorCommand.Flags().BoolVar(&raw, "raw", false, tr("Set terminal in raw mode (unbuffered)."))
 	monitorCommand.Flags().BoolVar(&describe, "describe", false, tr("Show all the settings of the communication port."))
 	monitorCommand.Flags().StringSliceVarP(&configs, "config", "c", []string{}, tr("Configure communication port settings. The format is <ID>=<value>[,<ID>=<value>]..."))
 	monitorCommand.Flags().BoolVarP(&quiet, "quiet", "q", false, tr("Run in silent mode, show only monitor input and output."))
+	monitorCommand.Flags().BoolVar(&timestamp, "timestamp", false, tr("Timestamp each incoming line."))
 	fqbn.AddToCommand(monitorCommand)
 	monitorCommand.MarkFlagRequired("port")
 	return monitorCommand
 }
 
-func runMonitorCmd(portArgs *arguments.Port, fqbn *arguments.Fqbn, configs []string, describe, quiet, raw bool) {
+func runMonitorCmd(portArgs *arguments.Port, fqbn *arguments.Fqbn, configs []string, describe, timestamp, quiet, raw bool) {
 	instance := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli monitor`")
 
@@ -160,6 +163,10 @@ func runMonitorCmd(portArgs *arguments.Port, fqbn *arguments.Fqbn, configs []str
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
 
+	if timestamp {
+		ttyOut = newTimeStampWriter(ttyOut)
+	}
+
 	ctx, cancel := cleanup.InterruptableContext(context.Background())
 	if raw {
 		feedback.SetRawModeStdin()
@@ -241,3 +248,35 @@ func contains(s []string, searchterm string) bool {
 	}
 	return false
 }
+
+type timeStampWriter struct {
+	writer            io.Writer
+	sendTimeStampNext bool
+}
+
+func newTimeStampWriter(writer io.Writer) *timeStampWriter {
+	return &timeStampWriter{
+		writer:            writer,
+		sendTimeStampNext: true,
+	}
+}
+
+func (t *timeStampWriter) Write(p []byte) (int, error) {
+	written := 0
+	for _, b := range p {
+		if t.sendTimeStampNext {
+			_, err := t.writer.Write([]byte(time.Now().Format("[2006-01-02 15:04:05] ")))
+			if err != nil {
+				return written, err
+			}
+			t.sendTimeStampNext = false
+		}
+		n, err := t.writer.Write([]byte{b})
+		written += n
+		if err != nil {
+			return written, err
+		}
+		t.sendTimeStampNext = b == '\n'
+	}
+	return written, nil
+}

internal/cli/monitor/monitor_test.go

@@ -0,0 +1,37 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2023 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 monitor
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestTimeStampWriter(t *testing.T) {
+	buf := &bytes.Buffer{}
+	writer := newTimeStampWriter(buf)
+
+	writer.Write([]byte("foo"))
+	// The first received bytes get a timestamp prepended
+	require.Regexp(t, `^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] foo$`, buf)
+
+	buf.Reset()
+	writer.Write([]byte("\nbar\n"))
+	// A timestamp should be inserted before the first char of the next line
+	require.Regexp(t, "^\n"+`\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] bar`+"\n$", buf)
+}