test_runner.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. import io
  2. import os
  3. import sys
  4. import pickle
  5. import subprocess
  6. import unittest
  7. from unittest.case import _Outcome
  8. from unittest.test.support import (LoggingResult,
  9. ResultWithNoStartTestRunStopTestRun)
  10. class TestCleanUp(unittest.TestCase):
  11. def testCleanUp(self):
  12. class TestableTest(unittest.TestCase):
  13. def testNothing(self):
  14. pass
  15. test = TestableTest('testNothing')
  16. self.assertEqual(test._cleanups, [])
  17. cleanups = []
  18. def cleanup1(*args, **kwargs):
  19. cleanups.append((1, args, kwargs))
  20. def cleanup2(*args, **kwargs):
  21. cleanups.append((2, args, kwargs))
  22. test.addCleanup(cleanup1, 1, 2, 3, four='hello', five='goodbye')
  23. test.addCleanup(cleanup2)
  24. self.assertEqual(test._cleanups,
  25. [(cleanup1, (1, 2, 3), dict(four='hello', five='goodbye')),
  26. (cleanup2, (), {})])
  27. self.assertTrue(test.doCleanups())
  28. self.assertEqual(cleanups, [(2, (), {}), (1, (1, 2, 3), dict(four='hello', five='goodbye'))])
  29. def testCleanUpWithErrors(self):
  30. class TestableTest(unittest.TestCase):
  31. def testNothing(self):
  32. pass
  33. test = TestableTest('testNothing')
  34. outcome = test._outcome = _Outcome()
  35. exc1 = Exception('foo')
  36. exc2 = Exception('bar')
  37. def cleanup1():
  38. raise exc1
  39. def cleanup2():
  40. raise exc2
  41. test.addCleanup(cleanup1)
  42. test.addCleanup(cleanup2)
  43. self.assertFalse(test.doCleanups())
  44. self.assertFalse(outcome.success)
  45. ((_, (Type1, instance1, _)),
  46. (_, (Type2, instance2, _))) = reversed(outcome.errors)
  47. self.assertEqual((Type1, instance1), (Exception, exc1))
  48. self.assertEqual((Type2, instance2), (Exception, exc2))
  49. def testCleanupInRun(self):
  50. blowUp = False
  51. ordering = []
  52. class TestableTest(unittest.TestCase):
  53. def setUp(self):
  54. ordering.append('setUp')
  55. if blowUp:
  56. raise Exception('foo')
  57. def testNothing(self):
  58. ordering.append('test')
  59. def tearDown(self):
  60. ordering.append('tearDown')
  61. test = TestableTest('testNothing')
  62. def cleanup1():
  63. ordering.append('cleanup1')
  64. def cleanup2():
  65. ordering.append('cleanup2')
  66. test.addCleanup(cleanup1)
  67. test.addCleanup(cleanup2)
  68. def success(some_test):
  69. self.assertEqual(some_test, test)
  70. ordering.append('success')
  71. result = unittest.TestResult()
  72. result.addSuccess = success
  73. test.run(result)
  74. self.assertEqual(ordering, ['setUp', 'test', 'tearDown',
  75. 'cleanup2', 'cleanup1', 'success'])
  76. blowUp = True
  77. ordering = []
  78. test = TestableTest('testNothing')
  79. test.addCleanup(cleanup1)
  80. test.run(result)
  81. self.assertEqual(ordering, ['setUp', 'cleanup1'])
  82. def testTestCaseDebugExecutesCleanups(self):
  83. ordering = []
  84. class TestableTest(unittest.TestCase):
  85. def setUp(self):
  86. ordering.append('setUp')
  87. self.addCleanup(cleanup1)
  88. def testNothing(self):
  89. ordering.append('test')
  90. def tearDown(self):
  91. ordering.append('tearDown')
  92. test = TestableTest('testNothing')
  93. def cleanup1():
  94. ordering.append('cleanup1')
  95. test.addCleanup(cleanup2)
  96. def cleanup2():
  97. ordering.append('cleanup2')
  98. test.debug()
  99. self.assertEqual(ordering, ['setUp', 'test', 'tearDown', 'cleanup1', 'cleanup2'])
  100. class Test_TextTestRunner(unittest.TestCase):
  101. """Tests for TextTestRunner."""
  102. def setUp(self):
  103. # clean the environment from pre-existing PYTHONWARNINGS to make
  104. # test_warnings results consistent
  105. self.pythonwarnings = os.environ.get('PYTHONWARNINGS')
  106. if self.pythonwarnings:
  107. del os.environ['PYTHONWARNINGS']
  108. def tearDown(self):
  109. # bring back pre-existing PYTHONWARNINGS if present
  110. if self.pythonwarnings:
  111. os.environ['PYTHONWARNINGS'] = self.pythonwarnings
  112. def test_init(self):
  113. runner = unittest.TextTestRunner()
  114. self.assertFalse(runner.failfast)
  115. self.assertFalse(runner.buffer)
  116. self.assertEqual(runner.verbosity, 1)
  117. self.assertEqual(runner.warnings, None)
  118. self.assertTrue(runner.descriptions)
  119. self.assertEqual(runner.resultclass, unittest.TextTestResult)
  120. self.assertFalse(runner.tb_locals)
  121. def test_multiple_inheritance(self):
  122. class AResult(unittest.TestResult):
  123. def __init__(self, stream, descriptions, verbosity):
  124. super(AResult, self).__init__(stream, descriptions, verbosity)
  125. class ATextResult(unittest.TextTestResult, AResult):
  126. pass
  127. # This used to raise an exception due to TextTestResult not passing
  128. # on arguments in its __init__ super call
  129. ATextResult(None, None, 1)
  130. def testBufferAndFailfast(self):
  131. class Test(unittest.TestCase):
  132. def testFoo(self):
  133. pass
  134. result = unittest.TestResult()
  135. runner = unittest.TextTestRunner(stream=io.StringIO(), failfast=True,
  136. buffer=True)
  137. # Use our result object
  138. runner._makeResult = lambda: result
  139. runner.run(Test('testFoo'))
  140. self.assertTrue(result.failfast)
  141. self.assertTrue(result.buffer)
  142. def test_locals(self):
  143. runner = unittest.TextTestRunner(stream=io.StringIO(), tb_locals=True)
  144. result = runner.run(unittest.TestSuite())
  145. self.assertEqual(True, result.tb_locals)
  146. def testRunnerRegistersResult(self):
  147. class Test(unittest.TestCase):
  148. def testFoo(self):
  149. pass
  150. originalRegisterResult = unittest.runner.registerResult
  151. def cleanup():
  152. unittest.runner.registerResult = originalRegisterResult
  153. self.addCleanup(cleanup)
  154. result = unittest.TestResult()
  155. runner = unittest.TextTestRunner(stream=io.StringIO())
  156. # Use our result object
  157. runner._makeResult = lambda: result
  158. self.wasRegistered = 0
  159. def fakeRegisterResult(thisResult):
  160. self.wasRegistered += 1
  161. self.assertEqual(thisResult, result)
  162. unittest.runner.registerResult = fakeRegisterResult
  163. runner.run(unittest.TestSuite())
  164. self.assertEqual(self.wasRegistered, 1)
  165. def test_works_with_result_without_startTestRun_stopTestRun(self):
  166. class OldTextResult(ResultWithNoStartTestRunStopTestRun):
  167. separator2 = ''
  168. def printErrors(self):
  169. pass
  170. class Runner(unittest.TextTestRunner):
  171. def __init__(self):
  172. super(Runner, self).__init__(io.StringIO())
  173. def _makeResult(self):
  174. return OldTextResult()
  175. runner = Runner()
  176. runner.run(unittest.TestSuite())
  177. def test_startTestRun_stopTestRun_called(self):
  178. class LoggingTextResult(LoggingResult):
  179. separator2 = ''
  180. def printErrors(self):
  181. pass
  182. class LoggingRunner(unittest.TextTestRunner):
  183. def __init__(self, events):
  184. super(LoggingRunner, self).__init__(io.StringIO())
  185. self._events = events
  186. def _makeResult(self):
  187. return LoggingTextResult(self._events)
  188. events = []
  189. runner = LoggingRunner(events)
  190. runner.run(unittest.TestSuite())
  191. expected = ['startTestRun', 'stopTestRun']
  192. self.assertEqual(events, expected)
  193. def test_pickle_unpickle(self):
  194. # Issue #7197: a TextTestRunner should be (un)pickleable. This is
  195. # required by test_multiprocessing under Windows (in verbose mode).
  196. stream = io.StringIO("foo")
  197. runner = unittest.TextTestRunner(stream)
  198. for protocol in range(2, pickle.HIGHEST_PROTOCOL + 1):
  199. s = pickle.dumps(runner, protocol)
  200. obj = pickle.loads(s)
  201. # StringIO objects never compare equal, a cheap test instead.
  202. self.assertEqual(obj.stream.getvalue(), stream.getvalue())
  203. def test_resultclass(self):
  204. def MockResultClass(*args):
  205. return args
  206. STREAM = object()
  207. DESCRIPTIONS = object()
  208. VERBOSITY = object()
  209. runner = unittest.TextTestRunner(STREAM, DESCRIPTIONS, VERBOSITY,
  210. resultclass=MockResultClass)
  211. self.assertEqual(runner.resultclass, MockResultClass)
  212. expectedresult = (runner.stream, DESCRIPTIONS, VERBOSITY)
  213. self.assertEqual(runner._makeResult(), expectedresult)
  214. def test_warnings(self):
  215. """
  216. Check that warnings argument of TextTestRunner correctly affects the
  217. behavior of the warnings.
  218. """
  219. # see #10535 and the _test_warnings file for more information
  220. def get_parse_out_err(p):
  221. return [b.splitlines() for b in p.communicate()]
  222. opts = dict(stdout=subprocess.PIPE, stderr=subprocess.PIPE,
  223. cwd=os.path.dirname(__file__))
  224. ae_msg = b'Please use assertEqual instead.'
  225. at_msg = b'Please use assertTrue instead.'
  226. # no args -> all the warnings are printed, unittest warnings only once
  227. p = subprocess.Popen([sys.executable, '_test_warnings.py'], **opts)
  228. with p:
  229. out, err = get_parse_out_err(p)
  230. self.assertIn(b'OK', err)
  231. # check that the total number of warnings in the output is correct
  232. self.assertEqual(len(out), 12)
  233. # check that the numbers of the different kind of warnings is correct
  234. for msg in [b'dw', b'iw', b'uw']:
  235. self.assertEqual(out.count(msg), 3)
  236. for msg in [ae_msg, at_msg, b'rw']:
  237. self.assertEqual(out.count(msg), 1)
  238. args_list = (
  239. # passing 'ignore' as warnings arg -> no warnings
  240. [sys.executable, '_test_warnings.py', 'ignore'],
  241. # -W doesn't affect the result if the arg is passed
  242. [sys.executable, '-Wa', '_test_warnings.py', 'ignore'],
  243. # -W affects the result if the arg is not passed
  244. [sys.executable, '-Wi', '_test_warnings.py']
  245. )
  246. # in all these cases no warnings are printed
  247. for args in args_list:
  248. p = subprocess.Popen(args, **opts)
  249. with p:
  250. out, err = get_parse_out_err(p)
  251. self.assertIn(b'OK', err)
  252. self.assertEqual(len(out), 0)
  253. # passing 'always' as warnings arg -> all the warnings printed,
  254. # unittest warnings only once
  255. p = subprocess.Popen([sys.executable, '_test_warnings.py', 'always'],
  256. **opts)
  257. with p:
  258. out, err = get_parse_out_err(p)
  259. self.assertIn(b'OK', err)
  260. self.assertEqual(len(out), 14)
  261. for msg in [b'dw', b'iw', b'uw', b'rw']:
  262. self.assertEqual(out.count(msg), 3)
  263. for msg in [ae_msg, at_msg]:
  264. self.assertEqual(out.count(msg), 1)
  265. def testStdErrLookedUpAtInstantiationTime(self):
  266. # see issue 10786
  267. old_stderr = sys.stderr
  268. f = io.StringIO()
  269. sys.stderr = f
  270. try:
  271. runner = unittest.TextTestRunner()
  272. self.assertTrue(runner.stream.stream is f)
  273. finally:
  274. sys.stderr = old_stderr
  275. def testSpecifiedStreamUsed(self):
  276. # see issue 10786
  277. f = io.StringIO()
  278. runner = unittest.TextTestRunner(f)
  279. self.assertTrue(runner.stream.stream is f)
  280. if __name__ == "__main__":
  281. unittest.main()