1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
|
//
// This file is part of pluggable-discovery-protocol-handler.
//
// Copyright 2024 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 discovery
import (
"fmt"
"io"
"net"
"testing"
"time"
"github.com/arduino/go-paths-helper"
"github.com/stretchr/testify/require"
)
type testLogger struct{}
func (l *testLogger) Debugf(msg string, args ...any) {
fmt.Printf(msg, args...)
fmt.Println()
}
func (l *testLogger) Errorf(msg string, args ...any) {
fmt.Printf(msg, args...)
fmt.Println()
}
func TestDiscoveryStdioHandling(t *testing.T) {
// Build `netcat` helper inside testdata/cat
builder, err := paths.NewProcess(nil, "go", "build")
require.NoError(t, err)
builder.SetDir("testdata/netcat")
require.NoError(t, builder.Run())
// Run netcat and test if streaming json works as expected
listener, err := net.ListenTCP("tcp", nil)
require.NoError(t, err)
disc := NewClient("test", "testdata/netcat/netcat", listener.Addr().String())
disc.SetLogger(&testLogger{})
err = disc.runProcess()
require.NoError(t, err)
listener.SetDeadline(time.Now().Add(time.Second))
conn, err := listener.Accept()
require.NoError(t, err)
_, err = conn.Write([]byte(`{ "eventType":`)) // send partial JSON
require.NoError(t, err)
msg, err := disc.waitMessage(time.Millisecond * 100)
require.Error(t, err)
require.Nil(t, msg)
_, err = conn.Write([]byte(`"ev1" }{ `)) // complete previous json and start another one
require.NoError(t, err)
msg, err = disc.waitMessage(time.Millisecond * 100)
require.NoError(t, err)
require.NotNil(t, msg)
require.Equal(t, "ev1", msg.EventType)
msg, err = disc.waitMessage(time.Millisecond * 100)
require.Error(t, err)
require.Nil(t, msg)
_, err = conn.Write([]byte(`"eventType":"ev2" }`)) // complete previous json
require.NoError(t, err)
msg, err = disc.waitMessage(time.Millisecond * 100)
require.NoError(t, err)
require.NotNil(t, msg)
require.Equal(t, "ev2", msg.EventType)
require.True(t, disc.Alive())
err = conn.Close()
require.NoError(t, err)
time.Sleep(time.Millisecond * 500)
require.False(t, disc.Alive())
}
func TestClient(t *testing.T) {
// Build dummy-discovery
builder, err := paths.NewProcess(nil, "go", "build")
require.NoError(t, err)
builder.SetDir("dummy-discovery")
require.NoError(t, builder.Run())
t.Run("WithDiscoveryCrashingOnStartup", func(t *testing.T) {
// Run client with discovery crashing on startup
cl := NewClient("1", "dummy-discovery/dummy-discovery", "--invalid")
require.ErrorIs(t, cl.Run(), io.EOF)
})
t.Run("WithDiscoveryCrashingWhileSendingCommands", func(t *testing.T) {
// Run client with crashing discovery after 1 second
cl := NewClient("1", "dummy-discovery/dummy-discovery", "-k")
require.NoError(t, cl.Run())
time.Sleep(time.Second)
ch, err := cl.StartSync(20)
require.Error(t, err)
require.Nil(t, ch)
})
t.Run("WithDiscoveryCrashingWhileStreamingEvents", func(t *testing.T) {
// Run client with crashing discovery after 1 second
cl := NewClient("1", "dummy-discovery/dummy-discovery", "-k")
require.NoError(t, cl.Run())
ch, err := cl.StartSync(20)
require.NoError(t, err)
time.Sleep(time.Second)
loop:
for {
select {
case msg, ok := <-ch:
if !ok {
// Channel closed: Test passed
fmt.Println("Event channel closed")
break loop
}
fmt.Println("Recv: ", msg)
case <-time.After(time.Second):
t.Error("Crashing client did not close event channel")
break loop
}
}
cl.Quit()
})
}
|