Buildout recipe to create testrunners for testing compatibility with other packages
Project description
z3c.recipe.compattest
This buildout recipe generates a list of packages to test and a test runner that runs each package’s tests (isolated from any other tests). This is useful to check that the changes made while developing a package do not break any packages that are using this package.
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)
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 - 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...
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 ... ... [kgs] ... packages = z3c.recipe.compattest zope.dottedname ... ... [compattest-trunk] ... recipe = z3c.recipe.compattest ... include = ${kgs:packages} ... 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
CHANGES
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for z3c.recipe.compattest-0.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4e7b2cbd6be4dbdc69a1eae45f16b4ff5b55f9d023667c73a675b8ef1cab30b |
|
MD5 | 2bd0efc6009a9151d3eee25a714d7ed4 |
|
BLAKE2b-256 | 8943e1ce78b56dd67784c82ba27ecba52acd9656b8901a3734542b7938307edf |