zuul/zuul-jobs
Code Issues Proposed changes
zuul-jobs/roles/tox
History
Jeremy Stanley 1861faf567 More exact section matching for tox showconfig 
With the original verbose output support in change
Iafeb88eaf9a596603ad4d2134a4574345d5189ab we looked for lines from
tox --showconfig output starting with an opening '[' but verbosity
also causes output from pip install activity to be included if a
tox.requires entry causes it to install packages before continuing
and these lines are prefixed by a process ID number wrapped in
brackets with the command string after that, which prematurely
triggered our search for the start of the INI content. Add a
stipulation that the first INI output line also end in ']' in order
to skip over those additional prepended lines.

Change-Id: If29e5a9abe3b92a145d87f5efc1b93350ea3908a
2021-10-01 16:03:12 +00:00
..
defaults
Make default tox run more strict about interpreter version
2021-09-08 08:19:08 +00:00
library
More exact section matching for tox showconfig
2021-10-01 16:03:12 +00:00
tasks
Revert "Include tox_extra_args in tox siblings tasks"
2021-09-30 17:54:17 +00:00
__init__.py
Enable Python 2.7 unit tests
2018-08-17 10:23:20 +10:00
README.rst
Add tox_config_file rolevar to tox
2021-09-17 20:34:37 +00:00

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.