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 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
|
//nolint:funlen
package irc_test
import (
"bytes"
"errors"
"fmt"
"io"
"testing"
"time"
"github.com/stretchr/testify/assert"
"gopkg.in/irc.v4"
)
type TestHandler struct {
messages []*irc.Message
delay time.Duration
}
func (th *TestHandler) Handle(c *irc.Client, m *irc.Message) {
th.messages = append(th.messages, m)
if th.delay > 0 {
time.Sleep(th.delay)
}
}
func (th *TestHandler) Messages() []*irc.Message {
ret := th.messages
th.messages = nil
return ret
}
func TestCapReq(t *testing.T) {
t.Parallel()
config := irc.ClientConfig{
Nick: "test_nick",
Pass: "test_pass",
User: "test_user",
Name: "test_name",
}
// Happy path
c := runClientTest(t, config, io.EOF, func(c *irc.Client) {
assert.False(t, c.CapAvailable("random-thing"))
assert.False(t, c.CapAvailable("multi-prefix"))
c.CapRequest("multi-prefix", true)
}, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("CAP LS\r\n"),
ExpectLine("CAP REQ :multi-prefix\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("CAP * LS :multi-prefix\r\n"),
SendLine("CAP * ACK :multi-prefix\r\n"),
ExpectLine("CAP END\r\n"),
})
assert.False(t, c.CapEnabled("random-thing"))
assert.True(t, c.CapEnabled("multi-prefix"))
assert.False(t, c.CapAvailable("random-thing"))
assert.True(t, c.CapAvailable("multi-prefix"))
// Malformed CAP responses should be ignored
c = runClientTest(t, config, io.EOF, func(c *irc.Client) {
assert.False(t, c.CapAvailable("random-thing"))
assert.False(t, c.CapAvailable("multi-prefix"))
c.CapRequest("multi-prefix", true)
}, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("CAP LS\r\n"),
ExpectLine("CAP REQ :multi-prefix\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("CAP * LS :multi-prefix\r\n"),
// TODO: There's currently a bug somewhere preventing this from working
// as expected without this delay. My current guess is that there's a
// bug in flushing the output buffer in tests, but it's odd that it only
// shows up here.
Delay(10 * time.Millisecond),
SendLine("CAP * ACK\r\n"), // Malformed CAP response
SendLine("CAP * ACK :multi-prefix\r\n"),
ExpectLine("CAP END\r\n"),
})
assert.False(t, c.CapEnabled("random-thing"))
assert.True(t, c.CapEnabled("multi-prefix"))
assert.False(t, c.CapAvailable("random-thing"))
assert.True(t, c.CapAvailable("multi-prefix"))
// Additional CAP messages after the start are ignored.
c = runClientTest(t, config, io.EOF, func(c *irc.Client) {
assert.False(t, c.CapAvailable("random-thing"))
assert.False(t, c.CapAvailable("multi-prefix"))
c.CapRequest("multi-prefix", true)
}, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("CAP LS\r\n"),
ExpectLine("CAP REQ :multi-prefix\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("CAP * LS :multi-prefix\r\n"),
SendLine("CAP * ACK :multi-prefix\r\n"),
ExpectLine("CAP END\r\n"),
SendLine("CAP * NAK :multi-prefix\r\n"),
})
assert.False(t, c.CapEnabled("random-thing"))
assert.True(t, c.CapEnabled("multi-prefix"))
assert.False(t, c.CapAvailable("random-thing"))
assert.True(t, c.CapAvailable("multi-prefix"))
c = runClientTest(t, config, io.EOF, func(c *irc.Client) {
assert.False(t, c.CapAvailable("random-thing"))
assert.False(t, c.CapAvailable("multi-prefix"))
c.CapRequest("multi-prefix", false)
}, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("CAP LS\r\n"),
ExpectLine("CAP REQ :multi-prefix\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("CAP * LS :multi-prefix\r\n"),
SendLine("CAP * NAK :multi-prefix\r\n"),
ExpectLine("CAP END\r\n"),
})
assert.False(t, c.CapEnabled("random-thing"))
assert.False(t, c.CapEnabled("multi-prefix"))
assert.False(t, c.CapAvailable("random-thing"))
assert.True(t, c.CapAvailable("multi-prefix"))
c = runClientTest(t, config, errors.New("CAP multi-prefix requested but was rejected"), func(c *irc.Client) {
assert.False(t, c.CapAvailable("random-thing"))
assert.False(t, c.CapAvailable("multi-prefix"))
c.CapRequest("multi-prefix", true)
}, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("CAP LS\r\n"),
ExpectLine("CAP REQ :multi-prefix\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("CAP * LS :multi-prefix\r\n"),
SendLine("CAP * NAK :multi-prefix\r\n"),
})
assert.False(t, c.CapEnabled("random-thing"))
assert.False(t, c.CapEnabled("multi-prefix"))
assert.False(t, c.CapAvailable("random-thing"))
assert.True(t, c.CapAvailable("multi-prefix"))
c = runClientTest(t, config, errors.New("CAP multi-prefix requested but not accepted"), func(c *irc.Client) {
assert.False(t, c.CapAvailable("random-thing"))
assert.False(t, c.CapAvailable("multi-prefix"))
c.CapRequest("multi-prefix", true)
}, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("CAP LS\r\n"),
ExpectLine("CAP REQ :multi-prefix\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("CAP * LS :multi-prefix\r\n"),
SendLine("CAP * ACK :\r\n"),
})
assert.False(t, c.CapEnabled("random-thing"))
assert.False(t, c.CapEnabled("multi-prefix"))
assert.False(t, c.CapAvailable("random-thing"))
assert.True(t, c.CapAvailable("multi-prefix"))
}
func TestClient(t *testing.T) {
t.Parallel()
config := irc.ClientConfig{
Nick: "test_nick",
Pass: "test_pass",
User: "test_user",
Name: "test_name",
}
runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
})
runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("PING :hello world\r\n"),
ExpectLine("PONG :hello world\r\n"),
})
c := runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine(":test_nick NICK :new_test_nick\r\n"),
})
assert.Equal(t, "new_test_nick", c.CurrentNick())
c = runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :new_test_nick\r\n"),
})
assert.Equal(t, "new_test_nick", c.CurrentNick())
c = runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("433\r\n"),
ExpectLine("NICK :test_nick_\r\n"),
})
assert.Equal(t, "test_nick_", c.CurrentNick())
c = runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("437\r\n"),
ExpectLine("NICK :test_nick_\r\n"),
})
assert.Equal(t, "test_nick_", c.CurrentNick())
c = runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("433\r\n"),
ExpectLine("NICK :test_nick_\r\n"),
SendLine("001 :test_nick_\r\n"),
SendLine("433\r\n"),
})
assert.Equal(t, "test_nick_", c.CurrentNick())
c = runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("437\r\n"),
ExpectLine("NICK :test_nick_\r\n"),
SendLine("001 :test_nick_\r\n"),
SendLine("437\r\n"),
})
assert.Equal(t, "test_nick_", c.CurrentNick())
}
func TestSendLimit(t *testing.T) {
t.Parallel()
handler := &TestHandler{}
config := irc.ClientConfig{
Nick: "test_nick",
Pass: "test_pass",
User: "test_user",
Name: "test_name",
Handler: handler,
SendLimit: 10 * time.Millisecond,
SendBurst: 2,
}
before := time.Now()
runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :hello_world\r\n"),
})
assert.WithinDuration(t, before, time.Now(), 50*time.Millisecond)
// This last test isn't really a test. It's being used to make sure we
// hit the branch which handles dropping ticks if the buffered channel is
// full.
handler.delay = 20 * time.Millisecond // Sleep for 20ms when we get the 001 message
config.SendLimit = 10 * time.Millisecond
config.SendBurst = 0
before = time.Now()
runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :hello_world\r\n"),
})
assert.WithinDuration(t, before, time.Now(), 60*time.Millisecond)
}
func TestClientHandler(t *testing.T) {
t.Parallel()
handler := &TestHandler{}
config := irc.ClientConfig{
Nick: "test_nick",
Pass: "test_pass",
User: "test_user",
Name: "test_name",
Handler: handler,
}
runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :hello_world\r\n"),
})
assert.EqualValues(t, []*irc.Message{
{
Tags: irc.Tags{},
Prefix: &irc.Prefix{},
Command: "001",
Params: []string{"hello_world"},
},
}, handler.Messages())
}
func TestFromChannel(t *testing.T) {
t.Parallel()
c := irc.NewClient(newNopCloser(&bytes.Buffer{}), irc.ClientConfig{Nick: "test_nick"})
m := irc.MustParseMessage("PRIVMSG test_nick :hello world")
assert.False(t, c.FromChannel(m))
m = irc.MustParseMessage("PRIVMSG #a_channel :hello world")
assert.True(t, c.FromChannel(m))
m = irc.MustParseMessage("PING")
assert.False(t, c.FromChannel(m))
}
func TestPingLoop(t *testing.T) {
t.Parallel()
config := irc.ClientConfig{
Nick: "test_nick",
Pass: "test_pass",
User: "test_user",
Name: "test_name",
PingFrequency: 20 * time.Millisecond,
PingTimeout: 5 * time.Millisecond,
}
var lastPing *irc.Message
// Successful ping
runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :hello_world\r\n"),
Delay(20 * time.Millisecond),
LineFunc(func(m *irc.Message) {
lastPing = m
}),
SendFunc(func() string {
return fmt.Sprintf("PONG :%s\r\n", lastPing.Trailing())
}),
Delay(10 * time.Millisecond),
})
// Ping timeout
runClientTest(t, config, errors.New("ping timeout"), nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :hello_world\r\n"),
Delay(20 * time.Millisecond),
LineFunc(func(m *irc.Message) {
lastPing = m
}),
Delay(20 * time.Millisecond),
})
// Exit in the middle of handling a ping
runClientTest(t, config, io.EOF, nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :hello_world\r\n"),
Delay(20 * time.Millisecond),
LineFunc(func(m *irc.Message) {
lastPing = m
}),
})
/*
// This one is just for coverage, so we know we're hitting the
// branch that drops extra pings.
runClientTest(t, config, io.EOF, func(c *irc.Client) {
c.incomingPongChan = make(chan string)
handlePong(c, irc.MustParseMessage("PONG :hello 1"))
}, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
SendLine("001 :hello_world\r\n"),
})
*/
// Successful ping with write error
runClientTest(t, config, errors.New("test error"), nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
// We queue this up a line early because the next write will happen after the delay.
QueueWriteError(errors.New("test error")),
SendLine("001 :hello_world\r\n"),
Delay(25 * time.Millisecond),
})
// See if we can get the client to hang
runClientTest(t, config, errors.New("test error"), nil, []TestAction{
ExpectLine("PASS :test_pass\r\n"),
ExpectLine("NICK :test_nick\r\n"),
ExpectLine("USER test_user 0 * :test_name\r\n"),
// We queue this up a line early because the next write will happen after the delay.
QueueWriteError(errors.New("test error")),
SendLine("001 :hello_world\r\n"),
Delay(2 * time.Second),
AssertClosed(),
})
}
|