summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2012-10-11 06:11:52 -0400
committerTim Graham <timograham@gmail.com>2012-10-11 06:14:24 -0400
commit3ac70a5907e054c734ca26e435f1ec1215797b08 (patch)
treeb97537f3330d6484e145d0bc3f3f1eef4ea5d909 /docs
parent1be0515fe9940a7a727680a775395fe5f0c12b1d (diff)
[1.4.X] Fixed #16817 - Added a guide of code coverage to contributing docs.
Thanks Pedro Lima for the draft patch. Backport of 06f5da3d78 from master
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/contributing/writing-code/unit-tests.txt20
-rw-r--r--docs/topics/testing.txt2
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt
index 9f5f9b0bef..3e791c09a1 100644
--- a/docs/internals/contributing/writing-code/unit-tests.txt
+++ b/docs/internals/contributing/writing-code/unit-tests.txt
@@ -165,6 +165,26 @@ associated tests will be skipped.
.. _gettext: http://www.gnu.org/software/gettext/manual/gettext.html
.. _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
diff --git a/docs/topics/testing.txt b/docs/topics/testing.txt
index 3e9c048820..7ef33afe91 100644
--- a/docs/topics/testing.txt
+++ b/docs/topics/testing.txt
@@ -575,6 +575,8 @@ to a faster hashing algorithm::
Don't forget to also include in :setting:`PASSWORD_HASHERS` any hashing
algorithm used in fixtures, if any.
+.. _topics-testing-code-coverage:
+
Integration with coverage.py
----------------------------