8000 [pluggable monitor] various minor refactors by cmaglie · Pull Request #1501 · arduino/arduino-cli · GitHub
[go: up one dir, main page]
Skip to content

[pluggable monitor] various minor refactors #1501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 8, 2021
Merged

[pluggable monitor] various minor refactors #1501

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c8b2d00
Factored pluggable monitor creation
cmaglie Oct 7, 2021
4d70ace
Factored out code duplication
cmaglie Oct 8, 2021
280d936
EnumerateMonitorPortSettings does require only protocol
cmaglie Oct 8, 2021
592ae78
Monitor.Open does require only address and protocol
cmaglie Oct 8, 2021
945f67e
Added GetPortAddressAndProtocol helper
cmaglie Oct 8, 2021
4d0cb19
fix i18n
cmaglie Oct 8, 2021
168a316
Apply suggestions from code review
cmaglie Oct 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Monitor.Open does require only address and protocol
  • Loading branch information
@cmaglie
cmaglie committed Oct 8, 2021
commit 592ae788cfa2feaa85b6c6e62913de525a30d5ea
9 changes: 4 additions & 5 deletions arduino/monitor/monitor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import (
"github.com/arduino/arduino-cli/cli/globals"
"github.com/arduino/arduino-cli/executils"
"github.com/arduino/arduino-cli/i18n"
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
"github.com/sirupsen/logrus"
)

Expand Down Expand Up @@ -264,9 +263,9 @@ func (mon *PluggableMonitor) Configure(param, value string) error {
}

// Open connects to the given Port. A communication channel is opened
func (mon *PluggableMonitor) Open(port *rpc.Port) (io.ReadWriter, error) {
if port.Protocol != mon.supportedProtocol {
return nil, fmt.Errorf("invalid monitor protocol '%s': only '%s' is accepted", port.Protocol, mon.supportedProtocol)
func (mon *PluggableMonitor) Open(portAddress, portProtocol string) (io.ReadWriter, error) {
if portProtocol != mon.supportedProtocol {
return nil, fmt.Errorf("invalid monitor protocol '%s': only '%s' is accepted", portProtocol, mon.supportedProtocol)
}

tcpListener, err := net.Listen("tcp", "127.0.0.1:")
Expand All @@ -276,7 +275,7 @@ func (mon *PluggableMonitor) Open(port *rpc.Port) (io.ReadWriter, error) {
defer tcpListener.Close()
tcpListenerPort := tcpListener.Addr().(*net.TCPAddr).Port

if err := mon.sendCommand(fmt.Sprintf("OPEN 127.0.0.1:%d %s\n", tcpListenerPort, port.Address)); err != nil {
if err := mon.sendCommand(fmt.Sprintf("OPEN 127.0.0.1:%d %s\n", tcpListenerPort, portAddress)); err != nil {
return nil, err
}
if _, err := mon.waitMessage(time.Second*10, "open"); err != nil {
Expand Down
8 changes: 3 additions & 5 deletions arduino/monitor/monitor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (
"testing"
"time"

"github.com/arduino/arduino-cli/arduino/discovery"
"github.com/arduino/arduino-cli/executils"
"github.com/arduino/go-paths-helper"
"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -59,12 +58,11 @@ func TestDummyMonitor(t *testing.T) {
err = mon.Configure("speed", "38400")
require.NoError(t, err)

port := &discovery.Port{Address: "/dev/ttyACM0", Protocol: "test"}
rw, err := mon.Open(port.ToRPC())
rw, err := mon.Open("/dev/ttyACM0", "test")
require.NoError(t, err)

// Double open -> error: port already opened
_, err = mon.Open(port.ToRPC())
_, err = mon.Open("/dev/ttyACM0", "test")
require.Error(t, err)

// Write "TEST"
Expand Down Expand Up @@ -93,7 +91,7 @@ func TestDummyMonitor(t *testing.T) {
time.Sleep(100 * time.Millisecond)
require.Equal(t, int32(1), atomic.LoadInt32(&completed))

rw, err = mon.Open(port.ToRPC())
rw, err = mon.Open("/dev/ttyACM0", "test")
require.NoError(t, err)
n, err = rw.Write([]byte("TEST"))
require.NoError(t, err)
Expand Down
2 changes: 1 addition & 1 deletion commands/monitor/monitor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func Monitor(ctx context.Context, req *rpc.MonitorRequest) (*PortProxy, *pluggab
return nil, nil, &commands.FailedMonitorError{Cause: err}
}

monIO, err := m.Open(req.GetPort())
monIO, err := m.Open(req.GetPort().GetAddress(), req.Port.GetProtocol())
if err != nil {
return nil, nil, &commands.FailedMonitorError{Cause: err}
}
Expand Down
0