Include error info from multiple locations (#23)

Author: nkr0

cppcheck_junit.py

@@ -4,6 +4,7 @@
 
 import argparse
 import collections
+from dataclasses import dataclass
 from datetime import datetime
 import os
 from socket import gethostname
@@ -14,26 +15,38 @@
 from exitstatus import ExitStatus
 
 
+@dataclass
+class CppcheckLocation:
+    """
+    file: Error location file.
+    line: Error location line.
+    column: Error location column.
+    info: Error location info.
+    """
+
+    file: str
+    line: int
+    column: int
+    info: str
+
+
+@dataclass
 class CppcheckError:
-    def __init__(
-        self, file: str, line: int, message: str, severity: str, error_id: str, verbose: str
-    ) -> None:
-        """Constructor.
-
-        Args:
-            file: File error originated on.
-            line: Line error originated on.
-            message: Error message.
-            severity: Severity of the error.
-            error_id: Unique identifier for the error.
-            verbose: Verbose error message.
-        """
-        self.file = file
-        self.line = line
-        self.message = message
-        self.severity = severity
-        self.error_id = error_id
-        self.verbose = verbose
+    """
+    file: File error originated on.
+    locations: Error locations.
+    message: Error message.
+    severity: Severity of the error.
+    error_id: Unique identifier for the error.
+    verbose: Verbose error message.
+    """
+
+    file: str
+    locations: List[CppcheckLocation]
+    message: str
+    severity: str
+    error_id: str
+    verbose: str
 
 
 def parse_arguments() -> argparse.Namespace:
@@ -80,21 +93,27 @@ def parse_cppcheck(file_name: str) -> Dict[str, List[CppcheckError]]:
 
     errors = collections.defaultdict(list)
     for error_element in error_root:
-        location_element: ElementTree.Element = error_element.find("location")
-        if location_element is not None:
-            file = location_element.get("file")
-            line = int(location_element.get("line"))
-        else:
-            file = ""
-            line = 0
+        file = error_element.get("file0", "")
+        locations = []
+        for location in error_element.findall("location"):
+            if not file:
+                file = location.get("file", "")
+            locations.append(
+                CppcheckLocation(
+                    location.get("file"),
+                    int(location.get("line", 0)),
+                    int(location.get("column", 0)),
+                    location.get("info", ""),
+                )
+            )
 
         error = CppcheckError(
             file=file,
-            line=line,
-            message=error_element.get("msg"),
-            severity=error_element.get("severity"),
-            error_id=error_element.get("id"),
-            verbose=error_element.get("verbose"),
+            locations=locations,
+            message=error_element.get("msg", ""),
+            severity=error_element.get("severity", ""),
+            error_id=error_element.get("id", ""),
+            verbose=error_element.get("verbose", ""),
         )
         errors[error.file].append(error)
 
@@ -128,14 +147,26 @@ def generate_test_suite(errors: Dict[str, List[CppcheckError]]) -> ElementTree.E
             time=str(1),
         )
         for error in errors:
