Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 1 | """ |
| 2 | Various tests for synchronization primitives. |
| 3 | """ |
| 4 | |
| 5 | import sys |
| 6 | import time |
Victor Stinner | 2a12974 | 2011-05-30 23:02:52 +0200 | [diff] [blame] | 7 | from _thread import start_new_thread, TIMEOUT_MAX |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 8 | import threading |
| 9 | import unittest |
| 10 | |
| 11 | from test import support |
| 12 | |
| 13 | |
| 14 | def _wait(): |
| 15 | # A crude wait/yield function not relying on synchronization primitives. |
| 16 | time.sleep(0.01) |
| 17 | |
| 18 | class Bunch(object): |
| 19 | """ |
| 20 | A bunch of threads. |
| 21 | """ |
| 22 | def __init__(self, f, n, wait_before_exit=False): |
| 23 | """ |
| 24 | Construct a bunch of `n` threads running the same function `f`. |
| 25 | If `wait_before_exit` is True, the threads won't terminate until |
| 26 | do_finish() is called. |
| 27 | """ |
| 28 | self.f = f |
| 29 | self.n = n |
| 30 | self.started = [] |
| 31 | self.finished = [] |
| 32 | self._can_exit = not wait_before_exit |
| 33 | def task(): |
Victor Stinner | 2a12974 | 2011-05-30 23:02:52 +0200 | [diff] [blame] | 34 | tid = threading.get_ident() |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 35 | self.started.append(tid) |
| 36 | try: |
| 37 | f() |
| 38 | finally: |
| 39 | self.finished.append(tid) |
| 40 | while not self._can_exit: |
| 41 | _wait() |
Serhiy Storchaka | 9db5500 | 2015-03-28 20:38:37 +0200 | [diff] [blame] | 42 | try: |
| 43 | for i in range(n): |
| 44 | start_new_thread(task, ()) |
| 45 | except: |
| 46 | self._can_exit = True |
| 47 | raise |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 48 | |
| 49 | def wait_for_started(self): |
| 50 | while len(self.started) < self.n: |
| 51 | _wait() |
| 52 | |
| 53 | def wait_for_finished(self): |
| 54 | while len(self.finished) < self.n: |
| 55 | _wait() |
| 56 | |
| 57 | def do_finish(self): |
| 58 | self._can_exit = True |
| 59 | |
| 60 | |
| 61 | class BaseTestCase(unittest.TestCase): |
| 62 | def setUp(self): |
| 63 | self._threads = support.threading_setup() |
| 64 | |
| 65 | def tearDown(self): |
| 66 | support.threading_cleanup(*self._threads) |
| 67 | support.reap_children() |
| 68 | |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 69 | def assertTimeout(self, actual, expected): |
| 70 | # The waiting and/or time.time() can be imprecise, which |
| 71 | # is why comparing to the expected value would sometimes fail |
| 72 | # (especially under Windows). |
| 73 | self.assertGreaterEqual(actual, expected * 0.6) |
| 74 | # Test nothing insane happened |
| 75 | self.assertLess(actual, expected * 10.0) |
| 76 | |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 77 | |
| 78 | class BaseLockTests(BaseTestCase): |
| 79 | """ |
| 80 | Tests for both recursive and non-recursive locks. |
| 81 | """ |
| 82 | |
| 83 | def test_constructor(self): |
| 84 | lock = self.locktype() |
| 85 | del lock |
| 86 | |
Christian Heimes | c5d95b1 | 2013-07-30 15:54:39 +0200 | [diff] [blame] | 87 | def test_repr(self): |
| 88 | lock = self.locktype() |
Raymond Hettinger | 62f4dad | 2014-05-25 18:22:35 -0700 | [diff] [blame] | 89 | self.assertRegex(repr(lock), "<unlocked .* object (.*)?at .*>") |
| 90 | del lock |
| 91 | |
| 92 | def test_locked_repr(self): |
| 93 | lock = self.locktype() |
| 94 | lock.acquire() |
| 95 | self.assertRegex(repr(lock), "<locked .* object (.*)?at .*>") |
Christian Heimes | c5d95b1 | 2013-07-30 15:54:39 +0200 | [diff] [blame] | 96 | del lock |
| 97 | |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 98 | def test_acquire_destroy(self): |
| 99 | lock = self.locktype() |
| 100 | lock.acquire() |
| 101 | del lock |
| 102 | |
| 103 | def test_acquire_release(self): |
| 104 | lock = self.locktype() |
| 105 | lock.acquire() |
| 106 | lock.release() |
| 107 | del lock |
| 108 | |
| 109 | def test_try_acquire(self): |
| 110 | lock = self.locktype() |
| 111 | self.assertTrue(lock.acquire(False)) |
| 112 | lock.release() |
| 113 | |
| 114 | def test_try_acquire_contended(self): |
| 115 | lock = self.locktype() |
| 116 | lock.acquire() |
| 117 | result = [] |
| 118 | def f(): |
| 119 | result.append(lock.acquire(False)) |
| 120 | Bunch(f, 1).wait_for_finished() |
| 121 | self.assertFalse(result[0]) |
| 122 | lock.release() |
| 123 | |
| 124 | def test_acquire_contended(self): |
| 125 | lock = self.locktype() |
| 126 | lock.acquire() |
| 127 | N = 5 |
| 128 | def f(): |
| 129 | lock.acquire() |
| 130 | lock.release() |
| 131 | |
| 132 | b = Bunch(f, N) |
| 133 | b.wait_for_started() |
| 134 | _wait() |
| 135 | self.assertEqual(len(b.finished), 0) |
| 136 | lock.release() |
| 137 | b.wait_for_finished() |
| 138 | self.assertEqual(len(b.finished), N) |
| 139 | |
| 140 | def test_with(self): |
| 141 | lock = self.locktype() |
| 142 | def f(): |
| 143 | lock.acquire() |
| 144 | lock.release() |
| 145 | def _with(err=None): |
| 146 | with lock: |
| 147 | if err is not None: |
| 148 | raise err |
| 149 | _with() |
| 150 | # Check the lock is unacquired |
| 151 | Bunch(f, 1).wait_for_finished() |
| 152 | self.assertRaises(TypeError, _with, TypeError) |
| 153 | # Check the lock is unacquired |
| 154 | Bunch(f, 1).wait_for_finished() |
| 155 | |
Antoine Pitrou | b087268 | 2009-11-09 16:08:16 +0000 | [diff] [blame] | 156 | def test_thread_leak(self): |
| 157 | # The lock shouldn't leak a Thread instance when used from a foreign |
| 158 | # (non-threading) thread. |
| 159 | lock = self.locktype() |
| 160 | def f(): |
| 161 | lock.acquire() |
| 162 | lock.release() |
| 163 | n = len(threading.enumerate()) |
| 164 | # We run many threads in the hope that existing threads ids won't |
| 165 | # be recycled. |
| 166 | Bunch(f, 15).wait_for_finished() |
Antoine Pitrou | 45fdb45 | 2011-04-04 21:59:09 +0200 | [diff] [blame] | 167 | if len(threading.enumerate()) != n: |
| 168 | # There is a small window during which a Thread instance's |
| 169 | # target function has finished running, but the Thread is still |
| 170 | # alive and registered. Avoid spurious failures by waiting a |
| 171 | # bit more (seen on a buildbot). |
| 172 | time.sleep(0.4) |
| 173 | self.assertEqual(n, len(threading.enumerate())) |
Antoine Pitrou | b087268 | 2009-11-09 16:08:16 +0000 | [diff] [blame] | 174 | |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 175 | def test_timeout(self): |
| 176 | lock = self.locktype() |
| 177 | # Can't set timeout if not blocking |
| 178 | self.assertRaises(ValueError, lock.acquire, 0, 1) |
| 179 | # Invalid timeout values |
| 180 | self.assertRaises(ValueError, lock.acquire, timeout=-100) |
| 181 | self.assertRaises(OverflowError, lock.acquire, timeout=1e100) |
| 182 | self.assertRaises(OverflowError, lock.acquire, timeout=TIMEOUT_MAX + 1) |
| 183 | # TIMEOUT_MAX is ok |
| 184 | lock.acquire(timeout=TIMEOUT_MAX) |
| 185 | lock.release() |
| 186 | t1 = time.time() |
| 187 | self.assertTrue(lock.acquire(timeout=5)) |
| 188 | t2 = time.time() |
| 189 | # Just a sanity test that it didn't actually wait for the timeout. |
| 190 | self.assertLess(t2 - t1, 5) |
| 191 | results = [] |
| 192 | def f(): |
| 193 | t1 = time.time() |
| 194 | results.append(lock.acquire(timeout=0.5)) |
| 195 | t2 = time.time() |
| 196 | results.append(t2 - t1) |
| 197 | Bunch(f, 1).wait_for_finished() |
| 198 | self.assertFalse(results[0]) |
| 199 | self.assertTimeout(results[1], 0.5) |
| 200 | |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 201 | |
| 202 | class LockTests(BaseLockTests): |
| 203 | """ |
| 204 | Tests for non-recursive, weak locks |
| 205 | (which can be acquired and released from different threads). |
| 206 | """ |
| 207 | def test_reacquire(self): |
| 208 | # Lock needs to be released before re-acquiring. |
| 209 | lock = self.locktype() |
| 210 | phase = [] |
| 211 | def f(): |
| 212 | lock.acquire() |
| 213 | phase.append(None) |
| 214 | lock.acquire() |
| 215 | phase.append(None) |
| 216 | start_new_thread(f, ()) |
| 217 | while len(phase) == 0: |
| 218 | _wait() |
| 219 | _wait() |
| 220 | self.assertEqual(len(phase), 1) |
| 221 | lock.release() |
| 222 | while len(phase) == 1: |
| 223 | _wait() |
| 224 | self.assertEqual(len(phase), 2) |
| 225 | |
| 226 | def test_different_thread(self): |
| 227 | # Lock can be released from a different thread. |
| 228 | lock = self.locktype() |
| 229 | lock.acquire() |
| 230 | def f(): |
| 231 | lock.release() |
| 232 | b = Bunch(f, 1) |
| 233 | b.wait_for_finished() |
| 234 | lock.acquire() |
| 235 | lock.release() |
| 236 | |
Antoine Pitrou | 7899acf | 2011-03-31 01:00:32 +0200 | [diff] [blame] | 237 | def test_state_after_timeout(self): |
| 238 | # Issue #11618: check that lock is in a proper state after a |
| 239 | # (non-zero) timeout. |
| 240 | lock = self.locktype() |
| 241 | lock.acquire() |
| 242 | self.assertFalse(lock.acquire(timeout=0.01)) |
| 243 | lock.release() |
| 244 | self.assertFalse(lock.locked()) |
| 245 | self.assertTrue(lock.acquire(blocking=False)) |
| 246 | |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 247 | |
| 248 | class RLockTests(BaseLockTests): |
| 249 | """ |
| 250 | Tests for recursive locks. |
| 251 | """ |
| 252 | def test_reacquire(self): |
| 253 | lock = self.locktype() |
| 254 | lock.acquire() |
| 255 | lock.acquire() |
| 256 | lock.release() |
| 257 | lock.acquire() |
| 258 | lock.release() |
| 259 | lock.release() |
| 260 | |
| 261 | def test_release_unacquired(self): |
| 262 | # Cannot release an unacquired lock |
| 263 | lock = self.locktype() |
| 264 | self.assertRaises(RuntimeError, lock.release) |
| 265 | lock.acquire() |
| 266 | lock.acquire() |
| 267 | lock.release() |
| 268 | lock.acquire() |
| 269 | lock.release() |
| 270 | lock.release() |
| 271 | self.assertRaises(RuntimeError, lock.release) |
Antoine Pitrou | ea3eb88 | 2012-05-17 18:55:59 +0200 | [diff] [blame] | 272 | |
| 273 | def test_release_save_unacquired(self): |
| 274 | # Cannot _release_save an unacquired lock |
| 275 | lock = self.locktype() |
| 276 | self.assertRaises(RuntimeError, lock._release_save) |
| 277 | lock.acquire() |
| 278 | lock.acquire() |
| 279 | lock.release() |
| 280 | lock.acquire() |
| 281 | lock.release() |
| 282 | lock.release() |
Victor Stinner | c2824d4 | 2011-04-24 23:41:33 +0200 | [diff] [blame] | 283 | self.assertRaises(RuntimeError, lock._release_save) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 284 | |
| 285 | def test_different_thread(self): |
| 286 | # Cannot release from a different thread |
| 287 | lock = self.locktype() |
| 288 | def f(): |
| 289 | lock.acquire() |
| 290 | b = Bunch(f, 1, True) |
| 291 | try: |
| 292 | self.assertRaises(RuntimeError, lock.release) |
| 293 | finally: |
| 294 | b.do_finish() |
| 295 | |
| 296 | def test__is_owned(self): |
| 297 | lock = self.locktype() |
| 298 | self.assertFalse(lock._is_owned()) |
| 299 | lock.acquire() |
| 300 | self.assertTrue(lock._is_owned()) |
| 301 | lock.acquire() |
| 302 | self.assertTrue(lock._is_owned()) |
| 303 | result = [] |
| 304 | def f(): |
| 305 | result.append(lock._is_owned()) |
| 306 | Bunch(f, 1).wait_for_finished() |
| 307 | self.assertFalse(result[0]) |
| 308 | lock.release() |
| 309 | self.assertTrue(lock._is_owned()) |
| 310 | lock.release() |
| 311 | self.assertFalse(lock._is_owned()) |
| 312 | |
| 313 | |
| 314 | class EventTests(BaseTestCase): |
| 315 | """ |
| 316 | Tests for Event objects. |
| 317 | """ |
| 318 | |
| 319 | def test_is_set(self): |
| 320 | evt = self.eventtype() |
| 321 | self.assertFalse(evt.is_set()) |
| 322 | evt.set() |
| 323 | self.assertTrue(evt.is_set()) |
| 324 | evt.set() |
| 325 | self.assertTrue(evt.is_set()) |
| 326 | evt.clear() |
| 327 | self.assertFalse(evt.is_set()) |
| 328 | evt.clear() |
| 329 | self.assertFalse(evt.is_set()) |
| 330 | |
| 331 | def _check_notify(self, evt): |
| 332 | # All threads get notified |
| 333 | N = 5 |
| 334 | results1 = [] |
| 335 | results2 = [] |
| 336 | def f(): |
| 337 | results1.append(evt.wait()) |
| 338 | results2.append(evt.wait()) |
| 339 | b = Bunch(f, N) |
| 340 | b.wait_for_started() |
| 341 | _wait() |
| 342 | self.assertEqual(len(results1), 0) |
| 343 | evt.set() |
| 344 | b.wait_for_finished() |
| 345 | self.assertEqual(results1, [True] * N) |
| 346 | self.assertEqual(results2, [True] * N) |
| 347 | |
| 348 | def test_notify(self): |
| 349 | evt = self.eventtype() |
| 350 | self._check_notify(evt) |
| 351 | # Another time, after an explicit clear() |
| 352 | evt.set() |
| 353 | evt.clear() |
| 354 | self._check_notify(evt) |
| 355 | |
| 356 | def test_timeout(self): |
| 357 | evt = self.eventtype() |
| 358 | results1 = [] |
| 359 | results2 = [] |
| 360 | N = 5 |
| 361 | def f(): |
| 362 | results1.append(evt.wait(0.0)) |
| 363 | t1 = time.time() |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 364 | r = evt.wait(0.5) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 365 | t2 = time.time() |
| 366 | results2.append((r, t2 - t1)) |
| 367 | Bunch(f, N).wait_for_finished() |
| 368 | self.assertEqual(results1, [False] * N) |
| 369 | for r, dt in results2: |
| 370 | self.assertFalse(r) |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 371 | self.assertTimeout(dt, 0.5) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 372 | # The event is set |
| 373 | results1 = [] |
| 374 | results2 = [] |
| 375 | evt.set() |
| 376 | Bunch(f, N).wait_for_finished() |
| 377 | self.assertEqual(results1, [True] * N) |
| 378 | for r, dt in results2: |
| 379 | self.assertTrue(r) |
| 380 | |
Charles-François Natali | ded0348 | 2012-01-07 18:24:56 +0100 | [diff] [blame] | 381 | def test_set_and_clear(self): |
| 382 | # Issue #13502: check that wait() returns true even when the event is |
| 383 | # cleared before the waiting thread is woken up. |
| 384 | evt = self.eventtype() |
| 385 | results = [] |
| 386 | N = 5 |
| 387 | def f(): |
| 388 | results.append(evt.wait(1)) |
| 389 | b = Bunch(f, N) |
| 390 | b.wait_for_started() |
| 391 | time.sleep(0.5) |
| 392 | evt.set() |
| 393 | evt.clear() |
| 394 | b.wait_for_finished() |
| 395 | self.assertEqual(results, [True] * N) |
| 396 | |
Benjamin Peterson | 15982aa | 2015-10-05 21:56:22 -0700 | [diff] [blame] | 397 | def test_reset_internal_locks(self): |
| 398 | evt = self.eventtype() |
| 399 | old_lock = evt._cond._lock |
| 400 | evt._reset_internal_locks() |
| 401 | new_lock = evt._cond._lock |
| 402 | self.assertIsNot(new_lock, old_lock) |
| 403 | self.assertIs(type(new_lock), type(old_lock)) |
| 404 | |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 405 | |
| 406 | class ConditionTests(BaseTestCase): |
| 407 | """ |
| 408 | Tests for condition variables. |
| 409 | """ |
| 410 | |
| 411 | def test_acquire(self): |
| 412 | cond = self.condtype() |
| 413 | # Be default we have an RLock: the condition can be acquired multiple |
| 414 | # times. |
| 415 | cond.acquire() |
| 416 | cond.acquire() |
| 417 | cond.release() |
| 418 | cond.release() |
| 419 | lock = threading.Lock() |
| 420 | cond = self.condtype(lock) |
| 421 | cond.acquire() |
| 422 | self.assertFalse(lock.acquire(False)) |
| 423 | cond.release() |
| 424 | self.assertTrue(lock.acquire(False)) |
| 425 | self.assertFalse(cond.acquire(False)) |
| 426 | lock.release() |
| 427 | with cond: |
| 428 | self.assertFalse(lock.acquire(False)) |
| 429 | |
| 430 | def test_unacquired_wait(self): |
| 431 | cond = self.condtype() |
| 432 | self.assertRaises(RuntimeError, cond.wait) |
| 433 | |
| 434 | def test_unacquired_notify(self): |
| 435 | cond = self.condtype() |
| 436 | self.assertRaises(RuntimeError, cond.notify) |
| 437 | |
| 438 | def _check_notify(self, cond): |
Kristjan Valur Jonsson | 020af2a | 2013-11-11 11:29:04 +0000 | [diff] [blame] | 439 | # Note that this test is sensitive to timing. If the worker threads |
| 440 | # don't execute in a timely fashion, the main thread may think they |
| 441 | # are further along then they are. The main thread therefore issues |
| 442 | # _wait() statements to try to make sure that it doesn't race ahead |
| 443 | # of the workers. |
| 444 | # Secondly, this test assumes that condition variables are not subject |
| 445 | # to spurious wakeups. The absence of spurious wakeups is an implementation |
| 446 | # detail of Condition Cariables in current CPython, but in general, not |
| 447 | # a guaranteed property of condition variables as a programming |
| 448 | # construct. In particular, it is possible that this can no longer |
| 449 | # be conveniently guaranteed should their implementation ever change. |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 450 | N = 5 |
| 451 | results1 = [] |
| 452 | results2 = [] |
| 453 | phase_num = 0 |
| 454 | def f(): |
| 455 | cond.acquire() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 456 | result = cond.wait() |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 457 | cond.release() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 458 | results1.append((result, phase_num)) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 459 | cond.acquire() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 460 | result = cond.wait() |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 461 | cond.release() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 462 | results2.append((result, phase_num)) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 463 | b = Bunch(f, N) |
| 464 | b.wait_for_started() |
| 465 | _wait() |
| 466 | self.assertEqual(results1, []) |
| 467 | # Notify 3 threads at first |
| 468 | cond.acquire() |
| 469 | cond.notify(3) |
| 470 | _wait() |
| 471 | phase_num = 1 |
| 472 | cond.release() |
| 473 | while len(results1) < 3: |
| 474 | _wait() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 475 | self.assertEqual(results1, [(True, 1)] * 3) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 476 | self.assertEqual(results2, []) |
Kristjan Valur Jonsson | 020af2a | 2013-11-11 11:29:04 +0000 | [diff] [blame] | 477 | # first wait, to ensure all workers settle into cond.wait() before |
| 478 | # we continue. See issue #8799 |
| 479 | _wait() |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 480 | # Notify 5 threads: they might be in their first or second wait |
| 481 | cond.acquire() |
| 482 | cond.notify(5) |
| 483 | _wait() |
| 484 | phase_num = 2 |
| 485 | cond.release() |
| 486 | while len(results1) + len(results2) < 8: |
| 487 | _wait() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 488 | self.assertEqual(results1, [(True, 1)] * 3 + [(True, 2)] * 2) |
| 489 | self.assertEqual(results2, [(True, 2)] * 3) |
Kristjan Valur Jonsson | 020af2a | 2013-11-11 11:29:04 +0000 | [diff] [blame] | 490 | _wait() # make sure all workers settle into cond.wait() |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 491 | # Notify all threads: they are all in their second wait |
| 492 | cond.acquire() |
| 493 | cond.notify_all() |
| 494 | _wait() |
| 495 | phase_num = 3 |
| 496 | cond.release() |
| 497 | while len(results2) < 5: |
| 498 | _wait() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 499 | self.assertEqual(results1, [(True, 1)] * 3 + [(True,2)] * 2) |
| 500 | self.assertEqual(results2, [(True, 2)] * 3 + [(True, 3)] * 2) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 501 | b.wait_for_finished() |
| 502 | |
| 503 | def test_notify(self): |
| 504 | cond = self.condtype() |
| 505 | self._check_notify(cond) |
| 506 | # A second time, to check internal state is still ok. |
| 507 | self._check_notify(cond) |
| 508 | |
| 509 | def test_timeout(self): |
| 510 | cond = self.condtype() |
| 511 | results = [] |
| 512 | N = 5 |
| 513 | def f(): |
| 514 | cond.acquire() |
| 515 | t1 = time.time() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 516 | result = cond.wait(0.5) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 517 | t2 = time.time() |
| 518 | cond.release() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 519 | results.append((t2 - t1, result)) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 520 | Bunch(f, N).wait_for_finished() |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 521 | self.assertEqual(len(results), N) |
| 522 | for dt, result in results: |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 523 | self.assertTimeout(dt, 0.5) |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 524 | # Note that conceptually (that"s the condition variable protocol) |
| 525 | # a wait() may succeed even if no one notifies us and before any |
| 526 | # timeout occurs. Spurious wakeups can occur. |
| 527 | # This makes it hard to verify the result value. |
| 528 | # In practice, this implementation has no spurious wakeups. |
| 529 | self.assertFalse(result) |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 530 | |
Kristján Valur Jónsson | 6331520 | 2010-11-18 12:46:39 +0000 | [diff] [blame] | 531 | def test_waitfor(self): |
| 532 | cond = self.condtype() |
| 533 | state = 0 |
| 534 | def f(): |
| 535 | with cond: |
| 536 | result = cond.wait_for(lambda : state==4) |
| 537 | self.assertTrue(result) |
| 538 | self.assertEqual(state, 4) |
| 539 | b = Bunch(f, 1) |
| 540 | b.wait_for_started() |
Victor Stinner | 3349bca | 2011-05-18 00:16:14 +0200 | [diff] [blame] | 541 | for i in range(4): |
Kristján Valur Jónsson | 6331520 | 2010-11-18 12:46:39 +0000 | [diff] [blame] | 542 | time.sleep(0.01) |
| 543 | with cond: |
| 544 | state += 1 |
| 545 | cond.notify() |
| 546 | b.wait_for_finished() |
| 547 | |
| 548 | def test_waitfor_timeout(self): |
| 549 | cond = self.condtype() |
| 550 | state = 0 |
| 551 | success = [] |
| 552 | def f(): |
| 553 | with cond: |
| 554 | dt = time.time() |
| 555 | result = cond.wait_for(lambda : state==4, timeout=0.1) |
| 556 | dt = time.time() - dt |
| 557 | self.assertFalse(result) |
| 558 | self.assertTimeout(dt, 0.1) |
| 559 | success.append(None) |
| 560 | b = Bunch(f, 1) |
| 561 | b.wait_for_started() |
| 562 | # Only increment 3 times, so state == 4 is never reached. |
| 563 | for i in range(3): |
| 564 | time.sleep(0.01) |
| 565 | with cond: |
| 566 | state += 1 |
| 567 | cond.notify() |
| 568 | b.wait_for_finished() |
| 569 | self.assertEqual(len(success), 1) |
| 570 | |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 571 | |
| 572 | class BaseSemaphoreTests(BaseTestCase): |
| 573 | """ |
| 574 | Common tests for {bounded, unbounded} semaphore objects. |
| 575 | """ |
| 576 | |
| 577 | def test_constructor(self): |
| 578 | self.assertRaises(ValueError, self.semtype, value = -1) |
| 579 | self.assertRaises(ValueError, self.semtype, value = -sys.maxsize) |
| 580 | |
| 581 | def test_acquire(self): |
| 582 | sem = self.semtype(1) |
| 583 | sem.acquire() |
| 584 | sem.release() |
| 585 | sem = self.semtype(2) |
| 586 | sem.acquire() |
| 587 | sem.acquire() |
| 588 | sem.release() |
| 589 | sem.release() |
| 590 | |
| 591 | def test_acquire_destroy(self): |
| 592 | sem = self.semtype() |
| 593 | sem.acquire() |
| 594 | del sem |
| 595 | |
| 596 | def test_acquire_contended(self): |
| 597 | sem = self.semtype(7) |
| 598 | sem.acquire() |
| 599 | N = 10 |
| 600 | results1 = [] |
| 601 | results2 = [] |
| 602 | phase_num = 0 |
| 603 | def f(): |
| 604 | sem.acquire() |
| 605 | results1.append(phase_num) |
| 606 | sem.acquire() |
| 607 | results2.append(phase_num) |
| 608 | b = Bunch(f, 10) |
| 609 | b.wait_for_started() |
| 610 | while len(results1) + len(results2) < 6: |
| 611 | _wait() |
| 612 | self.assertEqual(results1 + results2, [0] * 6) |
| 613 | phase_num = 1 |
| 614 | for i in range(7): |
| 615 | sem.release() |
| 616 | while len(results1) + len(results2) < 13: |
| 617 | _wait() |
| 618 | self.assertEqual(sorted(results1 + results2), [0] * 6 + [1] * 7) |
| 619 | phase_num = 2 |
| 620 | for i in range(6): |
| 621 | sem.release() |
| 622 | while len(results1) + len(results2) < 19: |
| 623 | _wait() |
| 624 | self.assertEqual(sorted(results1 + results2), [0] * 6 + [1] * 7 + [2] * 6) |
| 625 | # The semaphore is still locked |
| 626 | self.assertFalse(sem.acquire(False)) |
| 627 | # Final release, to let the last thread finish |
| 628 | sem.release() |
| 629 | b.wait_for_finished() |
| 630 | |
| 631 | def test_try_acquire(self): |
| 632 | sem = self.semtype(2) |
| 633 | self.assertTrue(sem.acquire(False)) |
| 634 | self.assertTrue(sem.acquire(False)) |
| 635 | self.assertFalse(sem.acquire(False)) |
| 636 | sem.release() |
| 637 | self.assertTrue(sem.acquire(False)) |
| 638 | |
| 639 | def test_try_acquire_contended(self): |
| 640 | sem = self.semtype(4) |
| 641 | sem.acquire() |
| 642 | results = [] |
| 643 | def f(): |
| 644 | results.append(sem.acquire(False)) |
| 645 | results.append(sem.acquire(False)) |
| 646 | Bunch(f, 5).wait_for_finished() |
| 647 | # There can be a thread switch between acquiring the semaphore and |
| 648 | # appending the result, therefore results will not necessarily be |
| 649 | # ordered. |
| 650 | self.assertEqual(sorted(results), [False] * 7 + [True] * 3 ) |
| 651 | |
Antoine Pitrou | 0454af9 | 2010-04-17 23:51:58 +0000 | [diff] [blame] | 652 | def test_acquire_timeout(self): |
| 653 | sem = self.semtype(2) |
| 654 | self.assertRaises(ValueError, sem.acquire, False, timeout=1.0) |
| 655 | self.assertTrue(sem.acquire(timeout=0.005)) |
| 656 | self.assertTrue(sem.acquire(timeout=0.005)) |
| 657 | self.assertFalse(sem.acquire(timeout=0.005)) |
| 658 | sem.release() |
| 659 | self.assertTrue(sem.acquire(timeout=0.005)) |
| 660 | t = time.time() |
| 661 | self.assertFalse(sem.acquire(timeout=0.5)) |
| 662 | dt = time.time() - t |
| 663 | self.assertTimeout(dt, 0.5) |
| 664 | |
Antoine Pitrou | 557934f | 2009-11-06 22:41:14 +0000 | [diff] [blame] | 665 | def test_default_value(self): |
| 666 | # The default initial value is 1. |
| 667 | sem = self.semtype() |
| 668 | sem.acquire() |
| 669 | def f(): |
| 670 | sem.acquire() |
| 671 | sem.release() |
| 672 | b = Bunch(f, 1) |
| 673 | b.wait_for_started() |
| 674 | _wait() |
| 675 | self.assertFalse(b.finished) |
| 676 | sem.release() |
| 677 | b.wait_for_finished() |
| 678 | |
| 679 | def test_with(self): |
| 680 | sem = self.semtype(2) |
| 681 | def _with(err=None): |
| 682 | with sem: |
| 683 | self.assertTrue(sem.acquire(False)) |
| 684 | sem.release() |
| 685 | with sem: |
| 686 | self.assertFalse(sem.acquire(False)) |
| 687 | if err: |
| 688 | raise err |
| 689 | _with() |
| 690 | self.assertTrue(sem.acquire(False)) |
| 691 | sem.release() |
| 692 | self.assertRaises(TypeError, _with, TypeError) |
| 693 | self.assertTrue(sem.acquire(False)) |
| 694 | sem.release() |
| 695 | |
| 696 | class SemaphoreTests(BaseSemaphoreTests): |
| 697 | """ |
| 698 | Tests for unbounded semaphores. |
| 699 | """ |
| 700 | |
| 701 | def test_release_unacquired(self): |
| 702 | # Unbounded releases are allowed and increment the semaphore's value |
| 703 | sem = self.semtype(1) |
| 704 | sem.release() |
| 705 | sem.acquire() |
| 706 | sem.acquire() |
| 707 | sem.release() |
| 708 | |
| 709 | |
| 710 | class BoundedSemaphoreTests(BaseSemaphoreTests): |
| 711 | """ |
| 712 | Tests for bounded semaphores. |
| 713 | """ |
| 714 | |
| 715 | def test_release_unacquired(self): |
| 716 | # Cannot go past the initial value |
| 717 | sem = self.semtype() |
| 718 | self.assertRaises(ValueError, sem.release) |
| 719 | sem.acquire() |
| 720 | sem.release() |
| 721 | self.assertRaises(ValueError, sem.release) |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 722 | |
| 723 | |
| 724 | class BarrierTests(BaseTestCase): |
| 725 | """ |
| 726 | Tests for Barrier objects. |
| 727 | """ |
| 728 | N = 5 |
Antoine Pitrou | 12ae290 | 2010-11-17 21:55:41 +0000 | [diff] [blame] | 729 | defaultTimeout = 2.0 |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 730 | |
| 731 | def setUp(self): |
Kristján Valur Jónsson | f53a626 | 2010-10-31 03:00:57 +0000 | [diff] [blame] | 732 | self.barrier = self.barriertype(self.N, timeout=self.defaultTimeout) |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 733 | def tearDown(self): |
| 734 | self.barrier.abort() |
| 735 | |
| 736 | def run_threads(self, f): |
| 737 | b = Bunch(f, self.N-1) |
| 738 | f() |
| 739 | b.wait_for_finished() |
| 740 | |
| 741 | def multipass(self, results, n): |
| 742 | m = self.barrier.parties |
| 743 | self.assertEqual(m, self.N) |
| 744 | for i in range(n): |
| 745 | results[0].append(True) |
| 746 | self.assertEqual(len(results[1]), i * m) |
| 747 | self.barrier.wait() |
| 748 | results[1].append(True) |
| 749 | self.assertEqual(len(results[0]), (i + 1) * m) |
| 750 | self.barrier.wait() |
| 751 | self.assertEqual(self.barrier.n_waiting, 0) |
| 752 | self.assertFalse(self.barrier.broken) |
| 753 | |
| 754 | def test_barrier(self, passes=1): |
| 755 | """ |
| 756 | Test that a barrier is passed in lockstep |
| 757 | """ |
| 758 | results = [[],[]] |
| 759 | def f(): |
| 760 | self.multipass(results, passes) |
| 761 | self.run_threads(f) |
| 762 | |
| 763 | def test_barrier_10(self): |
| 764 | """ |
| 765 | Test that a barrier works for 10 consecutive runs |
| 766 | """ |
| 767 | return self.test_barrier(10) |
| 768 | |
| 769 | def test_wait_return(self): |
| 770 | """ |
| 771 | test the return value from barrier.wait |
| 772 | """ |
| 773 | results = [] |
| 774 | def f(): |
| 775 | r = self.barrier.wait() |
| 776 | results.append(r) |
| 777 | |
| 778 | self.run_threads(f) |
| 779 | self.assertEqual(sum(results), sum(range(self.N))) |
| 780 | |
| 781 | def test_action(self): |
| 782 | """ |
| 783 | Test the 'action' callback |
| 784 | """ |
| 785 | results = [] |
| 786 | def action(): |
| 787 | results.append(True) |
| 788 | barrier = self.barriertype(self.N, action) |
| 789 | def f(): |
| 790 | barrier.wait() |
| 791 | self.assertEqual(len(results), 1) |
| 792 | |
| 793 | self.run_threads(f) |
| 794 | |
| 795 | def test_abort(self): |
| 796 | """ |
| 797 | Test that an abort will put the barrier in a broken state |
| 798 | """ |
| 799 | results1 = [] |
| 800 | results2 = [] |
| 801 | def f(): |
| 802 | try: |
| 803 | i = self.barrier.wait() |
| 804 | if i == self.N//2: |
| 805 | raise RuntimeError |
| 806 | self.barrier.wait() |
| 807 | results1.append(True) |
| 808 | except threading.BrokenBarrierError: |
| 809 | results2.append(True) |
| 810 | except RuntimeError: |
| 811 | self.barrier.abort() |
| 812 | pass |
| 813 | |
| 814 | self.run_threads(f) |
| 815 | self.assertEqual(len(results1), 0) |
| 816 | self.assertEqual(len(results2), self.N-1) |
| 817 | self.assertTrue(self.barrier.broken) |
| 818 | |
| 819 | def test_reset(self): |
| 820 | """ |
| 821 | Test that a 'reset' on a barrier frees the waiting threads |
| 822 | """ |
| 823 | results1 = [] |
| 824 | results2 = [] |
| 825 | results3 = [] |
| 826 | def f(): |
| 827 | i = self.barrier.wait() |
| 828 | if i == self.N//2: |
| 829 | # Wait until the other threads are all in the barrier. |
| 830 | while self.barrier.n_waiting < self.N-1: |
| 831 | time.sleep(0.001) |
| 832 | self.barrier.reset() |
| 833 | else: |
| 834 | try: |
| 835 | self.barrier.wait() |
| 836 | results1.append(True) |
| 837 | except threading.BrokenBarrierError: |
| 838 | results2.append(True) |
| 839 | # Now, pass the barrier again |
| 840 | self.barrier.wait() |
| 841 | results3.append(True) |
| 842 | |
| 843 | self.run_threads(f) |
| 844 | self.assertEqual(len(results1), 0) |
| 845 | self.assertEqual(len(results2), self.N-1) |
| 846 | self.assertEqual(len(results3), self.N) |
| 847 | |
| 848 | |
| 849 | def test_abort_and_reset(self): |
| 850 | """ |
| 851 | Test that a barrier can be reset after being broken. |
| 852 | """ |
| 853 | results1 = [] |
| 854 | results2 = [] |
| 855 | results3 = [] |
| 856 | barrier2 = self.barriertype(self.N) |
| 857 | def f(): |
| 858 | try: |
| 859 | i = self.barrier.wait() |
| 860 | if i == self.N//2: |
| 861 | raise RuntimeError |
| 862 | self.barrier.wait() |
| 863 | results1.append(True) |
| 864 | except threading.BrokenBarrierError: |
| 865 | results2.append(True) |
| 866 | except RuntimeError: |
| 867 | self.barrier.abort() |
| 868 | pass |
| 869 | # Synchronize and reset the barrier. Must synchronize first so |
| 870 | # that everyone has left it when we reset, and after so that no |
| 871 | # one enters it before the reset. |
| 872 | if barrier2.wait() == self.N//2: |
| 873 | self.barrier.reset() |
| 874 | barrier2.wait() |
| 875 | self.barrier.wait() |
| 876 | results3.append(True) |
| 877 | |
| 878 | self.run_threads(f) |
| 879 | self.assertEqual(len(results1), 0) |
| 880 | self.assertEqual(len(results2), self.N-1) |
| 881 | self.assertEqual(len(results3), self.N) |
| 882 | |
| 883 | def test_timeout(self): |
| 884 | """ |
| 885 | Test wait(timeout) |
| 886 | """ |
| 887 | def f(): |
| 888 | i = self.barrier.wait() |
| 889 | if i == self.N // 2: |
| 890 | # One thread is late! |
Antoine Pitrou | 12ae290 | 2010-11-17 21:55:41 +0000 | [diff] [blame] | 891 | time.sleep(1.0) |
| 892 | # Default timeout is 2.0, so this is shorter. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 893 | self.assertRaises(threading.BrokenBarrierError, |
Antoine Pitrou | 12ae290 | 2010-11-17 21:55:41 +0000 | [diff] [blame] | 894 | self.barrier.wait, 0.5) |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 895 | self.run_threads(f) |
| 896 | |
| 897 | def test_default_timeout(self): |
| 898 | """ |
| 899 | Test the barrier's default timeout |
| 900 | """ |
Charles-François Natali | d4d1d06 | 2011-07-27 21:26:42 +0200 | [diff] [blame] | 901 | # create a barrier with a low default timeout |
| 902 | barrier = self.barriertype(self.N, timeout=0.3) |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 903 | def f(): |
Kristján Valur Jónsson | f53a626 | 2010-10-31 03:00:57 +0000 | [diff] [blame] | 904 | i = barrier.wait() |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 905 | if i == self.N // 2: |
Charles-François Natali | d4d1d06 | 2011-07-27 21:26:42 +0200 | [diff] [blame] | 906 | # One thread is later than the default timeout of 0.3s. |
Antoine Pitrou | 12ae290 | 2010-11-17 21:55:41 +0000 | [diff] [blame] | 907 | time.sleep(1.0) |
Kristján Valur Jónsson | f53a626 | 2010-10-31 03:00:57 +0000 | [diff] [blame] | 908 | self.assertRaises(threading.BrokenBarrierError, barrier.wait) |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 909 | self.run_threads(f) |
| 910 | |
| 911 | def test_single_thread(self): |
| 912 | b = self.barriertype(1) |
| 913 | b.wait() |
| 914 | b.wait() |