Debian Codegraph @

Lib/test/test_unittest/test_async_case.py

raw
1 import asyncio
2 import contextvars
3 import unittest
4 from test import support
5 from test.support import force_not_colorized
6
7 support.requires_working_socket(module=True)
8
9
10 class MyException(Exception):
11 pass
12
13
14 def tearDownModule():
15 asyncio.events._set_event_loop_policy(None)
16
17
18 class TestCM:
19 def __init__(self, ordering, enter_result=None):
20 self.ordering = ordering
21 self.enter_result = enter_result
22
23 async def __aenter__(self):
24 self.ordering.append('enter')
25 return self.enter_result
26
27 async def __aexit__(self, *exc_info):
28 self.ordering.append('exit')
29
30
31 class LacksEnterAndExit:
32 pass
33 class LacksEnter:
34 async def __aexit__(self, *exc_info):
35 pass
36 class LacksExit:
37 async def __aenter__(self):
38 pass
39
40
41 VAR = contextvars.ContextVar('VAR', default=())
42
43
44 class TestAsyncCase(unittest.TestCase):
45 maxDiff = None
46
47 def setUp(self):
48 # Ensure that IsolatedAsyncioTestCase instances are destroyed before
49 # starting a new event loop
50 self.addCleanup(support.gc_collect)
51
52 def test_full_cycle(self):
53 expected = ['setUp',
54 'asyncSetUp',
55 'test',
56 'asyncTearDown',
57 'tearDown',
58 'cleanup6',
59 'cleanup5',
60 'cleanup4',
61 'cleanup3',
62 'cleanup2',
63 'cleanup1']
64 class Test(unittest.IsolatedAsyncioTestCase):
65 def setUp(self):
66 self.assertEqual(events, [])
67 events.append('setUp')
68 VAR.set(VAR.get() + ('setUp',))
69 self.addCleanup(self.on_cleanup1)
70 self.addAsyncCleanup(self.on_cleanup2)
71
72 async def asyncSetUp(self):
73 self.assertEqual(events, expected[:1])
74 events.append('asyncSetUp')
75 VAR.set(VAR.get() + ('asyncSetUp',))
76 self.addCleanup(self.on_cleanup3)
77 self.addAsyncCleanup(self.on_cleanup4)
78
79 async def test_func(self):
80 self.assertEqual(events, expected[:2])
81 events.append('test')
82 VAR.set(VAR.get() + ('test',))
83 self.addCleanup(self.on_cleanup5)
84 self.addAsyncCleanup(self.on_cleanup6)
85
86 async def asyncTearDown(self):
87 self.assertEqual(events, expected[:3])
88 VAR.set(VAR.get() + ('asyncTearDown',))
89 events.append('asyncTearDown')
90
91 def tearDown(self):
92 self.assertEqual(events, expected[:4])
93 events.append('tearDown')
94 VAR.set(VAR.get() + ('tearDown',))
95
96 def on_cleanup1(self):
97 self.assertEqual(events, expected[:10])
98 events.append('cleanup1')
99 VAR.set(VAR.get() + ('cleanup1',))
100 nonlocal cvar
101 cvar = VAR.get()
102
103 async def on_cleanup2(self):
104 self.assertEqual(events, expected[:9])
105 events.append('cleanup2')
106 VAR.set(VAR.get() + ('cleanup2',))
107
108 def on_cleanup3(self):
109 self.assertEqual(events, expected[:8])
110 events.append('cleanup3')
111 VAR.set(VAR.get() + ('cleanup3',))
112
113 async def on_cleanup4(self):
114 self.assertEqual(events, expected[:7])
115 events.append('cleanup4')
116 VAR.set(VAR.get() + ('cleanup4',))
117
118 def on_cleanup5(self):
119 self.assertEqual(events, expected[:6])
120 events.append('cleanup5')
121 VAR.set(VAR.get() + ('cleanup5',))
122
123 async def on_cleanup6(self):
124 self.assertEqual(events, expected[:5])
125 events.append('cleanup6')
126 VAR.set(VAR.get() + ('cleanup6',))
127
128 events = []
129 cvar = ()
130 test = Test("test_func")
131 result = test.run()
132 self.assertEqual(result.errors, [])
133 self.assertEqual(result.failures, [])
134 self.assertEqual(events, expected)
135 self.assertEqual(cvar, tuple(expected))
136
137 events = []
138 cvar = ()
139 test = Test("test_func")
140 test.debug()
141 self.assertEqual(events, expected)
142 self.assertEqual(cvar, tuple(expected))
143 test.doCleanups()
144 self.assertEqual(events, expected)
145 self.assertEqual(cvar, tuple(expected))
146
147 def test_exception_in_setup(self):
148 class Test(unittest.IsolatedAsyncioTestCase):
149 async def asyncSetUp(self):
150 events.append('asyncSetUp')
151 self.addAsyncCleanup(self.on_cleanup)
152 raise MyException()
153
154 async def test_func(self):
155 events.append('test')
156
157 async def asyncTearDown(self):
158 events.append('asyncTearDown')
159
160 async def on_cleanup(self):
161 events.append('cleanup')
162
163
164 events = []
165 test = Test("test_func")
166 result = test.run()
167 self.assertEqual(events, ['asyncSetUp', 'cleanup'])
168 self.assertIs(result.errors[0][0], test)
169 self.assertIn('MyException', result.errors[0][1])
170
171 events = []
172 test = Test("test_func")
173 self.addCleanup(test._tearDownAsyncioRunner)
174 try:
175 test.debug()
176 except MyException:
177 pass
178 else:
179 self.fail('Expected a MyException exception')
180 self.assertEqual(events, ['asyncSetUp'])
181 test.doCleanups()
182 self.assertEqual(events, ['asyncSetUp', 'cleanup'])
183
184 def test_exception_in_test(self):
185 class Test(unittest.IsolatedAsyncioTestCase):
186 async def asyncSetUp(self):
187 events.append('asyncSetUp')
188
189 async def test_func(self):
190 events.append('test')
191 self.addAsyncCleanup(self.on_cleanup)
192 raise MyException()
193
194 async def asyncTearDown(self):
195 events.append('asyncTearDown')
196
197 async def on_cleanup(self):
198 events.append('cleanup')
199
200 events = []
201 test = Test("test_func")
202 result = test.run()
203 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown', 'cleanup'])
204 self.assertIs(result.errors[0][0], test)
205 self.assertIn('MyException', result.errors[0][1])
206
207 events = []
208 test = Test("test_func")
209 self.addCleanup(test._tearDownAsyncioRunner)
210 try:
211 test.debug()
212 except MyException:
213 pass
214 else:
215 self.fail('Expected a MyException exception')
216 self.assertEqual(events, ['asyncSetUp', 'test'])
217 test.doCleanups()
218 self.assertEqual(events, ['asyncSetUp', 'test', 'cleanup'])
219
220 def test_exception_in_tear_down(self):
221 class Test(unittest.IsolatedAsyncioTestCase):
222 async def asyncSetUp(self):
223 events.append('asyncSetUp')
224
225 async def test_func(self):
226 events.append('test')
227 self.addAsyncCleanup(self.on_cleanup)
228
229 async def asyncTearDown(self):
230 events.append('asyncTearDown')
231 raise MyException()
232
233 async def on_cleanup(self):
234 events.append('cleanup')
235
236 events = []
237 test = Test("test_func")
238 result = test.run()
239 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown', 'cleanup'])
240 self.assertIs(result.errors[0][0], test)
241 self.assertIn('MyException', result.errors[0][1])
242
243 events = []
244 test = Test("test_func")
245 self.addCleanup(test._tearDownAsyncioRunner)
246 try:
247 test.debug()
248 except MyException:
249 pass
250 else:
251 self.fail('Expected a MyException exception')
252 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown'])
253 test.doCleanups()
254 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown', 'cleanup'])
255
256 @force_not_colorized
257 def test_exception_in_tear_clean_up(self):
258 class Test(unittest.IsolatedAsyncioTestCase):
259 async def asyncSetUp(self):
260 events.append('asyncSetUp')
261
262 async def test_func(self):
263 events.append('test')
264 self.addAsyncCleanup(self.on_cleanup1)
265 self.addAsyncCleanup(self.on_cleanup2)
266
267 async def asyncTearDown(self):
268 events.append('asyncTearDown')
269
270 async def on_cleanup1(self):
271 events.append('cleanup1')
272 raise MyException('some error')
273
274 async def on_cleanup2(self):
275 events.append('cleanup2')
276 raise MyException('other error')
277
278 events = []
279 test = Test("test_func")
280 result = test.run()
281 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown', 'cleanup2', 'cleanup1'])
282 self.assertIs(result.errors[0][0], test)
283 self.assertIn('MyException: other error', result.errors[0][1])
284 self.assertIn('MyException: some error', result.errors[1][1])
285
286 events = []
287 test = Test("test_func")
288 self.addCleanup(test._tearDownAsyncioRunner)
289 try:
290 test.debug()
291 except MyException:
292 pass
293 else:
294 self.fail('Expected a MyException exception')
295 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown', 'cleanup2'])
296 test.doCleanups()
297 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown', 'cleanup2', 'cleanup1'])
298
299 def test_deprecation_of_return_val_from_test(self):
300 # Issue 41322 - deprecate return of value that is not None from a test
301 class Nothing:
302 def __eq__(self, o):
303 return o is None
304 class Test(unittest.IsolatedAsyncioTestCase):
305 async def test1(self):
306 return 1
307 async def test2(self):
308 yield 1
309 async def test3(self):
310 return Nothing()
311
312 with self.assertWarns(DeprecationWarning) as w:
313 Test('test1').run()
314 self.assertIn('It is deprecated to return a value that is not None', str(w.warning))
315 self.assertIn('test1', str(w.warning))
316 self.assertEqual(w.filename, __file__)
317 self.assertIn("returned 'int'", str(w.warning))
318
319 with self.assertWarns(DeprecationWarning) as w:
320 Test('test2').run()
321 self.assertIn('It is deprecated to return a value that is not None', str(w.warning))
322 self.assertIn('test2', str(w.warning))
323 self.assertEqual(w.filename, __file__)
324 self.assertIn("returned 'async_generator'", str(w.warning))
325
326 with self.assertWarns(DeprecationWarning) as w:
327 Test('test3').run()
328 self.assertIn('It is deprecated to return a value that is not None', str(w.warning))
329 self.assertIn('test3', str(w.warning))
330 self.assertEqual(w.filename, __file__)
331 self.assertIn(f'returned {Nothing.__name__!r}', str(w.warning))
332
333 def test_cleanups_interleave_order(self):
334 events = []
335
336 class Test(unittest.IsolatedAsyncioTestCase):
337 async def test_func(self):
338 self.addAsyncCleanup(self.on_sync_cleanup, 1)
339 self.addAsyncCleanup(self.on_async_cleanup, 2)
340 self.addAsyncCleanup(self.on_sync_cleanup, 3)
341 self.addAsyncCleanup(self.on_async_cleanup, 4)
342
343 async def on_sync_cleanup(self, val):
344 events.append(f'sync_cleanup {val}')
345
346 async def on_async_cleanup(self, val):
347 events.append(f'async_cleanup {val}')
348
349 test = Test("test_func")
350 test.run()
351 self.assertEqual(events, ['async_cleanup 4',
352 'sync_cleanup 3',
353 'async_cleanup 2',
354 'sync_cleanup 1'])
355
356 def test_base_exception_from_async_method(self):
357 events = []
358 class Test(unittest.IsolatedAsyncioTestCase):
359 async def test_base(self):
360 events.append("test_base")
361 raise BaseException()
362 events.append("not it")
363
364 async def test_no_err(self):
365 events.append("test_no_err")
366
367 async def test_cancel(self):
368 raise asyncio.CancelledError()
369
370 test = Test("test_base")
371 output = test.run()
372 self.assertFalse(output.wasSuccessful())
373
374 test = Test("test_no_err")
375 test.run()
376 self.assertEqual(events, ['test_base', 'test_no_err'])
377
378 test = Test("test_cancel")
379 output = test.run()
380 self.assertFalse(output.wasSuccessful())
381
382 def test_cancellation_hanging_tasks(self):
383 cancelled = False
384 class Test(unittest.IsolatedAsyncioTestCase):
385 async def test_leaking_task(self):
386 async def coro():
387 nonlocal cancelled
388 try:
389 await asyncio.sleep(1)
390 except asyncio.CancelledError:
391 cancelled = True
392 raise
393
394 # Leave this running in the background
395 asyncio.create_task(coro())
396
397 test = Test("test_leaking_task")
398 output = test.run()
399 self.assertTrue(cancelled)
400
401 def test_enterAsyncContext(self):
402 events = []
403
404 class Test(unittest.IsolatedAsyncioTestCase):
405 async def test_func(slf):
406 slf.addAsyncCleanup(events.append, 'cleanup1')
407 cm = TestCM(events, 42)
408 self.assertEqual(await slf.enterAsyncContext(cm), 42)
409 slf.addAsyncCleanup(events.append, 'cleanup2')
410 events.append('test')
411
412 test = Test('test_func')
413 output = test.run()
414 self.assertTrue(output.wasSuccessful(), output)
415 self.assertEqual(events, ['enter', 'test', 'cleanup2', 'exit', 'cleanup1'])
416
417 def test_enterAsyncContext_arg_errors(self):
418 class Test(unittest.IsolatedAsyncioTestCase):
419 async def test_func(slf):
420 with self.assertRaisesRegex(TypeError, 'asynchronous context manager'):
421 await slf.enterAsyncContext(LacksEnterAndExit())
422 with self.assertRaisesRegex(TypeError, 'asynchronous context manager'):
423 await slf.enterAsyncContext(LacksEnter())
424 with self.assertRaisesRegex(TypeError, 'asynchronous context manager'):
425 await slf.enterAsyncContext(LacksExit())
426
427 test = Test('test_func')
428 output = test.run()
429 self.assertTrue(output.wasSuccessful())
430
431 def test_debug_cleanup_same_loop(self):
432 class Test(unittest.IsolatedAsyncioTestCase):
433 async def asyncSetUp(self):
434 async def coro():
435 await asyncio.sleep(0)
436 fut = asyncio.ensure_future(coro())
437 self.addAsyncCleanup(self.cleanup, fut)
438 events.append('asyncSetUp')
439
440 async def test_func(self):
441 events.append('test')
442 raise MyException()
443
444 async def asyncTearDown(self):
445 events.append('asyncTearDown')
446
447 async def cleanup(self, fut):
448 try:
449 # Raises an exception if in different loop
450 await asyncio.wait([fut])
451 events.append('cleanup')
452 except:
453 import traceback
454 traceback.print_exc()
455 raise
456
457 events = []
458 test = Test("test_func")
459 result = test.run()
460 self.assertEqual(events, ['asyncSetUp', 'test', 'asyncTearDown', 'cleanup'])
461 self.assertIn('MyException', result.errors[0][1])
462
463 events = []
464 test = Test("test_func")
465 self.addCleanup(test._tearDownAsyncioRunner)
466 try:
467 test.debug()
468 except MyException:
469 pass
470 else:
471 self.fail('Expected a MyException exception')
472 self.assertEqual(events, ['asyncSetUp', 'test'])
473 test.doCleanups()
474 self.assertEqual(events, ['asyncSetUp', 'test', 'cleanup'])
475
476 def test_setup_get_event_loop(self):
477 # See https://github.com/python/cpython/issues/95736
478 # Make sure the default event loop is not used
479 asyncio.set_event_loop(None)
480
481 class TestCase1(unittest.IsolatedAsyncioTestCase):
482 def setUp(self):
483 asyncio.events._get_event_loop_policy().get_event_loop()
484
485 async def test_demo1(self):
486 pass
487
488 test = TestCase1('test_demo1')
489 result = test.run()
490 self.assertTrue(result.wasSuccessful())
491
492 def test_loop_factory(self):
493 asyncio.events._set_event_loop_policy(None)
494
495 class TestCase1(unittest.IsolatedAsyncioTestCase):
496 loop_factory = asyncio.EventLoop
497
498 async def test_demo1(self):
499 pass
500
501 test = TestCase1('test_demo1')
502 result = test.run()
503 self.assertTrue(result.wasSuccessful())
504 self.assertIsNone(support.maybe_get_event_loop_policy())
505
506 if __name__ == "__main__":
507 unittest.main()