combine_results.py

#!/usr/bin/env python
"""
This script comes from cocotb/bin. It checks the result of
every test simulation.
"""

import argparse
import os
import sys
from xml.etree import ElementTree as ET


def find_all(name, path):
    for root, dirs, files in os.walk(path):
        if name in files:
            yield os.path.join(root, name)


def get_parser():
    """Return the cmdline parser"""
    parser = argparse.ArgumentParser(
        description=__doc__, formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )

    parser.add_argument(
        "--directory",
        dest="directory",
        type=str,
        required=False,
        default=".",
        help="Name of base directory to search from",
    )

    parser.add_argument(
        "--output_file",
        dest="output_file",
        type=str,
        required=False,
        default="combined_results.xml",
        help="Name of output file",
    )
    parser.add_argument(
        "--testsuites_name",
        dest="testsuites_name",
        type=str,
        required=False,
        default="results",
        help="Name value for testsuites tag",
    )
    parser.add_argument(
        "--verbose",
        dest="debug",
        action="store_const",
        required=False,
        const=True,
        default=False,
        help="Verbose/debug output",
    )
    parser.add_argument(
        "--suppress_rc",
        dest="set_rc",
        action="store_const",
        required=False,
        const=False,
        default=True,
        help="Suppress return code if failures found",
    )

    return parser


def main():
    parser = get_parser()
    args = parser.parse_args()
    rc = 0

    result = ET.Element("testsuites", name=args.testsuites_name)

    for fname in find_all("results.xml", args.directory):
        if args.debug:
            print(f"Reading file {fname}")
        tree = ET.parse(fname)
        for ts in tree.iter("testsuite"):
            if args.debug:
                print(
                    "Ts name : {}, package : {}".format(
                        ts.get("name"), ts.get("package")
                    )
                )
            use_element = None
            for existing in result:
                if existing.get("name") == ts.get("name") and existing.get(
                    "package"
                ) == ts.get("package"):
                    if args.debug:
                        print("Already found")
                    use_element = existing
                    break
            if use_element is None:
                result.append(ts)
            else:
                # for tc in ts.getiterator("testcase"):
                use_element.extend(list(ts))

    if args.debug:
        ET.dump(result)

    testsuite_count = 0
    testcase_count = 0
    for testsuite in result.iter("testsuite"):
        testsuite_count += 1
        for testcase in testsuite.iter("testcase"):
            testcase_count += 1
            for failure in testcase.iter("failure"):
                if args.set_rc:
                    rc = 1
                print(
                    "Failure in testsuite: '{}' classname: '{}' testcase: '{}' with parameters '{}'".format(
                        testsuite.get("name"),
                        testcase.get("classname"),
                        testcase.get("name"),
                        testsuite.get("package"),
                    )
                )
                if os.getenv("GITHUB_ACTIONS") is not None:
                    # Get test file relative to root of repo
                    repo_root = os.path.commonprefix(
                        [
                            os.path.abspath(testcase.get("file")),
                            os.path.abspath(__file__),
                        ]
                    )
                    relative_file = testcase.get("file").replace(repo_root, "")
                    print(
                        "::error file={},line={}::Test {}:{} failed".format(
                            relative_file,
                            testcase.get("lineno"),
                            testcase.get("classname"),
                            testcase.get("name"),
                        )
                    )

    print(f"Ran a total of {testsuite_count} TestSuites and {testcase_count} TestCases")

    ET.ElementTree(result).write(args.output_file, encoding="UTF-8")
    return rc


if __name__ == "__main__":
    rc = main()
    sys.exit(rc)