Record and show contexts when using coverage

slafs · slafs · commit 84bc7c6f90dd · 2024-05-02T15:16:32.000+02:00
As documented in https://coverage.readthedocs.io/en/7.5.0/contexts.html#dynamic-contexts While working on #11517 I wanted to see which test is best to modify for the fix. One way to easily find this out is to see which line is covered by which test. This PR adds a dynamic context setting and makes them show on the HTML coverage report. The contexts are test function names. NOTE pytest-cov plugin has even better support for pytest test names as coverage contexts, but I think this PR is already an imporovement.
diff --git a/pyproject.toml b/pyproject.toml
@@ -206,7 +206,7 @@ source = [
     "tests",
     "fastapi"
 ]
-context = '${CONTEXT}'
+dynamic_context = "test_function"
 omit = [
     "docs_src/response_model/tutorial003_04.py",
     "docs_src/response_model/tutorial003_04_py310.py",
diff --git a/scripts/test-cov-html.sh b/scripts/test-cov-html.sh
@@ -6,4 +6,4 @@ set -x
 bash scripts/test.sh ${@}
 coverage combine
 coverage report --show-missing
-coverage html
+coverage html --show-contexts

Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ source = [`
`206`	`206`	`"tests",`
`207`	`207`	`"fastapi"`
`208`	`208`	`]`
`209`		`-context = '${CONTEXT}'`
	`209`	`+dynamic_context = "test_function"`
`210`	`210`	`omit = [`
`211`	`211`	`"docs_src/response_model/tutorial003_04.py",`
`212`	`212`	`"docs_src/response_model/tutorial003_04_py310.py",`