pytest-requirements 0.0.0.dev0__py3-none-any.whl

pytest_requirements/__init__.py

@@ -0,0 +1,31 @@
+"""pytest plugin providing markers to link tests to requirements and usecases."""
+
+from ._version import __version__
+
+
+def pytest_configure(config):
+    """Register our custom markers."""
+    config.addinivalue_line(
+        "markers",
+        "verifies_requirement(requirement_id): Mark this test as verification for a requirement",
+    )
+    config.addinivalue_line(
+        "markers",
+        "verifies_usecase(usecase_id): Mark this test as verification for a usecase",
+    )
+
+
+def pytest_collection_modifyitems(session, config, items):
+    """Customize test collection.
+
+    - Make sure requirement/usecase marker information is written to junit xml.
+    """
+    for item in items:
+        for type_ in ("requirement", "usecase"):
+            for marker in item.iter_markers(name=f"verifies_{type_}"):
+                item.user_properties.append((f"{type_}_id", marker.args[0]))
+
+
+__all__ = [
+    "__version__",
+]

pytest_requirements/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.0.0.dev0'
+__version_tuple__ = version_tuple = (0, 0, 0, 'dev0')

pytest_requirements/test_plugin.py

@@ -0,0 +1,65 @@
+from xml.etree import ElementTree as ET
+
+EXPECTED = {
+    "test_single_requirement": {
+        "requirements": ["B-DPPS-0123"],
+        "usecases": [],
+    },
+    "test_multiple_requirements": {
+        "requirements": ["B-DPPS-0123", "B-DPPS-0124", "B-DPPS-0125"],
+        "usecases": [],
+    },
+    "test_usecase": {
+        "requirements": [],
+        "usecases": ["UC-130-1.2"],
+    },
+    "test_multiple_usecases": {
+        "requirements": [],
+        "usecases": ["UC-130-1.2.1", "UC-130-1.2.2"],
+    },
+    "test_mixed": {
+        "requirements": ["B-DPPS-0123"],
+        "usecases": ["UC-130-1.2.1", "UC-130-1.2.2"],
+    },
+}
+
+
+def collect_markers(test_case):
+    markers = {"requirements": [], "usecases": []}
+    for prop in test_case.iter("property"):
+        if prop.attrib["name"] == "requirement_id":
+            markers["requirements"].append(prop.attrib["value"])
+        elif prop.attrib["name"] == "usecase_id":
+            markers["usecases"].append(prop.attrib["value"])
+    return markers
+
+
+def test_plugin(pytester, tmp_path):
+    pytester.copy_example("conftest.py")
+    pytester.copy_example("test_requirements.py")
+
+    report_path = tmp_path / "report.xml"
+    result = pytester.runpytest(f"--junit-xml={report_path}")
+
+    result.assert_outcomes(passed=5)
+
+    # make sure the marker information is in the junit xml
+    tree = ET.parse(report_path)
+
+    test_cases = {
+        test_case.attrib["name"]: test_case for test_case in tree.iter("testcase")
+    }
+    assert len(test_cases) == 5
+
+    for key, expected in EXPECTED.items():
+        markers = collect_markers(test_cases[key])
+        for type_, expected_ids in expected.items():
+            ids = markers[type_]
+            assert len(ids) == len(expected_ids)
+            assert set(ids) == set(expected_ids)
+
+
+def test_version():
+    from pytest_requirements import __version__
+
+    assert __version__ != "0.0.0"

pytest_requirements-0.0.0.dev0.dist-info/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Cherenkov Telescope Array Observatory
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pytest_requirements-0.0.0.dev0.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: pytest-requirements
+Version: 0.0.0.dev0
+Summary: pytest plugin for using custom markers to relate tests to requirements and usecases
+Author-email: Maximilian Linhoff <maximilian.linhoff@tu-dortmund.de>
+License: BSD-3-Clause
+Project-URL: repository, https://gitlab.cta-observatory.org/cta-computing/common/pytest-requirements
+Project-URL: documentation, http://cta-computing.gitlab-pages.cta-observatory.org/common/pytest-requirements
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest
+Provides-Extra: test
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: numpydoc; extra == "doc"
+Requires-Dist: ctao-sphinx-theme~=0.1.2; extra == "doc"
+Requires-Dist: sphinx-changelog; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: setuptools_scm; extra == "dev"
+Requires-Dist: towncrier; extra == "dev"
+Provides-Extra: all
+Requires-Dist: pytest-requirements[dev,doc,test]; extra == "all"
+
+# pytest-requirements
+
+
+pytest plugin providing markers to link tests to requirements and usecases.

pytest_requirements-0.0.0.dev0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pytest_requirements/__init__.py,sha256=XZeJ_9nUUhgmNMcqRzUP3Z11s_i1goUS6JBjwM20pd8,919
+pytest_requirements/_version.py,sha256=qharzApsLGL2RoMhav5KFtnE6oeBEGFs89k6qEvDTIw,424
+pytest_requirements/test_plugin.py,sha256=nJP6Ldwg_VNp1A5LzFO9Tm3k_VFsHR_r27OwC_I5EjQ,1902
+pytest_requirements-0.0.0.dev0.dist-info/LICENSE,sha256=HuMcEyFbhXPlPf_O6TOBJ_8hKr6W8TYvHT3_fjD_I8I,1545
+pytest_requirements-0.0.0.dev0.dist-info/METADATA,sha256=R9HfjnCgroEvtSVMGIHuLmaNmdSftve6PILfMxdsVKs,1128
+pytest_requirements-0.0.0.dev0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+pytest_requirements-0.0.0.dev0.dist-info/entry_points.txt,sha256=AhCBkNfLFg5eLzf22fHGtELkERhn2UftIDJK3zcMf2Q,53
+pytest_requirements-0.0.0.dev0.dist-info/top_level.txt,sha256=u-AZz9GFmd0-7TSON3fmUWvttA1V84wsE8bFWLwZ0iE,20
+pytest_requirements-0.0.0.dev0.dist-info/RECORD,,

pytest_requirements-0.0.0.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pytest_requirements-0.0.0.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+pytest_requirements = pytest_requirements

pytest_requirements-0.0.0.dev0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pytest_requirements