pytest-requirements 0.1.0__tar.gz

pytest_requirements-0.1.0/.gitignore

@@ -0,0 +1,163 @@
+_version.py
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pytest_requirements-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,125 @@
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_COMMIT_TAG
+
+# jobs in the same stage run in parallel
+# later stages run after all jobs of previous stage were successfull
+stages:
+  - static-checks
+  - test
+  - sonarqube
+  - deploy
+
+static:
+  stage: static-checks
+  image: "python:3.10"
+
+  before_script:
+    - apt update && apt install -y --no-install-recommends git
+    - python --version
+    - pip install pre-commit
+
+  script:
+    - pre-commit run --all-files
+
+tests:
+  stage: test
+  parallel:
+    matrix:
+      - PYTHON_VERSION:
+        - "3.10"
+        - "3.11"
+        - "3.12"
+
+  image: "python:$PYTHON_VERSION"
+
+  before_script:
+    - python --version
+    - pip install -e .[test]
+
+  script:
+    - pytest -v --color=yes --doctest-modules --doctest-glob='docs/**/*.rst'
+
+# Run the coverage on the oldest supported python version
+# no special reason, just to have no "gap" in the versions in the matrix above
+tests-with-cov:
+  stage: test
+  image: "python:3.9"
+
+  before_script:
+    - python --version
+    - pip install -e .[test]
+
+  script:
+    - pytest -v --color=yes --doctest-modules --doctest-glob='docs/**/*.rst' --cov --cov-report=xml
+
+  artifacts:
+    paths:
+      - coverage.xml
+
+sonarqube:
+  stage: sonarqube
+  needs:
+    - job: tests-with-cov
+      artifacts: true
+  image:
+    name: sonarsource/sonar-scanner-cli:latest
+    entrypoint: [""]
+
+  variables:
+    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"
+    GIT_DEPTH: "0"
+
+  script:
+    - sonar-scanner -Dsonar.branch.name=${CI_COMMIT_BRANCH}
+
+build-docs:
+  stage: test
+  image: "python:3.12"
+
+  before_script:
+    - python --version
+    - pip install .[doc]
+
+  script:
+    - make -C docs html
+
+  artifacts:
+    paths:
+      - docs/build/html
+
+# actual deployment to gitlab pages, only on main
+pages:
+  stage: deploy
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_COMMIT_TAG
+  image: "python:3.12"
+  needs:
+    - job: build-docs
+      artifacts: true
+  before_script:
+    - pip install git+https://gitlab.cta-observatory.org/cta-computing/common/gitlab-multi-version-sphinx/
+  script:
+    - gitlab_multi_version_sphinx -v
+    - find public -maxdepth 1
+  artifacts:
+    paths:
+      - public
+  environment: production
+
+# Set the TWINE_PASSWORD env variable in the gitlab ci variables
+pypi:
+  image: "python:3.12"
+  stage: deploy
+  rules:
+    - if: $CI_COMMIT_TAG
+  script:
+    - pip install -U twine build
+    - python -m build
+    - twine upload dist/*
+  variables:
+    TWINE_NON_INTERACTIVE: "true"
+    TWINE_USERNAME: "__token__"

pytest_requirements-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0  # Use the ref you want to point at
+    hooks:
+    - id: trailing-whitespace
+      exclude: ".*\\.fits(\\.fz)?"
+    - id: check-added-large-files
+    - id: check-case-conflict
+    - id: check-merge-conflict
+      exclude: ".*\\.fits(\\.fz)?"
+    - id: end-of-file-fixer
+      exclude: ".*\\.fits(\\.fz)?"
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+    - id: codespell
+      additional_dependencies:
+        - tomli
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.0
+    hooks:
+      - id: ruff
+        args: [ --fix, --show-fixes ]
+      - id: ruff-format

pytest_requirements-0.1.0/CHANGES.rst

@@ -0,0 +1,6 @@
+pytest_requirements 0.1.0 (2024-11-29)
+--------------------------------------
+
+Initial release. Supports marking tests using
+``@pytest.mark.verifies_requirement("<ID>")`` and ``@pytest.mark.verifies_usecase("<ID>")``
+as well as exporting the marker information to the junit xml file.

pytest_requirements-0.1.0/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.1.0/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: pytest-requirements
+Version: 0.1.0
+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.
+
+
+Please see the [quickstart documentation](http://cta-computing.gitlab-pages.cta-observatory.org/common/pytest-requirements/latest/quickstart.html) to get started.

pytest_requirements-0.1.0/README.md

@@ -0,0 +1,7 @@
+# pytest-requirements
+
+
+pytest plugin providing markers to link tests to requirements and usecases.
+
+
+Please see the [quickstart documentation](http://cta-computing.gitlab-pages.cta-observatory.org/common/pytest-requirements/latest/quickstart.html) to get started.

pytest_requirements-0.1.0/docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -W --keep-going -n --color
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile clean
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf docs/api
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pytest_requirements-0.1.0/docs/changelog.rst

@@ -0,0 +1,7 @@
+Change Log
+==========
+
+.. changelog::
+   :towncrier: ../
+   :towncrier-skip-if-empty:
+   :changelog_file: ../CHANGES.rst

pytest_requirements-0.1.0/docs/changes/README.md

@@ -0,0 +1,22 @@
+# How to use towncrier
+
+An overview can be found [here](https://towncrier.readthedocs.io/en/stable/quickstart.html#).
+
+1. Create a new file for your changes `<MERGE REQUEST NUMBER>.<TYPE>.rst` in the corresponding folder.
+   The following types are available:
+    - feature: `New feature`
+    - bugfix: `Bugfix`
+    - api: `API Changes`
+    - optimization: `Refactoring and Optimization`
+    - maintenance: `Maintenance`
+
+2. Write a suitable message for the change:
+    ```
+    Fixed ``crazy_function`` to be consistent with ``not_so_crazy_function``
+    ```
+
+3. (For maintainers) How to generate a change log:
+    Execute the following command in the base directory of the project
+    ```
+    towncrier build --version=<VERSION NUMBER>
+    ```

pytest_requirements-0.1.0/docs/changes/template.rst

@@ -0,0 +1,43 @@
+{% if render_title %}
+{% if versiondata.name %}
+{{ versiondata.name | lower }} {{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
+{% else %}
+{{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
+{% endif %}
+{% endif %}
+
+{% for category, val in definitions.items() %}
+
+{% set underline = underlines[0] %}
+{{ definitions[category]['name'] }}
+{{ underline * definitions[category]['name']|length }}
+{% set underline = underlines[1] %}
+
+{% for section, _ in sections.items() %}
+{% if section and category in sections[section] %}
+{{section}}
+{{ underline * section|length }}
+
+{% endif %}
+{% if sections[section] and category in sections[section] %}
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ text }} [{{ values|join(', ') }}]
+
+{% endfor %}
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% if sections[section][category]|length == 0 %}
+No significant changes.
+
+{% else %}
+{% endif %}
+{% else %}
+{# No significant changes. #}
+{% endif %}
+{% endfor %}
+{% endfor %}

pytest_requirements-0.1.0/docs/conf.py

@@ -0,0 +1,37 @@
+import pytest_requirements
+
+project = "pytest_requirements"
+copyright = "CTAO"
+author = "CTAO Computing Department"
+version = pytest_requirements.__version__
+# The full version, including alpha/beta/rc tags.
+release = version
+
+
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "numpydoc",
+    "sphinx_changelog",
+]
+
+exclude_patterns = ["changes"]
+default_role = "py:obj"
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "pytest": ("https://docs.pytest.org/en/stable/", None),
+}
+
+html_theme = "ctao"
+html_theme_options = dict(
+    navigation_with_keys=False,
+    switcher=dict(
+        json_url="http://cta-computing.gitlab-pages.cta-observatory.org/common/pytest-requirements/versions.json",  # noqa: E501
+        version_match="latest" if ".dev" in version else f"v{version}",
+    ),
+    navbar_center=["version-switcher", "navbar-nav"],
+)
+
+html_static_path = []

pytest_requirements-0.1.0/docs/index.rst

@@ -0,0 +1,23 @@
+pytest-requirements
+===================
+
+Plugin to help with requirement and usecase verification using pytest.
+
+**Version**: |version| **Date**: |today|
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    quickstart
+    changelog
+
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pytest_requirements-0.1.0/docs/quickstart.rst

@@ -0,0 +1,69 @@
+Quickstart
+==========
+
+This project defines two pytest markers that allow linking of
+tests to requirement and usecase IDs.
+
+
+Installation and Setup
+----------------------
+
+To use this plugin, add it to your test dependencies, e.g. like this:
+
+.. code-block:: toml
+   :caption: ``pyproject.toml``
+   :emphasize-lines: 4
+
+   [project.optional-dependencies]
+   test = [
+     "pytest",
+     "pytest-requirements",
+     "pytest-cov",
+   ]
+
+And enable the plugin via the ``addopts`` configuration option:
+
+.. code-block:: toml
+   :caption: ``pyproject.toml``
+   :emphasize-lines: 4
+
+   [tool.pytest.ini_options]
+   minversion = "7"
+   testpaths = ["src"]
+   addopts = ["-p", "pytest_requirements"]
+
+
+Linking tests to requirements and usecases
+------------------------------------------
+
+Then you can use two markers to connect your tests to usecases and requirements:
+
+.. code-block:: python
+
+   import pytest
+
+   @pytest.mark.verifies_requirement("B-DPPS-0123")
+   def test_super_important_requirement():
+       pass
+
+
+   @pytest.mark.verifies_usecase("UC-130-2.1")
+   def test_super_important_usecase():
+       pass
+
+
+Generating XML reports
+----------------------
+
+The requirement and usecase IDs are also included in the ``junit``-style xml reports:
+
+.. code-block:: shell
+
+   $ pytest --junit-xml=report.xml
+
+``report.xml`` will contain properties for in each ``<testcase>``-node of the form:
+
+.. code-block:: xml
+
+   <property name="requirement_id" value="B-DPPS-0123" />
+   <property name="usecase_id" value="UC-123-2.1" />

pytest_requirements-0.1.0/example_tests/conftest.py

@@ -0,0 +1 @@
+pytest_plugins = ["pytest_requirements"]

pytest_requirements-0.1.0/example_tests/test_requirements.py

@@ -0,0 +1,31 @@
+import pytest
+
+
+@pytest.mark.verifies_requirement("B-DPPS-0123")
+def test_single_requirement():
+    pass
+
+
+@pytest.mark.verifies_requirement("B-DPPS-0123")
+@pytest.mark.verifies_requirement("B-DPPS-0124")
+@pytest.mark.verifies_requirement("B-DPPS-0125")
+def test_multiple_requirements():
+    pass
+
+
+@pytest.mark.verifies_usecase("UC-130-1.2")
+def test_usecase():
+    pass
+
+
+@pytest.mark.verifies_usecase("UC-130-1.2.1")
+@pytest.mark.verifies_usecase("UC-130-1.2.2")
+def test_multiple_usecases():
+    pass
+
+
+@pytest.mark.verifies_usecase("UC-130-1.2.1")
+@pytest.mark.verifies_usecase("UC-130-1.2.2")
+@pytest.mark.verifies_requirement("B-DPPS-0123")
+def test_mixed():
+    pass

pytest_requirements-0.1.0/pyproject.toml

@@ -0,0 +1,147 @@
+[build-system]
+requires = ["setuptools>=65", "setuptools_scm[toml]>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytest-requirements"
+description = "pytest plugin for using custom markers to relate tests to requirements and usecases"
+readme = "README.md"
+license = {text = "BSD-3-Clause"}
+authors = [
+    {name = "Maximilian Linhoff", email = "maximilian.linhoff@tu-dortmund.de"},
+]
+
+requires-python = ">=3.9"
+dependencies = [
+    "pytest",
+]
+
+# needed for setuptools_scm, we don"t define a static version
+dynamic = ["version"]
+
+[project.urls]
+repository = "https://gitlab.cta-observatory.org/cta-computing/common/pytest-requirements"
+documentation = "http://cta-computing.gitlab-pages.cta-observatory.org/common/pytest-requirements"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.optional-dependencies]
+test = [
+  "pytest-cov",
+]
+doc = [
+  "sphinx",
+  "numpydoc",
+  "ctao-sphinx-theme~=0.1.2",
+  "sphinx-changelog",
+]
+dev = [
+  "setuptools_scm",
+  "towncrier",
+]
+
+# we can use self-references to simplify all, needs to match project.name defined above
+all = [
+  "pytest-requirements[test,doc,dev]",
+]
+
+[tool.setuptools_scm]
+write_to = "src/pytest_requirements/_version.py"
+
+[project.entry-points.pytest11]
+pytest_requirements = "pytest_requirements"
+
+
+[tool.towncrier]
+package = "pytest_requirements"
+directory = "docs/changes"
+filename = "CHANGES.rst"
+template = "docs/changes/template.rst"
+underlines = ["-", "~", "^"]
+# Let towncrier create proper links to the merged MR.
+# By default, towncrier connects everything to issues.
+# We rather want to connect it to merge request
+issue_format = "`!{issue} <https://gitlab.cta-observatory.org/cta-computing/common/pytest-requirements/-/merge_requests/{issue}>`__"
+
+[tool.towncrier.fragment.feature]
+    name = "New Features"
+    showcontent = true
+
+[tool.towncrier.fragment.bugfix]
+    name = "Bug Fixes"
+    showcontent = true
+
+[tool.towncrier.fragment.api]
+    name = "API Changes"
+    showcontent = true
+
+[tool.towncrier.fragment.optimization]
+    name = "Refactoring and Optimization"
+    showcontent = true
+
+[tool.towncrier.fragment.maintenance]
+    name = "Maintenance"
+    showcontent = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py39"
+
+
+[tool.ruff.lint]
+extend-select = [
+    "I", # isort
+    "N", # pep8 naming
+    "D", # pydocstyle
+    "PT", # pytest
+    "UP", # pyupgrade
+    "COM", # flake8-commas
+    "ISC", # implicit string concat rules
+    "ICN", # import name conventions
+    "G", # logging
+]
+ignore = [
+    "COM812", # incompatible with ruff format
+    "ISC001", # incompatible with ruff format
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.per-file-ignores]
+# no documentation linting for test files
+"**/tests/**" = ["D"]
+"**/test_*.py" = ["D"]
+"**/conftest.py" = ["D"]
+"example_tests/**.py" = ["D"]
+"docs/**/*.py" = ["D"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.isort]
+profile = "black"
+line_length = 88
+
+[tool.coverage.run]
+relative_files = true
+source = ["src"]
+omit = [
+    "src/pytest_requirements/_version.py",
+]
+
+[tool.pytest.ini_options]
+minversion = "7"
+testpaths = ["src"]
+log_cli_level = "INFO"
+xfail_strict = true
+# print summary of failed tests, force errors if settings are misspelled
+addopts = ["-p", "pytester", "-ra", "--strict-config", "--strict-markers"]
+filterwarnings = [
+    "error",
+]
+pytester_example_dir = "example_tests"

