innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Added 'Unit tests' section to docs/contributing.txt 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@1906 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2006-01-11 05:54:27 +00:00
parent d062e6278d
commit ef60a399b3
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/contributing.txt
View File

@ -211,6 +211,38 @@ repository:
Subversion and Trac so that any commit message in that format will Subversion and Trac so that any commit message in that format will
automatically post a comment to the appropriate ticket. automatically post a comment to the appropriate ticket.
Unit tests
==========
Django comes with a test suite of its own, in the ``tests`` directory of the
Django tarball. It's our policy to make sure all tests pass at all times.
The tests cover:
* Models and the database API (``tests/testapp/models``).
* The cache system (``tests/otherthests/cache.py``).
* The ``django.utils.dateformat`` module (``tests/othertests/dateformat.py``).
* Database typecasts (``tests/othertests/db_typecasts.py``).
* The template system (``tests/othertests/templates.py`` and
``tests/othertests/defaultfilters.py``).
* ``QueryDict`` objects (``tests/othertests/httpwrappers.py``).
* Markup template tags (``tests/othertests/markup.py``).
* The ``django.utils.timesince`` module (``tests/othertests/timesince.py``).
We appreciate any and all contributions to the test suite!
Running the unit tests
----------------------
To run the tests, ``cd`` to the ``tests/`` directory and type::
./runtests.py --settings=path.to.django.settings
Yes, the unit tests need a settings module, but only for database connection
info -- the ``DATABASE_ENGINE``, ``DATABASE_USER`` and ``DATABASE_PASSWORD``.
The unit tests will not touch your database; they create a new database, called
``django_test_db``, which is deleted when the tests are finished.
Requesting features Requesting features
=================== ===================
@ -390,4 +422,4 @@ requests for commit access are potential flame-war starters, and will be ignored
.. _PEP 8: http://www.python.org/peps/pep-0008.html .. _PEP 8: http://www.python.org/peps/pep-0008.html
.. _i18n documentation: http://www.djangoproject.com/documentation/i18n/ .. _i18n documentation: http://www.djangoproject.com/documentation/i18n/
.. _i18n branch: http://code.djangoproject.com/browser/django/branches/i18n .. _i18n branch: http://code.djangoproject.com/browser/django/branches/i18n
.. _`tags/releases`: http://code.djangoproject.com/browser/django/tags/releases .. _`tags/releases`: http://code.djangoproject.com/browser/django/tags/releases