pytest-xdist for parallel execution - Framework Patterns

Framework Mode - pytest-xdist for parallel execution

Folder Structure

project-root/
├── tests/
│   ├── test_login.py
│   ├── test_checkout.py
│   └── test_profile.py
├── src/
│   └── app_code.py
├── utils/
│   └── helpers.py
├── conftest.py
├── pytest.ini
└── requirements.txt
    

Test Framework Layers

• Test Cases: Located in tests/, contain test functions using pytest syntax.
• Fixtures: Defined in conftest.py for setup and teardown, shared across tests.
• Utilities: Helper functions and reusable code in utils/.
• Configuration: pytest.ini for pytest settings including xdist options.
• Application Code: Source code under src/.

Configuration Patterns

Use pytest.ini to configure pytest and xdist options:

[pytest]
addopts = -n auto  # Run tests in parallel using all CPU cores

# You can also specify markers, test paths, or other options here
markers =
    smoke: quick smoke tests
    regression: full regression suite
    

Manage environments and credentials using environment variables or separate config files loaded in fixtures.

Test Reporting and CI/CD Integration

• Use pytest built-in reports or plugins like pytest-html for readable HTML reports.
• Integrate with CI/CD tools (GitHub Actions, Jenkins, GitLab CI) to run tests with pytest -n auto for parallel execution.
• Ensure test logs and reports are saved as artifacts for review.
• Configure CI to install dependencies from requirements.txt before running tests.

Best Practices

1. Use pytest-xdist to speed up test runs by running tests in parallel across CPU cores.
2. Keep tests independent: Avoid shared state or dependencies between tests to prevent flaky results in parallel runs.
3. Use fixtures wisely: Scope fixtures properly (function, module, session) to optimize setup time without conflicts.
4. Configure pytest.ini for parallel options: Use -n auto to automatically use all cores or specify number of workers.
5. Monitor resource usage: Parallel tests consume more CPU and memory; balance number of workers accordingly.

Self Check

Where in this framework structure would you add a new fixture that sets up a database connection for tests?

Key Result

Use pytest-xdist to run tests in parallel by configuring pytest.ini and keeping tests independent for faster, reliable test execution.

Practice

1. What is the main purpose of using pytest-xdist in test execution?

easy

A. To run tests in parallel and reduce total test time

B. To generate detailed HTML reports

C. To automatically fix failing tests

D. To run tests only on a single CPU core

Solution

1. Step 1: Understand pytest-xdist functionality

   pytest-xdist allows running tests simultaneously on multiple CPU cores.

2. Step 2: Identify the benefit of parallel execution

   Running tests in parallel reduces the total time needed to complete all tests.

3. Final Answer:

   To run tests in parallel and reduce total test time -> Option A

4. Quick Check:

   pytest-xdist = parallel test execution [OK]

Hint: Remember: xdist means 'distributed' tests run together [OK]

Common Mistakes:

• Confusing xdist with report generation tools
• Thinking xdist fixes test code automatically
• Assuming xdist runs tests sequentially

2. Which command correctly runs tests in parallel using 4 workers with pytest-xdist?

easy

A. pytest -n 4

B. pytest --workers=4

C. pytest -p 4

D. pytest --parallel 4

Solution

1. Step 1: Recall pytest-xdist syntax for parallelism

   The correct flag to specify number of parallel workers is -n.

2. Step 2: Match the correct command

   pytest -n 4 runs tests with 4 parallel workers.

3. Final Answer:

   pytest -n 4 -> Option A

4. Quick Check:

   -n sets workers = C [OK]

Hint: Use '-n' to set number of parallel workers [OK]

Common Mistakes:

• Using incorrect flags like --workers or --parallel
• Confusing -p (plugin) with -n
• Omitting the number after -n

3. Given this pytest command: pytest -n 3 test_sample.py, what happens during test execution?

medium

A. Tests run in parallel but limited to 1 CPU core

B. Tests in test_sample.py run sequentially on one CPU core

C. Only 3 tests from test_sample.py run sequentially

D. Tests in test_sample.py run in parallel using 3 CPU cores

Solution

1. Step 1: Analyze the command options

   The -n 3 option tells pytest-xdist to use 3 workers for parallel execution.

2. Step 2: Understand effect on test_sample.py

   All tests in test_sample.py are distributed across 3 CPU cores and run simultaneously.

3. Final Answer:

   Tests in test_sample.py run in parallel using 3 CPU cores -> Option D

4. Quick Check:

   -n 3 means 3 parallel workers = A [OK]

Hint: -n sets parallel workers, all tests split among them [OK]

Common Mistakes:

• Thinking only 3 tests run instead of all tests
• Assuming tests run sequentially despite -n
• Confusing number of workers with number of tests

4. You run pytest -n 2 but get an error: ERROR: unknown option: -n. What is the likely cause?

medium

A. You used the wrong flag; it should be --num

B. pytest-xdist plugin is not installed

C. You need to run pytest with sudo

D. The test files are missing

Solution

1. Step 1: Understand the error message

   The error says -n is unknown, meaning pytest does not recognize the option.

2. Step 2: Identify cause related to pytest-xdist

   The -n option is provided by pytest-xdist plugin. If it's not installed, pytest won't recognize it.

3. Final Answer:

   pytest-xdist plugin is not installed -> Option B

4. Quick Check:

   Unknown -n means missing xdist plugin = B [OK]

Hint: Install pytest-xdist to enable -n option [OK]

Common Mistakes:

• Assuming -n flag is built-in pytest option
• Trying to run with sudo unnecessarily
• Ignoring plugin installation step

5. You want to speed up a large test suite using pytest-xdist but notice flaky failures when running with pytest -n auto. What is a good approach to fix this?

hard

A. Disable pytest-xdist and run tests sequentially

B. Increase the number of workers beyond CPU cores

C. Add @pytest.mark.serial to tests that share state to run them sequentially

D. Use pytest -n 1 to force single worker

Solution

1. Step 1: Understand cause of flaky failures

   Tests sharing state or resources can fail when run in parallel due to conflicts.

2. Step 2: Use markers to run conflicting tests sequentially

   Marking such tests with @pytest.mark.serial (or similar) ensures they run one at a time, avoiding conflicts.

3. Step 3: Keep parallelism for other tests

   This approach balances speed and stability by running safe tests in parallel and conflicting ones sequentially.

4. Final Answer:

   Add @pytest.mark.serial to tests that share state to run them sequentially -> Option C

5. Quick Check:

   Mark shared-state tests serial to fix flakes = A [OK]

Hint: Mark shared tests serial to avoid parallel conflicts [OK]

Common Mistakes:

• Blindly increasing workers causing more flakes
• Disabling parallelism losing speed benefits
• Using -n 1 which is just sequential run