Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-08 06:10:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.11] gh-106300: Improve errors testing in test_unittest.test_runner (GH-106737) (GH-108007)

Browse source 
Use a custom exception to prevent unintentional silence of actual errors.
(cherry picked from commit fd9d70a94d)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
This commit is contained in:
Miss Islington (bot) 2023-08-16 02:59:44 -07:00 • committed by GitHub
parent c1c3f0bfec
commit 6b825c1b8a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 65 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

115
Lib/unittest/test/test_runner.py
View file

@ -21,6 +21,13 @@ def getRunner():
stream=io.StringIO()) stream=io.StringIO())
class CustomError(Exception):
pass
# For test output compat:
CustomErrorRepr = f"{__name__ + '.' if __name__ != '__main__' else ''}CustomError"
def runTests(*cases): def runTests(*cases):
suite = unittest.TestSuite() suite = unittest.TestSuite()
for case in cases: for case in cases:
@ -43,7 +50,7 @@ def cleanup(ordering, blowUp=False):
ordering.append('cleanup_good') ordering.append('cleanup_good')
else: else:
ordering.append('cleanup_exc') ordering.append('cleanup_exc')
raise Exception('CleanUpExc') raise CustomError('CleanUpExc')
class TestCM: class TestCM:
@ -105,8 +112,8 @@ def testNothing(self):
result = unittest.TestResult() result = unittest.TestResult()
outcome = test._outcome = _Outcome(result=result) outcome = test._outcome = _Outcome(result=result)
CleanUpExc = Exception('foo') CleanUpExc = CustomError('foo')
exc2 = Exception('bar') exc2 = CustomError('bar')
def cleanup1(): def cleanup1():
raise CleanUpExc raise CleanUpExc
@ -122,10 +129,10 @@ def cleanup2():
(_, msg2), (_, msg1) = result.errors (_, msg2), (_, msg1) = result.errors
self.assertIn('in cleanup1', msg1) self.assertIn('in cleanup1', msg1)
self.assertIn('raise CleanUpExc', msg1) self.assertIn('raise CleanUpExc', msg1)
self.assertIn('Exception: foo', msg1) self.assertIn(f'{CustomErrorRepr}: foo', msg1)
self.assertIn('in cleanup2', msg2) self.assertIn('in cleanup2', msg2)
self.assertIn('raise exc2', msg2) self.assertIn('raise exc2', msg2)
self.assertIn('Exception: bar', msg2) self.assertIn(f'{CustomErrorRepr}: bar', msg2)
def testCleanupInRun(self): def testCleanupInRun(self):
blowUp = False blowUp = False
@ -136,7 +143,7 @@ def setUp(self):
ordering.append('setUp') ordering.append('setUp')
test.addCleanup(cleanup2) test.addCleanup(cleanup2)
if blowUp: if blowUp:
raise Exception('foo') raise CustomError('foo')
def testNothing(self): def testNothing(self):
ordering.append('test') ordering.append('test')
@ -277,7 +284,7 @@ def setUpClass(cls):
ordering.append('setUpClass') ordering.append('setUpClass')
cls.addClassCleanup(cleanup, ordering) cls.addClassCleanup(cleanup, ordering)
if blowUp: if blowUp:
raise Exception() raise CustomError()
def testNothing(self): def testNothing(self):
ordering.append('test') ordering.append('test')
@classmethod @classmethod
@ -303,7 +310,7 @@ def setUpClass(cls):
ordering.append('setUpClass') ordering.append('setUpClass')
cls.addClassCleanup(cleanup, ordering) cls.addClassCleanup(cleanup, ordering)
if blowUp: if blowUp:
raise Exception() raise CustomError()
def testNothing(self): def testNothing(self):
ordering.append('test') ordering.append('test')
@classmethod @classmethod
@ -343,7 +350,7 @@ def tearDownClass(cls):
ordering = [] ordering = []
blowUp = True blowUp = True
suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest) suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest)
with self.assertRaises(Exception) as cm: with self.assertRaises(CustomError) as cm:
suite.debug() suite.debug()
self.assertEqual(str(cm.exception), 'CleanUpExc') self.assertEqual(str(cm.exception), 'CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
@ -363,10 +370,10 @@ def testNothing(self):
@classmethod @classmethod
def tearDownClass(cls): def tearDownClass(cls):
ordering.append('tearDownClass') ordering.append('tearDownClass')
raise Exception('TearDownClassExc') raise CustomError('TearDownClassExc')
suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest) suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest)
with self.assertRaises(Exception) as cm: with self.assertRaises(CustomError) as cm:
suite.debug() suite.debug()
self.assertEqual(str(cm.exception), 'TearDownClassExc') self.assertEqual(str(cm.exception), 'TearDownClassExc')
self.assertEqual(ordering, ['setUpClass', 'test', 'tearDownClass']) self.assertEqual(ordering, ['setUpClass', 'test', 'tearDownClass'])
@ -376,7 +383,7 @@ def tearDownClass(cls):
ordering = [] ordering = []
blowUp = True blowUp = True
suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest) suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest)
with self.assertRaises(Exception) as cm: with self.assertRaises(CustomError) as cm:
suite.debug() suite.debug()
self.assertEqual(str(cm.exception), 'TearDownClassExc') self.assertEqual(str(cm.exception), 'TearDownClassExc')
self.assertEqual(ordering, ['setUpClass', 'test', 'tearDownClass']) self.assertEqual(ordering, ['setUpClass', 'test', 'tearDownClass'])
@ -389,16 +396,22 @@ def testNothing(self):
pass pass
def cleanup1(): def cleanup1():
raise Exception('cleanup1') raise CustomError('cleanup1')
def cleanup2(): def cleanup2():
raise Exception('cleanup2') raise CustomError('cleanup2')
TestableTest.addClassCleanup(cleanup1) TestableTest.addClassCleanup(cleanup1)
TestableTest.addClassCleanup(cleanup2) TestableTest.addClassCleanup(cleanup2)
with self.assertRaises(Exception) as e:
TestableTest.doClassCleanups() TestableTest.doClassCleanups()
self.assertEqual(e, 'cleanup1')
self.assertEqual(len(TestableTest.tearDown_exceptions), 2)
e1, e2 = TestableTest.tearDown_exceptions
self.assertIsInstance(e1[1], CustomError)
self.assertEqual(str(e1[1]), 'cleanup2')
self.assertIsInstance(e2[1], CustomError)
self.assertEqual(str(e2[1]), 'cleanup1')
def test_with_errors_addCleanUp(self): def test_with_errors_addCleanUp(self):
ordering = [] ordering = []
@ -418,7 +431,7 @@ def tearDownClass(cls):
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpClass', 'setUp', 'cleanup_exc', ['setUpClass', 'setUp', 'cleanup_exc',
'tearDownClass', 'cleanup_good']) 'tearDownClass', 'cleanup_good'])
@ -441,7 +454,7 @@ def tearDownClass(cls):
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpClass', 'setUp', 'test', 'cleanup_good', ['setUpClass', 'setUp', 'test', 'cleanup_good',
'tearDownClass', 'cleanup_exc']) 'tearDownClass', 'cleanup_exc'])
@ -457,11 +470,11 @@ def setUpClass(cls):
ordering.append('setUpClass') ordering.append('setUpClass')
cls.addClassCleanup(cleanup, ordering, blowUp=True) cls.addClassCleanup(cleanup, ordering, blowUp=True)
if class_blow_up: if class_blow_up:
raise Exception('ClassExc') raise CustomError('ClassExc')
def setUp(self): def setUp(self):
ordering.append('setUp') ordering.append('setUp')
if method_blow_up: if method_blow_up:
raise Exception('MethodExc') raise CustomError('MethodExc')
def testNothing(self): def testNothing(self):
ordering.append('test') ordering.append('test')
@classmethod @classmethod
@ -470,7 +483,7 @@ def tearDownClass(cls):
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpClass', 'setUp', 'test', ['setUpClass', 'setUp', 'test',
'tearDownClass', 'cleanup_exc']) 'tearDownClass', 'cleanup_exc'])
@ -480,9 +493,9 @@ def tearDownClass(cls):
method_blow_up = False method_blow_up = False
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: ClassExc') f'{CustomErrorRepr}: ClassExc')
self.assertEqual(result.errors[1][1].splitlines()[-1], self.assertEqual(result.errors[1][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpClass', 'cleanup_exc']) ['setUpClass', 'cleanup_exc'])
@ -491,9 +504,9 @@ def tearDownClass(cls):
method_blow_up = True method_blow_up = True
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: MethodExc') f'{CustomErrorRepr}: MethodExc')
self.assertEqual(result.errors[1][1].splitlines()[-1], self.assertEqual(result.errors[1][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpClass', 'setUp', 'tearDownClass', ['setUpClass', 'setUp', 'tearDownClass',
'cleanup_exc']) 'cleanup_exc'])
@ -510,11 +523,11 @@ def testNothing(self):
@classmethod @classmethod
def tearDownClass(cls): def tearDownClass(cls):
ordering.append('tearDownClass') ordering.append('tearDownClass')
raise Exception('TearDownExc') raise CustomError('TearDownExc')
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: TearDownExc') f'{CustomErrorRepr}: TearDownExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpClass', 'test', 'tearDownClass', 'cleanup_good']) ['setUpClass', 'test', 'tearDownClass', 'cleanup_good'])
@ -607,7 +620,7 @@ def module_cleanup_good(*args, **kwargs):
module_cleanups.append((3, args, kwargs)) module_cleanups.append((3, args, kwargs))
def module_cleanup_bad(*args, **kwargs): def module_cleanup_bad(*args, **kwargs):
raise Exception('CleanUpExc') raise CustomError('CleanUpExc')
class Module(object): class Module(object):
unittest.addModuleCleanup(module_cleanup_good, 1, 2, 3, unittest.addModuleCleanup(module_cleanup_good, 1, 2, 3,
@ -617,7 +630,7 @@ class Module(object):
[(module_cleanup_good, (1, 2, 3), [(module_cleanup_good, (1, 2, 3),
dict(four='hello', five='goodbye')), dict(four='hello', five='goodbye')),
(module_cleanup_bad, (), {})]) (module_cleanup_bad, (), {})])
with self.assertRaises(Exception) as e: with self.assertRaises(CustomError) as e:
unittest.case.doModuleCleanups() unittest.case.doModuleCleanups()
self.assertEqual(str(e.exception), 'CleanUpExc') self.assertEqual(str(e.exception), 'CleanUpExc')
self.assertEqual(unittest.case._module_cleanups, []) self.assertEqual(unittest.case._module_cleanups, [])
@ -646,7 +659,7 @@ def setUpModule():
ordering.append('setUpModule') ordering.append('setUpModule')
unittest.addModuleCleanup(cleanup, ordering) unittest.addModuleCleanup(cleanup, ordering)
if blowUp: if blowUp:
raise Exception('setUpModule Exc') raise CustomError('setUpModule Exc')
@staticmethod @staticmethod
def tearDownModule(): def tearDownModule():
ordering.append('tearDownModule') ordering.append('tearDownModule')
@ -666,7 +679,7 @@ def tearDownClass(cls):
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(ordering, ['setUpModule', 'cleanup_good']) self.assertEqual(ordering, ['setUpModule', 'cleanup_good'])
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: setUpModule Exc') f'{CustomErrorRepr}: setUpModule Exc')
ordering = [] ordering = []
blowUp = False blowUp = False
@ -686,7 +699,7 @@ def setUpModule():
ordering.append('setUpModule') ordering.append('setUpModule')
unittest.addModuleCleanup(cleanup, ordering) unittest.addModuleCleanup(cleanup, ordering)
if blowUp: if blowUp:
raise Exception() raise CustomError()
@staticmethod @staticmethod
def tearDownModule(): def tearDownModule():
ordering.append('tearDownModule') ordering.append('tearDownModule')
@ -697,7 +710,7 @@ def setUpModule():
ordering.append('setUpModule2') ordering.append('setUpModule2')
unittest.addModuleCleanup(cleanup, ordering) unittest.addModuleCleanup(cleanup, ordering)
if blowUp2: if blowUp2:
raise Exception() raise CustomError()
@staticmethod @staticmethod
def tearDownModule(): def tearDownModule():
ordering.append('tearDownModule2') ordering.append('tearDownModule2')
@ -786,7 +799,7 @@ def setUpModule():
@staticmethod @staticmethod
def tearDownModule(): def tearDownModule():
ordering.append('tearDownModule') ordering.append('tearDownModule')
raise Exception('CleanUpExc') raise CustomError('CleanUpExc')
class TestableTest(unittest.TestCase): class TestableTest(unittest.TestCase):
@classmethod @classmethod
@ -802,7 +815,7 @@ def tearDownClass(cls):
sys.modules['Module'] = Module sys.modules['Module'] = Module
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test', self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test',
'tearDownClass', 'tearDownModule', 'tearDownClass', 'tearDownModule',
'cleanup_good']) 'cleanup_good'])
@ -842,7 +855,7 @@ def tearDownClass(cls):
ordering = [] ordering = []
blowUp = True blowUp = True
suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest) suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest)
with self.assertRaises(Exception) as cm: with self.assertRaises(CustomError) as cm:
suite.debug() suite.debug()
self.assertEqual(str(cm.exception), 'CleanUpExc') self.assertEqual(str(cm.exception), 'CleanUpExc')
self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test', self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test',
@ -860,7 +873,7 @@ def setUpModule():
@staticmethod @staticmethod
def tearDownModule(): def tearDownModule():
ordering.append('tearDownModule') ordering.append('tearDownModule')
raise Exception('TearDownModuleExc') raise CustomError('TearDownModuleExc')
class TestableTest(unittest.TestCase): class TestableTest(unittest.TestCase):
@classmethod @classmethod
@ -875,7 +888,7 @@ def tearDownClass(cls):
TestableTest.__module__ = 'Module' TestableTest.__module__ = 'Module'
sys.modules['Module'] = Module sys.modules['Module'] = Module
suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest) suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest)
with self.assertRaises(Exception) as cm: with self.assertRaises(CustomError) as cm:
suite.debug() suite.debug()
self.assertEqual(str(cm.exception), 'TearDownModuleExc') self.assertEqual(str(cm.exception), 'TearDownModuleExc')
self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test', self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test',
@ -886,7 +899,7 @@ def tearDownClass(cls):
ordering = [] ordering = []
blowUp = True blowUp = True
suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest) suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest)
with self.assertRaises(Exception) as cm: with self.assertRaises(CustomError) as cm:
suite.debug() suite.debug()
self.assertEqual(str(cm.exception), 'TearDownModuleExc') self.assertEqual(str(cm.exception), 'TearDownModuleExc')
self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test', self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test',
@ -965,7 +978,7 @@ def tearDownClass(cls):
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpModule', 'setUpClass', 'test', 'tearDownClass', ['setUpModule', 'setUpClass', 'test', 'tearDownClass',
'cleanup_exc', 'tearDownModule', 'cleanup_good']) 'cleanup_exc', 'tearDownModule', 'cleanup_good'])
@ -995,7 +1008,7 @@ def tearDown(self):
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpModule', 'setUp', 'test', 'tearDown', ['setUpModule', 'setUp', 'test', 'tearDown',
'cleanup_exc', 'tearDownModule', 'cleanup_good']) 'cleanup_exc', 'tearDownModule', 'cleanup_good'])
@ -1011,7 +1024,7 @@ def setUpModule():
ordering.append('setUpModule') ordering.append('setUpModule')
unittest.addModuleCleanup(cleanup, ordering, blowUp=True) unittest.addModuleCleanup(cleanup, ordering, blowUp=True)
if module_blow_up: if module_blow_up:
raise Exception('ModuleExc') raise CustomError('ModuleExc')
@staticmethod @staticmethod
def tearDownModule(): def tearDownModule():
ordering.append('tearDownModule') ordering.append('tearDownModule')
@ -1021,11 +1034,11 @@ class TestableTest(unittest.TestCase):
def setUpClass(cls): def setUpClass(cls):
ordering.append('setUpClass') ordering.append('setUpClass')
if class_blow_up: if class_blow_up:
raise Exception('ClassExc') raise CustomError('ClassExc')
def setUp(self): def setUp(self):
ordering.append('setUp') ordering.append('setUp')
if method_blow_up: if method_blow_up:
raise Exception('MethodExc') raise CustomError('MethodExc')
def testNothing(self): def testNothing(self):
ordering.append('test') ordering.append('test')
@classmethod @classmethod
@ -1037,7 +1050,7 @@ def tearDownClass(cls):
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, self.assertEqual(ordering,
['setUpModule', 'setUpClass', 'setUp', 'test', ['setUpModule', 'setUpClass', 'setUp', 'test',
'tearDownClass', 'tearDownModule', 'tearDownClass', 'tearDownModule',
@ -1049,9 +1062,9 @@ def tearDownClass(cls):
method_blow_up = False method_blow_up = False
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: ModuleExc') f'{CustomErrorRepr}: ModuleExc')
self.assertEqual(result.errors[1][1].splitlines()[-1], self.assertEqual(result.errors[1][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, ['setUpModule', 'cleanup_exc']) self.assertEqual(ordering, ['setUpModule', 'cleanup_exc'])
ordering = [] ordering = []
@ -1060,9 +1073,9 @@ def tearDownClass(cls):
method_blow_up = False method_blow_up = False
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: ClassExc') f'{CustomErrorRepr}: ClassExc')
self.assertEqual(result.errors[1][1].splitlines()[-1], self.assertEqual(result.errors[1][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, ['setUpModule', 'setUpClass', self.assertEqual(ordering, ['setUpModule', 'setUpClass',
'tearDownModule', 'cleanup_exc']) 'tearDownModule', 'cleanup_exc'])
@ -1072,9 +1085,9 @@ def tearDownClass(cls):
method_blow_up = True method_blow_up = True
result = runTests(TestableTest) result = runTests(TestableTest)
self.assertEqual(result.errors[0][1].splitlines()[-1], self.assertEqual(result.errors[0][1].splitlines()[-1],
'Exception: MethodExc') f'{CustomErrorRepr}: MethodExc')
self.assertEqual(result.errors[1][1].splitlines()[-1], self.assertEqual(result.errors[1][1].splitlines()[-1],
'Exception: CleanUpExc') f'{CustomErrorRepr}: CleanUpExc')
self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'setUp', self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'setUp',
'tearDownClass', 'tearDownModule', 'tearDownClass', 'tearDownModule',
'cleanup_exc']) 'cleanup_exc'])