Sync doc/tutorial.txt splash text with hooke.ui.UserInterface._splash_text.
[hooke.git] / doc / testing.txt
1 *************
2 Testing Hooke
3 *************
4
5 Hooke's test framework is build using doctest_, unittest_, and nose_.
6 `nosetests` (from the `nose` package) scans through the source
7 tree, searching out the various tests and running them.  If you aren't
8 familiar with `nose`, there is excellent documentation on its home
9 page.  We use `nose` because its auto-discovery allows us to avoid
10 collecting all of our assorted tests into `unittest.TestSuite`\s and
11 running them by hand.
12
13 To run the test suite from the Hooke installation directory, just use::
14
15     nosetests --with-doctest --doctest-tests
16
17 .. _doctest: http://docs.python.org/library/doctest.html
18 .. _unittest: http://docs.python.org/library/unittest.html
19 .. _nose: http://somethingaboutorange.com/mrl/projects/nose/0.11.3/
20
21
22 Adding tests to modules
23 -----------------------
24
25 Just go crazy with doctests and unittests; `nose` will find them.