mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-22 19:35:13 +00:00
Add pytest coverage prompt (#396)
* Add pytest coverage prompt * Add pytest coverage prompt * Address feedback
This commit is contained in:
28
prompts/pytest-coverage.prompt.md
Normal file
28
prompts/pytest-coverage.prompt.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
agent: agent
|
||||
description: 'Run pytest tests with coverage, discover lines missing coverage, and increase coverage to 100%.'
|
||||
---
|
||||
|
||||
The goal is for the tests to cover all lines of code.
|
||||
|
||||
Generate a coverage report with:
|
||||
|
||||
pytest --cov --cov-report=annotate:cov_annotate
|
||||
|
||||
If you are checking for coverage of a specific module, you can specify it like this:
|
||||
|
||||
pytest --cov=your_module_name --cov-report=annotate:cov_annotate
|
||||
|
||||
You can also specify specific tests to run, for example:
|
||||
|
||||
pytest tests/test_your_module.py --cov=your_module_name --cov-report=annotate:cov_annotate
|
||||
|
||||
Open the cov_annotate directory to view the annotated source code.
|
||||
There will be one file per source file. If a file has 100% source coverage, it means all lines are covered by tests, so you do not need to open the file.
|
||||
|
||||
For each file that has less than 100% test coverage, find the matching file in cov_annotate and review the file.
|
||||
|
||||
If a line starts with a ! (exclamation mark), it means that the line is not covered by tests.
|
||||
Add tests to cover the missing lines.
|
||||
|
||||
Keep running the tests and improving coverage until all lines are covered.
|
||||
Reference in New Issue
Block a user