Fix subtests (#178)

* [result] trying to fix subtest failures

* [result] adding missing methods to add expected failure and unexpected success

* [result] trying to add missing subdescription

* [tests] adding missing test for subtest error

Author: XonqNopp

tests/testsuite.py

@@ -147,6 +147,11 @@ def test_subTest_fail(self):
                 with self.subTest(i=i):
                     self.fail('this is a subtest.')
 
+        def test_subTest_error(self):
+            for i in range(2):
+                with self.subTest(i=i):
+                    raise Exception('this is a subtest')
+
     class DummyErrorInCallTest(unittest.TestCase):
 
         def __call__(self, result):
@@ -416,6 +421,30 @@ def test_unittest_subTest_fail(self):
             br'(XMLTestRunnerTestCase\.)?DummySubTest" '
             br'name="test_subTest_fail \(i=1\)"')
 
+    @unittest.skipIf(not hasattr(unittest.TestCase, 'subTest'),
+                     'unittest.TestCase.subTest not present.')
+    def test_unittest_subTest_error(self):
+        # test for issue #155
+        outdir = BytesIO()
+        runner = xmlrunner.XMLTestRunner(
+            stream=self.stream, output=outdir, verbosity=self.verbosity,
+            **self.runner_kwargs)
+        suite = unittest.TestSuite()
+        suite.addTest(self.DummySubTest('test_subTest_error'))
+        runner.run(suite)
+        outdir.seek(0)
+        output = outdir.read()
+        self.assertRegexpMatches(
+            output,
+            br'<testcase classname="tests\.testsuite\.'
+            br'(XMLTestRunnerTestCase\.)?DummySubTest" '
+            br'name="test_subTest_error \(i=0\)"')
+        self.assertRegexpMatches(
+            output,
+            br'<testcase classname="tests\.testsuite\.'
+            br'(XMLTestRunnerTestCase\.)?DummySubTest" '
+            br'name="test_subTest_error \(i=1\)"')
+
     @unittest.skipIf(not hasattr(unittest.TestCase, 'subTest'),
                      'unittest.TestCase.subTest not present.')
     def test_unittest_subTest_pass(self):

xmlrunner/result.py

@@ -156,8 +156,10 @@ def __init__(self, test_result, test_method, outcome=SUCCESS, err=None, subTest=
 
         self.test_name = testcase_name(test_method)
         self.test_id = test_method.id()
+        self.subDescription = None
         if subTest:
             self.test_id = subTest.id()
+            self.subDescription = subTest._subDescription()
 
     def id(self):
         return self.test_id
@@ -174,7 +176,12 @@ def get_description(self):
         """
         Return a text representation of the test method.
         """
-        return self.test_description
+        description = self.test_description
+
+        if self.subDescription is not None:
+            description += ' ' + self.subDescription
+
+        return description
 
     def get_error_info(self):
         """
@@ -337,14 +344,29 @@ def addSubTest(self, testcase, test, err):
         Called when a subTest method raises an error.
         """
         if err is not None:
+
+            errorText = None
+            errorValue = None
+            errorList = None
+            if issubclass(err[0], test.failureException):
+                errorText = 'FAIL'
+                errorValue = self.infoclass.FAILURE
+                errorList = self.failures
+
+            else:
+                errorText = 'ERROR'
+                errorValue = self.infoclass.ERROR
+                errorList = self.errors
+
             self._save_output_data()
+
             testinfo = self.infoclass(
-                self, testcase, self.infoclass.ERROR, err, subTest=test)
-            self.errors.append((
+                self, testcase, errorValue, err, subTest=test)
+            errorList.append((
                 testinfo,
                 self._exc_info_to_string(err, testcase)
             ))
-            self._prepare_callback(testinfo, [], 'ERROR', 'E')
+            self._prepare_callback(testinfo, [], errorText, errorText[0])
 
     def addSkip(self, test, reason):
         """
@@ -356,6 +378,36 @@ def addSkip(self, test, reason):
         self.skipped.append((testinfo, reason))
         self._prepare_callback(testinfo, [], 'SKIP', 'S')
 
+    def addExpectedFailure(self, test, err):
+        """
+        Missing in xmlrunner, copy-pasted from xmlrunner addError.
+        """
+        self._save_output_data()
+
+        testinfo = self.infoclass(self, test, self.infoclass.ERROR, err)
+        testinfo.test_exception_name = 'ExpectedFailure'
+        testinfo.test_exception_message = 'EXPECTED FAILURE: {}'.format(testinfo.test_exception_message)
+
+        self.expectedFailures.append((testinfo, self._exc_info_to_string(err, test)))
+        self._prepare_callback(testinfo, [], 'EXPECTED FAILURE', 'X')
+
+    @failfast
+    def addUnexpectedSuccess(self, test):
+        """
+        Missing in xmlrunner, copy-pasted from xmlrunner addSuccess.
+        """
+        self._save_output_data()
+
+        testinfo = self.infoclass(self, test)  # do not set outcome here because it will need exception
+        testinfo.outcome = self.infoclass.ERROR
+        # But since we want to have error outcome, we need to provide additional fields:
+        testinfo.test_exception_name = 'UnexpectedSuccess'
+        testinfo.test_exception_message = ('UNEXPECTED SUCCESS: This test was marked as expected failure but passed, '
+                                           'please review it')
+
+        self.unexpectedSuccesses.append(testinfo)
+        self._prepare_callback(testinfo, [], 'UNEXPECTED SUCCESS', 'U')
+
     def printErrorList(self, flavour, errors):
         """
         Writes information about the FAIL or ERROR to the stream.