Fixed #16817 - Added a guide of code coverage to contributing docs.

Thanks Pedro Lima for the draft patch.
This commit is contained in:
Tim Graham 2012-10-11 06:11:52 -04:00
parent 7ef2781ca0
commit 06f5da3d78
5 changed files with 31 additions and 0 deletions

2
.gitignore vendored
View File

@ -4,3 +4,5 @@
MANIFEST MANIFEST
dist/ dist/
docs/_build/ docs/_build/
tests/coverage_html/
tests/.coverage

View File

@ -4,3 +4,5 @@ syntax:glob
*.pot *.pot
*.py[co] *.py[co]
docs/_build/ docs/_build/
tests/coverage_html/
tests/.coverage

View File

@ -163,6 +163,26 @@ associated tests will be skipped.
.. _gettext: http://www.gnu.org/software/gettext/manual/gettext.html .. _gettext: http://www.gnu.org/software/gettext/manual/gettext.html
.. _selenium: http://pypi.python.org/pypi/selenium .. _selenium: http://pypi.python.org/pypi/selenium
Code coverage
~~~~~~~~~~~~~
Contributors are encouraged to run coverage on the test suite to identify areas
that need additional tests. The coverage tool installation and use is described
in :ref:`testing code coverage<topics-testing-code-coverage>`.
To run coverage on the Django test suite using the standard test settings::
coverage run ./runtests.py --settings=test_sqlite
After running coverage, generate the html report by running::
coverage html
When running coverage for the Django tests, the included ``.coveragerc``
settings file defines ``coverage_html`` as the output directory for the report
and also excludes several directories not relevant to the results
(test code or external code included in Django).
.. _contrib-apps: .. _contrib-apps:
Contrib apps Contrib apps

View File

@ -589,6 +589,8 @@ to a faster hashing algorithm::
Don't forget to also include in :setting:`PASSWORD_HASHERS` any hashing Don't forget to also include in :setting:`PASSWORD_HASHERS` any hashing
algorithm used in fixtures, if any. algorithm used in fixtures, if any.
.. _topics-testing-code-coverage:
Integration with coverage.py Integration with coverage.py
---------------------------- ----------------------------

5
tests/.coveragerc Normal file
View File

@ -0,0 +1,5 @@
[run]
omit = runtests,test_sqlite,regressiontests*,modeltests*,*/django/contrib/*/tests*,*/django/utils/unittest*,*/django/utils/simplejson*,*/django/utils/importlib.py,*/django/test/_doctest.py,*/django/core/servers/fastcgi.py,*/django/utils/autoreload.py,*/django/utils/dictconfig.py
[html]
directory = coverage_html