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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
|
import time
import unittest
import unittest.mock
from websockets.exceptions import ConcurrencyError
from websockets.frames import OP_BINARY, OP_CONT, OP_TEXT, Frame
from websockets.sync.messages import *
from ..utils import MS
from .utils import ThreadTestCase
class AssemblerTests(ThreadTestCase):
def setUp(self):
self.pause = unittest.mock.Mock()
self.resume = unittest.mock.Mock()
self.assembler = Assembler(high=2, low=1, pause=self.pause, resume=self.resume)
# Test get
def test_get_text_message_already_received(self):
"""get returns a text message that is already received."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
message = self.assembler.get()
self.assertEqual(message, "café")
def test_get_binary_message_already_received(self):
"""get returns a binary message that is already received."""
self.assembler.put(Frame(OP_BINARY, b"tea"))
message = self.assembler.get()
self.assertEqual(message, b"tea")
def test_get_text_message_not_received_yet(self):
"""get returns a text message when it is received."""
message = None
def getter():
nonlocal message
message = self.assembler.get()
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assertEqual(message, "café")
def test_get_binary_message_not_received_yet(self):
"""get returns a binary message when it is received."""
message = None
def getter():
nonlocal message
message = self.assembler.get()
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_BINARY, b"tea"))
self.assertEqual(message, b"tea")
def test_get_fragmented_text_message_already_received(self):
"""get reassembles a fragmented a text message that is already received."""
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assembler.put(Frame(OP_CONT, b"\xa9"))
message = self.assembler.get()
self.assertEqual(message, "café")
def test_get_fragmented_binary_message_already_received(self):
"""get reassembles a fragmented binary message that is already received."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
message = self.assembler.get()
self.assertEqual(message, b"tea")
def test_get_fragmented_text_message_not_received_yet(self):
"""get reassembles a fragmented text message when it is received."""
message = None
def getter():
nonlocal message
message = self.assembler.get()
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assembler.put(Frame(OP_CONT, b"\xa9"))
self.assertEqual(message, "café")
def test_get_fragmented_binary_message_not_received_yet(self):
"""get reassembles a fragmented binary message when it is received."""
message = None
def getter():
nonlocal message
message = self.assembler.get()
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
self.assertEqual(message, b"tea")
def test_get_fragmented_text_message_being_received(self):
"""get reassembles a fragmented text message that is partially received."""
message = None
def getter():
nonlocal message
message = self.assembler.get()
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assembler.put(Frame(OP_CONT, b"\xa9"))
self.assertEqual(message, "café")
def test_get_fragmented_binary_message_being_received(self):
"""get reassembles a fragmented binary message that is partially received."""
message = None
def getter():
nonlocal message
message = self.assembler.get()
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
self.assertEqual(message, b"tea")
def test_get_encoded_text_message(self):
"""get returns a text message without UTF-8 decoding."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
message = self.assembler.get(decode=False)
self.assertEqual(message, b"caf\xc3\xa9")
def test_get_decoded_binary_message(self):
"""get returns a binary message with UTF-8 decoding."""
self.assembler.put(Frame(OP_BINARY, b"tea"))
message = self.assembler.get(decode=True)
self.assertEqual(message, "tea")
def test_get_resumes_reading(self):
"""get resumes reading when queue goes below the low-water mark."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assembler.put(Frame(OP_TEXT, b"more caf\xc3\xa9"))
self.assembler.put(Frame(OP_TEXT, b"water"))
# queue is above the low-water mark
self.assembler.get()
self.resume.assert_not_called()
# queue is at the low-water mark
self.assembler.get()
self.resume.assert_called_once_with()
# queue is below the low-water mark
self.assembler.get()
self.resume.assert_called_once_with()
def test_get_does_not_resume_reading(self):
"""get does not resume reading when the low-water mark is unset."""
self.assembler.low = None
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assembler.put(Frame(OP_TEXT, b"more caf\xc3\xa9"))
self.assembler.put(Frame(OP_TEXT, b"water"))
self.assembler.get()
self.assembler.get()
self.assembler.get()
self.resume.assert_not_called()
def test_get_timeout_before_first_frame(self):
"""get times out before reading the first frame."""
with self.assertRaises(TimeoutError):
self.assembler.get(timeout=MS)
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
message = self.assembler.get()
self.assertEqual(message, "café")
def test_get_timeout_after_first_frame(self):
"""get times out after reading the first frame."""
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
with self.assertRaises(TimeoutError):
self.assembler.get(timeout=MS)
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assembler.put(Frame(OP_CONT, b"\xa9"))
message = self.assembler.get()
self.assertEqual(message, "café")
def test_get_timeout_0_message_already_received(self):
"""get(timeout=0) returns a message that is already received."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
message = self.assembler.get(timeout=0)
self.assertEqual(message, "café")
def test_get_timeout_0_message_not_received_yet(self):
"""get(timeout=0) times out when no message is already received."""
with self.assertRaises(TimeoutError):
self.assembler.get(timeout=0)
def test_get_timeout_0_fragmented_message_already_received(self):
"""get(timeout=0) returns a fragmented message that is already received."""
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assembler.put(Frame(OP_CONT, b"\xa9"))
message = self.assembler.get(timeout=0)
self.assertEqual(message, "café")
def test_get_timeout_0_fragmented_message_partially_received(self):
"""get(timeout=0) times out when a fragmented message is partially received."""
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
with self.assertRaises(TimeoutError):
self.assembler.get(timeout=0)
# Test get_iter
def test_get_iter_text_message_already_received(self):
"""get_iter yields a text message that is already received."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
fragments = list(self.assembler.get_iter())
self.assertEqual(fragments, ["café"])
def test_get_iter_binary_message_already_received(self):
"""get_iter yields a binary message that is already received."""
self.assembler.put(Frame(OP_BINARY, b"tea"))
fragments = list(self.assembler.get_iter())
self.assertEqual(fragments, [b"tea"])
def test_get_iter_text_message_not_received_yet(self):
"""get_iter yields a text message when it is received."""
fragments = []
def getter():
nonlocal fragments
for fragment in self.assembler.get_iter():
fragments.append(fragment)
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assertEqual(fragments, ["café"])
def test_get_iter_binary_message_not_received_yet(self):
"""get_iter yields a binary message when it is received."""
fragments = []
def getter():
nonlocal fragments
for fragment in self.assembler.get_iter():
fragments.append(fragment)
with self.run_in_thread(getter):
self.assembler.put(Frame(OP_BINARY, b"tea"))
self.assertEqual(fragments, [b"tea"])
def test_get_iter_fragmented_text_message_already_received(self):
"""get_iter yields a fragmented text message that is already received."""
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assembler.put(Frame(OP_CONT, b"\xa9"))
fragments = list(self.assembler.get_iter())
self.assertEqual(fragments, ["ca", "f", "é"])
def test_get_iter_fragmented_binary_message_already_received(self):
"""get_iter yields a fragmented binary message that is already received."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
fragments = list(self.assembler.get_iter())
self.assertEqual(fragments, [b"t", b"e", b"a"])
def test_get_iter_fragmented_text_message_not_received_yet(self):
"""get_iter yields a fragmented text message when it is received."""
iterator = self.assembler.get_iter()
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
self.assertEqual(next(iterator), "ca")
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assertEqual(next(iterator), "f")
self.assembler.put(Frame(OP_CONT, b"\xa9"))
self.assertEqual(next(iterator), "é")
def test_get_iter_fragmented_binary_message_not_received_yet(self):
"""get_iter yields a fragmented binary message when it is received."""
iterator = self.assembler.get_iter()
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assertEqual(next(iterator), b"t")
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assertEqual(next(iterator), b"e")
self.assembler.put(Frame(OP_CONT, b"a"))
self.assertEqual(next(iterator), b"a")
def test_get_iter_fragmented_text_message_being_received(self):
"""get_iter yields a fragmented text message that is partially received."""
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
iterator = self.assembler.get_iter()
self.assertEqual(next(iterator), "ca")
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assertEqual(next(iterator), "f")
self.assembler.put(Frame(OP_CONT, b"\xa9"))
self.assertEqual(next(iterator), "é")
def test_get_iter_fragmented_binary_message_being_received(self):
"""get_iter yields a fragmented binary message that is partially received."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
iterator = self.assembler.get_iter()
self.assertEqual(next(iterator), b"t")
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assertEqual(next(iterator), b"e")
self.assembler.put(Frame(OP_CONT, b"a"))
self.assertEqual(next(iterator), b"a")
def test_get_iter_encoded_text_message(self):
"""get_iter yields a text message without UTF-8 decoding."""
self.assembler.put(Frame(OP_TEXT, b"ca", fin=False))
self.assembler.put(Frame(OP_CONT, b"f\xc3", fin=False))
self.assembler.put(Frame(OP_CONT, b"\xa9"))
fragments = list(self.assembler.get_iter(decode=False))
self.assertEqual(fragments, [b"ca", b"f\xc3", b"\xa9"])
def test_get_iter_decoded_binary_message(self):
"""get_iter yields a binary message with UTF-8 decoding."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
fragments = list(self.assembler.get_iter(decode=True))
self.assertEqual(fragments, ["t", "e", "a"])
def test_get_iter_resumes_reading(self):
"""get_iter resumes reading when queue goes below the low-water mark."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
iterator = self.assembler.get_iter()
# queue is above the low-water mark
next(iterator)
self.resume.assert_not_called()
# queue is at the low-water mark
next(iterator)
self.resume.assert_called_once_with()
# queue is below the low-water mark
next(iterator)
self.resume.assert_called_once_with()
def test_get_iter_does_not_resume_reading(self):
"""get_iter does not resume reading when the low-water mark is unset."""
self.assembler.low = None
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
iterator = self.assembler.get_iter()
next(iterator)
next(iterator)
next(iterator)
self.resume.assert_not_called()
# Test put
def test_put_pauses_reading(self):
"""put pauses reading when queue goes above the high-water mark."""
# queue is below the high-water mark
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.pause.assert_not_called()
# queue is at the high-water mark
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.pause.assert_called_once_with()
# queue is above the high-water mark
self.assembler.put(Frame(OP_CONT, b"a"))
self.pause.assert_called_once_with()
def test_put_does_not_pause_reading(self):
"""put does not pause reading when the high-water mark is unset."""
self.assembler.high = None
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
self.pause.assert_not_called()
# Test termination
def test_get_fails_when_interrupted_by_close(self):
"""get raises EOFError when close is called."""
def closer():
time.sleep(2 * MS)
self.assembler.close()
with self.run_in_thread(closer):
with self.assertRaises(EOFError):
self.assembler.get()
def test_get_iter_fails_when_interrupted_by_close(self):
"""get_iter raises EOFError when close is called."""
def closer():
time.sleep(2 * MS)
self.assembler.close()
with self.run_in_thread(closer):
with self.assertRaises(EOFError):
for _ in self.assembler.get_iter():
self.fail("no fragment expected")
def test_get_fails_after_close(self):
"""get raises EOFError after close is called."""
self.assembler.close()
with self.assertRaises(EOFError):
self.assembler.get()
def test_get_iter_fails_after_close(self):
"""get_iter raises EOFError after close is called."""
self.assembler.close()
with self.assertRaises(EOFError):
for _ in self.assembler.get_iter():
self.fail("no fragment expected")
def test_get_queued_message_after_close(self):
"""get returns a message after close is called."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assembler.close()
message = self.assembler.get()
self.assertEqual(message, "café")
def test_get_iter_queued_message_after_close(self):
"""get_iter yields a message after close is called."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assembler.close()
fragments = list(self.assembler.get_iter())
self.assertEqual(fragments, ["café"])
def test_get_queued_fragmented_message_after_close(self):
"""get reassembles a fragmented message after close is called."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
self.assembler.close()
self.assembler.close()
message = self.assembler.get()
self.assertEqual(message, b"tea")
def test_get_iter_queued_fragmented_message_after_close(self):
"""get_iter yields a fragmented message after close is called."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.put(Frame(OP_CONT, b"a"))
self.assembler.close()
fragments = list(self.assembler.get_iter())
self.assertEqual(fragments, [b"t", b"e", b"a"])
def test_get_partially_queued_fragmented_message_after_close(self):
"""get raises EOF on a partial fragmented message after close is called."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.close()
with self.assertRaises(EOFError):
self.assembler.get()
def test_get_iter_partially_queued_fragmented_message_after_close(self):
"""get_iter yields a partial fragmented message after close is called."""
self.assembler.put(Frame(OP_BINARY, b"t", fin=False))
self.assembler.put(Frame(OP_CONT, b"e", fin=False))
self.assembler.close()
fragments = []
with self.assertRaises(EOFError):
for fragment in self.assembler.get_iter():
fragments.append(fragment)
self.assertEqual(fragments, [b"t", b"e"])
def test_put_fails_after_close(self):
"""put raises EOFError after close is called."""
self.assembler.close()
with self.assertRaises(EOFError):
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
def test_close_resumes_reading(self):
"""close unblocks reading when queue is above the high-water mark."""
self.assembler.put(Frame(OP_TEXT, b"caf\xc3\xa9"))
self.assembler.put(Frame(OP_TEXT, b"more caf\xc3\xa9"))
self.assembler.put(Frame(OP_TEXT, b"water"))
# queue is at the high-water mark
assert self.assembler.paused
self.assembler.close()
self.resume.assert_called_once_with()
def test_close_is_idempotent(self):
"""close can be called multiple times safely."""
self.assembler.close()
self.assembler.close()
# Test (non-)concurrency
def test_get_fails_when_get_is_running(self):
"""get cannot be called concurrently."""
with self.run_in_thread(self.assembler.get):
with self.assertRaises(ConcurrencyError):
self.assembler.get()
self.assembler.put(Frame(OP_TEXT, b"")) # unlock other thread
def test_get_fails_when_get_iter_is_running(self):
"""get cannot be called concurrently with get_iter."""
with self.run_in_thread(lambda: list(self.assembler.get_iter())):
with self.assertRaises(ConcurrencyError):
self.assembler.get()
self.assembler.put(Frame(OP_TEXT, b"")) # unlock other thread
def test_get_iter_fails_when_get_is_running(self):
"""get_iter cannot be called concurrently with get."""
with self.run_in_thread(self.assembler.get):
with self.assertRaises(ConcurrencyError):
list(self.assembler.get_iter())
self.assembler.put(Frame(OP_TEXT, b"")) # unlock other thread
def test_get_iter_fails_when_get_iter_is_running(self):
"""get_iter cannot be called concurrently."""
with self.run_in_thread(lambda: list(self.assembler.get_iter())):
with self.assertRaises(ConcurrencyError):
list(self.assembler.get_iter())
self.assembler.put(Frame(OP_TEXT, b"")) # unlock other thread
# Test setting limits
def test_set_high_water_mark(self):
"""high sets the high-water and low-water marks."""
assembler = Assembler(high=10)
self.assertEqual(assembler.high, 10)
self.assertEqual(assembler.low, 2)
def test_set_low_water_mark(self):
"""low sets the low-water and high-water marks."""
assembler = Assembler(low=5)
self.assertEqual(assembler.low, 5)
self.assertEqual(assembler.high, 20)
def test_set_high_and_low_water_marks(self):
"""high and low set the high-water and low-water marks."""
assembler = Assembler(high=10, low=5)
self.assertEqual(assembler.high, 10)
self.assertEqual(assembler.low, 5)
def test_unset_high_and_low_water_marks(self):
"""High-water and low-water marks are unset."""
assembler = Assembler()
self.assertEqual(assembler.high, None)
self.assertEqual(assembler.low, None)
def test_set_invalid_high_water_mark(self):
"""high must be a non-negative integer."""
with self.assertRaises(ValueError):
Assembler(high=-1)
def test_set_invalid_low_water_mark(self):
"""low must be higher than high."""
with self.assertRaises(ValueError):
Assembler(low=10, high=5)
|
