.. note:: **The information on this page is obsolete, incomplete or incorrect and left here only for reference
  and has not been ported to the new documentation wiki.**

  Please refer to the `TurboGears documentation wiki`_ for up-to-date documentation.

.. _turbogears documentation wiki: http://docs.turbogears.org/

**Note:** This document was written against rev 776 on February 14, 2006.

=============
Running Tests
=============

The nose_ test framework is installed as part of the TurboGears easy_install 
process. To run the full suite of unit tests, cd to the top level of your
turbogears checkout and run::

  nosetests

This command will recursively search the working directory for directories, 
modules, and files whose names start with 'Test' or 'test'. Nose will then 
search for methods in these files starting with 'Test' or 'test' and will
execute these methods as test cases.

.. _nose : http://somethingaboutorange.com/mrl/projects/nose/

Running particular tests
------------------------

As a whole, the entire TG test suite takes very little time to run, but if you
want to restrict the tests to a particular file, run::

  nosetests -f ./path/to/testfile.py

For more details, see the `nose usage documentation`_.

.. _`nose usage documentation` : http://somethingaboutorange.com/mrl/projects/nose/#usage