cherrypy.test package¶

Submodules¶

cherrypy.test.benchmark module¶

CherryPy Benchmark Tool

Usage:: benchmark.py [options]

–null: use a null Request object (to bench the HTTP server only) –notests: start the server but do not run the tests; this allows

you to check the tested pages with a browser

–help: show this help message –cpmodpy: run tests via apache on 54583 (with the builtin _cpmodpy) –modpython: run tests via apache on 54583 (with modpython_gateway) –ab=path: Use the ab script/executable at ‘path’ (see below) –apache=path: Use the apache script/exe at ‘path’ (see below)

To run the benchmarks, the Apache Benchmark tool “ab” must either be on your system path, or specified via the –ab=path option.

To run the modpython tests, the “apache” executable or script must be on your system path, or provided via the –apache=path option. On some platforms, “apache” may be called “apachectl” or “apache2ctl”–create a symlink to them if needed.

class cherrypy.test.benchmark.ABSession(path='/cpbench/users/rdelon/apps/blog/hello', requests=1000, concurrency=10)[source]¶

A session of ‘ab’, the Apache HTTP server benchmarking tool.

Example output from ab:

This is ApacheBench, Version 2.0.40-dev <$Revision: 1.121.2.1 $> apache-2.0 Copyright (c) 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/ Copyright (c) 1998-2002 The Apache Software Foundation, http://www.apache.org/

Benchmarking 127.0.0.1 (be patient) Completed 100 requests Completed 200 requests Completed 300 requests Completed 400 requests Completed 500 requests Completed 600 requests Completed 700 requests Completed 800 requests Completed 900 requests

Server Software: CherryPy/3.1beta Server Hostname: 127.0.0.1 Server Port: 54583

Document Path: /static/index.html Document Length: 14 bytes

