From 397c17ffc5755d2b41ccfa01225d4f42cb9545c1 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 21 Mar 2012 10:39:04 -0500 Subject: doc: Add stub document on how to run unit tests Signed-off-by: Sol Jerome --- doc/development/index.txt | 1 + doc/development/unit-testing.txt | 25 +++++++++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 doc/development/unit-testing.txt (limited to 'doc') diff --git a/doc/development/index.txt b/doc/development/index.txt index 352000dc8..2a54bfad8 100644 --- a/doc/development/index.txt +++ b/doc/development/index.txt @@ -39,3 +39,4 @@ git access. Mail the :ref:`help-mailinglist` for details. testing documentation docstyleguide + unit-testing 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 -- cgit v1.2.3-1-g7c22