tempest/roles/run-tempest/README.rst
Lukáš Piwowarski be19f21813 Remove references to 'all-plugin' tox environment
The 'all-plugin' tox environment was deprecated by this patch [1].
Instead of the 'all-plugin' it is recommended to use the 'all' tox
environment.

This patch removes any reference to 'all-plugin' tox environment and
updates the documentation so that the installation steps work with
the 'all' tox venv.

[1] https://review.opendev.org/c/openstack/tempest/+/543974

Related-Bug: 1862240
Change-Id: I0a86d9cf33bff6576a6337967d6b663ab7d9f4a6
2022-10-10 14:01:49 +02:00

93 lines
2.1 KiB
ReStructuredText

Run Tempest
The result of the tempest run is stored in the `tempest_run_result`
variable (through the `register` statement).
**Role Variables**
.. zuul:rolevar:: devstack_base_dir
:default: /opt/stack
The devstack base directory.
.. zuul:rolevar:: tempest_concurrency
:default: 0
The number of parallel test processes.
.. zuul:rolevar:: tempest_test_regex
:default: ''
A regular expression used to select the tests.
It works only when used with some specific tox environments
('all', 'all-site-packages').
In the following example only api scenario and third party tests
will be executed.
::
vars:
tempest_test_regex: (tempest\.(api|scenario|thirdparty)).*$
.. zuul:rolevar:: tempest_test_blacklist
DEPRECATED option, please use tempest_test_exclude_list instead.
.. zuul:rolevar:: tempest_test_exclude_list
Specifies an excludelist file to skip tests that are not needed.
Pass a full path to the file.
.. zuul:rolevar:: tox_envlist
:default: smoke
The Tempest tox environment to run.
.. zuul:rolevar:: tempest_black_regex
:default: ''
DEPRECATED option, please use tempest_exclude_regex instead.
.. zuul:rolevar:: tempest_exclude_regex
:default: ''
A regular expression used to skip the tests.
It works only when used with some specific tox environments
('all', 'all-site-packages').
::
vars:
tempest_exclude_regex: (tempest.api.identity).*$
.. zuul:rolevar:: tox_extra_args
:default: ''
String of extra command line options to pass to tox.
Here is an example of running tox with --sitepackages option:
::
vars:
tox_extra_args: --sitepackages
.. zuul:rolevar:: tempest_test_timeout
:default: ''
The timeout (in seconds) for each test.
.. zuul:rolevar:: stable_constraints_file
:default: ''
Upper constraints file to be used for stable branch till stable/victoria.
.. zuul:rolevar:: tempest_tox_environment
:default: ''
Environment variable to set for run-tempst task.
Env variables set in this variable will be combined with some more
defaults env variable set at runtime.