Concurrency Level: 10 Time taken for tests: 9.643867 seconds Complete requests: 1000 Failed requests: 0 Write errors: 0 Total transferred: 189000 bytes HTML transferred: 14000 bytes Requests per second: 103.69 [#/sec] (mean) Time per request: 96.439 [ms] (mean) Time per request: 9.644 [ms] (mean, across all concurrent requests) Transfer rate: 19.08 [Kbytes/sec] received

Connection Times (ms): min mean[+/-sd] median max

Connect: 0 0 2.9 0 10 Processing: 20 94 7.3 90 130 Waiting: 0 43 28.1 40 100 Total: 20 95 7.3 100 130

Percentage of the requests served within a certain time (ms): 50% 100 66% 100 75% 100 80% 100 90% 100 95% 100 98% 100 99% 110

100% 130 (longest request)

Finished 1000 requests

args()[source]¶

parse_patterns = [('complete_requests', 'Completed', '^Complete requests:\\s*(\\d+)'), ('failed_requests', 'Failed', '^Failed requests:\\s*(\\d+)'), ('requests_per_second', 'req/sec', '^Requests per second:\\s*([0-9.]+)'), ('time_per_request_concurrent', 'msec/req', '^Time per request:\\s*([0-9.]+).*concurrent requests\\)$'), ('transfer_rate', 'KB/sec', '^Transfer rate:\\s*([0-9.]+)')]¶

run()[source]¶

class cherrypy.test.benchmark.Root[source]¶

hello()[source]¶

index()[source]¶

sizer(size)[source]¶

cherrypy.test.benchmark.print_report(rows)[source]¶

cherrypy.test.benchmark.run_standard_benchmarks()[source]¶

cherrypy.test.benchmark.size_report(sizes=(10, 100, 1000, 10000, 100000, 100000000), concurrency=50)[source]¶

cherrypy.test.benchmark.thread_report(path='/cpbench/users/rdelon/apps/blog/hello', concurrency=(25, 50, 100, 200, 400))[source]¶

cherrypy.test.checkerdemo module¶

Demonstration app for cherrypy.checker.

This application is intentionally broken and badly designed. To demonstrate the output of the CherryPy Checker, simply execute this module.

class cherrypy.test.checkerdemo.Root[source]¶

cherrypy.test.helper module¶

A library of helper functions for the CherryPy test suite.

class cherrypy.test.helper.CPProcess(wait=False, daemonize=False, ssl=False, socket_host=None, socket_port=None)[source]¶

Bases: object

access_log = '/home/docs/checkouts/readthedocs.org/user_builds/cherrypy-wolph/envs/latest/local/lib/python2.7/site-packages/CherryPy-10.0.1.dev10+ng1a62192-py2.7.egg/cherrypy/test/test.access.log'¶

config_file = '/home/docs/checkouts/readthedocs.org/user_builds/cherrypy-wolph/envs/latest/local/lib/python2.7/site-packages/CherryPy-10.0.1.dev10+ng1a62192-py2.7.egg/cherrypy/test/test.conf'¶

config_template = "[global]\nserver.socket_host: '%(host)s'\nserver.socket_port: %(port)s\nchecker.on: False\nlog.screen: False\nlog.error_file: r'%(error_log)s'\nlog.access_file: r'%(access_log)s'\n%(ssl)s\n%(extra)s\n"¶

error_log = '/home/docs/checkouts/readthedocs.org/user_builds/cherrypy-wolph/envs/latest/local/lib/python2.7/site-packages/CherryPy-10.0.1.dev10+ng1a62192-py2.7.egg/cherrypy/test/test.error.log'¶

get_pid()[source]¶

join()[source]¶: Wait for the process to exit.

pid_file = '/home/docs/checkouts/readthedocs.org/user_builds/cherrypy-wolph/envs/latest/local/lib/python2.7/site-packages/CherryPy-10.0.1.dev10+ng1a62192-py2.7.egg/cherrypy/test/test.pid'¶

start(imports=None)[source]¶: Start cherryd in a subprocess.

write_conf(extra='')[source]¶

class cherrypy.test.helper.CPWebCase(methodName='runTest')[source]¶

Bases: cherrypy.test.webtest.WebCase

assertEqualDates(dt1, dt2, seconds=None)[source]¶: Assert abs(dt1 - dt2) is within Y seconds.

assertErrorPage(status, message=None, pattern='')[source]¶

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.

available_servers = {'wsgi': <class 'cherrypy.test.helper.LocalWSGISupervisor'>, 'wsgi_u': <function get_wsgi_u_supervisor at 0x7fd628b51398>, 'cpmodpy': <function get_cpmodpy_supervisor at 0x7fd628b3acf8>, 'modfastcgi': <function get_modfastcgi_supervisor at 0x7fd628b51320>, 'modpygw': <function get_modpygw_supervisor at 0x7fd628b511b8>, 'modwsgi': <function get_modwsgi_supervisor at 0x7fd628b51230>, 'modfcgid': <function get_modfcgid_supervisor at 0x7fd628b512a8>, 'native': <class 'cherrypy.test.helper.NativeServerSupervisor'>}¶

base()[source]¶

date_tolerance = 2¶

default_server = 'wsgi'¶

do_gc_test = False¶

exit()[source]¶

getPage(url, headers=None, method='GET', body=None, protocol=None, raise_subcls=None)[source]¶

Open the url. Return status, headers, body.

raise_subcls must be a tuple with the exceptions classes or a single exception class that are not going to be considered a socket.error regardless that they were are subclass of a socket.error and therefore not considered for a connection retry.

prefix()[source]¶

scheme = 'http'¶

script_name = ''¶

classmethod setup_class()[source]¶

skip(msg='skipped ')[source]¶

classmethod teardown_class()[source]¶

test_gc()[source]¶

class cherrypy.test.helper.LocalSupervisor(**kwargs)[source]¶

Bases: cherrypy.test.helper.Supervisor

Base class for modeling/controlling servers which run in the same process.

When the server side runs in a different process, start/stop can dump all state between each test module easily. When the server side runs in the same process as the client, however, we have to do a bit more work to ensure config and mounted apps are reset between tests.

start(modulename=None)[source]¶: Load and start the HTTP server.

stop()[source]¶

sync_apps()[source]¶: Tell the server about any apps which the setup functions mounted.

using_apache = False¶

using_wsgi = False¶

class cherrypy.test.helper.LocalWSGISupervisor(**kwargs)[source]¶

Bases: cherrypy.test.helper.LocalSupervisor

Server supervisor for the builtin WSGI server.

get_app(app=None)[source]¶: Obtain a new (decorated) WSGI app to hook into the origin server.

httpserver_class = 'cherrypy._cpwsgi_server.CPWSGIServer'¶

sync_apps()[source]¶: Hook a new WSGI app into the origin server.

using_apache = False¶

using_wsgi = True¶

class cherrypy.test.helper.NativeServerSupervisor(**kwargs)[source]¶

Bases: cherrypy.test.helper.LocalSupervisor

Server supervisor for the builtin HTTP server.

httpserver_class = 'cherrypy._cpnative_server.CPHTTPServer'¶

using_apache = False¶

using_wsgi = False¶

class cherrypy.test.helper.Supervisor(**kwargs)[source]¶

Bases: object

Base class for modeling and controlling servers during testing.

cherrypy.test.helper.get_cpmodpy_supervisor(**options)[source]¶

cherrypy.test.helper.get_modfastcgi_supervisor(**options)[source]¶

cherrypy.test.helper.get_modfcgid_supervisor(**options)[source]¶

cherrypy.test.helper.get_modpygw_supervisor(**options)[source]¶

cherrypy.test.helper.get_modwsgi_supervisor(**options)[source]¶

cherrypy.test.helper.get_tst_config(overconf={})[source]¶

cherrypy.test.helper.get_wsgi_u_supervisor(**options)[source]¶

cherrypy.test.helper.log_to_stderr(msg, level)¶

cherrypy.test.helper.setup_client()[source]¶: Set up the WebCase classes to match the server’s socket settings.

cherrypy.test.logtest module¶

logtest, a unittest.TestCase helper for testing log output.

class cherrypy.test.logtest.LogCase[source]¶

Bases: object

unittest.TestCase mixin for testing log messages.

logfile: a filename for the desired log. Yes, I know modes are evil,: but it makes the test functions so much cleaner to set this once.
lastmarker: the last marker in the log. This can be used to search for: messages since the last marker.
markerPrefix: a string with which to prefix log markers. This should be: unique enough from normal log output to use for marker identification.

assertInLog(line, marker=None)[source]¶

Fail if the given (partial) line is not in the log.

The log will be searched from the given marker to the next marker. If marker is None, self.lastmarker is used. If the log hasn’t been marked (using self.markLog), the entire log will be searched.

assertLog(sliceargs, lines, marker=None)[source]¶

Fail if log.readlines()[sliceargs] is not contained in ‘lines’.

The log will be searched from the given marker to the next marker. If marker is None, self.lastmarker is used. If the log hasn’t been marked (using self.markLog), the entire log will be searched.

assertNotInLog(line, marker=None)[source]¶

Fail if the given (partial) line is in the log.

The log will be searched from the given marker to the next marker. If marker is None, self.lastmarker is used. If the log hasn’t been marked (using self.markLog), the entire log will be searched.

emptyLog()[source]¶: Overwrite self.logfile with 0 bytes.

exit()[source]¶

lastmarker = None¶

logfile = None¶

markLog(key=None)[source]¶: Insert a marker line into the log and set self.lastmarker.

markerPrefix = 'test suite marker: '¶

cherrypy.test.logtest.getchar()[source]¶

cherrypy.test.modfastcgi module¶

Wrapper for mod_fastcgi, for use as a CherryPy HTTP server when testing.

To autostart fastcgi, the “apache” executable or script must be on your system path, or you must override the global APACHE_PATH. On some platforms, “apache” may be called “apachectl”, “apache2ctl”, or “httpd”–create a symlink to them if needed.

You’ll also need the WSGIServer from flup.servers. See http://projects.amor.org/misc/wiki/ModPythonGateway

KNOWN BUGS¶

Apache processes Range headers automatically; CherryPy’s truncated

output is then truncated again by Apache. See test_core.testRanges. This was worked around in http://www.cherrypy.org/changeset/1319.
Apache does not allow custom HTTP methods like CONNECT as per the spec.

See test_core.testHTTPMethods.
Max request header and body settings do not work with Apache.
Apache replaces status “reason phrases” automatically. For example,

CherryPy may set “304 Not modified” but Apache will write out “304 Not Modified” (capital “M”).
Apache does not allow custom error codes as per the spec.
Apache (or perhaps modpython, or modpython_gateway) unquotes %xx in the

Request-URI too early.
mod_python will not read request bodies which use the “chunked”

transfer-coding (it passes REQUEST_CHUNKED_ERROR to ap_setup_client_block instead of REQUEST_CHUNKED_DECHUNK, see Apache2’s http_protocol.c and mod_python’s requestobject.c).
Apache will output a “Content-Length: 0” response header even if there’s

no response entity body. This isn’t really a bug; it just differs from the CherryPy default.

class cherrypy.test.modfastcgi.ModFCGISupervisor(**kwargs)[source]¶

Bases: cherrypy.test.helper.LocalWSGISupervisor

httpserver_class = 'cherrypy.process.servers.FlupFCGIServer'¶

start(modulename)[source]¶

start_apache()[source]¶

stop()[source]¶: Gracefully shutdown a server that is serving forever.

sync_apps()[source]¶

template = '\n# Apache2 server conf file for testing CherryPy with mod_fastcgi.\n# fumanchu: I had to hard-code paths due to crazy Debian layouts :(\nServerRoot /usr/lib/apache2\nUser #1000\nErrorLog %(root)s/mod_fastcgi.error.log\n\nDocumentRoot "%(root)s"\nServerName 127.0.0.1\nListen %(port)s\nLoadModule fastcgi_module modules/mod_fastcgi.so\nLoadModule rewrite_module modules/mod_rewrite.so\n\nOptions +ExecCGI\nSetHandler fastcgi-script\nRewriteEngine On\nRewriteRule ^(.*)$ /fastcgi.pyc [L]\nFastCgiExternalServer "%(server)s" -host 127.0.0.1:4000\n'¶

using_apache = True¶

using_wsgi = True¶

cherrypy.test.modfastcgi.erase_script_name(environ, start_response)[source]¶

cherrypy.test.modfastcgi.read_process(cmd, args='')[source]¶

cherrypy.test.modfcgid module¶

Wrapper for mod_fcgid, for use as a CherryPy HTTP server when testing.

To autostart fcgid, the “apache” executable or script must be on your system path, or you must override the global APACHE_PATH. On some platforms, “apache” may be called “apachectl”, “apache2ctl”, or “httpd”–create a symlink to them if needed.

You’ll also need the WSGIServer from flup.servers. See http://projects.amor.org/misc/wiki/ModPythonGateway

KNOWN BUGS¶

Apache processes Range headers automatically; CherryPy’s truncated

output is then truncated again by Apache. See test_core.testRanges. This was worked around in http://www.cherrypy.org/changeset/1319.
Apache does not allow custom HTTP methods like CONNECT as per the spec.

See test_core.testHTTPMethods.
Max request header and body settings do not work with Apache.
Apache replaces status “reason phrases” automatically. For example,

CherryPy may set “304 Not modified” but Apache will write out “304 Not Modified” (capital “M”).
Apache does not allow custom error codes as per the spec.
Apache (or perhaps modpython, or modpython_gateway) unquotes %xx in the

Request-URI too early.
mod_python will not read request bodies which use the “chunked”

transfer-coding (it passes REQUEST_CHUNKED_ERROR to ap_setup_client_block instead of REQUEST_CHUNKED_DECHUNK, see Apache2’s http_protocol.c and mod_python’s requestobject.c).
Apache will output a “Content-Length: 0” response header even if there’s

no response entity body. This isn’t really a bug; it just differs from the CherryPy default.

class cherrypy.test.modfcgid.ModFCGISupervisor(**kwargs)[source]¶

Bases: cherrypy.test.helper.LocalSupervisor

start(modulename)[source]¶

start_apache()[source]¶

stop()[source]¶: Gracefully shutdown a server that is serving forever.

sync_apps()[source]¶

template = '\n# Apache2 server conf file for testing CherryPy with mod_fcgid.\n\nDocumentRoot "%(root)s"\nServerName 127.0.0.1\nListen %(port)s\nLoadModule fastcgi_module modules/mod_fastcgi.dll\nLoadModule rewrite_module modules/mod_rewrite.so\n\nOptions ExecCGI\nSetHandler fastcgi-script\nRewriteEngine On\nRewriteRule ^(.*)$ /fastcgi.pyc [L]\nFastCgiExternalServer "%(server)s" -host 127.0.0.1:4000\n'¶

using_apache = True¶

using_wsgi = True¶

cherrypy.test.modfcgid.read_process(cmd, args='')[source]¶

cherrypy.test.modpy module¶

Wrapper for mod_python, for use as a CherryPy HTTP server when testing.

To autostart modpython, the “apache” executable or script must be on your system path, or you must override the global APACHE_PATH. On some platforms, “apache” may be called “apachectl” or “apache2ctl”– create a symlink to them if needed.

If you wish to test the WSGI interface instead of our _cpmodpy interface, you also need the ‘modpython_gateway’ module at: http://projects.amor.org/misc/wiki/ModPythonGateway

KNOWN BUGS¶

Apache processes Range headers automatically; CherryPy’s truncated

output is then truncated again by Apache. See test_core.testRanges. This was worked around in http://www.cherrypy.org/changeset/1319.
Apache does not allow custom HTTP methods like CONNECT as per the spec.

See test_core.testHTTPMethods.
Max request header and body settings do not work with Apache.
Apache replaces status “reason phrases” automatically. For example,

CherryPy may set “304 Not modified” but Apache will write out “304 Not Modified” (capital “M”).
Apache does not allow custom error codes as per the spec.
Apache (or perhaps modpython, or modpython_gateway) unquotes %xx in the

Request-URI too early.
mod_python will not read request bodies which use the “chunked”

transfer-coding (it passes REQUEST_CHUNKED_ERROR to ap_setup_client_block instead of REQUEST_CHUNKED_DECHUNK, see Apache2’s http_protocol.c and mod_python’s requestobject.c).
Apache will output a “Content-Length: 0” response header even if there’s

no response entity body. This isn’t really a bug; it just differs from the CherryPy default.

class cherrypy.test.modpy.ModPythonSupervisor(**kwargs)[source]¶

Bases: cherrypy.test.helper.Supervisor

start(modulename)[source]¶

stop()[source]¶: Gracefully shutdown a server that is serving forever.

template = None¶

using_apache = True¶

using_wsgi = False¶

cherrypy.test.modpy.cpmodpysetup(req)[source]¶

cherrypy.test.modpy.read_process(cmd, args='')[source]¶

cherrypy.test.modpy.wsgisetup(req)[source]¶

cherrypy.test.modwsgi module¶

Wrapper for mod_wsgi, for use as a CherryPy HTTP server.

To autostart modwsgi, the “apache” executable or script must be on your system path, or you must override the global APACHE_PATH. On some platforms, “apache” may be called “apachectl” or “apache2ctl”– create a symlink to them if needed.

KNOWN BUGS¶

##1. Apache processes Range headers automatically; CherryPy’s truncated ## output is then truncated again by Apache. See test_core.testRanges. ## This was worked around in http://www.cherrypy.org/changeset/1319. 2. Apache does not allow custom HTTP methods like CONNECT as per the spec.

See test_core.testHTTPMethods.

3. Max request header and body settings do not work with Apache. ##4. Apache replaces status “reason phrases” automatically. For example, ## CherryPy may set “304 Not modified” but Apache will write out ## “304 Not Modified” (capital “M”). ##5. Apache does not allow custom error codes as per the spec. ##6. Apache (or perhaps modpython, or modpython_gateway) unquotes %xx in the ## Request-URI too early. 7. mod_wsgi will not read request bodies which use the “chunked”

transfer-coding (it passes REQUEST_CHUNKED_ERROR to ap_setup_client_block instead of REQUEST_CHUNKED_DECHUNK, see Apache2’s http_protocol.c and mod_python’s requestobject.c).

When responding with 204 No Content, mod_wsgi adds a Content-Length

header for you.
When an error is raised, mod_wsgi has no facility for printing a

traceback as the response content (it’s sent to the Apache log instead).
Startup and shutdown of Apache when running mod_wsgi seems slow.

class cherrypy.test.modwsgi.ModWSGISupervisor(**kwargs)[source]¶

Bases: cherrypy.test.helper.Supervisor

Server Controller for ModWSGI and CherryPy.

start(modulename)[source]¶

stop()[source]¶: Gracefully shutdown a server that is serving forever.

template = '\n# Apache2 server conf file for testing CherryPy with modpython_gateway.\n\nServerName 127.0.0.1\nDocumentRoot "/"\nListen %(port)s\n\nAllowEncodedSlashes On\nLoadModule rewrite_module modules/mod_rewrite.so\nRewriteEngine on\nRewriteMap escaping int:escape\n\nLoadModule log_config_module modules/mod_log_config.so\nLogFormat "%%h %%l %%u %%t \\"%%r\\" %%>s %%b \\"%%{Referer}i\\" \\"%%{User-agent}i\\"" combined\nCustomLog "%(curdir)s/apache.access.log" combined\nErrorLog "%(curdir)s/apache.error.log"\nLogLevel debug\n\nLoadModule wsgi_module modules/mod_wsgi.so\nLoadModule env_module modules/mod_env.so\n\nWSGIScriptAlias / "%(curdir)s/modwsgi.py"\nSetEnv testmod %(testmod)s\n'¶

using_apache = True¶

using_wsgi = True¶

cherrypy.test.modwsgi.application(environ, start_response)[source]¶

cherrypy.test.modwsgi.read_process(cmd, args='')[source]¶

cherrypy.test.sessiondemo module¶

A session demonstration app.

class cherrypy.test.sessiondemo.Root[source]¶

Bases: object

expire()[source]¶

index()[source]¶

page()[source]¶

regen()[source]¶

cherrypy.test.test_auth_basic module¶

class cherrypy.test.test_auth_basic.BasicAuthTest(methodName='runTest')[source]¶

cherrypy.test package¶

Submodules¶

cherrypy.test.benchmark module¶

cherrypy.test.checkerdemo module¶

cherrypy.test.helper module¶

cherrypy.test.logtest module¶

cherrypy.test.modfastcgi module¶

KNOWN BUGS¶

cherrypy.test.modfcgid module¶

KNOWN BUGS¶

cherrypy.test.modpy module¶

KNOWN BUGS¶

cherrypy.test.modwsgi module¶

KNOWN BUGS¶

cherrypy.test.sessiondemo module¶

cherrypy.test.test_auth_basic module¶

cherrypy.test.test_auth_digest module¶

cherrypy.test.test_bus module¶

cherrypy.test.test_caching module¶

cherrypy.test.test_compat module¶

cherrypy.test.test_config module¶

cherrypy.test.test_config_server module¶

cherrypy.test.test_conn module¶

cherrypy.test.test_core module¶

cherrypy.test.test_dynamicobjectmapping module¶

cherrypy.test.test_encoding module¶

cherrypy.test.test_etags module¶

cherrypy.test.test_http module¶

cherrypy.test.test_httpauth module¶

cherrypy.test.test_httplib module¶

cherrypy.test.test_iterator module¶

cherrypy.test.test_json module¶

cherrypy.test.test_logging module¶

cherrypy.test.test_mime module¶

cherrypy.test.test_misc_tools module¶

cherrypy.test.test_objectmapping module¶

cherrypy.test.test_params module¶

cherrypy.test.test_proxy module¶

cherrypy.test.test_refleaks module¶

cherrypy.test.test_request_obj module¶

cherrypy.test.test_routes module¶

cherrypy.test.test_session module¶

cherrypy.test.test_sessionauthenticate module¶

cherrypy.test.test_states module¶

cherrypy.test.test_static module¶

cherrypy.test.test_tools module¶

cherrypy.test.test_tutorials module¶

cherrypy.test.test_virtualhost module¶

cherrypy.test.test_wsgi_ns module¶

cherrypy.test.test_wsgi_unix_socket module¶

cherrypy.test.test_wsgi_vhost module¶

cherrypy.test.test_wsgiapps module¶

cherrypy.test.test_xmlrpc module¶

cherrypy.test.webtest module¶

Framework Integration¶

Module contents¶