Replace discovery with monitor

Author: umbynos

…hub/workflows/build-dummy-discovery.yaml …ithub/workflows/build-dummy-monitor.yaml.github/workflows/build-dummy-discovery.yaml renamed to .github/workflows/build-dummy-monitor.yaml .github/workflows/build-dummy-discovery.yaml renamed to .github/workflows/build-dummy-monitor.yaml

@@ -1,4 +1,4 @@
-name: Build dummy discovery
+name: Build dummy monitor
 
 on:
   push:
@@ -26,4 +26,4 @@ jobs:
           go-version: "1.16"
 
       - name: Build
-        run: task build-dummy-discovery
+        run: task build-dummy-monitor

LICENSE.txt

@@ -1,9 +1,9 @@
-This file includes licensing information for serial-discovery
+This file includes licensing information for serial-monitor
 
 Copyright (c) 2018 ARDUINO SA (www.arduino.cc)
 
 The software is released under the GNU General Public License, which covers the main body
-of the serial-discovery code. The terms of this license can be found at:
+of the serial-monitor code. 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

Taskfile.yml

@@ -2,23 +2,23 @@ version: "3"
 
 vars:
   DIST_DIR: "dist"
-  DUMMY_DISCOVERY_VERSION:
+  DUMMY_MONITOR_VERSION:
     sh: echo "$(git describe --tags --dirty --broken)"
-  DUMMY_DISCOVERY_TIMESTAMP:
+  DUMMY_MONITOR_TIMESTAMP:
     sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
-  DUMMY_DISCOVERY_LDFLAGS: >
-    -X github.com/arduino/pluggable-discovery-protocol-handler/dummy-discovery/args.Tag={{.DUMMY_DISCOVERY_VERSION}}
-    -X github.com/arduino/pluggable-discovery-protocol-handler/dummy-discovery/args.Timestamp={{.DUMMY_DISCOVERY_TIMESTAMP}}
+  DUMMY_MONITOR_LDFLAGS: >
+    -X github.com/arduino/pluggable-monitor-protocol-handler/dummy-monitor/args.Tag={{.DUMMY_MONITOR_VERSION}}
+    -X github.com/arduino/pluggable-monitor-protocol-handler/dummy-monitor/args.Timestamp={{.DUMMY_MONITOR_TIMESTAMP}}
   DEFAULT_GO_PACKAGES:
     sh: echo $(go list ./... | tr '\n' ' ')
 
 tasks:
-  build-dummy-discovery:
-    desc: Build the dummy-discovery client example
+  build-dummy-monitor:
+    desc: Build the dummy-monitor client example
     vars:
-      EXECUTABLE: dummy-discovery{{if eq OS "windows"}}.exe{{end}}
+      EXECUTABLE: dummy-monitor{{if eq OS "windows"}}.exe{{end}}
     cmds:
-      - go build -o dist/{{.EXECUTABLE}} -v -ldflags '{{.DUMMY_DISCOVERY_LDFLAGS}}' ./dummy-discovery
+      - go build -o dist/{{.EXECUTABLE}} -v -ldflags '{{.DUMMY_MONITOR_LDFLAGS}}' ./dummy-monitor
 
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-workflows-task/Taskfile.yml
   ci:validate:

dummy-discovery/README.md dummy-monitor/README.mddummy-discovery/README.md renamed to dummy-monitor/README.md

@@ -1,5 +1,5 @@
 //
-// This file is part of dummy-discovery.
+// This file is part of dummy-monitor.
 //
 // Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
 //
@@ -35,7 +35,7 @@ func Parse() {
 			continue
 		}
 		if arg == "-v" || arg == "--version" {
-			fmt.Printf("dummy-discovery %s (build timestamp: %s)\n", Tag, Timestamp)
+			fmt.Printf("dummy-monitor %s (build timestamp: %s)\n", Tag, Timestamp)
 			os.Exit(0)
 		}
 		fmt.Fprintf(os.Stderr, "invalid argument: %s\n", arg)

dummy-discovery/args/args.go dummy-monitor/args/args.godummy-discovery/args/args.go renamed to dummy-monitor/args/args.go

