yellow team mailing list archive
-
yellow team
-
Mailing list archive
-
Message #00898
[Merge] lp:~bac/zope.testing/list-tests into lp:zope.testing
Brad Crittenden has proposed merging lp:~bac/zope.testing/list-tests into lp:zope.testing.
Requested reviews:
Yellow Squad (yellow)
Related bugs:
Bug #682772 in Launchpad itself: "doctest construction generates duplicate test ids"
https://bugs.launchpad.net/launchpad/+bug/682772
For more details, see:
https://code.launchpad.net/~bac/zope.testing/list-tests/+merge/108977
In Launchpad, some doctests are registered multiple times using different layers, etc. To the test runner they appear the same as they have the same id. Launchpad now gives them different ids but they still reference the same path, which is what the testrunner uses to report and discover tests.
This change causes the testrunner to output test.id() instead of str(test). It also allows tests to be discovered by pattern matching against the id property.
--
The attached diff has been truncated due to its size.
https://code.launchpad.net/~bac/zope.testing/list-tests/+merge/108977
Your team Yellow Squad is requested to review the proposed merge of lp:~bac/zope.testing/list-tests into lp:zope.testing.
=== added file '.bzrignore'
--- .bzrignore 1970-01-01 00:00:00 +0000
+++ .bzrignore 2012-06-06 16:03:24 +0000
@@ -0,0 +1,6 @@
+./.installed.cfg
+./bin
+./develop-eggs
+./eggs
+./parts
+*.egg-info
=== renamed file '.bzrignore' => '.bzrignore.moved'
=== added file 'CHANGES.txt'
--- CHANGES.txt 1970-01-01 00:00:00 +0000
+++ CHANGES.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,344 @@
+zope.testing Changelog
+**********************
+
+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.
+
+ https://bugs.launchpad.net/bugs/69988
+
+ https://bugs.launchpad.net/zope3/+bug/144569
+
+
+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.6 (2009-12-23)
+==================
+
+- Added MANIFEST.in 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 http://bugs.python.org/issue5727).
+
+- 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
+ https://bugs.launchpad.net/bugs/339813
+
+- 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
+ http://bugs.python.org/issue1303673) 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 'setup.py 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 in Windoes
+ can be tested in 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
+ (https://bugs.launchpad.net/zope3/+bug/115454).
+
+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.
=== renamed file 'CHANGES.txt' => 'CHANGES.txt.moved'
=== added file 'COPYRIGHT.txt'
--- COPYRIGHT.txt 1970-01-01 00:00:00 +0000
+++ COPYRIGHT.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+Zope Foundation and Contributors
\ No newline at end of file
=== renamed file 'COPYRIGHT.txt' => 'COPYRIGHT.txt.moved'
=== added file 'LICENSE.txt'
--- LICENSE.txt 1970-01-01 00:00:00 +0000
+++ LICENSE.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,44 @@
+Zope Public License (ZPL) Version 2.1
+
+A copyright notice accompanies this license document that identifies the
+copyright holders.
+
+This license has been certified as open source. It has also been designated as
+GPL compatible by the Free Software Foundation (FSF).
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions in source code must retain the accompanying copyright
+notice, this list of conditions, and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the accompanying copyright
+notice, this list of conditions, and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Names of the copyright holders must not be used to endorse or promote
+products derived from this software without prior written permission from the
+copyright holders.
+
+4. The right to distribute this software or to use it for any purpose does not
+give you the right to use Servicemarks (sm) or Trademarks (tm) of the
+copyright
+holders. Use of them is covered by separate agreement with the copyright
+holders.
+
+5. If any files are modified, you must cause the modified files to carry
+prominent notices stating that you changed the files and the date of any
+change.
+
+Disclaimer
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=== renamed file 'LICENSE.txt' => 'LICENSE.txt.moved'
=== added file 'MANIFEST.in'
--- MANIFEST.in 1970-01-01 00:00:00 +0000
+++ MANIFEST.in 2012-06-06 16:03:24 +0000
@@ -0,0 +1,3 @@
+include *.txt *.py buildout.cfg
+recursive-include src *.py *.txt *.test sampletests
+# I found no way to include the three empty "sampletests" directories into the sdist :/
=== renamed file 'MANIFEST.in' => 'MANIFEST.in.moved'
=== added file 'README.txt'
--- README.txt 1970-01-01 00:00:00 +0000
+++ README.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,72 @@
+************
+zope.testing
+************
+
+.. contents::
+
+This package provides a number of testing frameworks. It includes a
+flexible test runner, and supports both doctest and unittest.
+
+cleanup.py
+ Provides a mixin class for cleaning up after tests that
+ make global changes.
+
+doctest.py
+ Enhanced version of python's standard doctest.py.
+ Better test count (one per block instead of one per docstring).
+ See doctest.txt.
+
+ (We need to merge this with the standard doctest module.)
+
+doctestunit.py
+ 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).
+
+formparser.py
+ 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.
+
+loggingsupport.py
+ 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.
+
+loghandler.py
+ Logging handler for tests that check logging output.
+
+module.py
+ Lets a doctest pretend to be a Python module.
+
+ See module.txt.
+
+renormalizing.py
+ Regular expression pattern normalizing output checker.
+ Useful for doctests.
+
+server.py
+ Provides a simple HTTP server compatible with the zope.app.testing
+ functional testing API. Lets you interactively play with the system
+ under test. Helpful in debugging functional doctest failures.
+
+setupstack.py
+ A simple framework for automating doctest set-up and tear-down.
+ See setupstack.txt.
+
+testrunner
+ The test runner package. This is typically wrapped by a test.py script that
+ sets up options to run a particular set of tests.
+
+
+Getting started
+***************
+
+zope.testing uses buildout. To start, run ``python bootstrap.py``. 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.
=== renamed file 'README.txt' => 'README.txt.moved'
=== added file 'bootstrap.py'
--- bootstrap.py 1970-01-01 00:00:00 +0000
+++ bootstrap.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,68 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+
+$Id: bootstrap.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import os, shutil, sys, tempfile, urllib2
+
+tmpeggs = tempfile.mkdtemp()
+
+ez = {}
+exec urllib2.urlopen('http://peak.telecommunity.com/dist/ez_setup.py'
+ ).read() in ez
+ez['use_setuptools'](to_dir=tmpeggs, download_delay=0)
+
+import pkg_resources
+
+is_jython = sys.platform.startswith('java')
+
+if is_jython:
+ import subprocess
+
+cmd = 'from setuptools.command.easy_install import main; main()'
+if sys.platform == 'win32':
+ cmd = '"%s"' % cmd # work around spawn lamosity on windows
+
+ws = pkg_resources.working_set
+
+if is_jython:
+ assert subprocess.Popen(
+ [sys.executable] + ['-c', cmd, '-mqNxd', tmpeggs, 'zc.buildout'],
+ env = dict(os.environ,
+ PYTHONPATH=
+ ws.find(pkg_resources.Requirement.parse('setuptools')).location
+ ),
+ ).wait() == 0
+
+else:
+ assert os.spawnle(
+ os.P_WAIT, sys.executable, sys.executable,
+ '-c', cmd, '-mqNxd', tmpeggs, 'zc.buildout',
+ dict(os.environ,
+ PYTHONPATH=
+ ws.find(pkg_resources.Requirement.parse('setuptools')).location
+ ),
+ ) == 0
+
+ws.add_entry(tmpeggs)
+ws.require('zc.buildout')
+import zc.buildout.buildout
+zc.buildout.buildout.main(sys.argv[1:] + ['bootstrap'])
+shutil.rmtree(tmpeggs)
=== renamed file 'bootstrap.py' => 'bootstrap.py.moved'
=== added file 'buildout.cfg'
--- buildout.cfg 1970-01-01 00:00:00 +0000
+++ buildout.cfg 2012-06-06 16:03:24 +0000
@@ -0,0 +1,34 @@
+[buildout]
+develop = .
+parts = test
+
+[test]
+recipe = zc.recipe.testrunner
+eggs = zope.testing
+
+
+# The [test2X] sections below are to make testing with various Python versions
+# easier. You'll need entries in your default.cfg that point to the location
+# that your various versions of Python are installed. Like so:
+#
+# [python2.4]
+# executable = /usr/local/bin/python2.4
+#
+# And then run "bin/buildout install test24 test25 test26" to build the
+# version-specific test scripts. Once that's done you ran run "bin/test24"
+# (etc.).
+
+[test24]
+python = python2.4
+recipe = zc.recipe.testrunner
+eggs = zope.testing
+
+[test25]
+python = python2.5
+recipe = zc.recipe.testrunner
+eggs = zope.testing
+
+[test26]
+python = python2.6
+recipe = zc.recipe.testrunner
+eggs = zope.testing
=== renamed file 'buildout.cfg' => 'buildout.cfg.moved'
=== added file 'setup.py'
--- setup.py 1970-01-01 00:00:00 +0000
+++ setup.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,113 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+# This package is developed by the Zope Toolkit project, documented here:
+# http://docs.zope.org/zopetoolkit
+# When developing and releasing this package, please follow the documented
+# Zope Toolkit policies as described by this documentation.
+##############################################################################
+"""Setup for zope.testing package
+
+$Id: setup.py 110768 2010-04-13 10:30:36Z sidnei $
+"""
+
+import os
+
+try:
+ from setuptools import setup
+ extra = dict(
+ namespace_packages=['zope',],
+ install_requires = ['setuptools',
+ 'zope.exceptions',
+ 'zope.interface'],
+ entry_points = {
+ 'console_scripts':
+ ['zope-testrunner = zope.testing.testrunner:run',]},
+ include_package_data = True,
+ zip_safe = False,
+ )
+except ImportError, e:
+ from distutils.core import setup
+ extra = {}
+
+chapters = '\n'.join([
+ open(os.path.join('src', 'zope', 'testing', 'testrunner', name)).read()
+ for name in (
+ 'testrunner.txt',
+ 'testrunner-simple.txt',
+ 'testrunner-layers-api.txt',
+ 'testrunner-layers.txt',
+ 'testrunner-arguments.txt',
+ 'testrunner-verbose.txt',
+ 'testrunner-test-selection.txt',
+ 'testrunner-progress.txt',
+
+ # The following seems to cause weird unicode in the output: :(
+ ## 'testrunner-errors.txt',
+
+ 'testrunner-debugging.txt',
+ 'testrunner-layers-ntd.txt',
+ 'testrunner-coverage.txt',
+ 'testrunner-profiling.txt',
+ 'testrunner-wo-source.txt',
+ 'testrunner-repeat.txt',
+ 'testrunner-gc.txt',
+ 'testrunner-leaks.txt',
+ 'testrunner-knit.txt',
+ )])
+
+chapters += '\n'.join([
+ open(os.path.join('src', 'zope', 'testing', name)).read()
+ for name in (
+ 'formparser.txt',
+ 'setupstack.txt',
+ )])
+
+long_description=(
+ open('README.txt').read()
+ + '\n' +
+ open('CHANGES.txt').read()
+ + '\n' +
+ 'Detailed Documentation\n'
+ '**********************\n'
+ + '\n' + chapters
+ )
+
+setup(
+ name='zope.testing',
+ version = '3.9.4-p8',
+ url='http://pypi.python.org/pypi/zope.testing',
+ license='ZPL 2.1',
+ description='Zope testing framework, including the testrunner script.',
+ long_description=long_description,
+ author='Zope Foundation and Contributors',
+ author_email='zope-dev@xxxxxxxx',
+
+ packages=["zope", "zope.testing"],
+ package_dir = {'': 'src'},
+
+ classifiers=[
+ "Development Status :: 5 - Production/Stable",
+ "Environment :: Console",
+ "Framework :: Zope3",
+ "Intended Audience :: Developers",
+ "License :: OSI Approved :: Zope Public License",
+ "Operating System :: OS Independent",
+ "Programming Language :: Python :: 2.4",
+ "Programming Language :: Python :: 2.5",
+ "Programming Language :: Python :: 2.6",
+ "Topic :: Software Development :: Libraries :: Python Modules",
+ "Topic :: Software Development :: Testing",
+ ],
+
+ **extra)
=== renamed file 'setup.py' => 'setup.py.moved'
=== added directory 'src'
=== renamed directory 'src' => 'src.moved'
=== added directory 'src/zope'
=== added file 'src/zope/__init__.py'
--- src/zope/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+__import__('pkg_resources').declare_namespace(__name__)
=== added directory 'src/zope/testing'
=== added file 'src/zope/testing/__init__.py'
--- src/zope/testing/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,13 @@
+##############################################################################
+#
+# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
=== added file 'src/zope/testing/cleanup.py'
--- src/zope/testing/cleanup.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/cleanup.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,65 @@
+##############################################################################
+#
+# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Provide a standard cleanup registry
+
+Unit tests that change global data should include the CleanUp base
+class, which provides simpler setUp and tearDown methods that call
+global-data cleanup routines::
+
+ class Test(CleanUp, unittest.TestCase):
+
+ ....
+
+If custom setUp or tearDown are needed, then the base routines should
+be called, as in::
+
+ def tearDown(self):
+ super(Test, self).tearDown()
+ ....
+
+Cleanup routines for global data should be registered by passing them to
+addCleanup::
+
+
+ addCleanUp(pigRegistry._clear)
+
+
+$Id: cleanup.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+_cleanups = []
+
+def addCleanUp(func, args=(), kw={}):
+ """Register a cleanup routines
+
+ Pass a function to be called to cleanup global data.
+ Optional argument tuple and keyword arguments may be passed.
+ """
+ _cleanups.append((func, args, kw))
+
+class CleanUp(object):
+ """Mix-in class providing clean-up setUp and tearDown routines."""
+
+ def cleanUp(self):
+ """Clean up global data."""
+ cleanUp()
+
+ setUp = tearDown = cleanUp
+
+
+def cleanUp():
+ """Clean up global data."""
+ for func, args, kw in _cleanups:
+ func(*args, **kw)
+
+setUp = tearDown = cleanUp
=== added directory 'src/zope/testing/doctest'
=== added file 'src/zope/testing/doctest.txt'
--- src/zope/testing/doctest.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/doctest.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,49 @@
+========================
+Additional doctest Tests
+========================
+
+Most `doctest` module tests are located within the module. This file only
+tests a few additional features not covered by the module tests, so that the
+changes to the `doctest` module -- which is forked from the Python standard
+library -- are minimized.
+
+Working with Carriage Returns
+-----------------------------
+
+Due to the way releases are made on different platforms, we sometimes test
+files on a *nix system with Windows file endings. Unfortunately, that leaves
+some of the test files broken:
+
+ >>> import tempfile
+ >>> fn = tempfile.mktemp()
+ >>> open(fn, 'w').write('Test:\r\n\r\n >>> x = 1 + 1\r\n\r\nDone.\r\n')
+
+Let's now run it as a doctest:
+
+ >>> from zope.testing import doctest
+ >>> doctest.testfile(fn, False)
+ (0, 1)
+
+It worked. Let's also try the test file suite:
+
+ >>> import unittest
+ >>> result = unittest.TestResult()
+ >>> doctest.DocFileSuite(fn, module_relative=False).run(result) #doctest: +ELLIPSIS
+ <...TestResult run=1 errors=0 failures=0>
+
+Regression tests
+----------------
+
+This section is about regression tests of ``zope.testing`` itself.
+
+ >>> from zope.testing.doctest import *
+
+LP #69988 and #144569 both assert that doctests fail when rendering
+non-ASCII output with a UnicodeDecodeError. However, this does not appear
+to be so:
+
+ >>> print u'abc'
+ abc
+
+ >>> print u'\xe9'.encode('utf-8')
+ é
=== added file 'src/zope/testing/doctest/__init__.py'
--- src/zope/testing/doctest/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/doctest/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,2964 @@
+# Module doctest.
+# Released to the public domain 16-Jan-2001, by Tim Peters (tim@xxxxxxxxxx).
+# Major enhancements and refactoring by:
+# Jim Fulton
+# Edward Loper
+
+# Provided as-is; use at your own risk; no warranty; no promises; enjoy!
+
+r"""Module doctest -- a framework for running examples in docstrings.
+
+In simplest use, end each module M to be tested with:
+
+def _test():
+ import doctest
+ doctest.testmod()
+
+if __name__ == "__main__":
+ _test()
+
+Then running the module as a script will cause the examples in the
+docstrings to get executed and verified:
+
+python M.py
+
+This won't display anything unless an example fails, in which case the
+failing example(s) and the cause(s) of the failure(s) are printed to stdout
+(why not stderr? because stderr is a lame hack <0.2 wink>), and the final
+line of output is "Test failed.".
+
+Run it with the -v switch instead:
+
+python M.py -v
+
+and a detailed report of all examples tried is printed to stdout, along
+with assorted summaries at the end.
+
+You can force verbose mode by passing "verbose=True" to testmod, or prohibit
+it by passing "verbose=False". In either of those cases, sys.argv is not
+examined by testmod.
+
+There are a variety of other ways to run doctests, including integration
+with the unittest framework, and support for running non-Python text
+files containing doctests. There are also many ways to override parts
+of doctest's default behaviors. See the Library Reference Manual for
+details.
+"""
+
+__docformat__ = 'reStructuredText en'
+
+__all__ = [
+ # 0, Option Flags
+ 'register_optionflag',
+ 'DONT_ACCEPT_TRUE_FOR_1',
+ 'DONT_ACCEPT_BLANKLINE',
+ 'NORMALIZE_WHITESPACE',
+ 'ELLIPSIS',
+ 'IGNORE_EXCEPTION_DETAIL',
+ 'COMPARISON_FLAGS',
+ 'REPORT_UDIFF',
+ 'REPORT_CDIFF',
+ 'REPORT_NDIFF',
+ 'REPORT_ONLY_FIRST_FAILURE',
+ 'REPORTING_FLAGS',
+ # 1. Utility Functions
+ 'is_private',
+ # 2. Example & DocTest
+ 'Example',
+ 'DocTest',
+ # 3. Doctest Parser
+ 'DocTestParser',
+ # 4. Doctest Finder
+ 'DocTestFinder',
+ # 5. Doctest Runner
+ 'DocTestRunner',
+ 'OutputChecker',
+ 'DocTestFailure',
+ 'UnexpectedException',
+ 'DebugRunner',
+ # 6. Test Functions
+ 'testmod',
+ 'testfile',
+ 'run_docstring_examples',
+ # 7. Tester
+ 'Tester',
+ # 8. Unittest Support
+ 'DocTestSuite',
+ 'DocFileSuite',
+ 'set_unittest_reportflags',
+ # 9. Debugging Support
+ 'script_from_examples',
+ 'testsource',
+ 'debug_src',
+ 'debug',
+]
+
+import __future__
+
+import doctest
+import sys, traceback, inspect, linecache, os, re
+import unittest, difflib, pdb, tempfile
+import warnings
+from doctest import DocTestFailure, UnexpectedException
+from StringIO import StringIO
+from zope.testing.exceptions import DocTestFailureException
+
+# Don't whine about the deprecated is_private function in this
+# module's tests.
+warnings.filterwarnings("ignore", "is_private", DeprecationWarning,
+ __name__, 0)
+
+# Tell people to use the builtin module instead.
+warnings.warn('zope.testing.doctest is deprecated in favour of '
+ 'the Python standard library doctest module', DeprecationWarning,
+ stacklevel=2)
+
+class UnusedFootnoteWarning(Warning):
+ """Warn about a footnote that is defined, but never referenced."""
+
+real_pdb_set_trace = pdb.set_trace
+
+# There are 4 basic classes:
+# - Example: a <source, want> pair, plus an intra-docstring line number.
+# - DocTest: a collection of examples, parsed from a docstring, plus
+# info about where the docstring came from (name, filename, lineno).
+# - DocTestFinder: extracts DocTests from a given object's docstring and
+# its contained objects' docstrings.
+# - DocTestRunner: runs DocTest cases, and accumulates statistics.
+#
+# So the basic picture is:
+#
+# list of:
+# +------+ +---------+ +-------+
+# |object| --DocTestFinder-> | DocTest | --DocTestRunner-> |results|
+# +------+ +---------+ +-------+
+# | Example |
+# | ... |
+# | Example |
+# +---------+
+
+# Option constants.
+
+from doctest import register_optionflag, \
+ OPTIONFLAGS_BY_NAME, \
+ DONT_ACCEPT_TRUE_FOR_1, \
+ DONT_ACCEPT_BLANKLINE, \
+ NORMALIZE_WHITESPACE, \
+ ELLIPSIS, \
+ IGNORE_EXCEPTION_DETAIL, \
+ COMPARISON_FLAGS, \
+ REPORT_UDIFF, \
+ REPORT_CDIFF, \
+ REPORT_NDIFF, \
+ REPORT_ONLY_FIRST_FAILURE, \
+ REPORTING_FLAGS
+
+INTERPRET_FOOTNOTES = register_optionflag('INTERPRET_FOOTNOTES')
+
+# Special string markers for use in `want` strings:
+BLANKLINE_MARKER = '<BLANKLINE>'
+ELLIPSIS_MARKER = '...'
+
+######################################################################
+## Table of Contents
+######################################################################
+# 1. Utility Functions
+# 2. Example & DocTest -- store test cases
+# 3. DocTest Parser -- extracts examples from strings
+# 4. DocTest Finder -- extracts test cases from objects
+# 5. DocTest Runner -- runs test cases
+# 6. Test Functions -- convenient wrappers for testing
+# 7. Tester Class -- for backwards compatibility
+# 8. Unittest Support
+# 9. Debugging Support
+# 10. Example Usage
+
+######################################################################
+## 1. Utility Functions
+######################################################################
+
+def is_private(prefix, base):
+ """prefix, base -> true iff name prefix + "." + base is "private".
+
+ Prefix may be an empty string, and base does not contain a period.
+ Prefix is ignored (although functions you write conforming to this
+ protocol may make use of it).
+ Return true iff base begins with an (at least one) underscore, but
+ does not both begin and end with (at least) two underscores.
+
+ >>> is_private("a.b", "my_func")
+ False
+ >>> is_private("____", "_my_func")
+ True
+ >>> is_private("someclass", "__init__")
+ False
+ >>> is_private("sometypo", "__init_")
+ True
+ >>> is_private("x.y.z", "_")
+ True
+ >>> is_private("_x.y.z", "__")
+ False
+ >>> is_private("", "") # senseless but consistent
+ False
+ """
+ warnings.warn("is_private is deprecated; it wasn't useful; "
+ "examine DocTestFinder.find() lists instead",
+ DeprecationWarning, stacklevel=2)
+ return base[:1] == "_" and not base[:2] == "__" == base[-2:]
+
+def _extract_future_flags(globs):
+ """
+ Return the compiler-flags associated with the future features that
+ have been imported into the given namespace (globs).
+ """
+ flags = 0
+ for fname in __future__.all_feature_names:
+ feature = globs.get(fname, None)
+ if feature is getattr(__future__, fname):
+ flags |= feature.compiler_flag
+ return flags
+
+def _normalize_module(module, depth=2):
+ """
+ Return the module specified by `module`. In particular:
+ - If `module` is a module, then return module.
+ - If `module` is a string, then import and return the
+ module with that name.
+ - If `module` is None, then return the calling module.
+ The calling module is assumed to be the module of
+ the stack frame at the given depth in the call stack.
+ """
+ if inspect.ismodule(module):
+ return module
+ elif isinstance(module, (str, unicode)):
+ return __import__(module, globals(), locals(), ["*"])
+ elif module is None:
+ return sys.modules[sys._getframe(depth).f_globals['__name__']]
+ else:
+ raise TypeError("Expected a module, string, or None")
+
+def _indent(s, indent=4):
+ """
+ Add the given number of space characters to the beginning every
+ non-blank line in `s`, and return the result.
+ """
+ # This regexp matches the start of non-blank lines:
+ return re.sub('(?m)^(?!$)', indent*' ', s)
+
+def _exception_traceback(exc_info):
+ """
+ Return a string containing a traceback message for the given
+ exc_info tuple (as returned by sys.exc_info()).
+ """
+ # Get a traceback message.
+ excout = StringIO()
+ exc_type, exc_val, exc_tb = exc_info
+ traceback.print_exception(exc_type, exc_val, exc_tb, file=excout)
+ return excout.getvalue()
+
+# Override some StringIO methods.
+class _SpoofOut(StringIO):
+ def getvalue(self):
+ result = StringIO.getvalue(self)
+ # If anything at all was written, make sure there's a trailing
+ # newline. There's no way for the expected output to indicate
+ # that a trailing newline is missing.
+ if result and not result.endswith("\n"):
+ result += "\n"
+ # Prevent softspace from screwing up the next test case, in
+ # case they used print with a trailing comma in an example.
+ if hasattr(self, "softspace"):
+ del self.softspace
+ return result
+
+ def truncate(self, size=None):
+ StringIO.truncate(self, size)
+ if hasattr(self, "softspace"):
+ del self.softspace
+
+ def write(self, value):
+ if isinstance(value, unicode):
+ value = value.encode('utf8')
+ StringIO.write(self, value)
+
+# Worst-case linear-time ellipsis matching.
+def _ellipsis_match(want, got):
+ """
+ Essentially the only subtle case:
+ >>> _ellipsis_match('aa...aa', 'aaa')
+ False
+ """
+ if ELLIPSIS_MARKER not in want:
+ return want == got
+
+ # Find "the real" strings.
+ ws = want.split(ELLIPSIS_MARKER)
+ assert len(ws) >= 2
+
+ # Deal with exact matches possibly needed at one or both ends.
+ startpos, endpos = 0, len(got)
+ w = ws[0]
+ if w: # starts with exact match
+ if got.startswith(w):
+ startpos = len(w)
+ del ws[0]
+ else:
+ return False
+ w = ws[-1]
+ if w: # ends with exact match
+ if got.endswith(w):
+ endpos -= len(w)
+ del ws[-1]
+ else:
+ return False
+
+ if startpos > endpos:
+ # Exact end matches required more characters than we have, as in
+ # _ellipsis_match('aa...aa', 'aaa')
+ return False
+
+ # For the rest, we only need to find the leftmost non-overlapping
+ # match for each piece. If there's no overall match that way alone,
+ # there's no overall match period.
+ for w in ws:
+ # w may be '' at times, if there are consecutive ellipses, or
+ # due to an ellipsis at the start or end of `want`. That's OK.
+ # Search for an empty string succeeds, and doesn't change startpos.
+ startpos = got.find(w, startpos, endpos)
+ if startpos < 0:
+ return False
+ startpos += len(w)
+
+ return True
+
+def _comment_line(line):
+ "Return a commented form of the given line"
+ line = line.rstrip()
+ if line:
+ return '# '+line
+ else:
+ return '#'
+
+class _OutputRedirectingPdb(pdb.Pdb):
+ """
+ A specialized version of the python debugger that redirects stdout
+ to a given stream when interacting with the user. Stdout is *not*
+ redirected when traced code is executed.
+ """
+ def __init__(self, out):
+ self.__out = out
+ self.__debugger_used = False
+ try:
+ pdb.Pdb.__init__(self, stdin=sys.stdin, stdout=out)
+ except TypeError:
+ pdb.Pdb.__init__(self)
+ # enable readline
+ self.use_rawinput = 1
+
+ def set_trace(self):
+ self.__debugger_used = True
+ pdb.Pdb.set_trace(self)
+
+ def set_continue(self):
+ # Calling set_continue unconditionally would break unit test coverage
+ # reporting, as Bdb.set_continue calls sys.settrace(None).
+ if self.__debugger_used:
+ pdb.Pdb.set_continue(self)
+
+ def trace_dispatch(self, *args):
+ # Redirect stdout to the given stream.
+ save_stdout = sys.stdout
+ sys.stdout = self.__out
+ # Call Pdb's trace dispatch method.
+ result = pdb.Pdb.trace_dispatch(self, *args)
+ # Restore stdout.
+ sys.stdout = save_stdout
+ return result
+
+# [XX] Normalize with respect to os.path.pardir?
+def _module_relative_path(module, path):
+ if not inspect.ismodule(module):
+ raise TypeError('Expected a module: %r' % module)
+ if path.startswith('/'):
+ raise ValueError('Module-relative files may not have absolute paths')
+
+ # Find the base directory for the path.
+ if hasattr(module, '__file__'):
+ # A normal module/package
+ basedir = os.path.split(module.__file__)[0]
+ elif module.__name__ == '__main__':
+ # An interactive session.
+ if len(sys.argv)>0 and sys.argv[0] != '':
+ basedir = os.path.split(sys.argv[0])[0]
+ else:
+ basedir = os.curdir
+ else:
+ # A module w/o __file__ (this includes builtins)
+ raise ValueError("Can't resolve paths relative to the module " +
+ module + " (it has no __file__)")
+
+ # Combine the base directory and the path.
+ return os.path.join(basedir, *(path.split('/')))
+
+######################################################################
+## 2. Example & DocTest
+######################################################################
+## - An "example" is a <source, want> pair, where "source" is a
+## fragment of source code, and "want" is the expected output for
+## "source." The Example class also includes information about
+## where the example was extracted from.
+##
+## - A "doctest" is a collection of examples, typically extracted from
+## a string (such as an object's docstring). The DocTest class also
+## includes information about where the string was extracted from.
+
+class Example:
+ """
+ A single doctest example, consisting of source code and expected
+ output. `Example` defines the following attributes:
+
+ - source: A single Python statement, always ending with a newline.
+ The constructor adds a newline if needed.
+
+ - want: The expected output from running the source code (either
+ from stdout, or a traceback in case of exception). `want` ends
+ with a newline unless it's empty, in which case it's an empty
+ string. The constructor adds a newline if needed.
+
+ - exc_msg: The exception message generated by the example, if
+ the example is expected to generate an exception; or `None` if
+ it is not expected to generate an exception. This exception
+ message is compared against the return value of
+ `traceback.format_exception_only()`. `exc_msg` ends with a
+ newline unless it's `None`. The constructor adds a newline
+ if needed.
+
+ - lineno: The line number within the DocTest string containing
+ this Example where the Example begins. This line number is
+ zero-based, with respect to the beginning of the DocTest.
+
+ - indent: The example's indentation in the DocTest string.
+ I.e., the number of space characters that preceed the
+ example's first prompt.
+
+ - options: A dictionary mapping from option flags to True or
+ False, which is used to override default options for this
+ example. Any option flags not contained in this dictionary
+ are left at their default value (as specified by the
+ DocTestRunner's optionflags). By default, no options are set.
+ """
+ def __init__(self, source, want, exc_msg=None, lineno=0, indent=0,
+ options=None):
+ # Normalize inputs.
+ if not source.endswith('\n'):
+ source += '\n'
+ if want and not want.endswith('\n'):
+ want += '\n'
+ if exc_msg is not None and not exc_msg.endswith('\n'):
+ exc_msg += '\n'
+ # Store properties.
+ self.source = source
+ self.want = want
+ self.lineno = lineno
+ self.indent = indent
+ if options is None: options = {}
+ self.options = options
+ self.exc_msg = exc_msg
+
+class DocTest:
+ """
+ A collection of doctest examples that should be run in a single
+ namespace. Each `DocTest` defines the following attributes:
+
+ - examples: the list of examples.
+
+ - globs: The namespace (aka globals) that the examples should
+ be run in.
+
+ - name: A name identifying the DocTest (typically, the name of
+ the object whose docstring this DocTest was extracted from).
+
+ - filename: The name of the file that this DocTest was extracted
+ from, or `None` if the filename is unknown.
+
+ - lineno: The line number within filename where this DocTest
+ begins, or `None` if the line number is unavailable. This
+ line number is zero-based, with respect to the beginning of
+ the file.
+
+ - docstring: The string that the examples were extracted from,
+ or `None` if the string is unavailable.
+ """
+ def __init__(self, examples, globs, name, filename, lineno, docstring):
+ """
+ Create a new DocTest containing the given examples. The
+ DocTest's globals are initialized with a copy of `globs`.
+ """
+ assert not isinstance(examples, basestring), \
+ "DocTest no longer accepts str; use DocTestParser instead"
+ self.examples = examples
+ self.docstring = docstring
+ self.globs = globs.copy()
+ self.name = name
+ self.filename = filename
+ self.lineno = lineno
+
+ def __repr__(self):
+ if len(self.examples) == 0:
+ examples = 'no examples'
+ elif len(self.examples) == 1:
+ examples = '1 example'
+ else:
+ examples = '%d examples' % len(self.examples)
+ return ('<DocTest %s from %s:%s (%s)>' %
+ (self.name, self.filename, self.lineno, examples))
+
+
+ # This lets us sort tests by name:
+ def __cmp__(self, other):
+ if not isinstance(other, DocTest):
+ return -1
+ return cmp((self.name, self.filename, self.lineno, id(self)),
+ (other.name, other.filename, other.lineno, id(other)))
+
+######################################################################
+## 3. DocTestParser
+######################################################################
+
+class DocTestParser:
+ """
+ A class used to parse strings containing doctest examples.
+ """
+ # This regular expression is used to find doctest examples in a
+ # string. It defines three groups: `source` is the source code
+ # (including leading indentation and prompts); `indent` is the
+ # indentation of the first (PS1) line of the source code; and
+ # `want` is the expected output (including leading indentation).
+ _EXAMPLE_RE = re.compile(r'''
+ # Source consists of a PS1 line followed by zero or more PS2 lines.
+ (?P<source>
+ (?:^(?P<indent> [ ]*) >>> .*) # PS1 line
+ (?:\n [ ]* \.\.\. .*)*) # PS2 lines
+ \n?
+ # Want consists of any non-blank lines that do not start with PS1.
+ (?P<want> (?:(?![ ]*$) # Not a blank line
+ (?![ ]*>>>) # Not a line starting with PS1
+ .*$\n? # But any other line
+ )*)
+ ''', re.MULTILINE | re.VERBOSE)
+
+ # A regular expression for handling `want` strings that contain
+ # expected exceptions. It divides `want` into three pieces:
+ # - the traceback header line (`hdr`)
+ # - the traceback stack (`stack`)
+ # - the exception message (`msg`), as generated by
+ # traceback.format_exception_only()
+ # `msg` may have multiple lines. We assume/require that the
+ # exception message is the first non-indented line starting with a word
+ # character following the traceback header line.
+ _EXCEPTION_RE = re.compile(r"""
+ # Grab the traceback header. Different versions of Python have
+ # said different things on the first traceback line.
+ ^(?P<hdr> Traceback\ \(
+ (?: most\ recent\ call\ last
+ | innermost\ last
+ ) \) :
+ )
+ \s* $ # toss trailing whitespace on the header.
+ (?P<stack> .*?) # don't blink: absorb stuff until...
+ ^ (?P<msg> \w+ .*) # a line *starts* with alphanum.
+ """, re.VERBOSE | re.MULTILINE | re.DOTALL)
+
+ # A callable returning a true value iff its argument is a blank line
+ # or contains a single comment.
+ _IS_BLANK_OR_COMMENT = re.compile(r'^[ ]*(#.*)?$').match
+
+ # Find footnote references.
+ _FOOTNOTE_REFERENCE_RE = re.compile(r'\[([^\]]+)]_')
+
+ # Find footnote definitions.
+ _FOOTNOTE_DEFINITION_RE = re.compile(
+ r'^\.\.\s*\[\s*([^\]]+)\s*\].*$', re.MULTILINE)
+
+ # End of footnote regex. Just looks for any unindented line.
+ _FOOTNOTE_END_RE = re.compile(r'^\S+', re.MULTILINE)
+
+ def parse(self, string, name='<string>', optionflags=0):
+ """
+ Divide the given string into examples and intervening text,
+ and return them as a list of alternating Examples and strings.
+ Line numbers for the Examples are 0-based. The optional
+ argument `name` is a name identifying this string, and is only
+ used for error messages.
+ """
+ string = string.expandtabs()
+ # If all lines begin with the same indentation, then strip it.
+ min_indent = self._min_indent(string)
+ if min_indent > 0:
+ string = '\n'.join([l[min_indent:] for l in string.split('\n')])
+
+ output = []
+ charno, lineno = 0, 0
+ # Find all doctest examples in the string:
+ for m in self._EXAMPLE_RE.finditer(string):
+ # Add the pre-example text to `output`.
+ output.append(string[charno:m.start()])
+ # Update lineno (lines before this example)
+ lineno += string.count('\n', charno, m.start())
+ # Extract info from the regexp match.
+ (source, options, want, exc_msg) = \
+ self._parse_example(m, name, lineno)
+ # Create an Example, and add it to the list.
+ if not self._IS_BLANK_OR_COMMENT(source):
+ output.append( Example(source, want, exc_msg,
+ lineno=lineno,
+ indent=min_indent+len(m.group('indent')),
+ options=options) )
+ # Update lineno (lines inside this example)
+ lineno += string.count('\n', m.start(), m.end())
+ # Update charno.
+ charno = m.end()
+ # Add any remaining post-example text to `output`.
+ output.append(string[charno:])
+
+ if optionflags & INTERPRET_FOOTNOTES:
+ footnotes = {}
+ in_footnote = False
+ # collect all the footnotes
+ for x in output:
+ if in_footnote:
+ footnote.append(x)
+ # we're collecting prose and examples for a footnote
+ if isinstance(x, Example):
+ x._footnote_name = name
+ elif self._FOOTNOTE_END_RE.search(x):
+ # this looks like prose that ends a footnote
+ in_footnote = False
+ footnotes[name] = footnote
+ del name
+ del footnote
+
+ if not in_footnote:
+ if not isinstance(x, Example):
+ matches = list(
+ self._FOOTNOTE_DEFINITION_RE.finditer(x))
+
+ if matches:
+ # all but the last one don't have any code
+ # note: we intentionally reuse the "leaked" value
+ # of match below
+ for match in matches:
+ footnotes[match.group(1)] = []
+
+ in_footnote = True
+ name = match.group(1)
+ footnote = []
+
+ # if we were still collecting a footnote when the loop ended,
+ # stash it away so it's not lost
+ if in_footnote:
+ footnotes[name] = footnote
+
+ # inject each footnote into the point(s) at which it is referenced
+ new_output = []
+ defined_footnotes = []
+ used_footnotes = []
+ for x in output:
+ if isinstance(x, Example):
+ # we don't want to execute footnotes where they're defined
+ if hasattr(x, '_footnote_name'):
+ defined_footnotes.append(x._footnote_name)
+ continue
+ else:
+ m = None
+ for m in self._FOOTNOTE_REFERENCE_RE.finditer(x):
+ name = m.group(1)
+ if name not in footnotes:
+ raise KeyError(
+ 'A footnote was referred to, but never'
+ ' defined: %r' % name)
+
+ new_output.append(x)
+ new_output.extend(footnotes[name])
+ used_footnotes.append(name)
+ if m is not None:
+ continue
+
+ new_output.append(x)
+ output = new_output
+
+ # make sure that all of the footnotes found were actually used
+ unused_footnotes = set(defined_footnotes) - set(used_footnotes)
+ for x in unused_footnotes:
+ warnings.warn('a footnote was defined, but never used: %r' % x,
+ UnusedFootnoteWarning)
+
+ return output
+
+ def get_doctest(self, string, globs, name, filename, lineno,
+ optionflags=0):
+ """
+ Extract all doctest examples from the given string, and
+ collect them into a `DocTest` object.
+
+ `globs`, `name`, `filename`, and `lineno` are attributes for
+ the new `DocTest` object. See the documentation for `DocTest`
+ for more information.
+ """
+ return DocTest(self.get_examples(string, name, optionflags), globs,
+ name, filename, lineno, string)
+
+ def get_examples(self, string, name='<string>', optionflags=0):
+ """
+ Extract all doctest examples from the given string, and return
+ them as a list of `Example` objects. Line numbers are
+ 0-based, because it's most common in doctests that nothing
+ interesting appears on the same line as opening triple-quote,
+ and so the first interesting line is called \"line 1\" then.
+
+ The optional argument `name` is a name identifying this
+ string, and is only used for error messages.
+ """
+ return [x for x in self.parse(string, name, optionflags)
+ if isinstance(x, Example)]
+
+ def _parse_example(self, m, name, lineno):
+ """
+ Given a regular expression match from `_EXAMPLE_RE` (`m`),
+ return a pair `(source, want)`, where `source` is the matched
+ example's source code (with prompts and indentation stripped);
+ and `want` is the example's expected output (with indentation
+ stripped).
+
+ `name` is the string's name, and `lineno` is the line number
+ where the example starts; both are used for error messages.
+ """
+ # Get the example's indentation level.
+ indent = len(m.group('indent'))
+
+ # Divide source into lines; check that they're properly
+ # indented; and then strip their indentation & prompts.
+ source_lines = m.group('source').split('\n')
+ self._check_prompt_blank(source_lines, indent, name, lineno)
+ self._check_prefix(source_lines[1:], ' '*indent + '.', name, lineno)
+ source = '\n'.join([sl[indent+4:] for sl in source_lines])
+
+ # Divide want into lines; check that it's properly indented; and
+ # then strip the indentation. Spaces before the last newline should
+ # be preserved, so plain rstrip() isn't good enough.
+ want = m.group('want')
+ want_lines = want.split('\n')
+ if len(want_lines) > 1 and re.match(r' *$', want_lines[-1]):
+ del want_lines[-1] # forget final newline & spaces after it
+ self._check_prefix(want_lines, ' '*indent, name,
+ lineno + len(source_lines))
+ want = '\n'.join([wl[indent:] for wl in want_lines])
+
+ # If `want` contains a traceback message, then extract it.
+ m = self._EXCEPTION_RE.match(want)
+ if m:
+ exc_msg = m.group('msg')
+ else:
+ exc_msg = None
+
+ # Extract options from the source.
+ options = self._find_options(source, name, lineno)
+
+ return source, options, want, exc_msg
+
+ # This regular expression looks for option directives in the
+ # source code of an example. Option directives are comments
+ # starting with "doctest:". Warning: this may give false
+ # positives for string-literals that contain the string
+ # "#doctest:". Eliminating these false positives would require
+ # actually parsing the string; but we limit them by ignoring any
+ # line containing "#doctest:" that is *followed* by a quote mark.
+ _OPTION_DIRECTIVE_RE = re.compile(r'#\s*doctest:\s*([^\n\'"]*)$',
+ re.MULTILINE)
+
+ def _find_options(self, source, name, lineno):
+ """
+ Return a dictionary containing option overrides extracted from
+ option directives in the given source string.
+
+ `name` is the string's name, and `lineno` is the line number
+ where the example starts; both are used for error messages.
+ """
+ options = {}
+ # (note: with the current regexp, this will match at most once:)
+ for m in self._OPTION_DIRECTIVE_RE.finditer(source):
+ option_strings = m.group(1).replace(',', ' ').split()
+ for option in option_strings:
+ if (option[0] not in '+-' or
+ option[1:] not in OPTIONFLAGS_BY_NAME):
+ raise ValueError('line %r of the doctest for %s '
+ 'has an invalid option: %r' %
+ (lineno+1, name, option))
+ flag = OPTIONFLAGS_BY_NAME[option[1:]]
+ options[flag] = (option[0] == '+')
+ if options and self._IS_BLANK_OR_COMMENT(source):
+ raise ValueError('line %r of the doctest for %s has an option '
+ 'directive on a line with no example: %r' %
+ (lineno, name, source))
+ return options
+
+ # This regular expression finds the indentation of every non-blank
+ # line in a string.
+ _INDENT_RE = re.compile('^([ ]*)(?=\S)', re.MULTILINE)
+
+ def _min_indent(self, s):
+ "Return the minimum indentation of any non-blank line in `s`"
+ indents = [len(indent) for indent in self._INDENT_RE.findall(s)]
+ if len(indents) > 0:
+ return min(indents)
+ else:
+ return 0
+
+ def _check_prompt_blank(self, lines, indent, name, lineno):
+ """
+ Given the lines of a source string (including prompts and
+ leading indentation), check to make sure that every prompt is
+ followed by a space character. If any line is not followed by
+ a space character, then raise ValueError.
+ """
+ for i, line in enumerate(lines):
+ if len(line) >= indent+4 and line[indent+3] != ' ':
+ raise ValueError('line %r of the docstring for %s '
+ 'lacks blank after %s: %r' %
+ (lineno+i+1, name,
+ line[indent:indent+3], line))
+
+ def _check_prefix(self, lines, prefix, name, lineno):
+ """
+ Check that every line in the given list starts with the given
+ prefix; if any line does not, then raise a ValueError.
+ """
+ for i, line in enumerate(lines):
+ if line and not line.startswith(prefix):
+ raise ValueError('line %r of the docstring for %s has '
+ 'inconsistent leading whitespace: %r' %
+ (lineno+i+1, name, line))
+
+
+######################################################################
+## 4. DocTest Finder
+######################################################################
+
+class DocTestFinder:
+ """
+ A class used to extract the DocTests that are relevant to a given
+ object, from its docstring and the docstrings of its contained
+ objects. Doctests can currently be extracted from the following
+ object types: modules, functions, classes, methods, staticmethods,
+ classmethods, and properties.
+ """
+
+ def __init__(self, verbose=False, parser=DocTestParser(),
+ recurse=True, _namefilter=None, exclude_empty=True):
+ """
+ Create a new doctest finder.
+
+ The optional argument `parser` specifies a class or
+ function that should be used to create new DocTest objects (or
+ objects that implement the same interface as DocTest). The
+ signature for this factory function should match the signature
+ of the DocTest constructor.
+
+ If the optional argument `recurse` is false, then `find` will
+ only examine the given object, and not any contained objects.
+
+ If the optional argument `exclude_empty` is false, then `find`
+ will include tests for objects with empty docstrings.
+ """
+ self._parser = parser
+ self._verbose = verbose
+ self._recurse = recurse
+ self._exclude_empty = exclude_empty
+ # _namefilter is undocumented, and exists only for temporary backward-
+ # compatibility support of testmod's deprecated isprivate mess.
+ self._namefilter = _namefilter
+
+ def find(self, obj, name=None, module=None, globs=None,
+ extraglobs=None, optionflags=0):
+ """
+ Return a list of the DocTests that are defined by the given
+ object's docstring, or by any of its contained objects'
+ docstrings.
+
+ The optional parameter `module` is the module that contains
+ the given object. If the module is not specified or is None, then
+ the test finder will attempt to automatically determine the
+ correct module. The object's module is used:
+
+ - As a default namespace, if `globs` is not specified.
+ - To prevent the DocTestFinder from extracting DocTests
+ from objects that are imported from other modules.
+ - To find the name of the file containing the object.
+ - To help find the line number of the object within its
+ file.
+
+ Contained objects whose module does not match `module` are ignored.
+
+ If `module` is False, no attempt to find the module will be made.
+ This is obscure, of use mostly in tests: if `module` is False, or
+ is None but cannot be found automatically, then all objects are
+ considered to belong to the (non-existent) module, so all contained
+ objects will (recursively) be searched for doctests.
+
+ The globals for each DocTest is formed by combining `globs`
+ and `extraglobs` (bindings in `extraglobs` override bindings
+ in `globs`). A new copy of the globals dictionary is created
+ for each DocTest. If `globs` is not specified, then it
+ defaults to the module's `__dict__`, if specified, or {}
+ otherwise. If `extraglobs` is not specified, then it defaults
+ to {}.
+
+ """
+ # If name was not specified, then extract it from the object.
+ if name is None:
+ name = getattr(obj, '__name__', None)
+ if name is None:
+ raise ValueError("DocTestFinder.find: name must be given "
+ "when obj.__name__ doesn't exist: %r" %
+ (type(obj),))
+
+ # Find the module that contains the given object (if obj is
+ # a module, then module=obj.). Note: this may fail, in which
+ # case module will be None.
+ if module is False:
+ module = None
+ elif module is None:
+ module = inspect.getmodule(obj)
+
+ # Read the module's source code. This is used by
+ # DocTestFinder._find_lineno to find the line number for a
+ # given object's docstring.
+ try:
+ file = inspect.getsourcefile(obj) or inspect.getfile(obj)
+ source_lines = linecache.getlines(file)
+ if not source_lines:
+ source_lines = None
+ except TypeError:
+ source_lines = None
+
+ # Initialize globals, and merge in extraglobs.
+ if globs is None:
+ if module is None:
+ globs = {}
+ else:
+ globs = module.__dict__.copy()
+ else:
+ globs = globs.copy()
+ if extraglobs is not None:
+ globs.update(extraglobs)
+
+ # Recursively expore `obj`, extracting DocTests.
+ tests = []
+ self._find(tests, obj, name, module, source_lines, globs, {},
+ optionflags=optionflags)
+ return tests
+
+ def _filter(self, obj, prefix, base):
+ """
+ Return true if the given object should not be examined.
+ """
+ return (self._namefilter is not None and
+ self._namefilter(prefix, base))
+
+ def _from_module(self, module, object):
+ """
+ Return true if the given object is defined in the given
+ module.
+ """
+ if module is None:
+ return True
+ elif inspect.isfunction(object):
+ return module.__dict__ is object.func_globals
+ elif inspect.isclass(object):
+ return module.__name__ == object.__module__
+ elif inspect.getmodule(object) is not None:
+ return module is inspect.getmodule(object)
+ elif hasattr(object, '__module__'):
+ return module.__name__ == object.__module__
+ elif isinstance(object, property):
+ return True # [XX] no way not be sure.
+ else:
+ raise ValueError("object must be a class or function")
+
+ def _find(self, tests, obj, name, module, source_lines, globs, seen,
+ optionflags):
+ """
+ Find tests for the given object and any contained objects, and
+ add them to `tests`.
+ """
+ if self._verbose:
+ print 'Finding tests in %s' % name
+
+ # If we've already processed this object, then ignore it.
+ if id(obj) in seen:
+ return
+ seen[id(obj)] = 1
+
+ # Find a test for this object, and add it to the list of tests.
+ test = self._get_test(obj, name, module, globs, source_lines,
+ optionflags)
+ if test is not None:
+ tests.append(test)
+
+ # Look for tests in a module's contained objects.
+ if inspect.ismodule(obj) and self._recurse:
+ for valname, val in obj.__dict__.items():
+ # Check if this contained object should be ignored.
+ if self._filter(val, name, valname):
+ continue
+ valname = '%s.%s' % (name, valname)
+ # Recurse to functions & classes.
+ if ((inspect.isfunction(val) or inspect.isclass(val)) and
+ self._from_module(module, val)):
+ self._find(tests, val, valname, module, source_lines,
+ globs, seen, optionflags)
+
+ # Look for tests in a module's __test__ dictionary.
+ if inspect.ismodule(obj) and self._recurse:
+ for valname, val in getattr(obj, '__test__', {}).items():
+ if not isinstance(valname, basestring):
+ raise ValueError("DocTestFinder.find: __test__ keys "
+ "must be strings: %r" %
+ (type(valname),))
+ if not (inspect.isfunction(val) or inspect.isclass(val) or
+ inspect.ismethod(val) or inspect.ismodule(val) or
+ isinstance(val, basestring)):
+ raise ValueError("DocTestFinder.find: __test__ values "
+ "must be strings, functions, methods, "
+ "classes, or modules: %r" %
+ (type(val),))
+ valname = '%s.__test__.%s' % (name, valname)
+ self._find(tests, val, valname, module, source_lines,
+ globs, seen, optionflags)
+
+ # Look for tests in a class's contained objects.
+ if inspect.isclass(obj) and self._recurse:
+ for valname, val in obj.__dict__.items():
+ # Check if this contained object should be ignored.
+ if self._filter(val, name, valname):
+ continue
+ # Special handling for staticmethod/classmethod.
+ if isinstance(val, staticmethod):
+ val = getattr(obj, valname)
+ if isinstance(val, classmethod):
+ val = getattr(obj, valname).im_func
+
+ # Recurse to methods, properties, and nested classes.
+ if ((inspect.isfunction(val) or inspect.isclass(val) or
+ isinstance(val, property)) and
+ self._from_module(module, val)):
+ valname = '%s.%s' % (name, valname)
+ self._find(tests, val, valname, module, source_lines,
+ globs, seen, optionflags)
+
+ def _get_test(self, obj, name, module, globs, source_lines, optionflags):
+ """
+ Return a DocTest for the given object, if it defines a docstring;
+ otherwise, return None.
+ """
+ # Extract the object's docstring. If it doesn't have one,
+ # then return None (no test for this object).
+ if isinstance(obj, basestring):
+ docstring = obj
+ else:
+ try:
+ if obj.__doc__ is None:
+ docstring = ''
+ else:
+ docstring = obj.__doc__
+ if not isinstance(docstring, basestring):
+ docstring = str(docstring)
+ except (TypeError, AttributeError):
+ docstring = ''
+
+ # Find the docstring's location in the file.
+ lineno = self._find_lineno(obj, source_lines)
+
+ # Don't bother if the docstring is empty.
+ if self._exclude_empty and not docstring:
+ return None
+
+ # Return a DocTest for this object.
+ if module is None:
+ filename = None
+ else:
+ filename = getattr(module, '__file__', module.__name__)
+ if filename[-4:] in (".pyc", ".pyo"):
+ filename = filename[:-1]
+ return self._parser.get_doctest(docstring, globs, name,
+ filename, lineno, optionflags)
+
+ def _find_lineno(self, obj, source_lines):
+ """
+ Return a line number of the given object's docstring. Note:
+ this method assumes that the object has a docstring.
+ """
+ lineno = None
+
+ # Find the line number for modules.
+ if inspect.ismodule(obj):
+ lineno = 0
+
+ # Find the line number for classes.
+ # Note: this could be fooled if a class is defined multiple
+ # times in a single file.
+ if inspect.isclass(obj):
+ if source_lines is None:
+ return None
+ pat = re.compile(r'^\s*class\s*%s\b' %
+ getattr(obj, '__name__', '-'))
+ for i, line in enumerate(source_lines):
+ if pat.match(line):
+ lineno = i
+ break
+
+ # Find the line number for functions & methods.
+ if inspect.ismethod(obj): obj = obj.im_func
+ if inspect.isfunction(obj): obj = obj.func_code
+ if inspect.istraceback(obj): obj = obj.tb_frame
+ if inspect.isframe(obj): obj = obj.f_code
+ if inspect.iscode(obj):
+ lineno = getattr(obj, 'co_firstlineno', None)-1
+
+ # Find the line number where the docstring starts. Assume
+ # that it's the first line that begins with a quote mark.
+ # Note: this could be fooled by a multiline function
+ # signature, where a continuation line begins with a quote
+ # mark.
+ if lineno is not None:
+ if source_lines is None:
+ return lineno+1
+ pat = re.compile('(^|.*:)\s*\w*("|\')')
+ for lineno in range(lineno, len(source_lines)):
+ if pat.match(source_lines[lineno]):
+ return lineno
+
+ # We couldn't find the line number.
+ return None
+
+######################################################################
+## 5. DocTest Runner
+######################################################################
+
+class DocTestRunner:
+ """
+ A class used to run DocTest test cases, and accumulate statistics.
+ The `run` method is used to process a single DocTest case. It
+ returns a tuple `(f, t)`, where `t` is the number of test cases
+ tried, and `f` is the number of test cases that failed.
+
+ >>> tests = DocTestFinder().find(_TestClass)
+ >>> runner = DocTestRunner(verbose=False)
+ >>> for test in tests:
+ ... print runner.run(test)
+ (0, 2)
+ (0, 1)
+ (0, 2)
+ (0, 2)
+
+ The `summarize` method prints a summary of all the test cases that
+ have been run by the runner, and returns an aggregated `(f, t)`
+ tuple:
+
+ >>> runner.summarize(verbose=1)
+ 4 items passed all tests:
+ 2 tests in _TestClass
+ 2 tests in _TestClass.__init__
+ 2 tests in _TestClass.get
+ 1 tests in _TestClass.square
+ 7 tests in 4 items.
+ 7 passed and 0 failed.
+ Test passed.
+ (0, 7)
+
+ The aggregated number of tried examples and failed examples is
+ also available via the `tries` and `failures` attributes:
+
+ >>> runner.tries
+ 7
+ >>> runner.failures
+ 0
+
+ The comparison between expected outputs and actual outputs is done
+ by an `OutputChecker`. This comparison may be customized with a
+ number of option flags; see the documentation for `testmod` for
+ more information. If the option flags are insufficient, then the
+ comparison may also be customized by passing a subclass of
+ `OutputChecker` to the constructor.
+
+ The test runner's display output can be controlled in two ways.
+ First, an output function (`out) can be passed to
+ `TestRunner.run`; this function will be called with strings that
+ should be displayed. It defaults to `sys.stdout.write`. If
+ capturing the output is not sufficient, then the display output
+ can be also customized by subclassing DocTestRunner, and
+ overriding the methods `report_start`, `report_success`,
+ `report_unexpected_exception`, and `report_failure`.
+ """
+ # This divider string is used to separate failure messages, and to
+ # separate sections of the summary.
+ DIVIDER = "*" * 70
+
+ def __init__(self, checker=None, verbose=None, optionflags=0):
+ """
+ Create a new test runner.
+
+ Optional keyword arg `checker` is the `OutputChecker` that
+ should be used to compare the expected outputs and actual
+ outputs of doctest examples.
+
+ Optional keyword arg 'verbose' prints lots of stuff if true,
+ only failures if false; by default, it's true iff '-v' is in
+ sys.argv.
+
+ Optional argument `optionflags` can be used to control how the
+ test runner compares expected output to actual output, and how
+ it displays failures. See the documentation for `testmod` for
+ more information.
+ """
+ self._checker = checker or OutputChecker()
+ if verbose is None:
+ verbose = '-v' in sys.argv
+ self._verbose = verbose
+ self.optionflags = optionflags
+ self.original_optionflags = optionflags
+
+ # Keep track of the examples we've run.
+ self.tries = 0
+ self.failures = 0
+ self._name2ft = {}
+
+ # Create a fake output target for capturing doctest output.
+ self._fakeout = _SpoofOut()
+
+ #/////////////////////////////////////////////////////////////////
+ # Reporting methods
+ #/////////////////////////////////////////////////////////////////
+
+ def report_start(self, out, test, example):
+ """
+ Report that the test runner is about to process the given
+ example. (Only displays a message if verbose=True)
+ """
+ if self._verbose:
+ if example.want:
+ out('Trying:\n' + _indent(example.source) +
+ 'Expecting:\n' + _indent(example.want))
+ else:
+ out('Trying:\n' + _indent(example.source) +
+ 'Expecting nothing\n')
+
+ def report_success(self, out, test, example, got):
+ """
+ Report that the given example ran successfully. (Only
+ displays a message if verbose=True)
+ """
+ if self._verbose:
+ out("ok\n")
+
+ def report_failure(self, out, test, example, got):
+ """
+ Report that the given example failed.
+ """
+ out(self._failure_header(test, example) +
+ self._checker.output_difference(example, got, self.optionflags))
+
+ def report_unexpected_exception(self, out, test, example, exc_info):
+ """
+ Report that the given example raised an unexpected exception.
+ """
+ out(self._failure_header(test, example) +
+ 'Exception raised:\n' + _indent(_exception_traceback(exc_info)))
+
+ def _failure_header(self, test, example):
+ out = [self.DIVIDER]
+ if test.filename:
+ if test.lineno is not None and example.lineno is not None:
+ lineno = test.lineno + example.lineno + 1
+ else:
+ lineno = '?'
+ out.append('File "%s", line %s, in %s' %
+ (test.filename, lineno, test.name))
+ else:
+ out.append('Line %s, in %s' % (example.lineno+1, test.name))
+ out.append('Failed example:')
+ source = example.source
+ out.append(_indent(source))
+ return '\n'.join(out)
+
+ #/////////////////////////////////////////////////////////////////
+ # DocTest Running
+ #/////////////////////////////////////////////////////////////////
+
+ def __run(self, test, compileflags, out):
+ """
+ Run the examples in `test`. Write the outcome of each example
+ with one of the `DocTestRunner.report_*` methods, using the
+ writer function `out`. `compileflags` is the set of compiler
+ flags that should be used to execute examples. Return a tuple
+ `(f, t)`, where `t` is the number of examples tried, and `f`
+ is the number of examples that failed. The examples are run
+ in the namespace `test.globs`.
+ """
+ # Keep track of the number of failures and tries.
+ failures = tries = 0
+
+ # Save the option flags (since option directives can be used
+ # to modify them).
+ original_optionflags = self.optionflags
+
+ SUCCESS, FAILURE, BOOM = range(3) # `outcome` state
+
+ check = self._checker.check_output
+
+ # Process each example.
+ for examplenum, example in enumerate(test.examples):
+
+ # If REPORT_ONLY_FIRST_FAILURE is set, then supress
+ # reporting after the first failure.
+ quiet = (self.optionflags & REPORT_ONLY_FIRST_FAILURE and
+ failures > 0)
+
+ # Merge in the example's options.
+ self.optionflags = original_optionflags
+ if example.options:
+ for (optionflag, val) in example.options.items():
+ if val:
+ self.optionflags |= optionflag
+ else:
+ self.optionflags &= ~optionflag
+
+ # Record that we started this example.
+ tries += 1
+ if not quiet:
+ self.report_start(out, test, example)
+
+ # Use a special filename for compile(), so we can retrieve
+ # the source code during interactive debugging (see
+ # __patched_linecache_getlines).
+ # Line number counting starts with 0 so we add one to get
+ # the real line number.
+ filename = '<doctest %s[line %d, example %d]>' % (
+ test.name, example.lineno+1, examplenum)
+
+ # Run the example in the given context (globs), and record
+ # any exception that gets raised. (But don't intercept
+ # keyboard interrupts.)
+ try:
+ # Don't blink! This is where the user's code gets run.
+ exec compile(example.source, filename, "single",
+ compileflags, 1) in test.globs
+ self.debugger.set_continue() # ==== Example Finished ====
+ exception = None
+ except KeyboardInterrupt:
+ raise
+ except:
+ exception = sys.exc_info()
+ self.debugger.set_continue() # ==== Example Finished ====
+ got = self._fakeout.getvalue() # the actual output
+ self._fakeout.truncate(0)
+ outcome = FAILURE # guilty until proved innocent or insane
+
+ # If the example executed without raising any exceptions,
+ # verify its output.
+ if exception is None:
+ if check(example.want, got, self.optionflags):
+ outcome = SUCCESS
+
+ # The example raised an exception: check if it was expected.
+ else:
+ exc_info = sys.exc_info()
+ exc_msg = traceback.format_exception_only(*exc_info[:2])[-1]
+ if not quiet:
+ got += _exception_traceback(exc_info)
+
+ # If `example.exc_msg` is None, then we weren't expecting
+ # an exception.
+ if example.exc_msg is None:
+ outcome = BOOM
+
+ # We expected an exception: see whether it matches.
+ elif check(example.exc_msg, exc_msg, self.optionflags):
+ outcome = SUCCESS
+
+ # Another chance if they didn't care about the detail.
+ elif self.optionflags & IGNORE_EXCEPTION_DETAIL:
+ m1 = re.match(r'[^:]*:', example.exc_msg)
+ m2 = re.match(r'[^:]*:', exc_msg)
+ if m1 and m2 and check(m1.group(0), m2.group(0),
+ self.optionflags):
+ outcome = SUCCESS
+
+ # Report the outcome.
+ if outcome is SUCCESS:
+ if not quiet:
+ self.report_success(out, test, example, got)
+ elif outcome is FAILURE:
+ if not quiet:
+ self.report_failure(out, test, example, got)
+ failures += 1
+ elif outcome is BOOM:
+ if not quiet:
+ self.report_unexpected_exception(out, test, example,
+ exc_info)
+ failures += 1
+ else:
+ assert False, ("unknown outcome", outcome)
+
+ # Restore the option flags (in case they were modified)
+ self.optionflags = original_optionflags
+
+ # Record and return the number of failures and tries.
+ self.__record_outcome(test, failures, tries)
+ return failures, tries
+
+ def __record_outcome(self, test, f, t):
+ """
+ Record the fact that the given DocTest (`test`) generated `f`
+ failures out of `t` tried examples.
+ """
+ f2, t2 = self._name2ft.get(test.name, (0,0))
+ self._name2ft[test.name] = (f+f2, t+t2)
+ self.failures += f
+ self.tries += t
+
+ __LINECACHE_FILENAME_RE = re.compile(
+ r'<doctest (?P<name>[\w\.]+)\[line \d+, example (?P<examplenum>\d+)\]>$'
+ )
+
+ def __patched_linecache_getlines(self, filename, module_globals=None):
+ m = self.__LINECACHE_FILENAME_RE.match(filename)
+ if m and m.group('name') == self.test.name:
+ example = self.test.examples[int(m.group('examplenum'))]
+ return example.source.splitlines(True)
+ else:
+ if module_globals is None:
+ return self.save_linecache_getlines(filename)
+ else:
+ return self.save_linecache_getlines(filename, module_globals)
+
+ def run(self, test, compileflags=None, out=None, clear_globs=True):
+ """
+ Run the examples in `test`, and display the results using the
+ writer function `out`.
+
+ The examples are run in the namespace `test.globs`. If
+ `clear_globs` is true (the default), then this namespace will
+ be cleared after the test runs, to help with garbage
+ collection. If you would like to examine the namespace after
+ the test completes, then use `clear_globs=False`.
+
+ `compileflags` gives the set of flags that should be used by
+ the Python compiler when running the examples. If not
+ specified, then it will default to the set of future-import
+ flags that apply to `globs`.
+
+ The output of each example is checked using
+ `DocTestRunner.check_output`, and the results are formatted by
+ the `DocTestRunner.report_*` methods.
+ """
+ self.test = test
+
+ if compileflags is None:
+ compileflags = _extract_future_flags(test.globs)
+
+ save_stdout = sys.stdout
+ if out is None:
+ out = save_stdout.write
+ sys.stdout = self._fakeout
+
+ # Patch pdb.set_trace to restore sys.stdout during interactive
+ # debugging (so it's not still redirected to self._fakeout).
+ # Note that the interactive output will go to *our*
+ # save_stdout, even if that's not the real sys.stdout; this
+ # allows us to write test cases for the set_trace behavior.
+ save_set_trace = pdb.set_trace
+ self.debugger = _OutputRedirectingPdb(save_stdout)
+ self.debugger.reset()
+ pdb.set_trace = self.debugger.set_trace
+
+ # Patch linecache.getlines, so we can see the example's source
+ # when we're inside the debugger.
+ self.save_linecache_getlines = linecache.getlines
+ linecache.getlines = self.__patched_linecache_getlines
+
+ try:
+ return self.__run(test, compileflags, out)
+ finally:
+ sys.stdout = save_stdout
+ pdb.set_trace = save_set_trace
+ linecache.getlines = self.save_linecache_getlines
+ if clear_globs:
+ test.globs.clear()
+
+ #/////////////////////////////////////////////////////////////////
+ # Summarization
+ #/////////////////////////////////////////////////////////////////
+ def summarize(self, verbose=None):
+ """
+ Print a summary of all the test cases that have been run by
+ this DocTestRunner, and return a tuple `(f, t)`, where `f` is
+ the total number of failed examples, and `t` is the total
+ number of tried examples.
+
+ The optional `verbose` argument controls how detailed the
+ summary is. If the verbosity is not specified, then the
+ DocTestRunner's verbosity is used.
+ """
+ if verbose is None:
+ verbose = self._verbose
+ notests = []
+ passed = []
+ failed = []
+ totalt = totalf = 0
+ for x in self._name2ft.items():
+ name, (f, t) = x
+ assert f <= t
+ totalt += t
+ totalf += f
+ if t == 0:
+ notests.append(name)
+ elif f == 0:
+ passed.append( (name, t) )
+ else:
+ failed.append(x)
+ if verbose:
+ if notests:
+ print len(notests), "items had no tests:"
+ notests.sort()
+ for thing in notests:
+ print " ", thing
+ if passed:
+ print len(passed), "items passed all tests:"
+ passed.sort()
+ for thing, count in passed:
+ print " %3d tests in %s" % (count, thing)
+ if failed:
+ print self.DIVIDER
+ print len(failed), "items had failures:"
+ failed.sort()
+ for thing, (f, t) in failed:
+ print " %3d of %3d in %s" % (f, t, thing)
+ if verbose:
+ print totalt, "tests in", len(self._name2ft), "items."
+ print totalt - totalf, "passed and", totalf, "failed."
+ if totalf:
+ print "***Test Failed***", totalf, "failures."
+ elif verbose:
+ print "Test passed."
+ return totalf, totalt
+
+ #/////////////////////////////////////////////////////////////////
+ # Backward compatibility cruft to maintain doctest.master.
+ #/////////////////////////////////////////////////////////////////
+ def merge(self, other):
+ d = self._name2ft
+ for name, (f, t) in other._name2ft.items():
+ if name in d:
+ print "*** DocTestRunner.merge: '" + name + "' in both" \
+ " testers; summing outcomes."
+ f2, t2 = d[name]
+ f = f + f2
+ t = t + t2
+ d[name] = f, t
+
+class OutputChecker:
+ """
+ A class used to check the whether the actual output from a doctest
+ example matches the expected output. `OutputChecker` defines two
+ methods: `check_output`, which compares a given pair of outputs,
+ and returns true if they match; and `output_difference`, which
+ returns a string describing the differences between two outputs.
+ """
+ def check_output(self, want, got, optionflags):
+ """
+ Return True iff the actual output from an example (`got`)
+ matches the expected output (`want`). These strings are
+ always considered to match if they are identical; but
+ depending on what option flags the test runner is using,
+ several non-exact match types are also possible. See the
+ documentation for `TestRunner` for more information about
+ option flags.
+ """
+ # Handle the common case first, for efficiency:
+ # if they're string-identical, always return true.
+ if got == want:
+ return True
+
+ # The values True and False replaced 1 and 0 as the return
+ # value for boolean comparisons in Python 2.3.
+ if not (optionflags & DONT_ACCEPT_TRUE_FOR_1):
+ if (got,want) == ("True\n", "1\n"):
+ return True
+ if (got,want) == ("False\n", "0\n"):
+ return True
+
+ # <BLANKLINE> can be used as a special sequence to signify a
+ # blank line, unless the DONT_ACCEPT_BLANKLINE flag is used.
+ if not (optionflags & DONT_ACCEPT_BLANKLINE):
+ # Replace <BLANKLINE> in want with a blank line.
+ want = re.sub('(?m)^%s\s*?$' % re.escape(BLANKLINE_MARKER),
+ '', want)
+ # If a line in got contains only spaces, then remove the
+ # spaces.
+ got = re.sub('(?m)^\s*?$', '', got)
+ if got == want:
+ return True
+
+ # This flag causes doctest to ignore any differences in the
+ # contents of whitespace strings. Note that this can be used
+ # in conjunction with the ELLIPSIS flag.
+ if optionflags & NORMALIZE_WHITESPACE:
+ got = ' '.join(got.split())
+ want = ' '.join(want.split())
+ if got == want:
+ return True
+
+ # The ELLIPSIS flag says to let the sequence "..." in `want`
+ # match any substring in `got`.
+ if optionflags & ELLIPSIS:
+ if _ellipsis_match(want, got):
+ return True
+
+ # We didn't find any match; return false.
+ return False
+
+ # Should we do a fancy diff?
+ def _do_a_fancy_diff(self, want, got, optionflags):
+ # Not unless they asked for a fancy diff.
+ if not optionflags & (REPORT_UDIFF |
+ REPORT_CDIFF |
+ REPORT_NDIFF):
+ return False
+
+ # If expected output uses ellipsis, a meaningful fancy diff is
+ # too hard ... or maybe not. In two real-life failures Tim saw,
+ # a diff was a major help anyway, so this is commented out.
+ # [todo] _ellipsis_match() knows which pieces do and don't match,
+ # and could be the basis for a kick-ass diff in this case.
+ ##if optionflags & ELLIPSIS and ELLIPSIS_MARKER in want:
+ ## return False
+
+ # ndiff does intraline difference marking, so can be useful even
+ # for 1-line differences.
+ if optionflags & REPORT_NDIFF:
+ return True
+
+ # The other diff types need at least a few lines to be helpful.
+ return want.count('\n') > 2 and got.count('\n') > 2
+
+ def output_difference(self, example, got, optionflags):
+ """
+ Return a string describing the differences between the
+ expected output for a given example (`example`) and the actual
+ output (`got`). `optionflags` is the set of option flags used
+ to compare `want` and `got`.
+ """
+ want = example.want
+ # If <BLANKLINE>s are being used, then replace blank lines
+ # with <BLANKLINE> in the actual output string.
+ if not (optionflags & DONT_ACCEPT_BLANKLINE):
+ got = re.sub('(?m)^[ ]*(?=\n)', BLANKLINE_MARKER, got)
+
+ # Check if we should use diff.
+ if self._do_a_fancy_diff(want, got, optionflags):
+ # Split want & got into lines.
+ want_lines = want.splitlines(True) # True == keep line ends
+ got_lines = got.splitlines(True)
+ # Use difflib to find their differences.
+ if optionflags & REPORT_UDIFF:
+ diff = difflib.unified_diff(want_lines, got_lines, n=2)
+ diff = list(diff)[2:] # strip the diff header
+ kind = 'unified diff with -expected +actual'
+ elif optionflags & REPORT_CDIFF:
+ diff = difflib.context_diff(want_lines, got_lines, n=2)
+ diff = list(diff)[2:] # strip the diff header
+ kind = 'context diff with expected followed by actual'
+ elif optionflags & REPORT_NDIFF:
+ engine = difflib.Differ(charjunk=difflib.IS_CHARACTER_JUNK)
+ diff = list(engine.compare(want_lines, got_lines))
+ kind = 'ndiff with -expected +actual'
+ else:
+ assert 0, 'Bad diff option'
+ # Remove trailing whitespace on diff output.
+ diff = [line.rstrip() + '\n' for line in diff]
+ return 'Differences (%s):\n' % kind + _indent(''.join(diff))
+
+ # If we're not using diff, then simply list the expected
+ # output followed by the actual output.
+ if want and got:
+ return 'Expected:\n%sGot:\n%s' % (_indent(want), _indent(got))
+ elif want:
+ return 'Expected:\n%sGot nothing\n' % _indent(want)
+ elif got:
+ return 'Expected nothing\nGot:\n%s' % _indent(got)
+ else:
+ return 'Expected nothing\nGot nothing\n'
+
+
+class DebugRunner(DocTestRunner):
+ r"""Run doc tests but raise an exception as soon as there is a failure.
+
+ If an unexpected exception occurs, an UnexpectedException is raised.
+ It contains the test, the example, and the original exception:
+
+ >>> runner = DebugRunner(verbose=False)
+ >>> test = DocTestParser().get_doctest('>>> raise KeyError\n42',
+ ... {}, 'foo', 'foo.py', 0)
+ >>> try:
+ ... runner.run(test)
+ ... except UnexpectedException, failure:
+ ... pass
+
+ >>> failure.test is test
+ True
+
+ >>> failure.example.want
+ '42\n'
+
+ >>> exc_info = failure.exc_info
+ >>> raise exc_info[0], exc_info[1], exc_info[2]
+ Traceback (most recent call last):
+ ...
+ KeyError
+
+ We wrap the original exception to give the calling application
+ access to the test and example information.
+
+ If the output doesn't match, then a DocTestFailure is raised:
+
+ >>> test = DocTestParser().get_doctest('''
+ ... >>> x = 1
+ ... >>> x
+ ... 2
+ ... ''', {}, 'foo', 'foo.py', 0)
+
+ >>> try:
+ ... runner.run(test)
+ ... except DocTestFailure, failure:
+ ... pass
+
+ DocTestFailure objects provide access to the test:
+
+ >>> failure.test is test
+ True
+
+ As well as to the example:
+
+ >>> failure.example.want
+ '2\n'
+
+ and the actual output:
+
+ >>> failure.got
+ '1\n'
+
+ If a failure or error occurs, the globals are left intact:
+
+ >>> del test.globs['__builtins__']
+ >>> test.globs
+ {'x': 1}
+
+ >>> test = DocTestParser().get_doctest('''
+ ... >>> x = 2
+ ... >>> raise KeyError
+ ... ''', {}, 'foo', 'foo.py', 0)
+
+ >>> runner.run(test)
+ Traceback (most recent call last):
+ ...
+ UnexpectedException: <DocTest foo from foo.py:0 (2 examples)>
+
+ >>> del test.globs['__builtins__']
+ >>> test.globs
+ {'x': 2}
+
+ But the globals are cleared if there is no error:
+
+ >>> test = DocTestParser().get_doctest('''
+ ... >>> x = 2
+ ... ''', {}, 'foo', 'foo.py', 0)
+
+ >>> runner.run(test)
+ (0, 1)
+
+ >>> test.globs
+ {}
+
+ """
+
+ def run(self, test, compileflags=None, out=None, clear_globs=True):
+ r = DocTestRunner.run(self, test, compileflags, out, False)
+ if clear_globs:
+ test.globs.clear()
+ return r
+
+ def report_unexpected_exception(self, out, test, example, exc_info):
+ raise UnexpectedException(test, example, exc_info)
+
+ def report_failure(self, out, test, example, got):
+ raise DocTestFailure(test, example, got)
+
+######################################################################
+## 6. Test Functions
+######################################################################
+# These should be backwards compatible.
+
+# For backward compatibility, a global instance of a DocTestRunner
+# class, updated by testmod.
+master = None
+
+def testmod(m=None, name=None, globs=None, verbose=None, isprivate=None,
+ report=True, optionflags=0, extraglobs=None,
+ raise_on_error=False, exclude_empty=False):
+ """m=None, name=None, globs=None, verbose=None, isprivate=None,
+ report=True, optionflags=0, extraglobs=None, raise_on_error=False,
+ exclude_empty=False
+
+ Test examples in docstrings in functions and classes reachable
+ from module m (or the current module if m is not supplied), starting
+ with m.__doc__. Unless isprivate is specified, private names
+ are not skipped.
+
+ Also test examples reachable from dict m.__test__ if it exists and is
+ not None. m.__test__ maps names to functions, classes and strings;
+ function and class docstrings are tested even if the name is private;
+ strings are tested directly, as if they were docstrings.
+
+ Return (#failures, #tests).
+
+ See doctest.__doc__ for an overview.
+
+ Optional keyword arg "name" gives the name of the module; by default
+ use m.__name__.
+
+ Optional keyword arg "globs" gives a dict to be used as the globals
+ when executing examples; by default, use m.__dict__. A copy of this
+ dict is actually used for each docstring, so that each docstring's
+ examples start with a clean slate.
+
+ Optional keyword arg "extraglobs" gives a dictionary that should be
+ merged into the globals that are used to execute examples. By
+ default, no extra globals are used. This is new in 2.4.
+
+ Optional keyword arg "verbose" prints lots of stuff if true, prints
+ only failures if false; by default, it's true iff "-v" is in sys.argv.
+
+ Optional keyword arg "report" prints a summary at the end when true,
+ else prints nothing at the end. In verbose mode, the summary is
+ detailed, else very brief (in fact, empty if all tests passed).
+
+ Optional keyword arg "optionflags" or's together module constants,
+ and defaults to 0. This is new in 2.3. Possible values (see the
+ docs for details):
+
+ DONT_ACCEPT_TRUE_FOR_1
+ DONT_ACCEPT_BLANKLINE
+ NORMALIZE_WHITESPACE
+ ELLIPSIS
+ IGNORE_EXCEPTION_DETAIL
+ REPORT_UDIFF
+ REPORT_CDIFF
+ REPORT_NDIFF
+ REPORT_ONLY_FIRST_FAILURE
+
+ Optional keyword arg "raise_on_error" raises an exception on the
+ first unexpected exception or failure. This allows failures to be
+ post-mortem debugged.
+
+ Deprecated in Python 2.4:
+ Optional keyword arg "isprivate" specifies a function used to
+ determine whether a name is private. The default function is
+ treat all functions as public. Optionally, "isprivate" can be
+ set to doctest.is_private to skip over functions marked as private
+ using the underscore naming convention; see its docs for details.
+
+ Advanced tomfoolery: testmod runs methods of a local instance of
+ class doctest.Tester, then merges the results into (or creates)
+ global Tester instance doctest.master. Methods of doctest.master
+ can be called directly too, if you want to do something unusual.
+ Passing report=0 to testmod is especially useful then, to delay
+ displaying a summary. Invoke doctest.master.summarize(verbose)
+ when you're done fiddling.
+ """
+ global master
+
+ if isprivate is not None:
+ warnings.warn("the isprivate argument is deprecated; "
+ "examine DocTestFinder.find() lists instead",
+ DeprecationWarning)
+
+ # If no module was given, then use __main__.
+ if m is None:
+ # DWA - m will still be None if this wasn't invoked from the command
+ # line, in which case the following TypeError is about as good an error
+ # as we should expect
+ m = sys.modules.get('__main__')
+
+ # Check that we were actually given a module.
+ if not inspect.ismodule(m):
+ raise TypeError("testmod: module required; %r" % (m,))
+
+ # If no name was given, then use the module's name.
+ if name is None:
+ name = m.__name__
+
+ # Find, parse, and run all tests in the given module.
+ finder = DocTestFinder(_namefilter=isprivate, exclude_empty=exclude_empty)
+
+ if raise_on_error:
+ runner = DebugRunner(verbose=verbose, optionflags=optionflags)
+ else:
+ runner = DocTestRunner(verbose=verbose, optionflags=optionflags)
+
+ for test in finder.find(m, name, globs=globs, extraglobs=extraglobs):
+ runner.run(test)
+
+ if report:
+ runner.summarize()
+
+ if master is None:
+ master = runner
+ else:
+ master.merge(runner)
+
+ return runner.failures, runner.tries
+
+def testfile(filename, module_relative=True, name=None, package=None,
+ globs=None, verbose=None, report=True, optionflags=0,
+ extraglobs=None, raise_on_error=False, parser=DocTestParser(),
+ encoding=None):
+ """
+ Test examples in the given file. Return (#failures, #tests).
+
+ Optional keyword arg "module_relative" specifies how filenames
+ should be interpreted:
+
+ - If "module_relative" is True (the default), then "filename"
+ specifies a module-relative path. By default, this path is
+ relative to the calling module's directory; but if the
+ "package" argument is specified, then it is relative to that
+ package. To ensure os-independence, "filename" should use
+ "/" characters to separate path segments, and should not
+ be an absolute path (i.e., it may not begin with "/").
+
+ - If "module_relative" is False, then "filename" specifies an
+ os-specific path. The path may be absolute or relative (to
+ the current working directory).
+
+ Optional keyword arg "name" gives the name of the test; by default
+ use the file's basename.
+
+ Optional keyword argument "package" is a Python package or the
+ name of a Python package whose directory should be used as the
+ base directory for a module relative filename. If no package is
+ specified, then the calling module's directory is used as the base
+ directory for module relative filenames. It is an error to
+ specify "package" if "module_relative" is False.
+
+ Optional keyword arg "globs" gives a dict to be used as the globals
+ when executing examples; by default, use {}. A copy of this dict
+ is actually used for each docstring, so that each docstring's
+ examples start with a clean slate.
+
+ Optional keyword arg "extraglobs" gives a dictionary that should be
+ merged into the globals that are used to execute examples. By
+ default, no extra globals are used.
+
+ Optional keyword arg "verbose" prints lots of stuff if true, prints
+ only failures if false; by default, it's true iff "-v" is in sys.argv.
+
+ Optional keyword arg "report" prints a summary at the end when true,
+ else prints nothing at the end. In verbose mode, the summary is
+ detailed, else very brief (in fact, empty if all tests passed).
+
+ Optional keyword arg "optionflags" or's together module constants,
+ and defaults to 0. Possible values (see the docs for details):
+
+ DONT_ACCEPT_TRUE_FOR_1
+ DONT_ACCEPT_BLANKLINE
+ NORMALIZE_WHITESPACE
+ ELLIPSIS
+ IGNORE_EXCEPTION_DETAIL
+ REPORT_UDIFF
+ REPORT_CDIFF
+ REPORT_NDIFF
+ REPORT_ONLY_FIRST_FAILURE
+
+ Optional keyword arg "raise_on_error" raises an exception on the
+ first unexpected exception or failure. This allows failures to be
+ post-mortem debugged.
+
+ Optional keyword arg "parser" specifies a DocTestParser (or
+ subclass) that should be used to extract tests from the files.
+
+ Optional keyword arg "encoding" specifies an encoding that should
+ be used to convert the file to unicode.
+
+ Advanced tomfoolery: testmod runs methods of a local instance of
+ class doctest.Tester, then merges the results into (or creates)
+ global Tester instance doctest.master. Methods of doctest.master
+ can be called directly too, if you want to do something unusual.
+ Passing report=0 to testmod is especially useful then, to delay
+ displaying a summary. Invoke doctest.master.summarize(verbose)
+ when you're done fiddling.
+ """
+ global master
+
+ if package and not module_relative:
+ raise ValueError("Package may only be specified for module-"
+ "relative paths.")
+
+ # Relativize the path
+ if module_relative:
+ package = _normalize_module(package)
+ filename = _module_relative_path(package, filename)
+
+ # If no name was given, then use the file's name.
+ if name is None:
+ name = os.path.basename(filename)
+
+ # Assemble the globals.
+ if globs is None:
+ globs = {}
+ else:
+ globs = globs.copy()
+ if extraglobs is not None:
+ globs.update(extraglobs)
+
+ if raise_on_error:
+ runner = DebugRunner(verbose=verbose, optionflags=optionflags)
+ else:
+ runner = DocTestRunner(verbose=verbose, optionflags=optionflags)
+
+ # Read the file, convert it to a test, and run it.
+ s = open(filename, 'U').read()
+ if encoding is None:
+ encoding = pep263_encoding(s)
+ if encoding is not None:
+ s = s.decode(encoding)
+ test = parser.get_doctest(s, globs, name, filename, 0)
+ runner.run(test)
+
+ if report:
+ runner.summarize()
+
+ if master is None:
+ master = runner
+ else:
+ master.merge(runner)
+
+ return runner.failures, runner.tries
+
+pep263_re_search = re.compile("coding[:=]\s*([-\w.]+)").search
+def pep263_encoding(s):
+ """Try to find the encoding of a string by looking for a pep263 coding.
+ """
+ for line in s.split('\n')[:2]:
+ r = pep263_re_search(line)
+ if r:
+ return r.group(1)
+
+
+
+def run_docstring_examples(f, globs, verbose=False, name="NoName",
+ compileflags=None, optionflags=0):
+ """
+ Test examples in the given object's docstring (`f`), using `globs`
+ as globals. Optional argument `name` is used in failure messages.
+ If the optional argument `verbose` is true, then generate output
+ even if there are no failures.
+
+ `compileflags` gives the set of flags that should be used by the
+ Python compiler when running the examples. If not specified, then
+ it will default to the set of future-import flags that apply to
+ `globs`.
+
+ Optional keyword arg `optionflags` specifies options for the
+ testing and output. See the documentation for `testmod` for more
+ information.
+ """
+ # Find, parse, and run all tests in the given module.
+ finder = DocTestFinder(verbose=verbose, recurse=False)
+ runner = DocTestRunner(verbose=verbose, optionflags=optionflags)
+ for test in finder.find(f, name, globs=globs):
+ runner.run(test, compileflags=compileflags)
+
+######################################################################
+## 7. Tester
+######################################################################
+# This is provided only for backwards compatibility. It's not
+# actually used in any way.
+
+class Tester:
+ def __init__(self, mod=None, globs=None, verbose=None,
+ isprivate=None, optionflags=0):
+
+ warnings.warn("class Tester is deprecated; "
+ "use class doctest.DocTestRunner instead",
+ DeprecationWarning, stacklevel=2)
+ if mod is None and globs is None:
+ raise TypeError("Tester.__init__: must specify mod or globs")
+ if mod is not None and not inspect.ismodule(mod):
+ raise TypeError("Tester.__init__: mod must be a module; %r" %
+ (mod,))
+ if globs is None:
+ globs = mod.__dict__
+ self.globs = globs
+
+ self.verbose = verbose
+ self.isprivate = isprivate
+ self.optionflags = optionflags
+ self.testfinder = DocTestFinder(_namefilter=isprivate)
+ self.testrunner = DocTestRunner(verbose=verbose,
+ optionflags=optionflags)
+
+ def runstring(self, s, name):
+ test = DocTestParser().get_doctest(s, self.globs, name, None, None,
+ self.optionflags)
+ if self.verbose:
+ print "Running string", name
+ (f,t) = self.testrunner.run(test)
+ if self.verbose:
+ print f, "of", t, "examples failed in string", name
+ return (f,t)
+
+ def rundoc(self, object, name=None, module=None):
+ f = t = 0
+ tests = self.testfinder.find(object, name, module=module,
+ globs=self.globs)
+ for test in tests:
+ (f2, t2) = self.testrunner.run(test)
+ (f,t) = (f+f2, t+t2)
+ return (f,t)
+
+ def rundict(self, d, name, module=None):
+ import new
+ m = new.module(name)
+ m.__dict__.update(d)
+ if module is None:
+ module = False
+ return self.rundoc(m, name, module)
+
+ def run__test__(self, d, name):
+ import new
+ m = new.module(name)
+ m.__test__ = d
+ return self.rundoc(m, name)
+
+ def summarize(self, verbose=None):
+ return self.testrunner.summarize(verbose)
+
+ def merge(self, other):
+ self.testrunner.merge(other.testrunner)
+
+######################################################################
+## 8. Unittest Support
+######################################################################
+
+from doctest import set_unittest_reportflags
+
+_para_re = re.compile(r'\s*\n\s*\n\s*')
+def _unittest_count(docstring):
+ words = 0
+ count = 0
+ for p in _para_re.split(docstring):
+ p = p.strip()
+ if not p:
+ continue
+ if p.startswith('>>> '):
+ if words:
+ count += 1
+ words = 0
+ else:
+ words = 1
+
+ return count or 1
+
+
+class DocTestCase(unittest.TestCase):
+
+ def __init__(self, test, optionflags=0, setUp=None, tearDown=None,
+ checker=None):
+
+ unittest.TestCase.__init__(self)
+ self._dt_optionflags = optionflags
+ self._dt_checker = checker
+ self._dt_test = test
+ self._dt_globs = test.globs.copy()
+ self._dt_setUp = setUp
+ self._dt_tearDown = tearDown
+
+ self._dt_count = _unittest_count(test.docstring)
+
+ def countTestCases(self):
+ return self._dt_count
+
+ def setUp(self):
+ test = self._dt_test
+
+ if self._dt_setUp is not None:
+ self._dt_setUp(test)
+
+ def tearDown(self):
+ test = self._dt_test
+
+ if self._dt_tearDown is not None:
+ self._dt_tearDown(test)
+
+ # restore the original globs
+ test.globs.clear()
+ test.globs.update(self._dt_globs)
+
+ failureException = DocTestFailureException
+
+ def runTest(self):
+ test = self._dt_test
+ old = sys.stdout
+ new = StringIO()
+ optionflags = self._dt_optionflags
+
+ if not (optionflags & REPORTING_FLAGS):
+ # The option flags don't include any reporting flags,
+ # so add the default reporting flags
+ optionflags |= doctest._unittest_reportflags
+
+ if doctest._unittest_reportflags & REPORT_ONLY_FIRST_FAILURE:
+ optionflags |= REPORT_ONLY_FIRST_FAILURE
+
+ runner = DocTestRunner(optionflags=optionflags,
+ checker=self._dt_checker, verbose=False)
+ def write(value):
+ if isinstance(value, unicode):
+ value = value.encode('utf8')
+ new.write(value)
+
+ try:
+ runner.DIVIDER = "-"*70
+ failures, tries = runner.run(
+ test, out=write, clear_globs=False)
+ finally:
+ sys.stdout = old
+
+ if failures:
+ raise self.failureException(self.format_failure(new.getvalue()))
+
+ def format_failure(self, err):
+ test = self._dt_test
+ if test.lineno is None:
+ lineno = 'unknown line number'
+ else:
+ lineno = '%s' % test.lineno
+ lname = '.'.join(test.name.split('.')[-1:])
+ return ('Failed doctest test for %s\n'
+ ' File "%s", line %s, in %s\n\n%s'
+ % (test.name, test.filename, lineno, lname, err)
+ )
+
+ def debug(self):
+ r"""Run the test case without results and without catching exceptions
+
+ The unit test framework includes a debug method on test cases
+ and test suites to support post-mortem debugging. The test code
+ is run in such a way that errors are not caught. This way a
+ caller can catch the errors and initiate post-mortem debugging.
+
+ The DocTestCase provides a debug method that raises
+ UnexpectedException errors if there is an unexepcted
+ exception:
+
+ >>> test = DocTestParser().get_doctest('>>> raise KeyError\n42',
+ ... {}, 'foo', 'foo.py', 0)
+ >>> case = DocTestCase(test)
+ >>> try:
+ ... case.debug()
+ ... except UnexpectedException, failure:
+ ... pass
+
+ The UnexpectedException contains the test, the example, and
+ the original exception:
+
+ >>> failure.test is test
+ True
+
+ >>> failure.example.want
+ '42\n'
+
+ >>> exc_info = failure.exc_info
+ >>> raise exc_info[0], exc_info[1], exc_info[2]
+ Traceback (most recent call last):
+ ...
+ KeyError
+
+ If the output doesn't match, then a DocTestFailure is raised:
+
+ >>> test = DocTestParser().get_doctest('''
+ ... >>> x = 1
+ ... >>> x
+ ... 2
+ ... ''', {}, 'foo', 'foo.py', 0)
+ >>> case = DocTestCase(test)
+
+ >>> try:
+ ... case.debug()
+ ... except DocTestFailure, failure:
+ ... pass
+
+ DocTestFailure objects provide access to the test:
+
+ >>> failure.test is test
+ True
+
+ As well as to the example:
+
+ >>> failure.example.want
+ '2\n'
+
+ and the actual output:
+
+ >>> failure.got
+ '1\n'
+
+ """
+
+ self.setUp()
+ runner = DebugRunner(optionflags=self._dt_optionflags,
+ checker=self._dt_checker, verbose=False)
+ runner.run(self._dt_test, clear_globs=False)
+ self.tearDown()
+
+ def id(self):
+ return self._dt_test.name
+
+ def __repr__(self):
+ name = self._dt_test.name.split('.')
+ return "%s (%s)" % (name[-1], '.'.join(name[:-1]))
+
+ __str__ = __repr__
+
+ def shortDescription(self):
+ return "Doctest: " + self._dt_test.name
+
+def DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None,
+ **options):
+ """
+ Convert doctest tests for a module to a unittest test suite.
+
+ This converts each documentation string in a module that
+ contains doctest tests to a unittest test case. If any of the
+ tests in a doc string fail, then the test case fails. An exception
+ is raised showing the name of the file containing the test and a
+ (sometimes approximate) line number.
+
+ The `module` argument provides the module to be tested. The argument
+ can be either a module or a module name.
+
+ If no argument is given, the calling module is used.
+
+ A number of options may be provided as keyword arguments:
+
+ setUp
+ A set-up function. This is called before running the
+ tests in each file. The setUp function will be passed a DocTest
+ object. The setUp function can access the test globals as the
+ globs attribute of the test passed.
+
+ tearDown
+ A tear-down function. This is called after running the
+ tests in each file. The tearDown function will be passed a DocTest
+ object. The tearDown function can access the test globals as the
+ globs attribute of the test passed.
+
+ globs
+ A dictionary containing initial global variables for the tests.
+
+ optionflags
+ A set of doctest option flags expressed as an integer.
+ """
+
+ if test_finder is None:
+ test_finder = DocTestFinder()
+
+ module = _normalize_module(module)
+ tests = test_finder.find(module, globs=globs, extraglobs=extraglobs,
+ optionflags=options.get('optionflags', 0))
+ if globs is None:
+ globs = module.__dict__
+ if not tests:
+ # Why do we want to do this? Because it reveals a bug that might
+ # otherwise be hidden.
+ raise ValueError(module, "has no tests")
+
+ tests.sort()
+ suite = unittest.TestSuite()
+ for test in tests:
+ if len(test.examples) == 0:
+ continue
+ if not test.filename:
+ filename = module.__file__
+ if filename[-4:] in (".pyc", ".pyo"):
+ filename = filename[:-1]
+ test.filename = filename
+ suite.addTest(DocTestCase(test, **options))
+
+ return suite
+
+class DocFileCase(DocTestCase):
+
+ def id(self):
+ return '_'.join(self._dt_test.name.split('.'))
+
+ def __repr__(self):
+ return self._dt_test.filename
+ __str__ = __repr__
+
+ def format_failure(self, err):
+ return ('Failed doctest test for %s\n File "%s", line 0\n\n%s'
+ % (self._dt_test.name, self._dt_test.filename, err)
+ )
+
+def DocFileTest(path, module_relative=True, package=None,
+ globs=None, parser=DocTestParser(),
+ encoding=None, **options):
+ if globs is None:
+ globs = {}
+ else:
+ globs = globs.copy()
+
+ if package and not module_relative:
+ raise ValueError("Package may only be specified for module-"
+ "relative paths.")
+
+ # Relativize the path.
+ if module_relative:
+ package = _normalize_module(package)
+ path = _module_relative_path(package, path)
+ if "__file__" not in globs:
+ globs["__file__"] = path
+
+ # Find the file and read it.
+ name = os.path.basename(path)
+ doc = open(path, 'U').read()
+
+ # If an encoding is specified, use it to convert the file to unicode
+ if encoding is None:
+ encoding = pep263_encoding(doc)
+ if encoding is not None:
+ doc = doc.decode(encoding)
+
+ optionflags = options.get('optionflags', 0)
+ # Convert it to a test, and wrap it in a DocFileCase.
+ test = parser.get_doctest(doc, globs, name, path, 0, optionflags)
+ return DocFileCase(test, **options)
+
+def DocFileSuite(*paths, **kw):
+ """A unittest suite for one or more doctest files.
+
+ The path to each doctest file is given as a string; the
+ interpretation of that string depends on the keyword argument
+ "module_relative".
+
+ A number of options may be provided as keyword arguments:
+
+ module_relative
+ If "module_relative" is True, then the given file paths are
+ interpreted as os-independent module-relative paths. By
+ default, these paths are relative to the calling module's
+ directory; but if the "package" argument is specified, then
+ they are relative to that package. To ensure os-independence,
+ "filename" should use "/" characters to separate path
+ segments, and may not be an absolute path (i.e., it may not
+ begin with "/").
+
+ If "module_relative" is False, then the given file paths are
+ interpreted as os-specific paths. These paths may be absolute
+ or relative (to the current working directory).
+
+ package
+ A Python package or the name of a Python package whose directory
+ should be used as the base directory for module relative paths.
+ If "package" is not specified, then the calling module's
+ directory is used as the base directory for module relative
+ filenames. It is an error to specify "package" if
+ "module_relative" is False.
+
+ setUp
+ A set-up function. This is called before running the
+ tests in each file. The setUp function will be passed a DocTest
+ object. The setUp function can access the test globals as the
+ globs attribute of the test passed.
+
+ tearDown
+ A tear-down function. This is called after running the
+ tests in each file. The tearDown function will be passed a DocTest
+ object. The tearDown function can access the test globals as the
+ globs attribute of the test passed.
+
+ globs
+ A dictionary containing initial global variables for the tests.
+
+ optionflags
+ A set of doctest option flags expressed as an integer.
+
+ parser
+ A DocTestParser (or subclass) that should be used to extract
+ tests from the files.
+
+ encoding
+ An encoding that will be used to convert the files to unicode.
+ """
+ suite = unittest.TestSuite()
+
+ # We do this here so that _normalize_module is called at the right
+ # level. If it were called in DocFileTest, then this function
+ # would be the caller and we might guess the package incorrectly.
+ if kw.get('module_relative', True):
+ kw['package'] = _normalize_module(kw.get('package'))
+
+ for path in paths:
+ suite.addTest(DocFileTest(path, **kw))
+
+ return suite
+
+######################################################################
+## 9. Debugging Support
+######################################################################
+
+def script_from_examples(s):
+ r"""Extract script from text with examples.
+
+ Converts text with examples to a Python script. Example input is
+ converted to regular code. Example output and all other words
+ are converted to comments:
+
+ >>> text = '''
+ ... Here are examples of simple math.
+ ...
+ ... Python has super accurate integer addition
+ ...
+ ... >>> 2 + 2
+ ... 5
+ ...
+ ... And very friendly error messages:
+ ...
+ ... >>> 1/0
+ ... To Infinity
+ ... And
+ ... Beyond
+ ...
+ ... You can use logic if you want:
+ ...
+ ... >>> if 0:
+ ... ... blah
+ ... ... blah
+ ... ...
+ ...
+ ... Ho hum
+ ... '''
+
+ >>> print script_from_examples(text)
+ # Here are examples of simple math.
+ #
+ # Python has super accurate integer addition
+ #
+ 2 + 2
+ # Expected:
+ ## 5
+ #
+ # And very friendly error messages:
+ #
+ 1/0
+ # Expected:
+ ## To Infinity
+ ## And
+ ## Beyond
+ #
+ # You can use logic if you want:
+ #
+ if 0:
+ blah
+ blah
+ #
+ # Ho hum
+ """
+ output = []
+ for piece in DocTestParser().parse(s):
+ if isinstance(piece, Example):
+ # Add the example's source code (strip trailing NL)
+ output.append(piece.source[:-1])
+ # Add the expected output:
+ want = piece.want
+ if want:
+ output.append('# Expected:')
+ output += ['## '+l for l in want.split('\n')[:-1]]
+ else:
+ # Add non-example text.
+ output += [_comment_line(l)
+ for l in piece.split('\n')[:-1]]
+
+ # Trim junk on both ends.
+ while output and output[-1] == '#':
+ output.pop()
+ while output and output[0] == '#':
+ output.pop(0)
+ # Combine the output, and return it.
+ return '\n'.join(output)
+
+def testsource(module, name):
+ """Extract the test sources from a doctest docstring as a script.
+
+ Provide the module (or dotted name of the module) containing the
+ test to be debugged and the name (within the module) of the object
+ with the doc string with tests to be debugged.
+ """
+ module = _normalize_module(module)
+ tests = DocTestFinder().find(module)
+ test = [t for t in tests if t.name == name]
+ if not test:
+ raise ValueError(name, "not found in tests")
+ test = test[0]
+ testsrc = script_from_examples(test.docstring)
+ return testsrc
+
+def debug_src(src, pm=False, globs=None):
+ """Debug a single doctest docstring, in argument `src`'"""
+ testsrc = script_from_examples(src)
+ debug_script(testsrc, pm, globs)
+
+def debug_script(src, pm=False, globs=None):
+ "Debug a test script. `src` is the script, as a string."
+ import pdb
+
+ # Note that tempfile.NameTemporaryFile() cannot be used. As the
+ # docs say, a file so created cannot be opened by name a second time
+ # on modern Windows boxes, and execfile() needs to open it.
+ srcfilename = tempfile.mktemp(".py", "doctestdebug")
+ f = open(srcfilename, 'w')
+ f.write(src)
+ f.close()
+
+ try:
+ if globs:
+ globs = globs.copy()
+ else:
+ globs = {}
+
+ if pm:
+ try:
+ execfile(srcfilename, globs, globs)
+ except:
+ print sys.exc_info()[1]
+ pdb.post_mortem(sys.exc_info()[2])
+ else:
+ # Note that %r is vital here. '%s' instead can, e.g., cause
+ # backslashes to get treated as metacharacters on Windows.
+ pdb.run("execfile(%r)" % srcfilename, globs, globs)
+
+ finally:
+ os.remove(srcfilename)
+
+def debug(module, name, pm=False):
+ """Debug a single doctest docstring.
+
+ Provide the module (or dotted name of the module) containing the
+ test to be debugged and the name (within the module) of the object
+ with the docstring with tests to be debugged.
+ """
+ module = _normalize_module(module)
+ testsrc = testsource(module, name)
+ debug_script(testsrc, pm, module.__dict__)
+
+######################################################################
+## 10. Example Usage
+######################################################################
+class _TestClass:
+ """
+ A pointless class, for sanity-checking of docstring testing.
+
+ Methods:
+ square()
+ get()
+
+ >>> _TestClass(13).get() + _TestClass(-12).get()
+ 1
+ >>> hex(_TestClass(13).square().get())
+ '0xa9'
+ """
+
+ def __init__(self, val):
+ """val -> _TestClass object with associated value val.
+
+ >>> t = _TestClass(123)
+ >>> print t.get()
+ 123
+ """
+
+ self.val = val
+
+ def square(self):
+ """square() -> square TestClass's associated value
+
+ >>> _TestClass(13).square().get()
+ 169
+ """
+
+ self.val = self.val ** 2
+ return self
+
+ def get(self):
+ """get() -> return TestClass's associated value.
+
+ >>> x = _TestClass(-42)
+ >>> print x.get()
+ -42
+ """
+
+ return self.val
+
+__test__ = {"_TestClass": _TestClass,
+ "string": r"""
+ Example of a string object, searched as-is.
+ >>> x = 1; y = 2
+ >>> x + y, x * y
+ (3, 2)
+ """,
+
+ "bool-int equivalence": r"""
+ In 2.2, boolean expressions displayed
+ 0 or 1. By default, we still accept
+ them. This can be disabled by passing
+ DONT_ACCEPT_TRUE_FOR_1 to the new
+ optionflags argument.
+ >>> 4 == 4
+ 1
+ >>> 4 == 4
+ True
+ >>> 4 > 4
+ 0
+ >>> 4 > 4
+ False
+ """,
+
+ "blank lines": r"""
+ Blank lines can be marked with <BLANKLINE>:
+ >>> print 'foo\n\nbar\n'
+ foo
+ <BLANKLINE>
+ bar
+ <BLANKLINE>
+ """,
+
+ "ellipsis": r"""
+ If the ellipsis flag is used, then '...' can be used to
+ elide substrings in the desired output:
+ >>> print range(1000) #doctest: +ELLIPSIS
+ [0, 1, 2, ..., 999]
+ """,
+
+ "whitespace normalization": r"""
+ If the whitespace normalization flag is used, then
+ differences in whitespace are ignored.
+ >>> print range(30) #doctest: +NORMALIZE_WHITESPACE
+ [0, 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]
+ """,
+ }
+
+def _test_footnotes():
+ '''
+ Footnotes
+ =========
+
+ If the INTERPRET_FOOTNOTES flag is passed as part of optionflags, then
+ footnotes will be looked up and their code injected at each point of
+ reference. For example:
+
+ >>> counter = 0
+
+ Here is some text that references a footnote [1]_
+
+ >>> counter
+ 1
+
+ .. [1] and here we increment ``counter``
+ >>> counter += 1
+
+ Footnotes can also be referenced after they are defined: [1]_
+
+ >>> counter
+ 2
+
+ Footnotes can also be "citations", which just means that the value in
+ the brackets is alphanumeric: [citation]_
+
+ >>> print from_citation
+ hi
+
+ .. [citation] this is a citation.
+ >>> from_citation = 'hi'
+
+ Footnotes can contain more than one example: [multi example]_
+
+ >>> print one
+ 1
+
+ >>> print two
+ 2
+
+ >>> print three
+ 3
+
+ .. [multi example] Here's a footnote with multiple examples:
+
+ >>> one = 1
+
+ and now another (note indentation to make this part of the footnote):
+
+ >>> two = 2
+
+ and a third:
+
+ >>> three = 3
+
+
+ More than one footnote can be referenced at a time [1]_ [2]_
+
+ >>> counter
+ 6
+
+ .. [2] let's multiply ``counter`` by two
+ >>> counter *= 2
+
+
+ Parsing Details
+ ---------------
+
+ If the INTERPRET_FOOTNOTES optionflag isn't set, footnotes are ignored.
+
+ >>> doctest = """
+ ... This is a doctest. [#1]_
+ ...
+ ... >>> print var
+ ...
+ ... .. [#1] a footnote
+ ... Here we set up the variable
+ ...
+ ... >>> var = 1
+ ... """
+
+ >>> print_structure(doctest)
+ Prose| This is a doctest. [#1]_
+ Code | print var
+ Prose| .. [#1] a footnote
+ Code | var = 1
+ Prose|
+
+ If INTERPRET_FOOTNOTES is set, footnotes are also copied to the point at
+ which they are referenced.
+
+ >>> print_structure(doctest, optionflags=INTERPRET_FOOTNOTES)
+ Prose| This is a doctest. [#1]_
+ Code | var = 1
+ Prose|
+ Code | print var
+ Prose| .. [#1] a footnote
+ Prose|
+
+ >>> print_structure("""
+ ... Footnotes can have code that starts with no prose. [#quick code]_
+ ...
+ ... .. [#quick code]
+ ... >>> print 'this is some code'
+ ... this is some code
+ ... """, optionflags=INTERPRET_FOOTNOTES)
+ Prose| Footnotes can have code that starts with no prose. [#quick code]_
+ Code | print 'this is some code'
+ Prose|
+ Prose|
+
+ >>> print_structure("""
+ ... Footnotes can be back-to-back [#first]_ [#second]_
+ ... .. [#first]
+ ... .. [#second]
+ ... >>> 1+1
+ ... 2
+ ... """, optionflags=INTERPRET_FOOTNOTES)
+ Prose| Footnotes can be back-to-back [#first]_ [#second]_
+ Prose| Footnotes can be back-to-back [#first]_ [#second]_
+ Code | 1+1
+ Prose|
+ Prose|
+
+ >>> print_structure("""
+ ... .. [#no code] Footnotes can also be defined with no code.
+ ... """, optionflags=INTERPRET_FOOTNOTES)
+ Prose| .. [#no code] Footnotes can also be defined with no code.
+
+ If there are multiple footnotes with no code, then one with code, they are
+ parsed correctly.
+
+ >>> print_structure("""
+ ... I'd like some code to go here [#some code]_
+ ... .. [#no code 1] Footnotes can also be defined with no code.
+ ... .. [#no code 2] Footnotes can also be defined with no code.
+ ... .. [#no code 3] Footnotes can also be defined with no code.
+ ... .. [#some code]
+ ... >>> print 'hi'
+ ... hi
+ ... """, optionflags=INTERPRET_FOOTNOTES)
+ Prose| I'd like some code to go here [#some code]_
+ Code | print 'hi'
+ Prose|
+ Prose|
+
+ The non-autonumbered flavor of labels works too.
+
+ >>> print_structure("""
+ ... Here is some text. [foo]_
+ ... .. [foo]
+ ... >>> print 'hi'
+ ... hi
+ ... """, optionflags=INTERPRET_FOOTNOTES)
+ Prose| Here is some text. [foo]_
+ Code | print 'hi'
+ Prose|
+ Prose|
+ '''
+
+
+def print_structure(doctest, optionflags=0):
+ def preview(s):
+ first_line = s.strip().split('\n')[0]
+ MAX_LENGTH = 70
+ if len(first_line) <= MAX_LENGTH:
+ return first_line
+
+ return '%s...' % first_line[:MAX_LENGTH].strip()
+
+ parser = DocTestParser()
+ for x in parser.parse(doctest, optionflags=optionflags):
+ if isinstance(x, Example):
+ result = 'Code | ' + preview(x.source)
+ else:
+ result = 'Prose| ' + preview(x)
+
+ print result.strip()
+
+
+def _test():
+ r = unittest.TextTestRunner()
+ r.run(DocTestSuite(optionflags=INTERPRET_FOOTNOTES))
+
+if __name__ == "__main__":
+ _test()
+
+# TODO:
+# - make tracebacks show where the footnote was referenced
+# - teach script_from_examples and testsource about INTERPRET_FOOTNOTES
+# - update comments (including docstring for testfile)
=== added file 'src/zope/testing/doctestunit.py'
--- src/zope/testing/doctestunit.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/doctestunit.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,38 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Extension to use doctest tests as unit tests
+
+This module provides a DocTestSuite contructor for converting doctest
+tests to unit tests.
+
+$Id: doctestunit.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import warnings
+warnings.warn('zope.testing.doctestunit is deprecated in favour of '
+ 'the Python standard library doctest module', DeprecationWarning,
+ stacklevel=2)
+
+from doctest import DocFileSuite, DocTestSuite
+from doctest import debug_src, debug
+
+def pprint():
+ from pprint import PrettyPrinter
+ def pprint(ob, **opts):
+ if 'width' not in opts:
+ opts['width'] = 1
+ return PrettyPrinter(**opts).pprint(ob)
+ return pprint
+
+pprint = pprint()
=== added file 'src/zope/testing/exceptions.py'
--- src/zope/testing/exceptions.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/exceptions.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,20 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Exceptions for zope.testing
+
+$Id$
+"""
+
+class DocTestFailureException(AssertionError):
+ """Use custom exception for doctest unit test failures"""
=== added file 'src/zope/testing/formparser.py'
--- src/zope/testing/formparser.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/formparser.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,234 @@
+"""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* for documentation.
+
+This isn't intended to simulate a browser session; that's provided by
+the `zope.testbrowser` package.
+
+"""
+__docformat__ = "reStructuredText"
+
+import HTMLParser
+import urlparse
+
+
+def parse(data, base=None):
+ """Return a form collection parsed from `data`.
+
+ `base` should be the URL from which `data` was retrieved.
+
+ """
+ parser = FormParser(data, base)
+ return parser.parse()
+
+
+class FormParser(object):
+
+ def __init__(self, data, base=None):
+ self.data = data
+ self.base = base
+ self._parser = HTMLParser.HTMLParser()
+ self._parser.handle_data = self._handle_data
+ self._parser.handle_endtag = self._handle_endtag
+ self._parser.handle_starttag = self._handle_starttag
+ self._parser.handle_startendtag = self._handle_starttag
+ self._buffer = []
+ self.current = None # current form
+ self.forms = FormCollection()
+
+ def parse(self):
+ """Parse the document, returning the collection of forms."""
+ self._parser.feed(self.data)
+ self._parser.close()
+ return self.forms
+
+ # HTMLParser handlers
+
+ def _handle_data(self, data):
+ self._buffer.append(data)
+
+ def _handle_endtag(self, tag):
+ if tag == "textarea":
+ self.textarea.value = "".join(self._buffer)
+ self.textarea = None
+ elif tag == "select":
+ self.select = None
+ elif tag == "option":
+ option = self.select.options[-1]
+ label = "".join(self._buffer)
+ if not option.label:
+ option.label = label
+ if not option.value:
+ option.value = label
+ if option.selected:
+ if self.select.multiple:
+ self.select.value.append(option.value)
+ else:
+ self.select.value = option.value
+
+ def _handle_starttag(self, tag, attrs):
+ del self._buffer[:]
+ d = {}
+ for name, value in attrs:
+ d[name] = value
+ name = d.get("name")
+ id = d.get("id") or d.get("xml:id")
+ if tag == "form":
+ method = kwattr(d, "method", "get")
+ action = d.get("action", "").strip() or None
+ if self.base and action:
+ action = urlparse.urljoin(self.base, action)
+ enctype = kwattr(d, "enctype", "application/x-www-form-urlencoded")
+ self.current = Form(name, id, method, action, enctype)
+ self.forms.append(self.current)
+ elif tag == "input":
+ type = kwattr(d, "type", "text")
+ checked = "checked" in d
+ disabled = "disabled" in d
+ readonly = "readonly" in d
+ src = d.get("src", "").strip() or None
+ if self.base and src:
+ src = urlparse.urljoin(self.base, src)
+ value = d.get("value")
+ size = intattr(d, "size")
+ maxlength = intattr(d, "maxlength")
+ self._add_field(
+ Input(name, id, type, value, checked,
+ disabled, readonly, src, size, maxlength))
+ elif tag == "button":
+ pass
+ elif tag == "textarea":
+ disabled = "disabled" in d
+ readonly = "readonly" in d
+ self.textarea = Input(name, id, "textarea", None,
+ None, disabled, readonly,
+ None, None, None)
+ self.textarea.rows = intattr(d, "rows")
+ self.textarea.cols = intattr(d, "cols")
+ self._add_field(self.textarea)
+ # The value will be set when the </textarea> is seen.
+ elif tag == "base":
+ href = d.get("href", "").strip()
+ if href and self.base:
+ href = urlparse.urljoin(self.base, href)
+ self.base = href
+ elif tag == "select":
+ disabled = "disabled" in d
+ multiple = "multiple" in d
+ size = intattr(d, "size")
+ self.select = Select(name, id, disabled, multiple, size)
+ self._add_field(self.select)
+ elif tag == "option":
+ disabled = "disabled" in d
+ selected = "selected" in d
+ value = d.get("value")
+ label = d.get("label")
+ option = Option(id, value, selected, label, disabled)
+ self.select.options.append(option)
+
+ # Helpers:
+
+ def _add_field(self, field):
+ if field.name in self.current:
+ ob = self.current[field.name]
+ if isinstance(ob, list):
+ ob.append(field)
+ else:
+ self.current[field.name] = [ob, field]
+ else:
+ self.current[field.name] = field
+
+
+def kwattr(d, name, default=None):
+ """Return attribute, converted to lowercase."""
+ v = d.get(name, default)
+ if v != default and v is not None:
+ v = v.strip().lower()
+ v = v or default
+ return v
+
+
+def intattr(d, name):
+ """Return attribute as an integer, or None."""
+ if name in d:
+ v = d[name].strip()
+ return int(v)
+ else:
+ return None
+
+
+class FormCollection(list):
+ """Collection of all forms from a page."""
+
+ def __getattr__(self, name):
+ for form in self:
+ if form.name == name:
+ return form
+ raise AttributeError(name)
+
+
+class Form(dict):
+ """A specific form within a page."""
+
+ # This object should provide some method to prepare a dictionary
+ # that can be passed directly as the value of the `form` argument
+ # to the `http()` function of the Zope functional test.
+ #
+ # This is probably a low priority given the availability of the
+ # `zope.testbrowser` package.
+
+ def __init__(self, name, id, method, action, enctype):
+ super(Form, self).__init__()
+ self.name = name
+ self.id = id
+ self.method = method
+ self.action = action
+ self.enctype = enctype
+
+
+class Input(object):
+ """Input element."""
+
+ rows = None
+ cols = None
+
+ def __init__(self, name, id, type, value, checked, disabled, readonly,
+ src, size, maxlength):
+ super(Input, self).__init__()
+ self.name = name
+ self.id = id
+ self.type = type
+ self.value = value
+ self.checked = checked
+ self.disabled = disabled
+ self.readonly = readonly
+ self.src = src
+ self.size = size
+ self.maxlength = maxlength
+
+
+class Select(Input):
+ """Select element."""
+
+ def __init__(self, name, id, disabled, multiple, size):
+ super(Select, self).__init__(name, id, "select", None, None,
+ disabled, None, None, size, None)
+ self.options = []
+ self.multiple = multiple
+ if multiple:
+ self.value = []
+
+
+class Option(object):
+ """Individual value representation for a select element."""
+
+ def __init__(self, id, value, selected, label, disabled):
+ super(Option, self).__init__()
+ self.id = id
+ self.value = value
+ self.selected = selected
+ self.label = label
+ self.disabled = disabled
=== added file 'src/zope/testing/formparser.txt'
--- src/zope/testing/formparser.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/formparser.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,142 @@
+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/foobar.py" 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="http://www.example.com/base/"; />
+ ... <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)
+ 2
+ >>> forms.form1 is forms[0]
+ True
+ >>> forms.form1 is forms[1]
+ False
+
+More often, the `parse()` convenience function is all that's needed:
+
+ >>> forms = zope.testing.formparser.parse(
+ ... page_text, "http://cgi.example.com/somewhere/form.html";)
+
+ >>> len(forms)
+ 2
+ >>> forms.form1 is forms[0]
+ True
+ >>> forms.form1 is forms[1]
+ False
+
+Once we have the form we're interested in, we can check form
+attributes and individual field values:
+
+ >>> form = forms.form1
+ >>> form.enctype
+ 'application/x-www-form-urlencoded'
+ >>> form.method
+ 'post'
+
+ >>> keys = form.keys()
+ >>> keys.sort()
+ >>> keys
+ ['do-it-now', 'f1', 'not-really', 'pick-two']
+
+ >>> not_really = form["not-really"]
+ >>> not_really.type
+ 'image'
+ >>> not_really.value
+ "Don't."
+ >>> not_really.readonly
+ False
+ >>> not_really.disabled
+ False
+
+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
+ 'http://cgi.example.com/cgi-bin/foobar.py'
+ >>> not_really.src
+ 'http://cgi.example.com/somewhere/dont.png'
+
+ >>> forms[1].action
+ 'http://www.example.com/base/sproing/sprung.html'
+ >>> forms[1]["action"].src
+ 'http://www.example.com/base/else.png'
+
+Fields which are repeated are reported as lists of objects that
+represent each instance of the field::
+
+ >>> field = forms[1]["multi"]
+ >>> type(field)
+ <type '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
+ 5
+ >>> print ta.cols
+ None
+ >>> ta.value
+ 'Some text.'
+
+The ``<select>`` element provides access to the options as well:
+
+ >>> select = form["pick-two"]
+ >>> select.multiple
+ True
+ >>> select.size
+ 3
+ >>> select.type
+ 'select'
+ >>> select.value
+ ['one', 'Fourth']
+
+ >>> options = select.options
+ >>> len(options)
+ 4
+ >>> [opt.label for opt in options]
+ ['First', 'Second', 'Third', 'Fourth']
+ >>> [opt.value for opt in options]
+ ['one', 'two', 'three', 'Fourth']
=== added file 'src/zope/testing/loggingsupport.py'
--- src/zope/testing/loggingsupport.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/loggingsupport.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,124 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""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:
+
+ >>> handler = InstalledHandler('foo.bar')
+
+The handler is installed into loggers for all of the names passed. In
+addition, the logger level is set to 1, which means, log
+everything. If you want to log less than everything, you can provide a
+level keyword argument. The level setting effects only the named
+loggers.
+
+ >>> handler_with_levels = InstalledHandler('baz', level=logging.WARNING)
+
+Then, any log output is collected in the handler:
+
+ >>> logging.getLogger('foo.bar').exception('eek')
+ >>> logging.getLogger('foo.bar').info('blah blah')
+
+ >>> for record in handler.records:
+ ... print record.name, record.levelname
+ ... print ' ', record.getMessage()
+ foo.bar ERROR
+ eek
+ foo.bar INFO
+ blah blah
+
+A similar effect can be gotten by just printing the handler:
+
+ >>> print handler
+ foo.bar ERROR
+ eek
+ foo.bar INFO
+ blah blah
+
+After checking the log output, you need to uninstall the handler:
+
+ >>> handler.uninstall()
+ >>> handler_with_levels.uninstall()
+
+At which point, the handler won't get any more log output.
+Let's clear the handler:
+
+ >>> handler.clear()
+ >>> handler.records
+ []
+
+And then log something:
+
+ >>> logging.getLogger('foo.bar').info('blah')
+
+and, sure enough, we still have no output:
+
+ >>> handler.records
+ []
+
+$Id: loggingsupport.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import logging
+
+class Handler(logging.Handler):
+
+ def __init__(self, *names, **kw):
+ logging.Handler.__init__(self)
+ self.names = names
+ self.records = []
+ self.setLoggerLevel(**kw)
+
+ def setLoggerLevel(self, level=1):
+ self.level = level
+ self.oldlevels = {}
+
+ def emit(self, record):
+ self.records.append(record)
+
+ def clear(self):
+ del self.records[:]
+
+ def install(self):
+ for name in self.names:
+ logger = logging.getLogger(name)
+ self.oldlevels[name] = logger.level
+ logger.setLevel(self.level)
+ logger.addHandler(self)
+
+ def uninstall(self):
+ for name in self.names:
+ logger = logging.getLogger(name)
+ logger.setLevel(self.oldlevels[name])
+ logger.removeHandler(self)
+
+ def __str__(self):
+ return '\n'.join(
+ [("%s %s\n %s" %
+ (record.name, record.levelname,
+ '\n'.join([line
+ for line in record.getMessage().split('\n')
+ if line.strip()])
+ )
+ )
+ for record in self.records]
+ )
+
+
+class InstalledHandler(Handler):
+
+ def __init__(self, *names, **kw):
+ Handler.__init__(self, *names, **kw)
+ self.install()
=== added file 'src/zope/testing/loghandler.py'
--- src/zope/testing/loghandler.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/loghandler.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,77 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""logging handler for tests that check logging output.
+
+$Id: loghandler.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+import logging
+
+class Handler(logging.Handler):
+ """Handler for use with unittest.TestCase objects.
+
+ The handler takes a TestCase instance as a constructor argument.
+ It can be registered with one or more loggers and collects log
+ records they generate.
+
+ The assertLogsMessage() and failIfLogsMessage() methods can be
+ used to check the logger output and causes the test to fail as
+ appropriate.
+ """
+
+ def __init__(self, testcase, propagate=False):
+ logging.Handler.__init__(self)
+ self.records = []
+ # loggers stores (logger, propagate) tuples
+ self.loggers = []
+ self.closed = False
+ self.propagate = propagate
+ self.testcase = testcase
+
+ def close(self):
+ """Remove handler from any loggers it was added to."""
+ if self.closed:
+ return
+ for logger, propagate in self.loggers:
+ logger.removeHandler(self)
+ logger.propagate = propagate
+ self.closed = True
+
+ def add(self, name):
+ """Add handler to logger named name."""
+ logger = logging.getLogger(name)
+ old_prop = logger.propagate
+ logger.addHandler(self)
+ if self.propagate:
+ logger.propagate = 1
+ else:
+ logger.propagate = 0
+ self.loggers.append((logger, old_prop))
+
+ def emit(self, record):
+ self.records.append(record)
+
+ def assertLogsMessage(self, msg, level=None):
+ for r in self.records:
+ if r.getMessage() == msg:
+ if level is not None and r.levelno == level:
+ return
+ msg = "No log message contained %r" % msg
+ if level is not None:
+ msg += " at level %d" % level
+ self.testcase.fail(msg)
+
+ def failIfLogsMessage(self, msg):
+ for r in self.records:
+ if r.getMessage() == msg:
+ self.testcase.fail("Found log message %r" % msg)
=== added file 'src/zope/testing/module.py'
--- src/zope/testing/module.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/module.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,48 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Fake module support
+
+$Id: module.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import sys
+
+class FakeModule:
+ def __init__(self, dict):
+ self.__dict = dict
+ def __getattr__(self, name):
+ try:
+ return self.__dict[name]
+ except KeyError:
+ raise AttributeError(name)
+
+def setUp(test, name='__main__'):
+ dict = test.globs
+ dict['__name__'] = name
+ module = FakeModule(dict)
+ sys.modules[name] = module
+ if '.' in name:
+ name = name.split('.')
+ parent = sys.modules['.'.join(name[:-1])]
+ setattr(parent, name[-1], module)
+
+def tearDown(test, name=None):
+ if name is None:
+ name = test.globs['__name__']
+ del test.globs['__name__']
+ del sys.modules[name]
+ if '.' in name:
+ name = name.split('.')
+ parent = sys.modules['.'.join(name[:-1])]
+ delattr(parent, name[-1])
=== added file 'src/zope/testing/module.txt'
--- src/zope/testing/module.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/module.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,106 @@
+Module setup
+============
+
+Normally when you create a class in a doctest, it will have the
+``__module__`` attribute of ``'__builtin__'``. This is sometimes not
+desirable. Let's demonstrate the behavior::
+
+ >>> class Foo(object):
+ ... pass
+
+ >>> Foo.__module__
+ '__builtin__'
+
+By using ``zope.testing.module.setUp`` this can be
+controlled. Normally you set up your tests with it, but in this case
+we'll just call it manually.
+
+To call this function manually, we need to set up a fake ``test``
+object. This because the ``setUp`` function expects a test with at
+least the ``globs`` dictionary attribute being present. Let's make
+such a fake test object, using the globals of the doctest::
+
+ >>> class FakeTest(object):
+ ... def __init__(self):
+ ... self.globs = globals()
+
+ >>> test = FakeTest()
+
+We can now call the ``setUp`` function::
+
+ >>> from zope.testing.module import setUp
+ >>> setUp(test)
+
+We will now demonstrate that the ``__module__`` argument is something
+else, in this case the default, ``__main__``::
+
+ >>> class Foo(object):
+ ... pass
+ >>> Foo.__module__
+ '__main__'
+
+Let's tear this down again::
+
+ >>> from zope.testing.module import tearDown
+ >>> tearDown(test)
+
+We should now be back to the original situation::
+
+ >>> class Foo(object):
+ ... pass
+ >>> Foo.__module__
+ '__builtin__'
+
+Importing
+---------
+
+Let's now imagine a more complicated example, were we actually want to
+be able to import the fake module as well::
+
+ >>> setUp(test, 'fake')
+ >>> a = 'Hello world'
+
+The import should not fail::
+
+ >>> import fake
+ >>> fake.a
+ 'Hello world'
+
+Let's tear it down again::
+
+ >>> tearDown(test)
+ >>> import fake
+ Traceback (most recent call last):
+ ...
+ ImportError: No module named fake
+
+If we enter a dotted name, it will actually try to place the fake
+module in that dotted name::
+
+ >>> setUp(test, 'zope.testing.unlikelymodulename')
+ >>> a = 'Bye world'
+ >>> import zope.testing.unlikelymodulename
+ >>> zope.testing.unlikelymodulename.a
+ 'Bye world'
+ >>> from zope.testing import unlikelymodulename
+ >>> unlikelymodulename.a
+ 'Bye world'
+ >>> tearDown(test)
+ >>> import zope.testing.unlikelymodulename
+ Traceback (most recent call last):
+ ...
+ ImportError: No module named unlikelymodulename
+
+This only works for packages that already exist::
+
+ >>> setUp(test, 'unlikelynamespacename.fake')
+ Traceback (most recent call last):
+ ...
+ KeyError: 'unlikelynamespacename'
+
+Even so, we still need to tear down::
+
+ >>> tearDown(test)
+ Traceback (most recent call last):
+ ...
+ KeyError: 'unlikelynamespacename'
=== added directory 'src/zope/testing/renormalizing'
=== added file 'src/zope/testing/renormalizing/__init__.py'
--- src/zope/testing/renormalizing/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/renormalizing/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,316 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+#
+# This file is a package rather than a module because we want
+#
+# import doctest
+#
+# to import the stdlib version of doctest rather than the deprecated
+# zope.testing.doctest, and
+#
+# from __future__ import absolute_import
+#
+# is not available on Python 2.4 which we still support.
+#
+##############################################################################
+r"""Regular expression pattern normalizing output checker
+
+The pattern-normalizing output checker extends the default output checker with
+an option to normalize expected and actual output.
+
+You specify a sequence of patterns and replacements. The replacements are
+applied to the expected and actual outputs before calling the default outputs
+checker. Let's look at an example. In this example, we have some times and
+addresses:
+
+ >>> want = '''\
+ ... <object object at 0xb7f14438>
+ ... completed in 1.234 seconds.
+ ... <BLANKLINE>
+ ... <object object at 0xb7f14440>
+ ... completed in 123.234 seconds.
+ ... <BLANKLINE>
+ ... <object object at 0xb7f14448>
+ ... completed in .234 seconds.
+ ... <BLANKLINE>
+ ... <object object at 0xb7f14450>
+ ... completed in 1.234 seconds.
+ ... <BLANKLINE>
+ ... '''
+
+ >>> got = '''\
+ ... <object object at 0xb7f14458>
+ ... completed in 1.235 seconds.
+ ...
+ ... <object object at 0xb7f14460>
+ ... completed in 123.233 seconds.
+ ...
+ ... <object object at 0xb7f14468>
+ ... completed in .231 seconds.
+ ...
+ ... <object object at 0xb7f14470>
+ ... completed in 1.23 seconds.
+ ...
+ ... '''
+
+We may wish to consider these two strings to match, even though they differ in
+actual addresses and times. The default output checker will consider them
+different:
+
+ >>> doctest.OutputChecker().check_output(want, got, 0)
+ False
+
+We'll use the RENormalizing to normalize both the wanted and gotten strings to
+ignore differences in times and addresses:
+
+ >>> import re
+ >>> checker = RENormalizing([
+ ... (re.compile('[0-9]*[.][0-9]* seconds'), '<SOME NUMBER OF> seconds'),
+ ... (re.compile('at 0x[0-9a-f]+'), 'at <SOME ADDRESS>'),
+ ... ])
+
+ >>> checker.check_output(want, got, 0)
+ True
+
+Usual OutputChecker options work as expected:
+
+ >>> want_ellided = '''\
+ ... <object object at 0xb7f14438>
+ ... completed in 1.234 seconds.
+ ... ...
+ ... <object object at 0xb7f14450>
+ ... completed in 1.234 seconds.
+ ... <BLANKLINE>
+ ... '''
+
+ >>> checker.check_output(want_ellided, got, 0)
+ False
+
+ >>> checker.check_output(want_ellided, got, doctest.ELLIPSIS)
+ True
+
+When we get differencs, we output them with normalized text:
+
+ >>> source = '''\
+ ... >>> do_something()
+ ... <object object at 0xb7f14438>
+ ... completed in 1.234 seconds.
+ ... ...
+ ... <object object at 0xb7f14450>
+ ... completed in 1.234 seconds.
+ ... <BLANKLINE>
+ ... '''
+
+ >>> example = doctest.Example(source, want_ellided)
+
+ >>> print checker.output_difference(example, got, 0)
+ Expected:
+ <object object at <SOME ADDRESS>>
+ completed in <SOME NUMBER OF> seconds.
+ ...
+ <object object at <SOME ADDRESS>>
+ completed in <SOME NUMBER OF> seconds.
+ <BLANKLINE>
+ Got:
+ <object object at <SOME ADDRESS>>
+ completed in <SOME NUMBER OF> seconds.
+ <BLANKLINE>
+ <object object at <SOME ADDRESS>>
+ completed in <SOME NUMBER OF> seconds.
+ <BLANKLINE>
+ <object object at <SOME ADDRESS>>
+ completed in <SOME NUMBER OF> seconds.
+ <BLANKLINE>
+ <object object at <SOME ADDRESS>>
+ completed in <SOME NUMBER OF> seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+
+ >>> print checker.output_difference(example, got,
+ ... doctest.REPORT_NDIFF)
+ Differences (ndiff with -expected +actual):
+ - <object object at <SOME ADDRESS>>
+ - completed in <SOME NUMBER OF> seconds.
+ - ...
+ <object object at <SOME ADDRESS>>
+ completed in <SOME NUMBER OF> seconds.
+ <BLANKLINE>
+ + <object object at <SOME ADDRESS>>
+ + completed in <SOME NUMBER OF> seconds.
+ + <BLANKLINE>
+ + <object object at <SOME ADDRESS>>
+ + completed in <SOME NUMBER OF> seconds.
+ + <BLANKLINE>
+ + <object object at <SOME ADDRESS>>
+ + completed in <SOME NUMBER OF> seconds.
+ + <BLANKLINE>
+ <BLANKLINE>
+
+ If the wanted text is empty, however, we don't transform the actual output.
+ This is usful when writing tests. We leave the expected output empty, run
+ the test, and use the actual output as expected, after reviewing it.
+
+ >>> source = '''\
+ ... >>> do_something()
+ ... '''
+
+ >>> example = doctest.Example(source, '\n')
+ >>> print checker.output_difference(example, got, 0)
+ Expected:
+ <BLANKLINE>
+ Got:
+ <object object at 0xb7f14458>
+ completed in 1.235 seconds.
+ <BLANKLINE>
+ <object object at 0xb7f14460>
+ completed in 123.233 seconds.
+ <BLANKLINE>
+ <object object at 0xb7f14468>
+ completed in .231 seconds.
+ <BLANKLINE>
+ <object object at 0xb7f14470>
+ completed in 1.23 seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+
+If regular expressions aren't expressive enough, you can use arbitrary Python
+callables to transform the text. For example, suppose you want to ignore
+case during comparison:
+
+ >>> checker = RENormalizing([
+ ... lambda s: s.lower(),
+ ... lambda s: s.replace('<blankline>', '<BLANKLINE>'),
+ ... ])
+
+ >>> want = '''\
+ ... Usage: thundermonkey [options] [url]
+ ... <BLANKLINE>
+ ... Options:
+ ... -h display this help message
+ ... '''
+
+ >>> got = '''\
+ ... usage: thundermonkey [options] [URL]
+ ...
+ ... options:
+ ... -h Display this help message
+ ... '''
+
+ >>> checker.check_output(want, got, 0)
+ True
+
+Suppose we forgot that <BLANKLINE> must be in upper case:
+
+ >>> checker = RENormalizing([
+ ... lambda s: s.lower(),
+ ... ])
+
+ >>> checker.check_output(want, got, 0)
+ False
+
+The difference would show us that:
+
+ >>> source = '''\
+ ... >>> print_help_message()
+ ... ''' + want
+ >>> example = doctest.Example(source, want)
+ >>> print checker.output_difference(example, got,
+ ... doctest.REPORT_NDIFF),
+ Differences (ndiff with -expected +actual):
+ usage: thundermonkey [options] [url]
+ - <blankline>
+ + <BLANKLINE>
+ options:
+ -h display this help message
+
+
+It is possible to combine RENormalizing checkers for easy reuse:
+
+ >>> address_and_time_checker = RENormalizing([
+ ... (re.compile('[0-9]*[.][0-9]* seconds'), '<SOME NUMBER OF> seconds'),
+ ... (re.compile('at 0x[0-9a-f]+'), 'at <SOME ADDRESS>'),
+ ... ])
+ >>> lowercase_checker = RENormalizing([
+ ... lambda s: s.lower(),
+ ... ])
+ >>> combined_checker = address_and_time_checker + lowercase_checker
+ >>> len(combined_checker.transformers)
+ 3
+
+Combining a checker with something else does not work:
+
+ >>> lowercase_checker + 5
+ Traceback (most recent call last):
+ ...
+ TypeError: unsupported operand type(s) for +: 'instance' and 'int'
+
+"""
+
+import doctest
+
+
+class RENormalizing(doctest.OutputChecker):
+ """Pattern-normalizing outout checker
+ """
+
+ def __init__(self, patterns):
+ self.transformers = map(self._cook, patterns)
+
+ def __add__(self, other):
+ if not isinstance(other, RENormalizing):
+ return NotImplemented
+ return RENormalizing(self.transformers + other.transformers)
+
+ def _cook(self, pattern):
+ if callable(pattern):
+ return pattern
+ regexp, replacement = pattern
+ return lambda text: regexp.sub(replacement, text)
+
+ def check_output(self, want, got, optionflags):
+ if got == want:
+ return True
+
+ for transformer in self.transformers:
+ want = transformer(want)
+ got = transformer(got)
+
+ return doctest.OutputChecker.check_output(self, want, got, optionflags)
+
+ def output_difference(self, example, got, optionflags):
+
+ want = example.want
+
+ # If want is empty, use original outputter. This is useful
+ # when setting up tests for the first time. In that case, we
+ # generally use the differencer to display output, which we evaluate
+ # by hand.
+ if not want.strip():
+ return doctest.OutputChecker.output_difference(
+ self, example, got, optionflags)
+
+ # Dang, this isn't as easy to override as we might wish
+ original = want
+
+ for transformer in self.transformers:
+ want = transformer(want)
+ got = transformer(got)
+
+ # temporarily hack example with normalized want:
+ example.want = want
+ result = doctest.OutputChecker.output_difference(
+ self, example, got, optionflags)
+ example.want = original
+
+ return result
=== added file 'src/zope/testing/server.py'
--- src/zope/testing/server.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/server.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,101 @@
+##############################################################################
+#
+# Copyright (c) 2007 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Functional test server to interactively inspect the state of the application.
+
+You can run it in a functional test by adding a line like this:
+
+ startServer(http, url, "username", "password")
+
+http is an instance of HTTPCaller, url is the url that will be opened
+in the browser, the username and password are optional. When you're
+done with inspecting the application press Ctrl+C to continue with the
+functional test.
+
+$Id: server.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+import urllib2
+import webbrowser
+from BaseHTTPServer import HTTPServer, BaseHTTPRequestHandler
+import sys
+
+
+def makeRequestHandler(http, user=None, password=None):
+ class FunctionalTestRequestHandler(BaseHTTPRequestHandler):
+
+ def do_GET(self):
+ request = self.raw_requestline
+ if user and password:
+ # Authentication is built in, as there is no fluent
+ # way of transferring session from functional test to
+ # the real browser
+ request += "Authorization: Basic %s:%s\r\n" % (user, password)
+
+ # Write headers to the request
+ for header in self.headers.headers:
+ request += header
+ request += '\r\n'
+
+ if self.headers.get('Content-Length'):
+ data = self.rfile.read(int(self.headers.get('Content-Length')))
+ request += data
+ else:
+ # if no content-length was set - read until the last
+ # char, then finish
+ self.request.setblocking(0)
+ while True:
+ try:
+ char = self.rfile.read()
+ except:
+ break
+ request += char
+
+ response = http(request)
+ self.wfile.write(response)
+
+ do_POST = do_GET
+
+ return FunctionalTestRequestHandler
+
+
+def addPortToURL(url, port):
+ """Add a port number to the url.
+
+ >>> addPortToURL('http://localhost/foo/bar/baz.html', 3000)
+ 'http://localhost:3000/foo/bar/baz.html'
+ >>> addPortToURL('http://foo.bar.com/index.html?param=some-value', 555)
+ 'http://foo.bar.com:555/index.html?param=some-value'
+
+ >>> addPortToURL('http://localhost:666/index.html', 555)
+ 'http://localhost:555/index.html'
+
+ """
+ (scheme, netloc, url, query, fragment) = urllib2.urlparse.urlsplit(url)
+ netloc = netloc.split(':')[0]
+ netloc = "%s:%s" % (netloc, port)
+ url = urllib2.urlparse.urlunsplit((scheme, netloc, url, query, fragment))
+ return url
+
+
+def startServer(http, url, user=None, password=None, port=8000):
+ try:
+ server_address = ('', port)
+ requestHandler = makeRequestHandler(http, user, password)
+ url = addPortToURL(url, port)
+ httpd = HTTPServer(server_address, requestHandler)
+ # XXX we rely on browser being slower than our server
+ webbrowser.open(url)
+ print >> sys.stderr, 'Starting HTTP server...'
+ httpd.serve_forever()
+ except KeyboardInterrupt:
+ print >> sys.stderr, 'Stopped HTTP server.'
=== added file 'src/zope/testing/setupstack.py'
--- src/zope/testing/setupstack.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/setupstack.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,52 @@
+##############################################################################
+#
+# Copyright (c) 2005 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Stack-based test doctest setUp and tearDown
+
+See setupstack.txt
+"""
+
+import os, stat, tempfile
+
+key = '__' + __name__
+
+def register(test, function, *args, **kw):
+ stack = test.globs.get(key)
+ if stack is None:
+ stack = test.globs[key] = []
+ stack.append((function, args, kw))
+
+def tearDown(test):
+ stack = test.globs.get(key)
+ while stack:
+ f, p, k = stack.pop()
+ f(*p, **k)
+
+def setUpDirectory(test):
+ tmp = tempfile.mkdtemp()
+ register(test, rmtree, tmp)
+ here = os.getcwd()
+ register(test, os.chdir, here)
+ os.chdir(tmp)
+
+def rmtree(path):
+ for path, dirs, files in os.walk(path, False):
+ for fname in files:
+ fname = os.path.join(path, fname)
+ os.chmod(fname, stat.S_IWUSR)
+ os.remove(fname)
+ for dname in dirs:
+ dname = os.path.join(path, dname)
+ os.rmdir(dname)
+ os.rmdir(path)
+
=== added file 'src/zope/testing/setupstack.txt'
--- src/zope/testing/setupstack.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/setupstack.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,103 @@
+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()
+ False
+
+We can create files to out heart's content:
+
+ >>> open('Data.fs', 'w').write('xxx')
+ >>> os.path.exists('Data.fs')
+ True
+
+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)
+
+When tearDown is called:
+
+ >>> zope.testing.setupstack.tearDown(test)
+
+We'll be back where we started:
+
+ >>> here == os.getcwd()
+ True
+
+and the files we created will be gone (along with the temporary
+directory that was created:
+
+ >>> os.path.exists('Data.fs')
+ False
=== added directory 'src/zope/testing/testrunner'
=== added file 'src/zope/testing/testrunner/__init__.py'
--- src/zope/testing/testrunner/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,64 @@
+##############################################################################
+#
+# Copyright (c) 2004-2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Test runner
+
+$Id: __init__.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import sys
+import unittest
+
+
+import zope.testing.testrunner.interfaces
+
+
+def run(defaults=None, args=None, script_parts=None):
+ """Main runner function which can be and is being used from main programs.
+
+ Will execute the tests and exit the process according to the test result.
+
+ """
+ failed = run_internal(defaults, args, script_parts=script_parts)
+ sys.exit(int(failed))
+
+
+def run_internal(defaults=None, args=None, script_parts=None):
+ """Execute tests.
+
+ Returns whether errors or failures occured during testing.
+
+ """
+ # XXX Bah. Lazy import to avoid circular/early import problems
+ from zope.testing.testrunner.runner import Runner
+ runner = Runner(defaults, args, script_parts=script_parts)
+ runner.run()
+ return runner.failed
+
+
+###############################################################################
+# Install 2.4 TestSuite __iter__ into earlier versions
+
+if sys.version_info < (2, 4):
+ def __iter__(suite):
+ return iter(suite._tests)
+ unittest.TestSuite.__iter__ = __iter__
+ del __iter__
+
+# Install 2.4 TestSuite __iter__ into earlier versions
+###############################################################################
+
+if __name__ == '__main__':
+ # allow people to try out the test runner with
+ # python -m zope.testing.testrunner --test-path .
+ run()
=== added file 'src/zope/testing/testrunner/_doctest.py'
--- src/zope/testing/testrunner/_doctest.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/_doctest.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,54 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Doc test support for the test runner.
+
+$Id: __init__.py 86232 2008-05-03 15:09:33Z ctheune $
+"""
+
+import sys
+import doctest
+import zope.testing.testrunner.feature
+
+
+class DocTest(zope.testing.testrunner.feature.Feature):
+
+ active = True
+
+ def global_setup(self):
+ options = self.runner.options
+ output = options.output
+
+ self.old_reporting_flags = doctest.set_unittest_reportflags(0)
+
+ reporting_flags = 0
+ if options.ndiff:
+ reporting_flags = doctest.REPORT_NDIFF
+ if options.udiff:
+ if reporting_flags:
+ output.error("Can only give one of --ndiff, --udiff, or --cdiff")
+ sys.exit(1)
+ reporting_flags = doctest.REPORT_UDIFF
+ if options.cdiff:
+ if reporting_flags:
+ output.error("Can only give one of --ndiff, --udiff, or --cdiff")
+ sys.exit(1)
+ reporting_flags = doctest.REPORT_CDIFF
+ if options.report_only_first_failure:
+ reporting_flags |= doctest.REPORT_ONLY_FIRST_FAILURE
+
+ if reporting_flags:
+ doctest.set_unittest_reportflags(reporting_flags)
+
+ def global_shutdown(self):
+ doctest.set_unittest_reportflags(self.old_reporting_flags)
=== added file 'src/zope/testing/testrunner/coverage.py'
--- src/zope/testing/testrunner/coverage.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/coverage.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,152 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Code coverage analysis
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import trace
+import sys
+import os.path
+import threading
+
+import zope.testing.testrunner.feature
+from zope.testing.testrunner.find import test_dirs
+
+
+# For some reason, the doctest module resets the trace callable randomly, thus
+# disabling the coverage. Simply disallow the code from doing this. A real
+# trace can be set, so that debugging still works.
+osettrace = sys.settrace
+def settrace(trace):
+ if trace is None:
+ return
+ osettrace(trace)
+
+
+class TestTrace(trace.Trace):
+ """Simple tracer.
+
+ >>> tracer = TestTrace([], count=False, trace=False)
+
+ Simple rules for use: you can't stop the tracer if it not started
+ and you can't start the tracer if it already started:
+
+ >>> tracer.stop()
+ Traceback (most recent call last):
+ File 'testrunner.py'
+ AssertionError: can't stop if not started
+
+ >>> tracer.start()
+ >>> tracer.start()
+ Traceback (most recent call last):
+ File 'testrunner.py'
+ AssertionError: can't start if already started
+
+ >>> tracer.stop()
+ >>> tracer.stop()
+ Traceback (most recent call last):
+ File 'testrunner.py'
+ AssertionError: can't stop if not started
+ """
+
+ def __init__(self, directories, **kw):
+ trace.Trace.__init__(self, **kw)
+ self.ignore = TestIgnore(directories)
+ self.started = False
+
+ def start(self):
+ assert not self.started, "can't start if already started"
+ if not self.donothing:
+ sys.settrace = settrace
+ sys.settrace(self.globaltrace)
+ threading.settrace(self.globaltrace)
+ self.started = True
+
+ def stop(self):
+ assert self.started, "can't stop if not started"
+ if not self.donothing:
+ sys.settrace = osettrace
+ sys.settrace(None)
+ threading.settrace(None)
+ self.started = False
+
+
+class TestIgnore:
+
+ def __init__(self, directories):
+ self._test_dirs = [self._filenameFormat(d[0]) + os.path.sep
+ for d in directories]
+ self._ignore = {}
+ self._ignored = self._ignore.get
+
+ def names(self, filename, modulename):
+ # Special case: Modules generated from text files; i.e. doctests
+ if modulename == '<string>':
+ return True
+ filename = self._filenameFormat(filename)
+ ignore = self._ignored(filename)
+ if ignore is None:
+ ignore = True
+ if filename is not None:
+ for d in self._test_dirs:
+ if filename.startswith(d):
+ ignore = False
+ break
+ self._ignore[filename] = ignore
+ return ignore
+
+ def _filenameFormat(self, filename):
+ return os.path.abspath(filename)
+
+if sys.platform == 'win32':
+ #on win32 drive name can be passed with different case to `names`
+ #that lets e.g. the coverage profiler skip complete files
+ #_filenameFormat will make sure that all drive and filenames get lowercased
+ #albeit trace coverage has still problems with lowercase drive letters
+ #when determining the dotted module name
+ OldTestIgnore = TestIgnore
+
+ class TestIgnore(OldTestIgnore):
+ def _filenameFormat(self, filename):
+ return os.path.normcase(os.path.abspath(filename))
+
+
+class Coverage(zope.testing.testrunner.feature.Feature):
+
+ tracer = None
+ directory = None
+
+ def __init__(self, runner):
+ super(Coverage, self).__init__(runner)
+ self.active = bool(runner.options.coverage)
+
+ def global_setup(self):
+ """Executed once when the test runner is being set up."""
+ self.directory = os.path.join(os.getcwd(), self.runner.options.coverage)
+
+ # FIXME: This shouldn't rely on the find feature directly.
+ self.tracer = TestTrace(test_dirs(self.runner.options, {}),
+ trace=False, count=True)
+ self.tracer.start()
+
+ def early_teardown(self):
+ """Executed once directly after all tests."""
+ self.tracer.stop()
+
+ def report(self):
+ """Executed once after all tests have been run and all setup was
+ torn down."""
+ r = self.tracer.results()
+ r.write_results(summary=True, coverdir=self.directory)
=== added file 'src/zope/testing/testrunner/debug.py'
--- src/zope/testing/testrunner/debug.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/debug.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,60 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Debug functions
+
+$Id: __init__.py 86232 2008-05-03 15:09:33Z ctheune $
+
+"""
+
+import doctest
+import sys
+import pdb
+
+import zope.testing.testrunner.interfaces
+
+
+def post_mortem(exc_info):
+ err = exc_info[1]
+ if isinstance(err, (doctest.UnexpectedException, doctest.DocTestFailure)):
+
+ if isinstance(err, doctest.UnexpectedException):
+ exc_info = err.exc_info
+
+ # Print out location info if the error was in a doctest
+ if exc_info[2].tb_frame.f_code.co_filename == '<string>':
+ print_doctest_location(err)
+
+ else:
+ print_doctest_location(err)
+ # Hm, we have a DocTestFailure exception. We need to
+ # generate our own traceback
+ try:
+ exec ('raise ValueError'
+ '("Expected and actual output are different")'
+ ) in err.test.globs
+ except:
+ exc_info = sys.exc_info()
+
+ print "%s:" % (exc_info[0], )
+ print exc_info[1]
+ pdb.post_mortem(exc_info[2])
+ raise zope.testing.testrunner.interfaces.EndRun()
+
+
+def print_doctest_location(err):
+ # This mimics pdb's output, which gives way cool results in emacs :)
+ filename = err.test.filename
+ if filename.endswith('.pyc'):
+ filename = filename[:-1]
+ print "> %s(%s)_()" % (filename, err.test.lineno+err.example.lineno+1)
=== added file 'src/zope/testing/testrunner/eggsupport.py'
--- src/zope/testing/testrunner/eggsupport.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/eggsupport.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,114 @@
+""" Add unit and functional testing support to setuptools-driven eggs.
+"""
+from setuptools.command.test import ScanningLoader
+from setuptools.command.test import test as BaseCommand
+
+
+def skipLayers(suite):
+ """ Walk the suite returned by setuptools' testloader.
+
+ o Skip any tests which have a 'layer' defined.
+ """
+ from unittest import TestSuite
+ result = TestSuite()
+ for test in suite._tests:
+ if isinstance(test, TestSuite):
+ result.addTest(skipLayers(test))
+ else:
+ layer = getattr(test, 'layer', None)
+ if layer is None:
+ result.addTest(test)
+ return result
+
+class SkipLayers(ScanningLoader):
+ """ Load only unit tests (those which have no layer associated with them).
+
+ o Running the tests using 'setup.py test' cannot, by default, drive the
+ full testrunner, with its support for layers (in functional tests).
+ This loader allows the command to work, by running only those tests
+ which don't need the layer support.
+
+ o To run layer-dependent tests, use 'setup.py ftest' (see below for
+ adding the command to your setup.py).
+
+ o To use this loader your pacakge add the following your 'setup()'
+ call::
+
+ setup(
+ ...
+ setup_requires=['eggtestinfo' # captures testing metadata in EGG-INFO
+ ],
+ tests_require=['zope.testing >= 3.6.1dev', #XXX fix version at release
+ ],
+ ...
+ test_loader='zope.testing.testrunner.eggsupport:SkipLayers',
+ ...
+ )
+ """
+ def loadTestsFromModule(self, module):
+ return skipLayers(ScanningLoader.loadTestsFromModule(self, module))
+
+def print_usage():
+ print 'python setup.py ftest'
+ print
+ print ftest.__doc__
+
+class ftest(BaseCommand):
+ """ Run unit and functional tests after an in-place build.
+
+ o Note that this command runs *all* tests (unit *and* functional).
+
+ o This command does not provide any of the configuration options which
+ the usual testrunner provided by 'zope.testing' offers: it is intended
+ to allow easy verification that a package has been installed correctly
+ via setuptools, but is not likely to be useful for developers working
+ on the package.
+
+ o Developers working on the package will likely prefer to work with
+ the stock testrunner, e.g., by using buildout with a recipe which
+ configures the testrunner as a standalone script.
+
+ o To use this in your pacakge add the following to the 'entry_points'
+ section::
+
+ setup(
+ ...
+ setup_requires=['zope.testing >= 3.6.1dev', #XXX fix version at release
+ 'eggtestinfo' # captures testing metadata in EGG-INFO
+ ],
+ ...
+ entry_points='''
+ [setuptools.commands]
+ ftest = zope.testing.testrunner.eggsupport:SetuptoolsFunctionalTest
+ '''
+ ...
+ )
+ """
+ description = "Run all functional and unit tests after in-place build"
+ user_options = []
+ help_options = [('usage', '?', 'Show usage', print_usage)]
+
+ def initialize_options(self):
+ pass # suppress normal handling
+
+ def finalize_options(self):
+ pass # suppress normal handling
+
+ def run(self):
+ from zope.testing.testrunner import run
+
+ dist = self.distribution
+ where = dist.package_dir or '.'
+ args = ['IGNORE_ME', '--test-path', where]
+
+ if dist.install_requires:
+ dist.fetch_build_eggs(dist.install_requires)
+
+ if dist.tests_require:
+ dist.fetch_build_eggs(dist.tests_require)
+
+ def _run():
+ run(args=args)
+
+ self.with_project_on_sys_path(_run)
+
=== added file 'src/zope/testing/testrunner/feature.py'
--- src/zope/testing/testrunner/feature.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/feature.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,71 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Generic features for the test runner.
+
+$Id: __init__.py 86232 2008-05-03 15:09:33Z ctheune $
+"""
+
+import zope.interface
+import zope.testing.testrunner.interfaces
+
+
+class Feature(object):
+ """A base class implementing no-op methods for the IFeature interface."""
+
+ zope.interface.implements(zope.testing.testrunner.interfaces.IFeature)
+
+ active = False
+
+ def __init__(self, runner):
+ self.runner = runner
+
+ def global_setup(self):
+ """Executed once when the test runner is being set up."""
+ pass
+
+ def late_setup(self):
+ """Executed once right before the actual tests get executed and after
+ all global setups have happened.
+ """
+ pass
+
+ def layer_setup(self, layer):
+ """Executed once after a layer was set up."""
+ pass
+
+ def layer_teardown(self, layer):
+ """Executed once after a layer was run."""
+ pass
+
+ def test_setup(self):
+ """Executed once before each test."""
+ pass
+
+ def test_teardown(self):
+ """Executed once after each test."""
+ pass
+
+ def early_teardown(self):
+ """Executed once directly after all tests."""
+ pass
+
+ def global_teardown(self):
+ """Executed once after all tests where run and early teardowns have
+ happened."""
+ pass
+
+ def report(self):
+ """Executed once after all tests have been run and all setup was
+ torn down."""
+ pass
=== added file 'src/zope/testing/testrunner/filter.py'
--- src/zope/testing/testrunner/filter.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/filter.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,82 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Filter which tests to run.
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import zope.testing.testrunner.feature
+
+
+UNITTEST_LAYER = 'zope.testing.testrunner.layer.UnitTests'
+
+
+class Filter(zope.testing.testrunner.feature.Feature):
+ """Filters and orders all tests registered until now."""
+
+ active = True
+
+ def global_setup(self):
+ layers = self.runner.tests_by_layer_name
+ options = self.runner.options
+
+ if UNITTEST_LAYER in layers:
+ # We start out assuming unit tests should run and look for reasons
+ # why they shouldn't be run.
+ should_run = True
+ if (not options.non_unit):
+ if options.layer:
+ should_run = False
+ for pat in options.layer:
+ if pat(UNITTEST_LAYER):
+ should_run = True
+ break
+ else:
+ should_run = True
+ else:
+ should_run = False
+
+ if not should_run:
+ layers.pop(UNITTEST_LAYER)
+
+ if self.runner.options.resume_layer is not None:
+ for name in list(layers):
+ if name != self.runner.options.resume_layer:
+ layers.pop(name)
+ elif self.runner.options.layer:
+ for name in list(layers):
+ for pat in self.runner.options.layer:
+ if pat(name):
+ # This layer matches a pattern selecting this layer
+ break
+ else:
+ # No pattern matched this name so we remove it
+ layers.pop(name)
+
+ if (self.runner.options.verbose and
+ not self.runner.options.resume_layer):
+ if self.runner.options.all:
+ msg = "Running tests at all levels"
+ else:
+ msg = "Running tests at level %d" % self.runner.options.at_level
+ self.runner.options.output.info(msg)
+
+ def report(self):
+ if not self.runner.do_run_tests:
+ return
+ if self.runner.options.resume_layer:
+ return
+ if self.runner.options.verbose:
+ self.runner.options.output.tests_with_errors(self.runner.errors)
+ self.runner.options.output.tests_with_failures(self.runner.failures)
=== added file 'src/zope/testing/testrunner/find.py'
--- src/zope/testing/testrunner/find.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/find.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,428 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Test discovery
+
+$Id: __init__.py 86223 2008-05-03 14:36:04Z ctheune $
+"""
+
+import re
+import os
+import unittest
+import sys
+
+import zope.testing.testrunner.feature
+import zope.testing.testrunner.layer
+import zope.testing.testrunner.debug
+
+identifier = re.compile(r'[_a-zA-Z]\w*$').match
+
+
+class StartUpFailure(unittest.TestCase):
+ """Empty test case added to the test suite to indicate import failures.
+
+ >>> class Options(object):
+ ... post_mortem = False
+ >>> options = Options()
+
+ Normally the StartUpFailure just acts as an empty test suite to satisfy
+ the test runner and statistics:
+
+ >>> s = StartUpFailure(options, None, None)
+ >>> isinstance(s,unittest.TestCase)
+ True
+
+ However, if the post mortem option is enabled:
+
+ >>> options.post_mortem = True
+
+ ...then the the StartUpFailure will start the debugger and stop
+ the test run after the debugger quits.
+
+ To simulate this, we need an exception and its associated
+ exc_info:
+
+ >>> import sys
+ >>> try:
+ ... raise Exception()
+ ... except:
+ ... exc_info = sys.exc_info()
+
+ To simulate the user pressing 'c' and hitting return in the
+ debugger, we use a FakeInputContinueGenerator:
+
+ >>> from zope.testing.testrunner.runner import FakeInputContinueGenerator
+ >>> old_stdin = sys.stdin
+ >>> sys.stdin = FakeInputContinueGenerator()
+
+ Now we can see the EndRun exception that is raised by the
+ postmortem debugger to indicate that debugging is finished and the
+ test run should be terminated:
+
+ >>> try:
+ ... StartUpFailure(options, None, exc_info)
+ ... finally:
+ ... sys.stdin = old_stdin
+ Traceback (most recent call last):
+ EndRun
+
+ Annoyingly, sometimes StartupFailures occur when postmortem debugging
+ is enabled but no exc_info is passed. In this case, we raise a
+ sensible exception rather than letting the debugger barf with an
+ AttributeError:
+
+ >>> options.post_mortem = True
+ >>> StartUpFailure(options, None, exc_info[:2]+(None,))
+ Traceback (most recent call last):
+ ...
+ TypeError: If post_mortem is specified, full exc_info must be passed!
+ """
+
+ def __init__(self, options, module, exc_info):
+ if options.post_mortem:
+ for item in exc_info:
+ if item is None:
+ raise TypeError('If post_mortem is specified, '
+ 'full exc_info must be passed!')
+ zope.testing.testrunner.debug.post_mortem(exc_info)
+ self.module = module
+ self.exc_info = exc_info
+
+ def __repr__(self):
+ return '<StartUpFailure module=%s>' % self.module
+
+
+def find_tests(options, found_suites=None):
+ """Creates a dictionary mapping layer name to a suite of tests to be run
+ in that layer.
+
+ Passing a list of suites using the found_suites parameter will cause
+ that list of suites to be used instead of attempting to load them from
+ the filesystem. This is useful for unit testing the test runner.
+ """
+ remove_stale_bytecode(options)
+ suites = {}
+ if found_suites is None:
+ found_suites = find_suites(options)
+ for suite in found_suites:
+ for test, layer_name in tests_from_suite(suite, options):
+ suite = suites.get(layer_name)
+ if not suite:
+ suite = suites[layer_name] = unittest.TestSuite()
+ suite.addTest(test)
+ return suites
+
+
+def find_suites(options):
+ for fpath, package in find_test_files(options):
+ for (prefix, prefix_package) in options.prefix:
+ if fpath.startswith(prefix) and package == prefix_package:
+ # strip prefix, strip .py suffix and convert separator to dots
+ noprefix = fpath[len(prefix):]
+ noext = strip_py_ext(options, noprefix)
+ assert noext is not None
+ module_name = noext.replace(os.path.sep, '.')
+ if package:
+ module_name = package + '.' + module_name
+
+ for filter in options.module:
+ if filter(module_name):
+ break
+ else:
+ continue
+
+ try:
+ module = import_name(module_name)
+ except KeyboardInterrupt:
+ raise
+ except:
+ suite = StartUpFailure(
+ options, module_name,
+ sys.exc_info()[:2]
+ + (sys.exc_info()[2].tb_next.tb_next,),
+ )
+ else:
+ try:
+ if hasattr(module, options.suite_name):
+ suite = getattr(module, options.suite_name)()
+ else:
+ suite = unittest.defaultTestLoader.loadTestsFromModule(module)
+ if suite.countTestCases() == 0:
+ raise TypeError(
+ "Module %s does not define any tests"
+ % module_name)
+
+ if isinstance(suite, unittest.TestSuite):
+ check_suite(suite, module_name)
+ else:
+ raise TypeError(
+ "Invalid test_suite, %r, in %s"
+ % (suite, module_name)
+ )
+ except KeyboardInterrupt:
+ raise
+ except:
+ suite = StartUpFailure(
+ options, module_name, sys.exc_info()[:2]+(None,))
+
+ yield suite
+ break
+
+
+def find_test_files(options):
+ found = {}
+ for f, package in find_test_files_(options):
+ if f not in found:
+ found[f] = 1
+ yield f, package
+
+
+def find_test_files_(options):
+ tests_pattern = options.tests_pattern
+ test_file_pattern = options.test_file_pattern
+
+ # If options.usecompiled, we can accept .pyc or .pyo files instead
+ # of .py files. We'd rather use a .py file if one exists. `root2ext`
+ # maps a test file path, sans extension, to the path with the best
+ # extension found (.py if it exists, else .pyc or .pyo).
+ # Note that "py" < "pyc" < "pyo", so if more than one extension is
+ # found, the lexicographically smaller one is best.
+
+ # Found a new test file, in directory `dirname`. `noext` is the
+ # file name without an extension, and `withext` is the file name
+ # with its extension.
+ def update_root2ext(dirname, noext, withext):
+ key = os.path.join(dirname, noext)
+ new = os.path.join(dirname, withext)
+ if key in root2ext:
+ root2ext[key] = min(root2ext[key], new)
+ else:
+ root2ext[key] = new
+
+ for (p, package) in test_dirs(options, {}):
+ for dirname, dirs, files in walk_with_symlinks(options, p):
+ if dirname != p and not contains_init_py(options, files):
+ # This is not a plausible test directory. Avoid descending
+ # further.
+ del dirs[:]
+ continue
+ root2ext = {}
+ dirs[:] = filter(identifier, dirs)
+ d = os.path.split(dirname)[1]
+ if tests_pattern(d) and contains_init_py(options, files):
+ # tests directory
+ for file in files:
+ noext = strip_py_ext(options, file)
+ if noext and test_file_pattern(noext):
+ update_root2ext(dirname, noext, file)
+
+ for file in files:
+ noext = strip_py_ext(options, file)
+ if noext and tests_pattern(noext):
+ update_root2ext(dirname, noext, file)
+
+ winners = root2ext.values()
+ winners.sort()
+ for file in winners:
+ yield file, package
+
+
+def strip_py_ext(options, path):
+ """Return path without its .py (or .pyc or .pyo) extension, or None.
+
+ If options.usecompiled is false:
+ If path ends with ".py", the path without the extension is returned.
+ Else None is returned.
+
+ If options.usecompiled is true:
+ If Python is running with -O, a .pyo extension is also accepted.
+ If Python is running without -O, a .pyc extension is also accepted.
+ """
+ if path.endswith(".py"):
+ return path[:-3]
+ if options.usecompiled:
+ if __debug__:
+ # Python is running without -O.
+ ext = ".pyc"
+ else:
+ # Python is running with -O.
+ ext = ".pyo"
+ if path.endswith(ext):
+ return path[:-len(ext)]
+ return None
+
+
+def test_dirs(options, seen):
+ if options.package:
+ for p in options.package:
+ p = import_name(p)
+ for p in p.__path__:
+ p = os.path.abspath(p)
+ if p in seen:
+ continue
+ for (prefix, package) in options.prefix:
+ if p.startswith(prefix) or p == prefix[:-1]:
+ seen[p] = 1
+ yield p, package
+ break
+ else:
+ for dpath in options.test_path:
+ yield dpath
+
+
+def walk_with_symlinks(options, dir):
+ # TODO -- really should have test of this that uses symlinks
+ # this is hard on a number of levels ...
+ for dirpath, dirs, files in os.walk(dir):
+ dirs.sort()
+ files.sort()
+ dirs[:] = [d for d in dirs if d not in options.ignore_dir]
+ yield (dirpath, dirs, files)
+ for d in dirs:
+ p = os.path.join(dirpath, d)
+ if os.path.islink(p):
+ for sdirpath, sdirs, sfiles in walk_with_symlinks(options, p):
+ yield (sdirpath, sdirs, sfiles)
+
+
+compiled_suffixes = '.pyc', '.pyo'
+def remove_stale_bytecode(options):
+ if options.keepbytecode:
+ return
+ for (p, _) in options.test_path:
+ for dirname, dirs, files in walk_with_symlinks(options, p):
+ for file in files:
+ if file[-4:] in compiled_suffixes and file[:-1] not in files:
+ fullname = os.path.join(dirname, file)
+ options.output.info("Removing stale bytecode file %s"
+ % fullname)
+ os.unlink(fullname)
+
+
+def contains_init_py(options, fnamelist):
+ """Return true iff fnamelist contains a suitable spelling of __init__.py.
+
+ If options.usecompiled is false, this is so iff "__init__.py" is in
+ the list.
+
+ If options.usecompiled is true, then "__init__.pyo" is also acceptable
+ if Python is running with -O, and "__init__.pyc" is also acceptable if
+ Python is running without -O.
+ """
+ if "__init__.py" in fnamelist:
+ return True
+ if options.usecompiled:
+ if __debug__:
+ # Python is running without -O.
+ return "__init__.pyc" in fnamelist
+ else:
+ # Python is running with -O.
+ return "__init__.pyo" in fnamelist
+ return False
+
+
+def import_name(name):
+ __import__(name)
+ return sys.modules[name]
+
+
+def tests_from_suite(suite, options, dlevel=1,
+ dlayer=zope.testing.testrunner.layer.UnitTests):
+ """Returns a sequence of (test, layer_name)
+
+ The tree of suites is recursively visited, with the most specific
+ layer taking precedence. So if a TestCase with a layer of 'foo' is
+ contained in a TestSuite with a layer of 'bar', the test case would be
+ returned with 'foo' as the layer.
+
+ Tests are also filtered out based on the test level and test selection
+ filters stored in the options.
+ """
+ level = getattr(suite, 'level', dlevel)
+ layer = getattr(suite, 'layer', dlayer)
+ if not isinstance(layer, basestring):
+ layer = name_from_layer(layer)
+
+ if isinstance(suite, unittest.TestSuite):
+ for possible_suite in suite:
+ for r in tests_from_suite(possible_suite, options, level, layer):
+ yield r
+ elif isinstance(suite, StartUpFailure):
+ yield (suite, None)
+ else:
+ if level <= options.at_level:
+ for pat in options.test:
+ if pat(str(suite)) or pat(suite.id()):
+ yield (suite, layer)
+ break
+
+
+def check_suite(suite, module_name):
+
+ """Check for bad tests in a test suite.
+
+ "Bad tests" are those that do not inherit from unittest.TestCase.
+
+ Note that this function is pointless on Python 2.5, because unittest itself
+ checks for this in TestSuite.addTest. It is, however, useful on earlier
+ Pythons.
+ """
+ for x in suite:
+ if isinstance(x, unittest.TestSuite):
+ check_suite(x, module_name)
+ elif not isinstance(x, unittest.TestCase):
+ raise TypeError(
+ "Invalid test, %r,\nin test_suite from %s"
+ % (x, module_name)
+ )
+
+
+_layer_name_cache = {}
+
+def name_from_layer(layer):
+ """Determine a name for the Layer using the namespace to avoid conflicts.
+
+ We also cache a name -> layer mapping to enable layer_from_name to work
+ in cases where the layer cannot be imported (such as layers defined
+ in doctests)
+ """
+ if layer.__module__ == '__builtin__':
+ name = layer.__name__
+ else:
+ name = layer.__module__ + '.' + layer.__name__
+ _layer_name_cache[name] = layer
+ return name
+
+
+class Find(zope.testing.testrunner.feature.Feature):
+ """Finds tests and registers them with the test runner."""
+
+ active = True
+
+ def global_setup(self):
+ # Add directories to the path
+ for path in self.runner.options.path:
+ if path not in sys.path:
+ sys.path.append(path)
+
+ tests = find_tests(self.runner.options, self.runner.found_suites)
+ self.import_errors = tests.pop(None, None)
+ self.runner.register_tests(tests)
+
+ # XXX move to reporting ???
+ self.runner.options.output.import_errors(self.import_errors)
+ self.runner.import_errors = bool(self.import_errors)
+
+ def report(self):
+ self.runner.options.output.modules_with_import_problems(
+ self.import_errors)
=== added file 'src/zope/testing/testrunner/formatter.py'
--- src/zope/testing/testrunner/formatter.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/formatter.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1086 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Output formatting.
+
+$Id: __init__.py 86207 2008-05-03 13:25:02Z ctheune $
+"""
+
+import doctest
+import os
+import sys
+import re
+import tempfile
+import traceback
+
+from datetime import datetime, timedelta
+
+from zope.testing.exceptions import DocTestFailureException
+
+doctest_template = """
+File "%s", line %s, in %s
+
+%s
+Want:
+%s
+Got:
+%s
+"""
+
+
+class OutputFormatter(object):
+ """Test runner output formatter."""
+
+ # Implementation note: be careful about printing stuff to sys.stderr.
+ # It is used for interprocess communication between the parent and the
+ # child test runner, when you run some test layers in a subprocess.
+ # resume_layer() reasigns sys.stderr for this reason, but be careful
+ # and don't store the original one in __init__ or something.
+
+ max_width = 80
+
+ def __init__(self, options):
+ self.options = options
+ self.last_width = 0
+ self.compute_max_width()
+
+ progress = property(lambda self: self.options.progress)
+ verbose = property(lambda self: self.options.verbose)
+ in_subprocess = property(
+ lambda self: self.options.resume_layer is not None and
+ self.options.processes > 1)
+
+ def compute_max_width(self):
+ """Try to determine the terminal width."""
+ # Note that doing this every time is more test friendly.
+ self.max_width = tigetnum('cols', self.max_width)
+
+ def getShortDescription(self, test, room):
+ """Return a description of a test that fits in ``room`` characters."""
+ room -= 1
+ s = str(test)
+ if len(s) > room:
+ pos = s.find(" (")
+ if pos >= 0:
+ w = room - (pos + 5)
+ if w < 1:
+ # first portion (test method name) is too long
+ s = s[:room-3] + "..."
+ else:
+ pre = s[:pos+2]
+ post = s[-w:]
+ s = "%s...%s" % (pre, post)
+ else:
+ w = room - 4
+ s = '... ' + s[-w:]
+
+ return ' ' + s[:room]
+
+ def info(self, message):
+ """Print an informative message."""
+ print message
+
+ def info_suboptimal(self, message):
+ """Print an informative message about losing some of the features.
+
+ For example, when you run some tests in a subprocess, you lose the
+ ability to use the debugger.
+ """
+ print message
+
+ def error(self, message):
+ """Report an error."""
+ print message
+
+ def error_with_banner(self, message):
+ """Report an error with a big ASCII banner."""
+ print
+ print '*'*70
+ self.error(message)
+ print '*'*70
+ print
+
+ def profiler_stats(self, stats):
+ """Report profiler stats."""
+ stats.print_stats(50)
+
+ def import_errors(self, import_errors):
+ """Report test-module import errors (if any)."""
+ if import_errors:
+ print "Test-module import failures:"
+ for error in import_errors:
+ self.print_traceback("Module: %s\n" % error.module,
+ error.exc_info),
+ print
+
+ def tests_with_errors(self, errors):
+ """Report names of tests with errors (if any)."""
+ if errors:
+ print
+ print "Tests with errors:"
+ for test, exc_info in errors:
+ print " ", test
+
+ def tests_with_failures(self, failures):
+ """Report names of tests with failures (if any)."""
+ if failures:
+ print
+ print "Tests with failures:"
+ for test, exc_info in failures:
+ print " ", test
+
+ def modules_with_import_problems(self, import_errors):
+ """Report names of modules with import problems (if any)."""
+ if import_errors:
+ print
+ print "Test-modules with import problems:"
+ for test in import_errors:
+ print " " + test.module
+
+ def format_seconds(self, n_seconds):
+ """Format a time in seconds."""
+ if n_seconds >= 60:
+ n_minutes, n_seconds = divmod(n_seconds, 60)
+ return "%d minutes %.3f seconds" % (n_minutes, n_seconds)
+ else:
+ return "%.3f seconds" % n_seconds
+
+ def format_seconds_short(self, n_seconds):
+ """Format a time in seconds (short version)."""
+ return "%.3f s" % n_seconds
+
+ def summary(self, n_tests, n_failures, n_errors, n_seconds):
+ """Summarize the results of a single test layer."""
+ print (" Ran %s tests with %s failures and %s errors in %s."
+ % (n_tests, n_failures, n_errors,
+ self.format_seconds(n_seconds)))
+
+ def totals(self, n_tests, n_failures, n_errors, n_seconds):
+ """Summarize the results of all layers."""
+ print ("Total: %s tests, %s failures, %s errors in %s."
+ % (n_tests, n_failures, n_errors,
+ self.format_seconds(n_seconds)))
+
+ def list_of_tests(self, tests, layer_name):
+ """Report a list of test names."""
+ print "Listing %s tests:" % layer_name
+ for test in tests:
+ print ' ', test.id()
+
+ def garbage(self, garbage):
+ """Report garbage generated by tests."""
+ if garbage:
+ print "Tests generated new (%d) garbage:" % len(garbage)
+ print garbage
+
+ def test_garbage(self, test, garbage):
+ """Report garbage generated by a test."""
+ if garbage:
+ print "The following test left garbage:"
+ print test
+ print garbage
+
+ def test_threads(self, test, new_threads):
+ """Report threads left behind by a test."""
+ if new_threads:
+ print "The following test left new threads behind:"
+ print test
+ print "New thread(s):", new_threads
+
+ def refcounts(self, rc, prev):
+ """Report a change in reference counts."""
+ print " sys refcount=%-8d change=%-6d" % (rc, rc - prev)
+
+ def detailed_refcounts(self, track, rc, prev):
+ """Report a change in reference counts, with extra detail."""
+ print (" sum detail refcount=%-8d"
+ " sys refcount=%-8d"
+ " change=%-6d"
+ % (track.n, rc, rc - prev))
+ track.output()
+
+ def start_set_up(self, layer_name):
+ """Report that we're setting up a layer.
+
+ The next output operation should be stop_set_up().
+ """
+ print " Set up %s" % layer_name,
+ sys.stdout.flush()
+
+ def stop_set_up(self, seconds):
+ """Report that we've set up a layer.
+
+ Should be called right after start_set_up().
+ """
+ print "in %s." % self.format_seconds(seconds)
+
+ def start_tear_down(self, layer_name):
+ """Report that we're tearing down a layer.
+
+ The next output operation should be stop_tear_down() or
+ tear_down_not_supported().
+ """
+ print " Tear down %s" % layer_name,
+ sys.stdout.flush()
+
+ def stop_tear_down(self, seconds):
+ """Report that we've tore down a layer.
+
+ Should be called right after start_tear_down().
+ """
+ print "in %s." % self.format_seconds(seconds)
+
+ def tear_down_not_supported(self):
+ """Report that we could not tear down a layer.
+
+ Should be called right after start_tear_down().
+ """
+ print "... not supported"
+
+ def start_test(self, test, tests_run, total_tests):
+ """Report that we're about to run a test.
+
+ The next output operation should be test_success(), test_error(), or
+ test_failure().
+ """
+ self.test_width = 0
+ if self.progress:
+ if self.last_width:
+ sys.stdout.write('\r' + (' ' * self.last_width) + '\r')
+
+ s = " %d/%d (%.1f%%)" % (tests_run, total_tests,
+ tests_run * 100.0 / total_tests)
+ sys.stdout.write(s)
+ self.test_width += len(s)
+ if self.verbose == 1:
+ room = self.max_width - self.test_width - 1
+ s = self.getShortDescription(test, room)
+ sys.stdout.write(s)
+ self.test_width += len(s)
+
+ elif self.verbose == 1:
+ sys.stdout.write('.' * test.countTestCases())
+
+ elif self.in_subprocess:
+ sys.stdout.write('.' * test.countTestCases())
+ # Give the parent process a new line so it sees the progress
+ # in a timely manner.
+ sys.stdout.write('\n')
+
+ if self.verbose > 1:
+ s = str(test.id())
+ sys.stdout.write(' ')
+ sys.stdout.write(s)
+ self.test_width += len(s) + 1
+
+ sys.stdout.flush()
+
+ def test_success(self, test, seconds):
+ """Report that a test was successful.
+
+ Should be called right after start_test().
+
+ The next output operation should be stop_test().
+ """
+ if self.verbose > 2:
+ s = " (%s)" % self.format_seconds_short(seconds)
+ sys.stdout.write(s)
+ self.test_width += len(s) + 1
+
+ def test_error(self, test, seconds, exc_info):
+ """Report that an error occurred while running a test.
+
+ Should be called right after start_test().
+
+ The next output operation should be stop_test().
+ """
+ if self.verbose > 2:
+ print " (%s)" % self.format_seconds_short(seconds)
+ print
+ self.print_traceback("Error in test %s" % test, exc_info)
+ self.test_width = self.last_width = 0
+
+ def test_failure(self, test, seconds, exc_info):
+ """Report that a test failed.
+
+ Should be called right after start_test().
+
+ The next output operation should be stop_test().
+ """
+ if self.verbose > 2:
+ print " (%s)" % self.format_seconds_short(seconds)
+ print
+ self.print_traceback("Failure in test %s" % test, exc_info)
+ self.test_width = self.last_width = 0
+
+ def print_traceback(self, msg, exc_info):
+ """Report an error with a traceback."""
+ print
+ print msg
+ print self.format_traceback(exc_info)
+
+ def format_traceback(self, exc_info):
+ """Format the traceback."""
+ v = exc_info[1]
+ if isinstance(v, DocTestFailureException):
+ tb = v.args[0]
+ elif isinstance(v, doctest.DocTestFailure):
+ tb = doctest_template % (
+ v.test.filename,
+ v.test.lineno + v.example.lineno + 1,
+ v.test.name,
+ v.example.source,
+ v.example.want,
+ v.got,
+ )
+ else:
+ tb = "".join(traceback.format_exception(*exc_info))
+ return tb
+
+ def stop_test(self, test):
+ """Clean up the output state after a test."""
+ if self.progress:
+ self.last_width = self.test_width
+ elif self.verbose > 1:
+ print
+ sys.stdout.flush()
+
+ def stop_tests(self):
+ """Clean up the output state after a collection of tests."""
+ if self.progress and self.last_width:
+ sys.stdout.write('\r' + (' ' * self.last_width) + '\r')
+ if self.verbose == 1 or self.progress:
+ print
+
+
+def tigetnum(attr, default=None):
+ """Return a value from the terminfo database.
+
+ Terminfo is used on Unix-like systems to report various terminal attributes
+ (such as width, height or the number of supported colors).
+
+ Returns ``default`` when the ``curses`` module is not available, or when
+ sys.stdout is not a terminal.
+ """
+ try:
+ import curses
+ except ImportError:
+ # avoid reimporting a broken module in python 2.3
+ sys.modules['curses'] = None
+ else:
+ try:
+ curses.setupterm()
+ except (curses.error, TypeError):
+ # You get curses.error when $TERM is set to an unknown name
+ # You get TypeError when sys.stdout is not a real file object
+ # (e.g. in unit tests that use various wrappers).
+ pass
+ else:
+ return curses.tigetnum(attr)
+ return default
+
+
+def terminal_has_colors():
+ """Determine whether the terminal supports colors.
+
+ Some terminals (e.g. the emacs built-in one) don't.
+ """
+ return tigetnum('colors', -1) >= 8
+
+
+class ColorfulOutputFormatter(OutputFormatter):
+ """Output formatter that uses ANSI color codes.
+
+ Like syntax highlighting in your text editor, colorizing
+ test failures helps the developer.
+ """
+
+ # These colors are carefully chosen to have enough contrast
+ # on terminals with both black and white background.
+ colorscheme = {'normal': 'normal',
+ 'default': 'default',
+ 'info': 'normal',
+ 'suboptimal-behaviour': 'magenta',
+ 'error': 'brightred',
+ 'number': 'green',
+ 'slow-test': 'brightmagenta',
+ 'ok-number': 'green',
+ 'error-number': 'brightred',
+ 'filename': 'lightblue',
+ 'lineno': 'lightred',
+ 'testname': 'lightcyan',
+ 'failed-example': 'cyan',
+ 'expected-output': 'green',
+ 'actual-output': 'red',
+ 'character-diffs': 'magenta',
+ 'diff-chunk': 'magenta',
+ 'exception': 'red'}
+
+ # Map prefix character to color in diff output. This handles ndiff and
+ # udiff correctly, but not cdiff. In cdiff we ought to highlight '!' as
+ # expected-output until we see a '-', then highlight '!' as actual-output,
+ # until we see a '*', then switch back to highlighting '!' as
+ # expected-output. Nevertheless, coloried cdiffs are reasonably readable,
+ # so I'm not going to fix this.
+ # -- mgedmin
+ diff_color = {'-': 'expected-output',
+ '+': 'actual-output',
+ '?': 'character-diffs',
+ '@': 'diff-chunk',
+ '*': 'diff-chunk',
+ '!': 'actual-output',}
+
+ prefixes = [('dark', '0;'),
+ ('light', '1;'),
+ ('bright', '1;'),
+ ('bold', '1;'),]
+
+ colorcodes = {'default': 0, 'normal': 0,
+ 'black': 30,
+ 'red': 31,
+ 'green': 32,
+ 'brown': 33, 'yellow': 33,
+ 'blue': 34,
+ 'magenta': 35,
+ 'cyan': 36,
+ 'grey': 37, 'gray': 37, 'white': 37}
+
+ slow_test_threshold = 10.0 # seconds
+
+ def color_code(self, color):
+ """Convert a color description (e.g. 'lightgray') to a terminal code."""
+ prefix_code = ''
+ for prefix, code in self.prefixes:
+ if color.startswith(prefix):
+ color = color[len(prefix):]
+ prefix_code = code
+ break
+ color_code = self.colorcodes[color]
+ return '\033[%s%sm' % (prefix_code, color_code)
+
+ def color(self, what):
+ """Pick a named color from the color scheme"""
+ return self.color_code(self.colorscheme[what])
+
+ def colorize(self, what, message, normal='normal'):
+ """Wrap message in color."""
+ return self.color(what) + message + self.color(normal)
+
+ def error_count_color(self, n):
+ """Choose a color for the number of errors."""
+ if n:
+ return self.color('error-number')
+ else:
+ return self.color('ok-number')
+
+ def info(self, message):
+ """Print an informative message."""
+ print self.colorize('info', message)
+
+ def info_suboptimal(self, message):
+ """Print an informative message about losing some of the features.
+
+ For example, when you run some tests in a subprocess, you lose the
+ ability to use the debugger.
+ """
+ print self.colorize('suboptimal-behaviour', message)
+
+ def error(self, message):
+ """Report an error."""
+ print self.colorize('error', message)
+
+ def error_with_banner(self, message):
+ """Report an error with a big ASCII banner."""
+ print
+ print self.colorize('error', '*'*70)
+ self.error(message)
+ print self.colorize('error', '*'*70)
+ print
+
+ def tear_down_not_supported(self):
+ """Report that we could not tear down a layer.
+
+ Should be called right after start_tear_down().
+ """
+ print "...", self.colorize('suboptimal-behaviour', "not supported")
+
+ def format_seconds(self, n_seconds, normal='normal'):
+ """Format a time in seconds."""
+ if n_seconds >= 60:
+ n_minutes, n_seconds = divmod(n_seconds, 60)
+ return "%s minutes %s seconds" % (
+ self.colorize('number', '%d' % n_minutes, normal),
+ self.colorize('number', '%.3f' % n_seconds, normal))
+ else:
+ return "%s seconds" % (
+ self.colorize('number', '%.3f' % n_seconds, normal))
+
+ def format_seconds_short(self, n_seconds):
+ """Format a time in seconds (short version)."""
+ if n_seconds >= self.slow_test_threshold:
+ color = 'slow-test'
+ else:
+ color = 'number'
+ return self.colorize(color, "%.3f s" % n_seconds)
+
+ def summary(self, n_tests, n_failures, n_errors, n_seconds):
+ """Summarize the results."""
+ sys.stdout.writelines([
+ self.color('info'), ' Ran ',
+ self.color('number'), str(n_tests),
+ self.color('info'), ' tests with ',
+ self.error_count_color(n_failures), str(n_failures),
+ self.color('info'), ' failures and ',
+ self.error_count_color(n_errors), str(n_errors),
+ self.color('info'), ' errors in ',
+ self.format_seconds(n_seconds, 'info'), '.',
+ self.color('normal'), '\n'])
+
+ def totals(self, n_tests, n_failures, n_errors, n_seconds):
+ """Report totals (number of tests, failures, and errors)."""
+ sys.stdout.writelines([
+ self.color('info'), 'Total: ',
+ self.color('number'), str(n_tests),
+ self.color('info'), ' tests, ',
+ self.error_count_color(n_failures), str(n_failures),
+ self.color('info'), ' failures, ',
+ self.error_count_color(n_errors), str(n_errors),
+ self.color('info'), ' errors in ',
+ self.format_seconds(n_seconds, 'info'), '.',
+ self.color('normal'), '\n'])
+
+ def print_traceback(self, msg, exc_info):
+ """Report an error with a traceback."""
+ print
+ print self.colorize('error', msg)
+ v = exc_info[1]
+ if isinstance(v, DocTestFailureException):
+ self.print_doctest_failure(v.args[0])
+ elif isinstance(v, doctest.DocTestFailure):
+ # I don't think these are ever used... -- mgedmin
+ tb = self.format_traceback(exc_info)
+ print tb
+ else:
+ tb = self.format_traceback(exc_info)
+ self.print_colorized_traceback(tb)
+
+ def print_doctest_failure(self, formatted_failure):
+ """Report a doctest failure.
+
+ ``formatted_failure`` is a string -- that's what
+ DocTestSuite/DocFileSuite gives us.
+ """
+ color_of_indented_text = 'normal'
+ colorize_diff = False
+ for line in formatted_failure.splitlines():
+ if line.startswith('File '):
+ m = re.match(r'File "(.*)", line (\d*), in (.*)$', line)
+ if m:
+ filename, lineno, test = m.groups()
+ sys.stdout.writelines([
+ self.color('normal'), 'File "',
+ self.color('filename'), filename,
+ self.color('normal'), '", line ',
+ self.color('lineno'), lineno,
+ self.color('normal'), ', in ',
+ self.color('testname'), test,
+ self.color('normal'), '\n'])
+ else:
+ print line
+ elif line.startswith(' ') or line.strip() == '':
+ if colorize_diff and len(line) > 4:
+ color = self.diff_color.get(line[4], color_of_indented_text)
+ print self.colorize(color, line)
+ else:
+ if line.strip() != '':
+ print self.colorize(color_of_indented_text, line)
+ else:
+ print line
+ else:
+ colorize_diff = False
+ if line.startswith('Failed example'):
+ color_of_indented_text = 'failed-example'
+ elif line.startswith('Expected:'):
+ color_of_indented_text = 'expected-output'
+ elif line.startswith('Got:'):
+ color_of_indented_text = 'actual-output'
+ elif line.startswith('Exception raised:'):
+ color_of_indented_text = 'exception'
+ elif line.startswith('Differences '):
+ color_of_indented_text = 'normal'
+ colorize_diff = True
+ else:
+ color_of_indented_text = 'normal'
+ print line
+ print
+
+ def print_colorized_traceback(self, formatted_traceback):
+ """Report a test failure.
+
+ ``formatted_traceback`` is a string.
+ """
+ for line in formatted_traceback.splitlines():
+ if line.startswith(' File'):
+ m = re.match(r' File "(.*)", line (\d*), in (.*)$', line)
+ if m:
+ filename, lineno, test = m.groups()
+ sys.stdout.writelines([
+ self.color('normal'), ' File "',
+ self.color('filename'), filename,
+ self.color('normal'), '", line ',
+ self.color('lineno'), lineno,
+ self.color('normal'), ', in ',
+ self.color('testname'), test,
+ self.color('normal'), '\n'])
+ else:
+ print line
+ elif line.startswith(' '):
+ print self.colorize('failed-example', line)
+ elif line.startswith('Traceback (most recent call last)'):
+ print line
+ else:
+ print self.colorize('exception', line)
+ print
+
+
+class FakeTest(object):
+ """A fake test object that only has an id."""
+
+ failureException = None
+
+ def __init__(self, test_id):
+ self._id = test_id
+
+ def id(self):
+ return self._id
+
+
+# Conditional imports, we don't want zope.testing to have a hard dependency on
+# subunit.
+try:
+ import subunit
+ from subunit.iso8601 import Utc
+except ImportError:
+ subunit = None
+
+
+# testtools is a hard dependency of subunit itself, guarding separately for
+# richer error messages.
+try:
+ from testtools import content
+except ImportError:
+ content = None
+
+
+class SubunitOutputFormatter(object):
+ """A subunit output formatter.
+
+ This output formatter generates subunit compatible output (see
+ https://launchpad.net/subunit). Subunit output is essentially a stream of
+ results of unit tests. In this formatter, non-test events (such as layer
+ set up) are encoded as specially tagged tests and summary-generating
+ methods (such as modules_with_import_problems) deliberately do nothing.
+
+ In particular, for a layer 'foo', the fake tests related to layer set up
+ and tear down are tagged with 'zope:layer' and are called 'foo:setUp' and
+ 'foo:tearDown'. Any tests within layer 'foo' are tagged with
+ 'zope:layer:foo'.
+
+ Note that all tags specific to this formatter begin with 'zope:'
+ """
+
+ # subunit output is designed for computers, so displaying a progress bar
+ # isn't helpful.
+ progress = False
+ verbose = property(lambda self: self.options.verbose)
+
+ TAG_INFO_SUBOPTIMAL = 'zope:info_suboptimal'
+ TAG_ERROR_WITH_BANNER = 'zope:error_with_banner'
+ TAG_LAYER = 'zope:layer'
+ TAG_IMPORT_ERROR = 'zope:import_error'
+ TAG_PROFILER_STATS = 'zope:profiler_stats'
+ TAG_GARBAGE = 'zope:garbage'
+ TAG_THREADS = 'zope:threads'
+ TAG_REFCOUNTS = 'zope:refcounts'
+
+ def __init__(self, options, stream=None):
+ if subunit is None:
+ raise Exception("Requires subunit 0.0.5 or better")
+ if content is None:
+ raise Exception("Requires testtools 0.9.2 or better")
+ self.options = options
+
+ if stream is None:
+ stream = sys.stdout
+ self._stream = stream
+ self._subunit = subunit.TestProtocolClient(self._stream)
+
+ # Used to track the last layer that was set up or torn down. Either
+ # None or (layer_name, last_touched_time).
+ self._last_layer = None
+ self.UTC = Utc()
+ # Content types used in the output.
+ self.TRACEBACK_CONTENT_TYPE = content.ContentType(
+ 'text', 'x-traceback', dict(language='python', charset='utf8'))
+ self.PROFILE_CONTENT_TYPE = content.ContentType(
+ 'application', 'x-binary-profile')
+ self.PLAIN_TEXT = content.ContentType(
+ 'text', 'plain', {'charset': 'utf8'})
+
+ @property
+ def _time_tests(self):
+ return self.verbose > 2
+
+ def _emit_timestamp(self, now=None):
+ """Emit a timestamp to the subunit stream.
+
+ If 'now' is not specified, use the current time on the system clock.
+ """
+ if now is None:
+ now = datetime.now(self.UTC)
+ self._subunit.time(now)
+ return now
+
+ def _emit_tag(self, tag):
+ self._stream.write('tags: %s\n' % (tag,))
+
+ def _stop_tag(self, tag):
+ self._stream.write('tags: -%s\n' % (tag,))
+
+ def _emit_fake_test(self, message, tag, details=None):
+ """Emit a successful fake test to the subunit stream.
+
+ Use this to print tagged informative messages.
+ """
+ test = FakeTest(message)
+ self._subunit.startTest(test)
+ self._emit_tag(tag)
+ self._subunit.addSuccess(test, details=details)
+
+ def _emit_error(self, error_id, tag, exc_info):
+ """Emit an error to the subunit stream.
+
+ Use this to pass on information about errors that occur outside of
+ tests.
+ """
+ test = FakeTest(error_id)
+ self._subunit.startTest(test)
+ self._emit_tag(tag)
+ self._subunit.addError(test, exc_info)
+
+ def _emit_failure(self, failure_id, tag, exc_info):
+ """Emit an failure to the subunit stream.
+
+ Use this to pass on information about failures that occur outside of
+ tests.
+ """
+ test = FakeTest(failure_id)
+ self._subunit.addFailure(test, exc_info)
+
+ def info(self, message):
+ """Print an informative message, but only if verbose."""
+ # info() output is not relevant to actual test results. It only says
+ # things like "Running tests" or "Tearing down left over layers",
+ # things that are communicated already by the subunit stream. Just
+ # suppress the info() output.
+ pass
+
+ def info_suboptimal(self, message):
+ """Print an informative message about losing some of the features.
+
+ For example, when you run some tests in a subprocess, you lose the
+ ability to use the debugger.
+ """
+ # Used _only_ to indicate running in a subprocess.
+ self._emit_fake_test(message.strip(), self.TAG_INFO_SUBOPTIMAL)
+
+ def error(self, message):
+ """Report an error."""
+ # XXX: Mostly used for user errors, sometimes used for errors in the
+ # test framework, sometimes used to record layer setUp failure (!!!).
+ self._stream.write('%s\n' % (message,))
+
+ def error_with_banner(self, message):
+ """Report an error with a big ASCII banner."""
+ # Either "Could not communicate with subprocess"
+ # Or "Can't post-mortem debug when running a layer as a subprocess!"
+ self._emit_fake_test(message, self.TAG_ERROR_WITH_BANNER)
+
+ def _enter_layer(self, layer_name):
+ """Signal in the subunit stream that we are entering a layer."""
+ self._emit_tag('zope:layer:%s' % (layer_name,))
+
+ def _exit_layer(self, layer_name):
+ """Signal in the subunit stream that we are leaving a layer."""
+ self._stop_tag('zope:layer:%s' % (layer_name,))
+
+ def start_set_up(self, layer_name):
+ """Report that we're setting up a layer.
+
+ We do this by emitting a tag of the form 'layer:$LAYER_NAME'.
+ """
+ now = self._emit_timestamp()
+ self._subunit.startTest(FakeTest('%s:setUp' % (layer_name,)))
+ self._emit_tag(self.TAG_LAYER)
+ self._last_layer = (layer_name, now)
+
+ def stop_set_up(self, seconds):
+ layer_name, start_time = self._last_layer
+ self._last_layer = None
+ self._emit_timestamp(start_time + timedelta(seconds=seconds))
+ self._subunit.addSuccess(FakeTest('%s:setUp' % (layer_name,)))
+ self._enter_layer(layer_name)
+
+ def layer_failure(self, failure_type, exc_info):
+ layer_name, start_time = self._last_layer
+ self._emit_failure(
+ '%s:%s' % (layer_name, failure_type), self.TAG_LAYER, exc_info)
+
+ def start_tear_down(self, layer_name):
+ """Report that we're tearing down a layer.
+
+ We do this by removing a tag of the form 'layer:$LAYER_NAME'.
+ """
+ self._exit_layer(layer_name)
+ now = self._emit_timestamp()
+ self._subunit.startTest(FakeTest('%s:tearDown' % (layer_name,)))
+ self._emit_tag(self.TAG_LAYER)
+ self._last_layer = (layer_name, now)
+
+ def stop_tear_down(self, seconds):
+ layer_name, start_time = self._last_layer
+ self._last_layer = None
+ self._emit_timestamp(start_time + timedelta(seconds=seconds))
+ self._subunit.addSuccess(FakeTest('%s:tearDown' % (layer_name,)))
+
+ def tear_down_not_supported(self):
+ """Report that we could not tear down a layer.
+
+ Should be called right after start_tear_down().
+ """
+ layer_name, start_time = self._last_layer
+ self._last_layer = None
+ self._emit_timestamp(datetime.now(self.UTC))
+ self._subunit.addSkip(
+ FakeTest('%s:tearDown' % (layer_name,)), "tearDown not supported")
+
+ def summary(self, n_tests, n_failures, n_errors, n_seconds):
+ """Print out a summary.
+
+ Since subunit is a stream protocol format, it has no need for a
+ summary. When the stream is finished other tools can generate a
+ summary if so desired.
+ """
+ pass
+
+ def start_test(self, test, tests_run, total_tests):
+ """Report that we're about to run a test.
+
+ The next output operation should be test_success(), test_error(), or
+ test_failure().
+ """
+ if self._time_tests:
+ self._emit_timestamp()
+ # Note that this always emits newlines, so it will function as well as
+ # other start_test implementations if we are running in a subprocess.
+ self._subunit.startTest(test)
+
+ def stop_test(self, test):
+ """Clean up the output state after a test."""
+ self._subunit.stopTest(test)
+ self._stream.flush()
+
+ def stop_tests(self):
+ """Clean up the output state after a collection of tests."""
+ self._stream.flush()
+
+ def test_success(self, test, seconds):
+ if self._time_tests:
+ self._emit_timestamp()
+ self._subunit.addSuccess(test)
+
+ def import_errors(self, import_errors):
+ """Report test-module import errors (if any)."""
+ if not import_errors:
+ return
+ for error in import_errors:
+ self._emit_error(
+ error.module, self.TAG_IMPORT_ERROR, error.exc_info)
+
+ def modules_with_import_problems(self, import_errors):
+ """Report names of modules with import problems (if any)."""
+ # This is simply a summary method, and subunit output doesn't benefit
+ # from summaries.
+ pass
+
+ def _exc_info_to_details(self, exc_info):
+ """Translate 'exc_info' into a details dictionary usable with subunit.
+ """
+ # In an ideal world, we'd use the pre-bundled 'TracebackContent' class
+ # from testtools. However, 'OutputFormatter' contains special logic to
+ # handle errors from doctests, so we have to use that and manually
+ # create an object equivalent to an instance of 'TracebackContent'.
+ formatter = OutputFormatter(None)
+ traceback = formatter.format_traceback(exc_info)
+
+ # We have no idea if the traceback is a unicode object or a bytestring
+ # with non-ASCII characters. We had best be careful when handling it.
+ if isinstance(traceback, unicode):
+ unicode_tb = traceback
+ else:
+ # Assume the traceback was utf-8 encoded, but still be careful.
+ unicode_tb = traceback.decode('utf8', 'replace')
+
+ return {
+ 'traceback': content.Content(
+ self.TRACEBACK_CONTENT_TYPE, lambda: [unicode_tb.encode('utf8')])}
+
+ def test_error(self, test, seconds, exc_info):
+ """Report that an error occurred while running a test.
+
+ Should be called right after start_test().
+
+ The next output operation should be stop_test().
+ """
+ if self._time_tests:
+ self._emit_timestamp()
+ details = self._exc_info_to_details(exc_info)
+ self._subunit.addError(test, details=details)
+
+ def test_failure(self, test, seconds, exc_info):
+ """Report that a test failed.
+
+ Should be called right after start_test().
+
+ The next output operation should be stop_test().
+ """
+ if self._time_tests:
+ self._emit_timestamp()
+ details = self._exc_info_to_details(exc_info)
+ self._subunit.addFailure(test, details=details)
+
+ def profiler_stats(self, stats):
+ """Report profiler stats."""
+ fd, filename = tempfile.mkstemp()
+ os.close(fd)
+ try:
+ stats.dump_stats(filename)
+ stats_dump = open(filename)
+ try:
+ profile_content = content.Content(
+ self.PROFILE_CONTENT_TYPE, stats_dump.read)
+ details = {'profiler-stats': profile_content}
+ # Name the test 'zope:profiler_stats' just like its tag.
+ self._emit_fake_test(
+ self.TAG_PROFILER_STATS, self.TAG_PROFILER_STATS, details)
+ finally:
+ stats_dump.close()
+ finally:
+ os.unlink(filename)
+
+ def tests_with_errors(self, errors):
+ """Report tests with errors.
+
+ Simply not supported by the subunit formatter. Fancy summary output
+ doesn't make sense.
+ """
+ pass
+
+ def tests_with_failures(self, failures):
+ """Report tests with failures.
+
+ Simply not supported by the subunit formatter. Fancy summary output
+ doesn't make sense.
+ """
+ pass
+
+ def totals(self, n_tests, n_failures, n_errors, n_seconds):
+ """Summarize the results of all layers.
+
+ Simply not supported by the subunit formatter. Fancy summary output
+ doesn't make sense.
+ """
+ pass
+
+ def list_of_tests(self, tests, layer_name):
+ """Report a list of test names."""
+ for test in tests:
+ print test.id()
+
+ def _get_text_details(self, name, text):
+ """Get a details dictionary that just has some plain text."""
+ return {
+ name: content.Content(
+ self.PLAIN_TEXT, lambda: [text.encode('utf8')])}
+
+ def garbage(self, garbage):
+ """Report garbage generated by tests."""
+ # XXX: Really, 'garbage', 'profiler_stats' and the 'refcounts' twins
+ # ought to add extra details to a fake test that represents the
+ # summary information for the whole suite. However, there's no event
+ # on output formatters for "everything is really finished, honest". --
+ # jml, 2010-02-14
+ details = self._get_text_details('garbage', unicode(garbage))
+ self._emit_fake_test(
+ self.TAG_GARBAGE, self.TAG_GARBAGE, details)
+
+ def test_garbage(self, test, garbage):
+ """Report garbage generated by a test.
+
+ Encoded in the subunit stream as a test error. Clients can filter out
+ these tests based on the tag if they don't think garbage should fail
+ the test run.
+ """
+ # XXX: Perhaps 'test_garbage' and 'test_threads' ought to be within
+ # the output for the actual test, appended as details to whatever
+ # result the test gets. Not an option with the present API, as there's
+ # no event for "no more output for this test". -- jml, 2010-02-14
+ self._subunit.startTest(test)
+ self._emit_tag(self.TAG_GARBAGE)
+ self._subunit.addError(
+ test, details=self._get_text_details('garbage', unicode(garbage)))
+
+ def test_threads(self, test, new_threads):
+ """Report threads left behind by a test.
+
+ Encoded in the subunit stream as a test error. Clients can filter out
+ these tests based on the tag if they don't think left-over threads
+ should fail the test run.
+ """
+ self._subunit.startTest(test)
+ self._emit_tag(self.TAG_THREADS)
+ # This is a skip because otherwise windmill errors make things break
+ # and its normal for threads to not complete exactly on test
+ # boundaries. We check for this in the LP testrunner baselayer anyway.
+ self._subunit.addSkip(
+ test, details=self._get_text_details('threads', unicode(new_threads)))
+
+ def refcounts(self, rc, prev):
+ """Report a change in reference counts."""
+ details = self._get_text_details('sys-refcounts', str(rc))
+ details.update(
+ self._get_text_details('changes', str(rc - prev)))
+ # XXX: Emit the details dict as JSON?
+ self._emit_fake_test(
+ self.TAG_REFCOUNTS, self.TAG_REFCOUNTS, details)
+
+ def detailed_refcounts(self, track, rc, prev):
+ """Report a change in reference counts, with extra detail."""
+ details = self._get_text_details('sys-refcounts', str(rc))
+ details.update(
+ self._get_text_details('changes', str(rc - prev)))
+ details.update(
+ self._get_text_details('track', str(track.delta)))
+
+ self._emit_fake_test(
+ self.TAG_REFCOUNTS, self.TAG_REFCOUNTS, details)
=== added file 'src/zope/testing/testrunner/garbagecollection.py'
--- src/zope/testing/testrunner/garbagecollection.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/garbagecollection.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,75 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Garbage collection support.
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import gc
+import sys
+import zope.testing.testrunner.feature
+
+
+class Threshold(zope.testing.testrunner.feature.Feature):
+
+ def __init__(self, runner):
+ super(Threshold, self).__init__(runner)
+ self.threshold = self.runner.options.gc
+ self.active = bool(self.threshold)
+
+ if not self.active:
+ return
+
+ if len(self.threshold) > 3:
+ self.runner.options.output.error("Too many --gc options")
+ sys.exit(1)
+
+ def global_setup(self):
+ self.old_threshold = gc.get_threshold()
+
+ if self.threshold[0]:
+ self.runner.options.output.info(
+ "Cyclic garbage collection threshold set to: %s" %
+ repr(tuple(self.threshold)))
+ else:
+ self.runner.options.output.info(
+ "Cyclic garbage collection is disabled.")
+
+ gc.set_threshold(*self.threshold)
+
+ def global_teardown(self):
+ gc.set_threshold(*self.old_threshold)
+
+
+class Debug(zope.testing.testrunner.feature.Feature):
+ """Manages garbage collection debug flags."""
+
+ def __init__(self, runner):
+ super(Debug, self).__init__(runner)
+ self.flags = self.runner.options.gc_option
+ self.active = bool(self.flags)
+
+ if not self.active:
+ return
+
+ def global_setup(self):
+ # Set garbage collection debug flags
+ self.old_flags = gc.get_debug()
+ new_flags = 0
+ for op in self.flags:
+ new_flags |= getattr(gc, op)
+ gc.set_debug(new_flags)
+
+ def global_teardown(self):
+ gc.set_debug(self.old_flags)
=== added file 'src/zope/testing/testrunner/interfaces.py'
--- src/zope/testing/testrunner/interfaces.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/interfaces.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,104 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Test runner interfaces
+
+XXX Note: These interfaces are still being sketched out. Please do not rely on
+them, yet.
+
+$Id: __init__.py 86232 2008-05-03 15:09:33Z ctheune $
+
+"""
+
+import zope.interface
+
+
+class EndRun(Exception):
+ """Indicate that the existing run call should stop
+
+ Used to prevent additional test output after post-mortem debugging.
+
+ """
+
+
+class IFeature(zope.interface.Interface):
+ """Features extend the test runners functionality in a pipe-lined
+ order.
+ """
+
+ active = zope.interface.Attribute(
+ "Flag whether this feature is activated. If it is not activated than "
+ "its methods won't be called by the runner.")
+
+ def global_setup():
+ """Executed once when the test runner is being set up."""
+
+ def late_setup():
+ """Executed once right before the actual tests get executed and after
+ all global setups have happened.
+
+ Should do as little work as possible to avoid timing interferences
+ with other features.
+
+ It is guaranteed that the calling stack frame is not left until
+ early_teardown was called.
+
+ """
+
+ def layer_setup(layer):
+ """Executed once after a layer was set up."""
+
+ def layer_teardown(layer):
+ """Executed once after a layer was run."""
+
+ def test_setup(test):
+ """Executed once before each test."""
+
+ def test_teardown(test):
+ """Executed once after each test."""
+
+ def early_teardown():
+ """Executed once directly after all tests.
+
+ This method should do as little as possible to avoid timing issues.
+
+ It is guaranteed to be called directly from the same stack frame that
+ called `late_setup`.
+
+ """
+
+ def global_teardown():
+ """Executed once after all tests where run and early teardowns have
+ happened.
+
+ """
+
+ def report():
+ """Executed once after all tests have been run and all setup was
+ torn down.
+
+ This is the only method that should produce output.
+
+ """
+
+
+class ITestRunner(zope.interface.Interface):
+ """The test runner manages test layers and their execution.
+
+ The functionality of a test runner can be extended by configuring
+ features.
+
+ """
+
+ options = zope.interface.Attribute(
+ "Provides access to configuration options.")
=== added file 'src/zope/testing/testrunner/layer.py'
--- src/zope/testing/testrunner/layer.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/layer.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,21 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Layer definitions
+
+$Id: __init__.py 86223 2008-05-03 14:36:04Z ctheune $
+"""
+
+
+class UnitTests(object):
+ """A layer for gathering all unit tests."""
=== added file 'src/zope/testing/testrunner/listing.py'
--- src/zope/testing/testrunner/listing.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/listing.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,35 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Filter which tests to run.
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import zope.testing.testrunner.feature
+
+
+class Listing(zope.testing.testrunner.feature.Feature):
+ """Lists all tests in the report instead of running the tests."""
+
+ def __init__(self, runner):
+ super(Listing, self).__init__(runner)
+ self.active = bool(runner.options.list_tests)
+
+ def global_setup(self):
+ self.runner.do_run_tests = False
+ self.runner.failed = False
+
+ def report(self):
+ for layer_name, layer, tests in self.runner.ordered_layers():
+ self.runner.options.output.list_of_tests(tests, layer_name)
=== added file 'src/zope/testing/testrunner/logsupport.py'
--- src/zope/testing/testrunner/logsupport.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/logsupport.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,64 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Logging support.
+
+This code is pretty much untested and was only mechanically refactored.
+
+The module name is not 'logging' because of a name collision with Python's
+logging module.
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import logging
+import logging.config
+import os.path
+
+import zope.testing.testrunner.feature
+
+
+class Logging(zope.testing.testrunner.feature.Feature):
+
+ active = True
+
+ def global_setup(self):
+ # Get the log.ini file from the current directory instead of
+ # possibly buried in the build directory. TODO: This isn't
+ # perfect because if log.ini specifies a log file, it'll be
+ # relative to the build directory. Hmm... logini =
+ # os.path.abspath("log.ini")
+
+ logini = os.path.abspath("log.ini")
+ if os.path.exists(logini):
+ logging.config.fileConfig(logini)
+ else:
+ # If there's no log.ini, cause the logging package to be
+ # silent during testing.
+ root = logging.getLogger()
+ root.addHandler(NullHandler())
+ logging.basicConfig()
+
+ if os.environ.has_key("LOGGING"):
+ level = int(os.environ["LOGGING"])
+ logging.getLogger().setLevel(level)
+
+
+class NullHandler(logging.Handler):
+ """Logging handler that drops everything on the floor.
+
+ We require silence in the test environment. Hush.
+ """
+
+ def emit(self, record):
+ pass
=== added file 'src/zope/testing/testrunner/options.py'
--- src/zope/testing/testrunner/options.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/options.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,710 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Command-line option parsing
+
+$Id: __init__.py 86231 2008-05-03 15:03:27Z ctheune $
+"""
+
+import optparse
+import re
+import os
+import sys
+
+import pkg_resources
+
+from zope.testing.testrunner.profiling import available_profilers
+from zope.testing.testrunner.formatter import (
+ OutputFormatter,
+ ColorfulOutputFormatter,
+ SubunitOutputFormatter,
+ )
+from zope.testing.testrunner.formatter import terminal_has_colors
+
+
+parser = optparse.OptionParser("Usage: %prog [options] [MODULE] [TEST]")
+
+######################################################################
+# Searching and filtering
+
+searching = optparse.OptionGroup(parser, "Searching and filtering", """\
+Options in this group are used to define which tests to run.
+""")
+
+searching.add_option(
+ '--package', '--dir', '-s', action="append", dest='package',
+ help="""\
+Search the given package's directories for tests. This can be
+specified more than once to run tests in multiple parts of the source
+tree. For example, if refactoring interfaces, you don't want to see
+the way you have broken setups for tests in other packages. You *just*
+want to run the interface tests.
+
+Packages are supplied as dotted names. For compatibility with the old
+test runner, forward and backward slashed in package names are
+converted to dots.
+
+(In the special case of packages spread over multiple directories,
+only directories within the test search path are searched. See the
+--path option.)
+
+""")
+
+searching.add_option(
+ '--module', '-m', action="append", dest='module',
+ help="""\
+Specify a test-module filter as a regular expression. This is a
+case-sensitive regular expression, used in search (not match) mode, to
+limit which test modules are searched for tests. The regular
+expressions are checked against dotted module names. In an extension
+of Python regexp notation, a leading "!" is stripped and causes the
+sense of the remaining regexp to be negated (so "!bc" matches any
+string that does not match "bc", and vice versa). The option can be
+specified multiple test-module filters. Test modules matching any of
+the test filters are searched. If no test-module filter is specified,
+then all test modules are used.
+""")
+
+searching.add_option(
+ '--test', '-t', action="append", dest='test',
+ help="""\
+Specify a test filter as a regular expression. This is a
+case-sensitive regular expression, used in search (not match) mode, to
+limit which tests are run. In an extension of Python regexp notation,
+a leading "!" is stripped and causes the sense of the remaining regexp
+to be negated (so "!bc" matches any string that does not match "bc",
+and vice versa). The option can be specified multiple test filters.
+Tests matching any of the test filters are included. If no test
+filter is specified, then all tests are run.
+""")
+
+searching.add_option(
+ '--unit', '-u', action="store_true", dest='unit',
+ help="""\
+Run only unit tests, ignoring any layer options.
+""")
+
+searching.add_option(
+ '--non-unit', '-f', action="store_true", dest='non_unit',
+ help="""\
+Run tests other than unit tests.
+""")
+
+searching.add_option(
+ '--layer', action="append", dest='layer',
+ help="""\
+Specify a test layer to run. The option can be given multiple times
+to specify more than one layer. If not specified, all layers are run.
+It is common for the running script to provide default values for this
+option. Layers are specified regular expressions, used in search
+mode, for dotted names of objects that define a layer. In an
+extension of Python regexp notation, a leading "!" is stripped and
+causes the sense of the remaining regexp to be negated (so "!bc"
+matches any string that does not match "bc", and vice versa). The
+layer named 'zope.testing.testrunner.layer.UnitTests' is reserved for
+unit tests, however, take note of the --unit and non-unit options.
+""")
+
+searching.add_option(
+ '-a', '--at-level', type='int', dest='at_level',
+ help="""\
+Run the tests at the given level. Any test at a level at or below
+this is run, any test at a level above this is not run. Level 0
+runs all tests.
+""")
+
+searching.add_option(
+ '--all', action="store_true", dest='all',
+ help="Run tests at all levels.")
+
+searching.add_option(
+ '--list-tests', action="store_true", dest='list_tests',
+ help="List all tests that matched your filters. Do not run any tests.")
+
+parser.add_option_group(searching)
+
+######################################################################
+# Reporting
+
+reporting = optparse.OptionGroup(parser, "Reporting", """\
+Reporting options control basic aspects of test-runner output
+""")
+
+reporting.add_option(
+ '--verbose', '-v', action="count", dest='verbose',
+ help="""\
+Make output more verbose.
+Increment the verbosity level.
+""")
+
+reporting.add_option(
+ '--quiet', '-q', action="store_true", dest='quiet',
+ help="""\
+Make the output minimal, overriding any verbosity options.
+""")
+
+reporting.add_option(
+ '--progress', '-p', action="store_true", dest='progress',
+ help="""\
+Output progress status
+""")
+
+reporting.add_option(
+ '--no-progress',action="store_false", dest='progress',
+ help="""\
+Do not output progress status. This is the default, but can be used to
+counter a previous use of --progress or -p.
+""")
+
+# We use a noop callback because the actual processing will be done in the
+# get_options function, but we want optparse to generate appropriate help info
+# for us, so we add an option anyway.
+reporting.add_option(
+ '--auto-progress', action="callback", callback=lambda *args: None,
+ help="""\
+Output progress status, but only when stdout is a terminal.
+""")
+
+reporting.add_option(
+ '--color', '-c', action="store_true", dest='color',
+ help="""\
+Colorize the output.
+""")
+
+reporting.add_option(
+ '--no-color', '-C', action="store_false", dest='color',
+ help="""\
+Do not colorize the output. This is the default, but can be used to
+counter a previous use of --color or -c.
+""")
+
+# We use a noop callback because the actual processing will be done in the
+# get_options function, but we want optparse to generate appropriate help info
+# for us, so we add an option anyway.
+reporting.add_option(
+ '--auto-color', action="callback", callback=lambda *args: None,
+ help="""\
+Colorize the output, but only when stdout is a terminal.
+""")
+
+reporting.add_option(
+ '--subunit', action="store_true", dest='subunit',
+ help="""\
+Use subunit output. Will not be colorized.
+""")
+
+reporting.add_option(
+ '--slow-test', type='float', dest='slow_test_threshold', metavar='N',
+ help="""\
+With -c and -vvv, highlight tests that take longer than N seconds (default:
+%default).
+""")
+
+reporting.add_option(
+ '-1', '--hide-secondary-failures',
+ action="store_true", dest='report_only_first_failure',
+ help="""\
+Report only the first failure in a doctest. (Examples after the
+failure are still executed, in case they do any cleanup.)
+""")
+
+reporting.add_option(
+ '--show-secondary-failures',
+ action="store_false", dest='report_only_first_failure',
+ help="""\
+Report all failures in a doctest. This is the default, but can
+be used to counter a default use of -1 or --hide-secondary-failures.
+""")
+
+reporting.add_option(
+ '--ndiff', action="store_true", dest="ndiff",
+ help="""\
+When there is a doctest failure, show it as a diff using the ndiff.py utility.
+""")
+
+reporting.add_option(
+ '--udiff', action="store_true", dest="udiff",
+ help="""\
+When there is a doctest failure, show it as a unified diff.
+""")
+
+reporting.add_option(
+ '--cdiff', action="store_true", dest="cdiff",
+ help="""\
+When there is a doctest failure, show it as a context diff.
+""")
+
+parser.add_option_group(reporting)
+
+######################################################################
+# Analysis
+
+analysis = optparse.OptionGroup(parser, "Analysis", """\
+Analysis options provide tools for analysing test output.
+""")
+
+
+analysis.add_option(
+ '--stop-on-error', '--stop', '-x', action="store_true",
+ dest='stop_on_error',
+ help="Stop running tests after first test failure or error."
+ )
+
+analysis.add_option(
+ '--post-mortem', '--pdb', '-D', action="store_true", dest='post_mortem',
+ help="Enable post-mortem debugging of test failures"
+ )
+
+
+analysis.add_option(
+ '--gc', '-g', action="append", dest='gc', type="int",
+ help="""\
+Set the garbage collector generation threshold. This can be used
+to stress memory and gc correctness. Some crashes are only
+reproducible when the threshold is set to 1 (aggressive garbage
+collection). Do "--gc 0" to disable garbage collection altogether.
+
+The --gc option can be used up to 3 times to specify up to 3 of the 3
+Python gc_threshold settings.
+
+""")
+
+analysis.add_option(
+ '--gc-option', '-G', action="append", dest='gc_option', type="choice",
+ choices=['DEBUG_STATS', 'DEBUG_COLLECTABLE', 'DEBUG_UNCOLLECTABLE',
+ 'DEBUG_INSTANCES', 'DEBUG_OBJECTS', 'DEBUG_SAVEALL',
+ 'DEBUG_LEAK'],
+ help="""\
+Set a Python gc-module debug flag. This option can be used more than
+once to set multiple flags.
+""")
+
+analysis.add_option(
+ '--repeat', '-N', action="store", type="int", dest='repeat',
+ help="""\
+Repeat the tests the given number of times. This option is used to
+make sure that tests leave their environment in the state they found
+it and, with the --report-refcounts option to look for memory leaks.
+""")
+
+analysis.add_option(
+ '--report-refcounts', '-r', action="store_true", dest='report_refcounts',
+ help="""\
+After each run of the tests, output a report summarizing changes in
+refcounts by object type. This option that requires that Python was
+built with the --with-pydebug option to configure.
+""")
+
+analysis.add_option(
+ '--coverage', action="store", type='string', dest='coverage',
+ help="""\
+Perform code-coverage analysis, saving trace data to the directory
+with the given name. A code coverage summary is printed to standard
+out.
+""")
+
+analysis.add_option(
+ '--profile', action="store", dest='profile', type="choice",
+ choices=available_profilers.keys(),
+ help="""\
+Run the tests under cProfiler or hotshot and display the top 50 stats, sorted
+by cumulative time and number of calls.
+""")
+
+def do_pychecker(*args):
+ if not os.environ.get("PYCHECKER"):
+ os.environ["PYCHECKER"] = "-q"
+ import pychecker.checker
+
+analysis.add_option(
+ '--pychecker', action="callback", callback=do_pychecker,
+ help="""\
+Run the tests under pychecker
+""")
+
+parser.add_option_group(analysis)
+
+######################################################################
+# Setup
+
+setup = optparse.OptionGroup(parser, "Setup", """\
+Setup options are normally supplied by the testrunner script, although
+they can be overridden by users.
+""")
+
+setup.add_option(
+ '--path', action="append", dest='path',
+ help="""\
+Specify a path to be added to Python's search path. This option can
+be used multiple times to specify multiple search paths. The path is
+usually specified by the test-runner script itself, rather than by
+users of the script, although it can be overridden by users. Only
+tests found in the path will be run.
+
+This option also specifies directories to be searched for tests.
+See the search_directory.
+""")
+
+setup.add_option(
+ '--test-path', action="append", dest='test_path',
+ help="""\
+Specify a path to be searched for tests, but not added to the Python
+search path. This option can be used multiple times to specify
+multiple search paths. The path is usually specified by the
+test-runner script itself, rather than by users of the script,
+although it can be overridden by users. Only tests found in the path
+will be run.
+""")
+
+setup.add_option(
+ '--package-path', action="append", dest='package_path', nargs=2,
+ help="""\
+Specify a path to be searched for tests, but not added to the Python
+search path. Also specify a package for files found in this path.
+This is used to deal with directories that are stitched into packages
+that are not otherwise searched for tests.
+
+This option takes 2 arguments. The first is a path name. The second is
+the package name.
+
+This option can be used multiple times to specify
+multiple search paths. The path is usually specified by the
+test-runner script itself, rather than by users of the script,
+although it can be overridden by users. Only tests found in the path
+will be run.
+""")
+
+setup.add_option(
+ '--tests-pattern', action="store", dest='tests_pattern',
+ help="""\
+The test runner looks for modules containing tests. It uses this
+pattern to identify these modules. The modules may be either packages
+or python files.
+
+If a test module is a package, it uses the value given by the
+test-file-pattern to identify python files within the package
+containing tests.
+""")
+
+setup.add_option(
+ '--suite-name', action="store", dest='suite_name',
+ help="""\
+Specify the name of the object in each test_module that contains the
+module's test suite.
+""")
+
+setup.add_option(
+ '--test-file-pattern', action="store", dest='test_file_pattern',
+ help="""\
+Specify a pattern for identifying python files within a tests package.
+See the documentation for the --tests-pattern option.
+""")
+
+setup.add_option(
+ '--ignore_dir', action="append", dest='ignore_dir',
+ help="""\
+Specifies the name of a directory to ignore when looking for tests.
+""")
+
+setup.add_option(
+ '--shuffle', action="store_true", dest='shuffle',
+ help="""\
+Shuffles the order in which tests are ran.
+""")
+
+setup.add_option(
+ '--shuffle-seed', action="store", dest='shuffle_seed', type="int",
+ help="""\
+Value used to initialize the tests shuffler. Specify a value to create
+repeatable random ordered tests.
+""")
+
+parser.add_option_group(setup)
+
+######################################################################
+# Other
+
+other = optparse.OptionGroup(parser, "Other", "Other options")
+
+other.add_option(
+ '--version', action="store_true", dest='showversion',
+ help="Print the version of the testrunner, and exit.")
+
+other.add_option(
+ '-j', action="store", type="int", dest='processes',
+ help="""\
+Use up to given number of parallel processes to execute tests. May decrease
+test run time substantially. Defaults to %default.
+""")
+
+other.add_option(
+ '--keepbytecode', '-k', action="store_true", dest='keepbytecode',
+ help="""\
+Normally, the test runner scans the test paths and the test
+directories looking for and deleting pyc or pyo files without
+corresponding py files. This is to prevent spurious test failures due
+to finding compiled modules where source modules have been deleted.
+This scan can be time consuming. Using this option disables this
+scan. If you know you haven't removed any modules since last running
+the tests, can make the test run go much faster.
+""")
+
+other.add_option(
+ '--usecompiled', action="store_true", dest='usecompiled',
+ help="""\
+Normally, a package must contain an __init__.py file, and only .py files
+can contain test code. When this option is specified, compiled Python
+files (.pyc and .pyo) can be used instead: a directory containing
+__init__.pyc or __init__.pyo is also considered to be a package, and if
+file XYZ.py contains tests but is absent while XYZ.pyc or XYZ.pyo exists
+then the compiled files will be used. This is necessary when running
+tests against a tree where the .py files have been removed after
+compilation to .pyc/.pyo. Use of this option implies --keepbytecode.
+""")
+
+other.add_option(
+ '--exit-with-status', action="store_true", dest='exitwithstatus',
+ help="""DEPRECATED: The test runner will always exit with a status.\
+""")
+
+
+parser.add_option_group(other)
+
+######################################################################
+# Default values
+
+parser.set_defaults(
+ ignore_dir=['.svn', 'CVS', '{arch}', '.arch-ids', '_darcs'],
+ tests_pattern='^tests$',
+ at_level=1,
+ test_file_pattern='^test',
+ suite_name='test_suite',
+ list_tests=False,
+ slow_test_threshold=10,
+ processes=1,
+ )
+
+
+######################################################################
+# Command-line processing
+
+def compile_filter(pattern):
+ if pattern.startswith('!'):
+ pattern = re.compile(pattern[1:]).search
+ return (lambda s: not pattern(s))
+ return re.compile(pattern).search
+
+def merge_options(options, defaults):
+ odict = options.__dict__
+ for name, value in defaults.__dict__.items():
+ if (value is not None) and (odict[name] is None):
+ odict[name] = value
+
+def get_options(args=None, defaults=None):
+ # Because we want to inspect stdout and decide to colorize or not, we
+ # replace the --auto-color option with the appropriate --color or
+ # --no-color option. That way the subprocess doesn't have to decide (which
+ # it would do incorrectly anyway because stdout would be a pipe).
+ def apply_auto_color(args):
+ if args and '--auto-color' in args:
+ if sys.stdout.isatty() and terminal_has_colors():
+ colorization = '--color'
+ else:
+ colorization = '--no-color'
+
+ args[:] = [arg.replace('--auto-color', colorization)
+ for arg in args]
+
+ # The comment of apply_auto_color applies here as well
+ def apply_auto_progress(args):
+ if args and '--auto-progress' in args:
+ if sys.stdout.isatty():
+ progress = '--progress'
+ else:
+ progress = '--no-progress'
+
+ args[:] = [arg.replace('--auto-progress', progress)
+ for arg in args]
+
+ apply_auto_color(args)
+ apply_auto_color(defaults)
+ apply_auto_progress(args)
+ apply_auto_progress(defaults)
+
+ if defaults:
+ defaults, _ = parser.parse_args(defaults)
+ assert not _
+ else:
+ defaults = None
+
+ if args is None:
+ args = sys.argv
+
+ options, positional = parser.parse_args(args[1:], defaults)
+ options.original_testrunner_args = args
+
+ if options.showversion:
+ dist = pkg_resources.require('zope.testing')[0]
+ print 'zope.app.testrunner version %s' % dist.version
+ options.fail = True
+ return options
+
+ if options.subunit:
+ try:
+ import subunit
+ except ImportError:
+ print """\
+ Subunit is not installed. Please install Subunit
+ to generate subunit output.
+ """
+ options.fail = True
+ return options
+ else:
+ options.output = SubunitOutputFormatter(options)
+ elif options.color:
+ options.output = ColorfulOutputFormatter(options)
+ options.output.slow_test_threshold = options.slow_test_threshold
+ else:
+ options.output = OutputFormatter(options)
+
+ options.fail = False
+
+ if positional:
+ module_filter = positional.pop(0)
+ if module_filter != '.':
+ if options.module:
+ options.module.append(module_filter)
+ else:
+ options.module = [module_filter]
+
+ if positional:
+ test_filter = positional.pop(0)
+ if options.test:
+ options.test.append(test_filter)
+ else:
+ options.test = [test_filter]
+
+ if positional:
+ parser.error("Too many positional arguments")
+
+ options.ignore_dir = dict([(d,1) for d in options.ignore_dir])
+ options.test_file_pattern = re.compile(options.test_file_pattern).search
+ options.tests_pattern = re.compile(options.tests_pattern).search
+ options.test = map(compile_filter, options.test or ('.'))
+ options.module = map(compile_filter, options.module or ('.'))
+
+ options.path = map(os.path.abspath, options.path or ())
+ options.test_path = map(os.path.abspath, options.test_path or ())
+ options.test_path += options.path
+
+ options.test_path = ([(path, '') for path in options.test_path]
+ +
+ [(os.path.abspath(path), package)
+ for (path, package) in options.package_path or ()
+ ])
+
+ if options.package:
+ pkgmap = dict(options.test_path)
+ options.package = [normalize_package(p, pkgmap)
+ for p in options.package]
+
+ options.prefix = [(path + os.path.sep, package)
+ for (path, package) in options.test_path]
+ if options.all:
+ options.at_level = sys.maxint
+
+ if options.unit and options.non_unit:
+ # The test runner interprets this as "run only those tests that are
+ # both unit and non-unit at the same time". The user, however, wants
+ # to run both unit and non-unit tests. Disable the filtering so that
+ # the user will get what she wants:
+ options.unit = options.non_unit = False
+
+ if options.unit:
+ # XXX Argh.
+ options.layer = ['zope.testing.testrunner.layer.UnitTests']
+ if options.layer:
+ options.layer = map(compile_filter, options.layer)
+
+ options.layer = options.layer and dict([(l, 1) for l in options.layer])
+
+ if options.usecompiled:
+ options.keepbytecode = options.usecompiled
+
+ if options.quiet:
+ options.verbose = 0
+
+ if options.report_refcounts and options.repeat < 2:
+ print """\
+ You must use the --repeat (-N) option to specify a repeat
+ count greater than 1 when using the --report_refcounts (-r)
+ option.
+ """
+ options.fail = True
+ return options
+
+
+ if options.report_refcounts and not hasattr(sys, "gettotalrefcount"):
+ print """\
+ The Python you are running was not configured
+ with --with-pydebug. This is required to use
+ the --report-refcounts option.
+ """
+ options.fail = True
+ return options
+
+ return options
+
+def normalize_package(package, package_map={}):
+ r"""Normalize package name passed to the --package option.
+
+ >>> normalize_package('zope.testing')
+ 'zope.testing'
+
+ Converts path names into package names for compatibility with the old
+ test runner.
+
+ >>> normalize_package('zope/testing')
+ 'zope.testing'
+ >>> normalize_package('zope/testing/')
+ 'zope.testing'
+ >>> normalize_package('zope\\testing')
+ 'zope.testing'
+
+ Can use a map of absolute pathnames to package names
+
+ >>> a = os.path.abspath
+ >>> normalize_package('src/zope/testing/',
+ ... {a('src'): ''})
+ 'zope.testing'
+ >>> normalize_package('src/zope_testing/',
+ ... {a('src/zope_testing'): 'zope.testing'})
+ 'zope.testing'
+ >>> normalize_package('src/zope_something/tests',
+ ... {a('src/zope_something'): 'zope.something',
+ ... a('src'): ''})
+ 'zope.something.tests'
+
+ """
+ package = package.replace('\\', '/')
+ if package.endswith('/'):
+ package = package[:-1]
+ bits = package.split('/')
+ for n in range(len(bits), 0, -1):
+ pkg = package_map.get(os.path.abspath('/'.join(bits[:n])))
+ if pkg is not None:
+ bits = bits[n:]
+ if pkg:
+ bits = [pkg] + bits
+ return '.'.join(bits)
+ return package.replace('/', '.')
=== added file 'src/zope/testing/testrunner/process.py'
--- src/zope/testing/testrunner/process.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/process.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,49 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Subprocess support.
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import sys
+import zope.testing.testrunner.feature
+
+
+class SubProcess(zope.testing.testrunner.feature.Feature):
+ """Lists all tests in the report instead of running the tests."""
+
+ def __init__(self, runner):
+ super(SubProcess, self).__init__(runner)
+ self.active = bool(runner.options.resume_layer)
+
+ def global_setup(self):
+ self.original_stderr = sys.stderr
+ sys.stderr = sys.stdout
+ if self.runner.options.processes > 1:
+ # If we only have one subprocess, there's absolutely
+ # no reason to squelch. We will let the messages through in a
+ # timely manner, if they have been requested. On the other hand, if
+ # there are multiple processes, we do squelch to 0.
+ self.runner.options.verbose = 0
+ self.progress = False
+
+ def report(self):
+ sys.stdout.close()
+ # Communicate with the parent. The protocol is obvious:
+ print >> self.original_stderr, self.runner.ran, \
+ len(self.runner.failures), len(self.runner.errors)
+ for test, exc_info in self.runner.failures:
+ print >> self.original_stderr, ' '.join(str(test).strip().split('\n'))
+ for test, exc_info in self.runner.errors:
+ print >> self.original_stderr, ' '.join(str(test).strip().split('\n'))
=== added file 'src/zope/testing/testrunner/profiling.py'
--- src/zope/testing/testrunner/profiling.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/profiling.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,140 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Profiler support for the test runner
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import os
+import glob
+import sys
+import tempfile
+import zope.testing.testrunner.feature
+
+available_profilers = {}
+
+
+try:
+ import cProfile
+ import pstats
+except ImportError:
+ pass
+else:
+ class CProfiler(object):
+ """cProfiler"""
+ def __init__(self, filepath):
+ self.filepath = filepath
+ self.profiler = cProfile.Profile()
+ self.enable = self.profiler.enable
+ self.disable = self.profiler.disable
+
+ def finish(self):
+ self.profiler.dump_stats(self.filepath)
+
+ def loadStats(self, prof_glob):
+ stats = None
+ for file_name in glob.glob(prof_glob):
+ if stats is None:
+ stats = pstats.Stats(file_name)
+ else:
+ stats.add(file_name)
+ return stats
+
+ available_profilers['cProfile'] = CProfiler
+
+
+# some Linux distributions don't include the profiler, which hotshot uses
+if not sys.hexversion >= 0x02060000:
+ # Hotshot is not maintained any longer in 2.6. It does not support
+ # merging to hotshot files. Thus we won't use it in python2.6 and
+ # onwards
+ try:
+ import hotshot
+ import hotshot.stats
+ except ImportError:
+ pass
+ else:
+ class HotshotProfiler(object):
+ """hotshot interface"""
+
+ def __init__(self, filepath):
+ self.profiler = hotshot.Profile(filepath)
+ self.enable = self.profiler.start
+ self.disable = self.profiler.stop
+
+ def finish(self):
+ self.profiler.close()
+
+ def loadStats(self, prof_glob):
+ stats = None
+ for file_name in glob.glob(prof_glob):
+ loaded = hotshot.stats.load(file_name)
+ if stats is None:
+ stats = loaded
+ else:
+ stats.add(loaded)
+ return stats
+
+ available_profilers['hotshot'] = HotshotProfiler
+
+
+class Profiling(zope.testing.testrunner.feature.Feature):
+
+ def __init__(self, runner):
+ super(Profiling, self).__init__(runner)
+
+ if (self.runner.options.profile
+ and sys.version_info[:3] <= (2,4,1)
+ and __debug__):
+ self.runner.options.output.error(
+ 'Because of a bug in Python < 2.4.1, profiling '
+ 'during tests requires the -O option be passed to '
+ 'Python (not the test runner).')
+ sys.exit()
+
+ self.active = bool(self.runner.options.profile)
+ self.profiler = self.runner.options.profile
+
+ def global_setup(self):
+ self.prof_prefix = 'tests_profile.'
+ self.prof_suffix = '.prof'
+ self.prof_glob = self.prof_prefix + '*' + self.prof_suffix
+ # if we are going to be profiling, and this isn't a subprocess,
+ # clean up any stale results files
+ if not self.runner.options.resume_layer:
+ for file_name in glob.glob(self.prof_glob):
+ os.unlink(file_name)
+ # set up the output file
+ self.oshandle, self.file_path = tempfile.mkstemp(self.prof_suffix,
+ self.prof_prefix, '.')
+ self.profiler = available_profilers[self.runner.options.profile](self.file_path)
+
+ # Need to do this rebinding to support the stack-frame annoyance with
+ # hotshot.
+ self.late_setup = self.profiler.enable
+ self.early_teardown = self.profiler.disable
+
+ def global_teardown(self):
+ self.profiler.finish()
+ # We must explicitly close the handle mkstemp returned, else on
+ # Windows this dies the next time around just above due to an
+ # attempt to unlink a still-open file.
+ os.close(self.oshandle)
+ if not self.runner.options.resume_layer:
+ self.profiler_stats = self.profiler.loadStats(self.prof_glob)
+ self.profiler_stats.sort_stats('cumulative', 'calls')
+
+ def report(self):
+ if not self.runner.options.resume_layer:
+ self.runner.options.output.profiler_stats(self.profiler_stats)
=== added file 'src/zope/testing/testrunner/refcount.py'
--- src/zope/testing/testrunner/refcount.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/refcount.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,109 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Support for tracking reference counts.
+
+$Id: __init__.py 86246 2008-05-03 15:54:02Z ctheune $
+"""
+
+import gc
+import sys
+import types
+
+
+class TrackRefs(object):
+ """Object to track reference counts across test runs."""
+
+ def __init__(self):
+ self.type2count = {}
+ self.type2all = {}
+ self.delta = None
+ self.n = 0
+ self.update()
+ self.delta = None
+
+ def update(self):
+ gc.collect()
+ obs = sys.getobjects(0)
+ type2count = {}
+ type2all = {}
+ n = 0
+ for o in obs:
+ if type(o) is str and o == '<dummy key>':
+ # avoid dictionary madness
+ continue
+
+ all = sys.getrefcount(o) - 3
+ n += all
+
+ t = type(o)
+ if t is types.InstanceType:
+ t = o.__class__
+
+ if t in type2count:
+ type2count[t] += 1
+ type2all[t] += all
+ else:
+ type2count[t] = 1
+ type2all[t] = all
+
+
+ ct = [(
+ type_or_class_title(t),
+ type2count[t] - self.type2count.get(t, 0),
+ type2all[t] - self.type2all.get(t, 0),
+ )
+ for t in type2count.iterkeys()]
+ ct += [(
+ type_or_class_title(t),
+ - self.type2count[t],
+ - self.type2all[t],
+ )
+ for t in self.type2count.iterkeys()
+ if t not in type2count]
+ ct.sort()
+ self.delta = ct
+ self.type2count = type2count
+ self.type2all = type2all
+ self.n = n
+
+
+ def output(self):
+ printed = False
+ s1 = s2 = 0
+ for t, delta1, delta2 in self.delta:
+ if delta1 or delta2:
+ if not printed:
+ print (
+ ' Leak details, changes in instances and refcounts'
+ ' by type/class:')
+ print " %-55s %6s %6s" % ('type/class', 'insts', 'refs')
+ print " %-55s %6s %6s" % ('-' * 55, '-----', '----')
+ printed = True
+ print " %-55s %6d %6d" % (t, delta1, delta2)
+ s1 += delta1
+ s2 += delta2
+
+ if printed:
+ print " %-55s %6s %6s" % ('-' * 55, '-----', '----')
+ print " %-55s %6s %6s" % ('total', s1, s2)
+
+
+ self.delta = None
+
+
+def type_or_class_title(t):
+ module = getattr(t, '__module__', '__builtin__')
+ if module == '__builtin__':
+ return t.__name__
+ return "%s.%s" % (module, t.__name__)
=== added file 'src/zope/testing/testrunner/runner.py'
--- src/zope/testing/testrunner/runner.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/runner.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,856 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Test execution
+
+$Id: __init__.py 86232 2008-05-03 15:09:33Z ctheune $
+"""
+
+import subprocess
+
+import cStringIO
+import errno
+import gc
+import Queue
+import re
+import sys
+import threading
+import time
+import traceback
+import unittest
+
+from zope.testing.testrunner.find import import_name
+from zope.testing.testrunner.find import name_from_layer, _layer_name_cache
+from zope.testing.testrunner.refcount import TrackRefs
+from zope.testing.testrunner.options import get_options
+import zope.testing.testrunner.coverage
+import zope.testing.testrunner._doctest
+import zope.testing.testrunner.logsupport
+import zope.testing.testrunner.selftest
+import zope.testing.testrunner.profiling
+import zope.testing.testrunner.filter
+import zope.testing.testrunner.garbagecollection
+import zope.testing.testrunner.listing
+import zope.testing.testrunner.statistics
+import zope.testing.testrunner.process
+import zope.testing.testrunner.interfaces
+import zope.testing.testrunner.debug
+import zope.testing.testrunner.tb_format
+import zope.testing.testrunner.shuffle
+
+
+EXPLOSIVE_ERRORS = (MemoryError, KeyboardInterrupt, SystemExit)
+PYREFCOUNT_PATTERN = re.compile('\[[0-9]+ refs\]')
+
+is_jython = sys.platform.startswith('java')
+
+
+class SubprocessError(Exception):
+ """An error occurred when running a subprocess
+ """
+
+ def __init__(self, reason, stderr):
+ self.reason = reason
+ self.stderr = stderr
+
+ def __str__(self):
+ return '%s: %s' % (self.reason, self.stderr)
+
+
+class CanNotTearDown(Exception):
+ "Couldn't tear down a test"
+
+
+class Runner(object):
+ """The test runner.
+
+ It is the central point of this package and responsible for finding and
+ executing tests as well as configuring itself from the (command-line)
+ options passed into it.
+
+ """
+
+ def __init__(self, defaults=None, args=None, found_suites=None,
+ options=None, script_parts=None):
+ self.defaults = defaults
+ self.args = args
+ self.found_suites = found_suites
+ self.options = options
+ self.script_parts = script_parts
+ self.failed = True
+
+ self.ran = 0
+ self.failures = []
+ self.errors = []
+
+ self.show_report = True
+ self.do_run_tests = True
+
+ self.features = []
+
+ self.tests_by_layer_name = {}
+
+ def ordered_layers(self):
+ layer_names = dict([(layer_from_name(layer_name), layer_name)
+ for layer_name in self.tests_by_layer_name])
+ for layer in order_by_bases(layer_names):
+ layer_name = layer_names[layer]
+ yield layer_name, layer, self.tests_by_layer_name[layer_name]
+
+ def register_tests(self, tests):
+ """Registers tests."""
+ # XXX To support multiple features that find tests this shouldn't be
+ # an update but merge the various layers individually.
+ self.tests_by_layer_name.update(tests)
+
+ def run(self):
+ self.configure()
+ if self.options.fail:
+ return True
+
+ # XXX Hacky to support existing code.
+ self.layer_name_cache = _layer_name_cache
+ self.layer_name_cache.clear()
+
+ # Global setup
+ for feature in self.features:
+ feature.global_setup()
+
+ # Late setup
+ #
+ # Some system tools like profilers are really bad with stack frames.
+ # E.g. hotshot doesn't like it when we leave the stack frame that we
+ # called start() from.
+ for feature in self.features:
+ feature.late_setup()
+
+ try:
+ if self.do_run_tests:
+ self.run_tests()
+ finally:
+ # Early teardown
+ for feature in reversed(self.features):
+ feature.early_teardown()
+ # Global teardown
+ for feature in reversed(self.features):
+ feature.global_teardown()
+
+ if self.show_report:
+ for feature in self.features:
+ feature.report()
+
+ def configure(self):
+ if self.args is None:
+ self.args = sys.argv[:]
+ # Check to see if we are being run as a subprocess. If we are,
+ # then use the resume-layer and defaults passed in.
+ if len(self.args) > 1 and self.args[1] == '--resume-layer':
+ self.args.pop(1)
+ resume_layer = self.args.pop(1)
+ resume_number = int(self.args.pop(1))
+ self.defaults = []
+ while len(self.args) > 1 and self.args[1] == '--default':
+ self.args.pop(1)
+ self.defaults.append(self.args.pop(1))
+
+ sys.stdin = FakeInputContinueGenerator()
+ else:
+ resume_layer = resume_number = None
+
+ options = get_options(self.args, self.defaults)
+
+ options.testrunner_defaults = self.defaults
+ options.resume_layer = resume_layer
+ options.resume_number = resume_number
+
+ self.options = options
+
+ self.features.append(zope.testing.testrunner.selftest.SelfTest(self))
+ self.features.append(zope.testing.testrunner.logsupport.Logging(self))
+ self.features.append(zope.testing.testrunner.coverage.Coverage(self))
+ self.features.append(zope.testing.testrunner._doctest.DocTest(self))
+ self.features.append(zope.testing.testrunner.profiling.Profiling(self))
+ if is_jython:
+ # Jython GC support is not yet implemented
+ pass
+ else:
+ self.features.append(
+ zope.testing.testrunner.garbagecollection.Threshold(self))
+ self.features.append(
+ zope.testing.testrunner.garbagecollection.Debug(self))
+
+ self.features.append(zope.testing.testrunner.find.Find(self))
+ self.features.append(zope.testing.testrunner.shuffle.Shuffle(self))
+ self.features.append(zope.testing.testrunner.process.SubProcess(self))
+ self.features.append(zope.testing.testrunner.filter.Filter(self))
+ self.features.append(zope.testing.testrunner.listing.Listing(self))
+ self.features.append(
+ zope.testing.testrunner.statistics.Statistics(self))
+ self.features.append(zope.testing.testrunner.tb_format.Traceback(self))
+
+ # Remove all features that aren't activated
+ self.features = [f for f in self.features if f.active]
+
+ def run_tests(self):
+ """Run all tests that were registered.
+
+ Returns True if there where failures or False if all tests passed.
+
+ """
+ setup_layers = {}
+ layers_to_run = list(self.ordered_layers())
+ should_resume = False
+
+ while layers_to_run:
+ layer_name, layer, tests = layers_to_run[0]
+ for feature in self.features:
+ feature.layer_setup(layer)
+ try:
+ self.ran += run_layer(self.options, layer_name, layer, tests,
+ setup_layers, self.failures, self.errors)
+ except zope.testing.testrunner.interfaces.EndRun:
+ self.failed = True
+ return
+ except CanNotTearDown:
+ if not self.options.resume_layer:
+ should_resume = True
+ break
+
+ layers_to_run.pop(0)
+ if self.options.processes > 1:
+ should_resume = True
+ break
+
+ if should_resume:
+ setup_layers = None
+ if layers_to_run:
+ self.ran += resume_tests(
+ self.script_parts, self.options, self.features,
+ layers_to_run, self.failures, self.errors)
+
+ if setup_layers:
+ if self.options.resume_layer is None:
+ self.options.output.info("Tearing down left over layers:")
+ try:
+ tear_down_unneeded(self.options, (), setup_layers, True)
+ except EXPLOSIVE_ERRORS:
+ raise
+ except Exception:
+ handle_layer_failure(
+ TearDownLayerFailure(), self.options.output, self.errors)
+
+ self.failed = bool(self.import_errors or self.failures or self.errors)
+
+
+def handle_layer_failure(failure_type, output, errors):
+ if hasattr(output, 'layer_failure'):
+ output.layer_failure(failure_type.subunit_label, sys.exc_info())
+ else:
+ f = cStringIO.StringIO()
+ traceback.print_exc(file=f)
+ output.error(f.getvalue())
+ errors.append((failure_type, sys.exc_info()))
+
+
+def run_tests(options, tests, name, failures, errors):
+ repeat = options.repeat or 1
+ repeat_range = iter(range(repeat))
+ ran = 0
+
+ output = options.output
+
+ if is_jython:
+ # Jython has no GC suppport - set count to 0
+ lgarbage = 0
+ else:
+ gc.collect()
+ lgarbage = len(gc.garbage)
+
+ sumrc = 0
+ if options.report_refcounts:
+ if options.verbose:
+ # XXX This code path is untested
+ track = TrackRefs()
+ rc = sys.gettotalrefcount()
+
+ for iteration in repeat_range:
+ if repeat > 1:
+ output.info("Iteration %d" % (iteration + 1))
+
+ if options.verbose > 0 or options.progress:
+ output.info(' Running:')
+ result = TestResult(options, tests, layer_name=name)
+
+ t = time.time()
+
+ if options.post_mortem:
+ # post-mortem debugging
+ for test in tests:
+ if result.shouldStop:
+ break
+ result.startTest(test)
+ state = test.__dict__.copy()
+ try:
+ try:
+ test.debug()
+ except KeyboardInterrupt:
+ raise
+ except:
+ result.addError(
+ test,
+ sys.exc_info()[:2] + (sys.exc_info()[2].tb_next, ),
+ )
+ else:
+ result.addSuccess(test)
+ finally:
+ result.stopTest(test)
+ test.__dict__.clear()
+ test.__dict__.update(state)
+
+ else:
+ # normal
+ for test in tests:
+ if result.shouldStop:
+ break
+ state = test.__dict__.copy()
+ test(result)
+ test.__dict__.clear()
+ test.__dict__.update(state)
+
+ t = time.time() - t
+ output.stop_tests()
+ failures.extend(result.failures)
+ errors.extend(result.errors)
+ output.summary(result.testsRun, len(result.failures),
+ len(result.errors), t)
+ ran = result.testsRun
+
+ if is_jython:
+ lgarbage = 0
+ else:
+ gc.collect()
+ if len(gc.garbage) > lgarbage:
+ output.garbage(gc.garbage[lgarbage:])
+ lgarbage = len(gc.garbage)
+
+ if options.report_refcounts:
+
+ # If we are being tested, we don't want stdout itself to
+ # foul up the numbers. :)
+ try:
+ sys.stdout.getvalue()
+ except AttributeError:
+ pass
+
+ prev = rc
+ rc = sys.gettotalrefcount()
+ if options.verbose:
+ track.update()
+ if iteration > 0:
+ output.detailed_refcounts(track, rc, prev)
+ else:
+ track.delta = None
+ elif iteration > 0:
+ output.refcounts(rc, prev)
+
+ return ran
+
+
+def run_layer(options, layer_name, layer, tests, setup_layers,
+ failures, errors):
+
+ output = options.output
+ gathered = []
+ gather_layers(layer, gathered)
+ needed = dict([(l, 1) for l in gathered])
+ if options.resume_number != 0:
+ output.info("Running %s tests:" % layer_name)
+ try:
+ tear_down_unneeded(options, needed, setup_layers)
+ except CanNotTearDown:
+ raise
+ except EXPLOSIVE_ERRORS:
+ raise
+ except Exception:
+ handle_layer_failure(TearDownLayerFailure(), output, errors)
+ return 0
+
+ if options.resume_layer is not None:
+ output.info_suboptimal(" Running in a subprocess.")
+
+ try:
+ setup_layer(options, layer, setup_layers)
+ except zope.testing.testrunner.interfaces.EndRun:
+ raise
+ except EXPLOSIVE_ERRORS:
+ raise
+ except Exception:
+ handle_layer_failure(SetUpLayerFailure(), output, errors)
+ return 0
+ else:
+ return run_tests(options, tests, layer_name, failures, errors)
+
+
+class SetUpLayerFailure(unittest.TestCase):
+
+ subunit_label = 'setUp'
+
+ def runTest(self):
+ "Layer set up failure."
+
+
+class TearDownLayerFailure(unittest.TestCase):
+
+ subunit_label = 'tearDown'
+
+ def runTest(self):
+ "Layer tear down failure."
+
+
+def spawn_layer_in_subprocess(result, script_parts, options, features,
+ layer_name, layer, failures, errors,
+ resume_number):
+ output = options.output
+
+ try:
+ # BBB
+ if script_parts is None:
+ script_parts = sys.argv[0:1]
+ args = [sys.executable]
+ args.extend(script_parts)
+ args.extend(['--resume-layer', layer_name, str(resume_number)])
+ for d in options.testrunner_defaults:
+ args.extend(['--default', d])
+
+ args.extend(options.original_testrunner_args[1:])
+
+ # this is because of a bug in Python (http://www.python.org/sf/900092)
+ if (options.profile == 'hotshot'
+ and sys.version_info[:3] <= (2, 4, 1)):
+ args.insert(1, '-O')
+
+ if sys.platform.startswith('win'):
+ args = args[0] + ' ' + ' '.join([
+ ('"' + a.replace('\\', '\\\\').replace('"', '\\"') + '"')
+ for a in args[1:]])
+
+ for feature in features:
+ feature.layer_setup(layer)
+
+ child = subprocess.Popen(args, shell=False, stdin=subprocess.PIPE,
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+ close_fds=not sys.platform.startswith('win'))
+
+ while True:
+ try:
+ while True:
+ # We use readline() instead of iterating over stdout
+ # because it appears that iterating over stdout causes a
+ # lot more buffering to take place (probably so it can
+ # return its lines as a batch). We don't want too much
+ # buffering because this foils automatic and human monitors
+ # trying to verify that the subprocess is still alive.
+ l = child.stdout.readline()
+ if not l:
+ break
+ result.write(l)
+ except IOError, e:
+ if e.errno == errno.EINTR:
+ # If the subprocess dies before we finish reading its
+ # output, a SIGCHLD signal can interrupt the reading.
+ # The correct thing to to in that case is to retry.
+ continue
+ output.error(
+ "Error reading subprocess output for %s" % layer_name)
+ output.info(str(e))
+ else:
+ break
+
+ # Now stderr should be ready to read the whole thing.
+ erriter = iter(child.stderr.read().splitlines())
+ nfail = nerr = 0
+ for line in erriter:
+ try:
+ result.num_ran, nfail, nerr = map(int, line.strip().split())
+ except ValueError:
+ continue
+ else:
+ break
+ else:
+ output.error_with_banner("Could not communicate with subprocess")
+
+ while nfail > 0:
+ nfail -= 1
+ failures.append((erriter.next().strip(), None))
+ while nerr > 0:
+ nerr -= 1
+ errors.append((erriter.next().strip(), None))
+
+ finally:
+ result.done = True
+
+
+class AbstractSubprocessResult(object):
+ """A result of a subprocess layer run."""
+
+ num_ran = 0
+ done = False
+
+ def __init__(self, layer_name, queue):
+ self.layer_name = layer_name
+ self.queue = queue
+ self.stdout = []
+
+ def write(self, out):
+ """Receive a line of the subprocess out."""
+
+
+class DeferredSubprocessResult(AbstractSubprocessResult):
+ """Keeps stdout around for later processing,"""
+
+ def write(self, out):
+ if not _is_dots(out):
+ self.stdout.append(out)
+
+
+class ImmediateSubprocessResult(AbstractSubprocessResult):
+ """Sends complete output to queue."""
+
+ def write(self, out):
+ sys.stdout.write(out)
+ # Help keep-alive monitors (human or automated) keep up-to-date.
+ sys.stdout.flush()
+
+
+_is_dots = re.compile(r'\.+(\r\n?|\n)').match # Windows sneaks in a \r\n.
+class KeepaliveSubprocessResult(AbstractSubprocessResult):
+ "Keeps stdout for later processing; sends marks to queue to show activity."
+
+ _done = False
+
+ def _set_done(self, value):
+ self._done = value
+ assert value, 'Internal error: unexpectedly setting done to False'
+ self.queue.put((self.layer_name, ' LAYER FINISHED'))
+ done = property(lambda self: self._done, _set_done)
+
+ def write(self, out):
+ if _is_dots(out):
+ self.queue.put((self.layer_name, out.strip()))
+ else:
+ self.stdout.append(out)
+
+
+def resume_tests(script_parts, options, features, layers, failures, errors):
+ results = []
+ stdout_queue = None
+ if options.processes == 1:
+ result_factory = ImmediateSubprocessResult
+ elif options.verbose > 1:
+ result_factory = KeepaliveSubprocessResult
+ stdout_queue = Queue.Queue()
+ else:
+ result_factory = DeferredSubprocessResult
+ resume_number = int(options.processes > 1)
+ ready_threads = []
+ for layer_name, layer, tests in layers:
+ result = result_factory(layer_name, stdout_queue)
+ results.append(result)
+ ready_threads.append(threading.Thread(
+ target=spawn_layer_in_subprocess,
+ args=(result, script_parts, options, features, layer_name, layer,
+ failures, errors, resume_number)))
+ resume_number += 1
+
+ # Now start a few threads at a time.
+ running_threads = []
+ results_iter = iter(results)
+ current_result = results_iter.next()
+ last_layer_intermediate_output = None
+ output = None
+ while ready_threads or running_threads:
+ while len(running_threads) < options.processes and ready_threads:
+ thread = ready_threads.pop(0)
+ thread.start()
+ running_threads.append(thread)
+
+ for index, thread in reversed(list(enumerate(running_threads))):
+ if not thread.isAlive():
+ del running_threads[index]
+
+ # Clear out any messages in queue
+ while stdout_queue is not None:
+ previous_output = output
+ try:
+ layer_name, output = stdout_queue.get(False)
+ except Queue.Empty:
+ break
+ if layer_name != last_layer_intermediate_output:
+ # Clarify what layer is reporting activity.
+ if previous_output is not None:
+ sys.stdout.write(']\n')
+ sys.stdout.write(
+ '[Parallel tests running in %s:\n ' % (layer_name,))
+ last_layer_intermediate_output = layer_name
+ sys.stdout.write(output)
+ # Display results in the order they would have been displayed, had the
+ # work not been done in parallel.
+ while current_result and current_result.done:
+ if output is not None:
+ sys.stdout.write(']\n')
+ output = None
+ map(sys.stdout.write, current_result.stdout)
+
+ try:
+ current_result = results_iter.next()
+ except StopIteration:
+ current_result = None
+
+ # Help keep-alive monitors (human or automated) keep up-to-date.
+ sys.stdout.flush()
+ time.sleep(0.01) # Keep the loop from being too tight.
+
+ # Return the total number of tests run.
+ return sum(r.num_ran for r in results)
+
+
+def tear_down_unneeded(options, needed, setup_layers, optional=False):
+ # Tear down any layers not needed for these tests. The unneeded layers
+ # might interfere.
+ unneeded = [l for l in setup_layers if l not in needed]
+ unneeded = order_by_bases(unneeded)
+ output = options.output
+ failed_teardown = False
+ while unneeded:
+ l = unneeded.pop()
+ output.start_tear_down(name_from_layer(l))
+ t = time.time()
+ try:
+ if hasattr(l, 'tearDown'):
+ l.tearDown()
+ except NotImplementedError:
+ output.tear_down_not_supported()
+ if not failed_teardown:
+ failed_teardown = True
+ # Unwind all layers: this way, even if a layer does not
+ # implement tearDown, all the other layers have a chance to
+ # clean up things. The runner will start a new process
+ # (optional=False) or the tests will be finished.
+ unneeded = [togo for togo in setup_layers if togo is not l]
+ unneeded = order_by_bases(unneeded)
+ else:
+ output.stop_tear_down(time.time() - t)
+ del setup_layers[l]
+ if failed_teardown and not optional:
+ raise CanNotTearDown(l)
+
+
+cant_pm_in_subprocess_message = """
+Can't post-mortem debug when running a layer as a subprocess!
+Try running layer %r by itself.
+"""
+
+
+def setup_layer(options, layer, setup_layers):
+ assert layer is not object
+ output = options.output
+ if layer not in setup_layers:
+ for base in layer.__bases__:
+ if base is not object:
+ setup_layer(options, base, setup_layers)
+ output.start_set_up(name_from_layer(layer))
+ t = time.time()
+ if hasattr(layer, 'setUp'):
+ try:
+ layer.setUp()
+ except EXPLOSIVE_ERRORS:
+ raise
+ except Exception:
+ if options.post_mortem:
+ if options.resume_layer:
+ options.output.error_with_banner(
+ cant_pm_in_subprocess_message
+ % options.resume_layer)
+ raise
+ else:
+ zope.testing.testrunner.debug.post_mortem(
+ sys.exc_info())
+ else:
+ raise
+
+ output.stop_set_up(time.time() - t)
+ setup_layers[layer] = 1
+
+
+class TestResult(unittest.TestResult):
+
+ def __init__(self, options, tests, layer_name=None):
+ unittest.TestResult.__init__(self)
+ self.options = options
+ # Calculate our list of relevant layers we need to call testSetUp
+ # and testTearDown on.
+ layers = []
+ gather_layers(layer_from_name(layer_name), layers)
+ self.layers = order_by_bases(layers)
+ count = 0
+ for test in tests:
+ count += test.countTestCases()
+ self.count = count
+
+ def testSetUp(self):
+ """A layer may define a setup method to be called before each
+ individual test.
+ """
+ for layer in self.layers:
+ if hasattr(layer, 'testSetUp'):
+ layer.testSetUp()
+
+ def testTearDown(self):
+ """A layer may define a teardown method to be called after each
+ individual test.
+
+ This is useful for clearing the state of global
+ resources or resetting external systems such as relational
+ databases or daemons.
+ """
+ for layer in self.layers[-1::-1]:
+ if hasattr(layer, 'testTearDown'):
+ layer.testTearDown()
+
+ def startTest(self, test):
+ self.testSetUp()
+ unittest.TestResult.startTest(self, test)
+ testsRun = self.testsRun - 1 # subtract the one the base class added
+ count = test.countTestCases()
+ self.testsRun = testsRun + count
+
+ self.options.output.start_test(test, self.testsRun, self.count)
+
+ self._threads = threading.enumerate()
+ self._start_time = time.time()
+
+ def addSuccess(self, test):
+ t = max(time.time() - self._start_time, 0.0)
+ self.options.output.test_success(test, t)
+
+ def addError(self, test, exc_info):
+ self.options.output.test_error(test, time.time() - self._start_time,
+ exc_info)
+
+ unittest.TestResult.addError(self, test, exc_info)
+
+ if self.options.post_mortem:
+ if self.options.resume_layer:
+ self.options.output.error_with_banner("Can't post-mortem debug"
+ " when running a layer"
+ " as a subprocess!")
+ else:
+ zope.testing.testrunner.debug.post_mortem(exc_info)
+ elif self.options.stop_on_error:
+ self.stop()
+
+ def addFailure(self, test, exc_info):
+ self.options.output.test_failure(test, time.time() - self._start_time,
+ exc_info)
+
+ unittest.TestResult.addFailure(self, test, exc_info)
+
+ if self.options.post_mortem:
+ # XXX: mgedmin: why isn't there a resume_layer check here like
+ # in addError?
+ zope.testing.testrunner.debug.post_mortem(exc_info)
+ elif self.options.stop_on_error:
+ self.stop()
+
+ def stopTest(self, test):
+ self.testTearDown()
+ self.options.output.stop_test(test)
+
+ if is_jython:
+ pass
+ else:
+ if gc.garbage:
+ self.options.output.test_garbage(test, gc.garbage)
+ # TODO: Perhaps eat the garbage here, so that the garbage isn't
+ # printed for every subsequent test.
+
+ # Did the test leave any new threads behind?
+ new_threads = [t for t in threading.enumerate()
+ if (t.isAlive()
+ and
+ t not in self._threads)]
+ if new_threads:
+ self.options.output.test_threads(test, new_threads)
+
+
+def layer_from_name(layer_name):
+ """Return the layer for the corresponding layer_name by discovering
+ and importing the necessary module if necessary.
+
+ Note that a name -> layer cache is maintained by name_from_layer
+ to allow locating layers in cases where it would otherwise be
+ impossible.
+ """
+ if layer_name in _layer_name_cache:
+ return _layer_name_cache[layer_name]
+ layer_names = layer_name.split('.')
+ layer_module, module_layer_name = layer_names[:-1], layer_names[-1]
+ module_name = '.'.join(layer_module)
+ module = import_name(module_name)
+ try:
+ return getattr(module, module_layer_name)
+ except AttributeError, e:
+ # the default error is very uninformative:
+ # AttributeError: 'module' object has no attribute 'DemoLayer'
+ # it doesn't say *which* module
+ raise AttributeError('module %r has no attribute %r'
+ % (module_name, module_layer_name))
+
+
+def order_by_bases(layers):
+ """Order the layers from least to most specific (bottom to top)
+ """
+ named_layers = [(name_from_layer(layer), layer) for layer in layers]
+ named_layers.sort()
+ named_layers.reverse()
+ gathered = []
+ for name, layer in named_layers:
+ gather_layers(layer, gathered)
+ gathered.reverse()
+ seen = {}
+ result = []
+ for layer in gathered:
+ if layer not in seen:
+ seen[layer] = 1
+ if layer in layers:
+ result.append(layer)
+ return result
+
+
+def gather_layers(layer, result):
+ if layer is not object:
+ result.append(layer)
+ for b in layer.__bases__:
+ gather_layers(b, result)
+
+
+class FakeInputContinueGenerator:
+
+ def readline(self):
+ print 'c\n'
+ print '*'*70
+ print ("Can't use pdb.set_trace when running a layer"
+ " as a subprocess!")
+ print '*'*70
+ print
+ return 'c\n'
=== added file 'src/zope/testing/testrunner/selftest.py'
--- src/zope/testing/testrunner/selftest.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/selftest.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,33 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Self-test support.
+
+Provides setup routines that enable the test runner to test itself.
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import pdb
+import zope.testing.testrunner.feature
+
+real_pdb_set_trace = pdb.set_trace
+
+
+class SelfTest(zope.testing.testrunner.feature.Feature):
+
+ active = True
+
+ def global_setup(self):
+ # Make sure we start with real pdb.set_trace.
+ pdb.set_trace = real_pdb_set_trace
=== added file 'src/zope/testing/testrunner/shuffle.py'
--- src/zope/testing/testrunner/shuffle.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/shuffle.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,51 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Shuffle tests discovered before executing them.
+
+$Id$
+"""
+
+import time
+import random
+import unittest
+import zope.testing.testrunner.feature
+
+
+class Shuffle(zope.testing.testrunner.feature.Feature):
+ """Take the tests found so far and shuffle them."""
+
+ def __init__(self, runner):
+ super(Shuffle, self).__init__(runner)
+ self.active = runner.options.shuffle
+ self.seed = runner.options.shuffle_seed
+ if self.seed is None:
+ # We can't rely on the random modules seed initialization because
+ # we can't introspect the seed later for reporting. This is a
+ # simple emulation of what random.Random.seed does anyway.
+ self.seed = long(time.time() * 256) # use fractional seconds
+
+ def global_setup(self):
+ rng = random.Random(self.seed)
+ for layer, suite in list(self.runner.tests_by_layer_name.items()):
+ # Test suites cannot be modified through a public API. We thus
+ # take a mutable copy of the list of tests of that suite, shuffle
+ # that and replace the test suite instance with a new one of the
+ # same class.
+ tests = list(suite)
+ rng.shuffle(tests)
+ self.runner.tests_by_layer_name[layer] = suite.__class__(tests)
+
+ def report(self):
+ msg = "Tests were shuffled using seed number %d." % self.seed
+ self.runner.options.output.info(msg)
=== added file 'src/zope/testing/testrunner/statistics.py'
--- src/zope/testing/testrunner/statistics.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/statistics.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,48 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Test runner statistics
+
+$Id: __init__.py 86218 2008-05-03 14:17:26Z ctheune $
+"""
+
+import time
+import zope.testing.testrunner.feature
+
+
+class Statistics(zope.testing.testrunner.feature.Feature):
+
+ active = True
+ layers_run = 0
+ tests_run = 0
+
+ def late_setup(self):
+ self.start_time = time.time()
+
+ def early_teardown(self):
+ self.end_time = time.time()
+
+ def global_teardown(self):
+ self.total_time = self.end_time - self.start_time
+
+ def layer_setup(self, layer):
+ self.layers_run += 1
+
+ def report(self):
+ if not self.runner.do_run_tests:
+ return
+ if self.layers_run == 1:
+ return
+ self.runner.options.output.totals(
+ self.runner.ran, len(self.runner.failures), len(self.runner.errors),
+ self.total_time)
=== added file 'src/zope/testing/testrunner/tb_format.py'
--- src/zope/testing/testrunner/tb_format.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/tb_format.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,50 @@
+##############################################################################
+#
+# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Set up testing environment
+
+$Id: __init__.py 68482 2006-06-04 14:58:55Z jim $
+"""
+
+import sys
+import traceback
+import zope.exceptions.exceptionformatter
+import zope.testing.testrunner.feature
+
+
+def format_exception(t, v, tb, limit=None):
+ fmt = zope.exceptions.exceptionformatter.TextExceptionFormatter(
+ limit=None, with_filenames=True)
+ return fmt.formatException(t, v, tb)
+
+
+def print_exception(t, v, tb, limit=None, file=None):
+ if file is None:
+ file = sys.stdout
+ file.writelines(format_exception(t, v, tb, limit))
+
+
+class Traceback(zope.testing.testrunner.feature.Feature):
+
+ active = True
+
+ def global_setup(self):
+ self.old_format = traceback.format_exception
+ traceback.format_exception = format_exception
+
+ self.old_print = traceback.print_exception
+ traceback.print_exception = print_exception
+
+ def global_teardown(self):
+ traceback.format_exception = self.old_format
+ traceback.print_exception = self.old_print
=== added file 'src/zope/testing/testrunner/test_subunit.py'
--- src/zope/testing/testrunner/test_subunit.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/test_subunit.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,59 @@
+##############################################################################
+#
+# Copyright (c) 2004-2008 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Unit tests for the testrunner's subunit integration.
+"""
+
+
+import sys
+import unittest
+import formatter
+import subunit
+from StringIO import StringIO
+
+
+class TestSubunitTracebackPrinting(unittest.TestCase):
+
+ def makeByteStringFailure(self, text, encoding):
+ try:
+ # Note that this deliberately throws a string of bytes instead
+ # of a unicode object. This simulates errors thrown by
+ # utf8-encoded doctests.
+ bytestr = text.encode(encoding)
+ self.fail(bytestr)
+ except self.failureException:
+ return sys.exc_info()
+
+ def setUp(self):
+ class FormatterOptions:
+ verbose=False
+ options = FormatterOptions()
+
+ self.output = StringIO()
+ self.subunit_formatter = formatter.SubunitOutputFormatter(
+ options, stream=self.output)
+
+ def test_print_failure_containing_utf8_bytestrings(self):
+ exc_info = self.makeByteStringFailure(unichr(6514), 'utf8')
+ self.subunit_formatter.test_failure(self, 0, exc_info)
+ assert "AssertionError: \xe1\xa5\xb2" in self.output.getvalue()
+
+ def test_print_error_containing_utf8_bytestrings(self):
+ exc_info = self.makeByteStringFailure(unichr(6514), 'utf8')
+ self.subunit_formatter.test_error(self, 0, exc_info)
+ assert "AssertionError: \xe1\xa5\xb2" in self.output.getvalue()
+
+ def test_print_failure_containing_latin1_bytestrings(self):
+ exc_info = self.makeByteStringFailure(unichr(241), 'latin1')
+ self.subunit_formatter.test_failure(self, 0, exc_info)
+ assert "AssertionError: \xef\xbf\xbd0" in self.output.getvalue()
\ No newline at end of file
=== added file 'src/zope/testing/testrunner/testrunner-arguments.txt'
--- src/zope/testing/testrunner/testrunner-arguments.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-arguments.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,69 @@
+Passing arguments explicitly
+============================
+
+In most of the examples here, we set up `sys.argv`. In normal usage,
+the testrunner just uses `sys.argv`. It is possible to pass arguments
+explicitly.
+
+ >>> import os.path
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex')
+ >>> defaults = [
+ ... '--path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+ >>> from zope.testing import testrunner
+ >>> testrunner.run_internal(defaults, 'test --layer 111'.split())
+ Running samplelayers.Layer111 tests:
+ Set up samplelayers.Layerx in N.NNN seconds.
+ Set up samplelayers.Layer1 in N.NNN seconds.
+ Set up samplelayers.Layer11 in N.NNN seconds.
+ Set up samplelayers.Layer111 in N.NNN seconds.
+ Ran 34 tests with 0 failures and 0 errors in N.NNN seconds.
+ Tearing down left over layers:
+ Tear down samplelayers.Layer111 in N.NNN seconds.
+ Tear down samplelayers.Layerx in N.NNN seconds.
+ Tear down samplelayers.Layer11 in N.NNN seconds.
+ Tear down samplelayers.Layer1 in N.NNN seconds.
+ False
+
+If options already have default values, then passing a different default will
+override.
+
+For example, --list-tests defaults to being turned off, but if we pass in a
+different default, that one takes effect.
+
+ >>> defaults = [
+ ... '--list-tests',
+ ... '--path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+ >>> from zope.testing import testrunner
+ >>> testrunner.run_internal(defaults, 'test --layer 111'.split())
+ Listing samplelayers.Layer111 tests:
+ test_x1 (sample1.sampletests.test111.TestA)
+ test_y0 (sample1.sampletests.test111.TestA)
+ test_z0 (sample1.sampletests.test111.TestA)
+ test_x0 (sample1.sampletests.test111.TestB)
+ test_y1 (sample1.sampletests.test111.TestB)
+ test_z0 (sample1.sampletests.test111.TestB)
+ test_1 (sample1.sampletests.test111.TestNotMuch)
+ test_2 (sample1.sampletests.test111.TestNotMuch)
+ test_3 (sample1.sampletests.test111.TestNotMuch)
+ test_x0 (sample1.sampletests.test111)
+ test_y0 (sample1.sampletests.test111)
+ test_z1 (sample1.sampletests.test111)
+ /home/benji/workspace/zope.testing/1/src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/../../sampletestsl.txt
+ test_x1 (sampletests.test111.TestA)
+ test_y0 (sampletests.test111.TestA)
+ test_z0 (sampletests.test111.TestA)
+ test_x0 (sampletests.test111.TestB)
+ test_y1 (sampletests.test111.TestB)
+ test_z0 (sampletests.test111.TestB)
+ test_1 (sampletests.test111.TestNotMuch)
+ test_2 (sampletests.test111.TestNotMuch)
+ test_3 (sampletests.test111.TestNotMuch)
+ test_x0 (sampletests.test111)
+ test_y0 (sampletests.test111)
+ test_z1 (sampletests.test111)
+ /home/benji/workspace/zope.testing/1/src/zope/testing/testrunner/testrunner-ex/sampletests/../sampletestsl.txt
+ False
=== added file 'src/zope/testing/testrunner/testrunner-colors.txt'
--- src/zope/testing/testrunner/testrunner-colors.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-colors.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,420 @@
+Colorful output
+===============
+
+If you're on a Unix-like system, you can ask for colorized output. The test
+runner emits terminal control sequences to highlight important pieces of
+information (such as the names of failing tests) in different colors.
+
+ >>> import os.path, sys
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex')
+ >>> defaults = [
+ ... '--path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+
+ >>> from zope.testing import testrunner
+
+Since it wouldn't be a good idea to have terminal control characters in a
+test file, let's wrap sys.stdout in a simple terminal interpreter
+
+ >>> import re
+ >>> class Terminal(object):
+ ... _color_regexp = re.compile('\033[[]([0-9;]*)m')
+ ... _colors = {'0': 'normal', '1': 'bold', '30': 'black', '31': 'red',
+ ... '32': 'green', '33': 'yellow', '34': 'blue',
+ ... '35': 'magenta', '36': 'cyan', '37': 'grey'}
+ ... def __init__(self, stream):
+ ... self._stream = stream
+ ... def __getattr__(self, attr):
+ ... return getattr(self._stream, attr)
+ ... def isatty(self):
+ ... return True
+ ... def write(self, text):
+ ... if '\033[' in text:
+ ... text = self._color_regexp.sub(self._color, text)
+ ... self._stream.write(text)
+ ... def writelines(self, lines):
+ ... for line in lines:
+ ... self.write(line)
+ ... def _color(self, match):
+ ... colorstring = '{'
+ ... for number in match.group(1).split(';'):
+ ... colorstring += self._colors.get(number, '?')
+ ... return colorstring + '}'
+
+ >>> real_stdout = sys.stdout
+ >>> sys.stdout = Terminal(sys.stdout)
+
+
+Successful test
+---------------
+
+A successful test run soothes the developer with warm green colors:
+
+ >>> sys.argv = 'test --layer 122 -c'.split()
+ >>> testrunner.run_internal(defaults)
+ {normal}Running samplelayers.Layer122 tests:{normal}
+ Set up samplelayers.Layer1 in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer12 in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer122 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.007{normal} seconds.{normal}
+ {normal}Tearing down left over layers:{normal}
+ Tear down samplelayers.Layer122 in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layer12 in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layer1 in {green}0.000{normal} seconds.
+ False
+
+
+Failed test
+-----------
+
+A failed test run highlights the failures in red:
+
+ >>> sys.argv = 'test -c --tests-pattern ^sampletests(f|_e|_f)?$ '.split()
+ >>> testrunner.run_internal(defaults)
+ {normal}Running samplelayers.Layer1 tests:{normal}
+ Set up samplelayers.Layer1 in {green}0.000{normal} seconds.
+ {normal} Ran {green}9{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.001{normal} seconds.{normal}
+ {normal}Running samplelayers.Layer11 tests:{normal}
+ Set up samplelayers.Layer11 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.007{normal} seconds.{normal}
+ {normal}Running samplelayers.Layer111 tests:{normal}
+ Set up samplelayers.Layerx in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer111 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.008{normal} seconds.{normal}
+ {normal}Running samplelayers.Layer112 tests:{normal}
+ Tear down samplelayers.Layer111 in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer112 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.008{normal} seconds.{normal}
+ {normal}Running samplelayers.Layer12 tests:{normal}
+ Tear down samplelayers.Layer112 in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layerx in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layer11 in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer12 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.007{normal} seconds.{normal}
+ {normal}Running samplelayers.Layer121 tests:{normal}
+ Set up samplelayers.Layer121 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.007{normal} seconds.{normal}
+ {normal}Running samplelayers.Layer122 tests:{normal}
+ Tear down samplelayers.Layer121 in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer122 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.008{normal} seconds.{normal}
+ {normal}Running zope.testing.testrunner.layer.UnitTests tests:{normal}
+ Tear down samplelayers.Layer122 in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layer12 in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layer1 in {green}0.000{normal} seconds.
+ Set up zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ {boldred}Failure in test eek (sample2.sampletests_e){normal}
+ Failed doctest test for sample2.sampletests_e.eek
+ File "testrunner-ex/sample2/sampletests_e.py", line 28, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ {normal}File "{boldblue}testrunner-ex/sample2/sampletests_e.py{normal}", line {boldred}30{normal}, in {boldcyan}sample2.sampletests_e.eek{normal}
+ Failed example:
+ {cyan} f(){normal}
+ Exception raised:
+ {red} Traceback (most recent call last):{normal}
+ {red} File ".../doctest/__init__.py", line 1356, in __run{normal}
+ {red} compileflags, 1) in test.globs{normal}
+ {red} File "<doctest sample2.sampletests_e.eek[line 2, example 0]>", line 1, in ?{normal}
+ {red} f(){normal}
+ {red} File "testrunner-ex/sample2/sampletests_e.py", line 19, in f{normal}
+ {red} g(){normal}
+ {red} File "testrunner-ex/sample2/sampletests_e.py", line 24, in g{normal}
+ {red} x = y + 1{normal}
+ {red} - __traceback_info__: I don't know what Y should be.{normal}
+ {red} NameError: global name 'y' is not defined{normal}
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ {boldred}Error in test test3 (sample2.sampletests_e.Test){normal}
+ Traceback (most recent call last):
+ {normal} File "{boldblue}unittest.py{normal}", line {boldred}260{normal}, in {boldcyan}run{normal}
+ {cyan} testMethod(){normal}
+ {normal} File "{boldblue}testrunner-ex/sample2/sampletests_e.py{normal}", line {boldred}43{normal}, in {boldcyan}test3{normal}
+ {cyan} f(){normal}
+ {normal} File "{boldblue}testrunner-ex/sample2/sampletests_e.py{normal}", line {boldred}19{normal}, in {boldcyan}f{normal}
+ {cyan} g(){normal}
+ {normal} File "{boldblue}testrunner-ex/sample2/sampletests_e.py{normal}", line {boldred}24{normal}, in {boldcyan}g{normal}
+ {cyan} x = y + 1{normal}
+ {red} - __traceback_info__: I don't know what Y should be.{normal}
+ {red}NameError: global name 'y' is not defined{normal}
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ {boldred}Failure in test testrunner-ex/sample2/e.txt{normal}
+ Failed doctest test for e.txt
+ File "testrunner-ex/sample2/e.txt", line 0
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ {normal}File "{boldblue}testrunner-ex/sample2/e.txt{normal}", line {boldred}4{normal}, in {boldcyan}e.txt{normal}
+ Failed example:
+ {cyan} f(){normal}
+ Exception raised:
+ {red} Traceback (most recent call last):{normal}
+ {red} File ".../doctest/__init__.py", line 1356, in __run{normal}
+ {red} compileflags, 1) in test.globs{normal}
+ {red} File "<doctest e.txt[line 4, example 1]>", line 1, in ?{normal}
+ {red} f(){normal}
+ {red} File "<doctest e.txt[line 1, example 0]>", line 2, in f{normal}
+ {red} return x{normal}
+ {red} NameError: global name 'x' is not defined{normal}
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ {boldred}Failure in test test (sample2.sampletests_f.Test){normal}
+ Traceback (most recent call last):
+ {normal} File "{boldblue}unittest.py{normal}", line {boldred}260{normal}, in {boldcyan}run{normal}
+ {cyan} testMethod(){normal}
+ {normal} File "{boldblue}testrunner-ex/sample2/sampletests_f.py{normal}", line {boldred}21{normal}, in {boldcyan}test{normal}
+ {cyan} self.assertEqual(1,0){normal}
+ {normal} File "{boldblue}unittest.py{normal}", line {boldred}333{normal}, in {boldcyan}failUnlessEqual{normal}
+ {cyan} raise self.failureException, \{normal}
+ {red}AssertionError: 1 != 0{normal}
+ <BLANKLINE>
+ {normal} Ran {green}200{normal} tests with {boldred}3{normal} failures and {boldred}1{normal} errors in {green}0.045{normal} seconds.{normal}
+ {normal}Tearing down left over layers:{normal}
+ Tear down zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ {normal}Total: {green}413{normal} tests, {boldred}3{normal} failures, {boldred}1{normal} errors in {green}0.023{normal} seconds.{normal}
+ True
+
+
+Doctest failures
+----------------
+
+The expected and actual outputs of failed doctests are shown in different
+colors:
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ -c'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ {normal}Running zope.testing.testrunner.layer.UnitTests tests:{normal}
+ Set up zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ {boldred}Failure in test pledge (pledge){normal}
+ Failed doctest test for pledge.pledge
+ File "testrunner-ex/pledge.py", line 24, in pledge
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ {normal}File testrunner-ex/pledge.py{normal}", line {boldred}26{normal}, in {boldcyan}pledge.pledge{normal}
+ Failed example:
+ {cyan} print pledge_template % ('and earthling', 'planet'),{normal}
+ Expected:
+ {green} I give my pledge, as an earthling,{normal}
+ {green} to save, and faithfully, to defend from waste,{normal}
+ {green} the natural resources of my planet.{normal}
+ {green} It's soils, minerals, forests, waters, and wildlife.{normal}
+ Got:
+ {red} I give my pledge, as and earthling,{normal}
+ {red} to save, and faithfully, to defend from waste,{normal}
+ {red} the natural resources of my planet.{normal}
+ {red} It's soils, minerals, forests, waters, and wildlife.{normal}
+ <BLANKLINE>
+ {normal} Ran {green}1{normal} tests with {boldred}1{normal} failures and {green}0{normal} errors in {green}0.002{normal} seconds.{normal}
+ {normal}Tearing down left over layers:{normal}
+ Tear down zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+
+Diffs are highlighted so you can easily tell the context and the mismatches
+apart:
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ --ndiff -c'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ {normal}Running zope.testing.testrunner.layer.UnitTests tests:{normal}
+ Set up zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ {boldred}Failure in test pledge (pledge){normal}
+ Failed doctest test for pledge.pledge
+ File "testrunner-ex/pledge.py", line 24, in pledge
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ {normal}File testrunner-ex/pledge.py{normal}", line {boldred}26{normal}, in {boldcyan}pledge.pledge{normal}
+ Failed example:
+ {cyan} print pledge_template % ('and earthling', 'planet'),{normal}
+ Differences (ndiff with -expected +actual):
+ {green} - I give my pledge, as an earthling,{normal}
+ {red} + I give my pledge, as and earthling,{normal}
+ {magenta} ? +{normal}
+ {normal} to save, and faithfully, to defend from waste,{normal}
+ {normal} the natural resources of my planet.{normal}
+ {normal} It's soils, minerals, forests, waters, and wildlife.{normal}
+ <BLANKLINE>
+ {normal} Ran {green}1{normal} tests with {boldred}1{normal} failures and {green}0{normal} errors in {green}0.003{normal} seconds.{normal}
+ {normal}Tearing down left over layers:{normal}
+ Tear down zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+
+Even test failures that have actual blank lines (as opposed to <BLANKLINE>) in
+them are highlighted correctly.
+
+ >>> import zope.testing.testrunner.formatter
+ >>> formatter = zope.testing.testrunner.formatter.ColorfulOutputFormatter(None)
+ >>> formatter.print_doctest_failure("""\
+ ... File "sometest.txt", line 221, in sometest.txt
+ ... Failed example:
+ ... foo()
+ ... Expected:
+ ... Output that contains
+ ...
+ ... blank lines.
+ ... Got:
+ ... Output that still contains
+ ...
+ ... blank lines.""")
+ {normal} File "sometest.txt", line 221, in sometest.txt{normal}
+ Failed example:
+ {cyan} foo(){normal}
+ Expected:
+ {green} Output that contains{normal}
+ <BLANKLINE>
+ {green} blank lines.{normal}
+ Got:
+ {red} Output that still contains{normal}
+ <BLANKLINE>
+ {red} blank lines.{normal}
+ <BLANKLINE>
+
+
+Timing individual tests
+-----------------------
+
+At very high verbosity levels you can see the time taken by each test
+
+ >>> sys.argv = 'test -u -t test_one.TestNotMuch -c -vvv'.split()
+ >>> testrunner.run_internal(defaults)
+ {normal}Running tests at level 1{normal}
+ {normal}Running zope.testing.testrunner.layer.UnitTests tests:{normal}
+ Set up zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ {normal} Running:{normal}
+ test_1 (sample1.sampletests.test_one.TestNotMuch) ({green}N.NNN s{normal})
+ test_2 (sample1.sampletests.test_one.TestNotMuch) ({green}N.NNN s{normal})
+ test_3 (sample1.sampletests.test_one.TestNotMuch) ({green}N.NNN s{normal})
+ test_1 (sampletests.test_one.TestNotMuch) ({green}N.NNN s{normal})
+ test_2 (sampletests.test_one.TestNotMuch) ({green}N.NNN s{normal})
+ test_3 (sampletests.test_one.TestNotMuch) ({green}N.NNN s{normal})
+ {normal} Ran {green}6{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}N.NNN{normal} seconds.{normal}
+ {normal}Tearing down left over layers:{normal}
+ Tear down zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ False
+
+
+If we had very slow tests we would see their times highlighted in a different color.
+Instead of creating a test that waits 10 seconds, let's lower the slow test threshold
+in the test runner to 0 seconds to make all of the tests seem slow.
+
+ >>> sys.argv = 'test -u -t test_one.TestNotMuch -c -vvv --slow-test 0'.split()
+ >>> testrunner.run_internal(defaults)
+ {normal}Running tests at level 1{normal}
+ {normal}Running zope.testing.testrunner.layer.UnitTests tests:{normal}
+ Set up zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ {normal} Running:{normal}
+ test_1 (sample1.sampletests.test_one.TestNotMuch) ({boldmagenta}N.NNN s{normal})
+ test_2 (sample1.sampletests.test_one.TestNotMuch) ({boldmagenta}N.NNN s{normal})
+ test_3 (sample1.sampletests.test_one.TestNotMuch) ({boldmagenta}N.NNN s{normal})
+ test_1 (sampletests.test_one.TestNotMuch) ({boldmagenta}N.NNN s{normal})
+ test_2 (sampletests.test_one.TestNotMuch) ({boldmagenta}N.NNN s{normal})
+ test_3 (sampletests.test_one.TestNotMuch) ({boldmagenta}N.NNN s{normal})
+ {normal} Ran {green}6{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}N.NNN{normal} seconds.{normal}
+ {normal}Tearing down left over layers:{normal}
+ Tear down zope.testing.testrunner.layer.UnitTests in {green}N.NNN{normal} seconds.
+ False
+
+
+
+Disabling colors
+----------------
+
+If -c or --color have been previously provided on the command line (perhaps by
+a test runner wrapper script), but no colorized output is desired, the -C or
+--no-color options will disable colorized output:
+
+ >>> sys.argv = 'test --layer 122 -c -C'.split()
+ >>> testrunner.run_internal(defaults)
+ Running samplelayers.Layer122 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Set up samplelayers.Layer12 in 0.000 seconds.
+ Set up samplelayers.Layer122 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Tearing down left over layers:
+ Tear down samplelayers.Layer122 in 0.000 seconds.
+ Tear down samplelayers.Layer12 in 0.000 seconds.
+ Tear down samplelayers.Layer1 in 0.000 seconds.
+ False
+
+ >>> sys.argv = 'test --layer 122 -c --no-color'.split()
+ >>> testrunner.run_internal(defaults)
+ Running samplelayers.Layer122 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Set up samplelayers.Layer12 in 0.000 seconds.
+ Set up samplelayers.Layer122 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Tearing down left over layers:
+ Tear down samplelayers.Layer122 in 0.000 seconds.
+ Tear down samplelayers.Layer12 in 0.000 seconds.
+ Tear down samplelayers.Layer1 in 0.000 seconds.
+ False
+
+
+Autodetecting colors
+--------------------
+
+The --auto-color option will determine if stdout is a terminal that supports
+colors, and only enable colorized output if so. Our ``Terminal`` wrapper
+pretends it is a terminal, but the curses module will realize it isn't:
+
+ >>> sys.argv = 'test --layer 122 --auto-color'.split()
+ >>> testrunner.run_internal(defaults)
+ Running samplelayers.Layer122 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Set up samplelayers.Layer12 in 0.000 seconds.
+ Set up samplelayers.Layer122 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Tearing down left over layers:
+ Tear down samplelayers.Layer122 in 0.000 seconds.
+ Tear down samplelayers.Layer12 in 0.000 seconds.
+ Tear down samplelayers.Layer1 in 0.000 seconds.
+ False
+
+We can fake it
+
+ >>> class FakeCurses(object):
+ ... class error(Exception):
+ ... pass
+ ... def setupterm(self):
+ ... pass
+ ... def tigetnum(self, attr):
+ ... return dict(colors=8).get(attr, -2)
+ >>> sys.modules['curses'] = FakeCurses()
+
+ >>> sys.argv = 'test --layer 122 --auto-color'.split()
+ >>> testrunner.run_internal(defaults)
+ {normal}Running samplelayers.Layer122 tests:{normal}
+ Set up samplelayers.Layer1 in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer12 in {green}0.000{normal} seconds.
+ Set up samplelayers.Layer122 in {green}0.000{normal} seconds.
+ {normal} Ran {green}34{normal} tests with {green}0{normal} failures and {green}0{normal} errors in {green}0.007{normal} seconds.{normal}
+ {normal}Tearing down left over layers:{normal}
+ Tear down samplelayers.Layer122 in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layer12 in {green}0.000{normal} seconds.
+ Tear down samplelayers.Layer1 in {green}0.000{normal} seconds.
+ False
+
+ >>> del sys.modules['curses']
+
+The real stdout is not a terminal in a doctest:
+
+ >>> sys.stdout = real_stdout
+
+ >>> sys.argv = 'test --layer 122 --auto-color'.split()
+ >>> testrunner.run_internal(defaults)
+ Running samplelayers.Layer122 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Set up samplelayers.Layer12 in 0.000 seconds.
+ Set up samplelayers.Layer122 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Tearing down left over layers:
+ Tear down samplelayers.Layer122 in 0.000 seconds.
+ Tear down samplelayers.Layer12 in 0.000 seconds.
+ Tear down samplelayers.Layer1 in 0.000 seconds.
+ False
=== added file 'src/zope/testing/testrunner/testrunner-coverage-win32.txt'
--- src/zope/testing/testrunner/testrunner-coverage-win32.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-coverage-win32.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,27 @@
+Code Coverage
+=============
+
+On Windows drive names can be upper and lower case, these can be
+randomly passed to TestIgnore.names.
+Watch out for the case of the R drive!
+
+ >>> from zope.testing.testrunner.coverage import TestIgnore
+ >>> ignore = TestIgnore((('r:\\winproject\\src\\blah\\foo', ''),
+ ... ('R:\\winproject\\src\\blah\\bar', '')))
+ >>> ignore._test_dirs
+ ['r:\\winproject\\src\\blah\\foo\\', 'R:\\winproject\\src\\blah\\bar\\']
+
+We can now ask whether a particular module should be ignored:
+
+ >>> ignore.names('r:\\winproject\\src\\blah\\foo\\baz.py', 'baz')
+ False
+ >>> ignore.names('R:\\winproject\\src\\blah\\foo\\baz.py', 'baz')
+ False
+ >>> ignore.names('r:\\winproject\\src\\blah\\bar\\zab.py', 'zab')
+ False
+ >>> ignore.names('R:\\winproject\\src\\blah\\bar\\zab.py', 'zab')
+ False
+ >>> ignore.names('r:\\winproject\\src\\blah\\hello.py', 'hello')
+ True
+ >>> ignore.names('R:\\winproject\\src\\blah\\hello.py', 'hello')
+ True
=== added file 'src/zope/testing/testrunner/testrunner-coverage.txt'
--- src/zope/testing/testrunner/testrunner-coverage.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-coverage.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,129 @@
+Code Coverage
+=============
+
+If the --coverage option is used, test coverage reports will be generated. The
+directory name given as the parameter will be used to hold the reports.
+
+
+ >>> import os.path, sys
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex')
+ >>> defaults = [
+ ... '--path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+
+ >>> sys.argv = 'test --coverage=coverage_dir'.split()
+
+ >>> from zope.testing import testrunner
+ >>> testrunner.run_internal(defaults)
+ Running samplelayers.Layer1 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Ran 9 tests with 0 failures and 0 errors in 0.000 seconds.
+ Running samplelayers.Layer11 tests:
+ Set up samplelayers.Layer11 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.125 seconds.
+ Running samplelayers.Layer111 tests:
+ Set up samplelayers.Layerx in 0.000 seconds.
+ Set up samplelayers.Layer111 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.125 seconds.
+ Running samplelayers.Layer112 tests:
+ Tear down samplelayers.Layer111 in 0.000 seconds.
+ Set up samplelayers.Layer112 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.125 seconds.
+ Running samplelayers.Layer12 tests:
+ Tear down samplelayers.Layer112 in 0.000 seconds.
+ Tear down samplelayers.Layerx in 0.000 seconds.
+ Tear down samplelayers.Layer11 in 0.000 seconds.
+ Set up samplelayers.Layer12 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.140 seconds.
+ Running samplelayers.Layer121 tests:
+ Set up samplelayers.Layer121 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.125 seconds.
+ Running samplelayers.Layer122 tests:
+ Tear down samplelayers.Layer121 in 0.000 seconds.
+ Set up samplelayers.Layer122 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.125 seconds.
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Tear down samplelayers.Layer122 in 0.000 seconds.
+ Tear down samplelayers.Layer12 in 0.000 seconds.
+ Tear down samplelayers.Layer1 in 0.000 seconds.
+ Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
+ Ran 192 tests with 0 failures and 0 errors in 0.687 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
+ lines cov% module (path)
+ ...
+ 48 100% sampletests.test1 (testrunner-ex/sampletests/test1.py)
+ 74 100% sampletests.test11 (testrunner-ex/sampletests/test11.py)
+ 74 100% sampletests.test111 (testrunner-ex/sampletests/test111.py)
+ 76 100% sampletests.test112 (testrunner-ex/sampletests/test112.py)
+ 74 100% sampletests.test12 (testrunner-ex/sampletests/test12.py)
+ 74 100% sampletests.test121 (testrunner-ex/sampletests/test121.py)
+ 74 100% sampletests.test122 (testrunner-ex/sampletests/test122.py)
+ 48 100% sampletests.test_one (testrunner-ex/sampletests/test_one.py)
+ 112 95% sampletestsf (testrunner-ex/sampletestsf.py)
+ Total: 405 tests, 0 failures, 0 errors in 0.630 seconds.
+ False
+
+The directory specified with the --coverage option will have been created and
+will hold the coverage reports.
+
+ >>> os.path.exists('coverage_dir')
+ True
+ >>> os.listdir('coverage_dir')
+ [...]
+
+(We should clean up after ourselves.)
+
+ >>> import shutil
+ >>> shutil.rmtree('coverage_dir')
+
+
+Ignoring Tests
+--------------
+
+The ``trace`` module supports ignoring directories and modules based the test
+selection. Only directories selected for testing should report coverage. The
+test runner provides a custom implementation of the relevant API.
+
+The ``TestIgnore`` class, the class managing the ignoring, is initialized by
+passing the command line options. It uses the options to determine the
+directories that should be covered.
+
+ >>> class FauxOptions(object):
+ ... package = None
+ ... test_path = [('/myproject/src/blah/foo', ''),
+ ... ('/myproject/src/blah/bar', '')]
+ >>> from zope.testing.testrunner import coverage
+ >>> from zope.testing.testrunner.find import test_dirs
+ >>> ignore = coverage.TestIgnore(test_dirs(FauxOptions(), {}))
+ >>> ignore._test_dirs
+ ['/myproject/src/blah/foo/', '/myproject/src/blah/bar/']
+
+We can now ask whether a particular module should be ignored:
+
+ >>> ignore.names('/myproject/src/blah/foo/baz.py', 'baz')
+ False
+ >>> ignore.names('/myproject/src/blah/bar/mine.py', 'mine')
+ False
+ >>> ignore.names('/myproject/src/blah/foo/__init__.py', 'foo')
+ False
+ >>> ignore.names('/myproject/src/blah/hello.py', 'hello')
+ True
+
+When running the test runner, modules are sometimes created from text
+strings. Those should *always* be ignored:
+
+ >>> ignore.names('/myproject/src/blah/hello.txt', '<string>')
+ True
+
+To make this check fast, the class implements a cache. In an early
+implementation, the result was cached by the module name, which was a problem,
+since a lot of modules carry the same name (not the Python dotted name
+here!). So just because a module has the same name in an ignored and tested
+directory, does not mean it is always ignored:
+
+ >>> ignore.names('/myproject/src/blah/module.py', 'module')
+ True
+ >>> ignore.names('/myproject/src/blah/foo/module.py', 'module')
+ False
=== added file 'src/zope/testing/testrunner/testrunner-debugging-layer-setup.test'
--- src/zope/testing/testrunner/testrunner-debugging-layer-setup.test 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-debugging-layer-setup.test 2012-06-06 16:03:24 +0000
@@ -0,0 +1,134 @@
+Post-mortem debugging also works when there is a failure in layer
+setup.
+
+ >>> import os, shutil, sys, tempfile
+ >>> tdir = tempfile.mkdtemp()
+ >>> dir = os.path.join(tdir, 'TESTS-DIR')
+ >>> os.mkdir(dir)
+ >>> open(os.path.join(dir, 'tests.py'), 'w').write(
+ ... '''
+ ... import doctest
+ ...
+ ... class Layer:
+ ... @classmethod
+ ... def setUp(self):
+ ... x = 1
+ ... raise ValueError
+ ...
+ ... def a_test():
+ ... """
+ ... >>> None
+ ... """
+ ... def test_suite():
+ ... suite = doctest.DocTestSuite()
+ ... suite.layer = Layer
+ ... return suite
+ ...
+ ... ''')
+
+ >>> class Input:
+ ... def __init__(self, src):
+ ... self.lines = src.split('\n')
+ ... def readline(self):
+ ... line = self.lines.pop(0)
+ ... print line
+ ... return line+'\n'
+
+ >>> real_stdin = sys.stdin
+ >>> if sys.version_info[:2] == (2, 3):
+ ... sys.stdin = Input('n\np x\nc')
+ ... else:
+ ... sys.stdin = Input('p x\nc')
+
+ >>> sys.argv = [testrunner_script]
+ >>> import zope.testing.testrunner
+ >>> try:
+ ... zope.testing.testrunner.run_internal(['--path', dir, '-D'])
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +ELLIPSIS
+ Running tests.Layer tests:
+ Set up tests.Layer exceptions.ValueError:
+ <BLANKLINE>
+ > ...tests.py(8)setUp()
+ -> raise ValueError
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+Note that post-mortem debugging doesn't work when the layer is run in
+a subprocess:
+
+ >>> if sys.version_info[:2] == (2, 3):
+ ... sys.stdin = Input('n\np x\nc')
+ ... else:
+ ... sys.stdin = Input('p x\nc')
+
+ >>> open(os.path.join(dir, 'tests2.py'), 'w').write(
+ ... '''
+ ... import doctest, unittest
+ ...
+ ... class Layer1:
+ ... @classmethod
+ ... def setUp(self):
+ ... pass
+ ...
+ ... @classmethod
+ ... def tearDown(self):
+ ... raise NotImplementedError
+ ...
+ ... class Layer2:
+ ... @classmethod
+ ... def setUp(self):
+ ... x = 1
+ ... raise ValueError
+ ...
+ ... def a_test():
+ ... """
+ ... >>> None
+ ... """
+ ... def test_suite():
+ ... suite1 = doctest.DocTestSuite()
+ ... suite1.layer = Layer1
+ ... suite2 = doctest.DocTestSuite()
+ ... suite2.layer = Layer2
+ ... return unittest.TestSuite((suite1, suite2))
+ ...
+ ... ''')
+
+ >>> import sys
+ >>> try:
+ ... zope.testing.testrunner.run_internal(
+ ... ['--path', dir, '-Dvv', '--tests-pattern', 'tests2'])
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +ELLIPSIS +REPORT_NDIFF
+ Running tests at level 1
+ Running tests2.Layer1 tests:
+ Set up tests2.Layer1 in 0.000 seconds.
+ Running:
+ a_test (tests2)
+ Ran 1 tests with 0 failures and 0 errors in 0.001 seconds.
+ Running tests2.Layer2 tests:
+ Tear down tests2.Layer1 ... not supported
+ Running in a subprocess.
+ Set up tests2.Layer2
+ **********************************************************************
+ <BLANKLINE>
+ Can't post-mortem debug when running a layer as a subprocess!
+ Try running layer 'tests2.Layer2' by itself.
+ <BLANKLINE>
+ **********************************************************************
+ <BLANKLINE>
+ Traceback (most recent call last):
+ ...
+ raise ValueError
+ ValueError
+ <BLANKLINE>
+ <BLANKLINE>
+ Tests with errors:
+ runTest (zope.testing.testrunner.runner.SetUpLayerFailure)
+ Total: 1 tests, 0 failures, 1 errors in 0.210 seconds.
+ True
+
+ >>> shutil.rmtree(tdir)
+
=== added file 'src/zope/testing/testrunner/testrunner-debugging.txt'
--- src/zope/testing/testrunner/testrunner-debugging.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-debugging.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,118 @@
+Debugging
+=========
+
+The testrunner module supports post-mortem debugging and debugging
+using `pdb.set_trace`. Let's look first at using `pdb.set_trace`.
+To demonstrate this, we'll provide input via helper Input objects:
+
+ >>> class Input:
+ ... def __init__(self, src):
+ ... self.lines = src.split('\n')
+ ... def readline(self):
+ ... line = self.lines.pop(0)
+ ... print line
+ ... return line+'\n'
+
+If a test or code called by a test calls pdb.set_trace, then the
+runner will enter pdb at that point:
+
+ >>> import os.path, sys
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex')
+ >>> from zope.testing import testrunner
+ >>> defaults = [
+ ... '--path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+
+ >>> real_stdin = sys.stdin
+ >>> if sys.version_info[:2] == (2, 3):
+ ... sys.stdin = Input('n\np x\nc')
+ ... else:
+ ... sys.stdin = Input('p x\nc')
+
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t set_trace1').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +ELLIPSIS
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ ...
+ > testrunner-ex/sample3/sampletests_d.py(27)test_set_trace1()
+ -> y = x
+ (Pdb) p x
+ 1
+ (Pdb) c
+ Ran 1 tests with 0 failures and 0 errors in 0.001 seconds.
+ ...
+ False
+
+Note that, prior to Python 2.4, calling pdb.set_trace caused pdb to
+break in the pdb.set_trace function. It was necessary to use 'next'
+or 'up' to get to the application code that called pdb.set_trace. In
+Python 2.4, pdb.set_trace causes pdb to stop right after the call to
+pdb.set_trace.
+
+You can also do post-mortem debugging, using the --post-mortem (-D)
+option:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem1 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE +REPORT_NDIFF
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ ...
+ Error in test test_post_mortem1 (sample3.sampletests_d.TestSomething)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample3/sampletests_d.py",
+ line 34, in test_post_mortem1
+ raise ValueError
+ ValueError
+ <BLANKLINE>
+ exceptions.ValueError:
+ <BLANKLINE>
+ > testrunner-ex/sample3/sampletests_d.py(34)test_post_mortem1()
+ -> raise ValueError
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+Note that the test runner exits after post-mortem debugging.
+
+In the example above, we debugged an error. Failures are actually
+converted to errors and can be debugged the same way:
+
+ >>> sys.stdin = Input('up\np x\np y\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem_failure1 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE +REPORT_NDIFF
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ ...
+ Error in test test_post_mortem_failure1 (sample3.sampletests_d.TestSomething)
+ Traceback (most recent call last):
+ File ".../unittest.py", line 252, in debug
+ getattr(self, self.__testMethodName)()
+ File "testrunner-ex/sample3/sampletests_d.py",
+ line 42, in test_post_mortem_failure1
+ self.assertEqual(x, y)
+ File ".../unittest.py", line 302, in failUnlessEqual
+ raise self.failureException, \
+ AssertionError: 1 != 2
+ <BLANKLINE>
+ exceptions.AssertionError:
+ 1 != 2
+ > .../unittest.py(302)failUnlessEqual()
+ -> ...
+ (Pdb) up
+ > testrunner-ex/sample3/sampletests_d.py(42)test_post_mortem_failure1()
+ -> self.assertEqual(x, y)
+ (Pdb) p x
+ 1
+ (Pdb) p y
+ 2
+ (Pdb) c
+ True
=== added file 'src/zope/testing/testrunner/testrunner-discovery.txt'
--- src/zope/testing/testrunner/testrunner-discovery.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-discovery.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,48 @@
+Automatically discovering tests
+===============================
+
+You can explicitly specify which tests to run by providing a function that
+returns a unittest.TestSuite in the test modules (the name of the function can
+be configured with the --suite-name parameter, it defaults to 'test_suite'). If
+no such function is present, testrunner will use all classes in the module that
+inherit from unittest.TestCase as tests:
+
+ >>> import os, sys
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex')
+
+ >>> from zope.testing import testrunner
+
+ >>> defaults = [
+ ... '--path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+ >>> sys.argv = ['test',
+ ... '--tests-pattern', '^sampletests_discover$',
+ ... ]
+ >>> testrunner.run(defaults)
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ Ran 1 tests with 0 failures and 0 errors in N.NNN seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ False
+
+If the module neither provides a TestSuite nor has discoverable tests,
+testrunner will exit with an error to prevent acidentally missing test cases:
+
+ >>> sys.argv = ['test',
+ ... '--tests-pattern', '^sampletests_discover_notests$',
+ ... ]
+ >>> testrunner.run(defaults)
+ Test-module import failures:
+ <BLANKLINE>
+ Module: sample1.sampletests_discover_notests
+ <BLANKLINE>
+ TypeError: Module sample1.sampletests_discover_notests does not define any tests
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ Test-modules with import problems:
+ sample1.sampletests_discover_notests
+ Total: 0 tests, 0 failures, 0 errors in 0.000 seconds.
+ True
=== added file 'src/zope/testing/testrunner/testrunner-edge-cases.txt'
--- src/zope/testing/testrunner/testrunner-edge-cases.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-edge-cases.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,515 @@
+testrunner Edge Cases
+=====================
+
+This document has some edge-case examples to test various aspects of
+the test runner.
+
+Separating Python path and test directories
+-------------------------------------------
+
+The --path option defines a directory to be searched for tests *and* a
+directory to be added to Python's search path. The --test-path option
+can be used when you want to set a test search path without also
+affecting the Python path:
+
+ >>> import os, sys
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex')
+
+ >>> from zope.testing import testrunner
+
+ >>> defaults = [
+ ... '--test-path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+ >>> sys.argv = ['test']
+ >>> testrunner.run_internal(defaults)
+ ... # doctest: +ELLIPSIS
+ Test-module import failures:
+ <BLANKLINE>
+ Module: sampletestsf
+ <BLANKLINE>
+ Traceback (most recent call last):
+ ImportError: No module named sampletestsf
+ ...
+
+ >>> sys.path.append(directory_with_tests)
+ >>> sys.argv = ['test']
+ >>> testrunner.run_internal(defaults)
+ ... # doctest: +ELLIPSIS
+ Running samplelayers.Layer1 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Ran 9 tests with 0 failures and 0 errors in 0.000 seconds.
+ ...
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Tear down samplelayers.Layer122 in N.NNN seconds.
+ Tear down samplelayers.Layer12 in N.NNN seconds.
+ Tear down samplelayers.Layer1 in N.NNN seconds.
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ Ran 192 tests with 0 failures and 0 errors in N.NNN seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ Total: 405 tests, 0 failures, 0 errors in N.NNN seconds.
+ False
+
+Bug #251759: The test runner's protection against descending into non-package
+directories was ineffective, e.g. picking up tests from eggs that were stored
+close by:
+
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex-251759')
+
+ >>> defaults = [
+ ... '--test-path', directory_with_tests,
+ ... ]
+ >>> testrunner.run_internal(defaults)
+ Total: 0 tests, 0 failures, 0 errors in 0.000 seconds.
+ False
+
+
+Debugging Edge Cases
+--------------------
+
+ >>> directory_with_tests = os.path.join(this_directory, 'testrunner-ex')
+ >>> defaults = [
+ ... '--test-path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+ >>> class Input:
+ ... def __init__(self, src):
+ ... self.lines = src.split('\n')
+ ... def readline(self):
+ ... line = self.lines.pop(0)
+ ... print line
+ ... return line+'\n'
+
+ >>> real_stdin = sys.stdin
+
+Using pdb.set_trace in a function called by an ordinary test:
+
+ >>> if sys.version_info[:2] == (2, 3):
+ ... sys.stdin = Input('n\np x\nc')
+ ... else:
+ ... sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t set_trace2').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +ELLIPSIS
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ > testrunner-ex/sample3/sampletests_d.py(47)f()
+ -> y = x
+ (Pdb) p x
+ 1
+ (Pdb) c
+ Ran 1 tests with 0 failures and 0 errors in 0.001 seconds.
+ ...
+ False
+
+Using pdb.set_trace in a function called by a doctest in a doc string:
+
+ >>> sys.stdin = Input('n\np x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t set_trace4').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ --Return--
+ > doctest.py(351)set_trace()->None
+ -> pdb.Pdb.set_trace(self)
+ (Pdb) n
+ > testrunner-ex/sample3/sampletests_d.py(42)f()
+ -> y = x
+ (Pdb) p x
+ 1
+ (Pdb) c
+ Ran 1 tests with 0 failures and 0 errors in 0.002 seconds.
+ ...
+ False
+
+Using pdb in a docstring-based doctest
+
+ >>> sys.stdin = Input('n\np x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t set_trace3').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ --Return--
+ > doctest.py(351)set_trace()->None
+ -> pdb.Pdb.set_trace(self)
+ (Pdb) n
+ > <doctest sample3.sampletests_d.set_trace3[line 3, example 1]>(3)...()
+ -> y = x
+ (Pdb) p x
+ 1
+ (Pdb) c
+ Ran 1 tests with 0 failures and 0 errors in 0.002 seconds.
+ ...
+ False
+
+Using pdb.set_trace in a doc file:
+
+
+ >>> sys.stdin = Input('n\np x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t set_trace5').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ --Return--
+ > doctest.py(351)set_trace()->None
+ -> pdb.Pdb.set_trace(self)
+ (Pdb) n
+ > <doctest set_trace5.txt[line 2, example 1]>(3)...()
+ -> y = x
+ (Pdb) p x
+ 1
+ (Pdb) c
+ Ran 1 tests with 0 failures and 0 errors in 0.002 seconds.
+ ...
+ False
+
+
+Using pdb.set_trace in a function called by a doctest in a doc file:
+
+
+ >>> sys.stdin = Input('n\np x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t set_trace6').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ --Return--
+ > doctest.py(351)set_trace()->None
+ -> pdb.Pdb.set_trace(self)
+ (Pdb) n
+ > testrunner-ex/sample3/sampletests_d.py(42)f()
+ -> y = x
+ (Pdb) p x
+ 1
+ (Pdb) c
+ Ran 1 tests with 0 failures and 0 errors in 0.002 seconds.
+ ...
+ False
+
+Post-mortem debugging function called from ordinary test:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem2 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ <BLANKLINE>
+ <BLANKLINE>
+ Error in test test_post_mortem2 (sample3.sampletests_d.TestSomething)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample3/sampletests_d.py",
+ line 37, in test_post_mortem2
+ g()
+ File "testrunner-ex/sample3/sampletests_d.py", line 46, in g
+ raise ValueError
+ ValueError
+ <BLANKLINE>
+ exceptions.ValueError:
+ <BLANKLINE>
+ > testrunner-ex/sample3/sampletests_d.py(46)g()
+ -> raise ValueError
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+
+Post-mortem debugging docstring-based doctest:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem3 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Error in test post_mortem3 (sample3.sampletests_d)
+ Traceback (most recent call last):
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in debug
+ runner.run(self._dt_test, clear_globs=False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ r = DocTestRunner.run(self, test, compileflags, out, False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ return self.__run(test, compileflags, out)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in __run
+ exc_info)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in report_unexpected_exception
+ raise UnexpectedException(test, example, exc_info)
+ UnexpectedException: testrunner-ex/sample3/sampletests_d.py:61 (2 examples)>
+ <BLANKLINE>
+ exceptions.ValueError:
+ <BLANKLINE>
+ > <doctest sample3.sampletests_d.post_mortem3[line 3, example 1]>(1)...()
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+Post-mortem debugging function called from docstring-based doctest:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem4 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Error in test post_mortem4 (sample3.sampletests_d)
+ Traceback (most recent call last):
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in debug
+ runner.run(self._dt_test, clear_globs=False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ r = DocTestRunner.run(self, test, compileflags, out, False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ return self.__run(test, compileflags, out)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in __run
+ exc_info)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in report_unexpected_exception
+ raise UnexpectedException(test, example, exc_info)
+ UnexpectedException: testrunner-ex/sample3/sampletests_d.py:NNN (1 example)>
+ <BLANKLINE>
+ exceptions.ValueError:
+ <BLANKLINE>
+ > testrunner-ex/sample3/sampletests_d.py(NNN)g()
+ -> raise ValueError
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+Post-mortem debugging file-based doctest:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem5 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Error testrunner-ex/sample3/post_mortem5.txt
+ Traceback (most recent call last):
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in debug
+ runner.run(self._dt_test, clear_globs=False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ r = DocTestRunner.run(self, test, compileflags, out, False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ return self.__run(test, compileflags, out)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in __run
+ exc_info)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in report_unexpected_exception
+ raise UnexpectedException(test, example, exc_info)
+ UnexpectedException: testrunner-ex/sample3/post_mortem5.txt:0 (2 examples)>
+ <BLANKLINE>
+ exceptions.ValueError:
+ <BLANKLINE>
+ > <doctest post_mortem5.txt[line 2, example 1]>(1)...()
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+
+Post-mortem debugging function called from file-based doctest:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem6 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Error testrunner-ex/sample3/post_mortem6.txt
+ Traceback (most recent call last):
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in debug
+ runner.run(self._dt_test, clear_globs=False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ r = DocTestRunner.run(self, test, compileflags, out, False)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in run
+ return self.__run(test, compileflags, out)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in __run
+ exc_info)
+ File ".../zope/testing/doctest/__init__.py", Line NNN, in report_unexpected_exception
+ raise UnexpectedException(test, example, exc_info)
+ UnexpectedException: testrunner-ex/sample3/post_mortem6.txt:0 (2 examples)>
+ <BLANKLINE>
+ exceptions.ValueError:
+ <BLANKLINE>
+ > testrunner-ex/sample3/sampletests_d.py(NNN)g()
+ -> raise ValueError
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+Post-mortem debugging of a docstring doctest failure:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem_failure2 -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ <BLANKLINE>
+ <BLANKLINE>
+ Error in test post_mortem_failure2 (sample3.sampletests_d)
+ <BLANKLINE>
+ File "testrunner-ex/sample3/sampletests_d.py",
+ line 81, in sample3.sampletests_d.post_mortem_failure2
+ <BLANKLINE>
+ x
+ <BLANKLINE>
+ Want:
+ 2
+ <BLANKLINE>
+ Got:
+ 1
+ <BLANKLINE>
+ <BLANKLINE>
+ > testrunner-ex/sample3/sampletests_d.py(81)_()
+ exceptions.ValueError:
+ Expected and actual output are different
+ > <string>(1)...()
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+
+Post-mortem debugging of a docfile doctest failure:
+
+ >>> sys.stdin = Input('p x\nc')
+ >>> sys.argv = ('test -ssample3 --tests-pattern ^sampletests_d$'
+ ... ' -t post_mortem_failure.txt -D').split()
+ >>> try: testrunner.run_internal(defaults)
+ ... finally: sys.stdin = real_stdin
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:...
+ <BLANKLINE>
+ <BLANKLINE>
+ Error in test /home/jim/z3/zope.testing/src/zope/testing/testrunner-ex/sample3/post_mortem_failure.txt
+ <BLANKLINE>
+ File "testrunner-ex/sample3/post_mortem_failure.txt",
+ line 2, in post_mortem_failure.txt
+ <BLANKLINE>
+ x
+ <BLANKLINE>
+ Want:
+ 2
+ <BLANKLINE>
+ Got:
+ 1
+ <BLANKLINE>
+ <BLANKLINE>
+ > testrunner-ex/sample3/post_mortem_failure.txt(2)_()
+ exceptions.ValueError:
+ Expected and actual output are different
+ > <string>(1)...()
+ (Pdb) p x
+ 1
+ (Pdb) c
+ True
+
+Post-mortem debugging with triple verbosity
+
+ >>> sys.argv = 'test --layer samplelayers.Layer1$ -vvv -D'.split()
+ >>> testrunner.run_internal(defaults)
+ Running tests at level 1
+ Running samplelayers.Layer1 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Running:
+ test_x1 (sampletestsf.TestA1) (0.000 s)
+ test_y0 (sampletestsf.TestA1) (0.000 s)
+ test_z0 (sampletestsf.TestA1) (0.000 s)
+ test_x0 (sampletestsf.TestB1) (0.000 s)
+ test_y1 (sampletestsf.TestB1) (0.000 s)
+ test_z0 (sampletestsf.TestB1) (0.000 s)
+ test_1 (sampletestsf.TestNotMuch1) (0.000 s)
+ test_2 (sampletestsf.TestNotMuch1) (0.000 s)
+ test_3 (sampletestsf.TestNotMuch1) (0.000 s)
+ Ran 9 tests with 0 failures and 0 errors in 0.001 seconds.
+ Tearing down left over layers:
+ Tear down samplelayers.Layer1 in 0.000 seconds.
+ False
+
+Test Suites with None for suites or tests
+-----------------------------------------
+
+ >>> sys.argv = ['test',
+ ... '--tests-pattern', '^sampletests_none_suite$',
+ ... ]
+ >>> testrunner.run_internal(defaults)
+ Test-module import failures:
+ <BLANKLINE>
+ Module: sample1.sampletests_none_suite
+ <BLANKLINE>
+ Traceback (most recent call last):
+ TypeError: Invalid test_suite, None, in sample1.sampletests_none_suite
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ Test-modules with import problems:
+ sample1.sampletests_none_suite
+ Total: 0 tests, 0 failures, 0 errors in N.NNN seconds.
+ True
+
+
+ >>> sys.argv = ['test',
+ ... '--tests-pattern', '^sampletests_none_test$',
+ ... ]
+ >>> testrunner.run_internal(defaults)
+ Test-module import failures:
+ <BLANKLINE>
+ Module: sample1.sampletests_none_test
+ <BLANKLINE>
+ Traceback (most recent call last):
+ TypeError: ...
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ Test-modules with import problems:
+ sample1.sampletests_none_test
+ Total: 0 tests, 0 failures, 0 errors in N.NNN seconds.
+ True
+
+You must use --repeat with --report-refcounts
+---------------------------------------------
+
+It is an error to specify --report-refcounts (-r) without specifying a
+repeat count greater than 1
+
+ >>> sys.argv = 'test -r'.split()
+ >>> testrunner.run_internal(defaults)
+ You must use the --repeat (-N) option to specify a repeat
+ count greater than 1 when using the --report_refcounts (-r)
+ option.
+ <BLANKLINE>
+ True
+
+ >>> sys.argv = 'test -r -N1'.split()
+ >>> testrunner.run_internal(defaults)
+ You must use the --repeat (-N) option to specify a repeat
+ count greater than 1 when using the --report_refcounts (-r)
+ option.
+ <BLANKLINE>
+ True
+
=== added file 'src/zope/testing/testrunner/testrunner-errors.txt'
--- src/zope/testing/testrunner/testrunner-errors.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-errors.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,893 @@
+Errors and Failures
+===================
+
+Let's look at tests that have errors and failures, first we need to make a
+temporary copy of the entire testing directory (except .svn files which may
+be read only):
+
+ >>> import os.path, sys, tempfile, shutil
+ >>> tmpdir = tempfile.mkdtemp()
+ >>> directory_with_tests = os.path.join(tmpdir, 'testrunner-ex')
+ >>> source = os.path.join(this_directory, 'testrunner-ex')
+ >>> n = len(source) + 1
+ >>> for root, dirs, files in os.walk(source):
+ ... dirs[:] = [d for d in dirs if d != ".svn"] # prune cruft
+ ... os.mkdir(os.path.join(directory_with_tests, root[n:]))
+ ... for f in files:
+ ... shutil.copy(os.path.join(root, f),
+ ... os.path.join(directory_with_tests, root[n:], f))
+
+ >>> from zope.testing import testrunner
+ >>> defaults = [
+ ... '--path', directory_with_tests,
+ ... '--tests-pattern', '^sampletestsf?$',
+ ... ]
+
+ >>> sys.argv = 'test --tests-pattern ^sampletests(f|_e|_f)?$ '.split()
+ >>> testrunner.run_internal(defaults)
+ ... # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
+ Running samplelayers.Layer1 tests:
+ ...
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ ...
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test eek (sample2.sampletests_e)
+ Failed doctest test for sample2.sampletests_e.eek
+ File "testrunner-ex/sample2/sampletests_e.py", line 28, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_e.py", line 30, in sample2.sampletests_e.eek
+ Failed example:
+ f()
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_e.eek[line 2, example 0]>", line 1, in ?
+ f()
+ File "testrunner-ex/sample2/sampletests_e.py", line 19, in f
+ g()
+ File "testrunner-ex/sample2/sampletests_e.py", line 24, in g
+ x = y + 1
+ - __traceback_info__: I don't know what Y should be.
+ NameError: global name 'y' is not defined
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ Error in test test3 (sample2.sampletests_e.Test)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sampletests_e.py", line 43, in test3
+ f()
+ File "testrunner-ex/sample2/sampletests_e.py", line 19, in f
+ g()
+ File "testrunner-ex/sample2/sampletests_e.py", line 24, in g
+ x = y + 1
+ - __traceback_info__: I don't know what Y should be.
+ NameError: global name 'y' is not defined
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test testrunner-ex/sample2/e.txt
+ Failed doctest test for e.txt
+ File "testrunner-ex/sample2/e.txt", line 0
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/e.txt", line 4, in e.txt
+ Failed example:
+ f()
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest e.txt[line 4, example 1]>", line 1, in ?
+ f()
+ File "<doctest e.txt[line 1, example 0]>", line 2, in f
+ return x
+ NameError: global name 'x' is not defined
+ <BLANKLINE>
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test test (sample2.sampletests_f.Test)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sampletests_f.py", line 21, in test
+ self.assertEqual(1,0)
+ File "/usr/local/python/2.3/lib/python2.3/unittest.py", line 302, in failUnlessEqual
+ raise self.failureException, \
+ AssertionError: 1 != 0
+ <BLANKLINE>
+ Ran 200 tests with 3 failures and 1 errors in N.NNN seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ Total: 413 tests, 3 failures, 1 errors in N.NNN seconds.
+ True
+
+We see that we get an error report and a traceback for the failing
+test. In addition, the test runner returned True, indicating that
+there was an error.
+
+If we ask for verbosity, the dotted output will be interrupted, and
+there'll be a summary of the errors at the end of the test:
+
+ >>> sys.argv = 'test --tests-pattern ^sampletests(f|_e|_f)?$ -uv'.split()
+ >>> testrunner.run_internal(defaults)
+ ... # doctest: +NORMALIZE_WHITESPACE +REPORT_NDIFF
+ Running tests at level 1
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ ...
+ Running:
+ .................................................................................................
+ <BLANKLINE>
+ Failure in test eek (sample2.sampletests_e)
+ Failed doctest test for sample2.sampletests_e.eek
+ File "testrunner-ex/sample2/sampletests_e.py", line 28, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_e.py", line 30,
+ in sample2.sampletests_e.eek
+ Failed example:
+ f()
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_e.eek[line 2, example 0]>", line 1, in ?
+ f()
+ File "testrunner-ex/sample2/sampletests_e.py", line 19, in f
+ g()
+ File "testrunner-ex/sample2/sampletests_e.py", line 24, in g
+ x = y + 1
+ - __traceback_info__: I don't know what Y should be.
+ NameError: global name 'y' is not defined
+ <BLANKLINE>
+ ...
+ <BLANKLINE>
+ <BLANKLINE>
+ Error in test test3 (sample2.sampletests_e.Test)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sampletests_e.py", line 43, in test3
+ f()
+ File "testrunner-ex/sample2/sampletests_e.py", line 19, in f
+ g()
+ File "testrunner-ex/sample2/sampletests_e.py", line 24, in g
+ x = y + 1
+ - __traceback_info__: I don't know what Y should be.
+ NameError: global name 'y' is not defined
+ <BLANKLINE>
+ ...
+ <BLANKLINE>
+ Failure in test testrunner-ex/sample2/e.txt
+ Failed doctest test for e.txt
+ File "testrunner-ex/sample2/e.txt", line 0
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/e.txt", line 4, in e.txt
+ Failed example:
+ f()
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest e.txt[line 4, example 1]>", line 1, in ?
+ f()
+ File "<doctest e.txt[line 1, example 0]>", line 2, in f
+ return x
+ NameError: global name 'x' is not defined
+ <BLANKLINE>
+ .
+ <BLANKLINE>
+ Failure in test test (sample2.sampletests_f.Test)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sampletests_f.py", line 21, in test
+ self.assertEqual(1,0)
+ File ".../unittest.py", line 302, in failUnlessEqual
+ raise self.failureException, \
+ AssertionError: 1 != 0
+ <BLANKLINE>
+ ................................................................................................
+ <BLANKLINE>
+ Ran 200 tests with 3 failures and 1 errors in 0.040 seconds.
+ ...
+ <BLANKLINE>
+ Tests with errors:
+ test3 (sample2.sampletests_e.Test)
+ <BLANKLINE>
+ Tests with failures:
+ eek (sample2.sampletests_e)
+ testrunner-ex/sample2/e.txt
+ test (sample2.sampletests_f.Test)
+ True
+
+Similarly for progress output, the progress ticker will be interrupted:
+
+ >>> sys.argv = ('test --tests-pattern ^sampletests(f|_e|_f)?$ -u -ssample2'
+ ... ' -p').split()
+ >>> testrunner.run_internal(defaults)
+ ... # doctest: +NORMALIZE_WHITESPACE +REPORT_NDIFF
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ Running:
+ 1/56 (1.8%)
+ <BLANKLINE>
+ Failure in test eek (sample2.sampletests_e)
+ Failed doctest test for sample2.sampletests_e.eek
+ File "testrunner-ex/sample2/sampletests_e.py", line 28, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_e.py", line 30,
+ in sample2.sampletests_e.eek
+ Failed example:
+ f()
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_e.eek[line 2, example 0]>", line 1, in ?
+ f()
+ File "testrunner-ex/sample2/sampletests_e.py", line 19, in f
+ g()
+ File "testrunner-ex/sample2/sampletests_e.py", line 24, in g
+ x = y + 1
+ - __traceback_info__: I don't know what Y should be.
+ NameError: global name 'y' is not defined
+ <BLANKLINE>
+ 2/56 (3.6%)##r##
+ ##r##
+ 3/56 (5.4%)##r##
+ ##r##
+ 4/56 (7.1%)
+ <BLANKLINE>
+ Error in test test3 (sample2.sampletests_e.Test)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sampletests_e.py", line 43, in test3
+ f()
+ File "testrunner-ex/sample2/sampletests_e.py", line 19, in f
+ g()
+ File "testrunner-ex/sample2/sampletests_e.py", line 24, in g
+ x = y + 1
+ - __traceback_info__: I don't know what Y should be.
+ NameError: global name 'y' is not defined
+ <BLANKLINE>
+ 5/56 (8.9%)##r##
+ ##r##
+ 6/56 (10.7%)##r##
+ ##r##
+ 7/56 (12.5%)
+ <BLANKLINE>
+ Failure in test testrunner-ex/sample2/e.txt
+ Failed doctest test for e.txt
+ File "testrunner-ex/sample2/e.txt", line 0
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/e.txt", line 4, in e.txt
+ Failed example:
+ f()
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest e.txt[line 4, example 1]>", line 1, in ?
+ f()
+ File "<doctest e.txt[line 1, example 0]>", line 2, in f
+ return x
+ NameError: global name 'x' is not defined
+ <BLANKLINE>
+ 8/56 (14.3%)
+ <BLANKLINE>
+ Failure in test test (sample2.sampletests_f.Test)
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sampletests_f.py", line 21, in test
+ self.assertEqual(1,0)
+ File ".../unittest.py", line 302, in failUnlessEqual
+ raise self.failureException, \
+ AssertionError: 1 != 0
+ <BLANKLINE>
+ 9/56 (16.1%)##r##
+ ##r##
+ 10/56 (17.9%)##r##
+ ##r##
+ 11/56 (19.6%)##r##
+ ##r##
+ 12/56 (21.4%)##r##
+ ##r##
+ 13/56 (23.2%)##r##
+ ##r##
+ 14/56 (25.0%)##r##
+ ##r##
+ 15/56 (26.8%)##r##
+ ##r##
+ 16/56 (28.6%)##r##
+ ##r##
+ 17/56 (30.4%)##r##
+ ##r##
+ 18/56 (32.1%)##r##
+ ##r##
+ 19/56 (33.9%)##r##
+ ##r##
+ 20/56 (35.7%)##r##
+ ##r##
+ 24/56 (42.9%)##r##
+ ##r##
+ 25/56 (44.6%)##r##
+ ##r##
+ 26/56 (46.4%)##r##
+ ##r##
+ 27/56 (48.2%)##r##
+ ##r##
+ 28/56 (50.0%)##r##
+ ##r##
+ 29/56 (51.8%)##r##
+ ##r##
+ 30/56 (53.6%)##r##
+ ##r##
+ 31/56 (55.4%)##r##
+ ##r##
+ 32/56 (57.1%)##r##
+ ##r##
+ 33/56 (58.9%)##r##
+ ##r##
+ 34/56 (60.7%)##r##
+ ##r##
+ 35/56 (62.5%)##r##
+ ##r##
+ 36/56 (64.3%)##r##
+ ##r##
+ 40/56 (71.4%)##r##
+ ##r##
+ 41/56 (73.2%)##r##
+ ##r##
+ 42/56 (75.0%)##r##
+ ##r##
+ 43/56 (76.8%)##r##
+ ##r##
+ 44/56 (78.6%)##r##
+ ##r##
+ 45/56 (80.4%)##r##
+ ##r##
+ 46/56 (82.1%)##r##
+ ##r##
+ 47/56 (83.9%)##r##
+ ##r##
+ 48/56 (85.7%)##r##
+ ##r##
+ 49/56 (87.5%)##r##
+ ##r##
+ 50/56 (89.3%)##r##
+ ##r##
+ 51/56 (91.1%)##r##
+ ##r##
+ 52/56 (92.9%)##r##
+ ##r##
+ 56/56 (100.0%)##r##
+ ##r##
+ Ran 56 tests with 3 failures and 1 errors in 0.054 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ True
+
+If you also want a summary of errors at the end, ask for verbosity as well
+as progress output.
+
+
+Suppressing multiple doctest errors
+-----------------------------------
+
+Often, when a doctest example fails, the failure will cause later
+examples in the same test to fail. Each failure is reported:
+
+ >>> sys.argv = 'test --tests-pattern ^sampletests_1$'.split()
+ >>> testrunner.run_internal(defaults) # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test eek (sample2.sampletests_1)
+ Failed doctest test for sample2.sampletests_1.eek
+ File "testrunner-ex/sample2/sampletests_1.py", line 17, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 19,
+ in sample2.sampletests_1.eek
+ Failed example:
+ x = y
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 2, example 0]>", line 1, in ?
+ x = y
+ NameError: name 'y' is not defined
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 21,
+ in sample2.sampletests_1.eek
+ Failed example:
+ x
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 4, example 1]>", line 1, in ?
+ x
+ NameError: name 'x' is not defined
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 24,
+ in sample2.sampletests_1.eek
+ Failed example:
+ z = x + 1
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 7, example 2]>", line 1, in ?
+ z = x + 1
+ NameError: name 'x' is not defined
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.002 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ True
+
+This can be a bit confusing, especially when there are enough tests
+that they scroll off a screen. Often you just want to see the first
+failure. This can be accomplished with the -1 option (for "just show
+me the first failed example in a doctest" :)
+
+ >>> sys.argv = 'test --tests-pattern ^sampletests_1$ -1'.split()
+ >>> testrunner.run_internal(defaults) # doctest:
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test eek (sample2.sampletests_1)
+ Failed doctest test for sample2.sampletests_1.eek
+ File "testrunner-ex/sample2/sampletests_1.py", line 17, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 19,
+ in sample2.sampletests_1.eek
+ Failed example:
+ x = y
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 2, example 0]>", line 1, in ?
+ x = y
+ NameError: name 'y' is not defined
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.001 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ True
+
+The --hide-secondary-failures option is an alias for -1:
+
+ >>> sys.argv = (
+ ... 'test --tests-pattern ^sampletests_1$'
+ ... ' --hide-secondary-failures'
+ ... ).split()
+ >>> testrunner.run_internal(defaults) # doctest:
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test eek (sample2.sampletests_1)
+ Failed doctest test for sample2.sampletests_1.eek
+ File "testrunner-ex/sample2/sampletests_1.py", line 17, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 19,
+ in sample2.sampletests_1.eek
+ Failed example:
+ x = y
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 2, example 0]>", line 1, in ?
+ x = y
+ NameError: name 'y' is not defined
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.001 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ True
+
+The --show-secondary-failures option counters -1 (or it's alias),
+causing the second and subsequent errors to be shown. This is useful
+if -1 is provided by a test script by inserting it ahead of
+command-line options in sys.argv.
+
+ >>> sys.argv = (
+ ... 'test --tests-pattern ^sampletests_1$'
+ ... ' --hide-secondary-failures --show-secondary-failures'
+ ... ).split()
+ >>> testrunner.run_internal(defaults) # doctest: +NORMALIZE_WHITESPACE
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test eek (sample2.sampletests_1)
+ Failed doctest test for sample2.sampletests_1.eek
+ File "testrunner-ex/sample2/sampletests_1.py", line 17, in eek
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 19,
+ in sample2.sampletests_1.eek
+ Failed example:
+ x = y
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 2, example 0]>", line 1, in ?
+ x = y
+ NameError: name 'y' is not defined
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 21,
+ in sample2.sampletests_1.eek
+ Failed example:
+ x
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 4, example 1]>", line 1, in ?
+ x
+ NameError: name 'x' is not defined
+ ----------------------------------------------------------------------
+ File "testrunner-ex/sample2/sampletests_1.py", line 24,
+ in sample2.sampletests_1.eek
+ Failed example:
+ z = x + 1
+ Exception raised:
+ Traceback (most recent call last):
+ File ".../doctest/__init__.py", line 1256, in __run
+ compileflags, 1) in test.globs
+ File "<doctest sample2.sampletests_1.eek[line 7, example 2]>", line 1, in ?
+ z = x + 1
+ NameError: name 'x' is not defined
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.002 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ True
+
+
+Getting diff output for doctest failures
+----------------------------------------
+
+If a doctest has large expected and actual output, it can be hard to
+see differences when expected and actual output differ. The --ndiff,
+--udiff, and --cdiff options can be used to get diff output of various
+kinds.
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test pledge (pledge)
+ Failed doctest test for pledge.pledge
+ File "testrunner-ex/pledge.py", line 24, in pledge
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/pledge.py", line 26, in pledge.pledge
+ Failed example:
+ print pledge_template % ('and earthling', 'planet'),
+ Expected:
+ I give my pledge, as an earthling,
+ to save, and faithfully, to defend from waste,
+ the natural resources of my planet.
+ It's soils, minerals, forests, waters, and wildlife.
+ Got:
+ I give my pledge, as and earthling,
+ to save, and faithfully, to defend from waste,
+ the natural resources of my planet.
+ It's soils, minerals, forests, waters, and wildlife.
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.002 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+
+Here, the actual output uses the word "and" rather than the word "an",
+but it's a bit hard to pick this out. We can use the various diff
+outputs to see this better. We could modify the test to ask for diff
+output, but it's easier to use one of the diff options.
+
+The --ndiff option requests a diff using Python's ndiff utility. This
+is the only method that marks differences within lines as well as
+across lines. For example, if a line of expected output contains digit
+1 where actual output contains letter l, a line is inserted with a
+caret marking the mismatching column positions.
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ --ndiff'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test pledge (pledge)
+ Failed doctest test for pledge.pledge
+ File "testrunner-ex/pledge.py", line 24, in pledge
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/pledge.py", line 26, in pledge.pledge
+ Failed example:
+ print pledge_template % ('and earthling', 'planet'),
+ Differences (ndiff with -expected +actual):
+ - I give my pledge, as an earthling,
+ + I give my pledge, as and earthling,
+ ? +
+ to save, and faithfully, to defend from waste,
+ the natural resources of my planet.
+ It's soils, minerals, forests, waters, and wildlife.
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.003 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+
+The -udiff option requests a standard "unified" diff:
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ --udiff'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test pledge (pledge)
+ Failed doctest test for pledge.pledge
+ File "testrunner-ex/pledge.py", line 24, in pledge
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/pledge.py", line 26, in pledge.pledge
+ Failed example:
+ print pledge_template % ('and earthling', 'planet'),
+ Differences (unified diff with -expected +actual):
+ @@ -1,3 +1,3 @@
+ -I give my pledge, as an earthling,
+ +I give my pledge, as and earthling,
+ to save, and faithfully, to defend from waste,
+ the natural resources of my planet.
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.002 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+
+The -cdiff option requests a standard "context" diff:
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ --cdiff'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure in test pledge (pledge)
+ Failed doctest test for pledge.pledge
+ File "testrunner-ex/pledge.py", line 24, in pledge
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File "testrunner-ex/pledge.py", line 26, in pledge.pledge
+ Failed example:
+ print pledge_template % ('and earthling', 'planet'),
+ Differences (context diff with expected followed by actual):
+ ***************
+ *** 1,3 ****
+ ! I give my pledge, as an earthling,
+ to save, and faithfully, to defend from waste,
+ the natural resources of my planet.
+ --- 1,3 ----
+ ! I give my pledge, as and earthling,
+ to save, and faithfully, to defend from waste,
+ the natural resources of my planet.
+ <BLANKLINE>
+ Ran 1 tests with 1 failures and 0 errors in 0.002 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+
+Specifying more than one diff option at once causes an error:
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ --cdiff --udiff'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ Traceback (most recent call last):
+ ...
+ SystemExit: 1
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ --cdiff --ndiff'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ Traceback (most recent call last):
+ ...
+ SystemExit: 1
+
+ >>> sys.argv = 'test --tests-pattern ^pledge$ --udiff --ndiff'.split()
+ >>> _ = testrunner.run_internal(defaults)
+ Traceback (most recent call last):
+ ...
+ SystemExit: 1
+
+
+Testing-Module Import Errors
+----------------------------
+
+If there are errors when importing a test module, these errors are
+reported. In order to illustrate a module with a syntax error, we create
+one now: this module used to be checked in to the project, but then it was
+included in distributions of projects using zope.testing too, and distutils
+complained about the syntax error when it compiled Python files during
+installation of such projects. So first we create a module with bad syntax:
+
+ >>> badsyntax_path = os.path.join(directory_with_tests,
+ ... "sample2", "sampletests_i.py")
+ >>> f = open(badsyntax_path, "w")
+ >>> print >> f, "importx unittest" # syntax error
+ >>> f.close()
+
+Then run the tests:
+
+ >>> sys.argv = ('test --tests-pattern ^sampletests(f|_i)?$ --layer 1 '
+ ... ).split()
+ >>> testrunner.run_internal(defaults)
+ ... # doctest: +NORMALIZE_WHITESPACE
+ Test-module import failures:
+ <BLANKLINE>
+ Module: sample2.sampletests_i
+ <BLANKLINE>
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sampletests_i.py", line 1
+ importx unittest
+ ^
+ SyntaxError: invalid syntax
+ <BLANKLINE>
+ <BLANKLINE>
+ Module: sample2.sample21.sampletests_i
+ <BLANKLINE>
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sample21/sampletests_i.py", line 15, in ?
+ import zope.testing.huh
+ ImportError: No module named huh
+ <BLANKLINE>
+ <BLANKLINE>
+ Module: sample2.sample23.sampletests_i
+ <BLANKLINE>
+ Traceback (most recent call last):
+ File "testrunner-ex/sample2/sample23/sampletests_i.py", line 18, in ?
+ class Test(unittest.TestCase):
+ File "testrunner-ex/sample2/sample23/sampletests_i.py", line 23, in Test
+ raise TypeError('eek')
+ TypeError: eek
+ <BLANKLINE>
+ <BLANKLINE>
+ Running samplelayers.Layer1 tests:
+ Set up samplelayers.Layer1 in 0.000 seconds.
+ Ran 9 tests with 0 failures and 0 errors in 0.000 seconds.
+ Running samplelayers.Layer11 tests:
+ Set up samplelayers.Layer11 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Running samplelayers.Layer111 tests:
+ Set up samplelayers.Layerx in 0.000 seconds.
+ Set up samplelayers.Layer111 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Running samplelayers.Layer112 tests:
+ Tear down samplelayers.Layer111 in 0.000 seconds.
+ Set up samplelayers.Layer112 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Running samplelayers.Layer12 tests:
+ Tear down samplelayers.Layer112 in 0.000 seconds.
+ Tear down samplelayers.Layerx in 0.000 seconds.
+ Tear down samplelayers.Layer11 in 0.000 seconds.
+ Set up samplelayers.Layer12 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Running samplelayers.Layer121 tests:
+ Set up samplelayers.Layer121 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.007 seconds.
+ Running samplelayers.Layer122 tests:
+ Tear down samplelayers.Layer121 in 0.000 seconds.
+ Set up samplelayers.Layer122 in 0.000 seconds.
+ Ran 34 tests with 0 failures and 0 errors in 0.006 seconds.
+ Tearing down left over layers:
+ Tear down samplelayers.Layer122 in 0.000 seconds.
+ Tear down samplelayers.Layer12 in 0.000 seconds.
+ Tear down samplelayers.Layer1 in 0.000 seconds.
+ <BLANKLINE>
+ Test-modules with import problems:
+ sample2.sampletests_i
+ sample2.sample21.sampletests_i
+ sample2.sample23.sampletests_i
+ Total: 213 tests, 0 failures, 0 errors in N.NNN seconds.
+ True
+
+
+Unicode Errors
+--------------
+
+There was a bug preventing decent error reporting when a result contained
+unicode and another not:
+
+ >>> sys.argv = 'test --tests-pattern ^unicode$ -u'.split()
+ >>> testrunner.run_internal(defaults) # doctest: +REPORT_NDIFF
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ <BLANKLINE>
+ <BLANKLINE>
+ Failure testrunner-ex/unicode.txt
+ Failed doctest test for unicode.txt
+ testrunner-ex/unicode.txt", line 0
+ <BLANKLINE>
+ ----------------------------------------------------------------------
+ File testrunner-ex/unicode.txt", Line NNN, in unicode.txt
+ Failed example:
+ print get_unicode()
+ Expected:
+ oink
+ Got:
+ foo — bar
+ ----------------------------------------------------------------------
+ File testrunner-ex/unicode.txt", Line NNN, in unicode.txt
+ Failed example:
+ 'xyz'
+ Expected:
+ 123
+ Got:
+ 'xyz'
+ <BLANKLINE>
+ Ran 3 tests with 1 failures and 0 errors in N.NNN seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ True
+
+
+Reporting Errors to Calling Processes
+-------------------------------------
+
+The testrunner returns the error status, indicating that the tests
+failed. This can be useful for an invoking process that wants to
+monitor the result of a test run.
+
+This is applied when invoking the testrunner using the ``run()`` function
+instead of ``run_internal()``:
+
+ >>> sys.argv = (
+ ... 'test --tests-pattern ^sampletests_1$'.split())
+ >>> try:
+ ... testrunner.run(defaults)
+ ... except SystemExit, e:
+ ... print 'exited with code', e.code
+ ... else:
+ ... print 'sys.exit was not called'
+ ... # doctest: +ELLIPSIS
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ ...
+ Ran 1 tests with 1 failures and 0 errors in 0.002 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ exited with code 1
+
+Passing tests exit with code 0 according to UNIX practices:
+
+ >>> sys.argv = (
+ ... 'test --tests-pattern ^sampletests$'.split())
+ >>> try:
+ ... testrunner.run(defaults)
+ ... except SystemExit, e2:
+ ... print 'exited with code', e2.code
+ ... else:
+ ... print 'sys.exit was not called'
+ ... # doctest: +ELLIPSIS
+ Running samplelayers.Layer11 tests:
+ ...
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Tear down samplelayers.Layer122 in N.NNN seconds.
+ Tear down samplelayers.Layer12 in N.NNN seconds.
+ Tear down samplelayers.Layer1 in N.NNN seconds.
+ Set up zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ Ran 160 tests with 0 failures and 0 errors in N.NNN seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in N.NNN seconds.
+ Total: 364 tests, 0 failures, 0 errors in N.NNN seconds.
+ exited with code 0
+
+And remove the temporary directory:
+
+ >>> shutil.rmtree(tmpdir)
=== added directory 'src/zope/testing/testrunner/testrunner-ex'
=== added directory 'src/zope/testing/testrunner/testrunner-ex-251759'
=== added directory 'src/zope/testing/testrunner/testrunner-ex-251759/eggs'
=== added directory 'src/zope/testing/testrunner/testrunner-ex-251759/eggs/foo.bar-1.2-py2.5.egg'
=== added directory 'src/zope/testing/testrunner/testrunner-ex-251759/eggs/foo.bar-1.2-py2.5.egg/foo'
=== added file 'src/zope/testing/testrunner/testrunner-ex-251759/eggs/foo.bar-1.2-py2.5.egg/foo/__init__.py'
=== added directory 'src/zope/testing/testrunner/testrunner-ex-251759/eggs/foo.bar-1.2-py2.5.egg/foo/bar'
=== added file 'src/zope/testing/testrunner/testrunner-ex-251759/eggs/foo.bar-1.2-py2.5.egg/foo/bar/__init__.py'
=== added file 'src/zope/testing/testrunner/testrunner-ex-251759/eggs/foo.bar-1.2-py2.5.egg/foo/bar/tests.py'
=== added file 'src/zope/testing/testrunner/testrunner-ex-251759/eggs/foo.bar-1.2-py2.5.egg/test.py'
=== added directory 'src/zope/testing/testrunner/testrunner-ex-pp-lib'
=== added directory 'src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4'
=== added file 'src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added directory 'src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4/products'
=== added file 'src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4/products/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4/products/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex-pp-lib/sample4/products/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,33 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Sample package that knits in extra directories.
+
+$Id: __init__.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import os
+
+__path__.append(
+ os.path.join(
+ os.path.dirname( # testing
+ os.path.dirname( # testrunner-ex-knit-lib
+ os.path.dirname( # sample4
+ os.path.dirname(__file__) # products
+ )
+ )
+ )
+ , "testrunner-ex-pp-products"
+ )
+ )
+
=== added directory 'src/zope/testing/testrunner/testrunner-ex-pp-products'
=== added file 'src/zope/testing/testrunner/testrunner-ex-pp-products/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex-pp-products/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex-pp-products/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added directory 'src/zope/testing/testrunner/testrunner-ex-pp-products/more'
=== added file 'src/zope/testing/testrunner/testrunner-ex-pp-products/more/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex-pp-products/more/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex-pp-products/more/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added file 'src/zope/testing/testrunner/testrunner-ex-pp-products/more/sampletests.py'
--- src/zope/testing/testrunner/testrunner-ex-pp-products/more/sampletests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex-pp-products/more/sampletests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,25 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+
+class Test(unittest.TestCase):
+
+ layer = 'samplelayers.Layer111'
+
+ def test_another_test_in_products(self):
+ pass
+
+def test_suite():
+ return unittest.makeSuite(Test)
=== added file 'src/zope/testing/testrunner/testrunner-ex-pp-products/sampletests.py'
--- src/zope/testing/testrunner/testrunner-ex-pp-products/sampletests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex-pp-products/sampletests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,25 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+
+class Test(unittest.TestCase):
+
+ layer = 'samplelayers.Layer111'
+
+ def test_extra_test_in_products(self):
+ pass
+
+def test_suite():
+ return unittest.makeSuite(Test)
=== added file 'src/zope/testing/testrunner/testrunner-ex/README.txt'
--- src/zope/testing/testrunner/testrunner-ex/README.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/README.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,2 @@
+This directory and its subdirectories contain example tests for
+testing the test runner, testrunner.py.
=== added file 'src/zope/testing/testrunner/testrunner-ex/brokenlayer.py'
--- src/zope/testing/testrunner/testrunner-ex/brokenlayer.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/brokenlayer.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,61 @@
+##############################################################################
+#
+# Copyright (c) 2012 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Sample tests with layers that have broken set up and tear down.
+"""
+
+import unittest
+
+class BrokenSetUpLayer:
+
+ @classmethod
+ def setUp(cls):
+ raise ValueError('No value is good enough for me!')
+
+ @classmethod
+ def tearDown(cls):
+ pass
+
+
+class BrokenTearDownLayer:
+
+ @classmethod
+ def setUp(cls):
+ pass
+
+ @classmethod
+ def tearDown(cls):
+ raise TypeError('You are not my type. No-one is my type!')
+
+
+class TestSomething1(unittest.TestCase):
+
+ layer = BrokenSetUpLayer
+
+ def test_something(self):
+ pass
+
+
+class TestSomething2(unittest.TestCase):
+
+ layer = BrokenTearDownLayer
+
+ def test_something(self):
+ pass
+
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestSomething1))
+ suite.addTest(unittest.makeSuite(TestSomething2))
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/gc0.py'
--- src/zope/testing/testrunner/testrunner-ex/gc0.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/gc0.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,25 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+from zope.testing import doctest
+
+def make_sure_gc_is_disabled():
+ """
+ >>> import gc
+ >>> gc.get_threshold()[0]
+ 0
+ """
+
+def test_suite():
+ return doctest.DocTestSuite()
+
=== added file 'src/zope/testing/testrunner/testrunner-ex/gc1.py'
--- src/zope/testing/testrunner/testrunner-ex/gc1.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/gc1.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,25 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+from zope.testing import doctest
+
+def make_sure_gc_threshold_is_one():
+ """
+ >>> import gc
+ >>> gc.get_threshold()[0]
+ 1
+ """
+
+def test_suite():
+ return doctest.DocTestSuite()
+
=== added file 'src/zope/testing/testrunner/testrunner-ex/gcset.py'
--- src/zope/testing/testrunner/testrunner-ex/gcset.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/gcset.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,25 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+from zope.testing import doctest
+
+def make_sure_gc_threshold_is_701_11_9():
+ """
+ >>> import gc
+ >>> gc.get_threshold()
+ (701, 11, 9)
+ """
+
+def test_suite():
+ return doctest.DocTestSuite()
+
=== added file 'src/zope/testing/testrunner/testrunner-ex/gcstats.py'
--- src/zope/testing/testrunner/testrunner-ex/gcstats.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/gcstats.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,25 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+from zope.testing import doctest
+
+def generate_some_gc_statistics():
+ """
+ >>> import gc
+ >>> l = []; l.append(l); del l
+ >>> _ = gc.collect()
+ """
+
+def test_suite():
+ return doctest.DocTestSuite()
+
=== added file 'src/zope/testing/testrunner/testrunner-ex/leak.py'
--- src/zope/testing/testrunner/testrunner-ex/leak.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/leak.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,39 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest, time
+
+class ClassicLeakable:
+ def __init__(self):
+ self.x = 'x'
+
+class Leakable(object):
+ def __init__(self):
+ self.x = 'x'
+
+leaked = []
+
+class TestSomething(unittest.TestCase):
+
+ def testleak(self):
+ leaked.append((ClassicLeakable(), Leakable(), time.time()))
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestSomething))
+ return suite
+
+
+if __name__ == '__main__':
+ unittest.main()
=== added file 'src/zope/testing/testrunner/testrunner-ex/pledge.py'
--- src/zope/testing/testrunner/testrunner-ex/pledge.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/pledge.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,34 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+from zope.testing import doctest
+
+pledge_template = """\
+I give my pledge, as %s,
+to save, and faithfully, to defend from waste,
+the natural resources of my %s.
+It's soils, minerals, forests, waters, and wildlife.
+"""
+
+def pledge():
+ """
+ >>> print pledge_template % ('and earthling', 'planet'),
+ I give my pledge, as an earthling,
+ to save, and faithfully, to defend from waste,
+ the natural resources of my planet.
+ It's soils, minerals, forests, waters, and wildlife.
+ """
+
+def test_suite():
+ return doctest.DocTestSuite()
+
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample1'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample1/sample11'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sample11/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sample11/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sample11/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample1/sample11/sampletests'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sample11/sampletests.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sample11/sampletests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sample11/sampletests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,123 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestA3(unittest.TestCase):
+
+ level = 3
+
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB2(unittest.TestCase):
+ level = 2
+
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestA3))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestB2))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ suite.addTest(doctest.DocTestSuite(setUp=setUp))
+ suite.addTest(doctest.DocFileSuite('../../sampletests.txt',
+ setUp=setUp))
+ return suite
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample1/sample12'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sample12/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sample12/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sample12/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample1/sample12/sampletests'
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample1/sample13'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sample13/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sample13/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sample13/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sample13/sampletests.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sample13/sampletests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sample13/sampletests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ suite.addTest(doctest.DocTestSuite(setUp=setUp))
+ suite.addTest(doctest.DocFileSuite('../../sampletests.txt',
+ setUp=setUp))
+ return suite
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test1.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test1.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test1.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ suite.addTest(doctest.DocTestSuite(setUp=setUp))
+ suite.addTest(doctest.DocFileSuite('../../sampletests.txt',
+ setUp=setUp))
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test11.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test11.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test11.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,127 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+import samplelayers
+
+layername = 'samplelayers.Layer11'
+layer = samplelayers.Layer11
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+class TestB(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+
+class TestNotMuch(unittest.TestCase):
+ layer = layername
+
+ def test_1(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_2(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_3(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+def setUp(test):
+ test.globs['z'] = 1
+ test.globs['layer'] = layer.layer
+ test.globs['layerx'] = layer.layerx
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ s = doctest.DocTestSuite(setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ s = doctest.DocFileSuite('../../sampletestsl.txt', setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test111.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test111.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test111.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,127 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+import samplelayers
+
+layername = 'samplelayers.Layer111'
+layer = samplelayers.Layer111
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+class TestB(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+
+class TestNotMuch(unittest.TestCase):
+ layer = layername
+
+ def test_1(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_2(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_3(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+def setUp(test):
+ test.globs['z'] = 1
+ test.globs['layer'] = layer.layer
+ test.globs['layerx'] = layer.layerx
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ s = doctest.DocTestSuite(setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ s = doctest.DocFileSuite('../../sampletestsl.txt', setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test112.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test112.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test112.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,128 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+import samplelayers
+
+layername = 'samplelayers.Layer112'
+layer = samplelayers.Layer112
+
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+class TestB(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+
+class TestNotMuch(unittest.TestCase):
+ layer = layername
+
+ def test_1(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_2(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_3(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+def setUp(test):
+ test.globs['z'] = 1
+ test.globs['layer'] = layer.layer
+ test.globs['layerx'] = layer.layerx
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ s = doctest.DocTestSuite(setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ s = doctest.DocFileSuite('../../sampletestsl.txt', setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test12.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test12.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test12.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,127 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+import samplelayers
+
+layername = 'samplelayers.Layer12'
+layer = samplelayers.Layer12
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+class TestB(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+
+class TestNotMuch(unittest.TestCase):
+ layer = layername
+
+ def test_1(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_2(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_3(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+def setUp(test):
+ test.globs['z'] = 1
+ test.globs['layer'] = layer.layer
+ test.globs['layerx'] = layer.layerx
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ s = doctest.DocTestSuite(setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ s = doctest.DocFileSuite('../../sampletestsl.txt', setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test121.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test121.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test121.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,127 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+import samplelayers
+
+layername = 'samplelayers.Layer121'
+layer = samplelayers.Layer121
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+class TestB(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+
+class TestNotMuch(unittest.TestCase):
+ layer = layername
+
+ def test_1(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_2(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_3(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+def setUp(test):
+ test.globs['z'] = 1
+ test.globs['layer'] = layer.layer
+ test.globs['layerx'] = layer.layerx
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ s = doctest.DocTestSuite(setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ s = doctest.DocFileSuite('../../sampletestsl.txt', setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test122.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test122.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test122.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,127 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+import samplelayers
+
+layername = 'samplelayers.Layer122'
+layer = samplelayers.Layer122
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+class TestB(unittest.TestCase):
+ layer = layername
+
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+
+class TestNotMuch(unittest.TestCase):
+ layer = layername
+
+ def test_1(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_2(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+ def test_3(self):
+ self.assertEqual(samplelayers.layer, layer.layer)
+ self.assertEqual(samplelayers.layerx, layer.layerx)
+
+def setUp(test):
+ test.globs['z'] = 1
+ test.globs['layer'] = layer.layer
+ test.globs['layerx'] = layer.layerx
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+
+ >>> (layer == samplelayers.layer), (layerx == samplelayers.layerx)
+ (True, True)
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ s = doctest.DocTestSuite(setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ s = doctest.DocFileSuite('../../sampletestsl.txt', setUp=setUp)
+ s.layer = layer
+ suite.addTest(s)
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test_one.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test_one.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests/test_one.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ suite.addTest(doctest.DocTestSuite(setUp=setUp))
+ suite.addTest(doctest.DocFileSuite('../../sampletests.txt',
+ setUp=setUp))
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_discover.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_discover.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_discover.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,5 @@
+import unittest
+
+class TestA(unittest.TestCase):
+ def test_truth(self):
+ self.assert_(True)
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_discover_notests.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_discover_notests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_discover_notests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,2 @@
+def test_function_that_would_never_be_run():
+ self.assert_(True)
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_none_suite.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_none_suite.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_none_suite.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,20 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Sample tests with a layer that can't be torn down
+
+$Id: sampletests_none_suite.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+def test_suite():
+ pass
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_none_test.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_none_test.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_none_test.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,24 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Sample tests with a layer that can't be torn down
+
+$Id: sampletests_none_test.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import unittest
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(None)
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_ntd.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_ntd.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_ntd.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,46 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Sample tests with a layer that can't be torn down
+
+$Id: sampletests_ntd.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import unittest
+
+class Layer:
+
+ def setUp(self):
+ pass
+ setUp = classmethod(setUp)
+
+ def tearDown(self):
+ raise NotImplementedError
+ tearDown = classmethod(tearDown)
+
+class TestSomething(unittest.TestCase):
+
+ layer = Layer
+
+ def test_something(self):
+ pass
+
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestSomething))
+ return suite
+
+
+if __name__ == '__main__':
+ unittest.main()
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_ntds.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_ntds.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletests_ntds.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,46 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Sample tests with a layer that can't be torn down
+
+$Id: sampletests_ntds.py 110538 2010-04-06 03:02:54Z tseaver $
+"""
+
+import unittest
+
+class Layer:
+
+ def setUp(self):
+ pass
+ setUp = classmethod(setUp)
+
+ def tearDown(self):
+ raise NotImplementedError
+ tearDown = classmethod(tearDown)
+
+class TestSomething(unittest.TestCase):
+
+ layer = Layer
+
+ def test_something(self):
+ pass
+
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestSomething))
+ return suite
+
+
+if __name__ == '__main__':
+ unittest.main()
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample1/sampletestsf.py'
--- src/zope/testing/testrunner/testrunner-ex/sample1/sampletestsf.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample1/sampletestsf.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ suite.addTest(doctest.DocTestSuite(setUp=setUp))
+ suite.addTest(doctest.DocFileSuite('../sampletests.txt',
+ setUp=setUp))
+ return suite
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2/do-not-enter'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/do-not-enter/sampletests.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/do-not-enter/sampletests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/do-not-enter/sampletests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,56 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+def f():
+ g()
+
+def g():
+ x = 1
+ x = x + 1
+ x = y + 1
+ x = x + 1
+
+
+def eek(self):
+ """
+ >>> f()
+ 1
+ """
+
+class Test(unittest.TestCase):
+
+ def test1(self):
+ pass
+
+ def test2(self):
+ pass
+
+ def test3(self):
+ f()
+
+ def test4(self):
+ pass
+
+ def test5(self):
+ pass
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(doctest.DocTestSuite())
+ suite.addTest(unittest.makeSuite(Test))
+ suite.addTest(doctest.DocFileSuite('e.txt'))
+ return suite
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2/donotenter'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/donotenter/sampletests.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/donotenter/sampletests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/donotenter/sampletests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,56 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+def f():
+ g()
+
+def g():
+ x = 1
+ x = x + 1
+ x = y + 1
+ x = x + 1
+
+
+def eek(self):
+ """
+ >>> f()
+ 1
+ """
+
+class Test(unittest.TestCase):
+
+ def test1(self):
+ pass
+
+ def test2(self):
+ pass
+
+ def test3(self):
+ f()
+
+ def test4(self):
+ pass
+
+ def test5(self):
+ pass
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(doctest.DocTestSuite())
+ suite.addTest(unittest.makeSuite(Test))
+ suite.addTest(doctest.DocFileSuite('e.txt'))
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/e.txt'
--- src/zope/testing/testrunner/testrunner-ex/sample2/e.txt 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/e.txt 2012-06-06 16:03:24 +0000
@@ -0,0 +1,4 @@
+ >>> def f():
+ ... return x
+
+ >>> f()
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2/sample21'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sample21/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sample21/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sample21/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sample21/sampletests.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sample21/sampletests.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sample21/sampletests.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ suite.addTest(doctest.DocTestSuite(setUp=setUp))
+ suite.addTest(doctest.DocFileSuite('../../sampletests.txt',
+ setUp=setUp))
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sample21/sampletests_i.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sample21/sampletests_i.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sample21/sampletests_i.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,24 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+import zope.testing.huh
+
+class Test(unittest.TestCase):
+
+ def test(self):
+ self.assertEqual(1,0)
+
+def test_suite():
+ return unittest.makeSuite(Test)
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2/sample22'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sample22/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sample22/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sample22/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2/sample22/sampletests'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sample22/sampletests_i.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sample22/sampletests_i.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sample22/sampletests_i.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,23 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+
+class Test(unittest.TestCase):
+
+ def test(self):
+ self.assertEqual(1,0)
+
+def test_suitex():
+ return unittest.makeSuite(Test)
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2/sample23'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sample23/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sample23/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sample23/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sample23/sampletests_i.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sample23/sampletests_i.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sample23/sampletests_i.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,25 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+
+class Test(unittest.TestCase):
+
+ def test(self):
+ self.assertEqual(1,0)
+
+ raise TypeError('eek')
+
+def test_suite():
+ return unittest.makeSuite(Test)
=== added directory 'src/zope/testing/testrunner/testrunner-ex/sample2/sampletests'
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/__init__.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/__init__.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/__init__.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,1 @@
+#
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/test_1.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/test_1.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/test_1.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestA))
+ suite.addTest(unittest.makeSuite(TestB))
+ suite.addTest(unittest.makeSuite(TestNotMuch))
+ suite.addTest(doctest.DocTestSuite(setUp=setUp))
+ suite.addTest(doctest.DocFileSuite('../../sampletests.txt',
+ setUp=setUp))
+ return suite
=== added file 'src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/testone.py'
--- src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/testone.py 1970-01-01 00:00:00 +0000
+++ src/zope/testing/testrunner/testrunner-ex/sample2/sampletests/testone.py 2012-06-06 16:03:24 +0000
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2003 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+import unittest
+from zope.testing import doctest
+
+x=0
+y=0
+z=0
+
+class TestA(unittest.TestCase):
+ def setUp(self):
+ global x
+ x = 1
+ def tearDown(self):
+ global x
+ x = 0
+ def test_x1(self):
+ self.assertEqual(x, 1)
+ def test_y0(self):
+ self.assertEqual(y, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+class TestB(unittest.TestCase):
+ def setUp(self):
+ global y
+ y = 1
+ def tearDown(self):
+ global y
+ y = 0
+ def test_y1(self):
+ self.assertEqual(y, 1)
+ def test_x0(self):
+ self.assertEqual(x, 0)
+ def test_z0(self):
+ self.assertEqual(z, 0)
+
+
+class TestNotMuch(unittest.TestCase):
+ def test_1(self):
+ pass
+ def test_2(self):
+ pass
+ def test_3(self):
+ pass
+
+def setUp(test):
+ test.globs['z'] = 1
+
+def test_y0(self):
+ """
+ >>> y
+ 0
+ """
+
+def test_x0(self):
+ """
+ >>> x
+ 0
+ """
+
+def test_z1(self):
+ """
+ >>> z
+ 1
+ """
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unitte
