pytest-cov setup - Framework Patterns

Framework Mode - pytest-cov setup

Folder Structure

project-root/
├── tests/
│   ├── test_example.py
│   └── __init__.py
├── src/
│   └── app_code.py
├── .coveragerc
├── pytest.ini
├── requirements.txt
└── README.md
  

Test Framework Layers

• Test Cases: Located in tests/ folder, contains pytest test functions.
• Application Code: In src/ folder, the code under test.
• Configuration: pytest.ini and .coveragerc files configure pytest and coverage behavior.
• Utilities: Helper functions or fixtures can be added inside tests/ or a separate tests/utils/ folder.

Configuration Patterns

Use pytest.ini to configure pytest options and enable coverage plugin:

[pytest]
addopts = --cov=src --cov-report=term-missing
  

Use .coveragerc to customize coverage settings, for example:

[run]
branch = True
source = src

[report]
exclude_lines =
    if __name__ == "__main__":
    pragma: no cover
  

Manage environment variables or credentials using pytest fixtures or external files, keeping secrets out of code.

Test Reporting and CI/CD Integration

• Coverage reports show which code lines are tested and which are missed.
• Use --cov-report=xml to generate XML reports for CI tools.
• Integrate with CI/CD pipelines (GitHub Actions, Jenkins) to run tests and collect coverage on every commit.
• Fail builds if coverage drops below a threshold using --cov-fail-under=80.

Best Practices

1. Keep tests and source code separate for clarity and maintainability.
2. Configure coverage to focus on your source code folder only, avoiding test files.
3. Use coverage exclusion rules to ignore non-testable code like if __name__ == '__main__'.
4. Run coverage in CI to ensure tests cover new code changes.
5. Keep configuration files simple and version-controlled for team consistency.

Self Check

Where would you add a new fixture that sets up a test database connection for coverage-instrumented tests?

Key Result

Organize tests in a separate folder, configure pytest.ini and .coveragerc for coverage, and integrate coverage reports into CI pipelines.

Practice

1. What is the main purpose of using pytest-cov in testing?

easy

A. To speed up test execution time

B. To measure how much of your code is tested by your tests

C. To automatically fix failing tests

D. To generate test data automatically

Solution

1. Step 1: Recall pytest-cov's core function

   pytest-cov is a plugin that tracks which parts of your code are executed during tests.

2. Step 2: Eliminate incorrect options

   Only To measure how much of your code is tested by your tests correctly describes coverage measurement, others describe unrelated features.

3. Final Answer:

   To measure how much of your code is tested by your tests -> Option B

4. Quick Check:

   pytest-cov measures coverage = A [OK]

Hint: Remember: cov means coverage, it shows tested code parts [OK]

Common Mistakes:

• Confusing coverage with test speed
• Thinking pytest-cov fixes tests
• Assuming it generates test data

2. Which command correctly installs the pytest-cov plugin?

easy

A. pip install pytest-cov

B. pip install pytest_cov

C. pip install pytestcov

D. pip install pytest coverage

Solution

1. Step 1: Recall the exact package name

   The official package name is 'pytest-cov' with a hyphen.

2. Step 2: Compare options with correct spelling

   Only pip install pytest-cov matches the correct package name and syntax.

3. Final Answer:

   pip install pytest-cov -> Option A

4. Quick Check:

   Correct package name = B [OK]

Hint: Use hyphen, not underscore or spaces in package name [OK]

Common Mistakes:

• Using underscore instead of hyphen
• Adding spaces in package name
• Misspelling the package name

3. What will be the output when running pytest --cov=my_module if all code in my_module is covered by tests?

medium

A. Tests will fail automatically

B. An error saying coverage data not found

C. No coverage report is shown

D. A coverage report showing 100% coverage for my_module

Solution

1. Step 1: Analyze the pytest --cov command

   The command runs tests and measures coverage for 'my_module'.

2. Step 2: Determine output for 100% coverage

   If all code is tested, coverage report shows 100% coverage.

3. Final Answer:

   A coverage report showing 100% coverage for my_module -> Option D

4. Quick Check:

   Full coverage means 100% report = A [OK]

Hint: Full coverage means report shows 100% coverage [OK]

Common Mistakes:

• Expecting errors when coverage is full
• Thinking coverage report is hidden by default
• Assuming tests fail if coverage is 100%

4. You run pytest --cov=my_module --cov-report=html but no HTML report is generated. What is the most likely cause?

medium

A. You forgot to install pytest-cov plugin

B. You did not specify the module name correctly

C. The HTML report is generated in a different folder

D. The tests did not run at all

Solution

1. Step 1: Check common reasons for missing HTML report

   pytest-cov generates HTML reports in a folder named 'htmlcov' by default.

2. Step 2: Understand report location

   The report is generated but may be in a folder you did not check.

3. Final Answer:

   The HTML report is generated in a different folder -> Option C

4. Quick Check:

   HTML report folder = C [OK]

Hint: Check 'htmlcov' folder for HTML report after running tests [OK]

Common Mistakes:

• Assuming plugin is not installed without checking
• Thinking report is shown in terminal only
• Believing tests must fail to generate report

5. You want to measure coverage for multiple modules mod1 and mod2 and generate both terminal and HTML reports. Which command is correct?

hard

A. pytest --cov=mod1,mod2 --cov-report=term --cov-report=html

B. pytest --cov=mod1 --cov-report=term --cov=mod2 --cov-report=term

C. pytest --cov=mod1 mod2 --cov-report=term,html

D. pytest --cov=mod1 --cov=mod2 --cov-report=term --cov-report=term

Solution

1. Step 1: Understand multiple module coverage syntax

   pytest-cov accepts multiple modules separated by commas in a single --cov option.

2. Step 2: Understand multiple report formats syntax

   Multiple reports are specified by repeating the --cov-report flag, e.g., --cov-report=term --cov-report=html.

3. Final Answer:

   pytest --cov=mod1,mod2 --cov-report=term --cov-report=html -> Option A

4. Quick Check:

   Comma for modules, repeat --cov-report = D [OK]

Hint: Use commas to list modules in one --cov option [OK]

Common Mistakes:

• Using multiple --cov options instead of comma separation
• Combining modules without commas
• Incorrectly combining report types in one option