|
| 1 | +#! /usr/bin/env python3 |
| 2 | + |
| 3 | +"""Converts Cppcheck XML version 2 output to JUnit XML format.""" |
| 4 | + |
| 5 | +import argparse |
| 6 | +import collections |
| 7 | +import os |
| 8 | +import sys |
| 9 | +from xml.etree import ElementTree |
| 10 | + |
| 11 | +__version__ = '0.1.0' |
| 12 | + |
| 13 | +EXIT_SUCCESS = 0 |
| 14 | +EXIT_FAILURE = -1 |
| 15 | + |
| 16 | + |
| 17 | +class CppcheckError(object): |
| 18 | + def __init__(self, file, line, message, severity, error_id, verbose): |
| 19 | + """Constructor. |
| 20 | +
|
| 21 | + Args: |
| 22 | + file (str): File error originated on. |
| 23 | + line (int): Line error originated on. |
| 24 | + message (str): Error message. |
| 25 | + severity (str): Severity of the error. |
| 26 | + error_id (str): Unique identifier for the error. |
| 27 | + verbose (str): Verbose error message. |
| 28 | + """ |
| 29 | + self.file = file |
| 30 | + self.line = line |
| 31 | + self.message = message |
| 32 | + self.severity = severity |
| 33 | + self.error_id = error_id |
| 34 | + self.verbose = verbose |
| 35 | + |
| 36 | + |
| 37 | +def parse_arguments(): |
| 38 | + parser = argparse.ArgumentParser(description='Converts Cppcheck XML version 2 to JUnit XML ' |
| 39 | + 'format.') |
| 40 | + parser.add_argument('input_file', type=str, help='Cppcheck XML version 2 stderr file.') |
| 41 | + parser.add_argument('output_file', type=str, help='JUnit XML output file.') |
| 42 | + return parser.parse_args() |
| 43 | + |
| 44 | + |
| 45 | +def parse_cppcheck(file_name): |
| 46 | + """Parses a Cppcheck XML version 2 file. |
| 47 | +
|
| 48 | + Args: |
| 49 | + file_name (str): Cppcheck XML file. |
| 50 | +
|
| 51 | + Returns: |
| 52 | + Dict[str, List[CppcheckError]]: Parsed errors grouped by file name. |
| 53 | +
|
| 54 | + Raises: |
| 55 | + ValueError: If unsupported Cppcheck XML version. |
| 56 | + """ |
| 57 | + root = ElementTree.parse(file_name).getroot() # type: ElementTree.Element |
| 58 | + |
| 59 | + if not int(root.get('version')) == 2: |
| 60 | + raise ValueError('Parser only supports Cppcheck XML version 2. Use --xml-version=2') |
| 61 | + |
| 62 | + error_root = root.find('errors') |
| 63 | + |
| 64 | + errors = collections.defaultdict(list) |
| 65 | + for error_element in error_root: |
| 66 | + location_element = error_element.find('location') # type: ElementTree.Element |
| 67 | + error = CppcheckError(file=location_element.get('file'), |
| 68 | + line=int(location_element.get('line')), |
| 69 | + message=error_element.get('msg'), |
| 70 | + severity=error_element.get('severity'), |
| 71 | + error_id=error_element.get('id'), |
| 72 | + verbose=error_element.get('verbose')) |
| 73 | + errors[error.file].append(error) |
| 74 | + |
| 75 | + return errors |
| 76 | + |
| 77 | + |
| 78 | +def generate_test_suite(errors, output_file): |
| 79 | + """Writes a JUnit test file from parsed Cppcheck errors. |
| 80 | +
|
| 81 | + Args: |
| 82 | + errors (Dict[str, List[CppcheckError]]): |
| 83 | + output_file (str): File path to create JUnit XML file. |
| 84 | +
|
| 85 | + Returns: |
| 86 | + Nothing. |
| 87 | + """ |
| 88 | + test_suite = ElementTree.Element('testsuite') |
| 89 | + test_suite.attrib['errors'] = str(len(errors)) |
| 90 | + test_suite.attrib['failures'] = str(0) |
| 91 | + test_suite.attrib['name'] = 'Cppcheck errors' |
| 92 | + test_suite.attrib['tests'] = str(len(errors)) |
| 93 | + test_suite.attrib['time'] = str(1) |
| 94 | + |
| 95 | + for file_name, errors in errors.items(): |
| 96 | + test_case = ElementTree.SubElement(test_suite, |
| 97 | + 'testcase', |
| 98 | + name=os.path.relpath(file_name)) |
| 99 | + for error in errors: |
| 100 | + ElementTree.SubElement(test_case, |
| 101 | + 'error', |
| 102 | + file=os.path.relpath(error.file), |
| 103 | + line=str(error.line), |
| 104 | + message='{}: {}'.format(error.line, error.message)) |
| 105 | + |
| 106 | + tree = ElementTree.ElementTree(test_suite) |
| 107 | + tree.write(output_file, encoding='utf-8', xml_declaration=True) |
| 108 | + |
| 109 | + |
| 110 | +def main(): |
| 111 | + """Main function. |
| 112 | +
|
| 113 | + Returns: |
| 114 | + int: Exit code. |
| 115 | + """ |
| 116 | + args = parse_arguments() |
| 117 | + |
| 118 | + try: |
| 119 | + errors = parse_cppcheck(args.input_file) |
| 120 | + except FileNotFoundError as e: |
| 121 | + print(str(e)) |
| 122 | + return EXIT_FAILURE |
| 123 | + |
| 124 | + if len(errors) > 0: |
| 125 | + generate_test_suite(errors, args.output_file) |
| 126 | + |
| 127 | + return EXIT_SUCCESS |
| 128 | + |
| 129 | +if __name__ == '__main__': |
| 130 | + sys.exit(main()) |
0 commit comments