/usr/lib/python2.7/dist-packages/cherrypy/test/helper.py is in python-cherrypy 2.3.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | """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.
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.
"""
# 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.
import re
import sys
import thread
import cherrypy
from cherrypy.lib import httptools
import webtest
class CPWebCase(webtest.WebCase):
mount_point = ""
scheme = "http"
def prefix(self):
return self.mount_point.rstrip("/")
def exit(self):
sys.exit()
def tearDown(self):
pass
def getPage(self, url, headers=None, method="GET", body=None, protocol="HTTP/1.1"):
"""Open the url. Return status, headers, body."""
if self.mount_point:
url = httptools.urljoin(self.mount_point, url)
webtest.WebCase.getPage(self, url, headers, method, body, protocol)
def assertErrorPage(self, status, message=None, pattern=''):
""" Compare the response body with a built in error page.
The function will optionally look for the regexp pattern,
within the exception embedded in the error page.
"""
# This will never contain a traceback:
page = cherrypy._cputil.getErrorPage(status, message=message)
# First, test the response body without checking the traceback.
# Stick a match-all group (.*) in to grab the traceback.
esc = re.escape
epage = esc(page)
epage = epage.replace(esc('<pre id="traceback"></pre>'),
esc('<pre id="traceback">')
+ '(.*)' + esc('</pre>'))
m = re.match(epage, self.body, re.DOTALL)
if not m:
self._handlewebError('Error page does not match\n' + page)
return
# Now test the pattern against the traceback
if pattern is None:
# Special-case None to mean that there should be *no* traceback.
if m and m.group(1):
self._handlewebError('Error page contains traceback')
else:
if (m is None) or (not re.search(re.escape(pattern), m.group(1))):
msg = 'Error page does not contain %s in traceback'
self._handlewebError(msg % repr(pattern))
CPTestLoader = webtest.ReloadingTestLoader()
CPTestRunner = webtest.TerseTestRunner(verbosity=2)
def setConfig(conf):
"""Set the config using a copy of conf."""
if isinstance(conf, basestring):
# assume it's a filename
cherrypy.config.update(file=conf)
else:
cherrypy.config.update(conf.copy())
def run_test_suite(moduleNames, server, conf):
"""Run the given test modules using the given server and conf.
The server is started and stopped once, regardless of the number
of test modules. The config, however, is reset for each module.
"""
setConfig(conf)
# The Pybots automatic testing system needs the suite to exit
# with a non-zero value if there were any problems.
# Might as well stick it in the server... :/
cherrypy.server.test_success = True
cherrypy.server.start_with_callback(_run_test_suite_thread,
args = (moduleNames, conf),
server_class = server)
if cherrypy.server.test_success:
return 0
else:
return 1
def _run_test_suite_thread(moduleNames, conf):
for testmod in moduleNames:
# Must run each module in a separate suite,
# because each module uses/overwrites cherrypy globals.
cherrypy.root = None
cherrypy.tree = cherrypy._cptree.Tree()
cherrypy.config.reset()
setConfig(conf)
m = __import__(testmod, globals(), locals())
setup = getattr(m, "setup_server", None)
if setup:
setup()
suite = CPTestLoader.loadTestsFromName(testmod)
result = CPTestRunner.run(suite)
cherrypy.server.test_success &= result.wasSuccessful()
teardown = getattr(m, "teardown_server", None)
if teardown:
teardown()
thread.interrupt_main()
def testmain(conf=None, *args, **kwargs):
"""Run __main__ as a test module, with webtest debugging."""
if conf is None:
conf = {}
setConfig(conf)
try:
cherrypy.server.start_with_callback(_test_main_thread, *args, **kwargs)
except KeyboardInterrupt:
cherrypy.server.stop()
def _test_main_thread():
try:
webtest.WebCase.PORT = cherrypy.config.get('server.socket_port')
webtest.main()
finally:
thread.interrupt_main()
|