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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
package irc_test
import (
"bytes"
"errors"
"io"
"testing"
"time"
"github.com/stretchr/testify/assert"
"gopkg.in/irc.v4"
)
// TestAction is used to execute an action during a stream test. If a
// non-nil error is returned the test will be failed.
type TestAction func(t *testing.T, rw *testReadWriter)
func SendLine(output string) TestAction {
return SendLineWithTimeout(output, 1*time.Second)
}
func AssertClosed() TestAction {
return func(t *testing.T, rw *testReadWriter) {
t.Helper()
if !rw.closed {
assert.Fail(t, "Expected conn to be closed")
}
}
}
func SendLineWithTimeout(output string, timeout time.Duration) TestAction {
return func(t *testing.T, rw *testReadWriter) {
t.Helper()
waitChan := time.After(timeout)
// First we send the message
select {
case rw.readChan <- output:
case <-waitChan:
assert.Fail(t, "SendLine send timeout on %s", output)
return
case <-rw.exiting:
assert.Fail(t, "Failed to send")
return
}
// Now we wait for the buffer to be emptied
select {
case <-rw.readEmptyChan:
case <-waitChan:
assert.Fail(t, "SendLine timeout on %s", output)
case <-rw.exiting:
assert.Fail(t, "Failed to send whole message")
}
}
}
func SendFunc(cb func() string) TestAction {
return func(t *testing.T, rw *testReadWriter) {
t.Helper()
SendLine(cb())(t, rw)
}
}
func LineFunc(cb func(m *irc.Message)) TestAction {
return func(t *testing.T, rw *testReadWriter) {
t.Helper()
select {
case line := <-rw.writeChan:
cb(irc.MustParseMessage(line))
case <-time.After(1 * time.Second):
assert.Fail(t, "LineFunc timeout")
case <-rw.exiting:
}
}
}
func ExpectLine(input string) TestAction {
return ExpectLineWithTimeout(input, 1*time.Second)
}
func ExpectLineWithTimeout(input string, timeout time.Duration) TestAction {
return func(t *testing.T, rw *testReadWriter) {
t.Helper()
select {
case line := <-rw.writeChan:
assert.Equal(t, input, line)
case <-time.After(timeout):
assert.Fail(t, "ExpectLine timeout on %s", input)
case <-rw.exiting:
}
}
}
func Delay(delay time.Duration) TestAction {
return func(t *testing.T, rw *testReadWriter) {
t.Helper()
select {
case <-time.After(delay):
case <-rw.exiting:
}
}
}
/*
func QueueReadError(err error) TestAction {
return func(t *testing.T, rw *testReadWriter) {
select {
case rw.readErrorChan <- err:
default:
assert.Fail(t, "Tried to queue a second read error")
}
}
}
*/
func QueueWriteError(err error) TestAction {
return func(t *testing.T, rw *testReadWriter) {
t.Helper()
select {
case rw.writeErrorChan <- err:
default:
assert.Fail(t, "Tried to queue a second write error")
}
}
}
type testReadWriter struct {
writeErrorChan chan error
writeChan chan string
readErrorChan chan error
readChan chan string
readEmptyChan chan struct{}
exiting chan struct{}
clientDone chan struct{}
closed bool
serverBuffer bytes.Buffer
}
func (rw *testReadWriter) maybeBroadcastEmpty() {
if rw.serverBuffer.Len() == 0 {
select {
case rw.readEmptyChan <- struct{}{}:
default:
}
}
}
func (rw *testReadWriter) Read(buf []byte) (int, error) {
// Check for a read error first
select {
case err := <-rw.readErrorChan:
return 0, err
default:
}
// If there's data left in the buffer, we want to use that first.
if rw.serverBuffer.Len() > 0 {
s, err := rw.serverBuffer.Read(buf)
if errors.Is(err, io.EOF) {
err = nil
}
rw.maybeBroadcastEmpty()
return s, err
}
// Read from server. We're waiting for this whole test to finish, data to
// come in from the server buffer, or for an error. We expect only one read
// to be happening at once.
select {
case err := <-rw.readErrorChan:
return 0, err
case data := <-rw.readChan:
rw.serverBuffer.WriteString(data)
s, err := rw.serverBuffer.Read(buf)
if errors.Is(err, io.EOF) {
err = nil
}
rw.maybeBroadcastEmpty()
return s, err
case <-rw.exiting:
return 0, io.EOF
}
}
func (rw *testReadWriter) Write(buf []byte) (int, error) {
select {
case err := <-rw.writeErrorChan:
return 0, err
default:
}
// Write to server. We can cheat with this because we know things
// will be written a line at a time.
select {
case rw.writeChan <- string(buf):
return len(buf), nil
case <-rw.exiting:
return 0, errors.New("Connection closed")
}
}
func (rw *testReadWriter) Close() error {
select {
case <-rw.exiting:
return errors.New("Connection closed")
default:
// Ensure no double close
if !rw.closed {
rw.closed = true
close(rw.exiting)
}
return nil
}
}
func newTestReadWriter() *testReadWriter {
return &testReadWriter{
writeErrorChan: make(chan error, 1),
writeChan: make(chan string),
readErrorChan: make(chan error, 1),
readChan: make(chan string),
readEmptyChan: make(chan struct{}, 1),
exiting: make(chan struct{}),
clientDone: make(chan struct{}),
}
}
func runClientTest(
t *testing.T,
cc irc.ClientConfig,
expectedErr error,
setup func(c *irc.Client),
actions []TestAction,
) *irc.Client {
t.Helper()
rw := newTestReadWriter()
c := irc.NewClient(rw, cc)
if setup != nil {
setup(c)
}
go func() {
err := c.Run()
assert.Equal(t, expectedErr, err)
close(rw.clientDone)
}()
runTest(t, rw, actions)
return c
}
func runTest(t *testing.T, rw *testReadWriter, actions []TestAction) {
t.Helper()
// Perform each of the actions
for _, action := range actions {
action(t, rw)
}
// TODO: Make sure there are no more incoming messages
// Ask everything to shut down
rw.Close()
// Wait for the client to stop
select {
case <-rw.clientDone:
case <-time.After(1 * time.Second):
assert.Fail(t, "Timeout in client shutdown")
}
}
|