Skip to main content

Zope testing helpers

Project description

This package provides a number of testing frameworks. It includes a flexible test runner, and supports both doctest and unittest.

Provides a mixin class for cleaning up after tests that make global changes.

Enhanced version of python’s standard Better test count (one per block instead of one per docstring). See doctest.txt.

(We need to merge this with the standard doctest module.)

Provides a pprint function that always sorts dictionary entries (pprint.pprint from the standard library doesn’t sort very short ones, sometimes causing test failures when the internal order changes).

An HTML parser that extracts form information.

This is intended to support functional tests that need to extract information from HTML forms returned by the publisher.

See formparser.txt.

Support for testing logging code

If you want to test that your code generates proper log output, you can create and install a handler that collects output.

Logging handler for tests that check logging output.

Lets a doctest pretend to be a Python module.

See module.txt.

Regular expression pattern normalizing output checker. Useful for doctests.

Provides a simple HTTP server compatible with the functional testing API. Lets you interactively play with the system under test. Helpful in debugging functional doctest failures.

A simple framework for automating doctest set-up and tear-down. See setupstack.txt.


The test runner package. This is typically wrapped by a script that sets up options to run a particular set of tests.

Getting started

zope.testing uses buildout. To start, run python It will create a number of directories and the bin/buildout script. Next, run bin/buildout. It will create a test script for you. Now, run bin/test to run the zope.testing test suite.

zope.testing Changelog

4.0.0 (2011-11-09)

  • Removes the deprecated zope.testing.doctest.

  • Adds Python 3 support.

  • Fixed test which fails if there is a file named Data.fs in the current working directory.

3.10.2 (2010-11-30)

  • Fix test of broken symlink handling to not break on Windows.

3.10.1 (2010-11-29)

  • Fix removal of broken symlinks on Unix.

3.10.0 (2010-07-21)

  • Removed zope.testing.testrunner, which now is moved to zope.testrunner.

  • Update fix for LP #221151 to a spelling compatible with Python 2.4.

3.9.5 (2010-05-19)

  • LP #579019: When layers were run in parallel, their tearDown was not called. Additionally, the first layer which was run in the main thread did not have it’s tearDown called either.

  • Deprecated zope.testing.testrunner and zope.testing.exceptions. They have been moved to a separate zope.testrunner module, and will be removed from zope.testing in 4.0.0, together with zope.testing.doctest.

3.9.4 (2010-04-13)

  • LP #560259: Fix subunit output formatter to handle layer setup errors.

  • LP #399394: Added a --stop-on-error / --stop / -x option to the testrunner.

  • LP #498162: Added a --pdb alias for the existing --post-mortem / -D option to the testrunner.

  • LP #547023: Added a --version option to the testrunner.

  • Added tests for LP #144569 and #69988.

3.9.3 (2010-03-26)

  • zope.testing.renormalizer no longer imports zope.testing.doctest, which caused deprecation warnings.

  • Fix testrunner-layers-ntd.txt to suppress output to sys.stderr.

  • Suppress zope.testing.doctest deprecation warning when running zope.testing’s own test suite.

3.9.2 (2010-03-15)

  • Fixed broken from zope.testing.doctest import *

3.9.1 (2010-03-15)

  • No changes; reuploaded to fix broken 3.9.0 release on PyPI.

3.9.0 (2010-03-12)

  • Modified the testrunner to use the standard Python doctest module instead of the deprecated zope.testing.doctest.

  • Fix testrunner-leaks.txt to use the run_internal helper, so that sys.exit() isn’t triggered during the test run.

  • Added support for conditionally using a subunit-based output formatter upon request if subunit and testtools are available. Patch contributed by Jonathan Lange.

3.8.7 (2010-01-26)

  • Downgraded the zope.testing.doctest deprecation warning into a PendingDeprecationWarning.

3.8.6 (2009-12-23)

  • Added and reuploaded to fix broken 3.8.5 release on PyPI.

3.8.5 (2009-12-23)

  • Added DocFileSuite, DocTestSuite, debug_src and debug back BBB imports back into zope.testing.doctestunit; apparently many packages still import them from there!

  • Made zope.testing.doctest and zope.testing.doctestunit emit deprecation warnings: use the stdlib doctest instead.

