[Zope3-checkins] SVN: zope.testing/trunk/ Updated documentation and
release data. The update of the
Jim Fulton
jim at zope.com
Wed Sep 20 17:27:33 EDT 2006
Log message for revision 70271:
Updated documentation and release data. The update of the
documentation was motivated by a desire to publish the documentation
at: http://www.python.org/pypi/zope.testing.
Changed:
U zope.testing/trunk/CHANGES.txt
U zope.testing/trunk/README.txt
U zope.testing/trunk/setup.py
U zope.testing/trunk/src/zope/testing/formparser.txt
U zope.testing/trunk/src/zope/testing/testrunner-arguments.txt
U zope.testing/trunk/src/zope/testing/testrunner-coverage-win32.txt
U zope.testing/trunk/src/zope/testing/testrunner-coverage.txt
U zope.testing/trunk/src/zope/testing/testrunner-debugging.txt
U zope.testing/trunk/src/zope/testing/testrunner-errors.txt
U zope.testing/trunk/src/zope/testing/testrunner-gc.txt
U zope.testing/trunk/src/zope/testing/testrunner-knit.txt
U zope.testing/trunk/src/zope/testing/testrunner-layers-api.txt
U zope.testing/trunk/src/zope/testing/testrunner-layers-ntd.txt
U zope.testing/trunk/src/zope/testing/testrunner-layers.txt
U zope.testing/trunk/src/zope/testing/testrunner-leaks-err.txt
U zope.testing/trunk/src/zope/testing/testrunner-leaks.txt
U zope.testing/trunk/src/zope/testing/testrunner-progress.txt
U zope.testing/trunk/src/zope/testing/testrunner-repeat.txt
U zope.testing/trunk/src/zope/testing/testrunner-simple.txt
U zope.testing/trunk/src/zope/testing/testrunner-test-selection.txt
U zope.testing/trunk/src/zope/testing/testrunner-verbose.txt
U zope.testing/trunk/src/zope/testing/testrunner-wo-source.txt
-=-
Modified: zope.testing/trunk/CHANGES.txt
===================================================================
--- zope.testing/trunk/CHANGES.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/CHANGES.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,8 @@
-zope.testing Package Changelog
-=============================
+zope.testing Changelog
+**********************
-zope.testing version 3.0
-------------------------
+3.0 (2006/09/20)
+================
- Updated the doctest copy with text-file encoding support
@@ -17,18 +17,17 @@
- Made zope.exception required only if the zope_tracebacks extra is
requested.
+2.x.y (???)
+===========
-zope.testing version 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 direcotry/package, then it was also ignored there, because the
ignore cache stored the result by module name and not the filename of the
module.
-zope.testing version 2.0 (2006/01/05)
---------------------------------------
+2.0 (2006/01/05)
+================
- Corresponds to the verison of the zope.testing package shipped as part of
the Zope 3.2.0 release.
Modified: zope.testing/trunk/README.txt
===================================================================
--- zope.testing/trunk/README.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/README.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,99 +1,41 @@
-========================================
-zope.testing package Readme
-========================================
+************
+zope.testing
+************
+.. contents::
+
This package provides a flexible testing framework. It includes a
flexible test runner, and supports both doctest and unittest.
-Additional Zope-specific testing features are in the zope.app.testing
-package.
-
-
cleanup.py
------------
+ Provides a mixin class for cleaning up after tests that
+ make global changes.
-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).
-Enhanced version of python's standard doctest.py.
-Better test count (one per block instead of one per docstring).
+ (We need to merge this with the standard doctest module.)
formparser.py
---------------
+ An HTML parser that extracts form information.
-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.
-This is intended to support functional tests that need to extract
-information from HTML forms returned by the publisher.
-
-See *formparser.txt* for documentation.
-
loggingsupport.py
------------------------
+ Support for testing logging code
-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.
-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.
-Logging handler for tests that check logging output.
-
-
renormalizing.py
------------------
+ Regular expression pattern normalizing output checker.
+ Useful for doctests.
-Regular expression pattern normalizing output checker.
-Useful for doctests.
-
-
testrunner.py
---------------
-
-The test runner module. This is typically wrapped by a test.py script that
-sets up options to run a particular set of tests.
-
-For overview of usage, see testrunner.txt.
-
-tests.py
----------
-
-Test script for the testing package. Invokes testrunner.
-
-
-Changes
--------
-
-See CHANGES.txt.
-
-
-Installation
-------------
-
-See INSTALL.txt.
-
-
-Developer Resources
--------------------
-
-- Subversion browser:
-
- http://svn.zope.org/zope.testing/
-
-- Read-only Subversion checkout:
-
- $ svn co svn://svn.zope.org/repos/main/zope.testing/trunk
-
-- Writable Subversion checkout:
-
- $ svn co svn://svn.zope.org/repos/main/zope.testing/trunk
-
-- Note that the 'src/zope/testing' package is acutally a 'svn:externals' link
- to the corresponding package in the Zope3 trunk (or to a specific tag,
- for released versions of the package).
+ The test runner module. This is typically wrapped by a test.py script that
+ sets up options to run a particular set of tests.
Modified: zope.testing/trunk/setup.py
===================================================================
--- zope.testing/trunk/setup.py 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/setup.py 2006-09-20 21:27:32 UTC (rev 70271)
@@ -22,21 +22,54 @@
from setuptools import setup
except ImportError, e:
from distutils.core import setup
+
+chapters = '\n'.join([
+ open(os.path.join('src', 'zope', 'testing', 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',
+ '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',
+ 'formparser.txt',
+ )])
-setup(name='zope.testing',
- version='3.0',
- url='http://svn.zope.org/zope.testing',
- license='ZPL 2.1',
- description='Zope testing framework, including the testrunner script.',
- author='Zope Corporation and Contributors',
- author_email='zope3-dev at zope.org',
-
- packages=["zope", "zope.testing"],
- package_dir = {'': 'src'},
-
- namespace_packages=['zope',],
- extras_require={'zope_tracebacks': 'zope.exceptions'},
- include_package_data = True,
-
- zip_safe = False,
- )
+setup(
+ name='zope.testing',
+ version='3.0',
+ url='http://svn.zope.org/zope.testing',
+ license='ZPL 2.1',
+ description='Zope testing framework, including the testrunner script.',
+ long_description=(
+ open('README.txt').read()
+ + '\n' +
+ open('CHANGES.txt').read()
+ + '\n' +
+ 'Detailed Documentation\n'
+ '**********************\n'
+ + '\n' + chapters
+ ),
+ author='Zope Corporation and Contributors',
+ author_email='zope3-dev at zope.org',
+
+ packages=["zope", "zope.testing"],
+ package_dir = {'': 'src'},
+
+ namespace_packages=['zope',],
+ extras_require={'zope_tracebacks': 'zope.exceptions'},
+ include_package_data = True,
+ zip_safe = False,
+ )
Modified: zope.testing/trunk/src/zope/testing/formparser.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/formparser.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/formparser.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,4 +1,3 @@
-==================
Parsing HTML Forms
==================
Modified: zope.testing/trunk/src/zope/testing/testrunner-arguments.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-arguments.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-arguments.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
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
Modified: zope.testing/trunk/src/zope/testing/testrunner-coverage-win32.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-coverage-win32.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-coverage-win32.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Code Coverage
--------------
+=============
On Windows drive names can be upper and lower case, these can be
randomly passed to TestIgnore.names.
@@ -31,4 +28,4 @@
>>> ignore.names('r:\\winproject\\src\\blah\\hello.py', 'hello')
True
>>> ignore.names('R:\\winproject\\src\\blah\\hello.py', 'hello')
- True
\ No newline at end of file
+ True
Modified: zope.testing/trunk/src/zope/testing/testrunner-coverage.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-coverage.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-coverage.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
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.
Modified: zope.testing/trunk/src/zope/testing/testrunner-debugging.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-debugging.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-debugging.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Debugging
----------
+=========
The testrunner module supports post-mortem debugging and debugging
using `pdb.set_trace`. Let's look first at using `pdb.set_trace`.
Modified: zope.testing/trunk/src/zope/testing/testrunner-errors.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-errors.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-errors.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Errors and Failures
--------------------
+===================
Let's look at tests that have errors and failures:
Modified: zope.testing/trunk/src/zope/testing/testrunner-gc.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-gc.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-gc.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Garbage Collection Control
---------------------------
+==========================
When having problems that seem to be caused my memory-management
errors, it can be helpful to adjust Python's cyclic garbage collector
Modified: zope.testing/trunk/src/zope/testing/testrunner-knit.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-knit.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-knit.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Knitting in extra package directories
--------------------------------------
+=====================================
Python packages have __path__ variables that can be manipulated to add
extra directories cntaining software used in the packages. The
Modified: zope.testing/trunk/src/zope/testing/testrunner-layers-api.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-layers-api.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-layers-api.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,9 +1,6 @@
-Test Runner
-===========
+Layers
+======
-The Layers API
---------------
-
A Layer is an object providing setup and teardown methods used to setup
and teardown the environment provided by the layer. It may also provide
setup and teardown methods used to reset the environment provided by the
Modified: zope.testing/trunk/src/zope/testing/testrunner-layers-ntd.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-layers-ntd.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-layers-ntd.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Layers that can't be torn down
-------------------------------
+==============================
A layer can have a tearDown method that raises NotImplementedError.
If this is the case and there are no remaining tests to run, the test
Modified: zope.testing/trunk/src/zope/testing/testrunner-layers.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-layers.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-layers.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Layer Selection
----------------
+===============
We can select which layers to run using the --layer option:
Modified: zope.testing/trunk/src/zope/testing/testrunner-leaks-err.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-leaks-err.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-leaks-err.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Debugging Memory Leaks without a debug build of Python
-------------------------------------------------------
+======================================================
To use the --report-refcounts (-r) to detect or debug memory leaks,
you must have a debug build of Python. Without a debug build, you will
Modified: zope.testing/trunk/src/zope/testing/testrunner-leaks.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-leaks.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-leaks.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Debugging Memory Leaks
-----------------------
+======================
The --report-refcounts (-r) option can be used with the --repeat (-N)
option to detect and diagnose memory leaks. To use this option, you
Modified: zope.testing/trunk/src/zope/testing/testrunner-progress.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-progress.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-progress.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Test Progress
--------------
+=============
If the --progress (-p) option is used, progress information is printed and
a carriage return (rather than a new-line) is printed between
Modified: zope.testing/trunk/src/zope/testing/testrunner-repeat.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-repeat.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-repeat.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Repeating Tests
----------------
+===============
The --repeat option can be used to repeat tests some number of times.
Repeating tests is useful to help make sure that tests clean up after
Modified: zope.testing/trunk/src/zope/testing/testrunner-simple.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-simple.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-simple.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Simple Usage
-------------
+============
The test runner consists of an importable module. The test runner is
used by providing scripts that import and invoke the `run` method from
Modified: zope.testing/trunk/src/zope/testing/testrunner-test-selection.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-test-selection.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-test-selection.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,9 +1,5 @@
-Test Runner
-===========
-
-
Test Selection
---------------
+==============
We've already seen that we can select tests by layer. There are three
other ways we can select tests. We can select tests by package:
Modified: zope.testing/trunk/src/zope/testing/testrunner-verbose.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-verbose.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-verbose.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Verbose Output
---------------
+==============
Normally, we just get a summary. We can use the -v option to get
increasingly more information.
Modified: zope.testing/trunk/src/zope/testing/testrunner-wo-source.txt
===================================================================
--- zope.testing/trunk/src/zope/testing/testrunner-wo-source.txt 2006-09-20 21:10:09 UTC (rev 70270)
+++ zope.testing/trunk/src/zope/testing/testrunner-wo-source.txt 2006-09-20 21:27:32 UTC (rev 70271)
@@ -1,8 +1,5 @@
-Test Runner
-===========
-
Running Without Source Code
----------------------------
+===========================
The ``--usecompiled`` option allows running tests in a tree without .py
source code, provided compiled .pyc or .pyo files exist (without
More information about the Zope3-Checkins
mailing list