Parallel execution in CI in PyTest - Test Execution Trace

Test Overview

This test runs multiple simple tests in parallel using pytest-xdist in a Continuous Integration (CI) environment. It verifies that tests execute concurrently and all pass successfully.

Test Code - pytest

PyTest

import pytest

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

def test_subtraction():
    assert 5 - 3 == 2

def test_multiplication():
    assert 3 * 4 == 12

def test_division():
    assert 10 / 2 == 5

# To run in parallel in CI, use: pytest -n 4

Execution Trace - 7 Steps

Step	Action	System State	Assertion	Result
1	Test runner starts with pytest and xdist plugin using '-n 4' to run 4 tests in parallel	CI environment initializes pytest with parallel workers	—	PASS
2	pytest discovers 4 test functions: test_addition, test_subtraction, test_multiplication, test_division	Test functions are ready to be executed concurrently	—	PASS
3	Each test runs in parallel worker process: test_addition runs and asserts 1 + 1 == 2	test_addition executes in worker 1	assert 1 + 1 == 2	PASS
4	test_subtraction runs in parallel worker process and asserts 5 - 3 == 2	test_subtraction executes in worker 2	assert 5 - 3 == 2	PASS
5	test_multiplication runs in parallel worker process and asserts 3 * 4 == 12	test_multiplication executes in worker 3	assert 3 * 4 == 12	PASS
6	test_division runs in parallel worker process and asserts 10 / 2 == 5	test_division executes in worker 4	assert 10 / 2 == 5	PASS
7	pytest collects results from all parallel workers and aggregates test report	CI system receives all test results	All tests passed	PASS

Failure Scenario

Failing Condition: One or more tests fail due to incorrect assertion or test error

Execution Trace Quiz - 3 Questions

What does the '-n 4' option do when running pytest in CI?

A Runs 4 tests in parallel using separate worker processes

B Runs tests sequentially 4 times

C Limits the test run to 4 tests total

D Skips 4 tests during execution

Key Result

Running tests in parallel in CI speeds up feedback but requires tests to be independent and free of shared state to avoid flaky failures.

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