Parallel execution in CI in PyTest - Build an Automation Script

Run pytest tests in parallel on CI pipeline

Preconditions (3)

Step 1: Configure the CI pipeline to install dependencies including pytest and pytest-xdist

Step 2: Run pytest with the -n option to enable parallel execution, e.g., pytest -n 4

Step 3: Observe the test execution running tests in parallel

Step 4: Verify that all tests pass successfully

Step 5: Check the CI test report for correct test results

✅ Expected Result: Tests run in parallel on 4 workers, all tests pass, and CI shows a successful test report

Automation Requirements - pytest

Assertions Needed:

All tests pass without errors or failures

Test execution time is reduced compared to sequential run

Best Practices:

Use pytest-xdist plugin for parallel execution

Avoid shared state or use fixtures with proper scope to prevent conflicts

Use explicit waits or synchronization if tests interact with shared resources

Configure CI pipeline to install dependencies and run tests with parallel flag

Automated Solution

PyTest

import pytest

# Sample test file: test_sample.py

def test_one():
    assert 1 + 1 == 2

def test_two():
    assert 'hello'.upper() == 'HELLO'

def test_three():
    assert len([1, 2, 3]) == 3

# To run in CI, use the command:
# pytest -n 4 --dist=loadscope

# This requires pytest-xdist installed:
# pip install pytest-xdist

# In CI pipeline script (example):
# python -m pip install -r requirements.txt
# pytest -n 4 --dist=loadscope

The code defines simple pytest tests to demonstrate parallel execution.

We use the -n 4 option with pytest to run tests on 4 parallel workers.

The --dist=loadscope option helps distribute tests by scope to avoid conflicts.

In the CI pipeline, dependencies including pytest and pytest-xdist must be installed before running tests.

This setup reduces total test time by running tests concurrently.

Common Mistakes - 3 Pitfalls

Not installing pytest-xdist plugin in CI environment

Running tests in parallel that share state without isolation

Hardcoding number of workers without considering CI environment resources

Bonus Challenge

Now add data-driven testing with 3 different inputs and run them in parallel in CI

Show Hint

Practice

1. What is the main benefit of using parallel execution in pytest within a CI environment?

easy

A. It disables flaky tests to improve stability.

B. It automatically fixes failing tests during execution.

C. It generates detailed test coverage reports.

D. It runs multiple tests at the same time to reduce total test time.

Solution

1. Step 1: Understand parallel execution purpose

   Parallel execution means running tests simultaneously instead of one by one.

2. Step 2: Identify benefit in CI context

   Running tests at the same time reduces the total time needed to finish all tests in CI.

3. Final Answer:

   It runs multiple tests at the same time to reduce total test time. -> Option D

4. Quick Check:

   Parallel execution = faster test runs [OK]

Hint: Parallel means multiple tests run together, saving time [OK]

Common Mistakes:

• Confusing parallel execution with automatic bug fixing
• Thinking it generates reports automatically
• Assuming it disables tests instead of running them

2. Which command correctly enables parallel test execution using pytest-xdist with 4 workers?

easy

A. pytest -n 4

B. pytest --workers=4

C. pytest --parallel=4

D. pytest -p xdist 4

Solution

1. Step 1: Recall pytest-xdist syntax

   The pytest-xdist plugin uses the option -n followed by the number of workers.

2. Step 2: Match correct command

   The correct command to run tests in parallel with 4 workers is pytest -n 4.

3. Final Answer:

   pytest -n 4 -> Option A

4. Quick Check:

   Use -n to set worker count [OK]

Hint: Remember: -n sets number of parallel workers [OK]

Common Mistakes:

• Using --workers instead of -n
• Adding number without -n option
• Misplacing plugin name in command

3. Given this pytest command in CI: pytest -n 3 tests/, what is the expected behavior?

medium

A. Tests in the 'tests/' folder run sequentially on one worker.

B. Tests in the 'tests/' folder run in parallel on 3 workers.

C. Only 3 tests will run from the 'tests/' folder.

D. Tests will run with 3 retries on failure.

Solution

1. Step 1: Analyze the command options

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

2. Step 2: Understand test execution effect

   All tests in the 'tests/' folder will be distributed and run simultaneously on 3 workers.

3. Final Answer:

   Tests in the 'tests/' folder run in parallel on 3 workers. -> Option B

4. Quick Check:

   -n 3 means 3 parallel workers [OK]

Hint: -n 3 means run tests on 3 parallel workers [OK]

Common Mistakes:

• Thinking only 3 tests run total
• Assuming tests run sequentially
• Confusing retries with parallelism

4. You added pytest -n 4 in your CI but tests still run sequentially. What is the most likely cause?

medium

A. The tests folder is empty, so no tests run.

B. You need to add --parallel option instead of -n.

C. pytest-xdist plugin is not installed in the CI environment.

D. You must specify the number of retries for parallel to work.

Solution

1. Step 1: Check plugin requirement for parallelism

   pytest-xdist plugin must be installed to enable -n parallel execution.

2. Step 2: Identify cause of sequential runs

   If plugin is missing, pytest ignores -n and runs tests sequentially.

3. Final Answer:

   pytest-xdist plugin is not installed in the CI environment. -> Option C

4. Quick Check:

   Missing plugin causes no parallelism [OK]

Hint: Parallel needs pytest-xdist installed to work [OK]

Common Mistakes:

• Using wrong option like --parallel
• Assuming empty folder causes sequential runs
• Confusing retries with parallel execution

5. In a CI pipeline, you want to run tests in parallel but limit each worker to use only one CPU core to avoid overload. Which pytest-xdist option helps achieve this?

hard

A. Use pytest -n auto --dist loadscope to auto assign workers with load balancing.

B. Use pytest -n 4 --max-worker-threads=1 to limit threads per worker.

C. Use pytest -n 4 --boxed to isolate each test in a subprocess.

D. Use pytest -n 4 --max-worker-memory=1G to limit memory per worker.

Solution

1. Step 1: Understand CPU core limitation in pytest-xdist

   pytest-xdist can auto detect CPU cores and assign workers accordingly using -n auto.

2. Step 2: Use load balancing to distribute tests efficiently

   The --dist loadscope option balances tests to avoid overloading any worker.

3. Final Answer:

   Use pytest -n auto --dist loadscope to auto assign workers with load balancing. -> Option A

4. Quick Check:

   -n auto with loadscope balances CPU load [OK]

Hint: -n auto with --dist loadscope balances CPU load per worker [OK]

Common Mistakes:

• Using non-existent options like --max-worker-threads
• Confusing --boxed with CPU core limits
• Trying to limit memory instead of CPU