zuul/zuul-jobs
Code Issues Proposed changes
zuul-jobs/roles/tox
History
James E. Blair 9e22cfdb0f Remove shebang from all python ansible modules 
This commit in Ansible:
9142be2f6c

now allows Python modules to specify their interpreter with the shebang.
We expect our roles to use the discovered python interpreter on remote
nodes, and on the executor, we need them to use the virtualenv.  Removing
the specific shebang accomplishes this under Ansible 6, and has no effect
under older versions of Ansible.

Without this, for example, the log upload roles would not have access to
their cloud libraries.

Also update our ansible/cli check in our module files.  Many of our modules
can be run from the command line for ease of testing, but the check that we
perform to determine if the module is being invoked from the command line
or Ansible fails on Ansible 5.  Update it to a check that should work in
all 4 versions of Ansible that Zuul uses.

Change-Id: I4e6e85156459cca032e6c3e1d8a9284be919ccca
2022-09-15 13:48:10 -07:00
..
defaults
Make default tox run more strict about interpreter version
2021-09-08 08:19:08 +00:00
library
Remove shebang from all python ansible modules
2022-09-15 13:48:10 -07:00
tasks
linters: add names to blocks
2022-07-27 17:13:39 +10:00
__init__.py
Enable Python 2.7 unit tests
2018-08-17 10:23:20 +10:00
README.rst
Merge "[tox] Update readme regarding default values"
2022-06-27 08:59:45 +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.