openstack/cinder
Code Issues Proposed changes

Add info about code coverage job

Browse Source 
Explicitly state how to generate the code coverage report locally and
where to find it in Gerrit.

Change-Id: I38fe7675928c9fbfaeb832dab2923a0fce923cc1
This commit is contained in:
Brian Rosmaita 2022-04-07 07:05:33 -04:00
parent 85387cae8b
commit 71a2b4fc2e
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/contributor/testing.rst
View File

@ -19,6 +19,18 @@ modules involved. Mock should be used to remove any external dependencies.
All significant code changes should have unit test coverage validating the code
happy path and any failure paths.
There's a tox environment defined that will run code coverage tests for you::
tox -e cover
It will create an HTML code coverage report that you can use a web browser
to read locally from the location ``./cover/index.html`` (relative to the
location of your ``tox.ini`` file). If you are reviewing someone else's
patch in Gerrit, we have ``cinder-code-coverage`` job that generates a
coverage report that you can read. From the review page, follow:
"Zuul Summary" tab -> "cinder-code-coverage" link -> "Logs" tab. The
"raw" link next to "cover" will take you to the index page of the report.
Any proposed code change will be automatically rejected by the OpenDev
Zuul project gating system [#f1]_ if the change causes unit test failures.