Changeset 660

Timestamp:

09/16/05 13:13:44

Author:

fumanchu

Message:

Some comments on test suite design and usage.

Files:

• trunk/cherrypy/test/helper.py (modified) (1 diff)
• trunk/cherrypy/test/test.py (modified) (1 diff)

trunk/cherrypy/test/helper.py

@@ -26 +26 @@
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-"""
+
+# This is a library of helper functions for the CherryPy test suite.
+# The actual script that runs the entire CP test suite is called
+# "test.py" (in this folder); test.py calls this module as a library.
+# 
+# GREAT CARE has been taken to separate this module from test.py,
+# because different consumers of each have mutually-exclusive import
+# requirements. So don't go moving functions from here into test.py,
+# or vice-versa, unless you *really* know what you're doing.
+# 
+# Usage:
+#   Each individual test_*.py module imports this module (helper),
+#   usually to make an instance of CPWebCase, and then call testmain().
+#   
+#   The CP test suite script (test.py) imports this module and calls
+#   run_test_suite, possibly more than once. CP applications may also
+#   import test.py (to use TestHarness), which then calls helper.py.
+
-
-import os, os.path

trunk/cherrypy/test/test.py

@@ -26 +26 @@
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-"""
+
+# This is the actual script that runs the entire CP test suite.
+# There is a library of helper functions for the CherryPy test suite,
+# called "helper.py" (in this folder); this module calls that as a library.
+# 
+# GREAT CARE has been taken to separate this module from helper.py,
+# because different consumers of each have mutually-exclusive import
+# requirements. So don't go moving functions from here into helper.py,
+# or vice-versa, unless you *really* know what you're doing.
+
-
-import sys