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
|
import asyncio
from unittest.mock import Mock, patch
import pytest
from zigpy import datastructures
async def test_dynamic_bounded_semaphore_simple_locking():
"""Test simple, serial locking/unlocking."""
sem = datastructures.PriorityDynamicBoundedSemaphore()
assert "unlocked" not in repr(sem) and "locked" in repr(sem)
assert sem.value == 0
assert sem.max_value == 0
assert sem.locked()
# Invalid max value
with pytest.raises(ValueError):
sem.max_value = -1
assert sem.value == 0
assert sem.max_value == 0
assert sem.locked()
# Max value is now specified
sem.max_value = 1
assert not sem.locked()
assert sem.max_value == 1
assert sem.value == 1
assert "unlocked" in repr(sem)
# Semaphore can now be acquired
async with sem:
assert sem.value == 0
assert sem.locked()
assert not sem.locked()
assert sem.max_value == 1
assert sem.value == 1
await sem.acquire()
assert sem.value == 0
assert sem.locked()
sem.release()
assert not sem.locked()
assert sem.max_value == 1
assert sem.value == 1
with pytest.raises(ValueError):
sem.release()
async def test_dynamic_bounded_semaphore_multiple_locking():
"""Test multiple locking/unlocking."""
sem = datastructures.PriorityDynamicBoundedSemaphore(5)
assert sem.value == 5
assert not sem.locked()
async with sem:
assert sem.value == 4
assert not sem.locked()
async with sem, sem, sem:
assert sem.value == 1
assert not sem.locked()
async with sem:
assert sem.locked()
assert sem.value == 0
assert not sem.locked()
assert sem.value == 1
assert sem.value == 4
assert not sem.locked()
assert sem.value == 5
assert not sem.locked()
async def test_dynamic_bounded_semaphore_hanging_bug():
"""Test semaphore hanging bug."""
sem = datastructures.PriorityDynamicBoundedSemaphore(1)
async def c1():
async with sem:
await asyncio.sleep(0)
t2.cancel()
async def c2():
async with sem:
pytest.fail("Should never get here")
t1 = asyncio.create_task(c1())
t2 = asyncio.create_task(c2())
r1, r2 = await asyncio.gather(t1, t2, return_exceptions=True)
assert r1 is None
assert isinstance(r2, asyncio.CancelledError)
assert not sem.locked()
async with sem:
assert True
def test_dynamic_bounded_semaphore_multiple_event_loops():
"""Test semaphore detecting multiple loops."""
async def test_semaphore(sem):
async with sem:
await asyncio.sleep(0.1)
async def make_semaphore():
sem = datastructures.PriorityDynamicBoundedSemaphore(1)
# The loop reference is lazily created so we need to actually lock the semaphore
await asyncio.gather(test_semaphore(sem), test_semaphore(sem))
return sem
loop1 = asyncio.new_event_loop()
sem = loop1.run_until_complete(make_semaphore())
async def inner():
await asyncio.gather(test_semaphore(sem), test_semaphore(sem))
loop2 = asyncio.new_event_loop()
with pytest.raises(RuntimeError):
loop2.run_until_complete(inner())
async def test_dynamic_bounded_semaphore_runtime_limit_increase():
"""Test changing the max_value at runtime."""
sem = datastructures.PriorityDynamicBoundedSemaphore(2)
def set_limit(n):
sem.max_value = n
asyncio.get_running_loop().call_later(0.1, set_limit, 3)
async with sem:
# Play with the value, testing edge cases
sem.max_value = 100
assert sem.value == 99
assert not sem.locked()
sem.max_value = 2
assert sem.value == 1
assert not sem.locked()
sem.max_value = 1
assert sem.value == 0
assert sem.locked()
# Setting it to `0` seems undefined but we keep track of locks so it works
sem.max_value = 0
assert sem.value == -1
assert sem.locked()
sem.max_value = 2
assert sem.value == 1
assert not sem.locked()
async with sem:
assert sem.locked()
assert sem.value == 0
assert sem.max_value == 2
async with sem:
# We're now locked until the limit is increased
pass
assert not sem.locked()
assert sem.value == 1
assert sem.max_value == 3
assert sem.value == 2
assert sem.max_value == 3
assert sem.value == 3
assert sem.max_value == 3
async def test_dynamic_bounded_semaphore_errors():
"""Test semaphore handling errors and cancellation."""
sem = datastructures.PriorityDynamicBoundedSemaphore(1)
def set_limit(n):
sem.max_value = n
async def acquire():
async with sem:
await asyncio.sleep(60)
# The first acquire call will succeed
acquire1 = asyncio.create_task(acquire())
# The remaining two will stall
acquire2 = asyncio.create_task(acquire())
acquire3 = asyncio.create_task(acquire())
await asyncio.sleep(0.1)
# Cancel the first one, which holds the lock
acquire1.cancel()
# But also cancel the second one, which was waiting
acquire2.cancel()
with pytest.raises(asyncio.CancelledError):
await acquire1
with pytest.raises(asyncio.CancelledError):
await acquire2
await asyncio.sleep(0.1)
# The third one will have succeeded
assert sem.locked()
assert sem.value == 0
assert sem.max_value == 1
acquire3.cancel()
with pytest.raises(asyncio.CancelledError):
await acquire3
assert not sem.locked()
assert sem.value == 1
assert sem.max_value == 1
async def test_dynamic_bounded_semaphore_cancellation():
"""Test semaphore handling errors and cancellation."""
sem = datastructures.PriorityDynamicBoundedSemaphore(2)
async def acquire():
async with sem:
await asyncio.sleep(0.2)
tasks = []
# First two lock up the semaphore but succeed
tasks.append(asyncio.create_task(acquire()))
tasks.append(asyncio.create_task(acquire()))
# Next two get in line, will be cancelled
tasks.append(asyncio.create_task(acquire()))
tasks.append(asyncio.create_task(acquire()))
await asyncio.sleep(0)
exc = RuntimeError("Uh oh :(")
sem.cancel_waiting(exc)
# Last one makes it through
tasks.append(asyncio.create_task(acquire()))
assert (await asyncio.gather(*tasks, return_exceptions=True)) == [
None,
None,
exc,
exc,
None,
]
assert not sem.locked()
async def test_priority_lock():
"""Test priority lock."""
lock = datastructures.PriorityLock()
with pytest.raises(ValueError):
lock.max_value = 2
assert lock.max_value == 1
# Default priority of 0
async with lock:
pass
# Overridden priority of 100
async with lock(priority=100):
pass
run_order = []
async def test_priority(priority: int, item: str):
assert lock.locked()
async with lock(priority=priority):
run_order.append(item)
# Lock first
async with lock:
assert lock.locked()
names = {
"1: first": 1,
"5: first": 5,
"1: second": 1,
"1: third": 1,
"5: second": 5,
"-5: only": -5,
"1: fourth": 1,
"2: only": 2,
}
tasks = {
name: asyncio.create_task(test_priority(priority + 0, name + ""))
for name, priority in names.items()
}
await asyncio.sleep(0)
tasks["1: second"].cancel()
await asyncio.sleep(0)
await asyncio.gather(*tasks.values(), return_exceptions=True)
assert run_order == [
"5: first",
"5: second",
"2: only",
"1: first",
# "1: second",
"1: third",
"1: fourth",
"-5: only",
]
async def test_reschedulable_timeout():
callback = Mock()
timeout = datastructures.ReschedulableTimeout(callback)
timeout.reschedule(0.1)
assert len(callback.mock_calls) == 0
await asyncio.sleep(0.09)
assert len(callback.mock_calls) == 0
await asyncio.sleep(0.02)
assert len(callback.mock_calls) == 1
async def test_reschedulable_timeout_reschedule():
callback = Mock()
timeout = datastructures.ReschedulableTimeout(callback)
timeout.reschedule(0.1)
timeout.reschedule(0.2)
await asyncio.sleep(0.19)
assert len(callback.mock_calls) == 0
await asyncio.sleep(0.02)
assert len(callback.mock_calls) == 1
async def test_reschedulable_timeout_cancel():
callback = Mock()
timeout = datastructures.ReschedulableTimeout(callback)
timeout.reschedule(0.1)
assert len(callback.mock_calls) == 0
await asyncio.sleep(0.09)
timeout.cancel()
await asyncio.sleep(0.02)
assert len(callback.mock_calls) == 0
async def test_debouncer():
"""Test debouncer."""
debouncer = datastructures.Debouncer()
debouncer.clean()
assert repr(debouncer) == "<Debouncer [tracked:0]>"
obj1 = object()
assert not debouncer.is_filtered(obj1)
assert not debouncer.filter(obj1, expire_in=0.1)
assert debouncer.is_filtered(obj1)
assert debouncer.filter(obj1, expire_in=1)
assert debouncer.filter(obj1, expire_in=0.1)
assert debouncer.filter(obj1, expire_in=1)
assert debouncer.is_filtered(obj1)
assert repr(debouncer) == "<Debouncer [tracked:1]>"
obj2 = object()
assert not debouncer.is_filtered(obj2)
assert not debouncer.filter(obj2, expire_in=0.2)
assert debouncer.filter(obj1, expire_in=1)
assert debouncer.filter(obj2, expire_in=1)
assert debouncer.filter(obj1, expire_in=1)
assert debouncer.filter(obj2, expire_in=1)
assert debouncer.is_filtered(obj1)
assert debouncer.is_filtered(obj2)
assert repr(debouncer) == "<Debouncer [tracked:2]>"
await asyncio.sleep(0.1)
assert not debouncer.is_filtered(obj1)
assert debouncer.is_filtered(obj2)
assert repr(debouncer) == "<Debouncer [tracked:1]>"
await asyncio.sleep(0.1)
assert not debouncer.is_filtered(obj1)
assert not debouncer.is_filtered(obj2)
assert repr(debouncer) == "<Debouncer [tracked:0]>"
async def test_debouncer_low_resolution_clock():
"""Test debouncer with a low resolution clock."""
loop = asyncio.get_running_loop()
now = loop.time()
# Make sure we can debounce on a low resolution clock
with patch.object(loop, "time", return_value=now):
debouncer = datastructures.Debouncer()
obj1 = object()
debouncer.filter(obj1, expire_in=0.1)
assert debouncer.is_filtered(obj1)
obj2 = object()
debouncer.filter(obj2, expire_in=0.1)
assert debouncer.is_filtered(obj2)
# The two objects cannot be compared
with pytest.raises(TypeError):
obj1 < obj2 # noqa: B015
async def test_debouncer_cleaning_bug():
"""Test debouncer bug when using heapq improperly."""
debouncer = datastructures.Debouncer()
obj1 = object()
obj2 = object()
obj3 = object()
# Filter obj1 with an expiration of 0.3 seconds
debouncer.filter(obj1, expire_in=0.3)
# Slight delay to ensure different expiration times
await asyncio.sleep(0.05)
# Filter obj2 with an expiration of 0.1 seconds
debouncer.filter(obj2, expire_in=0.1)
# Another slight delay
await asyncio.sleep(0.05)
# Filter obj3 with an expiration of 0.2 seconds
debouncer.filter(obj3, expire_in=0.2)
assert debouncer.is_filtered(obj1)
assert debouncer.is_filtered(obj2)
assert debouncer.is_filtered(obj3)
# Wait until after obj2 should have expired
await asyncio.sleep(0.11) # Total elapsed time ~0.21 seconds from start
# Clean up expired items
debouncer.clean()
# obj2 should have expired, but due to the bug, it might still be filtered
assert not debouncer.is_filtered(obj2)
# obj1 and obj3 should still be filtered
assert debouncer.is_filtered(obj1)
assert debouncer.is_filtered(obj3)
# Wait until after obj1 and obj3 should have expired
await asyncio.sleep(0.1) # Total elapsed time ~0.31 seconds from start
# Clean up expired items
debouncer.clean()
# Now all objects should have expired
assert not debouncer.is_filtered(obj1)
assert not debouncer.is_filtered(obj3)
# The queue should be empty
assert len(debouncer._queue) == 0
|
