pytest.ini configuration - Framework Patterns

Framework Mode - pytest.ini configuration

Folder Structure

project-root/
├── tests/
│   ├── test_example.py
│   └── conftest.py
├── src/
│   └── app_code.py
├── pytest.ini
└── requirements.txt
  

Test Framework Layers

• Configuration Layer: pytest.ini file to set global pytest options and markers.
• Test Layer: Test files inside tests/ folder containing test functions.
• Fixtures Layer: conftest.py for shared setup and teardown code.
• Application Layer: Source code under src/ folder.
• Utilities Layer: Helper functions or modules imported by tests or fixtures.

Configuration Patterns

The pytest.ini file is used to configure pytest behavior globally for the project.

Common configurations include:

• Markers: Define custom markers to categorize tests.
• Test paths: Specify directories or file patterns to discover tests.
• Command line options: Set default options like verbosity or capture mode.
• Logging: Configure logging levels and formats.

Example pytest.ini content:

[pytest]
minversion = 7.0
addopts = -ra -q
testpaths = tests
markers =
    smoke: Quick smoke tests
    regression: Full regression suite
log_cli = true
log_cli_level = INFO

This setup helps run tests consistently across environments without repeating command line arguments.

Test Reporting and CI/CD Integration

pytest.ini can configure reporting options such as verbosity and logging to help understand test results.

For CI/CD pipelines:

• Use addopts to include plugins like pytest-html for HTML reports.
• Configure markers to selectively run tests (e.g., smoke tests on every commit).
• Set logging to capture detailed info for debugging failures.
• Integrate pytest commands in CI scripts referencing pytest.ini for consistent runs.

Example snippet for CI usage:

pytest --html=report.html --self-contained-html

Best Practices

• Keep pytest.ini simple: Only add necessary global options to avoid confusion.
• Use markers wisely: Define clear categories for tests to run subsets easily.
• Version control pytest.ini: Keep it in the project root under version control for team consistency.
• Document markers: Add comments or documentation for custom markers in pytest.ini.
• Combine with conftest.py: Use pytest.ini for config and conftest.py for fixtures and hooks.

Self Check

Where in this framework structure would you add a new custom marker called slow to categorize tests that take longer to run?

Key Result

Use pytest.ini to centrally configure pytest options, markers, and logging for consistent test runs.

Practice

1. What is the primary purpose of the pytest.ini file in a pytest project?

easy

A. To install pytest dependencies automatically

B. To store configuration settings for pytest test runs

C. To write test functions and test cases

D. To generate test reports after running tests

Solution

1. Step 1: Understand pytest.ini role

   The pytest.ini file is used to configure pytest behavior before running tests.

2. Step 2: Differentiate from other files

   Test functions are written in Python files, not in pytest.ini. Dependency installation and report generation are handled elsewhere.

3. Final Answer:

   To store configuration settings for pytest test runs -> Option B

4. Quick Check:

   pytest.ini = config file [OK]

Hint: pytest.ini holds settings, not test code or reports [OK]

Common Mistakes:

• Confusing pytest.ini with test script files
• Thinking pytest.ini installs packages
• Assuming pytest.ini generates reports

2. Which of the following is the correct way to set the verbosity level to 2 in pytest.ini?

easy

A. [pytest]
addopts = -vv

B. [pytest]
verbosity = 2

C. [pytest]
verbosity: 2

D. [pytest]
addopts = --verbosity=2

Solution

1. Step 1: Recall pytest verbosity setting

   pytest uses addopts to pass command-line options like -vv for verbosity level 2.

2. Step 2: Check syntax correctness

   [pytest] addopts = -vv correctly uses addopts = -vv. [pytest] verbosity = 2 uses an invalid key verbosity. [pytest] verbosity: 2 uses wrong syntax with colon. [pytest] addopts = --verbosity=2 uses an invalid flag.

3. Final Answer:

   [pytest] addopts = -vv -> Option A

4. Quick Check:

   Verbosity level 2 via addopts = -vv [OK]

Hint: Use addopts with -vv for verbosity level 2 in pytest.ini [OK]

Common Mistakes:

• Using 'verbosity' instead of 'addopts'
• Incorrect syntax with colon instead of equals
• Using unsupported flags like --verbosity

3. Given this pytest.ini content:

