blob: 5b1f033c6f806d5d2900afee9152b4093e38b7e8 [file] [log] [blame]
Antoine Pitrou557934f2009-11-06 22:41:14 +00001"""
2Various tests for synchronization primitives.
3"""
4
5import sys
6import time
Victor Stinner2a129742011-05-30 23:02:52 +02007from _thread import start_new_thread, TIMEOUT_MAX
Antoine Pitrou557934f2009-11-06 22:41:14 +00008import threading
9import unittest
Raymond Hettinger7836a272015-10-09 00:03:51 -040010import weakref
Antoine Pitrou557934f2009-11-06 22:41:14 +000011
12from test import support
13
14
15def _wait():
16 # A crude wait/yield function not relying on synchronization primitives.
17 time.sleep(0.01)
18
19class Bunch(object):
20 """
21 A bunch of threads.
22 """
23 def __init__(self, f, n, wait_before_exit=False):
24 """
25 Construct a bunch of `n` threads running the same function `f`.
26 If `wait_before_exit` is True, the threads won't terminate until
27 do_finish() is called.
28 """
29 self.f = f
30 self.n = n
31 self.started = []
32 self.finished = []
33 self._can_exit = not wait_before_exit
Victor Stinnerff40ecd2017-09-14 13:07:24 -070034 self.wait_thread = support.wait_threads_exit()
35 self.wait_thread.__enter__()
36
Antoine Pitrou557934f2009-11-06 22:41:14 +000037 def task():
Victor Stinner2a129742011-05-30 23:02:52 +020038 tid = threading.get_ident()
Antoine Pitrou557934f2009-11-06 22:41:14 +000039 self.started.append(tid)
40 try:
41 f()
42 finally:
43 self.finished.append(tid)
44 while not self._can_exit:
45 _wait()
Victor Stinnerff40ecd2017-09-14 13:07:24 -070046
Serhiy Storchaka9db55002015-03-28 20:38:37 +020047 try:
48 for i in range(n):
49 start_new_thread(task, ())
50 except:
51 self._can_exit = True
52 raise
Antoine Pitrou557934f2009-11-06 22:41:14 +000053
54 def wait_for_started(self):
55 while len(self.started) < self.n:
56 _wait()
57
58 def wait_for_finished(self):
59 while len(self.finished) < self.n:
60 _wait()
Victor Stinnerff40ecd2017-09-14 13:07:24 -070061 # Wait for threads exit
62 self.wait_thread.__exit__(None, None, None)
Antoine Pitrou557934f2009-11-06 22:41:14 +000063
64 def do_finish(self):
65 self._can_exit = True
66
67
68class BaseTestCase(unittest.TestCase):
69 def setUp(self):
70 self._threads = support.threading_setup()
71
72 def tearDown(self):
73 support.threading_cleanup(*self._threads)
74 support.reap_children()
75
Antoine Pitrou7c3e5772010-04-14 15:44:10 +000076 def assertTimeout(self, actual, expected):
77 # The waiting and/or time.time() can be imprecise, which
78 # is why comparing to the expected value would sometimes fail
79 # (especially under Windows).
80 self.assertGreaterEqual(actual, expected * 0.6)
81 # Test nothing insane happened
82 self.assertLess(actual, expected * 10.0)
83
Antoine Pitrou557934f2009-11-06 22:41:14 +000084
85class BaseLockTests(BaseTestCase):
86 """
87 Tests for both recursive and non-recursive locks.
88 """
89
90 def test_constructor(self):
91 lock = self.locktype()
92 del lock
93
Christian Heimesc5d95b12013-07-30 15:54:39 +020094 def test_repr(self):
95 lock = self.locktype()
Raymond Hettinger62f4dad2014-05-25 18:22:35 -070096 self.assertRegex(repr(lock), "<unlocked .* object (.*)?at .*>")
97 del lock
98
99 def test_locked_repr(self):
100 lock = self.locktype()
101 lock.acquire()
102 self.assertRegex(repr(lock), "<locked .* object (.*)?at .*>")
Christian Heimesc5d95b12013-07-30 15:54:39 +0200103 del lock
104
Antoine Pitrou557934f2009-11-06 22:41:14 +0000105 def test_acquire_destroy(self):
106 lock = self.locktype()
107 lock.acquire()
108 del lock
109
110 def test_acquire_release(self):
111 lock = self.locktype()
112 lock.acquire()
113 lock.release()
114 del lock
115
116 def test_try_acquire(self):
117 lock = self.locktype()
118 self.assertTrue(lock.acquire(False))
119 lock.release()
120
121 def test_try_acquire_contended(self):
122 lock = self.locktype()
123 lock.acquire()
124 result = []
125 def f():
126 result.append(lock.acquire(False))
127 Bunch(f, 1).wait_for_finished()
128 self.assertFalse(result[0])
129 lock.release()
130
131 def test_acquire_contended(self):
132 lock = self.locktype()
133 lock.acquire()
134 N = 5
135 def f():
136 lock.acquire()
137 lock.release()
138
139 b = Bunch(f, N)
140 b.wait_for_started()
141 _wait()
142 self.assertEqual(len(b.finished), 0)
143 lock.release()
144 b.wait_for_finished()
145 self.assertEqual(len(b.finished), N)
146
147 def test_with(self):
148 lock = self.locktype()
149 def f():
150 lock.acquire()
151 lock.release()
152 def _with(err=None):
153 with lock:
154 if err is not None:
155 raise err
156 _with()
157 # Check the lock is unacquired
158 Bunch(f, 1).wait_for_finished()
159 self.assertRaises(TypeError, _with, TypeError)
160 # Check the lock is unacquired
161 Bunch(f, 1).wait_for_finished()
162
Antoine Pitroub0872682009-11-09 16:08:16 +0000163 def test_thread_leak(self):
164 # The lock shouldn't leak a Thread instance when used from a foreign
165 # (non-threading) thread.
166 lock = self.locktype()
167 def f():
168 lock.acquire()
169 lock.release()
170 n = len(threading.enumerate())
171 # We run many threads in the hope that existing threads ids won't
172 # be recycled.
173 Bunch(f, 15).wait_for_finished()
Antoine Pitrou45fdb452011-04-04 21:59:09 +0200174 if len(threading.enumerate()) != n:
175 # There is a small window during which a Thread instance's
176 # target function has finished running, but the Thread is still
177 # alive and registered. Avoid spurious failures by waiting a
178 # bit more (seen on a buildbot).
179 time.sleep(0.4)
180 self.assertEqual(n, len(threading.enumerate()))
Antoine Pitroub0872682009-11-09 16:08:16 +0000181
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000182 def test_timeout(self):
183 lock = self.locktype()
184 # Can't set timeout if not blocking
185 self.assertRaises(ValueError, lock.acquire, 0, 1)
186 # Invalid timeout values
187 self.assertRaises(ValueError, lock.acquire, timeout=-100)
188 self.assertRaises(OverflowError, lock.acquire, timeout=1e100)
189 self.assertRaises(OverflowError, lock.acquire, timeout=TIMEOUT_MAX + 1)
190 # TIMEOUT_MAX is ok
191 lock.acquire(timeout=TIMEOUT_MAX)
192 lock.release()
193 t1 = time.time()
194 self.assertTrue(lock.acquire(timeout=5))
195 t2 = time.time()
196 # Just a sanity test that it didn't actually wait for the timeout.
197 self.assertLess(t2 - t1, 5)
198 results = []
199 def f():
200 t1 = time.time()
201 results.append(lock.acquire(timeout=0.5))
202 t2 = time.time()
203 results.append(t2 - t1)
204 Bunch(f, 1).wait_for_finished()
205 self.assertFalse(results[0])
206 self.assertTimeout(results[1], 0.5)
207
Raymond Hettinger7836a272015-10-09 00:03:51 -0400208 def test_weakref_exists(self):
209 lock = self.locktype()
210 ref = weakref.ref(lock)
211 self.assertIsNotNone(ref())
212
213 def test_weakref_deleted(self):
214 lock = self.locktype()
215 ref = weakref.ref(lock)
216 del lock
217 self.assertIsNone(ref())
218
Antoine Pitrou557934f2009-11-06 22:41:14 +0000219
220class LockTests(BaseLockTests):
221 """
222 Tests for non-recursive, weak locks
223 (which can be acquired and released from different threads).
224 """
225 def test_reacquire(self):
226 # Lock needs to be released before re-acquiring.
227 lock = self.locktype()
228 phase = []
Victor Stinnerff40ecd2017-09-14 13:07:24 -0700229
Antoine Pitrou557934f2009-11-06 22:41:14 +0000230 def f():
231 lock.acquire()
232 phase.append(None)
233 lock.acquire()
234 phase.append(None)
Victor Stinnerff40ecd2017-09-14 13:07:24 -0700235
236 with support.wait_threads_exit():
237 start_new_thread(f, ())
238 while len(phase) == 0:
239 _wait()
Antoine Pitrou557934f2009-11-06 22:41:14 +0000240 _wait()
Victor Stinnerff40ecd2017-09-14 13:07:24 -0700241 self.assertEqual(len(phase), 1)
242 lock.release()
243 while len(phase) == 1:
244 _wait()
245 self.assertEqual(len(phase), 2)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000246
247 def test_different_thread(self):
248 # Lock can be released from a different thread.
249 lock = self.locktype()
250 lock.acquire()
251 def f():
252 lock.release()
253 b = Bunch(f, 1)
254 b.wait_for_finished()
255 lock.acquire()
256 lock.release()
257
Antoine Pitrou7899acf2011-03-31 01:00:32 +0200258 def test_state_after_timeout(self):
259 # Issue #11618: check that lock is in a proper state after a
260 # (non-zero) timeout.
261 lock = self.locktype()
262 lock.acquire()
263 self.assertFalse(lock.acquire(timeout=0.01))
264 lock.release()
265 self.assertFalse(lock.locked())
266 self.assertTrue(lock.acquire(blocking=False))
267
Antoine Pitrou557934f2009-11-06 22:41:14 +0000268
269class RLockTests(BaseLockTests):
270 """
271 Tests for recursive locks.
272 """
273 def test_reacquire(self):
274 lock = self.locktype()
275 lock.acquire()
276 lock.acquire()
277 lock.release()
278 lock.acquire()
279 lock.release()
280 lock.release()
281
282 def test_release_unacquired(self):
283 # Cannot release an unacquired lock
284 lock = self.locktype()
285 self.assertRaises(RuntimeError, lock.release)
286 lock.acquire()
287 lock.acquire()
288 lock.release()
289 lock.acquire()
290 lock.release()
291 lock.release()
292 self.assertRaises(RuntimeError, lock.release)
Antoine Pitrouea3eb882012-05-17 18:55:59 +0200293
294 def test_release_save_unacquired(self):
295 # Cannot _release_save an unacquired lock
296 lock = self.locktype()
297 self.assertRaises(RuntimeError, lock._release_save)
298 lock.acquire()
299 lock.acquire()
300 lock.release()
301 lock.acquire()
302 lock.release()
303 lock.release()
Victor Stinnerc2824d42011-04-24 23:41:33 +0200304 self.assertRaises(RuntimeError, lock._release_save)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000305
306 def test_different_thread(self):
307 # Cannot release from a different thread
308 lock = self.locktype()
309 def f():
310 lock.acquire()
311 b = Bunch(f, 1, True)
312 try:
313 self.assertRaises(RuntimeError, lock.release)
314 finally:
315 b.do_finish()
Victor Stinner096ae332017-09-13 16:41:08 -0700316 b.wait_for_finished()
Antoine Pitrou557934f2009-11-06 22:41:14 +0000317
318 def test__is_owned(self):
319 lock = self.locktype()
320 self.assertFalse(lock._is_owned())
321 lock.acquire()
322 self.assertTrue(lock._is_owned())
323 lock.acquire()
324 self.assertTrue(lock._is_owned())
325 result = []
326 def f():
327 result.append(lock._is_owned())
328 Bunch(f, 1).wait_for_finished()
329 self.assertFalse(result[0])
330 lock.release()
331 self.assertTrue(lock._is_owned())
332 lock.release()
333 self.assertFalse(lock._is_owned())
334
335
336class EventTests(BaseTestCase):
337 """
338 Tests for Event objects.
339 """
340
341 def test_is_set(self):
342 evt = self.eventtype()
343 self.assertFalse(evt.is_set())
344 evt.set()
345 self.assertTrue(evt.is_set())
346 evt.set()
347 self.assertTrue(evt.is_set())
348 evt.clear()
349 self.assertFalse(evt.is_set())
350 evt.clear()
351 self.assertFalse(evt.is_set())
352
353 def _check_notify(self, evt):
354 # All threads get notified
355 N = 5
356 results1 = []
357 results2 = []
358 def f():
359 results1.append(evt.wait())
360 results2.append(evt.wait())
361 b = Bunch(f, N)
362 b.wait_for_started()
363 _wait()
364 self.assertEqual(len(results1), 0)
365 evt.set()
366 b.wait_for_finished()
367 self.assertEqual(results1, [True] * N)
368 self.assertEqual(results2, [True] * N)
369
370 def test_notify(self):
371 evt = self.eventtype()
372 self._check_notify(evt)
373 # Another time, after an explicit clear()
374 evt.set()
375 evt.clear()
376 self._check_notify(evt)
377
378 def test_timeout(self):
379 evt = self.eventtype()
380 results1 = []
381 results2 = []
382 N = 5
383 def f():
384 results1.append(evt.wait(0.0))
385 t1 = time.time()
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000386 r = evt.wait(0.5)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000387 t2 = time.time()
388 results2.append((r, t2 - t1))
389 Bunch(f, N).wait_for_finished()
390 self.assertEqual(results1, [False] * N)
391 for r, dt in results2:
392 self.assertFalse(r)
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000393 self.assertTimeout(dt, 0.5)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000394 # The event is set
395 results1 = []
396 results2 = []
397 evt.set()
398 Bunch(f, N).wait_for_finished()
399 self.assertEqual(results1, [True] * N)
400 for r, dt in results2:
401 self.assertTrue(r)
402
Charles-François Natalided03482012-01-07 18:24:56 +0100403 def test_set_and_clear(self):
404 # Issue #13502: check that wait() returns true even when the event is
405 # cleared before the waiting thread is woken up.
406 evt = self.eventtype()
407 results = []
408 N = 5
409 def f():
410 results.append(evt.wait(1))
411 b = Bunch(f, N)
412 b.wait_for_started()
413 time.sleep(0.5)
414 evt.set()
415 evt.clear()
416 b.wait_for_finished()
417 self.assertEqual(results, [True] * N)
418
Benjamin Peterson15982aa2015-10-05 21:56:22 -0700419 def test_reset_internal_locks(self):
Berker Peksag6d34bbb2016-04-29 17:25:29 +0300420 # ensure that condition is still using a Lock after reset
Benjamin Peterson15982aa2015-10-05 21:56:22 -0700421 evt = self.eventtype()
Berker Peksag6d34bbb2016-04-29 17:25:29 +0300422 with evt._cond:
423 self.assertFalse(evt._cond.acquire(False))
Benjamin Peterson15982aa2015-10-05 21:56:22 -0700424 evt._reset_internal_locks()
Berker Peksag6d34bbb2016-04-29 17:25:29 +0300425 with evt._cond:
426 self.assertFalse(evt._cond.acquire(False))
Benjamin Peterson15982aa2015-10-05 21:56:22 -0700427
Antoine Pitrou557934f2009-11-06 22:41:14 +0000428
429class ConditionTests(BaseTestCase):
430 """
431 Tests for condition variables.
432 """
433
434 def test_acquire(self):
435 cond = self.condtype()
436 # Be default we have an RLock: the condition can be acquired multiple
437 # times.
438 cond.acquire()
439 cond.acquire()
440 cond.release()
441 cond.release()
442 lock = threading.Lock()
443 cond = self.condtype(lock)
444 cond.acquire()
445 self.assertFalse(lock.acquire(False))
446 cond.release()
447 self.assertTrue(lock.acquire(False))
448 self.assertFalse(cond.acquire(False))
449 lock.release()
450 with cond:
451 self.assertFalse(lock.acquire(False))
452
453 def test_unacquired_wait(self):
454 cond = self.condtype()
455 self.assertRaises(RuntimeError, cond.wait)
456
457 def test_unacquired_notify(self):
458 cond = self.condtype()
459 self.assertRaises(RuntimeError, cond.notify)
460
461 def _check_notify(self, cond):
Kristjan Valur Jonsson020af2a2013-11-11 11:29:04 +0000462 # Note that this test is sensitive to timing. If the worker threads
463 # don't execute in a timely fashion, the main thread may think they
464 # are further along then they are. The main thread therefore issues
465 # _wait() statements to try to make sure that it doesn't race ahead
466 # of the workers.
467 # Secondly, this test assumes that condition variables are not subject
468 # to spurious wakeups. The absence of spurious wakeups is an implementation
469 # detail of Condition Cariables in current CPython, but in general, not
470 # a guaranteed property of condition variables as a programming
471 # construct. In particular, it is possible that this can no longer
472 # be conveniently guaranteed should their implementation ever change.
Antoine Pitrou557934f2009-11-06 22:41:14 +0000473 N = 5
Serhiy Storchaka32cb9682017-06-23 13:36:36 +0300474 ready = []
Antoine Pitrou557934f2009-11-06 22:41:14 +0000475 results1 = []
476 results2 = []
477 phase_num = 0
478 def f():
479 cond.acquire()
Serhiy Storchaka32cb9682017-06-23 13:36:36 +0300480 ready.append(phase_num)
Georg Brandlb9a43912010-10-28 09:03:20 +0000481 result = cond.wait()
Antoine Pitrou557934f2009-11-06 22:41:14 +0000482 cond.release()
Georg Brandlb9a43912010-10-28 09:03:20 +0000483 results1.append((result, phase_num))
Antoine Pitrou557934f2009-11-06 22:41:14 +0000484 cond.acquire()
Serhiy Storchaka32cb9682017-06-23 13:36:36 +0300485 ready.append(phase_num)
Georg Brandlb9a43912010-10-28 09:03:20 +0000486 result = cond.wait()
Antoine Pitrou557934f2009-11-06 22:41:14 +0000487 cond.release()
Georg Brandlb9a43912010-10-28 09:03:20 +0000488 results2.append((result, phase_num))
Antoine Pitrou557934f2009-11-06 22:41:14 +0000489 b = Bunch(f, N)
490 b.wait_for_started()
Serhiy Storchaka32cb9682017-06-23 13:36:36 +0300491 # first wait, to ensure all workers settle into cond.wait() before
492 # we continue. See issues #8799 and #30727.
493 while len(ready) < 5:
494 _wait()
495 ready.clear()
Antoine Pitrou557934f2009-11-06 22:41:14 +0000496 self.assertEqual(results1, [])
497 # Notify 3 threads at first
498 cond.acquire()
499 cond.notify(3)
500 _wait()
501 phase_num = 1
502 cond.release()
503 while len(results1) < 3:
504 _wait()
Georg Brandlb9a43912010-10-28 09:03:20 +0000505 self.assertEqual(results1, [(True, 1)] * 3)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000506 self.assertEqual(results2, [])
Serhiy Storchaka32cb9682017-06-23 13:36:36 +0300507 # make sure all awaken workers settle into cond.wait()
508 while len(ready) < 3:
509 _wait()
Antoine Pitrou557934f2009-11-06 22:41:14 +0000510 # Notify 5 threads: they might be in their first or second wait
511 cond.acquire()
512 cond.notify(5)
513 _wait()
514 phase_num = 2
515 cond.release()
516 while len(results1) + len(results2) < 8:
517 _wait()
Georg Brandlb9a43912010-10-28 09:03:20 +0000518 self.assertEqual(results1, [(True, 1)] * 3 + [(True, 2)] * 2)
519 self.assertEqual(results2, [(True, 2)] * 3)
Serhiy Storchaka32cb9682017-06-23 13:36:36 +0300520 # make sure all workers settle into cond.wait()
521 while len(ready) < 5:
522 _wait()
Antoine Pitrou557934f2009-11-06 22:41:14 +0000523 # Notify all threads: they are all in their second wait
524 cond.acquire()
525 cond.notify_all()
526 _wait()
527 phase_num = 3
528 cond.release()
529 while len(results2) < 5:
530 _wait()
Georg Brandlb9a43912010-10-28 09:03:20 +0000531 self.assertEqual(results1, [(True, 1)] * 3 + [(True,2)] * 2)
532 self.assertEqual(results2, [(True, 2)] * 3 + [(True, 3)] * 2)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000533 b.wait_for_finished()
534
535 def test_notify(self):
536 cond = self.condtype()
537 self._check_notify(cond)
538 # A second time, to check internal state is still ok.
539 self._check_notify(cond)
540
541 def test_timeout(self):
542 cond = self.condtype()
543 results = []
544 N = 5
545 def f():
546 cond.acquire()
547 t1 = time.time()
Georg Brandlb9a43912010-10-28 09:03:20 +0000548 result = cond.wait(0.5)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000549 t2 = time.time()
550 cond.release()
Georg Brandlb9a43912010-10-28 09:03:20 +0000551 results.append((t2 - t1, result))
Antoine Pitrou557934f2009-11-06 22:41:14 +0000552 Bunch(f, N).wait_for_finished()
Georg Brandlb9a43912010-10-28 09:03:20 +0000553 self.assertEqual(len(results), N)
554 for dt, result in results:
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000555 self.assertTimeout(dt, 0.5)
Georg Brandlb9a43912010-10-28 09:03:20 +0000556 # Note that conceptually (that"s the condition variable protocol)
557 # a wait() may succeed even if no one notifies us and before any
558 # timeout occurs. Spurious wakeups can occur.
559 # This makes it hard to verify the result value.
560 # In practice, this implementation has no spurious wakeups.
561 self.assertFalse(result)
Antoine Pitrou557934f2009-11-06 22:41:14 +0000562
Kristján Valur Jónsson63315202010-11-18 12:46:39 +0000563 def test_waitfor(self):
564 cond = self.condtype()
565 state = 0
566 def f():
567 with cond:
568 result = cond.wait_for(lambda : state==4)
569 self.assertTrue(result)
570 self.assertEqual(state, 4)
571 b = Bunch(f, 1)
572 b.wait_for_started()
Victor Stinner3349bca2011-05-18 00:16:14 +0200573 for i in range(4):
Kristján Valur Jónsson63315202010-11-18 12:46:39 +0000574 time.sleep(0.01)
575 with cond:
576 state += 1
577 cond.notify()
578 b.wait_for_finished()
579
580 def test_waitfor_timeout(self):
581 cond = self.condtype()
582 state = 0
583 success = []
584 def f():
585 with cond:
586 dt = time.time()
587 result = cond.wait_for(lambda : state==4, timeout=0.1)
588 dt = time.time() - dt
589 self.assertFalse(result)
590 self.assertTimeout(dt, 0.1)
591 success.append(None)
592 b = Bunch(f, 1)
593 b.wait_for_started()
594 # Only increment 3 times, so state == 4 is never reached.
595 for i in range(3):
596 time.sleep(0.01)
597 with cond:
598 state += 1
599 cond.notify()
600 b.wait_for_finished()
601 self.assertEqual(len(success), 1)
602
Antoine Pitrou557934f2009-11-06 22:41:14 +0000603
604class BaseSemaphoreTests(BaseTestCase):
605 """
606 Common tests for {bounded, unbounded} semaphore objects.
607 """
608
609 def test_constructor(self):
610 self.assertRaises(ValueError, self.semtype, value = -1)
611 self.assertRaises(ValueError, self.semtype, value = -sys.maxsize)
612
613 def test_acquire(self):
614 sem = self.semtype(1)
615 sem.acquire()
616 sem.release()
617 sem = self.semtype(2)
618 sem.acquire()
619 sem.acquire()
620 sem.release()
621 sem.release()
622
623 def test_acquire_destroy(self):
624 sem = self.semtype()
625 sem.acquire()
626 del sem
627
628 def test_acquire_contended(self):
629 sem = self.semtype(7)
630 sem.acquire()
631 N = 10
Garrett Berga0374dd2017-12-07 11:04:26 -0700632 sem_results = []
Antoine Pitrou557934f2009-11-06 22:41:14 +0000633 results1 = []
634 results2 = []
635 phase_num = 0
636 def f():
Garrett Berga0374dd2017-12-07 11:04:26 -0700637 sem_results.append(sem.acquire())
Antoine Pitrou557934f2009-11-06 22:41:14 +0000638 results1.append(phase_num)
Garrett Berga0374dd2017-12-07 11:04:26 -0700639 sem_results.append(sem.acquire())
Antoine Pitrou557934f2009-11-06 22:41:14 +0000640 results2.append(phase_num)
641 b = Bunch(f, 10)
642 b.wait_for_started()
643 while len(results1) + len(results2) < 6:
644 _wait()
645 self.assertEqual(results1 + results2, [0] * 6)
646 phase_num = 1
647 for i in range(7):
648 sem.release()
649 while len(results1) + len(results2) < 13:
650 _wait()
651 self.assertEqual(sorted(results1 + results2), [0] * 6 + [1] * 7)
652 phase_num = 2
653 for i in range(6):
654 sem.release()
655 while len(results1) + len(results2) < 19:
656 _wait()
657 self.assertEqual(sorted(results1 + results2), [0] * 6 + [1] * 7 + [2] * 6)
658 # The semaphore is still locked
659 self.assertFalse(sem.acquire(False))
660 # Final release, to let the last thread finish
661 sem.release()
662 b.wait_for_finished()
Garrett Berga0374dd2017-12-07 11:04:26 -0700663 self.assertEqual(sem_results, [True] * (6 + 7 + 6 + 1))
Antoine Pitrou557934f2009-11-06 22:41:14 +0000664
665 def test_try_acquire(self):
666 sem = self.semtype(2)
667 self.assertTrue(sem.acquire(False))
668 self.assertTrue(sem.acquire(False))
669 self.assertFalse(sem.acquire(False))
670 sem.release()
671 self.assertTrue(sem.acquire(False))
672
673 def test_try_acquire_contended(self):
674 sem = self.semtype(4)
675 sem.acquire()
676 results = []
677 def f():
678 results.append(sem.acquire(False))
679 results.append(sem.acquire(False))
680 Bunch(f, 5).wait_for_finished()
681 # There can be a thread switch between acquiring the semaphore and
682 # appending the result, therefore results will not necessarily be
683 # ordered.
684 self.assertEqual(sorted(results), [False] * 7 + [True] * 3 )
685
Antoine Pitrou0454af92010-04-17 23:51:58 +0000686 def test_acquire_timeout(self):
687 sem = self.semtype(2)
688 self.assertRaises(ValueError, sem.acquire, False, timeout=1.0)
689 self.assertTrue(sem.acquire(timeout=0.005))
690 self.assertTrue(sem.acquire(timeout=0.005))
691 self.assertFalse(sem.acquire(timeout=0.005))
692 sem.release()
693 self.assertTrue(sem.acquire(timeout=0.005))
694 t = time.time()
695 self.assertFalse(sem.acquire(timeout=0.5))
696 dt = time.time() - t
697 self.assertTimeout(dt, 0.5)
698
Antoine Pitrou557934f2009-11-06 22:41:14 +0000699 def test_default_value(self):
700 # The default initial value is 1.
701 sem = self.semtype()
702 sem.acquire()
703 def f():
704 sem.acquire()
705 sem.release()
706 b = Bunch(f, 1)
707 b.wait_for_started()
708 _wait()
709 self.assertFalse(b.finished)
710 sem.release()
711 b.wait_for_finished()
712
713 def test_with(self):
714 sem = self.semtype(2)
715 def _with(err=None):
716 with sem:
717 self.assertTrue(sem.acquire(False))
718 sem.release()
719 with sem:
720 self.assertFalse(sem.acquire(False))
721 if err:
722 raise err
723 _with()
724 self.assertTrue(sem.acquire(False))
725 sem.release()
726 self.assertRaises(TypeError, _with, TypeError)
727 self.assertTrue(sem.acquire(False))
728 sem.release()
729
730class SemaphoreTests(BaseSemaphoreTests):
731 """
732 Tests for unbounded semaphores.
733 """
734
735 def test_release_unacquired(self):
736 # Unbounded releases are allowed and increment the semaphore's value
737 sem = self.semtype(1)
738 sem.release()
739 sem.acquire()
740 sem.acquire()
741 sem.release()
742
743
744class BoundedSemaphoreTests(BaseSemaphoreTests):
745 """
746 Tests for bounded semaphores.
747 """
748
749 def test_release_unacquired(self):
750 # Cannot go past the initial value
751 sem = self.semtype()
752 self.assertRaises(ValueError, sem.release)
753 sem.acquire()
754 sem.release()
755 self.assertRaises(ValueError, sem.release)
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000756
757
758class BarrierTests(BaseTestCase):
759 """
760 Tests for Barrier objects.
761 """
762 N = 5
Antoine Pitrou12ae2902010-11-17 21:55:41 +0000763 defaultTimeout = 2.0
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000764
765 def setUp(self):
Kristján Valur Jónssonf53a6262010-10-31 03:00:57 +0000766 self.barrier = self.barriertype(self.N, timeout=self.defaultTimeout)
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000767 def tearDown(self):
768 self.barrier.abort()
769
770 def run_threads(self, f):
771 b = Bunch(f, self.N-1)
772 f()
773 b.wait_for_finished()
774
775 def multipass(self, results, n):
776 m = self.barrier.parties
777 self.assertEqual(m, self.N)
778 for i in range(n):
779 results[0].append(True)
780 self.assertEqual(len(results[1]), i * m)
781 self.barrier.wait()
782 results[1].append(True)
783 self.assertEqual(len(results[0]), (i + 1) * m)
784 self.barrier.wait()
785 self.assertEqual(self.barrier.n_waiting, 0)
786 self.assertFalse(self.barrier.broken)
787
788 def test_barrier(self, passes=1):
789 """
790 Test that a barrier is passed in lockstep
791 """
792 results = [[],[]]
793 def f():
794 self.multipass(results, passes)
795 self.run_threads(f)
796
797 def test_barrier_10(self):
798 """
799 Test that a barrier works for 10 consecutive runs
800 """
801 return self.test_barrier(10)
802
803 def test_wait_return(self):
804 """
805 test the return value from barrier.wait
806 """
807 results = []
808 def f():
809 r = self.barrier.wait()
810 results.append(r)
811
812 self.run_threads(f)
813 self.assertEqual(sum(results), sum(range(self.N)))
814
815 def test_action(self):
816 """
817 Test the 'action' callback
818 """
819 results = []
820 def action():
821 results.append(True)
822 barrier = self.barriertype(self.N, action)
823 def f():
824 barrier.wait()
825 self.assertEqual(len(results), 1)
826
827 self.run_threads(f)
828
829 def test_abort(self):
830 """
831 Test that an abort will put the barrier in a broken state
832 """
833 results1 = []
834 results2 = []
835 def f():
836 try:
837 i = self.barrier.wait()
838 if i == self.N//2:
839 raise RuntimeError
840 self.barrier.wait()
841 results1.append(True)
842 except threading.BrokenBarrierError:
843 results2.append(True)
844 except RuntimeError:
845 self.barrier.abort()
846 pass
847
848 self.run_threads(f)
849 self.assertEqual(len(results1), 0)
850 self.assertEqual(len(results2), self.N-1)
851 self.assertTrue(self.barrier.broken)
852
853 def test_reset(self):
854 """
855 Test that a 'reset' on a barrier frees the waiting threads
856 """
857 results1 = []
858 results2 = []
859 results3 = []
860 def f():
861 i = self.barrier.wait()
862 if i == self.N//2:
863 # Wait until the other threads are all in the barrier.
864 while self.barrier.n_waiting < self.N-1:
865 time.sleep(0.001)
866 self.barrier.reset()
867 else:
868 try:
869 self.barrier.wait()
870 results1.append(True)
871 except threading.BrokenBarrierError:
872 results2.append(True)
873 # Now, pass the barrier again
874 self.barrier.wait()
875 results3.append(True)
876
877 self.run_threads(f)
878 self.assertEqual(len(results1), 0)
879 self.assertEqual(len(results2), self.N-1)
880 self.assertEqual(len(results3), self.N)
881
882
883 def test_abort_and_reset(self):
884 """
885 Test that a barrier can be reset after being broken.
886 """
887 results1 = []
888 results2 = []
889 results3 = []
890 barrier2 = self.barriertype(self.N)
891 def f():
892 try:
893 i = self.barrier.wait()
894 if i == self.N//2:
895 raise RuntimeError
896 self.barrier.wait()
897 results1.append(True)
898 except threading.BrokenBarrierError:
899 results2.append(True)
900 except RuntimeError:
901 self.barrier.abort()
902 pass
903 # Synchronize and reset the barrier. Must synchronize first so
904 # that everyone has left it when we reset, and after so that no
905 # one enters it before the reset.
906 if barrier2.wait() == self.N//2:
907 self.barrier.reset()
908 barrier2.wait()
909 self.barrier.wait()
910 results3.append(True)
911
912 self.run_threads(f)
913 self.assertEqual(len(results1), 0)
914 self.assertEqual(len(results2), self.N-1)
915 self.assertEqual(len(results3), self.N)
916
917 def test_timeout(self):
918 """
919 Test wait(timeout)
920 """
921 def f():
922 i = self.barrier.wait()
923 if i == self.N // 2:
924 # One thread is late!
Antoine Pitrou12ae2902010-11-17 21:55:41 +0000925 time.sleep(1.0)
926 # Default timeout is 2.0, so this is shorter.
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000927 self.assertRaises(threading.BrokenBarrierError,
Antoine Pitrou12ae2902010-11-17 21:55:41 +0000928 self.barrier.wait, 0.5)
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000929 self.run_threads(f)
930
931 def test_default_timeout(self):
932 """
933 Test the barrier's default timeout
934 """
Charles-François Natalid4d1d062011-07-27 21:26:42 +0200935 # create a barrier with a low default timeout
936 barrier = self.barriertype(self.N, timeout=0.3)
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000937 def f():
Kristján Valur Jónssonf53a6262010-10-31 03:00:57 +0000938 i = barrier.wait()
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000939 if i == self.N // 2:
Charles-François Natalid4d1d062011-07-27 21:26:42 +0200940 # One thread is later than the default timeout of 0.3s.
Antoine Pitrou12ae2902010-11-17 21:55:41 +0000941 time.sleep(1.0)
Kristján Valur Jónssonf53a6262010-10-31 03:00:57 +0000942 self.assertRaises(threading.BrokenBarrierError, barrier.wait)
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000943 self.run_threads(f)
944
945 def test_single_thread(self):
946 b = self.barriertype(1)
947 b.wait()
948 b.wait()