zuul
/
zuul-jobs
Code Issues Proposed changes
zuul-jobs/roles/tox
History
Ian Wienand a016a1a565 linters: standardise on newline at end of file 
I noticed this by accident when I ran ansible-lint over this repo from
an outside context; it didn't use the .yamllint in here and started
compalining about eof whitespace.

After scratching my head for a bit as to why this didn't fail here, I
realised we've allowed various newlines since the initial commit
I936fe2c997597972d884c5fc62655d28e8aaf8c5.

Remove this and just use the default eof rules, and fixup the
whitespace as required.  This is fairly unimportant, but is nice for
consistency.

Change-Id: Idb46a1f39ba798b0bf70eaa27b4c6b4758ce3d26
 		2022-07-28 16:19:06 +10:00
..
defaults Make default tox run more strict about interpreter version 2021-09-08 08:19:08 +00:00
library linters: standardise on newline at end of file 2022-07-28 16:19:06 +10:00
tasks linters: add names to blocks 2022-07-27 17:13:39 +10:00
README.rst Merge "[tox] Update readme regarding default values" 2022-06-27 08:59:45 +00:00
__init__.py Enable Python 2.7 unit tests 2018-08-17 10:23:20 +10: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.