pytest-collect-requirements

A pytest plugin to collect test requirements from tests marked with the @pytest.mark.requirements(...) marker.
This plugin allows you to specify requirements for your tests and collect them without executing the tests themselves as default behavior.

Features

• ✅ addoption --collect-requirements to collect requirements without running tests
• ✅ addoption --save-to to specify the output file path for collected requirements (default: logs/test_requirements.json)
• ✅ addoption --execute-tests to run tests after collecting requirements
• ✅ Collect requirements from tests using the @pytest.mark.requirements() marker
• ✅ Flexible keyword arguments support for any requirement metadata (e.g., cloud instances, regions, resources)
• ✅ Automatic collection and store the requirements in json file
• ✅ Seamless integration with pytest's marker system

Installation

pip install pytest-collect-requirements

Usage Examples

Basic Usage

Mark your tests with the @pytest.mark.requirements() marker to specify infrastructure requirements:

import pytest

@pytest.mark.requirements(cloud_instance="c5.large", region="eu-west-1")
def test_my_feature():
    assert 1 == 1

Collecting Requirements

Run pytest with the --collect-requirements flag to collect all requirements without executing tests:

pytest --collect-requirements

This will collect all requirements from tests marked with @pytest.mark.requirements() and store them in the pytest config for later use.

Multiple Requirements

You can mark multiple tests with different requirements:

import pytest

@pytest.mark.requirements(cloud_instance="c5.large", region="eu-west-1")
def test_requirements():
    assert 1 == 1

@pytest.mark.requirements(cloud_instance="c5.small", region="eu-west-2")
def test_requirements2():
    assert 1 == 1

Custom Requirement Parameters

The @pytest.mark.requirements() marker accepts any keyword arguments, allowing you to define custom requirement metadata:

import pytest

@pytest.mark.requirements(
    cloud_instance="c5.large",
    region="eu-west-1",
    storage="100GB",
    network="high-speed"
)
def test_with_custom_requirements():
    assert 1 == 1

import pytest
from _pytest.fixtures import FixtureRequest

def requirements(cloud_instance: str, region: str) -> pytest.MarkDecorator:
    return pytest.mark.requirements(
        cloud_instance=cloud_instance,
        region=region,
    )


@requirements(
    cloud_instance="c5.large",
    region="eu-west-1",
)
def test_requirements_with_static_parameters(request: FixtureRequest):
    assert request.config._selected_requirements[request.node.nodeid]['region'] == "eu-west-1"

🤝 Contributing

If you have a helpful tool, pattern, or improvement to suggest: Fork the repo
Create a new branch
Submit a pull request
I welcome additions that promote clean, productive, and maintainable development.

🙏 Thanks

Thanks for exploring this repository!
Happy coding!