~mars/tarmac/fix-push-round-2

208 by Paul Hummer
Added HACKING document
1
=============
2
Writing Tests
3
=============
4
5
  To write tests, there are a few convenience test classes that can be used to
6
help out.  These test cases can be found in the ``tarmac.tests`` package.
7
These test cases are:
8
9
TarmacTestCase
10
==============
11
12
  Any test written should at least inherit from this test case.  It sets up a
13
test environment for configuration, etc.  It also makes sure that the test
215 by Paul Hummer
Changed documentation for TarmacTestCase.
14
environment is cleaned up when everything is completed.  Optionally,
15
TarmacTestCase can have a ``CONFIG_TEMPLATE`` attribute for use with
16
``TarmacTestCase.write_config_file`` which, when used, will write out a
17
temporary config file with the contents of the template.