blob: 29f823de08037fb69f11568edc852134a0fbdb37 [file] [log] [blame]
Georg Brandl86b2fb92008-07-16 03:43:04 +00001#!/usr/bin/env python
2
Benjamin Petersone711caf2008-06-11 16:44:04 +00003#
4# Unit tests for the multiprocessing package
5#
6
7import unittest
8import threading
9import queue as pyqueue
10import time
11import sys
12import os
13import gc
14import signal
15import array
16import copy
17import socket
18import random
19import logging
20
Benjamin Petersone5384b02008-10-04 22:00:42 +000021
22# Work around broken sem_open implementations
23try:
24 import multiprocessing.synchronize
25except ImportError as e:
Benjamin Petersone549ead2009-03-28 21:42:05 +000026 raise unittest.SkipTest(e)
Benjamin Petersone5384b02008-10-04 22:00:42 +000027
Benjamin Petersone711caf2008-06-11 16:44:04 +000028import multiprocessing.dummy
29import multiprocessing.connection
30import multiprocessing.managers
31import multiprocessing.heap
Benjamin Petersone711caf2008-06-11 16:44:04 +000032import multiprocessing.pool
33import _multiprocessing
34
35from multiprocessing import util
36
37#
38#
39#
40
Benjamin Peterson2bc91df2008-07-13 18:45:30 +000041def latin(s):
42 return s.encode('latin')
Benjamin Petersone711caf2008-06-11 16:44:04 +000043
Benjamin Petersone711caf2008-06-11 16:44:04 +000044#
45# Constants
46#
47
48LOG_LEVEL = util.SUBWARNING
49#LOG_LEVEL = logging.WARNING
50
51DELTA = 0.1
52CHECK_TIMINGS = False # making true makes tests take a lot longer
53 # and can sometimes cause some non-serious
54 # failures because some calls block a bit
55 # longer than expected
56if CHECK_TIMINGS:
57 TIMEOUT1, TIMEOUT2, TIMEOUT3 = 0.82, 0.35, 1.4
58else:
59 TIMEOUT1, TIMEOUT2, TIMEOUT3 = 0.1, 0.1, 0.1
60
61HAVE_GETVALUE = not getattr(_multiprocessing,
62 'HAVE_BROKEN_SEM_GETVALUE', False)
63
Jesse Noller6214edd2009-01-19 16:23:53 +000064WIN32 = (sys.platform == "win32")
65
Benjamin Petersone711caf2008-06-11 16:44:04 +000066#
67# Creates a wrapper for a function which records the time it takes to finish
68#
69
70class TimingWrapper(object):
71
72 def __init__(self, func):
73 self.func = func
74 self.elapsed = None
75
76 def __call__(self, *args, **kwds):
77 t = time.time()
78 try:
79 return self.func(*args, **kwds)
80 finally:
81 self.elapsed = time.time() - t
82
83#
84# Base class for test cases
85#
86
87class BaseTestCase(object):
88
89 ALLOWED_TYPES = ('processes', 'manager', 'threads')
90
91 def assertTimingAlmostEqual(self, a, b):
92 if CHECK_TIMINGS:
93 self.assertAlmostEqual(a, b, 1)
94
95 def assertReturnsIfImplemented(self, value, func, *args):
96 try:
97 res = func(*args)
98 except NotImplementedError:
99 pass
100 else:
101 return self.assertEqual(value, res)
102
103#
104# Return the value of a semaphore
105#
106
107def get_value(self):
108 try:
109 return self.get_value()
110 except AttributeError:
111 try:
112 return self._Semaphore__value
113 except AttributeError:
114 try:
115 return self._value
116 except AttributeError:
117 raise NotImplementedError
118
119#
120# Testcases
121#
122
123class _TestProcess(BaseTestCase):
124
125 ALLOWED_TYPES = ('processes', 'threads')
126
127 def test_current(self):
128 if self.TYPE == 'threads':
129 return
130
131 current = self.current_process()
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000132 authkey = current.authkey
Benjamin Petersone711caf2008-06-11 16:44:04 +0000133
134 self.assertTrue(current.is_alive())
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000135 self.assertTrue(not current.daemon)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000136 self.assertTrue(isinstance(authkey, bytes))
137 self.assertTrue(len(authkey) > 0)
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000138 self.assertEqual(current.ident, os.getpid())
139 self.assertEqual(current.exitcode, None)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000140
141 def _test(self, q, *args, **kwds):
142 current = self.current_process()
143 q.put(args)
144 q.put(kwds)
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000145 q.put(current.name)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000146 if self.TYPE != 'threads':
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000147 q.put(bytes(current.authkey))
Benjamin Petersone711caf2008-06-11 16:44:04 +0000148 q.put(current.pid)
149
150 def test_process(self):
151 q = self.Queue(1)
152 e = self.Event()
153 args = (q, 1, 2)
154 kwargs = {'hello':23, 'bye':2.54}
155 name = 'SomeProcess'
156 p = self.Process(
157 target=self._test, args=args, kwargs=kwargs, name=name
158 )
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000159 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000160 current = self.current_process()
161
162 if self.TYPE != 'threads':
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000163 self.assertEquals(p.authkey, current.authkey)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000164 self.assertEquals(p.is_alive(), False)
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000165 self.assertEquals(p.daemon, True)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000166 self.assertTrue(p not in self.active_children())
167 self.assertTrue(type(self.active_children()) is list)
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000168 self.assertEqual(p.exitcode, None)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000169
170 p.start()
171
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000172 self.assertEquals(p.exitcode, None)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000173 self.assertEquals(p.is_alive(), True)
174 self.assertTrue(p in self.active_children())
175
176 self.assertEquals(q.get(), args[1:])
177 self.assertEquals(q.get(), kwargs)
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000178 self.assertEquals(q.get(), p.name)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000179 if self.TYPE != 'threads':
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000180 self.assertEquals(q.get(), current.authkey)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000181 self.assertEquals(q.get(), p.pid)
182
183 p.join()
184
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000185 self.assertEquals(p.exitcode, 0)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000186 self.assertEquals(p.is_alive(), False)
187 self.assertTrue(p not in self.active_children())
188
189 def _test_terminate(self):
190 time.sleep(1000)
191
192 def test_terminate(self):
193 if self.TYPE == 'threads':
194 return
195
196 p = self.Process(target=self._test_terminate)
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000197 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000198 p.start()
199
200 self.assertEqual(p.is_alive(), True)
201 self.assertTrue(p in self.active_children())
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000202 self.assertEqual(p.exitcode, None)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000203
204 p.terminate()
205
206 join = TimingWrapper(p.join)
207 self.assertEqual(join(), None)
208 self.assertTimingAlmostEqual(join.elapsed, 0.0)
209
210 self.assertEqual(p.is_alive(), False)
211 self.assertTrue(p not in self.active_children())
212
213 p.join()
214
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000215 # XXX sometimes get p.exitcode == 0 on Windows ...
216 #self.assertEqual(p.exitcode, -signal.SIGTERM)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000217
218 def test_cpu_count(self):
219 try:
220 cpus = multiprocessing.cpu_count()
221 except NotImplementedError:
222 cpus = 1
223 self.assertTrue(type(cpus) is int)
224 self.assertTrue(cpus >= 1)
225
226 def test_active_children(self):
227 self.assertEqual(type(self.active_children()), list)
228
229 p = self.Process(target=time.sleep, args=(DELTA,))
230 self.assertTrue(p not in self.active_children())
231
232 p.start()
233 self.assertTrue(p in self.active_children())
234
235 p.join()
236 self.assertTrue(p not in self.active_children())
237
238 def _test_recursion(self, wconn, id):
239 from multiprocessing import forking
240 wconn.send(id)
241 if len(id) < 2:
242 for i in range(2):
243 p = self.Process(
244 target=self._test_recursion, args=(wconn, id+[i])
245 )
246 p.start()
247 p.join()
248
249 def test_recursion(self):
250 rconn, wconn = self.Pipe(duplex=False)
251 self._test_recursion(wconn, [])
252
253 time.sleep(DELTA)
254 result = []
255 while rconn.poll():
256 result.append(rconn.recv())
257
258 expected = [
259 [],
260 [0],
261 [0, 0],
262 [0, 1],
263 [1],
264 [1, 0],
265 [1, 1]
266 ]
267 self.assertEqual(result, expected)
268
269#
270#
271#
272
273class _UpperCaser(multiprocessing.Process):
274
275 def __init__(self):
276 multiprocessing.Process.__init__(self)
277 self.child_conn, self.parent_conn = multiprocessing.Pipe()
278
279 def run(self):
280 self.parent_conn.close()
281 for s in iter(self.child_conn.recv, None):
282 self.child_conn.send(s.upper())
283 self.child_conn.close()
284
285 def submit(self, s):
286 assert type(s) is str
287 self.parent_conn.send(s)
288 return self.parent_conn.recv()
289
290 def stop(self):
291 self.parent_conn.send(None)
292 self.parent_conn.close()
293 self.child_conn.close()
294
295class _TestSubclassingProcess(BaseTestCase):
296
297 ALLOWED_TYPES = ('processes',)
298
299 def test_subclassing(self):
300 uppercaser = _UpperCaser()
301 uppercaser.start()
302 self.assertEqual(uppercaser.submit('hello'), 'HELLO')
303 self.assertEqual(uppercaser.submit('world'), 'WORLD')
304 uppercaser.stop()
305 uppercaser.join()
306
307#
308#
309#
310
311def queue_empty(q):
312 if hasattr(q, 'empty'):
313 return q.empty()
314 else:
315 return q.qsize() == 0
316
317def queue_full(q, maxsize):
318 if hasattr(q, 'full'):
319 return q.full()
320 else:
321 return q.qsize() == maxsize
322
323
324class _TestQueue(BaseTestCase):
325
326
327 def _test_put(self, queue, child_can_start, parent_can_continue):
328 child_can_start.wait()
329 for i in range(6):
330 queue.get()
331 parent_can_continue.set()
332
333 def test_put(self):
334 MAXSIZE = 6
335 queue = self.Queue(maxsize=MAXSIZE)
336 child_can_start = self.Event()
337 parent_can_continue = self.Event()
338
339 proc = self.Process(
340 target=self._test_put,
341 args=(queue, child_can_start, parent_can_continue)
342 )
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000343 proc.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000344 proc.start()
345
346 self.assertEqual(queue_empty(queue), True)
347 self.assertEqual(queue_full(queue, MAXSIZE), False)
348
349 queue.put(1)
350 queue.put(2, True)
351 queue.put(3, True, None)
352 queue.put(4, False)
353 queue.put(5, False, None)
354 queue.put_nowait(6)
355
356 # the values may be in buffer but not yet in pipe so sleep a bit
357 time.sleep(DELTA)
358
359 self.assertEqual(queue_empty(queue), False)
360 self.assertEqual(queue_full(queue, MAXSIZE), True)
361
362 put = TimingWrapper(queue.put)
363 put_nowait = TimingWrapper(queue.put_nowait)
364
365 self.assertRaises(pyqueue.Full, put, 7, False)
366 self.assertTimingAlmostEqual(put.elapsed, 0)
367
368 self.assertRaises(pyqueue.Full, put, 7, False, None)
369 self.assertTimingAlmostEqual(put.elapsed, 0)
370
371 self.assertRaises(pyqueue.Full, put_nowait, 7)
372 self.assertTimingAlmostEqual(put_nowait.elapsed, 0)
373
374 self.assertRaises(pyqueue.Full, put, 7, True, TIMEOUT1)
375 self.assertTimingAlmostEqual(put.elapsed, TIMEOUT1)
376
377 self.assertRaises(pyqueue.Full, put, 7, False, TIMEOUT2)
378 self.assertTimingAlmostEqual(put.elapsed, 0)
379
380 self.assertRaises(pyqueue.Full, put, 7, True, timeout=TIMEOUT3)
381 self.assertTimingAlmostEqual(put.elapsed, TIMEOUT3)
382
383 child_can_start.set()
384 parent_can_continue.wait()
385
386 self.assertEqual(queue_empty(queue), True)
387 self.assertEqual(queue_full(queue, MAXSIZE), False)
388
389 proc.join()
390
391 def _test_get(self, queue, child_can_start, parent_can_continue):
392 child_can_start.wait()
Benjamin Petersonb29cbbc2008-06-16 20:57:14 +0000393 #queue.put(1)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000394 queue.put(2)
395 queue.put(3)
396 queue.put(4)
397 queue.put(5)
398 parent_can_continue.set()
399
400 def test_get(self):
401 queue = self.Queue()
402 child_can_start = self.Event()
403 parent_can_continue = self.Event()
404
405 proc = self.Process(
406 target=self._test_get,
407 args=(queue, child_can_start, parent_can_continue)
408 )
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000409 proc.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000410 proc.start()
411
412 self.assertEqual(queue_empty(queue), True)
413
414 child_can_start.set()
415 parent_can_continue.wait()
416
417 time.sleep(DELTA)
418 self.assertEqual(queue_empty(queue), False)
419
Benjamin Petersonb29cbbc2008-06-16 20:57:14 +0000420 # Hangs unexpectedly, remove for now
421 #self.assertEqual(queue.get(), 1)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000422 self.assertEqual(queue.get(True, None), 2)
423 self.assertEqual(queue.get(True), 3)
424 self.assertEqual(queue.get(timeout=1), 4)
425 self.assertEqual(queue.get_nowait(), 5)
426
427 self.assertEqual(queue_empty(queue), True)
428
429 get = TimingWrapper(queue.get)
430 get_nowait = TimingWrapper(queue.get_nowait)
431
432 self.assertRaises(pyqueue.Empty, get, False)
433 self.assertTimingAlmostEqual(get.elapsed, 0)
434
435 self.assertRaises(pyqueue.Empty, get, False, None)
436 self.assertTimingAlmostEqual(get.elapsed, 0)
437
438 self.assertRaises(pyqueue.Empty, get_nowait)
439 self.assertTimingAlmostEqual(get_nowait.elapsed, 0)
440
441 self.assertRaises(pyqueue.Empty, get, True, TIMEOUT1)
442 self.assertTimingAlmostEqual(get.elapsed, TIMEOUT1)
443
444 self.assertRaises(pyqueue.Empty, get, False, TIMEOUT2)
445 self.assertTimingAlmostEqual(get.elapsed, 0)
446
447 self.assertRaises(pyqueue.Empty, get, timeout=TIMEOUT3)
448 self.assertTimingAlmostEqual(get.elapsed, TIMEOUT3)
449
450 proc.join()
451
452 def _test_fork(self, queue):
453 for i in range(10, 20):
454 queue.put(i)
455 # note that at this point the items may only be buffered, so the
456 # process cannot shutdown until the feeder thread has finished
457 # pushing items onto the pipe.
458
459 def test_fork(self):
460 # Old versions of Queue would fail to create a new feeder
461 # thread for a forked process if the original process had its
462 # own feeder thread. This test checks that this no longer
463 # happens.
464
465 queue = self.Queue()
466
467 # put items on queue so that main process starts a feeder thread
468 for i in range(10):
469 queue.put(i)
470
471 # wait to make sure thread starts before we fork a new process
472 time.sleep(DELTA)
473
474 # fork process
475 p = self.Process(target=self._test_fork, args=(queue,))
476 p.start()
477
478 # check that all expected items are in the queue
479 for i in range(20):
480 self.assertEqual(queue.get(), i)
481 self.assertRaises(pyqueue.Empty, queue.get, False)
482
483 p.join()
484
485 def test_qsize(self):
486 q = self.Queue()
487 try:
488 self.assertEqual(q.qsize(), 0)
489 except NotImplementedError:
490 return
491 q.put(1)
492 self.assertEqual(q.qsize(), 1)
493 q.put(5)
494 self.assertEqual(q.qsize(), 2)
495 q.get()
496 self.assertEqual(q.qsize(), 1)
497 q.get()
498 self.assertEqual(q.qsize(), 0)
499
500 def _test_task_done(self, q):
501 for obj in iter(q.get, None):
502 time.sleep(DELTA)
503 q.task_done()
504
505 def test_task_done(self):
506 queue = self.JoinableQueue()
507
508 if sys.version_info < (2, 5) and not hasattr(queue, 'task_done'):
509 return
510
511 workers = [self.Process(target=self._test_task_done, args=(queue,))
512 for i in range(4)]
513
514 for p in workers:
515 p.start()
516
517 for i in range(10):
518 queue.put(i)
519
520 queue.join()
521
522 for p in workers:
523 queue.put(None)
524
525 for p in workers:
526 p.join()
527
528#
529#
530#
531
532class _TestLock(BaseTestCase):
533
534 def test_lock(self):
535 lock = self.Lock()
536 self.assertEqual(lock.acquire(), True)
537 self.assertEqual(lock.acquire(False), False)
538 self.assertEqual(lock.release(), None)
539 self.assertRaises((ValueError, threading.ThreadError), lock.release)
540
541 def test_rlock(self):
542 lock = self.RLock()
543 self.assertEqual(lock.acquire(), True)
544 self.assertEqual(lock.acquire(), True)
545 self.assertEqual(lock.acquire(), True)
546 self.assertEqual(lock.release(), None)
547 self.assertEqual(lock.release(), None)
548 self.assertEqual(lock.release(), None)
549 self.assertRaises((AssertionError, RuntimeError), lock.release)
550
Jesse Nollerf8d00852009-03-31 03:25:07 +0000551 def test_lock_context(self):
552 with self.Lock():
553 pass
554
Benjamin Petersone711caf2008-06-11 16:44:04 +0000555
556class _TestSemaphore(BaseTestCase):
557
558 def _test_semaphore(self, sem):
559 self.assertReturnsIfImplemented(2, get_value, sem)
560 self.assertEqual(sem.acquire(), True)
561 self.assertReturnsIfImplemented(1, get_value, sem)
562 self.assertEqual(sem.acquire(), True)
563 self.assertReturnsIfImplemented(0, get_value, sem)
564 self.assertEqual(sem.acquire(False), False)
565 self.assertReturnsIfImplemented(0, get_value, sem)
566 self.assertEqual(sem.release(), None)
567 self.assertReturnsIfImplemented(1, get_value, sem)
568 self.assertEqual(sem.release(), None)
569 self.assertReturnsIfImplemented(2, get_value, sem)
570
571 def test_semaphore(self):
572 sem = self.Semaphore(2)
573 self._test_semaphore(sem)
574 self.assertEqual(sem.release(), None)
575 self.assertReturnsIfImplemented(3, get_value, sem)
576 self.assertEqual(sem.release(), None)
577 self.assertReturnsIfImplemented(4, get_value, sem)
578
579 def test_bounded_semaphore(self):
580 sem = self.BoundedSemaphore(2)
581 self._test_semaphore(sem)
582 # Currently fails on OS/X
583 #if HAVE_GETVALUE:
584 # self.assertRaises(ValueError, sem.release)
585 # self.assertReturnsIfImplemented(2, get_value, sem)
586
587 def test_timeout(self):
588 if self.TYPE != 'processes':
589 return
590
591 sem = self.Semaphore(0)
592 acquire = TimingWrapper(sem.acquire)
593
594 self.assertEqual(acquire(False), False)
595 self.assertTimingAlmostEqual(acquire.elapsed, 0.0)
596
597 self.assertEqual(acquire(False, None), False)
598 self.assertTimingAlmostEqual(acquire.elapsed, 0.0)
599
600 self.assertEqual(acquire(False, TIMEOUT1), False)
601 self.assertTimingAlmostEqual(acquire.elapsed, 0)
602
603 self.assertEqual(acquire(True, TIMEOUT2), False)
604 self.assertTimingAlmostEqual(acquire.elapsed, TIMEOUT2)
605
606 self.assertEqual(acquire(timeout=TIMEOUT3), False)
607 self.assertTimingAlmostEqual(acquire.elapsed, TIMEOUT3)
608
609
610class _TestCondition(BaseTestCase):
611
612 def f(self, cond, sleeping, woken, timeout=None):
613 cond.acquire()
614 sleeping.release()
615 cond.wait(timeout)
616 woken.release()
617 cond.release()
618
619 def check_invariant(self, cond):
620 # this is only supposed to succeed when there are no sleepers
621 if self.TYPE == 'processes':
622 try:
623 sleepers = (cond._sleeping_count.get_value() -
624 cond._woken_count.get_value())
625 self.assertEqual(sleepers, 0)
626 self.assertEqual(cond._wait_semaphore.get_value(), 0)
627 except NotImplementedError:
628 pass
629
630 def test_notify(self):
631 cond = self.Condition()
632 sleeping = self.Semaphore(0)
633 woken = self.Semaphore(0)
634
635 p = self.Process(target=self.f, args=(cond, sleeping, woken))
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000636 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000637 p.start()
638
639 p = threading.Thread(target=self.f, args=(cond, sleeping, woken))
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000640 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000641 p.start()
642
643 # wait for both children to start sleeping
644 sleeping.acquire()
645 sleeping.acquire()
646
647 # check no process/thread has woken up
648 time.sleep(DELTA)
649 self.assertReturnsIfImplemented(0, get_value, woken)
650
651 # wake up one process/thread
652 cond.acquire()
653 cond.notify()
654 cond.release()
655
656 # check one process/thread has woken up
657 time.sleep(DELTA)
658 self.assertReturnsIfImplemented(1, get_value, woken)
659
660 # wake up another
661 cond.acquire()
662 cond.notify()
663 cond.release()
664
665 # check other has woken up
666 time.sleep(DELTA)
667 self.assertReturnsIfImplemented(2, get_value, woken)
668
669 # check state is not mucked up
670 self.check_invariant(cond)
671 p.join()
672
673 def test_notify_all(self):
674 cond = self.Condition()
675 sleeping = self.Semaphore(0)
676 woken = self.Semaphore(0)
677
678 # start some threads/processes which will timeout
679 for i in range(3):
680 p = self.Process(target=self.f,
681 args=(cond, sleeping, woken, TIMEOUT1))
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000682 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000683 p.start()
684
685 t = threading.Thread(target=self.f,
686 args=(cond, sleeping, woken, TIMEOUT1))
Benjamin Peterson72753702008-08-18 18:09:21 +0000687 t.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000688 t.start()
689
690 # wait for them all to sleep
691 for i in range(6):
692 sleeping.acquire()
693
694 # check they have all timed out
695 for i in range(6):
696 woken.acquire()
697 self.assertReturnsIfImplemented(0, get_value, woken)
698
699 # check state is not mucked up
700 self.check_invariant(cond)
701
702 # start some more threads/processes
703 for i in range(3):
704 p = self.Process(target=self.f, args=(cond, sleeping, woken))
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +0000705 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000706 p.start()
707
708 t = threading.Thread(target=self.f, args=(cond, sleeping, woken))
Benjamin Peterson72753702008-08-18 18:09:21 +0000709 t.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +0000710 t.start()
711
712 # wait for them to all sleep
713 for i in range(6):
714 sleeping.acquire()
715
716 # check no process/thread has woken up
717 time.sleep(DELTA)
718 self.assertReturnsIfImplemented(0, get_value, woken)
719
720 # wake them all up
721 cond.acquire()
722 cond.notify_all()
723 cond.release()
724
725 # check they have all woken
726 time.sleep(DELTA)
727 self.assertReturnsIfImplemented(6, get_value, woken)
728
729 # check state is not mucked up
730 self.check_invariant(cond)
731
732 def test_timeout(self):
733 cond = self.Condition()
734 wait = TimingWrapper(cond.wait)
735 cond.acquire()
736 res = wait(TIMEOUT1)
737 cond.release()
738 self.assertEqual(res, None)
739 self.assertTimingAlmostEqual(wait.elapsed, TIMEOUT1)
740
741
742class _TestEvent(BaseTestCase):
743
744 def _test_event(self, event):
745 time.sleep(TIMEOUT2)
746 event.set()
747
748 def test_event(self):
749 event = self.Event()
750 wait = TimingWrapper(event.wait)
751
752 # Removed temporaily, due to API shear, this does not
753 # work with threading._Event objects. is_set == isSet
754 #self.assertEqual(event.is_set(), False)
755
756 self.assertEqual(wait(0.0), None)
757 self.assertTimingAlmostEqual(wait.elapsed, 0.0)
758 self.assertEqual(wait(TIMEOUT1), None)
759 self.assertTimingAlmostEqual(wait.elapsed, TIMEOUT1)
760
761 event.set()
762
763 # See note above on the API differences
764 # self.assertEqual(event.is_set(), True)
765 self.assertEqual(wait(), None)
766 self.assertTimingAlmostEqual(wait.elapsed, 0.0)
767 self.assertEqual(wait(TIMEOUT1), None)
768 self.assertTimingAlmostEqual(wait.elapsed, 0.0)
769 # self.assertEqual(event.is_set(), True)
770
771 event.clear()
772
773 #self.assertEqual(event.is_set(), False)
774
775 self.Process(target=self._test_event, args=(event,)).start()
776 self.assertEqual(wait(), None)
777
778#
779#
780#
781
782class _TestValue(BaseTestCase):
783
784 codes_values = [
785 ('i', 4343, 24234),
786 ('d', 3.625, -4.25),
787 ('h', -232, 234),
788 ('c', latin('x'), latin('y'))
789 ]
790
791 def _test(self, values):
792 for sv, cv in zip(values, self.codes_values):
793 sv.value = cv[2]
794
795
796 def test_value(self, raw=False):
797 if self.TYPE != 'processes':
798 return
799
800 if raw:
801 values = [self.RawValue(code, value)
802 for code, value, _ in self.codes_values]
803 else:
804 values = [self.Value(code, value)
805 for code, value, _ in self.codes_values]
806
807 for sv, cv in zip(values, self.codes_values):
808 self.assertEqual(sv.value, cv[1])
809
810 proc = self.Process(target=self._test, args=(values,))
811 proc.start()
812 proc.join()
813
814 for sv, cv in zip(values, self.codes_values):
815 self.assertEqual(sv.value, cv[2])
816
817 def test_rawvalue(self):
818 self.test_value(raw=True)
819
820 def test_getobj_getlock(self):
821 if self.TYPE != 'processes':
822 return
823
824 val1 = self.Value('i', 5)
825 lock1 = val1.get_lock()
826 obj1 = val1.get_obj()
827
828 val2 = self.Value('i', 5, lock=None)
829 lock2 = val2.get_lock()
830 obj2 = val2.get_obj()
831
832 lock = self.Lock()
833 val3 = self.Value('i', 5, lock=lock)
834 lock3 = val3.get_lock()
835 obj3 = val3.get_obj()
836 self.assertEqual(lock, lock3)
837
Jesse Nollerb0516a62009-01-18 03:11:38 +0000838 arr4 = self.Value('i', 5, lock=False)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000839 self.assertFalse(hasattr(arr4, 'get_lock'))
840 self.assertFalse(hasattr(arr4, 'get_obj'))
841
Jesse Nollerb0516a62009-01-18 03:11:38 +0000842 self.assertRaises(AttributeError, self.Value, 'i', 5, lock='navalue')
843
844 arr5 = self.RawValue('i', 5)
845 self.assertFalse(hasattr(arr5, 'get_lock'))
846 self.assertFalse(hasattr(arr5, 'get_obj'))
847
Benjamin Petersone711caf2008-06-11 16:44:04 +0000848
849class _TestArray(BaseTestCase):
850
851 def f(self, seq):
852 for i in range(1, len(seq)):
853 seq[i] += seq[i-1]
854
855 def test_array(self, raw=False):
856 if self.TYPE != 'processes':
857 return
858
859 seq = [680, 626, 934, 821, 150, 233, 548, 982, 714, 831]
860 if raw:
861 arr = self.RawArray('i', seq)
862 else:
863 arr = self.Array('i', seq)
864
865 self.assertEqual(len(arr), len(seq))
866 self.assertEqual(arr[3], seq[3])
867 self.assertEqual(list(arr[2:7]), list(seq[2:7]))
868
869 arr[4:8] = seq[4:8] = array.array('i', [1, 2, 3, 4])
870
871 self.assertEqual(list(arr[:]), seq)
872
873 self.f(seq)
874
875 p = self.Process(target=self.f, args=(arr,))
876 p.start()
877 p.join()
878
879 self.assertEqual(list(arr[:]), seq)
880
881 def test_rawarray(self):
882 self.test_array(raw=True)
883
884 def test_getobj_getlock_obj(self):
885 if self.TYPE != 'processes':
886 return
887
888 arr1 = self.Array('i', list(range(10)))
889 lock1 = arr1.get_lock()
890 obj1 = arr1.get_obj()
891
892 arr2 = self.Array('i', list(range(10)), lock=None)
893 lock2 = arr2.get_lock()
894 obj2 = arr2.get_obj()
895
896 lock = self.Lock()
897 arr3 = self.Array('i', list(range(10)), lock=lock)
898 lock3 = arr3.get_lock()
899 obj3 = arr3.get_obj()
900 self.assertEqual(lock, lock3)
901
Jesse Nollerb0516a62009-01-18 03:11:38 +0000902 arr4 = self.Array('i', range(10), lock=False)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000903 self.assertFalse(hasattr(arr4, 'get_lock'))
904 self.assertFalse(hasattr(arr4, 'get_obj'))
Jesse Nollerb0516a62009-01-18 03:11:38 +0000905 self.assertRaises(AttributeError,
906 self.Array, 'i', range(10), lock='notalock')
907
908 arr5 = self.RawArray('i', range(10))
909 self.assertFalse(hasattr(arr5, 'get_lock'))
910 self.assertFalse(hasattr(arr5, 'get_obj'))
Benjamin Petersone711caf2008-06-11 16:44:04 +0000911
912#
913#
914#
915
916class _TestContainers(BaseTestCase):
917
918 ALLOWED_TYPES = ('manager',)
919
920 def test_list(self):
921 a = self.list(list(range(10)))
922 self.assertEqual(a[:], list(range(10)))
923
924 b = self.list()
925 self.assertEqual(b[:], [])
926
927 b.extend(list(range(5)))
928 self.assertEqual(b[:], list(range(5)))
929
930 self.assertEqual(b[2], 2)
931 self.assertEqual(b[2:10], [2,3,4])
932
933 b *= 2
934 self.assertEqual(b[:], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4])
935
936 self.assertEqual(b + [5, 6], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4, 5, 6])
937
938 self.assertEqual(a[:], list(range(10)))
939
940 d = [a, b]
941 e = self.list(d)
942 self.assertEqual(
943 e[:],
944 [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4]]
945 )
946
947 f = self.list([a])
948 a.append('hello')
949 self.assertEqual(f[:], [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 'hello']])
950
951 def test_dict(self):
952 d = self.dict()
953 indices = list(range(65, 70))
954 for i in indices:
955 d[i] = chr(i)
956 self.assertEqual(d.copy(), dict((i, chr(i)) for i in indices))
957 self.assertEqual(sorted(d.keys()), indices)
958 self.assertEqual(sorted(d.values()), [chr(i) for i in indices])
959 self.assertEqual(sorted(d.items()), [(i, chr(i)) for i in indices])
960
961 def test_namespace(self):
962 n = self.Namespace()
963 n.name = 'Bob'
964 n.job = 'Builder'
965 n._hidden = 'hidden'
966 self.assertEqual((n.name, n.job), ('Bob', 'Builder'))
967 del n.job
968 self.assertEqual(str(n), "Namespace(name='Bob')")
969 self.assertTrue(hasattr(n, 'name'))
970 self.assertTrue(not hasattr(n, 'job'))
971
972#
973#
974#
975
976def sqr(x, wait=0.0):
977 time.sleep(wait)
978 return x*x
Benjamin Petersone711caf2008-06-11 16:44:04 +0000979class _TestPool(BaseTestCase):
980
981 def test_apply(self):
982 papply = self.pool.apply
983 self.assertEqual(papply(sqr, (5,)), sqr(5))
984 self.assertEqual(papply(sqr, (), {'x':3}), sqr(x=3))
985
986 def test_map(self):
987 pmap = self.pool.map
988 self.assertEqual(pmap(sqr, list(range(10))), list(map(sqr, list(range(10)))))
989 self.assertEqual(pmap(sqr, list(range(100)), chunksize=20),
990 list(map(sqr, list(range(100)))))
991
992 def test_async(self):
993 res = self.pool.apply_async(sqr, (7, TIMEOUT1,))
994 get = TimingWrapper(res.get)
995 self.assertEqual(get(), 49)
996 self.assertTimingAlmostEqual(get.elapsed, TIMEOUT1)
997
998 def test_async_timeout(self):
999 res = self.pool.apply_async(sqr, (6, TIMEOUT2 + 0.2))
1000 get = TimingWrapper(res.get)
1001 self.assertRaises(multiprocessing.TimeoutError, get, timeout=TIMEOUT2)
1002 self.assertTimingAlmostEqual(get.elapsed, TIMEOUT2)
1003
1004 def test_imap(self):
1005 it = self.pool.imap(sqr, list(range(10)))
1006 self.assertEqual(list(it), list(map(sqr, list(range(10)))))
1007
1008 it = self.pool.imap(sqr, list(range(10)))
1009 for i in range(10):
1010 self.assertEqual(next(it), i*i)
1011 self.assertRaises(StopIteration, it.__next__)
1012
1013 it = self.pool.imap(sqr, list(range(1000)), chunksize=100)
1014 for i in range(1000):
1015 self.assertEqual(next(it), i*i)
1016 self.assertRaises(StopIteration, it.__next__)
1017
1018 def test_imap_unordered(self):
1019 it = self.pool.imap_unordered(sqr, list(range(1000)))
1020 self.assertEqual(sorted(it), list(map(sqr, list(range(1000)))))
1021
1022 it = self.pool.imap_unordered(sqr, list(range(1000)), chunksize=53)
1023 self.assertEqual(sorted(it), list(map(sqr, list(range(1000)))))
1024
1025 def test_make_pool(self):
1026 p = multiprocessing.Pool(3)
1027 self.assertEqual(3, len(p._pool))
1028 p.close()
1029 p.join()
1030
1031 def test_terminate(self):
1032 if self.TYPE == 'manager':
1033 # On Unix a forked process increfs each shared object to
1034 # which its parent process held a reference. If the
1035 # forked process gets terminated then there is likely to
1036 # be a reference leak. So to prevent
1037 # _TestZZZNumberOfObjects from failing we skip this test
1038 # when using a manager.
1039 return
1040
1041 result = self.pool.map_async(
1042 time.sleep, [0.1 for i in range(10000)], chunksize=1
1043 )
1044 self.pool.terminate()
1045 join = TimingWrapper(self.pool.join)
1046 join()
1047 self.assertTrue(join.elapsed < 0.2)
Benjamin Petersone711caf2008-06-11 16:44:04 +00001048#
1049# Test that manager has expected number of shared objects left
1050#
1051
1052class _TestZZZNumberOfObjects(BaseTestCase):
1053 # Because test cases are sorted alphabetically, this one will get
1054 # run after all the other tests for the manager. It tests that
1055 # there have been no "reference leaks" for the manager's shared
1056 # objects. Note the comment in _TestPool.test_terminate().
1057 ALLOWED_TYPES = ('manager',)
1058
1059 def test_number_of_objects(self):
1060 EXPECTED_NUMBER = 1 # the pool object is still alive
1061 multiprocessing.active_children() # discard dead process objs
1062 gc.collect() # do garbage collection
1063 refs = self.manager._number_of_objects()
Jesse Noller63b3a972009-01-21 02:15:48 +00001064 debug_info = self.manager._debug_info()
Benjamin Petersone711caf2008-06-11 16:44:04 +00001065 if refs != EXPECTED_NUMBER:
Georg Brandl3dbca812008-07-23 16:10:53 +00001066 print(self.manager._debug_info())
Jesse Noller63b3a972009-01-21 02:15:48 +00001067 print(debug_info)
Benjamin Petersone711caf2008-06-11 16:44:04 +00001068
1069 self.assertEqual(refs, EXPECTED_NUMBER)
1070
1071#
1072# Test of creating a customized manager class
1073#
1074
1075from multiprocessing.managers import BaseManager, BaseProxy, RemoteError
1076
1077class FooBar(object):
1078 def f(self):
1079 return 'f()'
1080 def g(self):
1081 raise ValueError
1082 def _h(self):
1083 return '_h()'
1084
1085def baz():
1086 for i in range(10):
1087 yield i*i
1088
1089class IteratorProxy(BaseProxy):
1090 _exposed_ = ('next', '__next__')
1091 def __iter__(self):
1092 return self
1093 def __next__(self):
1094 return self._callmethod('next')
1095 def __next__(self):
1096 return self._callmethod('__next__')
1097
1098class MyManager(BaseManager):
1099 pass
1100
1101MyManager.register('Foo', callable=FooBar)
1102MyManager.register('Bar', callable=FooBar, exposed=('f', '_h'))
1103MyManager.register('baz', callable=baz, proxytype=IteratorProxy)
1104
1105
1106class _TestMyManager(BaseTestCase):
1107
1108 ALLOWED_TYPES = ('manager',)
1109
1110 def test_mymanager(self):
1111 manager = MyManager()
1112 manager.start()
1113
1114 foo = manager.Foo()
1115 bar = manager.Bar()
1116 baz = manager.baz()
1117
1118 foo_methods = [name for name in ('f', 'g', '_h') if hasattr(foo, name)]
1119 bar_methods = [name for name in ('f', 'g', '_h') if hasattr(bar, name)]
1120
1121 self.assertEqual(foo_methods, ['f', 'g'])
1122 self.assertEqual(bar_methods, ['f', '_h'])
1123
1124 self.assertEqual(foo.f(), 'f()')
1125 self.assertRaises(ValueError, foo.g)
1126 self.assertEqual(foo._callmethod('f'), 'f()')
1127 self.assertRaises(RemoteError, foo._callmethod, '_h')
1128
1129 self.assertEqual(bar.f(), 'f()')
1130 self.assertEqual(bar._h(), '_h()')
1131 self.assertEqual(bar._callmethod('f'), 'f()')
1132 self.assertEqual(bar._callmethod('_h'), '_h()')
1133
1134 self.assertEqual(list(baz), [i*i for i in range(10)])
1135
1136 manager.shutdown()
1137
1138#
1139# Test of connecting to a remote server and using xmlrpclib for serialization
1140#
1141
1142_queue = pyqueue.Queue()
1143def get_queue():
1144 return _queue
1145
1146class QueueManager(BaseManager):
1147 '''manager class used by server process'''
1148QueueManager.register('get_queue', callable=get_queue)
1149
1150class QueueManager2(BaseManager):
1151 '''manager class which specifies the same interface as QueueManager'''
1152QueueManager2.register('get_queue')
1153
1154
1155SERIALIZER = 'xmlrpclib'
1156
1157class _TestRemoteManager(BaseTestCase):
1158
1159 ALLOWED_TYPES = ('manager',)
1160
1161 def _putter(self, address, authkey):
1162 manager = QueueManager2(
1163 address=address, authkey=authkey, serializer=SERIALIZER
1164 )
1165 manager.connect()
1166 queue = manager.get_queue()
1167 queue.put(('hello world', None, True, 2.25))
1168
1169 def test_remote(self):
1170 authkey = os.urandom(32)
1171
1172 manager = QueueManager(
1173 address=('localhost', 0), authkey=authkey, serializer=SERIALIZER
1174 )
1175 manager.start()
1176
1177 p = self.Process(target=self._putter, args=(manager.address, authkey))
1178 p.start()
1179
1180 manager2 = QueueManager2(
1181 address=manager.address, authkey=authkey, serializer=SERIALIZER
1182 )
1183 manager2.connect()
1184 queue = manager2.get_queue()
1185
1186 # Note that xmlrpclib will deserialize object as a list not a tuple
1187 self.assertEqual(queue.get(), ['hello world', None, True, 2.25])
1188
1189 # Because we are using xmlrpclib for serialization instead of
1190 # pickle this will cause a serialization error.
1191 self.assertRaises(Exception, queue.put, time.sleep)
1192
1193 # Make queue finalizer run before the server is stopped
1194 del queue
1195 manager.shutdown()
1196
Jesse Nollerc5d28a02009-03-30 16:37:36 +00001197class _TestManagerRestart(BaseTestCase):
1198
1199 def _putter(self, address, authkey):
1200 manager = QueueManager(
1201 address=address, authkey=authkey, serializer=SERIALIZER)
1202 manager.connect()
1203 queue = manager.get_queue()
1204 queue.put('hello world')
1205
1206 def test_rapid_restart(self):
1207 authkey = os.urandom(32)
1208 manager = QueueManager(
1209 address=('localhost', 9999), authkey=authkey, serializer=SERIALIZER)
1210 manager.start()
1211
1212 p = self.Process(target=self._putter, args=(manager.address, authkey))
1213 p.start()
1214 queue = manager.get_queue()
1215 self.assertEqual(queue.get(), 'hello world')
Jesse Noller35d1f002009-03-30 22:59:27 +00001216 del queue
Jesse Nollerc5d28a02009-03-30 16:37:36 +00001217 manager.shutdown()
1218 manager = QueueManager(
1219 address=('localhost', 9999), authkey=authkey, serializer=SERIALIZER)
1220 manager.start()
Jesse Noller35d1f002009-03-30 22:59:27 +00001221 manager.shutdown()
Jesse Nollerc5d28a02009-03-30 16:37:36 +00001222
Benjamin Petersone711caf2008-06-11 16:44:04 +00001223#
1224#
1225#
1226
1227SENTINEL = latin('')
1228
1229class _TestConnection(BaseTestCase):
1230
1231 ALLOWED_TYPES = ('processes', 'threads')
1232
1233 def _echo(self, conn):
1234 for msg in iter(conn.recv_bytes, SENTINEL):
1235 conn.send_bytes(msg)
1236 conn.close()
1237
1238 def test_connection(self):
1239 conn, child_conn = self.Pipe()
1240
1241 p = self.Process(target=self._echo, args=(child_conn,))
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +00001242 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +00001243 p.start()
1244
1245 seq = [1, 2.25, None]
1246 msg = latin('hello world')
1247 longmsg = msg * 10
1248 arr = array.array('i', list(range(4)))
1249
1250 if self.TYPE == 'processes':
1251 self.assertEqual(type(conn.fileno()), int)
1252
1253 self.assertEqual(conn.send(seq), None)
1254 self.assertEqual(conn.recv(), seq)
1255
1256 self.assertEqual(conn.send_bytes(msg), None)
1257 self.assertEqual(conn.recv_bytes(), msg)
1258
1259 if self.TYPE == 'processes':
1260 buffer = array.array('i', [0]*10)
1261 expected = list(arr) + [0] * (10 - len(arr))
1262 self.assertEqual(conn.send_bytes(arr), None)
1263 self.assertEqual(conn.recv_bytes_into(buffer),
1264 len(arr) * buffer.itemsize)
1265 self.assertEqual(list(buffer), expected)
1266
1267 buffer = array.array('i', [0]*10)
1268 expected = [0] * 3 + list(arr) + [0] * (10 - 3 - len(arr))
1269 self.assertEqual(conn.send_bytes(arr), None)
1270 self.assertEqual(conn.recv_bytes_into(buffer, 3 * buffer.itemsize),
1271 len(arr) * buffer.itemsize)
1272 self.assertEqual(list(buffer), expected)
1273
1274 buffer = bytearray(latin(' ' * 40))
1275 self.assertEqual(conn.send_bytes(longmsg), None)
1276 try:
1277 res = conn.recv_bytes_into(buffer)
1278 except multiprocessing.BufferTooShort as e:
1279 self.assertEqual(e.args, (longmsg,))
1280 else:
1281 self.fail('expected BufferTooShort, got %s' % res)
1282
1283 poll = TimingWrapper(conn.poll)
1284
1285 self.assertEqual(poll(), False)
1286 self.assertTimingAlmostEqual(poll.elapsed, 0)
1287
1288 self.assertEqual(poll(TIMEOUT1), False)
1289 self.assertTimingAlmostEqual(poll.elapsed, TIMEOUT1)
1290
1291 conn.send(None)
1292
1293 self.assertEqual(poll(TIMEOUT1), True)
1294 self.assertTimingAlmostEqual(poll.elapsed, 0)
1295
1296 self.assertEqual(conn.recv(), None)
1297
1298 really_big_msg = latin('X') * (1024 * 1024 * 16) # 16Mb
1299 conn.send_bytes(really_big_msg)
1300 self.assertEqual(conn.recv_bytes(), really_big_msg)
1301
1302 conn.send_bytes(SENTINEL) # tell child to quit
1303 child_conn.close()
1304
1305 if self.TYPE == 'processes':
1306 self.assertEqual(conn.readable, True)
1307 self.assertEqual(conn.writable, True)
1308 self.assertRaises(EOFError, conn.recv)
1309 self.assertRaises(EOFError, conn.recv_bytes)
1310
1311 p.join()
1312
1313 def test_duplex_false(self):
1314 reader, writer = self.Pipe(duplex=False)
1315 self.assertEqual(writer.send(1), None)
1316 self.assertEqual(reader.recv(), 1)
1317 if self.TYPE == 'processes':
1318 self.assertEqual(reader.readable, True)
1319 self.assertEqual(reader.writable, False)
1320 self.assertEqual(writer.readable, False)
1321 self.assertEqual(writer.writable, True)
1322 self.assertRaises(IOError, reader.send, 2)
1323 self.assertRaises(IOError, writer.recv)
1324 self.assertRaises(IOError, writer.poll)
1325
1326 def test_spawn_close(self):
1327 # We test that a pipe connection can be closed by parent
1328 # process immediately after child is spawned. On Windows this
1329 # would have sometimes failed on old versions because
1330 # child_conn would be closed before the child got a chance to
1331 # duplicate it.
1332 conn, child_conn = self.Pipe()
1333
1334 p = self.Process(target=self._echo, args=(child_conn,))
1335 p.start()
1336 child_conn.close() # this might complete before child initializes
1337
1338 msg = latin('hello')
1339 conn.send_bytes(msg)
1340 self.assertEqual(conn.recv_bytes(), msg)
1341
1342 conn.send_bytes(SENTINEL)
1343 conn.close()
1344 p.join()
1345
1346 def test_sendbytes(self):
1347 if self.TYPE != 'processes':
1348 return
1349
1350 msg = latin('abcdefghijklmnopqrstuvwxyz')
1351 a, b = self.Pipe()
1352
1353 a.send_bytes(msg)
1354 self.assertEqual(b.recv_bytes(), msg)
1355
1356 a.send_bytes(msg, 5)
1357 self.assertEqual(b.recv_bytes(), msg[5:])
1358
1359 a.send_bytes(msg, 7, 8)
1360 self.assertEqual(b.recv_bytes(), msg[7:7+8])
1361
1362 a.send_bytes(msg, 26)
1363 self.assertEqual(b.recv_bytes(), latin(''))
1364
1365 a.send_bytes(msg, 26, 0)
1366 self.assertEqual(b.recv_bytes(), latin(''))
1367
1368 self.assertRaises(ValueError, a.send_bytes, msg, 27)
1369
1370 self.assertRaises(ValueError, a.send_bytes, msg, 22, 5)
1371
1372 self.assertRaises(ValueError, a.send_bytes, msg, 26, 1)
1373
1374 self.assertRaises(ValueError, a.send_bytes, msg, -1)
1375
1376 self.assertRaises(ValueError, a.send_bytes, msg, 4, -1)
1377
Benjamin Petersone711caf2008-06-11 16:44:04 +00001378class _TestListenerClient(BaseTestCase):
1379
1380 ALLOWED_TYPES = ('processes', 'threads')
1381
1382 def _test(self, address):
1383 conn = self.connection.Client(address)
1384 conn.send('hello')
1385 conn.close()
1386
1387 def test_listener_client(self):
1388 for family in self.connection.families:
1389 l = self.connection.Listener(family=family)
1390 p = self.Process(target=self._test, args=(l.address,))
Benjamin Peterson58ea9fe2008-08-19 19:17:39 +00001391 p.daemon = True
Benjamin Petersone711caf2008-06-11 16:44:04 +00001392 p.start()
1393 conn = l.accept()
1394 self.assertEqual(conn.recv(), 'hello')
1395 p.join()
1396 l.close()
Benjamin Petersone711caf2008-06-11 16:44:04 +00001397#
1398# Test of sending connection and socket objects between processes
1399#
Benjamin Petersonb29cbbc2008-06-16 20:57:14 +00001400"""
Benjamin Petersone711caf2008-06-11 16:44:04 +00001401class _TestPicklingConnections(BaseTestCase):
1402
1403 ALLOWED_TYPES = ('processes',)
1404
1405 def _listener(self, conn, families):
1406 for fam in families:
1407 l = self.connection.Listener(family=fam)
1408 conn.send(l.address)
1409 new_conn = l.accept()
1410 conn.send(new_conn)
1411
1412 if self.TYPE == 'processes':
1413 l = socket.socket()
1414 l.bind(('localhost', 0))
1415 conn.send(l.getsockname())
1416 l.listen(1)
1417 new_conn, addr = l.accept()
1418 conn.send(new_conn)
1419
1420 conn.recv()
1421
1422 def _remote(self, conn):
1423 for (address, msg) in iter(conn.recv, None):
1424 client = self.connection.Client(address)
1425 client.send(msg.upper())
1426 client.close()
1427
1428 if self.TYPE == 'processes':
1429 address, msg = conn.recv()
1430 client = socket.socket()
1431 client.connect(address)
1432 client.sendall(msg.upper())
1433 client.close()
1434
1435 conn.close()
1436
1437 def test_pickling(self):
1438 try:
1439 multiprocessing.allow_connection_pickling()
1440 except ImportError:
1441 return
1442
1443 families = self.connection.families
1444
1445 lconn, lconn0 = self.Pipe()
1446 lp = self.Process(target=self._listener, args=(lconn0, families))
1447 lp.start()
1448 lconn0.close()
1449
1450 rconn, rconn0 = self.Pipe()
1451 rp = self.Process(target=self._remote, args=(rconn0,))
1452 rp.start()
1453 rconn0.close()
1454
1455 for fam in families:
1456 msg = ('This connection uses family %s' % fam).encode('ascii')
1457 address = lconn.recv()
1458 rconn.send((address, msg))
1459 new_conn = lconn.recv()
1460 self.assertEqual(new_conn.recv(), msg.upper())
1461
1462 rconn.send(None)
1463
1464 if self.TYPE == 'processes':
1465 msg = latin('This connection uses a normal socket')
1466 address = lconn.recv()
1467 rconn.send((address, msg))
1468 if hasattr(socket, 'fromfd'):
1469 new_conn = lconn.recv()
1470 self.assertEqual(new_conn.recv(100), msg.upper())
1471 else:
1472 # XXX On Windows with Py2.6 need to backport fromfd()
1473 discard = lconn.recv_bytes()
1474
1475 lconn.send(None)
1476
1477 rconn.close()
1478 lconn.close()
1479
1480 lp.join()
1481 rp.join()
Benjamin Petersonb29cbbc2008-06-16 20:57:14 +00001482"""
Benjamin Petersone711caf2008-06-11 16:44:04 +00001483#
1484#
1485#
1486
1487class _TestHeap(BaseTestCase):
1488
1489 ALLOWED_TYPES = ('processes',)
1490
1491 def test_heap(self):
1492 iterations = 5000
1493 maxblocks = 50
1494 blocks = []
1495
1496 # create and destroy lots of blocks of different sizes
1497 for i in range(iterations):
1498 size = int(random.lognormvariate(0, 1) * 1000)
1499 b = multiprocessing.heap.BufferWrapper(size)
1500 blocks.append(b)
1501 if len(blocks) > maxblocks:
1502 i = random.randrange(maxblocks)
1503 del blocks[i]
1504
1505 # get the heap object
1506 heap = multiprocessing.heap.BufferWrapper._heap
1507
1508 # verify the state of the heap
1509 all = []
1510 occupied = 0
1511 for L in list(heap._len_to_seq.values()):
1512 for arena, start, stop in L:
1513 all.append((heap._arenas.index(arena), start, stop,
1514 stop-start, 'free'))
1515 for arena, start, stop in heap._allocated_blocks:
1516 all.append((heap._arenas.index(arena), start, stop,
1517 stop-start, 'occupied'))
1518 occupied += (stop-start)
1519
1520 all.sort()
1521
1522 for i in range(len(all)-1):
1523 (arena, start, stop) = all[i][:3]
1524 (narena, nstart, nstop) = all[i+1][:3]
1525 self.assertTrue((arena != narena and nstart == 0) or
1526 (stop == nstart))
1527
1528#
1529#
1530#
1531
1532try:
1533 from ctypes import Structure, Value, copy, c_int, c_double
1534except ImportError:
1535 Structure = object
1536 c_int = c_double = None
1537
1538class _Foo(Structure):
1539 _fields_ = [
1540 ('x', c_int),
1541 ('y', c_double)
1542 ]
1543
1544class _TestSharedCTypes(BaseTestCase):
1545
1546 ALLOWED_TYPES = ('processes',)
1547
1548 def _double(self, x, y, foo, arr, string):
1549 x.value *= 2
1550 y.value *= 2
1551 foo.x *= 2
1552 foo.y *= 2
1553 string.value *= 2
1554 for i in range(len(arr)):
1555 arr[i] *= 2
1556
1557 def test_sharedctypes(self, lock=False):
1558 if c_int is None:
1559 return
1560
1561 x = Value('i', 7, lock=lock)
1562 y = Value(ctypes.c_double, 1.0/3.0, lock=lock)
1563 foo = Value(_Foo, 3, 2, lock=lock)
1564 arr = Array('d', list(range(10)), lock=lock)
1565 string = Array('c', 20, lock=lock)
1566 string.value = 'hello'
1567
1568 p = self.Process(target=self._double, args=(x, y, foo, arr, string))
1569 p.start()
1570 p.join()
1571
1572 self.assertEqual(x.value, 14)
1573 self.assertAlmostEqual(y.value, 2.0/3.0)
1574 self.assertEqual(foo.x, 6)
1575 self.assertAlmostEqual(foo.y, 4.0)
1576 for i in range(10):
1577 self.assertAlmostEqual(arr[i], i*2)
1578 self.assertEqual(string.value, latin('hellohello'))
1579
1580 def test_synchronize(self):
1581 self.test_sharedctypes(lock=True)
1582
1583 def test_copy(self):
1584 if c_int is None:
1585 return
1586
1587 foo = _Foo(2, 5.0)
1588 bar = copy(foo)
1589 foo.x = 0
1590 foo.y = 0
1591 self.assertEqual(bar.x, 2)
1592 self.assertAlmostEqual(bar.y, 5.0)
1593
1594#
1595#
1596#
1597
1598class _TestFinalize(BaseTestCase):
1599
1600 ALLOWED_TYPES = ('processes',)
1601
1602 def _test_finalize(self, conn):
1603 class Foo(object):
1604 pass
1605
1606 a = Foo()
1607 util.Finalize(a, conn.send, args=('a',))
1608 del a # triggers callback for a
1609
1610 b = Foo()
1611 close_b = util.Finalize(b, conn.send, args=('b',))
1612 close_b() # triggers callback for b
1613 close_b() # does nothing because callback has already been called
1614 del b # does nothing because callback has already been called
1615
1616 c = Foo()
1617 util.Finalize(c, conn.send, args=('c',))
1618
1619 d10 = Foo()
1620 util.Finalize(d10, conn.send, args=('d10',), exitpriority=1)
1621
1622 d01 = Foo()
1623 util.Finalize(d01, conn.send, args=('d01',), exitpriority=0)
1624 d02 = Foo()
1625 util.Finalize(d02, conn.send, args=('d02',), exitpriority=0)
1626 d03 = Foo()
1627 util.Finalize(d03, conn.send, args=('d03',), exitpriority=0)
1628
1629 util.Finalize(None, conn.send, args=('e',), exitpriority=-10)
1630
1631 util.Finalize(None, conn.send, args=('STOP',), exitpriority=-100)
1632
1633 # call mutliprocessing's cleanup function then exit process without
1634 # garbage collecting locals
1635 util._exit_function()
1636 conn.close()
1637 os._exit(0)
1638
1639 def test_finalize(self):
1640 conn, child_conn = self.Pipe()
1641
1642 p = self.Process(target=self._test_finalize, args=(child_conn,))
1643 p.start()
1644 p.join()
1645
1646 result = [obj for obj in iter(conn.recv, 'STOP')]
1647 self.assertEqual(result, ['a', 'b', 'd10', 'd03', 'd02', 'd01', 'e'])
1648
1649#
1650# Test that from ... import * works for each module
1651#
1652
1653class _TestImportStar(BaseTestCase):
1654
1655 ALLOWED_TYPES = ('processes',)
1656
1657 def test_import(self):
1658 modules = (
1659 'multiprocessing', 'multiprocessing.connection',
1660 'multiprocessing.heap', 'multiprocessing.managers',
1661 'multiprocessing.pool', 'multiprocessing.process',
1662 'multiprocessing.reduction', 'multiprocessing.sharedctypes',
1663 'multiprocessing.synchronize', 'multiprocessing.util'
1664 )
1665
1666 for name in modules:
1667 __import__(name)
1668 mod = sys.modules[name]
1669
1670 for attr in getattr(mod, '__all__', ()):
1671 self.assertTrue(
1672 hasattr(mod, attr),
1673 '%r does not have attribute %r' % (mod, attr)
1674 )
1675
1676#
1677# Quick test that logging works -- does not test logging output
1678#
1679
1680class _TestLogging(BaseTestCase):
1681
1682 ALLOWED_TYPES = ('processes',)
1683
1684 def test_enable_logging(self):
1685 logger = multiprocessing.get_logger()
1686 logger.setLevel(util.SUBWARNING)
1687 self.assertTrue(logger is not None)
1688 logger.debug('this will not be printed')
1689 logger.info('nor will this')
1690 logger.setLevel(LOG_LEVEL)
1691
1692 def _test_level(self, conn):
1693 logger = multiprocessing.get_logger()
1694 conn.send(logger.getEffectiveLevel())
1695
1696 def test_level(self):
1697 LEVEL1 = 32
1698 LEVEL2 = 37
1699
1700 logger = multiprocessing.get_logger()
1701 root_logger = logging.getLogger()
1702 root_level = root_logger.level
1703
1704 reader, writer = multiprocessing.Pipe(duplex=False)
1705
1706 logger.setLevel(LEVEL1)
1707 self.Process(target=self._test_level, args=(writer,)).start()
1708 self.assertEqual(LEVEL1, reader.recv())
1709
1710 logger.setLevel(logging.NOTSET)
1711 root_logger.setLevel(LEVEL2)
1712 self.Process(target=self._test_level, args=(writer,)).start()
1713 self.assertEqual(LEVEL2, reader.recv())
1714
1715 root_logger.setLevel(root_level)
1716 logger.setLevel(level=LOG_LEVEL)
1717
1718#
Jesse Noller6214edd2009-01-19 16:23:53 +00001719# Test to verify handle verification, see issue 3321
1720#
1721
1722class TestInvalidHandle(unittest.TestCase):
1723
1724 def test_invalid_handles(self):
1725 if WIN32:
1726 return
1727 conn = _multiprocessing.Connection(44977608)
1728 self.assertRaises(IOError, conn.poll)
1729 self.assertRaises(IOError, _multiprocessing.Connection, -1)
1730#
Benjamin Petersone711caf2008-06-11 16:44:04 +00001731# Functions used to create test cases from the base ones in this module
1732#
1733
1734def get_attributes(Source, names):
1735 d = {}
1736 for name in names:
1737 obj = getattr(Source, name)
1738 if type(obj) == type(get_attributes):
1739 obj = staticmethod(obj)
1740 d[name] = obj
1741 return d
1742
1743def create_test_cases(Mixin, type):
1744 result = {}
1745 glob = globals()
1746 Type = type[0].upper() + type[1:]
1747
1748 for name in list(glob.keys()):
1749 if name.startswith('_Test'):
1750 base = glob[name]
1751 if type in base.ALLOWED_TYPES:
1752 newname = 'With' + Type + name[1:]
1753 class Temp(base, unittest.TestCase, Mixin):
1754 pass
1755 result[newname] = Temp
1756 Temp.__name__ = newname
1757 Temp.__module__ = Mixin.__module__
1758 return result
1759
1760#
1761# Create test cases
1762#
1763
1764class ProcessesMixin(object):
1765 TYPE = 'processes'
1766 Process = multiprocessing.Process
1767 locals().update(get_attributes(multiprocessing, (
1768 'Queue', 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore',
1769 'Condition', 'Event', 'Value', 'Array', 'RawValue',
1770 'RawArray', 'current_process', 'active_children', 'Pipe',
1771 'connection', 'JoinableQueue'
1772 )))
1773
1774testcases_processes = create_test_cases(ProcessesMixin, type='processes')
1775globals().update(testcases_processes)
1776
1777
1778class ManagerMixin(object):
1779 TYPE = 'manager'
1780 Process = multiprocessing.Process
1781 manager = object.__new__(multiprocessing.managers.SyncManager)
1782 locals().update(get_attributes(manager, (
1783 'Queue', 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore',
1784 'Condition', 'Event', 'Value', 'Array', 'list', 'dict',
1785 'Namespace', 'JoinableQueue'
1786 )))
1787
1788testcases_manager = create_test_cases(ManagerMixin, type='manager')
1789globals().update(testcases_manager)
1790
1791
1792class ThreadsMixin(object):
1793 TYPE = 'threads'
1794 Process = multiprocessing.dummy.Process
1795 locals().update(get_attributes(multiprocessing.dummy, (
1796 'Queue', 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore',
1797 'Condition', 'Event', 'Value', 'Array', 'current_process',
1798 'active_children', 'Pipe', 'connection', 'dict', 'list',
1799 'Namespace', 'JoinableQueue'
1800 )))
1801
1802testcases_threads = create_test_cases(ThreadsMixin, type='threads')
1803globals().update(testcases_threads)
1804
Neal Norwitz5d6415e2008-08-25 01:53:32 +00001805class OtherTest(unittest.TestCase):
1806 # TODO: add more tests for deliver/answer challenge.
1807 def test_deliver_challenge_auth_failure(self):
1808 class _FakeConnection(object):
1809 def recv_bytes(self, size):
Neal Norwitzec105ad2008-08-25 03:05:54 +00001810 return b'something bogus'
Neal Norwitz5d6415e2008-08-25 01:53:32 +00001811 def send_bytes(self, data):
1812 pass
1813 self.assertRaises(multiprocessing.AuthenticationError,
1814 multiprocessing.connection.deliver_challenge,
1815 _FakeConnection(), b'abc')
1816
1817 def test_answer_challenge_auth_failure(self):
1818 class _FakeConnection(object):
1819 def __init__(self):
1820 self.count = 0
1821 def recv_bytes(self, size):
1822 self.count += 1
1823 if self.count == 1:
1824 return multiprocessing.connection.CHALLENGE
1825 elif self.count == 2:
Neal Norwitzec105ad2008-08-25 03:05:54 +00001826 return b'something bogus'
1827 return b''
Neal Norwitz5d6415e2008-08-25 01:53:32 +00001828 def send_bytes(self, data):
1829 pass
1830 self.assertRaises(multiprocessing.AuthenticationError,
1831 multiprocessing.connection.answer_challenge,
1832 _FakeConnection(), b'abc')
1833
Jesse Noller6214edd2009-01-19 16:23:53 +00001834testcases_other = [OtherTest, TestInvalidHandle]
Neal Norwitz5d6415e2008-08-25 01:53:32 +00001835
Benjamin Petersone711caf2008-06-11 16:44:04 +00001836#
1837#
1838#
1839
1840def test_main(run=None):
Jesse Nollerd00df3c2008-06-18 14:22:48 +00001841 if sys.platform.startswith("linux"):
1842 try:
1843 lock = multiprocessing.RLock()
1844 except OSError:
Amaury Forgeot d'Arc620626b2008-06-19 22:03:50 +00001845 from test.support import TestSkipped
Benjamin Petersone549ead2009-03-28 21:42:05 +00001846 raise unittest.SkipTest("OSError raises on RLock creation, see issue 3111!")
Benjamin Peterson3c0dd062008-06-17 22:43:48 +00001847
Benjamin Petersone711caf2008-06-11 16:44:04 +00001848 if run is None:
1849 from test.support import run_unittest as run
1850
1851 util.get_temp_dir() # creates temp directory for use by all processes
1852
1853 multiprocessing.get_logger().setLevel(LOG_LEVEL)
1854
Benjamin Peterson41181742008-07-02 20:22:54 +00001855 ProcessesMixin.pool = multiprocessing.Pool(4)
1856 ThreadsMixin.pool = multiprocessing.dummy.Pool(4)
1857 ManagerMixin.manager.__init__()
1858 ManagerMixin.manager.start()
1859 ManagerMixin.pool = ManagerMixin.manager.Pool(4)
Benjamin Petersone711caf2008-06-11 16:44:04 +00001860
1861 testcases = (
Benjamin Peterson41181742008-07-02 20:22:54 +00001862 sorted(testcases_processes.values(), key=lambda tc:tc.__name__) +
1863 sorted(testcases_threads.values(), key=lambda tc:tc.__name__) +
Neal Norwitz5d6415e2008-08-25 01:53:32 +00001864 sorted(testcases_manager.values(), key=lambda tc:tc.__name__) +
1865 testcases_other
Benjamin Petersone711caf2008-06-11 16:44:04 +00001866 )
1867
1868 loadTestsFromTestCase = unittest.defaultTestLoader.loadTestsFromTestCase
1869 suite = unittest.TestSuite(loadTestsFromTestCase(tc) for tc in testcases)
1870 run(suite)
1871
Benjamin Peterson41181742008-07-02 20:22:54 +00001872 ThreadsMixin.pool.terminate()
1873 ProcessesMixin.pool.terminate()
1874 ManagerMixin.pool.terminate()
1875 ManagerMixin.manager.shutdown()
Benjamin Petersone711caf2008-06-11 16:44:04 +00001876
Benjamin Peterson41181742008-07-02 20:22:54 +00001877 del ProcessesMixin.pool, ThreadsMixin.pool, ManagerMixin.pool
Benjamin Petersone711caf2008-06-11 16:44:04 +00001878
1879def main():
1880 test_main(unittest.TextTestRunner(verbosity=2).run)
1881
1882if __name__ == '__main__':
1883 main()