Why coverage measures test completeness in PyTest - Framework Benefits

Framework Mode - Why coverage measures test completeness

Folder Structure of a Pytest Project with Coverage

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

Test Framework Layers

• Source Code Layer: The application code inside src/.
• Test Layer: Test cases inside tests/ using pytest functions.
• Coverage Layer: Coverage tool measures which parts of source code are run by tests.
• Configuration Layer: Files like .coveragerc and pytest.ini to set coverage options and test settings.
• Utilities Layer: Fixtures or helper functions inside tests/ or separate utility modules.

Configuration Patterns for Coverage in Pytest

Use a .coveragerc file to specify coverage settings:

[run]
source = src
branch = True

[report]
show_missing = True
skip_covered = False
  

Use pytest.ini to integrate coverage plugin:

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

This setup runs tests and shows which lines of src/ are tested or missed.

Test Reporting and CI/CD Integration

• Coverage reports show percentage of code tested (line and branch coverage).
• Reports can be in terminal, HTML, XML formats for easy reading.
• CI/CD pipelines run pytest --cov to check coverage on every code change.
• Fail builds if coverage drops below a set threshold to keep tests complete.

Best Practices for Using Coverage to Measure Test Completeness

• Measure both line and branch coverage for better completeness insight.
• Configure coverage to focus on source code, excluding tests and external libraries.
• Use coverage reports to find untested code and write new tests accordingly.
• Integrate coverage checks into CI to maintain test quality over time.
• Remember coverage shows what code runs, but not if tests check correct behavior--combine with assertions.

Self Check Question

Where in this folder structure would you add a new test file to increase coverage for a new feature?

Key Result

Coverage tools measure which parts of the source code are exercised by tests, helping ensure test completeness.