[pytest]
markers = slow: marks tests as slow
          smoke: marks smoke tests
addopts = -rs

What will be the effect of running pytest with this configuration?

medium

A. Tests marked as slow or smoke will be skipped automatically

B. pytest will run tests with no output

C. Only tests marked as slow will run

D. pytest will show extra summary info for skipped and failed tests

Solution

1. Step 1: Understand markers and addopts

   The markers section defines labels for tests but does not skip them automatically. The addopts = -rs option tells pytest to show extra summary info for skipped and failed tests.

2. Step 2: Analyze each option

   Tests marked as slow or smoke will be skipped automatically is wrong because markers alone don't skip tests. Only tests marked as slow will run is wrong because no selection is made. pytest will run tests with no output is wrong because -rs increases output detail.

3. Final Answer:

   pytest will show extra summary info for skipped and failed tests -> Option D

4. Quick Check:

   addopts = -rs shows skip/fail summary [OK]

Hint: addopts = -rs shows skip and fail summaries [OK]

Common Mistakes:

• Thinking markers skip tests automatically
• Confusing addopts flags with test selection
• Assuming no output with -rs option

4. You added this to your pytest.ini file:

[pytest]
markers = regression
addopts = --maxfail=3

But when you run pytest, you get an error: ERROR: unknown option: --maxfail=3
What is the most likely cause?

medium

A. The addopts line should use -maxfail=3 instead

B. The pytest.ini file is missing the [pytest] header

C. The pytest version is outdated and does not support --maxfail

D. Markers must be defined after addopts in pytest.ini

Solution

1. Step 1: Understand the error message

   The error says unknown option: --maxfail=3, meaning pytest does not recognize this option.

2. Step 2: Check possible causes

   The addopts line should use -maxfail=3 instead is wrong because --maxfail requires two dashes. The pytest.ini file is missing the [pytest] header is wrong because the header is present. Markers must be defined after addopts in pytest.ini is wrong because order does not matter. The most common cause is an outdated pytest version that lacks support for --maxfail.

3. Final Answer:

   The pytest version is outdated and does not support --maxfail -> Option C

4. Quick Check:

   Unknown option usually means outdated pytest [OK]

Hint: Unknown option often means pytest version too old [OK]

Common Mistakes:

• Changing option syntax incorrectly
• Forgetting to include [pytest] header
• Thinking order of keys matters in pytest.ini

5. You want to configure pytest.ini to:
1. Mark tests with slow and critical labels.
2. Run only tests matching the pattern test_*.py.
3. Stop after 2 failures.

Which of the following pytest.ini configurations achieves all three correctly?

hard

A. [pytest]
markers = slow: slow tests
critical: critical tests
python_files = test_*.py
addopts = --maxfail=2

B. [pytest]
markers = slow
critical
python_files = test_*.py
addopts = -x --maxfail=2

C. [pytest]
markers = slow: slow tests
critical: critical tests
python_files = test_*.py
addopts = -x --maxfail=2

D. [pytest]
markers = slow: slow tests
critical: critical tests
python_files = test_*.py
addopts = --maxfail=2 -x

Solution

1. Step 1: Check markers syntax

   Options A, C, and D correctly define markers with descriptions. [pytest] markers = slow critical python_files = test_*.py addopts = -x --maxfail=2 lacks descriptions, which is allowed but less clear.

2. Step 2: Verify test file pattern

   All options set python_files = test_*.py correctly.

3. Step 3: Confirm failure stop and run options

   [pytest] markers = slow: slow tests critical: critical tests python_files = test_*.py addopts = --maxfail=2 uses addopts = --maxfail=2 which stops after 2 failures but does not stop immediately on first failure. Options C and D add -x which stops after first failure, conflicting with requirement to stop after 2 failures. [pytest] markers = slow critical python_files = test_*.py addopts = -x --maxfail=2 lacks descriptions in markers.

4. Final Answer:

   Markers with descriptions, correct python_files, and stop after 2 failures -> Option A

5. Quick Check:

   Use --maxfail=2 without -x to stop after 2 failures [OK]

Hint: Use --maxfail=2 without -x to stop after 2 failures [OK]

Common Mistakes:

• Adding -x stops after 1 failure, not 2
• Omitting marker descriptions
• Misconfiguring python_files pattern