zuul/zuul-jobs
Code Issues Proposed changes
911fe88a9f
zuul-jobs/roles/tox
History
Benedikt Loeffler 9eaab6fd74 Pass environment variables to 'tox envlist config' task 
As of version 3.21.0, tox now throws an exception if an environment variable
used in config is missing. We now need to pass the variables also to the task
"Get tox envlist config".

Change-Id: I4073f55b6ba3456f3d2db40cafb692efbb478914
2021-01-14 15:25:31 +01:00
..
defaults Remove default tox_envlist: venv 2020-07-16 21:59:57 +02:00
library Create tox_package_name for tox role 2020-12-16 11:29:39 -05:00
tasks Pass environment variables to 'tox envlist config' task 2021-01-14 15:25:31 +01:00
__init__.py Enable Python 2.7 unit tests 2018-08-17 10:23:20 +10:00
README.rst Document Python siblings handling for tox role 2021-01-08 23:41:27 +03: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 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.