blob: aa4743f1274f85e0d73e2dbfe6f27ab663178f46 [file] [log] [blame]
Jesse Noller76cf55f2008-07-02 16:56:51 +00001#!/usr/bin/env python
2
Benjamin Petersondfd79492008-06-13 19:13:39 +00003#
4# Unit tests for the multiprocessing package
5#
6
7import unittest
8import threading
9import Queue
10import time
11import sys
12import os
13import gc
14import signal
15import array
16import copy
17import socket
18import random
19import logging
20
Jesse Noller37040cd2008-09-30 00:15:45 +000021
22# Work around broken sem_open implementations
23try:
24 import multiprocessing.synchronize
25except ImportError, e:
26 from test.test_support import TestSkipped
27 raise TestSkipped(e)
28
Benjamin Petersondfd79492008-06-13 19:13:39 +000029import multiprocessing.dummy
30import multiprocessing.connection
31import multiprocessing.managers
32import multiprocessing.heap
Benjamin Petersondfd79492008-06-13 19:13:39 +000033import multiprocessing.pool
34import _multiprocessing
35
36from multiprocessing import util
37
38#
39#
40#
41
Benjamin Petersone79edf52008-07-13 18:34:58 +000042latin = str
Benjamin Petersondfd79492008-06-13 19:13:39 +000043
Benjamin Petersondfd79492008-06-13 19:13:39 +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 Nollere6bab482009-03-30 16:11:16 +000064WIN32 = (sys.platform == "win32")
65
Benjamin Petersondfd79492008-06-13 19:13:39 +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()
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000132 authkey = current.authkey
Benjamin Petersondfd79492008-06-13 19:13:39 +0000133
134 self.assertTrue(current.is_alive())
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000135 self.assertTrue(not current.daemon)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000136 self.assertTrue(isinstance(authkey, bytes))
137 self.assertTrue(len(authkey) > 0)
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000138 self.assertEqual(current.ident, os.getpid())
139 self.assertEqual(current.exitcode, None)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000140
141 def _test(self, q, *args, **kwds):
142 current = self.current_process()
143 q.put(args)
144 q.put(kwds)
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000145 q.put(current.name)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000146 if self.TYPE != 'threads':
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000147 q.put(bytes(current.authkey))
Benjamin Petersondfd79492008-06-13 19:13:39 +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 )
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000159 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000160 current = self.current_process()
161
162 if self.TYPE != 'threads':
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000163 self.assertEquals(p.authkey, current.authkey)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000164 self.assertEquals(p.is_alive(), False)
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000165 self.assertEquals(p.daemon, True)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000166 self.assertTrue(p not in self.active_children())
167 self.assertTrue(type(self.active_children()) is list)
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000168 self.assertEqual(p.exitcode, None)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000169
170 p.start()
171
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000172 self.assertEquals(p.exitcode, None)
Benjamin Petersondfd79492008-06-13 19:13:39 +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)
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000178 self.assertEquals(q.get(), p.name)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000179 if self.TYPE != 'threads':
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000180 self.assertEquals(q.get(), current.authkey)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000181 self.assertEquals(q.get(), p.pid)
182
183 p.join()
184
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000185 self.assertEquals(p.exitcode, 0)
Benjamin Petersondfd79492008-06-13 19:13:39 +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)
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000197 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000198 p.start()
199
200 self.assertEqual(p.is_alive(), True)
201 self.assertTrue(p in self.active_children())
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000202 self.assertEqual(p.exitcode, None)
Benjamin Petersondfd79492008-06-13 19:13:39 +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
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000215 # XXX sometimes get p.exitcode == 0 on Windows ...
216 #self.assertEqual(p.exitcode, -signal.SIGTERM)
Benjamin Petersondfd79492008-06-13 19:13:39 +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 )
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000343 proc.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +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(Queue.Full, put, 7, False)
366 self.assertTimingAlmostEqual(put.elapsed, 0)
367
368 self.assertRaises(Queue.Full, put, 7, False, None)
369 self.assertTimingAlmostEqual(put.elapsed, 0)
370
371 self.assertRaises(Queue.Full, put_nowait, 7)
372 self.assertTimingAlmostEqual(put_nowait.elapsed, 0)
373
374 self.assertRaises(Queue.Full, put, 7, True, TIMEOUT1)
375 self.assertTimingAlmostEqual(put.elapsed, TIMEOUT1)
376
377 self.assertRaises(Queue.Full, put, 7, False, TIMEOUT2)
378 self.assertTimingAlmostEqual(put.elapsed, 0)
379
380 self.assertRaises(Queue.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 Petersonda3a1b12008-06-16 20:52:48 +0000393 #queue.put(1)
Benjamin Petersondfd79492008-06-13 19:13:39 +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 )
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000409 proc.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +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 Petersonda3a1b12008-06-16 20:52:48 +0000420 # Hangs unexpectedly, remove for now
421 #self.assertEqual(queue.get(), 1)
Benjamin Petersondfd79492008-06-13 19:13:39 +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(Queue.Empty, get, False)
433 self.assertTimingAlmostEqual(get.elapsed, 0)
434
435 self.assertRaises(Queue.Empty, get, False, None)
436 self.assertTimingAlmostEqual(get.elapsed, 0)
437
438 self.assertRaises(Queue.Empty, get_nowait)
439 self.assertTimingAlmostEqual(get_nowait.elapsed, 0)
440
441 self.assertRaises(Queue.Empty, get, True, TIMEOUT1)
442 self.assertTimingAlmostEqual(get.elapsed, TIMEOUT1)
443
444 self.assertRaises(Queue.Empty, get, False, TIMEOUT2)
445 self.assertTimingAlmostEqual(get.elapsed, 0)
446
447 self.assertRaises(Queue.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(Queue.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 xrange(4)]
513
514 for p in workers:
515 p.start()
516
517 for i in xrange(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
551
552class _TestSemaphore(BaseTestCase):
553
554 def _test_semaphore(self, sem):
555 self.assertReturnsIfImplemented(2, get_value, sem)
556 self.assertEqual(sem.acquire(), True)
557 self.assertReturnsIfImplemented(1, get_value, sem)
558 self.assertEqual(sem.acquire(), True)
559 self.assertReturnsIfImplemented(0, get_value, sem)
560 self.assertEqual(sem.acquire(False), False)
561 self.assertReturnsIfImplemented(0, get_value, sem)
562 self.assertEqual(sem.release(), None)
563 self.assertReturnsIfImplemented(1, get_value, sem)
564 self.assertEqual(sem.release(), None)
565 self.assertReturnsIfImplemented(2, get_value, sem)
566
567 def test_semaphore(self):
568 sem = self.Semaphore(2)
569 self._test_semaphore(sem)
570 self.assertEqual(sem.release(), None)
571 self.assertReturnsIfImplemented(3, get_value, sem)
572 self.assertEqual(sem.release(), None)
573 self.assertReturnsIfImplemented(4, get_value, sem)
574
575 def test_bounded_semaphore(self):
576 sem = self.BoundedSemaphore(2)
577 self._test_semaphore(sem)
578 # Currently fails on OS/X
579 #if HAVE_GETVALUE:
580 # self.assertRaises(ValueError, sem.release)
581 # self.assertReturnsIfImplemented(2, get_value, sem)
582
583 def test_timeout(self):
584 if self.TYPE != 'processes':
585 return
586
587 sem = self.Semaphore(0)
588 acquire = TimingWrapper(sem.acquire)
589
590 self.assertEqual(acquire(False), False)
591 self.assertTimingAlmostEqual(acquire.elapsed, 0.0)
592
593 self.assertEqual(acquire(False, None), False)
594 self.assertTimingAlmostEqual(acquire.elapsed, 0.0)
595
596 self.assertEqual(acquire(False, TIMEOUT1), False)
597 self.assertTimingAlmostEqual(acquire.elapsed, 0)
598
599 self.assertEqual(acquire(True, TIMEOUT2), False)
600 self.assertTimingAlmostEqual(acquire.elapsed, TIMEOUT2)
601
602 self.assertEqual(acquire(timeout=TIMEOUT3), False)
603 self.assertTimingAlmostEqual(acquire.elapsed, TIMEOUT3)
604
605
606class _TestCondition(BaseTestCase):
607
608 def f(self, cond, sleeping, woken, timeout=None):
609 cond.acquire()
610 sleeping.release()
611 cond.wait(timeout)
612 woken.release()
613 cond.release()
614
615 def check_invariant(self, cond):
616 # this is only supposed to succeed when there are no sleepers
617 if self.TYPE == 'processes':
618 try:
619 sleepers = (cond._sleeping_count.get_value() -
620 cond._woken_count.get_value())
621 self.assertEqual(sleepers, 0)
622 self.assertEqual(cond._wait_semaphore.get_value(), 0)
623 except NotImplementedError:
624 pass
625
626 def test_notify(self):
627 cond = self.Condition()
628 sleeping = self.Semaphore(0)
629 woken = self.Semaphore(0)
630
631 p = self.Process(target=self.f, args=(cond, sleeping, woken))
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000632 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000633 p.start()
634
635 p = threading.Thread(target=self.f, args=(cond, sleeping, woken))
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000636 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000637 p.start()
638
639 # wait for both children to start sleeping
640 sleeping.acquire()
641 sleeping.acquire()
642
643 # check no process/thread has woken up
644 time.sleep(DELTA)
645 self.assertReturnsIfImplemented(0, get_value, woken)
646
647 # wake up one process/thread
648 cond.acquire()
649 cond.notify()
650 cond.release()
651
652 # check one process/thread has woken up
653 time.sleep(DELTA)
654 self.assertReturnsIfImplemented(1, get_value, woken)
655
656 # wake up another
657 cond.acquire()
658 cond.notify()
659 cond.release()
660
661 # check other has woken up
662 time.sleep(DELTA)
663 self.assertReturnsIfImplemented(2, get_value, woken)
664
665 # check state is not mucked up
666 self.check_invariant(cond)
667 p.join()
668
669 def test_notify_all(self):
670 cond = self.Condition()
671 sleeping = self.Semaphore(0)
672 woken = self.Semaphore(0)
673
674 # start some threads/processes which will timeout
675 for i in range(3):
676 p = self.Process(target=self.f,
677 args=(cond, sleeping, woken, TIMEOUT1))
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000678 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000679 p.start()
680
681 t = threading.Thread(target=self.f,
682 args=(cond, sleeping, woken, TIMEOUT1))
Benjamin Petersona9b22222008-08-18 18:01:43 +0000683 t.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000684 t.start()
685
686 # wait for them all to sleep
687 for i in xrange(6):
688 sleeping.acquire()
689
690 # check they have all timed out
691 for i in xrange(6):
692 woken.acquire()
693 self.assertReturnsIfImplemented(0, get_value, woken)
694
695 # check state is not mucked up
696 self.check_invariant(cond)
697
698 # start some more threads/processes
699 for i in range(3):
700 p = self.Process(target=self.f, args=(cond, sleeping, woken))
Jesse Noller5bc9f4c2008-08-19 19:06:19 +0000701 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000702 p.start()
703
704 t = threading.Thread(target=self.f, args=(cond, sleeping, woken))
Benjamin Petersona9b22222008-08-18 18:01:43 +0000705 t.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +0000706 t.start()
707
708 # wait for them to all sleep
709 for i in xrange(6):
710 sleeping.acquire()
711
712 # check no process/thread has woken up
713 time.sleep(DELTA)
714 self.assertReturnsIfImplemented(0, get_value, woken)
715
716 # wake them all up
717 cond.acquire()
718 cond.notify_all()
719 cond.release()
720
721 # check they have all woken
722 time.sleep(DELTA)
723 self.assertReturnsIfImplemented(6, get_value, woken)
724
725 # check state is not mucked up
726 self.check_invariant(cond)
727
728 def test_timeout(self):
729 cond = self.Condition()
730 wait = TimingWrapper(cond.wait)
731 cond.acquire()
732 res = wait(TIMEOUT1)
733 cond.release()
734 self.assertEqual(res, None)
735 self.assertTimingAlmostEqual(wait.elapsed, TIMEOUT1)
736
737
738class _TestEvent(BaseTestCase):
739
740 def _test_event(self, event):
741 time.sleep(TIMEOUT2)
742 event.set()
743
744 def test_event(self):
745 event = self.Event()
746 wait = TimingWrapper(event.wait)
747
748 # Removed temporaily, due to API shear, this does not
749 # work with threading._Event objects. is_set == isSet
750 #self.assertEqual(event.is_set(), False)
751
752 self.assertEqual(wait(0.0), None)
753 self.assertTimingAlmostEqual(wait.elapsed, 0.0)
754 self.assertEqual(wait(TIMEOUT1), None)
755 self.assertTimingAlmostEqual(wait.elapsed, TIMEOUT1)
756
757 event.set()
758
759 # See note above on the API differences
760 # self.assertEqual(event.is_set(), True)
761 self.assertEqual(wait(), None)
762 self.assertTimingAlmostEqual(wait.elapsed, 0.0)
763 self.assertEqual(wait(TIMEOUT1), None)
764 self.assertTimingAlmostEqual(wait.elapsed, 0.0)
765 # self.assertEqual(event.is_set(), True)
766
767 event.clear()
768
769 #self.assertEqual(event.is_set(), False)
770
771 self.Process(target=self._test_event, args=(event,)).start()
772 self.assertEqual(wait(), None)
773
774#
775#
776#
777
778class _TestValue(BaseTestCase):
779
780 codes_values = [
781 ('i', 4343, 24234),
782 ('d', 3.625, -4.25),
783 ('h', -232, 234),
784 ('c', latin('x'), latin('y'))
785 ]
786
787 def _test(self, values):
788 for sv, cv in zip(values, self.codes_values):
789 sv.value = cv[2]
790
791
792 def test_value(self, raw=False):
793 if self.TYPE != 'processes':
794 return
795
796 if raw:
797 values = [self.RawValue(code, value)
798 for code, value, _ in self.codes_values]
799 else:
800 values = [self.Value(code, value)
801 for code, value, _ in self.codes_values]
802
803 for sv, cv in zip(values, self.codes_values):
804 self.assertEqual(sv.value, cv[1])
805
806 proc = self.Process(target=self._test, args=(values,))
807 proc.start()
808 proc.join()
809
810 for sv, cv in zip(values, self.codes_values):
811 self.assertEqual(sv.value, cv[2])
812
813 def test_rawvalue(self):
814 self.test_value(raw=True)
815
816 def test_getobj_getlock(self):
817 if self.TYPE != 'processes':
818 return
819
820 val1 = self.Value('i', 5)
821 lock1 = val1.get_lock()
822 obj1 = val1.get_obj()
823
824 val2 = self.Value('i', 5, lock=None)
825 lock2 = val2.get_lock()
826 obj2 = val2.get_obj()
827
828 lock = self.Lock()
829 val3 = self.Value('i', 5, lock=lock)
830 lock3 = val3.get_lock()
831 obj3 = val3.get_obj()
832 self.assertEqual(lock, lock3)
833
Benjamin Petersonafd7eaa2009-01-18 04:01:18 +0000834 arr4 = self.Value('i', 5, lock=False)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000835 self.assertFalse(hasattr(arr4, 'get_lock'))
836 self.assertFalse(hasattr(arr4, 'get_obj'))
837
Benjamin Petersonafd7eaa2009-01-18 04:01:18 +0000838 self.assertRaises(AttributeError, self.Value, 'i', 5, lock='navalue')
839
840 arr5 = self.RawValue('i', 5)
841 self.assertFalse(hasattr(arr5, 'get_lock'))
842 self.assertFalse(hasattr(arr5, 'get_obj'))
843
Benjamin Petersondfd79492008-06-13 19:13:39 +0000844
845class _TestArray(BaseTestCase):
846
847 def f(self, seq):
848 for i in range(1, len(seq)):
849 seq[i] += seq[i-1]
850
851 def test_array(self, raw=False):
852 if self.TYPE != 'processes':
853 return
854
855 seq = [680, 626, 934, 821, 150, 233, 548, 982, 714, 831]
856 if raw:
857 arr = self.RawArray('i', seq)
858 else:
859 arr = self.Array('i', seq)
860
861 self.assertEqual(len(arr), len(seq))
862 self.assertEqual(arr[3], seq[3])
863 self.assertEqual(list(arr[2:7]), list(seq[2:7]))
864
865 arr[4:8] = seq[4:8] = array.array('i', [1, 2, 3, 4])
866
867 self.assertEqual(list(arr[:]), seq)
868
869 self.f(seq)
870
871 p = self.Process(target=self.f, args=(arr,))
872 p.start()
873 p.join()
874
875 self.assertEqual(list(arr[:]), seq)
876
877 def test_rawarray(self):
878 self.test_array(raw=True)
879
880 def test_getobj_getlock_obj(self):
881 if self.TYPE != 'processes':
882 return
883
884 arr1 = self.Array('i', range(10))
885 lock1 = arr1.get_lock()
886 obj1 = arr1.get_obj()
887
888 arr2 = self.Array('i', range(10), lock=None)
889 lock2 = arr2.get_lock()
890 obj2 = arr2.get_obj()
891
892 lock = self.Lock()
893 arr3 = self.Array('i', range(10), lock=lock)
894 lock3 = arr3.get_lock()
895 obj3 = arr3.get_obj()
896 self.assertEqual(lock, lock3)
897
Benjamin Petersonafd7eaa2009-01-18 04:01:18 +0000898 arr4 = self.Array('i', range(10), lock=False)
Benjamin Petersondfd79492008-06-13 19:13:39 +0000899 self.assertFalse(hasattr(arr4, 'get_lock'))
900 self.assertFalse(hasattr(arr4, 'get_obj'))
Benjamin Petersonafd7eaa2009-01-18 04:01:18 +0000901 self.assertRaises(AttributeError,
902 self.Array, 'i', range(10), lock='notalock')
903
904 arr5 = self.RawArray('i', range(10))
905 self.assertFalse(hasattr(arr5, 'get_lock'))
906 self.assertFalse(hasattr(arr5, 'get_obj'))
Benjamin Petersondfd79492008-06-13 19:13:39 +0000907
908#
909#
910#
911
912class _TestContainers(BaseTestCase):
913
914 ALLOWED_TYPES = ('manager',)
915
916 def test_list(self):
917 a = self.list(range(10))
918 self.assertEqual(a[:], range(10))
919
920 b = self.list()
921 self.assertEqual(b[:], [])
922
923 b.extend(range(5))
924 self.assertEqual(b[:], range(5))
925
926 self.assertEqual(b[2], 2)
927 self.assertEqual(b[2:10], [2,3,4])
928
929 b *= 2
930 self.assertEqual(b[:], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4])
931
932 self.assertEqual(b + [5, 6], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4, 5, 6])
933
934 self.assertEqual(a[:], range(10))
935
936 d = [a, b]
937 e = self.list(d)
938 self.assertEqual(
939 e[:],
940 [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4]]
941 )
942
943 f = self.list([a])
944 a.append('hello')
945 self.assertEqual(f[:], [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 'hello']])
946
947 def test_dict(self):
948 d = self.dict()
949 indices = range(65, 70)
950 for i in indices:
951 d[i] = chr(i)
952 self.assertEqual(d.copy(), dict((i, chr(i)) for i in indices))
953 self.assertEqual(sorted(d.keys()), indices)
954 self.assertEqual(sorted(d.values()), [chr(i) for i in indices])
955 self.assertEqual(sorted(d.items()), [(i, chr(i)) for i in indices])
956
957 def test_namespace(self):
958 n = self.Namespace()
959 n.name = 'Bob'
960 n.job = 'Builder'
961 n._hidden = 'hidden'
962 self.assertEqual((n.name, n.job), ('Bob', 'Builder'))
963 del n.job
964 self.assertEqual(str(n), "Namespace(name='Bob')")
965 self.assertTrue(hasattr(n, 'name'))
966 self.assertTrue(not hasattr(n, 'job'))
967
968#
969#
970#
971
972def sqr(x, wait=0.0):
973 time.sleep(wait)
974 return x*x
Benjamin Petersondfd79492008-06-13 19:13:39 +0000975class _TestPool(BaseTestCase):
976
977 def test_apply(self):
978 papply = self.pool.apply
979 self.assertEqual(papply(sqr, (5,)), sqr(5))
980 self.assertEqual(papply(sqr, (), {'x':3}), sqr(x=3))
981
982 def test_map(self):
983 pmap = self.pool.map
984 self.assertEqual(pmap(sqr, range(10)), map(sqr, range(10)))
985 self.assertEqual(pmap(sqr, range(100), chunksize=20),
986 map(sqr, range(100)))
987
988 def test_async(self):
989 res = self.pool.apply_async(sqr, (7, TIMEOUT1,))
990 get = TimingWrapper(res.get)
991 self.assertEqual(get(), 49)
992 self.assertTimingAlmostEqual(get.elapsed, TIMEOUT1)
993
994 def test_async_timeout(self):
995 res = self.pool.apply_async(sqr, (6, TIMEOUT2 + 0.2))
996 get = TimingWrapper(res.get)
997 self.assertRaises(multiprocessing.TimeoutError, get, timeout=TIMEOUT2)
998 self.assertTimingAlmostEqual(get.elapsed, TIMEOUT2)
999
1000 def test_imap(self):
1001 it = self.pool.imap(sqr, range(10))
1002 self.assertEqual(list(it), map(sqr, range(10)))
1003
1004 it = self.pool.imap(sqr, range(10))
1005 for i in range(10):
1006 self.assertEqual(it.next(), i*i)
1007 self.assertRaises(StopIteration, it.next)
1008
1009 it = self.pool.imap(sqr, range(1000), chunksize=100)
1010 for i in range(1000):
1011 self.assertEqual(it.next(), i*i)
1012 self.assertRaises(StopIteration, it.next)
1013
1014 def test_imap_unordered(self):
1015 it = self.pool.imap_unordered(sqr, range(1000))
1016 self.assertEqual(sorted(it), map(sqr, range(1000)))
1017
1018 it = self.pool.imap_unordered(sqr, range(1000), chunksize=53)
1019 self.assertEqual(sorted(it), map(sqr, range(1000)))
1020
1021 def test_make_pool(self):
1022 p = multiprocessing.Pool(3)
1023 self.assertEqual(3, len(p._pool))
1024 p.close()
1025 p.join()
1026
1027 def test_terminate(self):
1028 if self.TYPE == 'manager':
1029 # On Unix a forked process increfs each shared object to
1030 # which its parent process held a reference. If the
1031 # forked process gets terminated then there is likely to
1032 # be a reference leak. So to prevent
1033 # _TestZZZNumberOfObjects from failing we skip this test
1034 # when using a manager.
1035 return
1036
1037 result = self.pool.map_async(
1038 time.sleep, [0.1 for i in range(10000)], chunksize=1
1039 )
1040 self.pool.terminate()
1041 join = TimingWrapper(self.pool.join)
1042 join()
1043 self.assertTrue(join.elapsed < 0.2)
Benjamin Petersondfd79492008-06-13 19:13:39 +00001044#
1045# Test that manager has expected number of shared objects left
1046#
1047
1048class _TestZZZNumberOfObjects(BaseTestCase):
1049 # Because test cases are sorted alphabetically, this one will get
1050 # run after all the other tests for the manager. It tests that
1051 # there have been no "reference leaks" for the manager's shared
1052 # objects. Note the comment in _TestPool.test_terminate().
1053 ALLOWED_TYPES = ('manager',)
1054
1055 def test_number_of_objects(self):
1056 EXPECTED_NUMBER = 1 # the pool object is still alive
1057 multiprocessing.active_children() # discard dead process objs
1058 gc.collect() # do garbage collection
1059 refs = self.manager._number_of_objects()
1060 if refs != EXPECTED_NUMBER:
Jesse Noller7fb96402008-07-17 21:01:05 +00001061 print self.manager._debug_info()
Benjamin Petersondfd79492008-06-13 19:13:39 +00001062
1063 self.assertEqual(refs, EXPECTED_NUMBER)
1064
1065#
1066# Test of creating a customized manager class
1067#
1068
1069from multiprocessing.managers import BaseManager, BaseProxy, RemoteError
1070
1071class FooBar(object):
1072 def f(self):
1073 return 'f()'
1074 def g(self):
1075 raise ValueError
1076 def _h(self):
1077 return '_h()'
1078
1079def baz():
1080 for i in xrange(10):
1081 yield i*i
1082
1083class IteratorProxy(BaseProxy):
1084 _exposed_ = ('next', '__next__')
1085 def __iter__(self):
1086 return self
1087 def next(self):
1088 return self._callmethod('next')
1089 def __next__(self):
1090 return self._callmethod('__next__')
1091
1092class MyManager(BaseManager):
1093 pass
1094
1095MyManager.register('Foo', callable=FooBar)
1096MyManager.register('Bar', callable=FooBar, exposed=('f', '_h'))
1097MyManager.register('baz', callable=baz, proxytype=IteratorProxy)
1098
1099
1100class _TestMyManager(BaseTestCase):
1101
1102 ALLOWED_TYPES = ('manager',)
1103
1104 def test_mymanager(self):
1105 manager = MyManager()
1106 manager.start()
1107
1108 foo = manager.Foo()
1109 bar = manager.Bar()
1110 baz = manager.baz()
1111
1112 foo_methods = [name for name in ('f', 'g', '_h') if hasattr(foo, name)]
1113 bar_methods = [name for name in ('f', 'g', '_h') if hasattr(bar, name)]
1114
1115 self.assertEqual(foo_methods, ['f', 'g'])
1116 self.assertEqual(bar_methods, ['f', '_h'])
1117
1118 self.assertEqual(foo.f(), 'f()')
1119 self.assertRaises(ValueError, foo.g)
1120 self.assertEqual(foo._callmethod('f'), 'f()')
1121 self.assertRaises(RemoteError, foo._callmethod, '_h')
1122
1123 self.assertEqual(bar.f(), 'f()')
1124 self.assertEqual(bar._h(), '_h()')
1125 self.assertEqual(bar._callmethod('f'), 'f()')
1126 self.assertEqual(bar._callmethod('_h'), '_h()')
1127
1128 self.assertEqual(list(baz), [i*i for i in range(10)])
1129
1130 manager.shutdown()
1131
1132#
1133# Test of connecting to a remote server and using xmlrpclib for serialization
1134#
1135
1136_queue = Queue.Queue()
1137def get_queue():
1138 return _queue
1139
1140class QueueManager(BaseManager):
1141 '''manager class used by server process'''
1142QueueManager.register('get_queue', callable=get_queue)
1143
1144class QueueManager2(BaseManager):
1145 '''manager class which specifies the same interface as QueueManager'''
1146QueueManager2.register('get_queue')
1147
1148
1149SERIALIZER = 'xmlrpclib'
1150
1151class _TestRemoteManager(BaseTestCase):
1152
1153 ALLOWED_TYPES = ('manager',)
1154
1155 def _putter(self, address, authkey):
1156 manager = QueueManager2(
1157 address=address, authkey=authkey, serializer=SERIALIZER
1158 )
1159 manager.connect()
1160 queue = manager.get_queue()
1161 queue.put(('hello world', None, True, 2.25))
1162
1163 def test_remote(self):
1164 authkey = os.urandom(32)
1165
1166 manager = QueueManager(
1167 address=('localhost', 0), authkey=authkey, serializer=SERIALIZER
1168 )
1169 manager.start()
1170
1171 p = self.Process(target=self._putter, args=(manager.address, authkey))
1172 p.start()
1173
1174 manager2 = QueueManager2(
1175 address=manager.address, authkey=authkey, serializer=SERIALIZER
1176 )
1177 manager2.connect()
1178 queue = manager2.get_queue()
1179
1180 # Note that xmlrpclib will deserialize object as a list not a tuple
1181 self.assertEqual(queue.get(), ['hello world', None, True, 2.25])
1182
1183 # Because we are using xmlrpclib for serialization instead of
1184 # pickle this will cause a serialization error.
1185 self.assertRaises(Exception, queue.put, time.sleep)
1186
1187 # Make queue finalizer run before the server is stopped
1188 del queue
1189 manager.shutdown()
1190
Jesse Nollerb48cfa62009-03-30 16:19:10 +00001191class _TestManagerRestart(BaseTestCase):
1192
1193 def _putter(self, address, authkey):
1194 manager = QueueManager(
1195 address=address, authkey=authkey, serializer=SERIALIZER)
1196 manager.connect()
1197 queue = manager.get_queue()
1198 queue.put('hello world')
1199
1200 def test_rapid_restart(self):
1201 authkey = os.urandom(32)
1202 manager = QueueManager(
1203 address=('localhost', 9999), authkey=authkey, serializer=SERIALIZER)
1204 manager.start()
1205
1206 p = self.Process(target=self._putter, args=(manager.address, authkey))
1207 p.start()
1208 queue = manager.get_queue()
1209 self.assertEqual(queue.get(), 'hello world')
1210 manager.shutdown()
1211 manager = QueueManager(
1212 address=('localhost', 9999), authkey=authkey, serializer=SERIALIZER)
1213 manager.start()
1214
Benjamin Petersondfd79492008-06-13 19:13:39 +00001215#
1216#
1217#
1218
1219SENTINEL = latin('')
1220
1221class _TestConnection(BaseTestCase):
1222
1223 ALLOWED_TYPES = ('processes', 'threads')
1224
1225 def _echo(self, conn):
1226 for msg in iter(conn.recv_bytes, SENTINEL):
1227 conn.send_bytes(msg)
1228 conn.close()
1229
1230 def test_connection(self):
1231 conn, child_conn = self.Pipe()
1232
1233 p = self.Process(target=self._echo, args=(child_conn,))
Jesse Noller5bc9f4c2008-08-19 19:06:19 +00001234 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +00001235 p.start()
1236
1237 seq = [1, 2.25, None]
1238 msg = latin('hello world')
1239 longmsg = msg * 10
1240 arr = array.array('i', range(4))
1241
1242 if self.TYPE == 'processes':
1243 self.assertEqual(type(conn.fileno()), int)
1244
1245 self.assertEqual(conn.send(seq), None)
1246 self.assertEqual(conn.recv(), seq)
1247
1248 self.assertEqual(conn.send_bytes(msg), None)
1249 self.assertEqual(conn.recv_bytes(), msg)
1250
1251 if self.TYPE == 'processes':
1252 buffer = array.array('i', [0]*10)
1253 expected = list(arr) + [0] * (10 - len(arr))
1254 self.assertEqual(conn.send_bytes(arr), None)
1255 self.assertEqual(conn.recv_bytes_into(buffer),
1256 len(arr) * buffer.itemsize)
1257 self.assertEqual(list(buffer), expected)
1258
1259 buffer = array.array('i', [0]*10)
1260 expected = [0] * 3 + list(arr) + [0] * (10 - 3 - len(arr))
1261 self.assertEqual(conn.send_bytes(arr), None)
1262 self.assertEqual(conn.recv_bytes_into(buffer, 3 * buffer.itemsize),
1263 len(arr) * buffer.itemsize)
1264 self.assertEqual(list(buffer), expected)
1265
1266 buffer = bytearray(latin(' ' * 40))
1267 self.assertEqual(conn.send_bytes(longmsg), None)
1268 try:
1269 res = conn.recv_bytes_into(buffer)
1270 except multiprocessing.BufferTooShort, e:
1271 self.assertEqual(e.args, (longmsg,))
1272 else:
1273 self.fail('expected BufferTooShort, got %s' % res)
1274
1275 poll = TimingWrapper(conn.poll)
1276
1277 self.assertEqual(poll(), False)
1278 self.assertTimingAlmostEqual(poll.elapsed, 0)
1279
1280 self.assertEqual(poll(TIMEOUT1), False)
1281 self.assertTimingAlmostEqual(poll.elapsed, TIMEOUT1)
1282
1283 conn.send(None)
1284
1285 self.assertEqual(poll(TIMEOUT1), True)
1286 self.assertTimingAlmostEqual(poll.elapsed, 0)
1287
1288 self.assertEqual(conn.recv(), None)
1289
1290 really_big_msg = latin('X') * (1024 * 1024 * 16) # 16Mb
1291 conn.send_bytes(really_big_msg)
1292 self.assertEqual(conn.recv_bytes(), really_big_msg)
1293
1294 conn.send_bytes(SENTINEL) # tell child to quit
1295 child_conn.close()
1296
1297 if self.TYPE == 'processes':
1298 self.assertEqual(conn.readable, True)
1299 self.assertEqual(conn.writable, True)
1300 self.assertRaises(EOFError, conn.recv)
1301 self.assertRaises(EOFError, conn.recv_bytes)
1302
1303 p.join()
1304
1305 def test_duplex_false(self):
1306 reader, writer = self.Pipe(duplex=False)
1307 self.assertEqual(writer.send(1), None)
1308 self.assertEqual(reader.recv(), 1)
1309 if self.TYPE == 'processes':
1310 self.assertEqual(reader.readable, True)
1311 self.assertEqual(reader.writable, False)
1312 self.assertEqual(writer.readable, False)
1313 self.assertEqual(writer.writable, True)
1314 self.assertRaises(IOError, reader.send, 2)
1315 self.assertRaises(IOError, writer.recv)
1316 self.assertRaises(IOError, writer.poll)
1317
1318 def test_spawn_close(self):
1319 # We test that a pipe connection can be closed by parent
1320 # process immediately after child is spawned. On Windows this
1321 # would have sometimes failed on old versions because
1322 # child_conn would be closed before the child got a chance to
1323 # duplicate it.
1324 conn, child_conn = self.Pipe()
1325
1326 p = self.Process(target=self._echo, args=(child_conn,))
1327 p.start()
1328 child_conn.close() # this might complete before child initializes
1329
1330 msg = latin('hello')
1331 conn.send_bytes(msg)
1332 self.assertEqual(conn.recv_bytes(), msg)
1333
1334 conn.send_bytes(SENTINEL)
1335 conn.close()
1336 p.join()
1337
1338 def test_sendbytes(self):
1339 if self.TYPE != 'processes':
1340 return
1341
1342 msg = latin('abcdefghijklmnopqrstuvwxyz')
1343 a, b = self.Pipe()
1344
1345 a.send_bytes(msg)
1346 self.assertEqual(b.recv_bytes(), msg)
1347
1348 a.send_bytes(msg, 5)
1349 self.assertEqual(b.recv_bytes(), msg[5:])
1350
1351 a.send_bytes(msg, 7, 8)
1352 self.assertEqual(b.recv_bytes(), msg[7:7+8])
1353
1354 a.send_bytes(msg, 26)
1355 self.assertEqual(b.recv_bytes(), latin(''))
1356
1357 a.send_bytes(msg, 26, 0)
1358 self.assertEqual(b.recv_bytes(), latin(''))
1359
1360 self.assertRaises(ValueError, a.send_bytes, msg, 27)
1361
1362 self.assertRaises(ValueError, a.send_bytes, msg, 22, 5)
1363
1364 self.assertRaises(ValueError, a.send_bytes, msg, 26, 1)
1365
1366 self.assertRaises(ValueError, a.send_bytes, msg, -1)
1367
1368 self.assertRaises(ValueError, a.send_bytes, msg, 4, -1)
1369
Benjamin Petersondfd79492008-06-13 19:13:39 +00001370class _TestListenerClient(BaseTestCase):
1371
1372 ALLOWED_TYPES = ('processes', 'threads')
1373
1374 def _test(self, address):
1375 conn = self.connection.Client(address)
1376 conn.send('hello')
1377 conn.close()
1378
1379 def test_listener_client(self):
1380 for family in self.connection.families:
1381 l = self.connection.Listener(family=family)
1382 p = self.Process(target=self._test, args=(l.address,))
Jesse Noller5bc9f4c2008-08-19 19:06:19 +00001383 p.daemon = True
Benjamin Petersondfd79492008-06-13 19:13:39 +00001384 p.start()
1385 conn = l.accept()
1386 self.assertEqual(conn.recv(), 'hello')
1387 p.join()
1388 l.close()
Benjamin Petersondfd79492008-06-13 19:13:39 +00001389#
1390# Test of sending connection and socket objects between processes
1391#
Benjamin Petersonda3a1b12008-06-16 20:52:48 +00001392"""
Benjamin Petersondfd79492008-06-13 19:13:39 +00001393class _TestPicklingConnections(BaseTestCase):
1394
1395 ALLOWED_TYPES = ('processes',)
1396
1397 def _listener(self, conn, families):
1398 for fam in families:
1399 l = self.connection.Listener(family=fam)
1400 conn.send(l.address)
1401 new_conn = l.accept()
1402 conn.send(new_conn)
1403
1404 if self.TYPE == 'processes':
1405 l = socket.socket()
1406 l.bind(('localhost', 0))
1407 conn.send(l.getsockname())
1408 l.listen(1)
1409 new_conn, addr = l.accept()
1410 conn.send(new_conn)
1411
1412 conn.recv()
1413
1414 def _remote(self, conn):
1415 for (address, msg) in iter(conn.recv, None):
1416 client = self.connection.Client(address)
1417 client.send(msg.upper())
1418 client.close()
1419
1420 if self.TYPE == 'processes':
1421 address, msg = conn.recv()
1422 client = socket.socket()
1423 client.connect(address)
1424 client.sendall(msg.upper())
1425 client.close()
1426
1427 conn.close()
1428
1429 def test_pickling(self):
1430 try:
1431 multiprocessing.allow_connection_pickling()
1432 except ImportError:
1433 return
1434
1435 families = self.connection.families
1436
1437 lconn, lconn0 = self.Pipe()
1438 lp = self.Process(target=self._listener, args=(lconn0, families))
1439 lp.start()
1440 lconn0.close()
1441
1442 rconn, rconn0 = self.Pipe()
1443 rp = self.Process(target=self._remote, args=(rconn0,))
1444 rp.start()
1445 rconn0.close()
1446
1447 for fam in families:
1448 msg = ('This connection uses family %s' % fam).encode('ascii')
1449 address = lconn.recv()
1450 rconn.send((address, msg))
1451 new_conn = lconn.recv()
1452 self.assertEqual(new_conn.recv(), msg.upper())
1453
1454 rconn.send(None)
1455
1456 if self.TYPE == 'processes':
1457 msg = latin('This connection uses a normal socket')
1458 address = lconn.recv()
1459 rconn.send((address, msg))
1460 if hasattr(socket, 'fromfd'):
1461 new_conn = lconn.recv()
1462 self.assertEqual(new_conn.recv(100), msg.upper())
1463 else:
1464 # XXX On Windows with Py2.6 need to backport fromfd()
1465 discard = lconn.recv_bytes()
1466
1467 lconn.send(None)
1468
1469 rconn.close()
1470 lconn.close()
1471
1472 lp.join()
1473 rp.join()
Benjamin Petersonda3a1b12008-06-16 20:52:48 +00001474"""
Benjamin Petersondfd79492008-06-13 19:13:39 +00001475#
1476#
1477#
1478
1479class _TestHeap(BaseTestCase):
1480
1481 ALLOWED_TYPES = ('processes',)
1482
1483 def test_heap(self):
1484 iterations = 5000
1485 maxblocks = 50
1486 blocks = []
1487
1488 # create and destroy lots of blocks of different sizes
1489 for i in xrange(iterations):
1490 size = int(random.lognormvariate(0, 1) * 1000)
1491 b = multiprocessing.heap.BufferWrapper(size)
1492 blocks.append(b)
1493 if len(blocks) > maxblocks:
1494 i = random.randrange(maxblocks)
1495 del blocks[i]
1496
1497 # get the heap object
1498 heap = multiprocessing.heap.BufferWrapper._heap
1499
1500 # verify the state of the heap
1501 all = []
1502 occupied = 0
1503 for L in heap._len_to_seq.values():
1504 for arena, start, stop in L:
1505 all.append((heap._arenas.index(arena), start, stop,
1506 stop-start, 'free'))
1507 for arena, start, stop in heap._allocated_blocks:
1508 all.append((heap._arenas.index(arena), start, stop,
1509 stop-start, 'occupied'))
1510 occupied += (stop-start)
1511
1512 all.sort()
1513
1514 for i in range(len(all)-1):
1515 (arena, start, stop) = all[i][:3]
1516 (narena, nstart, nstop) = all[i+1][:3]
1517 self.assertTrue((arena != narena and nstart == 0) or
1518 (stop == nstart))
1519
1520#
1521#
1522#
1523
1524try:
1525 from ctypes import Structure, Value, copy, c_int, c_double
1526except ImportError:
1527 Structure = object
1528 c_int = c_double = None
1529
1530class _Foo(Structure):
1531 _fields_ = [
1532 ('x', c_int),
1533 ('y', c_double)
1534 ]
1535
1536class _TestSharedCTypes(BaseTestCase):
1537
1538 ALLOWED_TYPES = ('processes',)
1539
1540 def _double(self, x, y, foo, arr, string):
1541 x.value *= 2
1542 y.value *= 2
1543 foo.x *= 2
1544 foo.y *= 2
1545 string.value *= 2
1546 for i in range(len(arr)):
1547 arr[i] *= 2
1548
1549 def test_sharedctypes(self, lock=False):
1550 if c_int is None:
1551 return
1552
1553 x = Value('i', 7, lock=lock)
1554 y = Value(ctypes.c_double, 1.0/3.0, lock=lock)
1555 foo = Value(_Foo, 3, 2, lock=lock)
1556 arr = Array('d', range(10), lock=lock)
1557 string = Array('c', 20, lock=lock)
1558 string.value = 'hello'
1559
1560 p = self.Process(target=self._double, args=(x, y, foo, arr, string))
1561 p.start()
1562 p.join()
1563
1564 self.assertEqual(x.value, 14)
1565 self.assertAlmostEqual(y.value, 2.0/3.0)
1566 self.assertEqual(foo.x, 6)
1567 self.assertAlmostEqual(foo.y, 4.0)
1568 for i in range(10):
1569 self.assertAlmostEqual(arr[i], i*2)
1570 self.assertEqual(string.value, latin('hellohello'))
1571
1572 def test_synchronize(self):
1573 self.test_sharedctypes(lock=True)
1574
1575 def test_copy(self):
1576 if c_int is None:
1577 return
1578
1579 foo = _Foo(2, 5.0)
1580 bar = copy(foo)
1581 foo.x = 0
1582 foo.y = 0
1583 self.assertEqual(bar.x, 2)
1584 self.assertAlmostEqual(bar.y, 5.0)
1585
1586#
1587#
1588#
1589
1590class _TestFinalize(BaseTestCase):
1591
1592 ALLOWED_TYPES = ('processes',)
1593
1594 def _test_finalize(self, conn):
1595 class Foo(object):
1596 pass
1597
1598 a = Foo()
1599 util.Finalize(a, conn.send, args=('a',))
1600 del a # triggers callback for a
1601
1602 b = Foo()
1603 close_b = util.Finalize(b, conn.send, args=('b',))
1604 close_b() # triggers callback for b
1605 close_b() # does nothing because callback has already been called
1606 del b # does nothing because callback has already been called
1607
1608 c = Foo()
1609 util.Finalize(c, conn.send, args=('c',))
1610
1611 d10 = Foo()
1612 util.Finalize(d10, conn.send, args=('d10',), exitpriority=1)
1613
1614 d01 = Foo()
1615 util.Finalize(d01, conn.send, args=('d01',), exitpriority=0)
1616 d02 = Foo()
1617 util.Finalize(d02, conn.send, args=('d02',), exitpriority=0)
1618 d03 = Foo()
1619 util.Finalize(d03, conn.send, args=('d03',), exitpriority=0)
1620
1621 util.Finalize(None, conn.send, args=('e',), exitpriority=-10)
1622
1623 util.Finalize(None, conn.send, args=('STOP',), exitpriority=-100)
1624
1625 # call mutliprocessing's cleanup function then exit process without
1626 # garbage collecting locals
1627 util._exit_function()
1628 conn.close()
1629 os._exit(0)
1630
1631 def test_finalize(self):
1632 conn, child_conn = self.Pipe()
1633
1634 p = self.Process(target=self._test_finalize, args=(child_conn,))
1635 p.start()
1636 p.join()
1637
1638 result = [obj for obj in iter(conn.recv, 'STOP')]
1639 self.assertEqual(result, ['a', 'b', 'd10', 'd03', 'd02', 'd01', 'e'])
1640
1641#
1642# Test that from ... import * works for each module
1643#
1644
1645class _TestImportStar(BaseTestCase):
1646
1647 ALLOWED_TYPES = ('processes',)
1648
1649 def test_import(self):
1650 modules = (
1651 'multiprocessing', 'multiprocessing.connection',
1652 'multiprocessing.heap', 'multiprocessing.managers',
1653 'multiprocessing.pool', 'multiprocessing.process',
1654 'multiprocessing.reduction', 'multiprocessing.sharedctypes',
1655 'multiprocessing.synchronize', 'multiprocessing.util'
1656 )
1657
1658 for name in modules:
1659 __import__(name)
1660 mod = sys.modules[name]
1661
1662 for attr in getattr(mod, '__all__', ()):
1663 self.assertTrue(
1664 hasattr(mod, attr),
1665 '%r does not have attribute %r' % (mod, attr)
1666 )
1667
1668#
1669# Quick test that logging works -- does not test logging output
1670#
1671
1672class _TestLogging(BaseTestCase):
1673
1674 ALLOWED_TYPES = ('processes',)
1675
1676 def test_enable_logging(self):
1677 logger = multiprocessing.get_logger()
1678 logger.setLevel(util.SUBWARNING)
1679 self.assertTrue(logger is not None)
1680 logger.debug('this will not be printed')
1681 logger.info('nor will this')
1682 logger.setLevel(LOG_LEVEL)
1683
1684 def _test_level(self, conn):
1685 logger = multiprocessing.get_logger()
1686 conn.send(logger.getEffectiveLevel())
1687
1688 def test_level(self):
1689 LEVEL1 = 32
1690 LEVEL2 = 37
1691
1692 logger = multiprocessing.get_logger()
1693 root_logger = logging.getLogger()
1694 root_level = root_logger.level
1695
1696 reader, writer = multiprocessing.Pipe(duplex=False)
1697
1698 logger.setLevel(LEVEL1)
1699 self.Process(target=self._test_level, args=(writer,)).start()
1700 self.assertEqual(LEVEL1, reader.recv())
1701
1702 logger.setLevel(logging.NOTSET)
1703 root_logger.setLevel(LEVEL2)
1704 self.Process(target=self._test_level, args=(writer,)).start()
1705 self.assertEqual(LEVEL2, reader.recv())
1706
1707 root_logger.setLevel(root_level)
1708 logger.setLevel(level=LOG_LEVEL)
1709
1710#
Jesse Nollere6bab482009-03-30 16:11:16 +00001711# Test to verify handle verification, see issue 3321
1712#
1713
1714class TestInvalidHandle(unittest.TestCase):
1715
1716 def test_invalid_handles(self):
1717 if WIN32:
1718 return
1719 conn = _multiprocessing.Connection(44977608)
1720 self.assertRaises(IOError, conn.poll)
1721 self.assertRaises(IOError, _multiprocessing.Connection, -1)
1722#
Benjamin Petersondfd79492008-06-13 19:13:39 +00001723# Functions used to create test cases from the base ones in this module
1724#
1725
1726def get_attributes(Source, names):
1727 d = {}
1728 for name in names:
1729 obj = getattr(Source, name)
1730 if type(obj) == type(get_attributes):
1731 obj = staticmethod(obj)
1732 d[name] = obj
1733 return d
1734
1735def create_test_cases(Mixin, type):
1736 result = {}
1737 glob = globals()
1738 Type = type[0].upper() + type[1:]
1739
1740 for name in glob.keys():
1741 if name.startswith('_Test'):
1742 base = glob[name]
1743 if type in base.ALLOWED_TYPES:
1744 newname = 'With' + Type + name[1:]
1745 class Temp(base, unittest.TestCase, Mixin):
1746 pass
1747 result[newname] = Temp
1748 Temp.__name__ = newname
1749 Temp.__module__ = Mixin.__module__
1750 return result
1751
1752#
1753# Create test cases
1754#
1755
1756class ProcessesMixin(object):
1757 TYPE = 'processes'
1758 Process = multiprocessing.Process
1759 locals().update(get_attributes(multiprocessing, (
1760 'Queue', 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore',
1761 'Condition', 'Event', 'Value', 'Array', 'RawValue',
1762 'RawArray', 'current_process', 'active_children', 'Pipe',
1763 'connection', 'JoinableQueue'
1764 )))
1765
1766testcases_processes = create_test_cases(ProcessesMixin, type='processes')
1767globals().update(testcases_processes)
1768
1769
1770class ManagerMixin(object):
1771 TYPE = 'manager'
1772 Process = multiprocessing.Process
1773 manager = object.__new__(multiprocessing.managers.SyncManager)
1774 locals().update(get_attributes(manager, (
1775 'Queue', 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore',
1776 'Condition', 'Event', 'Value', 'Array', 'list', 'dict',
1777 'Namespace', 'JoinableQueue'
1778 )))
1779
1780testcases_manager = create_test_cases(ManagerMixin, type='manager')
1781globals().update(testcases_manager)
1782
1783
1784class ThreadsMixin(object):
1785 TYPE = 'threads'
1786 Process = multiprocessing.dummy.Process
1787 locals().update(get_attributes(multiprocessing.dummy, (
1788 'Queue', 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore',
1789 'Condition', 'Event', 'Value', 'Array', 'current_process',
1790 'active_children', 'Pipe', 'connection', 'dict', 'list',
1791 'Namespace', 'JoinableQueue'
1792 )))
1793
1794testcases_threads = create_test_cases(ThreadsMixin, type='threads')
1795globals().update(testcases_threads)
1796
Neal Norwitz0c519b32008-08-25 01:50:24 +00001797class OtherTest(unittest.TestCase):
1798 # TODO: add more tests for deliver/answer challenge.
1799 def test_deliver_challenge_auth_failure(self):
1800 class _FakeConnection(object):
1801 def recv_bytes(self, size):
Neal Norwitz2a7767a2008-08-25 03:03:25 +00001802 return b'something bogus'
Neal Norwitz0c519b32008-08-25 01:50:24 +00001803 def send_bytes(self, data):
1804 pass
1805 self.assertRaises(multiprocessing.AuthenticationError,
1806 multiprocessing.connection.deliver_challenge,
1807 _FakeConnection(), b'abc')
1808
1809 def test_answer_challenge_auth_failure(self):
1810 class _FakeConnection(object):
1811 def __init__(self):
1812 self.count = 0
1813 def recv_bytes(self, size):
1814 self.count += 1
1815 if self.count == 1:
1816 return multiprocessing.connection.CHALLENGE
1817 elif self.count == 2:
Neal Norwitz2a7767a2008-08-25 03:03:25 +00001818 return b'something bogus'
1819 return b''
Neal Norwitz0c519b32008-08-25 01:50:24 +00001820 def send_bytes(self, data):
1821 pass
1822 self.assertRaises(multiprocessing.AuthenticationError,
1823 multiprocessing.connection.answer_challenge,
1824 _FakeConnection(), b'abc')
1825
Jesse Nollere6bab482009-03-30 16:11:16 +00001826testcases_other = [OtherTest, TestInvalidHandle]
Neal Norwitz0c519b32008-08-25 01:50:24 +00001827
Benjamin Petersondfd79492008-06-13 19:13:39 +00001828#
1829#
1830#
1831
1832def test_main(run=None):
Jesse Noller18623822008-06-18 13:29:52 +00001833 if sys.platform.startswith("linux"):
1834 try:
1835 lock = multiprocessing.RLock()
1836 except OSError:
1837 from test.test_support import TestSkipped
1838 raise TestSkipped("OSError raises on RLock creation, see issue 3111!")
Benjamin Petersoned77f2e2008-06-17 22:40:44 +00001839
Benjamin Petersondfd79492008-06-13 19:13:39 +00001840 if run is None:
1841 from test.test_support import run_unittest as run
1842
1843 util.get_temp_dir() # creates temp directory for use by all processes
1844
1845 multiprocessing.get_logger().setLevel(LOG_LEVEL)
1846
Jesse Noller146b7ab2008-07-02 16:44:09 +00001847 ProcessesMixin.pool = multiprocessing.Pool(4)
1848 ThreadsMixin.pool = multiprocessing.dummy.Pool(4)
1849 ManagerMixin.manager.__init__()
1850 ManagerMixin.manager.start()
1851 ManagerMixin.pool = ManagerMixin.manager.Pool(4)
Benjamin Petersondfd79492008-06-13 19:13:39 +00001852
1853 testcases = (
Jesse Noller146b7ab2008-07-02 16:44:09 +00001854 sorted(testcases_processes.values(), key=lambda tc:tc.__name__) +
1855 sorted(testcases_threads.values(), key=lambda tc:tc.__name__) +
Neal Norwitz0c519b32008-08-25 01:50:24 +00001856 sorted(testcases_manager.values(), key=lambda tc:tc.__name__) +
1857 testcases_other
Benjamin Petersondfd79492008-06-13 19:13:39 +00001858 )
1859
1860 loadTestsFromTestCase = unittest.defaultTestLoader.loadTestsFromTestCase
1861 suite = unittest.TestSuite(loadTestsFromTestCase(tc) for tc in testcases)
1862 run(suite)
1863
Jesse Noller146b7ab2008-07-02 16:44:09 +00001864 ThreadsMixin.pool.terminate()
1865 ProcessesMixin.pool.terminate()
1866 ManagerMixin.pool.terminate()
1867 ManagerMixin.manager.shutdown()
Benjamin Petersondfd79492008-06-13 19:13:39 +00001868
Jesse Noller146b7ab2008-07-02 16:44:09 +00001869 del ProcessesMixin.pool, ThreadsMixin.pool, ManagerMixin.pool
Benjamin Petersondfd79492008-06-13 19:13:39 +00001870
1871def main():
1872 test_main(unittest.TextTestRunner(verbosity=2).run)
1873
1874if __name__ == '__main__':
1875 main()