-
Notifications
You must be signed in to change notification settings - Fork 0
/
frame_test.go
488 lines (399 loc) · 10.9 KB
/
frame_test.go
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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
package websocket
import (
"bufio"
"testing"
)
func TestReadInitialForFin(t *testing.T) {
type testCase struct {
b *bufio.Reader
v bool
}
testCases := []testCase{
// When fin bit is '0' should set fin to false.
{b: newBuffer([]byte{1 /* 00000001 */, 0}), v: false},
// When fin bit is '1' should set fin to true.
{b: newBuffer([]byte{129 /* 10000001 */, 0}), v: true},
}
for i, c := range testCases {
f := &frame{}
if err := f.readInitial(c.b); err != nil {
t.Errorf("test case %d: unexpected error returned: %v", i, err)
}
if f.fin != c.v {
t.Errorf("test case %d: expected 'fin' to be '%t'", i, c.v)
}
}
}
func TestReadInitialForOpcode(t *testing.T) {
type testCase struct {
b *bufio.Reader
v int
}
// When opcode is valid, should not return an error.
testCases := []testCase{
// Without mask bit.
{b: newBuffer([]byte{0, 0}), v: OpcodeContinuation},
{b: newBuffer([]byte{1, 0}), v: OpcodeText},
{b: newBuffer([]byte{2, 0}), v: OpcodeBinary},
{b: newBuffer([]byte{8, 0}), v: OpcodeClose},
{b: newBuffer([]byte{9, 0}), v: OpcodePing},
{b: newBuffer([]byte{10, 0}), v: OpcodePong},
// With mask bit.
{b: newBuffer([]byte{128, 0}), v: OpcodeContinuation},
{b: newBuffer([]byte{129, 0}), v: OpcodeText},
{b: newBuffer([]byte{130, 0}), v: OpcodeBinary},
{b: newBuffer([]byte{136, 0}), v: OpcodeClose},
{b: newBuffer([]byte{137, 0}), v: OpcodePing},
{b: newBuffer([]byte{138, 0}), v: OpcodePong},
}
for i, c := range testCases {
f := &frame{}
if err := f.readInitial(c.b); err != nil {
t.Errorf("test case %d: unexpected error returned: %v", i, err)
}
if f.opcode != c.v {
t.Errorf("test case %d: expected 'opcode' to be '%d'", i, c.v)
}
}
}
func TestReadInitialForRSVError(t *testing.T) {
type testCase struct {
b *bufio.Reader
}
// Library doesn't support extensions thus when extension bits are used,
// lib should return an error.
testCases := []testCase{
{b: newBuffer([]byte{17 /* 00010001 */, 0})},
{b: newBuffer([]byte{33 /* 00100001 */, 0})},
{b: newBuffer([]byte{49 /* 00110001 */, 0})},
{b: newBuffer([]byte{65 /* 01000001 */, 0})},
{b: newBuffer([]byte{81 /* 01010001 */, 0})},
{b: newBuffer([]byte{97 /* 01100001 */, 0})},
{b: newBuffer([]byte{113 /* 01110001 */, 0})},
}
for i, c := range testCases {
f := &frame{}
err := f.readInitial(c.b)
if err == nil {
t.Errorf("test case %d: an error was expected.", i)
}
e, k := err.(*CloseError)
if !k {
t.Errorf("test case %d: expected error to be of type '*CloseError' but it is '%T'.", i, e)
}
if e.Reason != "no support for extensions" {
t.Errorf(`test case %d: expected error to have reason "no support for extensions", instead it got "%s".`, i, e.Reason)
}
}
}
// Should return an error if opcode is invalid.
func TestReadInitialForOpcodeError(t *testing.T) {
f := &frame{}
b := newBuffer([]byte{15, 0})
err := f.readInitial(b)
if err == nil {
t.Error("unexpected error returned")
}
e, k := err.(*CloseError)
if !k {
t.Fatalf("expected error to be of type '*websocket.CloseError', but it is '%T'.", e)
}
if e.Reason != "unsupported opcode: 15" {
t.Errorf(`expected error to have reason "unsupported opcode: 15", but it got "%s".`, e.Reason)
}
}
func TestReadInitialForMasked(t *testing.T) {
type testCase struct {
b *bufio.Reader
v bool
}
testCases := []testCase{
// When masked bit is '0' should set masked to false.
{b: newBuffer([]byte{1, 0}), v: false},
// When masked bit is '1' should set masked to true.
{b: newBuffer([]byte{1, 128}), v: true},
}
for i, c := range testCases {
f := &frame{}
if err := f.readInitial(c.b); err != nil {
t.Errorf("test case %d: unexpected error returned: %v", i, err)
}
if f.masked != c.v {
t.Errorf("test case %d: expected 'masked' to be '%t'", i, c.v)
}
}
}
func TestReadInitialForLength(t *testing.T) {
type testCase struct {
b *bufio.Reader
v uint64
}
testCases := []testCase{
// Should set length to 124 when payload len is 124.
{b: newBuffer([]byte{1, 124}), v: 124},
{b: newBuffer([]byte{1, 252}), v: 124},
// Should set length to 125 when payload len is 125.
{b: newBuffer([]byte{1, 125}), v: 125},
{b: newBuffer([]byte{1, 253}), v: 125},
// Should set length to 126 when payload len is 126.
{b: newBuffer([]byte{1, 126}), v: 126},
{b: newBuffer([]byte{1, 254}), v: 126},
// Should set length to 127 when payload len is 127.
{b: newBuffer([]byte{1, 127}), v: 127},
{b: newBuffer([]byte{1, 255}), v: 127},
}
for i, c := range testCases {
f := &frame{}
if err := f.readInitial(c.b); err != nil {
t.Errorf("test case %d: unexpected error returned: %v", i, err)
}
if f.length != c.v {
t.Errorf("test case %d: expected 'length' to be '%d'", i, c.v)
}
}
}
func TestReadMaskKey(t *testing.T) {
f := &frame{}
p := []byte{102, 100, 1, 54}
b := newBuffer(p)
// When f.masked is false, it means that the payload is not masked and
// therefore no key has been sent. For this reason f.key should be left
// untouched.
f.masked = false
if err := f.readMaskKey(b); err != nil {
t.Error("unexpected error returned:", err)
}
if len(f.key) != 0 {
t.Error("expected f.key to be empty but it is:", len(f.key))
}
// When f.masked is true, it means that the payload is masked and therefore
// the key must be read and stored in f.key.
f.masked = true
f.key = nil
if err := f.readMaskKey(b); err != nil {
t.Error("unexpected error returned:", err)
}
if len(f.key) != 4 {
t.Errorf("expected f.key to be '4 bytes' long but it is '%d bytes'", len(f.key))
}
for i, v := range p {
if v != f.key[i] {
t.Fatalf("expected mask key to be '%v' but it is '%v'", p, f.key)
}
}
}
func TestReadLength(t *testing.T) {
f := &frame{}
type testCase struct {
// initial length
i uint64
// final length
l uint64
}
testCases := []testCase{
{i: 124, l: 124},
{i: 125, l: 125},
{i: 126, l: 65535},
{i: 127, l: 9223372036854775807},
}
for i, c := range testCases {
f.length = c.i
b := newBuffer([]byte{255, 255, 255, 255, 255, 255, 255, 255})
if err := f.readLength(b); err != nil {
t.Errorf("test case %d: unexpected error returned: %v", i, err)
}
if f.length != c.l {
t.Errorf("test case %d: expected f.length to be '%d', but it is '%d'", i, c.l, f.length)
}
}
}
func TestReadPayload(t *testing.T) {
type testCase struct {
// Masked or not
m bool
}
testCases := []testCase{
{m: false},
{m: true},
}
for i, c := range testCases {
// Data Frame Received
p := []byte{120, 15, 17}
b := newBuffer(p)
// Creation and config of frame instance.
f := &frame{}
f.key = []byte{10, 15, 1, 120}
f.length = 2
// Setting Masked.
f.masked = c.m
if err := f.readPayload(b); err != nil {
t.Fatalf("test case %d: unexpected error was returned: %v", i, err)
}
// If masked unmask it.
if f.masked {
mask(f.payload, f.key)
}
if uint64(len(f.payload)) != f.length {
t.Errorf("test case %d: expected length of f.payload to be '%d', but it is '%d'", i, f.length, len(f.payload))
}
for i, v := range f.payload {
if v != p[i] {
t.Fatalf("test case %d: expected slice of bytes to be '%v', but it is '%v'.", i, p[:f.length], f.payload)
}
}
}
}
func TestToBytesFin(t *testing.T) {
type testCase struct {
v bool
r byte
}
testCases := []testCase{
// When f.fin is false first byte should not be affected
{v: false, r: 0},
// When f.fin is true first byte should has its MSB == 1.
{v: true, r: 128},
}
for i, c := range testCases {
f := &frame{fin: c.v}
p := make([]byte, 1)
f.toBytesFin(p)
if p[0] != c.r {
t.Errorf("test case %d: expected slice of bytes to be [%d] but it is [%d]", i, c.r, p[0])
}
}
}
func TestToBytesOpcode(t *testing.T) {
type testCase struct {
// Fin Value
v bool
// Opcode Value
o int
// Resultant byte
r byte
}
testCases := []testCase{
// With Fin == false
{v: false, o: OpcodeText, r: byte(OpcodeText)},
// With Fin == true
{v: true, o: OpcodeText, r: 128 + byte(OpcodeText)},
}
for i, c := range testCases {
f := &frame{fin: c.v, opcode: c.o}
p := make([]byte, 1)
f.toBytesFin(p)
f.toBytesOpcode(p)
if p[0] != c.r {
t.Errorf("test case %d: expected slice of bytes to be [%d] but it is [%d]", i, c.r, p[0])
}
}
}
func TestToBytesMasked(t *testing.T) {
type testCase struct {
// Value of f.key.
v []byte
// Resultant byte.
r byte
}
testCases := []testCase{
{v: nil, r: 0},
{v: []byte{1, 2, 3, 4}, r: 128},
}
for i, c := range testCases {
f := frame{key: c.v}
p := make([]byte, 2)
f.toBytesMasked(p)
if p[1] != c.r {
t.Errorf("test case %d: expected slice of bytes to be [%d] but it is [%d]", i, c.r, p[1])
}
}
}
func TestToBytesPayloadLength(t *testing.T) {
type testCase struct {
m bool
r byte
l int
}
testCases := []testCase{
// With Mask Bit (f.masked) set to false
{m: false, r: 124, l: 124},
{m: false, r: 125, l: 125},
{m: false, r: 126, l: 30000},
{m: false, r: 126, l: 65535},
{m: false, r: 127, l: 700000},
// With Mask Bit (f.masked) set to true
{m: true, r: 128 + 124, l: 124},
{m: true, r: 128 + 125, l: 125},
{m: true, r: 128 + 126, l: 30000},
{m: true, r: 128 + 126, l: 65535},
{m: true, r: 128 + 127, l: 700000},
// testCase{m: false, r: 127, l: 9223372036854775807},
}
for i, c := range testCases {
p := make([]byte, 2)
f := frame{payload: make([]byte, c.l)}
if c.m {
f.key = []byte{1, 2, 3, 4}
}
f.toBytesMasked(p)
f.toBytesPayloadLength(p)
if p[1] != c.r {
t.Errorf("test case %d: expected slice of bytes to be [%d] but it is [%d]", i, c.r, p[1])
}
}
}
func TestToBytesPayloadLengthExt(t *testing.T) {
type testCase struct {
l int
r []byte
}
testCases := []testCase{
// Length Known.
{l: 124, r: nil},
// Length Known.
{l: 125, r: nil},
// Read next 2 bytes.
{l: 30000, r: []byte{117, 48}},
// Read next 2 bytes.
{l: 65535, r: []byte{255, 255}},
// Read next 8 bytes.
{l: 700000, r: []byte{0, 0, 0, 0, 0, 10, 174, 96}},
}
for i, c := range testCases {
f := frame{payload: make([]byte, c.l)}
p := f.toBytesPayloadLengthExt()
if len(p) != len(c.r) {
t.Errorf("test case %d: expected length to be '%d' but it is '%d'", i, len(c.r), len(p))
}
for ci, cv := range c.r {
if cv != p[ci] {
t.Errorf("test case %d: Expected slice of bytes to be %v but it is %v", i, c.r, p)
break
}
}
}
}
func TestToBytesPayloadData(t *testing.T) {
type testCase struct {
m []byte
p []byte
}
testCases := []testCase{
// When masking key is present and valid, payload must be masked.
{p: []byte{3, 4, 5, 6}, m: nil},
// When masking key is not present, payload must not be masked.
{p: []byte{3, 4, 5, 6}, m: []byte{1, 2, 3, 4}},
}
for i, c := range testCases {
f := &frame{key: c.m, payload: c.p}
p := f.toBytesPayloadData()
if c.m != nil {
mask(p, c.m)
}
for ci, cv := range c.p {
if cv != p[ci] {
t.Errorf("test case %d: Expected slice of bytes to be %v but it is %v", i, c.p, p)
}
}
}
}