zuul-jobs/roles/tox/README.rst

Runs tox for a project

This role overrides Python packages installed into tox environments with corresponding Zuul sibling projects and runs tox tests as follows:

1. Create tox environments.
2. Get Python sibling package names for sibling projects created by Zuul (using required-projects job variable). Package names are searched in following sources:
   • setup.cfg of pbr projects,
   • setup.py,
   • tox_package_name role variable.
3. Remove sibling packages from tox environments.
4. Create temporary constraints file, lines for sibling packages are removed.
5. Install sibling packages from Zuul projects into tox environments with temporary constraints file.
6. Run tox tests.

Role Variables

Comma separated string with test environments tox should run. ALL runs all test environments while an empty string runs all test environments configured with envlist in tox.

Path to a tox configuration file, or directory containing a tox.ini file. Will be provided to tox via its -c command-line option if set.

Path to a pip constraints file. Will be provided to tox via TOX_CONSTRAINTS_FILE (deprecated but currently still supported name is UPPER_CONSTRAINTS_FILE) environment variable if it exists.

Allows a user to setup the package name to be used by tox, over reading a setup.cfg file in the project.