ctest_measurements_reporter.py

Go to the documentation of this file.

 
import os
import re
import xml.sax.saxutils as XSS
 
# This plugin integrates with pytest to capture and report test results
# in a format compatible with CTest using DartMeasurement tags
 
# Key functions and hooks include:
# - sanitize_for_xml: Sanitizes a string by escaping non-XML characters.
# - pytest_configure: Initializes a dictionary to store test suite properties.
# - pytest_runtest_makereport: Collects information about failing tests and
# exceptions during test execution.
# - pytest_sessionfinish: Outputs the collected test information in a format
# suitable for CTest.
 
 
def sanitize_for_xml(data):
    bad_chars = re.compile("[\x00-\x08\x0b\x0c\x0e-\x1f\ud800-\udfff\ufffe\uffff]")
 
    def quote(match):
        "helper function"
        return "".join("[NON-XML-CHAR-0x%2X]" % ord(c) for c in match.group())
 
    return bad_chars.sub(quote, data)
 
 
def pytest_sessionstart(session):
    # list passed, failed and skipped tests
    session.results = {"pass": set(), "fail": set(), "skip": set()}
    # make sure CTest does not drop output lines on successful tests
    print("CTEST_FULL_OUTPUT")
 
 
def _skipped_item(item):
    if any(item.iter_markers(name="skip")):
        return True
    if any(mark.args[0] for mark in item.iter_markers(name="skipif")):
        return True
    return False
 
 
def pytest_runtest_makereport(item, call):
    name = (
        f"{item.cls.__name__}.{item.name}"
        if hasattr(item, "cls") and item.cls is not None
        else item.name
    )
    result = None
 
    if call.when == "setup":
        if _skipped_item(item):
            result = "skip"
    elif call.when == "call":
        if call.excinfo is not None:
            if call.excinfo.typename == "Skipped":
                result = "skip"
            else:
                result = "fail"
                item.user_properties.append(("exception_info", str(call.excinfo.value)))
        else:
            result = "pass"
 
    if result is not None:
        item.session.results[result].add(name)
 
 
def pytest_sessionfinish(session, exitstatus):
    if not hasattr(session, "items"):
        # no test run, nothing to report
        return
    if os.environ.get("DISABLE_CTEST_MEASUREMENTS") == "1":
        # user requested to disable CTest measurements printouts
        return
 
    results = list((name, sorted(value)) for name, value in session.results.items())
 
    prefix = ""
    for item in session.items:
        prefix = (
            f"{item.cls.__name__}.{item.name}"
            if hasattr(item, "cls") and item.cls is not None
            else item.name
        )
        for name, value in item.user_properties:
            results.append((f"{prefix}.{name}", value))
 
    if hasattr(session, "sources"):
        results.extend(
            (f"{name}.source_code", value) for name, value in session.sources.items()
        )
 
    if hasattr(session, "docstrings"):
        results.extend(
            (f"{name}.doc", value) for name, value in session.docstrings.items()
        )
 
    ignore_keys = {"test_fixture_setup.completed_process"}
    template = (
        '<DartMeasurement type="text/string" name="{name}">{value}</DartMeasurement>'
    )
 
    to_print = [
        (key, value)
        for key, value in results
        if not any(key.endswith(ignore_key) for ignore_key in ignore_keys) and value
    ]
    for key, value in to_print:
        sanitized_value = XSS.escape(sanitize_for_xml(str(value)))
        # workaround for a limitation of CTestXML2HTML
        key = key.replace("/", "_")
        print(template.format(name=key, value=sanitized_value), end="")