3.8.4 (2009-12-18)

  • Fixed missing imports and undefined variables reported by pyflakes, adding tests to exercise the blind spots.

  • Cleaned up unused imports reported by pyflakes.

  • Added two new options to generate randomly ordered list of tests and to select a specific order of tests.

  • RENormalizing checkers can be combined via + now: checker1 + checker2 creates a checker with the transformations of both checkers.

  • Test fixes for Python 2.7.

3.8.3 (2009-09-21)

  • Avoid a split() call or we get test failures when running from a directory with spaces in it.

  • Fix testrunner behavior on Windows for -j2 (or greater) combined with -v (or greater).

3.8.2 (2009-09-15)

  • Removing hotshot profiler when using Python 2.6. That makes zope.testing compatible with Python 2.6

3.8.1 (2009-08-12)

  • Avoid hardcoding sys.argv[0] as script; allow, for instance, Zope 2’s bin/instance test (LP#407916).

  • Produce a clear error message when a subprocess doesn’t follow the zope.testing.testrunner protocol (LP#407916).

  • Do not unnecessarily squelch verbose output in a subprocess when there are not multiple subprocesses.

  • Do not unnecessarily batch subprocess output, which can stymie automated and human processes for identifying hung tests.

  • Include incremental output when there are multiple subprocesses and a verbosity of -vv or greater is requested. This again is not batched, supporting automated processes and humans looking for hung tests.

3.8.0 (2009-07-24)

  • Testrunner automatically picks up descendants of unittest.TestCase in test modules, so you don’t have to provide a test_suite() anymore.

3.7.7 (2009-07-15)

  • Clean up support for displaying tracebacks with supplements by turning it into an always-enabled feature and making the dependency on zope.exceptions explicit.

  • Fix #251759: Test runner descended into directories that aren’t Python packages.

  • Code cleanups.

3.7.6 (2009-07-02)

  • Add zope-testrunner console_scripts entry point. This exposes a zope-testrunner binary with default installs allowing the testrunner to be run from the command line.

3.7.5 (2009-06-08)

  • Fix bug when running subprocesses on Windows.

  • The option REPORT_ONLY_FIRST_FAILURE (command line option “-1”) is now respected even when a doctest declares its own REPORTING_FLAGS, such as REPORT_NDIFF.

  • Fixed bug that broke readline with pdb when using doctest (see

  • Made tests pass on Windows and Linux at the same time.

3.7.4 (2009-05-01)

  • Filenames of doctest examples now contain the line number and not only the example number. So a stack trace in pdb tells the exact line number of the current example. This fixes

  • Colorization of doctest output correctly handles blank lines.

3.7.3 (2009-04-22)

  • Better deal with rogue threads by always exiting with status so even spinning daemon threads won’t block the runner from exiting. This deprecated the --with-exit-status option.

3.7.2 (2009-04-13)

  • fix test failure on Python 2.4 because of slight difference in the way coverage is reported (__init__ files with only a single comment line are now not reported)

  • fixed bug that caused the test runner to hang when running subprocesses (as a result Python 2.3 is no longer supported).

  • there is apparently a bug in Python 2.6 (related to that causes the profile tests to fail.

  • added explanitory notes to buildout.cfg about how to run the tests with multiple versions of Python

3.7.1 (2008-10-17)

  • The setupstack temporary-directory support now properly handles read-only files by making them writable before removing them.

3.7.0 (2008-09-22)

  • Added an alterate setuptools / distutils commands for running all tests using our testrunner. See ‘zope.testing.testrunner.eggsupport:ftest’.

  • Added a setuptools-compatible test loader which skips tests with layers: the testrunner used by ‘ test’ doesn’t know about them, and those tests then fail. See ‘zope.testing.testrunner.eggsupport:SkipLayers’.

  • Added support for Jython, when a garbage collector call is sent.

  • Added support to bootstrap on Jython.

  • Fixed NameError in StartUpFailure.

  • Open doctest files in universal mode, so that packages released on Windows can be tested on Linux, for example.

3.6.0 (2008/07/10)

  • Added -j option to parallel tests run in subprocesses.

  • RENormalizer accepts plain Python callables.

  • Added –slow-test option.

  • Added –no-progress and –auto-progress options.

  • Complete refactoring of the test runner into multiple code files and a more modular (pipeline-like) architecture.

  • Unified unit tests with the layer support by introducing a real unit test layer.

  • Added a doctest for zope.testing.module. There were several bugs that were fixed:

    • README.txt was a really bad default argument for the module name, as it is not a proper dotted name. The code would immediately fail as it would look for the txt module in the README package. The default is now __main__.

    • The tearDown function did not clean up the __name__ entry in the global dictionary.

  • Fix a bug that caused a SubprocessError to be generated if a subprocess sent any output to stderr.

  • Fix a bug that caused the unit tests to be skipped if run in a subprocess.

3.5.1 (2007/08/14)

Bugs Fixed:

  • Post-mortem debugging wasn’t invoked for layer-setup failures.

3.5.0 (2007/07/19)

New Features

  • The test runner now works on Python 2.5.

  • Added support for cProfile.

  • Added output colorizing (-c option).

  • Added –hide-secondary-failures and –show-secondary-failures options (

Bugs Fixed:

  • Fix some problems with Unicode in doctests.

  • Fix “Error reading from subprocess” errors on Unix-like systems.

3.4 (2007/03/29)

New Features

  • Added exit-with-status support (supports use with buildbot and zc.recipe.testing)

  • Added a small framework for automating set up and tear down of doctest tests. See setupstack.txt.

Bugs Fixed:

  • Fix testrunner-wo-source.txt and testrunner-errors.txt to run with a read-only source tree.

3.0 (2006/09/20)

  • Updated the doctest copy with text-file encoding support.

  • Added logging-level support to loggingsuppport module.

  • At verbosity-level 1, dots are not output continuously, without any line breaks.

  • Improved output when the inability to tear down a layer causes tests to be run in a subprocess.

  • Made zope.exception required only if the zope_tracebacks extra is requested.

2.x.y (???)

  • Fix the test coverage. If a module, for example interfaces, was in an ignored directory/package, then if a module of the same name existed in a covered directory/package, then it was also ignored there, because the ignore cache stored the result by module name and not the filename of the module.

2.0 (2006/01/05)

  • Corresponds to the version of the zope.testing package shipped as part of the Zope 3.2.0 release.

Detailed Documentation

Parsing HTML Forms

Sometimes in functional tests, information from a generated form must be extracted in order to re-submit it as part of a subsequent request. The zope.testing.formparser module can be used for this purpose.

The scanner is implemented using the FormParser class. The constructor arguments are the page data containing the form and (optionally) the URL from which the page was retrieved:

>>> import zope.testing.formparser
>>> page_text = '''\
... <html><body>
...   <form name="form1" action="/cgi-bin/" method="POST">
...     <input type="hidden" name="f1" value="today" />
...     <input type="submit" name="do-it-now" value="Go for it!" />
...     <input type="IMAGE" name="not-really" value="Don't."
...            src="dont.png" />
...     <select name="pick-two" size="3" multiple>
...       <option value="one" selected>First</option>
...       <option value="two" label="Second">Another</option>
...       <optgroup>
...         <option value="three">Third</option>
...         <option selected="selected">Fourth</option>
...       </optgroup>
...     </select>
...   </form>
...   Just for fun, a second form, after specifying a base:
...   <base href="" />
...   <form action = 'sproing/sprung.html' enctype="multipart/form">
...     <textarea name="sometext" rows="5">Some text.</textarea>
...     <input type="Image" name="action" value="Do something."
...            src="else.png" />
...     <input type="text" value="" name="multi" size="2" />
...     <input type="text" value="" name="multi" size="3" />
...   </form>
... </body></html>
... '''
>>> parser = zope.testing.formparser.FormParser(page_text)
>>> forms = parser.parse()
>>> len(forms)
>>> forms.form1 is forms[0]
>>> forms.form1 is forms[1]

More often, the parse() convenience function is all that’s needed:

>>> forms = zope.testing.formparser.parse(
...     page_text, "")
>>> len(forms)
>>> forms.form1 is forms[0]
>>> forms.form1 is forms[1]

Once we have the form we’re interested in, we can check form attributes and individual field values:

>>> form = forms.form1
>>> form.enctype
>>> form.method
>>> keys = form.keys()
>>> keys.sort()
>>> keys
['do-it-now', 'f1', 'not-really', 'pick-two']
>>> not_really = form["not-really"]
>>> not_really.type
>>> not_really.value
>>> not_really.readonly
>>> not_really.disabled

Note that relative URLs are converted to absolute URLs based on the <base> element (if present) or using the base passed in to the constructor.

>>> form.action
>>> not_really.src
>>> forms[1].action
>>> forms[1]["action"].src

Fields which are repeated are reported as lists of objects that represent each instance of the field:

>>> field = forms[1]["multi"]
>>> isinstance(field, list)
>>> [o.value for o in field]
['', '']
>>> [o.size for o in field]
[2, 3]

The <textarea> element provides some additional attributes:

>>> ta = forms[1]["sometext"]
>>> print ta.rows
>>> print ta.cols
>>> ta.value
'Some text.'

The <select> element provides access to the options as well:

>>> select = form["pick-two"]
>>> select.multiple
>>> select.size
>>> select.type
>>> select.value
['one', 'Fourth']
>>> options = select.options
>>> len(options)
>>> [opt.label for opt in options]
['First', 'Second', 'Third', 'Fourth']
>>> [opt.value for opt in options]
['one', 'two', 'three', 'Fourth']

Stack-based test doctest setUp and tearDown

Writing doctest setUp and tearDown functions can be a bit tedious, especially when setUp/tearDown functions are combined.

the zope.testing.setupstack module provides a small framework for automating test tear down. It provides a generic setUp function that sets up a stack. Normal test setUp functions call this function to set up the stack and then use the register function to register tear-down functions.

To see how this works we’ll create a faux test:

>>> class Test:
...     def __init__(self):
...         self.globs = {}
>>> test = Test()

We’ll register some tearDown functions that just print something:

>>> import sys
>>> import zope.testing.setupstack
>>> zope.testing.setupstack.register(
...     test, lambda : sys.stdout.write('td 1\n'))
>>> zope.testing.setupstack.register(
...     test, lambda : sys.stdout.write('td 2\n'))

Now, when we call the tearDown function:

>>> zope.testing.setupstack.tearDown(test)
td 2
td 1

The registered tearDown functions are run. Note that they are run in the reverse order that they were registered.

Extra positional arguments can be passed to register:

>>> zope.testing.setupstack.register(
...    test, lambda x, y, z: sys.stdout.write('%s %s %s\n' % (x, y, z)),
...    1, 2, z=9)
>>> zope.testing.setupstack.tearDown(test)
1 2 9

Temporary Test Directory

Often, tests create files as they demonstrate functionality. They need to arrange for the removeal of these files when the test is cleaned up.

The setUpDirectory function automates this. We’ll get the current directory first:

>>> import os
>>> here = os.getcwd()

We’ll also create a new test:

>>> test = Test()

Now we’ll call the setUpDirectory function:

>>> zope.testing.setupstack.setUpDirectory(test)

We don’t have to call zope.testing.setupstack.setUp, because setUpDirectory calls it for us.

Now the current working directory has changed:

>>> here == os.getcwd()
>>> setupstack_cwd = os.getcwd()

We can create files to out heart’s content:

>>> foo = open('Data.fs', 'w').write('xxx')
>>> os.path.exists(os.path.join(setupstack_cwd, 'Data.fs'))

We’ll make the file read-only. This can cause problems on Windows, but setupstack takes care of that by making files writable before trying to remove them.

>>> import stat
>>> os.chmod('Data.fs', stat.S_IREAD)

On Unix systems, broken symlinks can cause problems because the chmod attempt by the teardown hook will fail; let’s set up a broken symlink as well, and verify the teardown doesn’t break because of that:

>>> if hasattr(os, 'symlink'):
...     os.symlink('NotThere', 'BrokenLink')

When tearDown is called:

>>> zope.testing.setupstack.tearDown(test)

We’ll be back where we started:

>>> here == os.getcwd()

and the files we created will be gone (along with the temporary directory that was created:

>>> os.path.exists(os.path.join(setupstack_cwd, 'Data.fs'))

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zope.testing-4.0.0.tar.gz (37.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page