-            ElementTree.SubElement(
+            error_element = ElementTree.SubElement(
                 test_case,
                 "error",
-                type="",
+                type=error.severity,
                 file=os.path.relpath(error.file) if error.file else "",
-                line=str(error.line),
-                message=f"{error.line}: ({error.severity}) {error.message}",
+                message=f"{error.message}",
             )
+            if len(error.locations) == 0:
+                error_element.text = error.verbose
+            elif len(error.locations) == 1 and error.locations[0].info == "":
+                location = error.locations[0]
+                file = os.path.relpath(location.file) if location.file else ""
+                error_element.text = f"{file}:{location.line}:{location.column}: {error.verbose}"
+            else:
+                error_element.text = error.verbose
+                for location in error.locations:
+                    file = os.path.relpath(location.file) if location.file else ""
+                    error_element.text += (
+                        f"\n{file}:{location.line}:{location.column}: {location.info}"
+                    )
 
     return ElementTree.ElementTree(test_suite)
 

test.py

@@ -10,6 +10,7 @@
 
 from cppcheck_junit import (
     CppcheckError,
+    CppcheckLocation,
     generate_single_success_test_suite,
     generate_test_suite,
     parse_arguments,
@@ -27,13 +28,13 @@ def test_bad(self) -> None:
         errors = parse_cppcheck("tests/cppcheck-out-bad.xml")
 
         self.assertEqual(errors[file1][0].file, file1)
-        self.assertEqual(errors[file1][0].line, 4)
+        self.assertEqual(errors[file1][0].locations[0].line, 4)
         self.assertEqual(
             errors[file1][0].message, "Variable 'a' is assigned a value that is never used."
         )
 
         self.assertEqual(errors[file1][1].file, file1)
-        self.assertEqual(errors[file1][1].line, 4)
+        self.assertEqual(errors[file1][1].locations[0].line, 4)
         self.assertEqual(
             errors[file1][1].message, "Array 'a[10]' accessed at index 10, which is out of bounds."
         )
@@ -45,7 +46,7 @@ def test_no_location_element(self) -> None:
         self.assertEqual(len(errors), 1)
         error = errors[file][0]
         self.assertEqual(error.file, file)
-        self.assertEqual(error.line, 0)
+        self.assertEqual(error.locations, [])
         self.assertEqual(
             error.message,
             "Too many #ifdef configurations - cppcheck only checks 12 configurations. "
@@ -61,7 +62,7 @@ def test_missing_include_no_location_element(self) -> None:
         self.assertEqual(len(errors), 1)
         error = errors[file][0]
         self.assertEqual(error.file, file)
-        self.assertEqual(error.line, 0)
+        self.assertEqual(error.locations, [])
         self.assertEqual(
             error.message,
             "Cppcheck cannot find all the include files (use --check-config for details)",
@@ -78,25 +79,25 @@ def test_all(self) -> None:
         errors = parse_cppcheck("tests/cppcheck-out-all.xml")
 
         self.assertEqual(errors[file1][0].file, file1)
-        self.assertEqual(errors[file1][0].line, 4)
+        self.assertEqual(errors[file1][0].locations[0].line, 4)
         self.assertEqual(
             errors[file1][0].message, "Variable 'a' is assigned a value that is never used."
         )
 
         self.assertEqual(errors[file1][1].file, file1)
-        self.assertEqual(errors[file1][1].line, 4)
+        self.assertEqual(errors[file1][1].locations[0].line, 4)
         self.assertEqual(
             errors[file1][1].message, "Array 'a[10]' accessed at index 10, which is out of bounds."
         )
 
         self.assertEqual(errors[file2][0].file, file2)
-        self.assertEqual(errors[file2][0].line, 4)
+        self.assertEqual(errors[file2][0].locations[0].line, 4)
         self.assertEqual(
             errors[file2][0].message, "Variable 'a' is assigned a value that is never used."
         )
 
         self.assertEqual(errors[file2][1].file, file2)
-        self.assertEqual(errors[file2][1].line, 4)
+        self.assertEqual(errors[file2][1].locations[0].line, 4)
         self.assertEqual(
             errors[file2][1].message, "Array 'a[10]' accessed at index 10, which is out of bounds."
         )
@@ -136,7 +137,7 @@ def test_single(self) -> None:
             "file_name": [
                 CppcheckError(
                     "file_name",
-                    4,
+                    [CppcheckLocation("file_name", 4, 0, "")],
                     "error message",
                     "severity",
                     "error_id",
@@ -161,8 +162,9 @@ def test_single(self) -> None:
 
         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")
+        self.assertEqual(error_element.get("type"), "severity")
+        self.assertEqual(error_element.get("message"), "error message")
+        self.assertEqual(error_element.text, "file_name:4:0: verbose 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())
@@ -172,7 +174,7 @@ def test_missing_file(self) -> None:
             "": [
                 CppcheckError(
                     file="",
-                    line=0,
+                    locations=[],
                     message="Too many #ifdef configurations - cppcheck only checks "
                     "12 configurations. Use --force to check all "
                     "configurations. For more details, use "
@@ -206,14 +208,64 @@ def test_missing_file(self) -> None:
 
         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 "
+            "Too many #ifdef configurations - cppcheck only checks "
             "12 configurations. Use --force to check all "
             "configurations. For more details, use "
             "--enable=information.",
         )
+        self.assertEqual(
+            error_element.text,
+            "The checking of the file will be interrupted because "
+            "there are too many #ifdef configurations. Checking of "
+            "all #ifdef configurations can be forced by --force "
+            "command line option or from GUI preferences. However "
+            "that may increase the checking time. 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())
+
+    def test_multiple(self) -> None:
+        errors = {
+            "file_name": [
+                CppcheckError(
+                    "file_name",
+                    [
+                        CppcheckLocation("file_name", 4, 0, "info"),
+                        CppcheckLocation("file_name", 5, 0, "info"),
+                    ],
+                    "error message",
+                    "severity",
+                    "error_id",
+                    "verbose error message",
+                )
+            ]
+        }
+        tree = generate_test_suite(errors)
+        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("type"), "severity")
+        self.assertEqual(error_element.get("message"), "error message")
+        self.assertEqual(
+            error_element.text, "verbose error message\nfile_name:4:0: info\nfile_name:5:0: info"
+        )
         # 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())