Skip to content

Commit

Permalink
bpo-36674: Honour the skipping decorators in TestCase.debug() (GH-28446)
Browse files Browse the repository at this point in the history
unittest.TestCase.debug() raises now a SkipTest if the class or
the test method are decorated with the skipping decorator.

Previously it only raised a SkipTest if the test method was decorated
with other decorator in addition to the skipping decorator, or
if SkipTest was explicitly raised in the test or setup methods.
  • Loading branch information
serhiy-storchaka committed Sep 18, 2021
1 parent 94b4626 commit dea59cf
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 1 deletion.
10 changes: 9 additions & 1 deletion Lib/unittest/case.py
Expand Up @@ -653,8 +653,16 @@ def __call__(self, *args, **kwds):

def debug(self):
"""Run the test without collecting errors in a TestResult"""
testMethod = getattr(self, self._testMethodName)
if (getattr(self.__class__, "__unittest_skip__", False) or
getattr(testMethod, "__unittest_skip__", False)):
# If the class or method was skipped.
skip_why = (getattr(self.__class__, '__unittest_skip_why__', '')
or getattr(testMethod, '__unittest_skip_why__', ''))
raise SkipTest(skip_why)

self.setUp()
getattr(self, self._testMethodName)()
testMethod()
self.tearDown()
while self._cleanups:
function, args, kwargs = self._cleanups.pop(-1)
Expand Down
66 changes: 66 additions & 0 deletions Lib/unittest/test/test_skipping.py
Expand Up @@ -460,5 +460,71 @@ def test_1(self):
self.assertIs(suite.run(result), result)
self.assertEqual(result.skipped, [(test, "")])

def test_debug_skipping(self):
class Foo(unittest.TestCase):
def setUp(self):
events.append("setUp")
def tearDown(self):
events.append("tearDown")
def test1(self):
self.skipTest('skipping exception')
events.append("test1")
@unittest.skip("skipping decorator")
def test2(self):
events.append("test2")

events = []
test = Foo("test1")
with self.assertRaises(unittest.SkipTest) as cm:
test.debug()
self.assertIn("skipping exception", str(cm.exception))
self.assertEqual(events, ["setUp"])

events = []
test = Foo("test2")
with self.assertRaises(unittest.SkipTest) as cm:
test.debug()
self.assertIn("skipping decorator", str(cm.exception))
self.assertEqual(events, [])

def test_debug_skipping_class(self):
@unittest.skip("testing")
class Foo(unittest.TestCase):
def setUp(self):
events.append("setUp")
def tearDown(self):
events.append("tearDown")
def test(self):
events.append("test")

events = []
test = Foo("test")
with self.assertRaises(unittest.SkipTest) as cm:
test.debug()
self.assertIn("testing", str(cm.exception))
self.assertEqual(events, [])

def test_debug_skipping_subtests(self):
class Foo(unittest.TestCase):
def setUp(self):
events.append("setUp")
def tearDown(self):
events.append("tearDown")
def test(self):
with self.subTest(a=1):
events.append('subtest')
self.skipTest("skip subtest")
events.append('end subtest')
events.append('end test')

events = []
result = LoggingResult(events)
test = Foo("test")
with self.assertRaises(unittest.SkipTest) as cm:
test.debug()
self.assertIn("skip subtest", str(cm.exception))
self.assertEqual(events, ['setUp', 'subtest'])


if __name__ == "__main__":
unittest.main()
@@ -0,0 +1,2 @@
:meth:`unittest.TestCase.debug` raises now a :class:`unittest.SkipTest` if
the class or the test method are decorated with the skipping decorator.

0 comments on commit dea59cf

Please sign in to comment.