test_result.py 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567
  1. import sys
  2. import textwrap
  3. from StringIO import StringIO
  4. from test import test_support
  5. import traceback
  6. import unittest
  7. class Test_TestResult(unittest.TestCase):
  8. # Note: there are not separate tests for TestResult.wasSuccessful(),
  9. # TestResult.errors, TestResult.failures, TestResult.testsRun or
  10. # TestResult.shouldStop because these only have meaning in terms of
  11. # other TestResult methods.
  12. #
  13. # Accordingly, tests for the aforenamed attributes are incorporated
  14. # in with the tests for the defining methods.
  15. ################################################################
  16. def test_init(self):
  17. result = unittest.TestResult()
  18. self.assertTrue(result.wasSuccessful())
  19. self.assertEqual(len(result.errors), 0)
  20. self.assertEqual(len(result.failures), 0)
  21. self.assertEqual(result.testsRun, 0)
  22. self.assertEqual(result.shouldStop, False)
  23. self.assertIsNone(result._stdout_buffer)
  24. self.assertIsNone(result._stderr_buffer)
  25. # "This method can be called to signal that the set of tests being
  26. # run should be aborted by setting the TestResult's shouldStop
  27. # attribute to True."
  28. def test_stop(self):
  29. result = unittest.TestResult()
  30. result.stop()
  31. self.assertEqual(result.shouldStop, True)
  32. # "Called when the test case test is about to be run. The default
  33. # implementation simply increments the instance's testsRun counter."
  34. def test_startTest(self):
  35. class Foo(unittest.TestCase):
  36. def test_1(self):
  37. pass
  38. test = Foo('test_1')
  39. result = unittest.TestResult()
  40. result.startTest(test)
  41. self.assertTrue(result.wasSuccessful())
  42. self.assertEqual(len(result.errors), 0)
  43. self.assertEqual(len(result.failures), 0)
  44. self.assertEqual(result.testsRun, 1)
  45. self.assertEqual(result.shouldStop, False)
  46. result.stopTest(test)
  47. # "Called after the test case test has been executed, regardless of
  48. # the outcome. The default implementation does nothing."
  49. def test_stopTest(self):
  50. class Foo(unittest.TestCase):
  51. def test_1(self):
  52. pass
  53. test = Foo('test_1')
  54. result = unittest.TestResult()
  55. result.startTest(test)
  56. self.assertTrue(result.wasSuccessful())
  57. self.assertEqual(len(result.errors), 0)
  58. self.assertEqual(len(result.failures), 0)
  59. self.assertEqual(result.testsRun, 1)
  60. self.assertEqual(result.shouldStop, False)
  61. result.stopTest(test)
  62. # Same tests as above; make sure nothing has changed
  63. self.assertTrue(result.wasSuccessful())
  64. self.assertEqual(len(result.errors), 0)
  65. self.assertEqual(len(result.failures), 0)
  66. self.assertEqual(result.testsRun, 1)
  67. self.assertEqual(result.shouldStop, False)
  68. # "Called before and after tests are run. The default implementation does nothing."
  69. def test_startTestRun_stopTestRun(self):
  70. result = unittest.TestResult()
  71. result.startTestRun()
  72. result.stopTestRun()
  73. # "addSuccess(test)"
  74. # ...
  75. # "Called when the test case test succeeds"
  76. # ...
  77. # "wasSuccessful() - Returns True if all tests run so far have passed,
  78. # otherwise returns False"
  79. # ...
  80. # "testsRun - The total number of tests run so far."
  81. # ...
  82. # "errors - A list containing 2-tuples of TestCase instances and
  83. # formatted tracebacks. Each tuple represents a test which raised an
  84. # unexpected exception. Contains formatted
  85. # tracebacks instead of sys.exc_info() results."
  86. # ...
  87. # "failures - A list containing 2-tuples of TestCase instances and
  88. # formatted tracebacks. Each tuple represents a test where a failure was
  89. # explicitly signalled using the TestCase.fail*() or TestCase.assert*()
  90. # methods. Contains formatted tracebacks instead
  91. # of sys.exc_info() results."
  92. def test_addSuccess(self):
  93. class Foo(unittest.TestCase):
  94. def test_1(self):
  95. pass
  96. test = Foo('test_1')
  97. result = unittest.TestResult()
  98. result.startTest(test)
  99. result.addSuccess(test)
  100. result.stopTest(test)
  101. self.assertTrue(result.wasSuccessful())
  102. self.assertEqual(len(result.errors), 0)
  103. self.assertEqual(len(result.failures), 0)
  104. self.assertEqual(result.testsRun, 1)
  105. self.assertEqual(result.shouldStop, False)
  106. # "addFailure(test, err)"
  107. # ...
  108. # "Called when the test case test signals a failure. err is a tuple of
  109. # the form returned by sys.exc_info(): (type, value, traceback)"
  110. # ...
  111. # "wasSuccessful() - Returns True if all tests run so far have passed,
  112. # otherwise returns False"
  113. # ...
  114. # "testsRun - The total number of tests run so far."
  115. # ...
  116. # "errors - A list containing 2-tuples of TestCase instances and
  117. # formatted tracebacks. Each tuple represents a test which raised an
  118. # unexpected exception. Contains formatted
  119. # tracebacks instead of sys.exc_info() results."
  120. # ...
  121. # "failures - A list containing 2-tuples of TestCase instances and
  122. # formatted tracebacks. Each tuple represents a test where a failure was
  123. # explicitly signalled using the TestCase.fail*() or TestCase.assert*()
  124. # methods. Contains formatted tracebacks instead
  125. # of sys.exc_info() results."
  126. def test_addFailure(self):
  127. class Foo(unittest.TestCase):
  128. def test_1(self):
  129. pass
  130. test = Foo('test_1')
  131. try:
  132. test.fail("foo")
  133. except:
  134. exc_info_tuple = sys.exc_info()
  135. result = unittest.TestResult()
  136. result.startTest(test)
  137. result.addFailure(test, exc_info_tuple)
  138. result.stopTest(test)
  139. self.assertFalse(result.wasSuccessful())
  140. self.assertEqual(len(result.errors), 0)
  141. self.assertEqual(len(result.failures), 1)
  142. self.assertEqual(result.testsRun, 1)
  143. self.assertEqual(result.shouldStop, False)
  144. test_case, formatted_exc = result.failures[0]
  145. self.assertIs(test_case, test)
  146. self.assertIsInstance(formatted_exc, str)
  147. # "addError(test, err)"
  148. # ...
  149. # "Called when the test case test raises an unexpected exception err
  150. # is a tuple of the form returned by sys.exc_info():
  151. # (type, value, traceback)"
  152. # ...
  153. # "wasSuccessful() - Returns True if all tests run so far have passed,
  154. # otherwise returns False"
  155. # ...
  156. # "testsRun - The total number of tests run so far."
  157. # ...
  158. # "errors - A list containing 2-tuples of TestCase instances and
  159. # formatted tracebacks. Each tuple represents a test which raised an
  160. # unexpected exception. Contains formatted
  161. # tracebacks instead of sys.exc_info() results."
  162. # ...
  163. # "failures - A list containing 2-tuples of TestCase instances and
  164. # formatted tracebacks. Each tuple represents a test where a failure was
  165. # explicitly signalled using the TestCase.fail*() or TestCase.assert*()
  166. # methods. Contains formatted tracebacks instead
  167. # of sys.exc_info() results."
  168. def test_addError(self):
  169. class Foo(unittest.TestCase):
  170. def test_1(self):
  171. pass
  172. test = Foo('test_1')
  173. try:
  174. raise TypeError()
  175. except:
  176. exc_info_tuple = sys.exc_info()
  177. result = unittest.TestResult()
  178. result.startTest(test)
  179. result.addError(test, exc_info_tuple)
  180. result.stopTest(test)
  181. self.assertFalse(result.wasSuccessful())
  182. self.assertEqual(len(result.errors), 1)
  183. self.assertEqual(len(result.failures), 0)
  184. self.assertEqual(result.testsRun, 1)
  185. self.assertEqual(result.shouldStop, False)
  186. test_case, formatted_exc = result.errors[0]
  187. self.assertIs(test_case, test)
  188. self.assertIsInstance(formatted_exc, str)
  189. def testGetDescriptionWithoutDocstring(self):
  190. result = unittest.TextTestResult(None, True, 1)
  191. self.assertEqual(
  192. result.getDescription(self),
  193. 'testGetDescriptionWithoutDocstring (' + __name__ +
  194. '.Test_TestResult)')
  195. @unittest.skipIf(sys.flags.optimize >= 2,
  196. "Docstrings are omitted with -O2 and above")
  197. def testGetDescriptionWithOneLineDocstring(self):
  198. """Tests getDescription() for a method with a docstring."""
  199. result = unittest.TextTestResult(None, True, 1)
  200. self.assertEqual(
  201. result.getDescription(self),
  202. ('testGetDescriptionWithOneLineDocstring '
  203. '(' + __name__ + '.Test_TestResult)\n'
  204. 'Tests getDescription() for a method with a docstring.'))
  205. @unittest.skipIf(sys.flags.optimize >= 2,
  206. "Docstrings are omitted with -O2 and above")
  207. def testGetDescriptionWithMultiLineDocstring(self):
  208. """Tests getDescription() for a method with a longer docstring.
  209. The second line of the docstring.
  210. """
  211. result = unittest.TextTestResult(None, True, 1)
  212. self.assertEqual(
  213. result.getDescription(self),
  214. ('testGetDescriptionWithMultiLineDocstring '
  215. '(' + __name__ + '.Test_TestResult)\n'
  216. 'Tests getDescription() for a method with a longer '
  217. 'docstring.'))
  218. def testStackFrameTrimming(self):
  219. class Frame(object):
  220. class tb_frame(object):
  221. f_globals = {}
  222. result = unittest.TestResult()
  223. self.assertFalse(result._is_relevant_tb_level(Frame))
  224. Frame.tb_frame.f_globals['__unittest'] = True
  225. self.assertTrue(result._is_relevant_tb_level(Frame))
  226. def testFailFast(self):
  227. result = unittest.TestResult()
  228. result._exc_info_to_string = lambda *_: ''
  229. result.failfast = True
  230. result.addError(None, None)
  231. self.assertTrue(result.shouldStop)
  232. result = unittest.TestResult()
  233. result._exc_info_to_string = lambda *_: ''
  234. result.failfast = True
  235. result.addFailure(None, None)
  236. self.assertTrue(result.shouldStop)
  237. result = unittest.TestResult()
  238. result._exc_info_to_string = lambda *_: ''
  239. result.failfast = True
  240. result.addUnexpectedSuccess(None)
  241. self.assertTrue(result.shouldStop)
  242. def testFailFastSetByRunner(self):
  243. runner = unittest.TextTestRunner(stream=StringIO(), failfast=True)
  244. def test(result):
  245. self.assertTrue(result.failfast)
  246. runner.run(test)
  247. classDict = dict(unittest.TestResult.__dict__)
  248. for m in ('addSkip', 'addExpectedFailure', 'addUnexpectedSuccess',
  249. '__init__'):
  250. del classDict[m]
  251. def __init__(self, stream=None, descriptions=None, verbosity=None):
  252. self.failures = []
  253. self.errors = []
  254. self.testsRun = 0
  255. self.shouldStop = False
  256. self.buffer = False
  257. classDict['__init__'] = __init__
  258. OldResult = type('OldResult', (object,), classDict)
  259. class Test_OldTestResult(unittest.TestCase):
  260. def assertOldResultWarning(self, test, failures):
  261. with test_support.check_warnings(("TestResult has no add.+ method,",
  262. RuntimeWarning)):
  263. result = OldResult()
  264. test.run(result)
  265. self.assertEqual(len(result.failures), failures)
  266. def testOldTestResult(self):
  267. class Test(unittest.TestCase):
  268. def testSkip(self):
  269. self.skipTest('foobar')
  270. @unittest.expectedFailure
  271. def testExpectedFail(self):
  272. raise TypeError
  273. @unittest.expectedFailure
  274. def testUnexpectedSuccess(self):
  275. pass
  276. for test_name, should_pass in (('testSkip', True),
  277. ('testExpectedFail', True),
  278. ('testUnexpectedSuccess', False)):
  279. test = Test(test_name)
  280. self.assertOldResultWarning(test, int(not should_pass))
  281. def testOldTestTesultSetup(self):
  282. class Test(unittest.TestCase):
  283. def setUp(self):
  284. self.skipTest('no reason')
  285. def testFoo(self):
  286. pass
  287. self.assertOldResultWarning(Test('testFoo'), 0)
  288. def testOldTestResultClass(self):
  289. @unittest.skip('no reason')
  290. class Test(unittest.TestCase):
  291. def testFoo(self):
  292. pass
  293. self.assertOldResultWarning(Test('testFoo'), 0)
  294. def testOldResultWithRunner(self):
  295. class Test(unittest.TestCase):
  296. def testFoo(self):
  297. pass
  298. runner = unittest.TextTestRunner(resultclass=OldResult,
  299. stream=StringIO())
  300. # This will raise an exception if TextTestRunner can't handle old
  301. # test result objects
  302. runner.run(Test('testFoo'))
  303. class MockTraceback(object):
  304. @staticmethod
  305. def format_exception(*_):
  306. return ['A traceback']
  307. def restore_traceback():
  308. unittest.result.traceback = traceback
  309. class TestOutputBuffering(unittest.TestCase):
  310. def setUp(self):
  311. self._real_out = sys.stdout
  312. self._real_err = sys.stderr
  313. def tearDown(self):
  314. sys.stdout = self._real_out
  315. sys.stderr = self._real_err
  316. def testBufferOutputOff(self):
  317. real_out = self._real_out
  318. real_err = self._real_err
  319. result = unittest.TestResult()
  320. self.assertFalse(result.buffer)
  321. self.assertIs(real_out, sys.stdout)
  322. self.assertIs(real_err, sys.stderr)
  323. result.startTest(self)
  324. self.assertIs(real_out, sys.stdout)
  325. self.assertIs(real_err, sys.stderr)
  326. def testBufferOutputStartTestAddSuccess(self):
  327. real_out = self._real_out
  328. real_err = self._real_err
  329. result = unittest.TestResult()
  330. self.assertFalse(result.buffer)
  331. result.buffer = True
  332. self.assertIs(real_out, sys.stdout)
  333. self.assertIs(real_err, sys.stderr)
  334. result.startTest(self)
  335. self.assertIsNot(real_out, sys.stdout)
  336. self.assertIsNot(real_err, sys.stderr)
  337. self.assertIsInstance(sys.stdout, StringIO)
  338. self.assertIsInstance(sys.stderr, StringIO)
  339. self.assertIsNot(sys.stdout, sys.stderr)
  340. out_stream = sys.stdout
  341. err_stream = sys.stderr
  342. result._original_stdout = StringIO()
  343. result._original_stderr = StringIO()
  344. print 'foo'
  345. print >> sys.stderr, 'bar'
  346. self.assertEqual(out_stream.getvalue(), 'foo\n')
  347. self.assertEqual(err_stream.getvalue(), 'bar\n')
  348. self.assertEqual(result._original_stdout.getvalue(), '')
  349. self.assertEqual(result._original_stderr.getvalue(), '')
  350. result.addSuccess(self)
  351. result.stopTest(self)
  352. self.assertIs(sys.stdout, result._original_stdout)
  353. self.assertIs(sys.stderr, result._original_stderr)
  354. self.assertEqual(result._original_stdout.getvalue(), '')
  355. self.assertEqual(result._original_stderr.getvalue(), '')
  356. self.assertEqual(out_stream.getvalue(), '')
  357. self.assertEqual(err_stream.getvalue(), '')
  358. def getStartedResult(self):
  359. result = unittest.TestResult()
  360. result.buffer = True
  361. result.startTest(self)
  362. return result
  363. def testBufferOutputAddErrorOrFailure(self):
  364. unittest.result.traceback = MockTraceback
  365. self.addCleanup(restore_traceback)
  366. for message_attr, add_attr, include_error in [
  367. ('errors', 'addError', True),
  368. ('failures', 'addFailure', False),
  369. ('errors', 'addError', True),
  370. ('failures', 'addFailure', False)
  371. ]:
  372. result = self.getStartedResult()
  373. buffered_out = sys.stdout
  374. buffered_err = sys.stderr
  375. result._original_stdout = StringIO()
  376. result._original_stderr = StringIO()
  377. print >> sys.stdout, 'foo'
  378. if include_error:
  379. print >> sys.stderr, 'bar'
  380. addFunction = getattr(result, add_attr)
  381. addFunction(self, (None, None, None))
  382. result.stopTest(self)
  383. result_list = getattr(result, message_attr)
  384. self.assertEqual(len(result_list), 1)
  385. test, message = result_list[0]
  386. expectedOutMessage = textwrap.dedent("""
  387. Stdout:
  388. foo
  389. """)
  390. expectedErrMessage = ''
  391. if include_error:
  392. expectedErrMessage = textwrap.dedent("""
  393. Stderr:
  394. bar
  395. """)
  396. expectedFullMessage = 'A traceback%s%s' % (expectedOutMessage, expectedErrMessage)
  397. self.assertIs(test, self)
  398. self.assertEqual(result._original_stdout.getvalue(), expectedOutMessage)
  399. self.assertEqual(result._original_stderr.getvalue(), expectedErrMessage)
  400. self.assertMultiLineEqual(message, expectedFullMessage)
  401. def testBufferSetupClass(self):
  402. result = unittest.TestResult()
  403. result.buffer = True
  404. class Foo(unittest.TestCase):
  405. @classmethod
  406. def setUpClass(cls):
  407. 1//0
  408. def test_foo(self):
  409. pass
  410. suite = unittest.TestSuite([Foo('test_foo')])
  411. suite(result)
  412. self.assertEqual(len(result.errors), 1)
  413. def testBufferTearDownClass(self):
  414. result = unittest.TestResult()
  415. result.buffer = True
  416. class Foo(unittest.TestCase):
  417. @classmethod
  418. def tearDownClass(cls):
  419. 1//0
  420. def test_foo(self):
  421. pass
  422. suite = unittest.TestSuite([Foo('test_foo')])
  423. suite(result)
  424. self.assertEqual(len(result.errors), 1)
  425. def testBufferSetUpModule(self):
  426. result = unittest.TestResult()
  427. result.buffer = True
  428. class Foo(unittest.TestCase):
  429. def test_foo(self):
  430. pass
  431. class Module(object):
  432. @staticmethod
  433. def setUpModule():
  434. 1//0
  435. Foo.__module__ = 'Module'
  436. sys.modules['Module'] = Module
  437. self.addCleanup(sys.modules.pop, 'Module')
  438. suite = unittest.TestSuite([Foo('test_foo')])
  439. suite(result)
  440. self.assertEqual(len(result.errors), 1)
  441. def testBufferTearDownModule(self):
  442. result = unittest.TestResult()
  443. result.buffer = True
  444. class Foo(unittest.TestCase):
  445. def test_foo(self):
  446. pass
  447. class Module(object):
  448. @staticmethod
  449. def tearDownModule():
  450. 1//0
  451. Foo.__module__ = 'Module'
  452. sys.modules['Module'] = Module
  453. self.addCleanup(sys.modules.pop, 'Module')
  454. suite = unittest.TestSuite([Foo('test_foo')])
  455. suite(result)
  456. self.assertEqual(len(result.errors), 1)
  457. if __name__ == '__main__':
  458. unittest.main()