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
|
# -*- coding: utf-8 -*-
"""
Tests for SelectConnection _Timer and _Timeout classes
"""
import math
import time
import unittest
from unittest import mock
import pika.compat
from pika.adapters import select_connection
# Suppress protected-access
# pylint: disable=W0212
# Suppress missing-docstring
# pylint: disable=C0111
# Suppress invalid-name
# pylint: disable=C0103
def test_now():
# pika/pika#1184
# Note that time is a float, and these tests depend
# on exact math. Round up the value to ensure that
# CI doesn't fail because of something like this:
# raise self.failureException('6.000000000000028 != 6')
# https://travis-ci.org/pika/pika/jobs/489828602
return math.ceil(pika.compat.time_now())
class ChildTimeout(select_connection._Timeout):
def __init__(self, *args, **kwargs):
super(ChildTimeout, self).__init__(*args, **kwargs)
self.extra = 'e'
def __eq__(self, other):
if isinstance(other, ChildTimeout):
return self.extra == other.extra and super(
ChildTimeout, self).__eq__(other)
return NotImplemented
class TimeoutClassTests(unittest.TestCase):
"""Test select_connection._Timeout class"""
def test_properties(self):
now = test_now()
cb = lambda: None
timeout = select_connection._Timeout(now + 5.3, cb)
self.assertIs(timeout.callback, cb)
self.assertEqual(timeout.deadline, now + 5.3)
def test_non_negative_deadline(self):
select_connection._Timeout(0, lambda: None)
select_connection._Timeout(5, lambda: None)
with self.assertRaises(ValueError) as cm:
select_connection._Timeout(-1, lambda: None)
self.assertIn('deadline must be non-negative epoch number',
cm.exception.args[0])
def test_non_callable_callback_raises(self):
with self.assertRaises(TypeError) as cm:
select_connection._Timeout(5, None)
self.assertIn('callback must be a callable, but got',
cm.exception.args[0])
with self.assertRaises(TypeError) as cm:
select_connection._Timeout(5, dict())
self.assertIn('callback must be a callable, but got',
cm.exception.args[0])
def test_eq(self):
# Comparison should be by deadline only
self.assertEqual(
select_connection._Timeout(5, lambda: None),
select_connection._Timeout(5, lambda: 5))
self.assertEqual(
select_connection._Timeout(5, lambda: 5),
select_connection._Timeout(5, lambda: None))
self.assertEqual(
select_connection._Timeout(5, lambda: None),
ChildTimeout(5, lambda: 5))
self.assertEqual(
ChildTimeout(5, lambda: 5),
select_connection._Timeout(5, lambda: None))
class Foreign(object):
def __eq__(self, other):
return 'foobar'
self.assertEqual(
select_connection._Timeout(5, lambda: None) == Foreign(),
'foobar')
self.assertEqual(
Foreign() == select_connection._Timeout(5, lambda: None),
'foobar')
def test_ne(self):
# Comparison should be by deadline only
self.assertNotEqual(
select_connection._Timeout(5, lambda: None),
select_connection._Timeout(10, lambda: None))
self.assertNotEqual(
select_connection._Timeout(10, lambda: None),
select_connection._Timeout(5, lambda: None))
self.assertNotEqual(
select_connection._Timeout(5, lambda: None),
ChildTimeout(10, lambda: None))
self.assertNotEqual(
ChildTimeout(10, lambda: None),
select_connection._Timeout(5, lambda: None))
self.assertNotEqual(
select_connection._Timeout(5, lambda: None),
dict(deadline=5, callback=lambda: None))
self.assertNotEqual(
dict(deadline=5, callback=lambda: None),
select_connection._Timeout(5, lambda: None))
class Foreign(object):
def __ne__(self, other):
return 'foobar'
self.assertEqual(
select_connection._Timeout(5, lambda: None) != Foreign(),
'foobar')
self.assertEqual(
Foreign() != select_connection._Timeout(5, lambda: None),
'foobar')
def test_lt(self):
# Comparison should be by deadline only
self.assertLess(
select_connection._Timeout(5, lambda: None),
select_connection._Timeout(10, lambda: None))
self.assertLess(
select_connection._Timeout(5, lambda: None),
ChildTimeout(10, lambda: None))
class Foreign(object):
def __gt__(self, other):
return 'foobar'
self.assertEqual(
select_connection._Timeout(5, lambda: None) < Foreign(),
'foobar')
self.assertFalse(
select_connection._Timeout(5, lambda: None)
< select_connection._Timeout(5, lambda: None))
self.assertFalse(
select_connection._Timeout(5, lambda: None)
< select_connection._Timeout(1, lambda: None))
def test_gt(self):
# Comparison should be by deadline only
self.assertGreater(
select_connection._Timeout(10, lambda: None),
select_connection._Timeout(5, lambda: None))
self.assertGreater(
select_connection._Timeout(10, lambda: None),
ChildTimeout(5, lambda: None))
class Foreign(object):
def __lt__(self, other):
return 'foobar'
self.assertEqual(
select_connection._Timeout(5, lambda: None) > Foreign(),
'foobar')
self.assertFalse(
select_connection._Timeout(5, lambda: None)
> select_connection._Timeout(5, lambda: None))
self.assertFalse(
select_connection._Timeout(1, lambda: None)
> select_connection._Timeout(5, lambda: None))
def test_le(self):
# Comparison should be by deadline only
self.assertLessEqual(
select_connection._Timeout(5, lambda: None),
select_connection._Timeout(10, lambda: None))
self.assertLessEqual(
select_connection._Timeout(5, lambda: None),
select_connection._Timeout(5, lambda: None))
self.assertLessEqual(
select_connection._Timeout(5, lambda: None),
ChildTimeout(10, lambda: None))
self.assertLessEqual(
select_connection._Timeout(5, lambda: None),
ChildTimeout(5, lambda: None))
class Foreign(object):
def __ge__(self, other):
return 'foobar'
self.assertEqual(
select_connection._Timeout(5, lambda: None) <= Foreign(),
'foobar')
self.assertFalse(
select_connection._Timeout(5, lambda: None)
<= select_connection._Timeout(1, lambda: None))
def test_ge(self):
# Comparison should be by deadline only
self.assertGreaterEqual(
select_connection._Timeout(10, lambda: None),
select_connection._Timeout(5, lambda: None))
self.assertGreaterEqual(
select_connection._Timeout(5, lambda: None),
select_connection._Timeout(5, lambda: None))
self.assertGreaterEqual(
select_connection._Timeout(10, lambda: None),
ChildTimeout(5, lambda: None))
self.assertGreaterEqual(
select_connection._Timeout(5, lambda: None),
ChildTimeout(5, lambda: None))
class Foreign(object):
def __le__(self, other):
return 'foobar'
self.assertEqual(
select_connection._Timeout(5, lambda: None) >= Foreign(),
'foobar')
self.assertFalse(
select_connection._Timeout(1, lambda: None)
>= select_connection._Timeout(5, lambda: None))
class TimerClassTests(unittest.TestCase):
"""Test select_connection._Timer class"""
def test_close_empty(self):
timer = select_connection._Timer()
timer.close()
self.assertIsNone(timer._timeout_heap)
def test_close_non_empty(self):
timer = select_connection._Timer()
t1 = timer.call_later(10, lambda: 10)
t2 = timer.call_later(20, lambda: 20)
timer.close()
self.assertIsNone(timer._timeout_heap)
self.assertIsNone(t1.callback)
self.assertIsNone(t2.callback)
def test_no_timeouts_remaining_interval_is_none(self):
timer = select_connection._Timer()
self.assertIsNone(timer.get_remaining_interval())
def test_call_later_non_negative_delay_check(self):
now = test_now()
# 0 delay is okay
with mock.patch('pika.compat.time_now', return_value=now):
timer = select_connection._Timer()
timer.call_later(0, lambda: None)
self.assertEqual(timer._timeout_heap[0].deadline, now)
self.assertEqual(timer.get_remaining_interval(), 0)
# Positive delay is okay
with mock.patch('pika.compat.time_now', return_value=now):
timer = select_connection._Timer()
timer.call_later(0.5, lambda: None)
self.assertEqual(timer._timeout_heap[0].deadline, now + 0.5)
self.assertEqual(timer.get_remaining_interval(), 0.5)
# Negative delay raises ValueError
timer = select_connection._Timer()
with self.assertRaises(ValueError) as cm:
timer.call_later(-5, lambda: None)
self.assertIn('call_later: delay must be non-negative, but got',
cm.exception.args[0])
def test_call_later_single_timer_expires(self):
now = test_now()
with mock.patch('pika.compat.time_now', return_value=now):
bucket = []
timer = select_connection._Timer()
timer.call_later(5, lambda: bucket.append(1))
# Nothing is ready to expire
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertEqual(timer.get_remaining_interval(), 5)
# Advance time by 5 seconds and expect the timer to expire
with mock.patch('pika.compat.time_now', return_value=now + 5):
self.assertEqual(timer.get_remaining_interval(), 0)
timer.process_timeouts()
self.assertEqual(bucket, [1])
self.assertEqual(len(timer._timeout_heap), 0)
self.assertIsNone(timer.get_remaining_interval())
def test_call_later_multiple_timers(self):
now = test_now()
bucket = []
timer = select_connection._Timer()
with mock.patch('pika.compat.time_now', return_value=now):
timer.call_later(5, lambda: bucket.append(1))
timer.call_later(5, lambda: bucket.append(2))
timer.call_later(10, lambda: bucket.append(3))
# Nothing is ready to fire yet
self.assertEqual(timer.get_remaining_interval(), 5)
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertEqual(timer.get_remaining_interval(), 5)
# Advance time by 6 seconds and expect first two timers to expire
with mock.patch('pika.compat.time_now', return_value=now + 6):
self.assertEqual(timer.get_remaining_interval(), 0)
timer.process_timeouts()
self.assertEqual(bucket, [1, 2])
self.assertEqual(len(timer._timeout_heap), 1)
self.assertEqual(timer.get_remaining_interval(), 4)
# Advance time by 10 seconds and expect the 3rd timeout to expire
with mock.patch('pika.compat.time_now', return_value=now + 10):
self.assertEqual(timer.get_remaining_interval(), 0)
timer.process_timeouts()
self.assertEqual(bucket, [1, 2, 3])
self.assertEqual(len(timer._timeout_heap), 0)
self.assertIsNone(timer.get_remaining_interval())
def test_add_and_remove_timeout(self):
now = test_now()
bucket = []
timer = select_connection._Timer()
with mock.patch('pika.compat.time_now', return_value=now):
timer.call_later(10, lambda: bucket.append(3)) # t3
t2 = timer.call_later(6, lambda: bucket.append(2))
t1 = timer.call_later(5, lambda: bucket.append(1))
# Nothing is ready to fire yet
self.assertEqual(timer.get_remaining_interval(), 5)
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertEqual(timer.get_remaining_interval(), 5)
# Cancel t1 and t2 that haven't expired yet
timer.remove_timeout(t1)
self.assertIsNone(t1.callback)
self.assertEqual(timer._num_cancellations, 1)
timer.remove_timeout(t2)
self.assertIsNone(t2.callback)
self.assertEqual(timer._num_cancellations, 2)
self.assertEqual(timer.get_remaining_interval(), 5)
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertEqual(timer._num_cancellations, 2)
self.assertEqual(timer.get_remaining_interval(), 5)
self.assertEqual(len(timer._timeout_heap), 3)
# Advance time by 6 seconds to expire t1 and t2 and verify they don't
# fire
with mock.patch('pika.compat.time_now', return_value=now + 6):
self.assertEqual(timer.get_remaining_interval(), 0)
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertEqual(timer._num_cancellations, 0)
self.assertEqual(len(timer._timeout_heap), 1)
self.assertEqual(timer.get_remaining_interval(), 4)
# Advance time by 10 seconds to expire t3 and verify it fires
with mock.patch('pika.compat.time_now', return_value=now + 10):
self.assertEqual(timer.get_remaining_interval(), 0)
timer.process_timeouts()
self.assertEqual(bucket, [3])
self.assertEqual(len(timer._timeout_heap), 0)
self.assertIsNone(timer.get_remaining_interval())
def test_gc_of_unexpired_timeouts(self):
now = test_now()
bucket = []
timer = select_connection._Timer()
with mock.patch.multiple(select_connection._Timer,
_GC_CANCELLATION_THRESHOLD=1):
with mock.patch('pika.compat.time_now', return_value=now):
t3 = timer.call_later(10, lambda: bucket.append(3))
t2 = timer.call_later(6, lambda: bucket.append(2))
t1 = timer.call_later(5, lambda: bucket.append(1))
# Cancel t1 and check that it doesn't trigger GC because it's
# not greater than half the timeouts
timer.remove_timeout(t1)
self.assertEqual(timer._num_cancellations, 1)
timer.process_timeouts()
self.assertEqual(timer._num_cancellations, 1)
self.assertEqual(bucket, [])
self.assertEqual(len(timer._timeout_heap), 3)
self.assertEqual(timer.get_remaining_interval(), 5)
# Cancel t3 and verify GC since it's now greater than half of
# total timeouts
timer.remove_timeout(t3)
self.assertEqual(timer._num_cancellations, 2)
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertEqual(len(timer._timeout_heap), 1)
self.assertIs(t2, timer._timeout_heap[0])
self.assertEqual(timer.get_remaining_interval(), 6)
self.assertEqual(timer._num_cancellations, 0)
def test_add_timeout_from_another_timeout(self):
now = test_now()
bucket = []
timer = select_connection._Timer()
with mock.patch('pika.compat.time_now', return_value=now):
t1 = timer.call_later(
5,
lambda: bucket.append(
timer.call_later(0, lambda: bucket.append(2))))
# Advance time by 10 seconds and verify that t1 fires and creates t2,
# but timer manager defers firing of t2 to next `process_timeouts` in
# order to avoid IO starvation
with mock.patch('pika.compat.time_now', return_value=now + 10):
timer.process_timeouts()
t2 = bucket.pop()
self.assertIsInstance(t2, select_connection._Timeout)
self.assertIsNot(t2, t1)
self.assertEqual(bucket, [])
self.assertEqual(len(timer._timeout_heap), 1)
self.assertIs(t2, timer._timeout_heap[0])
self.assertEqual(timer.get_remaining_interval(), 0)
# t2 should now fire
timer.process_timeouts()
self.assertEqual(bucket, [2])
self.assertEqual(timer.get_remaining_interval(), None)
def test_cancel_unexpired_timeout_from_another_timeout(self):
now = test_now()
bucket = []
timer = select_connection._Timer()
with mock.patch('pika.compat.time_now', return_value=now):
t2 = timer.call_later(10, lambda: bucket.append(2))
t1 = timer.call_later(5, lambda: timer.remove_timeout(t2))
self.assertIs(t1, timer._timeout_heap[0])
# Advance time by 6 seconds and check that t2 is cancelled, but not
# removed from timeout heap
with mock.patch('pika.compat.time_now', return_value=now + 6):
timer.process_timeouts()
self.assertIsNone(t2.callback)
self.assertEqual(timer.get_remaining_interval(), 4)
self.assertIs(t2, timer._timeout_heap[0])
self.assertEqual(timer._num_cancellations, 1)
# Advance time by 10 seconds and verify that t2 is removed without
# firing
with mock.patch('pika.compat.time_now', return_value=now + 10):
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertIsNone(timer.get_remaining_interval())
self.assertEqual(len(timer._timeout_heap), 0)
self.assertEqual(timer._num_cancellations, 0)
def test_cancel_expired_timeout_from_another_timeout(self):
now = test_now()
bucket = []
timer = select_connection._Timer()
with mock.patch('pika.compat.time_now', return_value=now):
t2 = timer.call_later(10, lambda: bucket.append(2))
t1 = timer.call_later(
5,
lambda: (self.assertEqual(timer._num_cancellations, 0),
timer.remove_timeout(t2)))
self.assertIs(t1, timer._timeout_heap[0])
# Advance time by 10 seconds and check that t2 is cancelled and
# removed from timeout heap
with mock.patch('pika.compat.time_now', return_value=now + 10):
timer.process_timeouts()
self.assertEqual(bucket, [])
self.assertIsNone(t2.callback)
self.assertIsNone(timer.get_remaining_interval())
self.assertEqual(len(timer._timeout_heap), 0)
self.assertEqual(timer._num_cancellations, 0)
|
