z3c.recipe.compattest 0.11

Usage

Add a part to your buildout.cfg that uses this recipe. No further configuration is required, but you can set the following options:

• include: list of packages to include (whitespace-separated) (default: empty)

• exclude: packages matching any regex in this list will be excluded (default: empty)

• script: the name of the runner script (defaults to the part name)

>>> cd(sample_buildout)
>>> write('buildout.cfg', """
... [buildout]
... parts = compattest
...
... [compattest]
... recipe = z3c.recipe.compattest
... include = z3c.recipe.compattest
... """)

>>> 'Installing compattest' in system(buildout)
True

Details

The recipe generates a test runner for each package, as well as a global runner script (called test-compat by default) that will run all of them:

>>> ls('bin')
- buildout
- compattest
- compattest-z3c.recipe.compattest

>>> cat('bin', 'compattest')
#!...python...
...main(...compattest-z3c.recipe.compattest...

We take care about installing the test dependencies for the packages (from their extras_require['test']). Do demonstrate this, we declared a (superfluous) test dependency on zope.dottedname, which is picked up:

>>> cat('bin', 'compattest-z3c.recipe.compattest')
#!...python...
...zope.dottedname...

Passing options to the test runners

If you want to use custom options in the generated test runners, you can specify them in the part options, prefixed by runner-. That is, if you want to pass the --foo option by default to all generated test runners, you can set runner-defaults = ['--foo'] in your part:

>>> write('buildout.cfg', """
... [buildout]
... parts = compattest
...
... [compattest]
... recipe = z3c.recipe.compattest
... include = z3c.recipe.compattest
... runner-defaults = ['-c', '-v', '-v']
... """)
>>> ignore = system(buildout)
>>> cat('bin', 'compattest-z3c.recipe.compattest')
#!...python...
...run(...['-c', '-v', '-v']...

Every options prefixed by runner- will be automatically passed to the generated test runners.

0.11 (2009-09-30)

• Removed the “check out packages from subversion” feature. If you require such functionality, mr.developer <http://pypi.python.org/pypi/mr.developer> provides this much more comprehensively (and for multiple version control systems, too) .

0.10 (2009-09-28)

• Options prefixed by runner- are automatically passed to generated test runners.

0.9 (2009-09-14)

• Test runner: return the exit code 1 in case of test failures; this simplifies buildbot configurations.

0.8 (2009-08-17)

• Windoes is now supported.

• Changed the default master script name to the part name. (Don’t add a “test-” prefix any more.)

0.7 (2009-08-13)

• Simplified building the list of packages even more: we now just take a list of packages, period.

0.6 (2009-08-07)

• Restructured the way we construct our list of packages to test: We no longer filter a list we retrieved from SVN with includes/excludes, but use an explicit list that can be populated from a buildout section, e. g. [versions]. Thus, we can now easily test against a KGS.

• Always enable all extras of packages under test.

0.5 (2009-01-29)

• Fix duplicate url parameter in setup.py that confused Python 2.4 but got accepted by Python 2.5.

0.4 (2009-01-29)

• Ignore missing package releases for packages listed in Subversion (as long as we don’t try to run from Subversion).

• Allow parallel execution of the individual test runners by stating ‘max_jobs=X’ in the recipe’s options.

0.3 (2009-01-28)

• Adding the exclude parameter in buildout causes the default exclude list to be merged with the option in buildout.cfg.

0.2 (2009-01-28)

• Implemented use_svn option to use SVN trunk checkouts instead of released versions.

0.1 (2009-01-28)

• first released version