klab-pytest-toolkit-decorators 0.0.0__tar.gz

klab_pytest_toolkit_decorators-0.0.0/.gitignore

@@ -0,0 +1,177 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Custom ###
+pytest.xml
+pytest-coverage.txt
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

klab_pytest_toolkit_decorators-0.0.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: klab-pytest-toolkit-decorators
+Version: 0.0.0
+Summary: Pytest decorators for the Klab Pytest Toolkit
+Author-email: Burak Kizilkaya <burak.kizilkaya@outlook.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <4,>=3.11
+Requires-Dist: pytest>=8.3.5
+Description-Content-Type: text/markdown
+
+# Klab Pytest Toolkit - Decorators
+
+Custom pytest decorators for marking and annotating tests.
+
+At the moment the package provides the following decorator:
+
+- `@requirement(id: str)`: Marks a test with a requirement ID for traceability. The ID is added to the junit xml output.
+
+## Installation
+
+```bash
+pip install klab_pytest_toolkit_decorators
+```
+
+## Usage
+
+### Requirement Decorator
+
+Mark tests with requirement IDs for traceability:
+
+```python
+from klab_pytest_toolkit_decorators import requirement
+
+@requirement("REQ-001")
+def test_something():
+    assert True
+
+@requirement("REQ-002")
+async def test_async_something():
+    assert True
+```
+
+The decorator works with both synchronous and asynchronous test functions. The requirement IDs are added to the junit xml output.
+
+## License
+
+MIT

klab_pytest_toolkit_decorators-0.0.0/README.md

@@ -0,0 +1,37 @@
+# Klab Pytest Toolkit - Decorators
+
+Custom pytest decorators for marking and annotating tests.
+
+At the moment the package provides the following decorator:
+
+- `@requirement(id: str)`: Marks a test with a requirement ID for traceability. The ID is added to the junit xml output.
+
+## Installation
+
+```bash
+pip install klab_pytest_toolkit_decorators
+```
+
+## Usage
+
+### Requirement Decorator
+
+Mark tests with requirement IDs for traceability:
+
+```python
+from klab_pytest_toolkit_decorators import requirement
+
+@requirement("REQ-001")
+def test_something():
+    assert True
+
+@requirement("REQ-002")
+async def test_async_something():
+    assert True
+```
+
+The decorator works with both synchronous and asynchronous test functions. The requirement IDs are added to the junit xml output.
+
+## License
+
+MIT

klab_pytest_toolkit_decorators-0.0.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "klab-pytest-toolkit-decorators"
+dynamic = ["version"]
+description = "Pytest decorators for the Klab Pytest Toolkit"
+authors = [{ name = "Burak Kizilkaya", email = "burak.kizilkaya@outlook.com" }]
+requires-python = ">=3.11,<4"
+readme = "README.md"
+license = "MIT"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "pytest>=8.3.5",
+]
+
+[project.entry-points.pytest11]
+klab_pytest_toolkit_decorators = "klab_pytest_toolkit_decorators.plugin"
+
+[tool.hatch.version]
+path = "src/klab_pytest_toolkit_decorators/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "tests",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+pythonpath = [
+  "."
+]

klab_pytest_toolkit_decorators-0.0.0/src/klab_pytest_toolkit_decorators/__init__.py

@@ -0,0 +1,4 @@
+from klab_pytest_toolkit_decorators.compliance import requirement
+
+__version__ = "0.0.0"
+__all__ = ["requirement"]

klab_pytest_toolkit_decorators-0.0.0/src/klab_pytest_toolkit_decorators/compliance.py

@@ -0,0 +1,39 @@
+import functools
+import inspect
+from collections.abc import Awaitable, Callable
+
+import pytest
+
+
+def requirement(*req_ids):
+    """Custom decorator to mark a test with requirement ID(s) and log them in the JUnit report.
+
+    Supports multiple requirements in several ways:
+    - Single requirement: @requirement("REQ-001")
+    - Multiple arguments: @requirement("REQ-001", "REQ-002", "REQ-003")
+    - Multiple decorators: @requirement("REQ-001") @requirement("REQ-002")
+    """
+    if not req_ids:
+        raise ValueError("At least one requirement ID must be provided")
+
+    def decorator(func: Callable) -> Callable[[], Awaitable[None]]:
+        # Apply markers for each requirement ID at decoration time
+        marked_func = func
+        for req_id in req_ids:
+            marked_func = pytest.mark.requirement(req_id)(marked_func)
+
+        @functools.wraps(marked_func)
+        async def async_wrapper(*args, **kwargs):
+            return await marked_func(*args, **kwargs)
+
+        @functools.wraps(marked_func)
+        def sync_wrapper(*args, **kwargs):
+            return marked_func(*args, **kwargs)
+
+        wrapper = async_wrapper if inspect.iscoroutinefunction(func) else sync_wrapper
+        # Copy over the pytest markers to the wrapper
+        # type: ignore is needed because pytestmark is dynamically added
+        setattr(wrapper, "pytestmark", getattr(marked_func, "pytestmark", []))
+        return wrapper
+
+    return decorator

klab_pytest_toolkit_decorators-0.0.0/src/klab_pytest_toolkit_decorators/plugin.py

@@ -0,0 +1,30 @@
+"""Pytest plugin to register custom markers."""
+
+
+def pytest_configure(config):
+    """Register custom markers for klab-pytest-toolkit-decorators."""
+    config.addinivalue_line(
+        "markers", "requirement(req_id): mark test with a requirement ID for traceability"
+    )
+
+
+def pytest_collection_modifyitems(items):
+    """Add requirement IDs to test properties for JUnit XML report."""
+    for item in items:
+        # Get all requirement markers (there can be multiple)
+        requirement_markers = [m for m in item.iter_markers(name="requirement")]
+        if requirement_markers:
+            # Collect all requirement IDs
+            req_ids = []
+            for marker in requirement_markers:
+                if marker.args:
+                    req_ids.append(str(marker.args[0]))
+
+            # Add all requirements as properties for JUnit XML
+            # Can be added as comma-separated single property or individual properties
+            if req_ids:
+                # Add as comma-separated list
+                item.user_properties.append(("requirements", ", ".join(req_ids)))
+                # Also add individual properties for each requirement
+                for req_id in req_ids:
+                    item.user_properties.append(("requirement", req_id))