Python Jobs¶
-
tox
¶ Base job containing setup and teardown for tox-based test jobs.
This performs basic host and general project setup tasks common to all tox unit test jobs.
Responds to these variables:
-
tox_envlist
¶ Use the specified tox environments (
ALL
selects all).
-
tox_environment
¶
Type: dict Environment variables to pass in to the tox run.
-
tox_extra_args
¶ String containing extra arguments to append to the tox command line.
-
tox_constraints_file
¶ Path to a pip constraints file. Will be provided to tox in the TOX_CONSTRAINTS_FILE environment variable if it exists.
-
tox_install_siblings
¶
Default:true
Override tox requirements that have corresponding zuul git repos on the node by installing the git versions into the tox virtualenv.
-
tox_install_bindep
¶
Default:true
Whether or not to run the binary dependencies detection and installation with bindep.
-
-
tox-py27
¶ Run unit tests for a Python project under cPython version 2.7.
Uses tox with the
py27
environment.
-
tox-py34
¶ Run unit tests for a Python project under cPython version 3.4.
Uses tox with the
py34
environment.
-
tox-py35
¶ Run unit tests for a Python project under cPython version 3.5.
Uses tox with the
py35
environment.
-
tox-py36
¶ Run unit tests for a Python project under cPython version 3.6.
Uses tox with the
py36
environment.
-
tox-py37
¶ Run unit tests for a Python project under cPython version 3.7.
Uses tox with the
py37
environment.
-
tox-py38
¶ Run unit tests for a Python project under cPython version 3.8.
Uses tox with the
py38
environment.
-
tox-py39
¶ Run unit tests for a Python project under cPython version 3.9.
Uses tox with the
py39
environment.
-
tox-docs
¶ Run documentation unit tests.
Uses tox with the
docs
environment.
-
tox-linters
¶ Runs code linting tests.
Uses tox with the
linters
environment.
-
tox-molecule
¶ Runs Ansible molecule testing on a system where docker is available.
Uses tox with the
molecule
environment.
-
tox-pep8
¶ Runs code pep8 tests.
Uses tox with the
pep8
environment.
-
tox-cover
¶ Run code coverage tests.
Uses tox with the
cover
environment.
-
tox-bashate
¶ Run bashate tests.
Uses tox with the
bashate
environment.
-
tox-nodejs-npm
¶ Run tests using tox but with the javascript toolchain installed and available as well. A combination of the tox and nodejs-npm jobs. By default will run npm before running the tox environment listed.
Responds to these variables:
-
tox_envlist
¶ Use the specified tox environments (
ALL
selects all).
-
tox_environment
¶
Type: dict Environment variables to pass in to the tox run.
-
tox_extra_args
¶ String containing extra arguments to append to the tox command line.
-
tox_constraints_file
¶ Path to a pip constraints file. Will be provided to tox in the TOX_CONSTRAINTS_FILE environment variable if it exists.
-
tox_install_siblings
¶
Default:true
Override tox requirements that have corresponding zuul git repos on the node by installing the git versions into the tox virtualenv.
-
npm_command
¶
Default:build
Command to pass to npm.
-
node_version
¶
Default:6
The version of Node to use.
-
javascript_content_dir
¶
Default:dist
Directory, relative to zuul_work_dir, holding build content.
-
zuul_work_dir
¶
Default:{{ zuul.project.src_dir }}
Path to operate in.
-
-
build-python-release
¶ Build a source tarball and a bdist wheel for uploading.
-
python-upload-pypi
¶ Generate and upload a python source tarball and binary wheel
Requires a variable
pypi_info
be set which is a dict containing at least ausername
andpassword
attribute.
-
build-sphinx-docs
¶ Build documentation using Sphinx
Additional requirements can be provided in a project in either the file
doc/requirements.txt
ortest-requirements.txt
. (The first file found in that order will be the one used) Non-python distro requirements can be specified inbindep.txt
using thedoc
tag.Runs whereto https://docs.openstack.org/whereto/latest/ after the build if it is installed.
Responds to these variables:
-
constraints_file
¶ Optional path to a pip constraints file for installing python libraries.
-
sphinx_python
¶
Default:python2
Version of python to use, either
python2
orpython3
.
-
zuul_work_dir
¶
Default:{{ zuul.project.src_dir }}
Directory to operate in.
-
-
build-reno-releasenotes
¶ Build releasenotes using reno
Additional requirements can be provided in a project in either the file
doc/requirements.txt
ortest-requirements.txt
. (The first file found in that order will be the one used) Non-python distro requirements can be specified inbindep.txt
using thedoc
tag.Responds to these variables:
-
constraints_file
¶ Optional path to a pip constraints file for installing python libraries.
-
sphinx_python
¶
Default:python2
Version of python to use, either
python2
orpython3
.
-
zuul_work_dir
¶
Default:{{ zuul.project.src_dir }}
Directory to operate in.
-