Changeset 124

Timestamp:

08/02/06 15:52:55 (2 years ago)

Author:

mk

Message:

Described in README how to run Cheesecake unit tests.

Files:

• branches/mk/README (modified) (3 diffs)
• branches/mk/setup.py (modified) (1 diff)

branches/mk/README

@@ -51 +51 @@
-called the Cheesecake index!
-
-Requirements
-------------
-
-* `pylint <http://www.logilab.org/projects/pylint>`_ is required for
-  part of the code kwalitee index computation 
-* `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ is
-  required for testing installation
-
-Usage examples
---------------
@@ -101 +93 @@
-    For more options, run cheesecake.py with -h or --help.
-
+Requirements
+------------
+
+* `pylint <http://www.logilab.org/projects/pylint>`_ is required for
+  part of the code kwalitee index computation 
+* `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ is
+  required for testing installation
+
-Obtaining the source code
--------------------------
@@ -139 +139 @@
-:Note: Generating documentation requires `epydoc <http://epydoc.sourceforge.net/>`_
-       tool installed.
+
+Unit tests
+----------
+
+We use `nose <http://somethingaboutorange.com/mrl/projects/nose/>`_ for automatic
+testing of our project, so if you want to test Cheesecake on your machine, please
+install that first. Running standard set of Cheesecake unit test is as easy as::
+
+  python setup.py test
+
+This command is equivalent of::
+
+  nosetests --verbose --with-doctest --doctest-tests --include unit --exe
+
+We also have a set of functional tests, which can be run by issuing this command::
+
+  nosetests --verbose --include functional
+
+Functional tests can take a bit longer to complete, as they test cheesecake_index
+script as a whole (opposed to testing modules and classes separately).
+
+If you happen to found any of our tests failing, please don't hesitate to contact
+us, either via
+`cheesecake-devel mailing list <http://lists.sourceforge.net/lists/listinfo/cheesecake-devel>`_
+or via `Cheesecake Trac <http://pycheesecake.org/>`_.
-
-Buildbot

branches/mk/setup.py

@@ -11 +11 @@
-os.environ['NOSE_DOCTEST_TESTS'] = 'True'
-os.environ['NOSE_INCLUDE'] = 'unit'
+os.environ['NOSE_INCLUDE_EXE'] = 'True'
-
-setup(