Fixture scope with parallel tests in PyTest - Framework Patterns

Framework Mode - Fixture scope with parallel tests

Folder Structure

tests/
├── test_login.py
├── test_checkout.py
├── test_profile.py
├── conftest.py
├── pytest.ini
├── requirements.txt

This structure keeps all test files inside tests/. The conftest.py file holds fixtures shared across tests.

Test Framework Layers

• Fixtures Layer: Defined in conftest.py, provides setup and teardown for tests with scopes like function, class, module, or session.
• Test Layer: Test files inside tests/ folder use fixtures by declaring them as function arguments.
• Utilities Layer: Helper functions or classes can be placed in separate modules imported by tests or fixtures.
• Configuration Layer: pytest.ini or environment variables control test runs, including parallel execution settings.

Configuration Patterns

• pytest.ini: Configure pytest options and plugins, for example enabling pytest-xdist for parallel runs.
• Fixture Scope: Use scope="function" for isolated tests, scope="session" for expensive setup shared across all tests.
• Parallel Tests: Use pytest-xdist plugin with -n option to run tests in parallel workers.
• Fixture Isolation: Avoid sharing mutable state in session-scoped fixtures when running tests in parallel to prevent conflicts.
• Environment Variables: Use environment variables or config files to pass credentials or URLs securely.

Test Reporting and CI/CD Integration

• Use pytest built-in reports or plugins like pytest-html to generate readable test reports.
• Integrate with CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on code changes.
• Configure parallel test runs in CI by setting pytest -n auto or a fixed number of workers.
• Collect and archive test reports and logs for analysis after each run.

Best Practices

1. Use the smallest fixture scope possible: Prefer function scope to avoid shared state issues in parallel tests.
2. Design fixtures to be stateless or thread-safe: Avoid mutable shared data in session or module scoped fixtures when running tests in parallel.
3. Use pytest-xdist for parallel execution: It is the standard plugin for parallel test runs in pytest.
4. Keep fixtures simple and focused: Each fixture should do one thing, making debugging easier.
5. Use autouse=False for fixtures: Explicitly request fixtures in tests to improve clarity and control.

Self Check

Where would you add a new fixture that sets up a database connection for all tests in the tests/ folder, ensuring it runs once per test session but remains safe for parallel test execution?

Key Result

Use pytest fixtures with appropriate scopes and pytest-xdist plugin to run parallel tests safely.