File: testing.rst

package info (click to toggle)
prody 2.4.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 106,704 kB
  • sloc: python: 47,651; ansic: 6,865; cpp: 4,032; xml: 1,728; javascript: 146; makefile: 72
file content (48 lines) | stat: -rw-r--r-- 1,129 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.. _testing:

.. currentmodule:: prody

Testing ProDy
=============

.. contents::
   :local:


Running Unittests
-----------------

The easiest way to run ProDy unit tests is using nose_. The following will
run all tests::

  $ nosetests prody

To skip tests that are slow, use the following::

  $ nosetests prody -a '!slow'

To run tests for a specific module do as follows::

  $ nosetests prody.tests.atomic prody.tests.sequence


Unittest Development
--------------------

Unit test development should follow these guidelines:

  #. For comparing Python numerical types and objects, e.g. int, list, tuple,
     use methods of :class:`unittest.TestCase`.

  #. For comparing Numpy arrays, use assertions available in
     :mod:`numpy.testing` module.

  #. All test files should be stored in :file:`tests` folder in the ProDy
     package directory, i.e. :file:`prody/tests/`

  #. All tests for functions and classes in a ProDy module should be in a
     single test file named after the module,
     e.g. :file:`test_atomic/test_select.py`.

  #. Data files for testing should be located in :file:`tests/test_datafiles`.