@@ -1,5 +1,5 @@
 //
-// This file is part of dummy-discovery.
+// This file is part of dummy-monitor.
 //
 // Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
 //
@@ -24,23 +24,23 @@ import (
 	"time"
 
 	"github.com/arduino/go-properties-orderedmap"
-	discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2"
-	"github.com/arduino/pluggable-discovery-protocol-handler/v2/dummy-discovery/args"
+	monitor "github.com/arduino/pluggable-monitor-protocol-handler"
+	"github.com/arduino/pluggable-monitor-protocol-handler/dummy-monitor/args"
 )
 
-// dummyDiscovery is an example implementation of a Discovery.
-// It simulates a real implementation of a Discovery by generating
+// dummyMonitor is an example implementation of a Monitor.
+// It simulates a real implementation of a Monitor by generating
 // connected ports deterministically, it can also be used for testing
 // purposes.
-type dummyDiscovery struct {
+type dummyMonitor struct {
 	startSyncCount int
 	closeChan      chan<- bool
 }
 
 func main() {
 	args.Parse()
-	dummy := &dummyDiscovery{}
-	server := discovery.NewServer(dummy)
+	dummy := &dummyMonitor{}
+	server := monitor.NewServer(dummy)
 	if err := server.Run(os.Stdin, os.Stdout); err != nil {
 		os.Exit(1)
 	}
@@ -49,18 +49,39 @@ func main() {
 // Hello does nothing.
 // In a real implementation it could setup background processes
 // or other kind of resources necessary to discover Ports.
-func (d *dummyDiscovery) Hello(userAgent string, protocol int) error {
+func (d *dummyMonitor) Hello(userAgent string, protocol int) error {
 	return nil
 }
 
 // Quit does nothing.
 // In a real implementation it can be used to tear down resources
-// used to discovery Ports.
-func (d *dummyDiscovery) Quit() {}
+// used to monitor Ports.
+func (d *dummyMonitor) Quit() {}
 
+//TODO implement
+func (d *dummyMonitor) Describe() {
+
+}
+
+//TODO implement
+func (d *dummyMonitor) Configure() {
+
+}
+
+//TODO implement
+func (d *dummyMonitor) Open() {
+
+}
+
+//TODO implement
+func (d *dummyMonitor) Close() {
+
+}
+
+//TODO remove
 // Stop is used to stop the goroutine started by StartSync
 // used to discover ports.
-func (d *dummyDiscovery) Stop() error {
+func (d *dummyMonitor) Stop() error {
 	if d.closeChan != nil {
 		d.closeChan <- true
 		close(d.closeChan)
@@ -69,8 +90,9 @@ func (d *dummyDiscovery) Stop() error {
 	return nil
 }
 
+//TODO remove
 // StartSync starts the goroutine that generates fake Ports.
-func (d *dummyDiscovery) StartSync(eventCB discovery.EventCallback, errorCB discovery.ErrorCallback) error {
+func (d *dummyMonitor) StartSync(eventCB monitor.EventCallback, errorCB monitor.ErrorCallback) error {
 	d.startSyncCount++
 	if d.startSyncCount%5 == 0 {
 		return errors.New("could not start_sync every 5 times")
@@ -107,7 +129,7 @@ func (d *dummyDiscovery) StartSync(eventCB discovery.EventCallback, errorCB disc
 			case <-time.After(2 * time.Second):
 			}
 
-			eventCB("remove", &discovery.Port{
+			eventCB("remove", &monitor.Port{
 				Address:  port.Address,
 				Protocol: port.Protocol,
 			})
@@ -123,9 +145,9 @@ func (d *dummyDiscovery) StartSync(eventCB discovery.EventCallback, errorCB disc
 var dummyCounter = 0
 
 // createDummyPort creates a Port with fake data
-func createDummyPort() *discovery.Port {
+func createDummyPort() *monitor.Port {
 	dummyCounter++
-	return &discovery.Port{
+	return &monitor.Port{
 		Address:       fmt.Sprintf("%d", dummyCounter),
 		AddressLabel:  "Dummy upload port",
 		Protocol:      "dummy",

dummy-discovery/main.go dummy-monitor/main.godummy-discovery/main.go renamed to dummy-monitor/main.go

@@ -0,0 +1,11 @@
+github.com/arduino/go-paths-helper v1.0.1 h1:utYXLM2RfFlc9qp/MJTIYp3t6ux/xM6mWjeEb/WLK4Q=
+github.com/arduino/go-paths-helper v1.0.1/go.mod h1:HpxtKph+g238EJHq4geEPv9p+gl3v5YYu35Yb+w31Ck=
+github.com/arduino/go-properties-orderedmap v1.4.0 h1:YEbbzPqm1gXWDM/Jaq8tlvmh09z2qeHPJTUw9/VA4Dk=
+github.com/arduino/go-properties-orderedmap v1.4.0/go.mod h1:DKjD2VXY/NZmlingh4lSFMEYCVubfeArCsGPGDwb2yk=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=

go.sum

@@ -1,5 +1,5 @@
 //
-// This file is part of pluggable-discovery-protocol-handler.
+// This file is part of pluggable-monitor-protocol-handler.
 //
 // Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
 //
@@ -15,7 +15,7 @@
 // a commercial license, send an email to license@arduino.cc.
 //
 
-package discovery
+package monitor
 
 type message struct {
 	EventType       string   `json:"eventType"`

message.go

@@ -1,5 +1,5 @@
 //
-// This file is part of pluggable-discovery-protocol-handler.
+// This file is part of pluggable-monitor-protocol-handler.
 //
 // Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
 //
@@ -15,16 +15,16 @@
 // a commercial license, send an email to license@arduino.cc.
 //
 
-// Package discovery is a library for handling the Arduino Pluggable-Discovery protocol
-// (https://github.com/arduino/tooling-rfcs/blob/main/RFCs/0002-pluggable-discovery.md#pluggable-discovery-api-via-stdinstdout)
+// Package monitor is a library for handling the Arduino Pluggable-Monitor protocol
+// (https://github.com/arduino/tooling-rfcs/blob/main/RFCs/0004-pluggable-monitor.md#pluggable-monitor-api-via-stdinstdout)
 //
-// The library implements the state machine and the parsing logic to communicate with a pluggable-discovery client.
+// The library implements the state machine and the parsing logic to communicate with a pluggable-monitor client.
 // All the commands issued by the client are conveniently translated into function calls, in particular
-// the Discovery interface are the only functions that must be implemented to get a fully working pluggable discovery
+// the Monitor interface are the only functions that must be implemented to get a fully working pluggable monitor
 // using this library.
 //
-// A usage example is provided in the dummy-discovery package.
-package discovery
+// A usage example is provided in the dummy-monitor package.
+package monitor
 
 import (
 	"bufio"
@@ -47,44 +47,44 @@ type Port struct {
 	Properties    *properties.Map `json:"properties,omitempty"`
 }
 
-// Discovery is an interface that represents the business logic that
-// a pluggable discovery must implement. The communication protocol
-// is completely hidden and it's handled by a DiscoveryServer.
-type Discovery interface {
+// Monitor is an interface that represents the business logic that
+// a pluggable monitor must implement. The communication protocol
+// is completely hidden and it's handled by a MonitorServer.
+type Monitor interface {
 	// Hello is called once at startup to provide the userAgent string
 	// and the protocolVersion negotiated with the client.
 	Hello(userAgent string, protocolVersion int) error
 
-	// StartSync is called to put the discovery in event mode. When the
-	// function returns the discovery must send port events ("add" or "remove")
+	// StartSync is called to put the monitor in event mode. When the
+	// function returns the monitor must send port events ("add" or "remove")
 	// using the eventCB function.
 	StartSync(eventCB EventCallback, errorCB ErrorCallback) error
 
-	// Stop stops the discovery internal subroutines. If the discovery is
+	// Stop stops the monitor internal subroutines. If the monitor is
 	// in event mode it must stop sending events through the eventCB previously
 	// set.
 	Stop() error
 
 	// Quit is called just before the server terminates. This function can be
-	// used by the discovery as a last chance gracefully close resources.
+	// used by the monitor as a last chance gracefully close resources.
 	Quit()
 }
 
 // EventCallback is a callback function to call to transmit port
-// metadata when the discovery is in "sync" mode and a new event
+// metadata when the monitor is in "sync" mode and a new event
 // is detected.
 type EventCallback func(event string, port *Port)
 
 // ErrorCallback is a callback function to signal unrecoverable errors to the
-// client while the discovery is in event mode. Once the discovery signal an
+// client while the monitor is in event mode. Once the monitor signal an
 // error it means that no more port-events will be delivered until the client
 // performs a STOP+START_SYNC cycle.
 type ErrorCallback func(err string)
 
-// A Server is a pluggable discovery protocol handler,
+// A Server is a pluggable monitor protocol handler,
 // it must be created using the NewServer function.
 type Server struct {
-	impl               Discovery
+	impl               Monitor
 	outputChan         chan *message
 	userAgent          string
 	reqProtocolVersion int
@@ -95,10 +95,10 @@ type Server struct {
 	cachedErr          string
 }
 
-// NewServer creates a new discovery server backed by the
-// provided pluggable discovery implementation. To start the server
+// NewServer creates a new monitor server backed by the
+// provided pluggable monitor implementation. To start the server
 // use the Run method.
-func NewServer(impl Discovery) *Server {
+func NewServer(impl Monitor) *Server {
 	return &Server{
 		impl:       impl,
 		outputChan: make(chan *message),
@@ -182,11 +182,11 @@ func (d *Server) hello(cmd string) {
 
 func (d *Server) start() {
 	if d.started {
-		d.outputChan <- messageError("start", "Discovery already STARTed")
+		d.outputChan <- messageError("start", "Monitor already STARTed")
 		return
 	}
 	if d.syncStarted {
-		d.outputChan <- messageError("start", "Discovery already START_SYNCed, cannot START")
+		d.outputChan <- messageError("start", "Monitor already START_SYNCed, cannot START")
 		return
 	}
 	d.cachedPorts = map[string]*Port{}
@@ -215,11 +215,11 @@ func (d *Server) errorCallback(msg string) {
 
 func (d *Server) list() {
 	if !d.started {
-		d.outputChan <- messageError("list", "Discovery not STARTed")
+		d.outputChan <- messageError("list", "Monitor not STARTed")
 		return
 	}
 	if d.syncStarted {
-		d.outputChan <- messageError("list", "discovery already START_SYNCed, LIST not allowed")
+		d.outputChan <- messageError("list", "monitor already START_SYNCed, LIST not allowed")
 		return
 	}
 	if d.cachedErr != "" {
@@ -238,11 +238,11 @@ func (d *Server) list() {
 
 func (d *Server) startSync() {
 	if d.syncStarted {
-		d.outputChan <- messageError("start_sync", "Discovery already START_SYNCed")
+		d.outputChan <- messageError("start_sync", "Monitor already START_SYNCed")
 		return
 	}
 	if d.started {
-		d.outputChan <- messageError("start_sync", "Discovery already STARTed, cannot START_SYNC")
+		d.outputChan <- messageError("start_sync", "Monitor already STARTed, cannot START_SYNC")
 		return
 	}
 	if err := d.impl.StartSync(d.syncEvent, d.errorEvent); err != nil {
@@ -255,7 +255,7 @@ func (d *Server) startSync() {
 
 func (d *Server) stop() {
 	if !d.syncStarted && !d.started {
-		d.outputChan <- messageError("stop", "Discovery already STOPped")
+		d.outputChan <- messageError("stop", "Monitor already STOPped")
 		return
 	}
 	if err := d.impl.Stop(); err != nil {

discovery.go monitor.godiscovery.go renamed to monitor.go

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "pluggable-discovery-protocol-handler"
+name = "pluggable-monitor-protocol-handler"
 version = "0.1.0"
 description = ""
 authors = ["Your Name <you@example.com>"]