z3c.recipe.compattest 0.6

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 (one package per line) If an entry has the form [section], all keys of that buildout section are included. (default: the version-section of the buildout (${buildout:versions}) if one is defined)

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

• script: the name of the runner script (default: test-<partname>)

• svn_url: SVN repository to search for packages instead of using releases (see below)

• svn_directory: directory to place checkouts in (default: parts/<partname>)

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

>>> print system(buildout)
Couldn't...Installing compattest...

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-z3c.recipe.compattest
- test-compattest
>>> cat('bin', 'test-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...

Using SVN checkouts

When you set an svn_url, the test runners will not refer to released eggs, but rather use development-egg links to SVN checkouts of the trunks of each package (the checkouts are placed in svn_directory).

Note: Even though the generated testrunners will use development-egg links, this does not change the develop-eggs for your buildout itself. We check that before the installation of the recipe, there’s just the single develop-egg link of the package we’re working on:

>>> ls('develop-eggs')
- z3c.recipe.compattest.egg-link

>>> write('buildout.cfg', """
... [buildout]
... parts = compattest-trunk
... versions = versions
...
... [versions]
... # we don't care about the version numbers, we just extract
... # which package names to include from here
... z3c.recipe.compattest =
... zope.dottedname =
...
... [compattest-trunk]
... recipe = z3c.recipe.compattest
... svn_url = svn://svn.zope.org/repos/main/
... """)
>>> ignore = system(buildout)

The checkouts are placed in the parts/ folder by default, but you can override this by setting svn_directory – so you can share checkouts between several buildouts, for example.

Note that for packages that already exist as develop eggs (in our example, z3c.recipe.compattest), no checkout is performed.

>>> ls('parts/compattest-trunk')
d zope.dottedname

The testrunner uses the checked out version of zope.dottedname:

>>> cat('bin', 'compattest-trunk-zope.dottedname')
#!/...python...
...parts/compattest-trunk/zope.dottedname/src...

But no additional develop-egg links are present:

>>> ls('develop-eggs')
- z3c.recipe.compattest.egg-link

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