summaryrefslogtreecommitdiffstats
path: root/doc/development/unit-testing.txt
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2012-03-21 10:39:04 -0500
committerSol Jerome <sol.jerome@gmail.com>2012-03-21 10:39:04 -0500
commit397c17ffc5755d2b41ccfa01225d4f42cb9545c1 (patch)
treee83c9ebafac6ffa0d6a9995f12d09927bb4f88cf /doc/development/unit-testing.txt
parentd939fc920fe5d69768b017c873f1bbef5f4b2795 (diff)
downloadbcfg2-397c17ffc5755d2b41ccfa01225d4f42cb9545c1.tar.gz
bcfg2-397c17ffc5755d2b41ccfa01225d4f42cb9545c1.tar.bz2
bcfg2-397c17ffc5755d2b41ccfa01225d4f42cb9545c1.zip
doc: Add stub document on how to run unit tests
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/development/unit-testing.txt')
-rw-r--r--doc/development/unit-testing.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/development/unit-testing.txt b/doc/development/unit-testing.txt
new file mode 100644
index 000000000..30217dcc5
--- /dev/null
+++ b/doc/development/unit-testing.txt
@@ -0,0 +1,25 @@
+.. -*- mode: rst -*-
+
+.. _development-unit-testing:
+
+==================
+Bcfg2 unit testing
+==================
+
+.. _Python Mock Module: http://python-mock.sourceforge.net/
+.. _Python Nose: http://readthedocs.org/docs/nose/en/latest/
+
+You will first need to install the `Python Mock Module`_ and `Python
+Nose`_ modules. You can then run the existing tests with the
+following.::
+
+ cd testsuite
+ nosetests
+
+You should see output something like the following::
+
+ ..................................................
+ ----------------------------------------------------------------------
+ Ran 50 tests in 0.121s
+
+ OK