pytest_requirements-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pytest_requirements-0.1.0/sonar-project.properties

@@ -0,0 +1,9 @@
+sonar.projectKey=cta-computing_common_pytest-requirements_AZN0FJNnAfB1AuE28RjL
+sonar.host.url=https://sonar-cta-dpps.zeuthen.desy.de
+sonar.qualitygate.wait=true
+sonar.language=python
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.version=3
+
+# ignore some files not relevant for testing so they don't count towards missing coverage
+sonar.exclusions=src/pytest_requirements/version.py,docs/conf.py,example_tests/**

pytest_requirements-0.1.0/src/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-0.1.0/src/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.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)

pytest_requirements-0.1.0/src/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.1.0/src/pytest_requirements.egg-info/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: pytest-requirements
+Version: 0.1.0
+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.
+
+
+Please see the [quickstart documentation](http://cta-computing.gitlab-pages.cta-observatory.org/common/pytest-requirements/latest/quickstart.html) to get started.

pytest_requirements-0.1.0/src/pytest_requirements.egg-info/SOURCES.txt

@@ -0,0 +1,26 @@
+.gitignore
+.gitlab-ci.yml
+.pre-commit-config.yaml
+CHANGES.rst
+LICENSE
+README.md
+pyproject.toml
+sonar-project.properties
+docs/Makefile
+docs/changelog.rst
+docs/conf.py
+docs/index.rst
+docs/quickstart.rst
+docs/changes/README.md
+docs/changes/template.rst
+example_tests/conftest.py
+example_tests/test_requirements.py
+src/pytest_requirements/__init__.py
+src/pytest_requirements/_version.py
+src/pytest_requirements/test_plugin.py
+src/pytest_requirements.egg-info/PKG-INFO
+src/pytest_requirements.egg-info/SOURCES.txt
+src/pytest_requirements.egg-info/dependency_links.txt
+src/pytest_requirements.egg-info/entry_points.txt
+src/pytest_requirements.egg-info/requires.txt
+src/pytest_requirements.egg-info/top_level.txt

pytest_requirements-0.1.0/src/pytest_requirements.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pytest_requirements-0.1.0/src/pytest_requirements.egg-info/entry_points.txt

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

pytest_requirements-0.1.0/src/pytest_requirements.egg-info/requires.txt

@@ -0,0 +1,17 @@
+pytest
+
+[all]
+pytest-requirements[dev,doc,test]
+
+[dev]
+setuptools_scm
+towncrier
+
+[doc]
+sphinx
+numpydoc
+ctao-sphinx-theme~=0.1.2
+sphinx-changelog
+
+[test]
+pytest-cov

pytest_requirements-0.1.0/src/pytest_requirements.egg-info/top_level.txt

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