← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to doc/dev/coding.rst

  • Committer: William Grant
  • Date: 2012-06-28 01:52:02 UTC
  • Revision ID: me@williamgrant.id.au-20120628015202-f6ru7o367gt6nvgz
Hah

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/dev/coding.rst
70
70
      A quick introduction to Bazaar's core functionality.
71
71
 
72
72
 
 
73
Test Suite
 
74
==========
 
75
IVLE has a small (but growing) set of test cases. After making any significant 
 
76
changes to the codebase developers are strongly recommended to run the test 
 
77
suite and, if a test fails, correct their code or fix the test case.
 
78
 
 
79
IVLE currently uses `nose 
 
80
<http://somethingaboutorange.com/mrl/projects/nose/>`_ for its test suite. For 
 
81
simple functions the easiest way of writing a test is to use the `doctests
 
82
<http://docs.python.org/library/doctest.html>`_ style of test markup. The 
 
83
``nosetests`` script will automatically detect and run these test cases. For 
 
84
more complex tests, you will probably need to write a test module. Test 
 
85
modules are any module with a name of the form ``test_MODULENAME.py``. Any 
 
86
function with the word 'test' in it's name will be run and should throw an 
 
87
exception or fail an assert if the test case fails.
 
88
 
 
89
To run the test suite either run the ``ivle-testsuite`` script from 
 
90
``lp:~ivle-dev/ivle/dev-scripts`` or run ``IVLECONF="." nosetests`` in the top 
 
91
level directory of an IVLE checkout.
 
92
 
73
93
License
74
94
=======
75
95
IVLE is licenced under the `GNU General Public License Version 2.0