Addopts for default options in PyTest - Framework Patterns

Framework Mode - Addopts for default options

Folder Structure

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

Test Framework Layers

• Tests: Located in tests/ folder, contains test scripts like test_example.py.
• Fixtures & Hooks: Defined in conftest.py for setup and teardown logic shared across tests.
• Configuration: pytest.ini file holds default options using addopts to customize pytest runs.
• Dependencies: requirements.txt lists Python packages needed for testing.

Configuration Patterns

The pytest.ini file uses the addopts setting to specify default command-line options for pytest runs. This helps avoid typing options every time.

[pytest]
addopts = -v --maxfail=2 --tb=short

# Explanation:
# -v : verbose output
# --maxfail=2 : stop after 2 failures
# --tb=short : shorter traceback for failures
    

Use environment variables or separate config files for different environments if needed, but addopts is the main place for default pytest options.

Test Reporting and CI/CD Integration

Default options in addopts can include plugins for reporting, like --junitxml=reports/junit-report.xml to generate XML reports for CI tools.

[pytest]
addopts = -v --maxfail=2 --tb=short --junitxml=reports/junit-report.xml
    

CI/CD pipelines can run pytest without extra flags, relying on pytest.ini defaults. This keeps pipeline scripts simple and consistent.

Best Practices

• Use addopts in pytest.ini to set common options like verbosity and failure limits.
• Keep pytest.ini in the project root for easy discovery by pytest.
• Include reporting options in addopts for automated test reports in CI/CD.
• Avoid putting sensitive info in addopts; use environment variables or conftest.py fixtures for secrets.
• Document the purpose of each option in comments inside pytest.ini for team clarity.

Self Check

Question: Where would you add a default option to generate an HTML report automatically after tests run?

Answer: Add the option --html=report.html inside the addopts setting in the pytest.ini file at the project root.

Key Result

Use pytest.ini's addopts to set default command-line options for consistent and simple test runs.

Practice

1. What is the main purpose of the addopts setting in a pytest.ini file?

easy

A. To set default command-line options for pytest runs

B. To define test case names automatically

C. To specify the Python version for pytest

D. To list all test files explicitly

Solution

1. Step 1: Understand addopts role in pytest.ini

   addopts is used to provide default command-line options so you don't have to type them every time.

2. Step 2: Compare other options

   Other options like naming tests or Python version are not controlled by addopts.

3. Final Answer:

   To set default command-line options for pytest runs -> Option A

4. Quick Check:

   Default pytest options = addopts [OK]

Hint: Remember: addopts sets default pytest command options [OK]

Common Mistakes:

• Thinking addopts defines test names
• Confusing addopts with Python version settings
• Assuming addopts lists test files

2. Which of the following is the correct way to add default options in pytest.ini using addopts?

easy

A. [pytest]
addopts = maxfail=3 verbose

B. [pytest]
addopts: --maxfail=3 --verbose

C. [pytest]
addopts = --maxfail=3 --verbose

D. [pytest]
addopts --maxfail=3 --verbose

Solution

1. Step 1: Check correct syntax for ini files

   In pytest.ini, options are set as key = value pairs under [pytest] section.

2. Step 2: Validate option format

   Options must be space-separated strings with dashes, e.g., --maxfail=3 --verbose.

3. Final Answer:

   [pytest]\naddopts = --maxfail=3 --verbose -> Option C

4. Quick Check:

   Ini syntax uses = and spaces for addopts [OK]

Hint: Use '=' after addopts and space-separated options [OK]

Common Mistakes:

• Using ':' instead of '='
• Omitting dashes before options
• Not placing options under [pytest] section

3. Given this pytest.ini content:

[pytest]
addopts = --maxfail=2 --tb=short

What will happen when you run pytest tests/ without extra options?

medium

A. Pytest runs all tests and shows full tracebacks

B. Pytest stops after 2 failures and shows short tracebacks

C. Pytest ignores addopts and runs normally

D. Pytest throws a syntax error due to addopts

Solution

1. Step 1: Understand addopts effect on pytest run

   The options --maxfail=2 and --tb=short set limits on failures and traceback style by default.

2. Step 2: Predict behavior without extra command-line options

   Since addopts sets defaults, pytest will stop after 2 failures and show short tracebacks automatically.

3. Final Answer:

   Pytest stops after 2 failures and shows short tracebacks -> Option B

4. Quick Check:

   addopts options apply by default [OK]

Hint: Default options run automatically without typing them [OK]

Common Mistakes:

• Assuming addopts is ignored
• Thinking full tracebacks show by default
• Expecting all tests to run despite maxfail

4. You added addopts = --maxfail=1 --verbose to pytest.ini but pytest still runs all tests without stopping early. What is the likely cause?

medium

A. The pytest.ini file is not in the current directory or pytest root

B. The --maxfail option does not work with addopts

C. You must run pytest with --use-addopts flag

D. Verbose mode disables maxfail stopping

Solution

1. Step 1: Check pytest.ini location

   Pytest only reads pytest.ini if it is in the current directory or a parent directory of the test run.

2. Step 2: Understand addopts behavior

   If pytest.ini is misplaced, addopts settings are ignored and default pytest behavior occurs.

3. Final Answer:

   The pytest.ini file is not in the current directory or pytest root -> Option A

4. Quick Check:

   pytest.ini location affects addopts usage [OK]

Hint: Ensure pytest.ini is in the test root folder [OK]

Common Mistakes:

• Believing maxfail needs special flags
• Thinking verbose disables maxfail
• Ignoring pytest.ini file location

5. You want pytest to always run tests with coverage report and stop after 5 failures by default. Which addopts line in pytest.ini achieves this correctly?

hard

A. [pytest]
addopts: --cov src --maxfail=5

B. [pytest]
addopts = maxfail=5 --cov src

C. [pytest]
addopts = --maxfail=5 --cov=src --stop

D. [pytest]
addopts = --cov=src --maxfail=5

Solution

1. Step 1: Understand correct option syntax

   Coverage option requires --cov=src with equals sign; maxfail uses --maxfail=5.

2. Step 2: Check for invalid or missing syntax

   Options without '=' or extra unknown flags like --stop are incorrect.

3. Final Answer:

   [pytest]\naddopts = --cov=src --maxfail=5 -> Option D

4. Quick Check:

   Use '=' for options with values in addopts [OK]

Hint: Use '=' for options with values like --cov=src [OK]

Common Mistakes:

• Omitting '=' in options with values
• Adding unsupported flags like --stop
• Switching order without '=' causing errors