Function record_testsuite_property

src/_pytest/junitxml.py:336–371

Record a new ``<property>`` tag as child of the root ``<testsuite>``. This is suitable to writing global information regarding the entire test suite, and is compatible with ``xunit2`` JUnit family. This is a ``session``-scoped fixture which is called with ``(name, value)``. Example:

(request: FixtureRequest)

@pytest.fixture(scope=class="st">"session")
def record_testsuite_property(request: FixtureRequest) -> Callable[[str, object], None]:
    class="st">"""Record a new ``<property>`` tag as child of the root ``<testsuite>``.

    This is suitable to writing global information regarding the entire test
    suite, and is compatible with ``xunit2`` JUnit family.

    This is a ``session``-scoped fixture which is called with ``(name, value)``. Example:

    .. code-block:: python

        def test_foo(record_testsuite_property):
            record_testsuite_property(class="st">"ARCH", class="st">"PPC")
            record_testsuite_property(class="st">"STORAGE_TYPE", class="st">"CEPH")

    :param name:
        The property name.
    :param value:
        The property value. Will be converted to a string.

    .. warning::

        Currently this fixture **does not work** with the
        `pytest-xdist <https://github.com/pytest-dev/pytest-xdist>`__ plugin. See
        :issue:`7767` for details.
    class="st">"""
    __tracebackhide__ = True

    def record_func(name: str, value: object) -> None:
        class="st">""class="st">"No-op function in case --junit-xml was not passed in the command-line."class="st">""
        __tracebackhide__ = True
        _check_record_param_type(class="st">"name", name)

    xml = request.config.stash.get(xml_key, None)
    if xml is not None:
        record_func = xml.add_global_property
    return record_func


def pytest_addoption(parser: Parser) -> None: