Merge pull request #4 from yamokosk/master

Improves validation against JUnit schema

Author: johnthagen

cppcheck_junit.py

@@ -6,7 +6,9 @@
 
 import argparse
 import collections
+from datetime import datetime
 import os
+from socket import gethostname
 import sys
 from typing import Dict, List  # noqa: F401
 from xml.etree import ElementTree
@@ -110,19 +112,24 @@ def generate_test_suite(errors):
         XML test suite.
     """
     test_suite = ElementTree.Element('testsuite')
-    test_suite.attrib['errors'] = str(len(errors))
-    test_suite.attrib['failures'] = str(0)
     test_suite.attrib['name'] = 'Cppcheck errors'
+    test_suite.attrib['timestamp'] = datetime.isoformat(datetime.now())
+    test_suite.attrib['hostname'] = gethostname()
     test_suite.attrib['tests'] = str(len(errors))
+    test_suite.attrib['failures'] = str(0)
+    test_suite.attrib['errors'] = str(len(errors))
     test_suite.attrib['time'] = str(1)
 
     for file_name, errors in errors.items():
         test_case = ElementTree.SubElement(test_suite,
                                            'testcase',
-                                           name=os.path.relpath(file_name) if file_name else '')
+                                           name=os.path.relpath(file_name) if file_name else '',
+                                           classname='',
+                                           time=str(1))
         for error in errors:
             ElementTree.SubElement(test_case,
                                    'error',
+                                   type='',
                                    file=os.path.relpath(error.file) if error.file else '',
                                    line=str(error.line),
                                    message='{}: ({}) {}'.format(error.line,
@@ -137,10 +144,17 @@ def generate_single_success_test_suite():
     """Generates a single successful JUnit XML testcase."""
     test_suite = ElementTree.Element('testsuite')
     test_suite.attrib['name'] = 'Cppcheck errors'
+    test_suite.attrib['timestamp'] = datetime.isoformat(datetime.now())
+    test_suite.attrib['hostname'] = gethostname()
     test_suite.attrib['tests'] = str(1)
+    test_suite.attrib['failures'] = str(0)
+    test_suite.attrib['errors'] = str(0)
+    test_suite.attrib['time'] = str(1)
     ElementTree.SubElement(test_suite,
                            'testcase',
-                           name='Cppcheck success')
+                           name='Cppcheck success',
+                           classname='',
+                           time=str(1))
     return ElementTree.ElementTree(test_suite)
 
 

test.py

@@ -102,6 +102,15 @@ def test_malformed(self):  # type: () -> None
 
 
 class GenerateTestSuiteTestCase(unittest.TestCase):
+    # Expected attributes from JUnit XSD
+    #   ref: https://raw.githubusercontent.com/windyroad/JUnit-Schema/master/JUnit.xsd
+    # @TODO: Better thing to do here would be to curl or otherwise access the
+    #        spec above instead of hardcoding pieces of it here
+    junit_testsuite_attributes = ['name', 'timestamp', 'hostname', 'tests',
+                                  'failures', 'errors', 'time']
+    junit_testcase_attributes = ['name', 'classname', 'time']
+    junit_error_attributes = ['type']
+
     def test_single(self):  # type: () -> None
         errors = {'file_name':
                   [CppcheckError('file_name',
@@ -111,18 +120,27 @@ def test_single(self):  # type: () -> None
                                  'error_id',
                                  'verbose error message')]}
         tree = generate_test_suite(errors)
-        root = tree.getroot()
-        self.assertEqual(root.get('errors'), str(1))
-        self.assertEqual(root.get('failures'), str(0))
-        self.assertEqual(root.get('tests'), str(1))
-
-        test_case_element = root.find('testcase')
-        self.assertEqual(test_case_element.get('name'), 'file_name')
-
-        error_element = test_case_element.find('error')
+        testsuite_element = tree.getroot()
+        self.assertEqual(testsuite_element.get('errors'), str(1))
+        self.assertEqual(testsuite_element.get('failures'), str(0))
+        self.assertEqual(testsuite_element.get('tests'), str(1))
+        # Check that testsuite element is compliant with the spec
+        for required_attribute in self.junit_testsuite_attributes:
+            self.assertTrue(required_attribute in testsuite_element.attrib.keys())
+
+        testcase_element = testsuite_element.find('testcase')
+        self.assertEqual(testcase_element.get('name'), 'file_name')
+        # Check that test_case is compliant with the spec
+        for required_attribute in self.junit_testcase_attributes:
+            self.assertTrue(required_attribute in testcase_element.attrib.keys())
+
+        error_element = testcase_element.find('error')
         self.assertEqual(error_element.get('file'), 'file_name')
         self.assertEqual(error_element.get('line'), str(4))
         self.assertEqual(error_element.get('message'), '4: (severity) error message')
+        # Check that error element is compliant with the spec
+        for required_attribute in self.junit_error_attributes:
+            self.assertTrue(required_attribute in error_element.attrib.keys())
 
     def test_missing_file(self):  # type: () -> None
         errors = {'':
@@ -141,32 +159,57 @@ def test_missing_file(self):  # type: () -> None
                                          'that may increase the checking time. For more details, '
                                          'use --enable=information.')]}
         tree = generate_test_suite(errors)
-        root = tree.getroot()
-        self.assertEqual(root.get('errors'), str(1))
-        self.assertEqual(root.get('failures'), str(0))
-        self.assertEqual(root.get('tests'), str(1))
-
-        test_case_element = root.find('testcase')
-        self.assertEqual(test_case_element.get('name'), '')
-
-        error_element = test_case_element.find('error')
+        testsuite_element = tree.getroot()
+        self.assertEqual(testsuite_element.get('errors'), str(1))
+        self.assertEqual(testsuite_element.get('failures'), str(0))
+        self.assertEqual(testsuite_element.get('tests'), str(1))
+        # Check that testsuite element is compliant with the spec
+        for required_attribute in self.junit_testsuite_attributes:
+            self.assertTrue(required_attribute in testsuite_element.attrib.keys())
+
+        testcase_element = testsuite_element.find('testcase')
+        self.assertEqual(testcase_element.get('name'), '')
+        # Check that test_case is compliant with the spec
+        for required_attribute in self.junit_testcase_attributes:
+            self.assertTrue(required_attribute in testcase_element.attrib.keys())
+
+        error_element = testcase_element.find('error')
         self.assertEqual(error_element.get('file'), '')
         self.assertEqual(error_element.get('line'), str(0))
         self.assertEqual(error_element.get('message'),
                          '0: (information) Too many #ifdef configurations - cppcheck only checks '
                          '12 configurations. Use --force to check all '
                          'configurations. For more details, use '
                          '--enable=information.')
+        # Check that error element is compliant with the spec
+        for required_attribute in self.junit_error_attributes:
+            self.assertTrue(required_attribute in error_element.attrib.keys())
 
 
 class GenerateSingleSuccessTestSuite(unittest.TestCase):
+    # Expected attributes from JUnit XSD
+    #   ref: https://raw.githubusercontent.com/windyroad/JUnit-Schema/master/JUnit.xsd
+    # @TODO: Better thing to do here would be to curl or otherwise access the
+    #        spec above instead of hardcoding pieces of it here
+    junit_testsuite_attributes = ['name', 'timestamp', 'hostname', 'tests',
+                                  'failures', 'errors', 'time']
+    junit_testcase_attributes = ['name', 'classname', 'time']
+
     def test(self):  # type: () -> None
         tree = generate_single_success_test_suite()
-        root = tree.getroot()
-        self.assertEqual(root.get('tests'), str(1))
-
-        test_case_element = root.find('testcase')
-        self.assertEqual(test_case_element.get('name'), 'Cppcheck success')
+        testsuite_element = tree.getroot()
+        self.assertEqual(testsuite_element.get('tests'), str(1))
+        self.assertEqual(testsuite_element.get('errors'), str(0))
+        self.assertEqual(testsuite_element.get('failures'), str(0))
+        # Check that testsuite element is compliant with the spec
+        for required_attribute in self.junit_testsuite_attributes:
+            self.assertTrue(required_attribute in testsuite_element.attrib.keys())
+
+        testcase_element = testsuite_element.find('testcase')
+        self.assertEqual(testcase_element.get('name'), 'Cppcheck success')
+        # Check that test_case is compliant with the spec
+        for required_attribute in self.junit_testcase_attributes:
+            self.assertTrue(required_attribute in testcase_element.attrib.keys())
 
 
 class ParseArgumentsTestCase(unittest.TestCase):