Merge pull request kyrus#9 from Ketouem/master

brianebeyer · brianebeyer · commit 3e585cf7f757 · 2013-07-02T08:27:05.000-07:00
Handling of &lt;skipped&gt; xml entity that can be parsed by Jenkins
diff --git a/junit_xml/__init__.py b/junit_xml/__init__.py
@@ -24,6 +24,11 @@
                 the output of the testcase
             </error>
         </testcase>
+	<testcase classname="package.directory" name="003-skipped-test" time="0">
+	    <skipped message="SKIPPED Test" type="skipped">
+                the output of the testcase
+            </skipped>	
+	</testcase>
         <testcase classname="testdb.directory" name="003-passed-test" time="10">
             <system-out>
                 I am system output
@@ -63,6 +68,7 @@ def build_xml_doc(self):
         test_suite_attributes['name'] = str(self.name)
         test_suite_attributes['failures'] = str(len([c for c in self.test_cases if c.is_failure()]))
         test_suite_attributes['errors'] = str(len([c for c in self.test_cases if c.is_error()]))
+	test_suite_attributes['skipped'] = str(len([c for c in self.test_cases if c.is_skipped()]))
         test_suite_attributes['time'] = str(sum(c.elapsed_sec for c in self.test_cases if c.elapsed_sec))        
         test_suite_attributes['tests'] = str(len(self.test_cases))
 
@@ -115,6 +121,16 @@ def build_xml_doc(self):
                     error_element.text = case.error_output
                 test_case_element.append(error_element)
 
+            # skippeds
+            if case.is_skipped():
+                attrs = {'type': 'skipped'}
+                if case.skipped_message:
+                    attrs['message'] = case.skipped_message
+                skipped_element = ET.Element("skipped", attrs)
+                if case.error_output:
+                    skipped_element.text = case.skipped_output
+                test_case_element.append(skipped_element)
+
             # test stdout
             if case.stdout:
                 stdout_element = ET.Element("system-out")
@@ -130,7 +146,7 @@ def build_xml_doc(self):
         return xml_element
 
     @staticmethod
-    def to_xml_string(test_suites, prettyprint=True):
+    def to_xml_string(test_suites, prettyprint=True, encoding=None):
         """Returns the string representation of the JUnit XML document"""
         try:
             iter(test_suites)
@@ -141,17 +157,17 @@ def to_xml_string(test_suites, prettyprint=True):
         for ts in test_suites:
             xml_element.append(ts.build_xml_doc())
 
-        xml_string = ET.tostring(xml_element)
+        xml_string = ET.tostring(xml_element, encoding=encoding)
         xml_string = TestSuite._clean_illegal_xml_chars(xml_string)
 
         if prettyprint:
             xml_string = xml.dom.minidom.parseString(xml_string).toprettyxml()
         return xml_string
 
     @staticmethod
-    def to_file(file_descriptor, test_suites, prettyprint=True):
+    def to_file(file_descriptor, test_suites, prettyprint=True, encoding=None):
         """Writes the JUnit XML document to file"""
-        file_descriptor.write(TestSuite.to_xml_string(test_suites, prettyprint))
+        file_descriptor.write(TestSuite.to_xml_string(test_suites, prettyprint, encoding))
 
     @staticmethod
     def _clean_illegal_xml_chars(string_to_clean):
@@ -187,6 +203,8 @@ def __init__(self, name, classname=None, elapsed_sec=None, stdout=None, stderr=N
         self.error_output = None
         self.failure_message = None
         self.failure_output = None
+        self.skipped_message = None
+        self.skipped_output = None
 
     def add_error_info(self, message=None, output=None):
         """Adds an error message, output, or both to the test case"""
@@ -202,10 +220,21 @@ def add_failure_info(self, message=None, output=None):
         if output:
             self.failure_output = output
 
+    def add_skipped_info(self, message=None, output=None):
+        """Adds a skipped message, output, or both to the test case"""
+        if message:
+            self.skipped_message = message
+        if output:
+            self.skipped_output = output
+
     def is_failure(self):
         """returns true if this test case is a failure"""
         return self.failure_output or self.failure_message
 
     def is_error(self):
         """returns true if this test case is an error"""
         return self.error_output or self.error_message
+
+    def is_skipped(self):
+        """returns true if this test case has been skipped"""
+        return self.skipped_output or self.skipped_message
diff --git a/tests.py b/tests.py
@@ -156,6 +156,25 @@ def test_init_error(self):
         verify_test_case(self, tcs[0], {'name': 'Error-Message-and-Output'},
                          error_message="error message", error_output="I errored!")
 
+    def test_init_skipped_message(self):
+        tc = TestCase('Skipped-Message')
+        tc.add_skipped_info("skipped message")
+        (ts, tcs) = serialize_and_read(TestSuite('test', [tc]))[0]
+        verify_test_case(self, tcs[0], {'name': 'Skipped-Message'}, skipped_message="skipped message")
+
+    def test_init_skipped_output(self):
+        tc = TestCase('Skipped-Output')
+        tc.add_skipped_info(output="I skipped!")
+        (ts, tcs) = serialize_and_read(TestSuite('test', [tc]))[0]
+        verify_test_case(self, tcs[0], {'name': 'Skipped-Output'}, skipped_output="I skipped!")
+
+    def test_init_skipped(self):
+        tc = TestCase('Skipped-Message-and-Output')
+        tc.add_skipped_info("skipped message", "I skipped!")
+        (ts, tcs) = serialize_and_read(TestSuite('test', [tc]))[0]
+        verify_test_case(self, tcs[0], {'name': 'Skipped-Message-and-Output'},
+                         skipped_message="skipped message", skipped_output="I skipped!") 
+
     def test_init_legal_unicode_char(self):
         tc = TestCase('Failure-Message')
         tc.add_failure_info(u"failure message with legal unicode char: [\x22]")
@@ -174,6 +193,7 @@ def test_init_illegal_unicode_char(self):
 def verify_test_case(tc, test_case_element, expected_attributes,
                      error_message=None, error_output=None,
                      failure_message=None, failure_output=None,
+                     skipped_message=None, skipped_output=None,
                      stdout=None, stderr=None):
     for k, v in expected_attributes.items():
         tc.assertEqual(v, test_case_element.attributes[k].value)
@@ -210,5 +230,11 @@ def verify_test_case(tc, test_case_element, expected_attributes,
         if failure_output:
             tc.assertEqual(failure_output, failures[0].firstChild.nodeValue.strip())
 
+        skipped = test_case_element.getElementsByTagName('skipped')
+        if skipped_message or skipped_output:
+            tc.assertTrue(len(skipped) > 0)
+        else:
+            tc.assertEqual(0, len(skipped))
+
 if __name__ == '__main__':
     unittest.main()
