.github/scripts/tests/junit_utils.py - main - githubmirror/nbs

.github/scripts/tests/junit_utils.py
120 строк3 KB
Nikita Menkovich
chore: get rid of need to canonize data for github actions tests (#5710)
01 май 2026, 12:11
01 май 2026, 12:11fdf62a3
from __future__ import annotations

import os
import glob
import sys
from collections.abc import Iterable, Iterator
from typing import TypeAlias
from xml.etree import ElementTree as ET

TestSuiteCase: TypeAlias = tuple[str, ET.Element, ET.Element]
SuiteCaseItem: TypeAlias = tuple[ET.Element, ET.Element, str, str]


def get_or_create_properties(testcase: ET.Element) -> ET.Element:
    props = testcase.find("properties")
    if props is None:
        props = ET.Element("properties")
        testcase.append(props)
    return props


def add_junit_link_property(testcase: ET.Element, name: str, url: str) -> None:
    add_junit_property(testcase, f"url:{name}", url)


def add_junit_property(testcase: ET.Element, name: str, value: str) -> None:
    props = get_or_create_properties(testcase)

    # remove existing property if exists
    for item in props.findall("property"):
        if item.get("name") == name:
            props.remove(item)
            break

    props.append(ET.Element("property", dict(name=name, value=value)))


def add_junit_log_property(testcase: ET.Element, url: str) -> None:
    add_junit_link_property(testcase, "Log", url)


def get_property_value(testcase: ET.Element, name: str) -> str | None:
    props = testcase.find("properties")
    if props is None:
        return None

    for prop in props.findall("property"):
        if prop.attrib["name"] == name:
            return prop.attrib["value"]
    return None


def create_error_testsuite(testcases: Iterable[ET.Element]) -> ET.ElementTree:
    testcases = list(testcases)
    n = str(len(testcases))
    suite = ET.Element("testsuite", dict(tests=n, errors=n))
    suite.extend(testcases)

    root = ET.Element("testsuites", dict(tests=n, errors=n))
    root.append(suite)
    return ET.ElementTree(root)


def create_error_testcase(
    shardname: str,
    classname: str,
    name: str,
    log_fn: str | None = None,
    log_url: str | None = None,
) -> ET.Element:
    testcase = ET.Element("testcase", dict(classname=classname, name=name))
    add_junit_property(testcase, "shard", shardname)
    if log_url:
        add_junit_log_property(testcase, log_url)

    err = ET.Element("error", dict(type="error"))

    if log_fn:
        with open(log_fn, "rt") as fp:
            err.text = fp.read(4096)
    testcase.append(err)

    return testcase


def suite_case_iterator(root: ET.Element) -> Iterator[SuiteCaseItem]:
    for suite in root.findall("testsuite"):
        for case in suite.findall("testcase"):
            cls, method = case.attrib["classname"], case.attrib["name"]
            yield suite, case, cls, method


def iter_xml_files(folder_or_file: str) -> Iterator[TestSuiteCase]:
    if os.path.isfile(folder_or_file):
        files = [folder_or_file]
    else:
        files = sorted(glob.glob(os.path.join(folder_or_file, "*.xml")))

    for fn in files:
        try:
            tree = ET.parse(fn)
        except ET.ParseError as e:
            print(f"Unable to parse {fn}: {e}", file=sys.stderr)
            continue

        root = tree.getroot()

        if root.tag == "testsuite":
            suites = [root]
        elif root.tag == "testsuites":
            suites = root.findall("testsuite")
        else:
            raise ValueError(f"Invalid root tag {root.tag}")
        for suite in suites:
            for case in suite.findall("testcase"):
                yield fn, suite, case


def is_faulty_testcase(testcase: ET.Element) -> bool:
    return testcase.find("failure") is not None or testcase.find("error") is not None