zuul/zuul-jobs
Code Issues Proposed changes

Document Python siblings handling for tox role

Browse Source 
Brief overview how actually siblings are installed helps
proper usage of 'tox' role.

Change-Id: Id27c9c60a40e43c0e351849470ccb4d0d11739a3
This commit is contained in:
Vitaliy Lotorev 2021-01-02 02:54:18 +03:00
parent 4708a35220
commit ecc11af6fe
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
roles/tox/README.rst
View File

@ -1,5 +1,24 @@
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:
#. Create tox environments.
#. 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.
#. Remove sibling packages from tox environments.
#. Create temporary constraints file, lines for sibling packages are
removed.
#. Install sibling packages from Zuul projects into tox environments
with temporary constraints file.
#. Run tox tests.
**Role Variables**
.. zuul:rolevar:: tox_environment