PR#206: docs: how to display code coverage - fedora-qa/blockerbugs

Kamil Páral • 3 years ago

5e964df

.gitignore

file modified

+5 -1

docs/source/development.rst

file modified

docs/source/development_tasks.rst

file modified

+16

		`@@ -96,6 +96,22 @@`

		You can then continue with :ref:`initializing the environment <initializing_env>`.

		`+`
		`+ Exploring code coverage`
		`+ =======================`
		`+`
		`+ Code coverage will display which source code lines were/weren't executed as part`
		+ of the :ref:`test suite <test_suite>` execution. It will help you understand
		`+ what additional tests you should write when writing unit tests for a specific`
		`+ Python module.`
		`+`
		`+ In order to display the current code coverage, run this from the project root directory::`
		`+`
		`+ pytest --cov`
		`+`
		+ You'll see a coverage report including line numbers missing coverage in your terminal. You can also browse an interactive HTML report which highlights individual lines missing coverage in ``htmlcov/index.html``.
		`+`
		`+`
		`Release Process`
		`===============`

setup.cfg

file modified

		`@@ -36,6 +36,7 @@`
		`python_functions=test should`
		`python_files=test_* testfunc_*`
		`testpaths = testing`
		`+ addopts = --cov-config=setup.cfg --cov-report term-missing --cov-report html`
		`filterwarnings =`
		`ignore:the imp module is deprecated in favour of importlib:DeprecationWarning:koji`
		`ignore:defusedxml.cElementTree is deprecated, import from defusedxml.ElementTree instead:DeprecationWarning:openid`
		`@@ -43,3 +44,6 @@`
		`ignore:'contextfunction' is renamed to 'pass_context', the old name will be removed in Jinja 3.1.:DeprecationWarning:flask_admin`
		`ignore:The 'autoescape' extension is deprecated and will be removed in Jinja 3.1. This is built in now.:DeprecationWarning:jinja2`
		`ignore:The 'with' extension is deprecated and will be removed in Jinja 3.1. This is built in now.:DeprecationWarning:jinja2`
		`+`
		`+ [coverage:run]`
		`+ source = blockerbugs`