blob: 3643edb4e46c5aee39cb478e12e266b53d98b196 [file] [log] [blame]
Andrea Frittoli (andreaf)7d5445d2017-10-03 18:43:05 +01001Run Tempest
2
Luigi Toscanob7746662020-04-17 13:31:00 +02003The result of the tempest run is stored in the `tempest_run_result`
4variable (through the `register` statement).
5
Andrea Frittoli (andreaf)7d5445d2017-10-03 18:43:05 +01006**Role Variables**
7
8.. zuul:rolevar:: devstack_base_dir
9 :default: /opt/stack
10
11 The devstack base directory.
12
13.. zuul:rolevar:: tempest_concurrency
14 :default: 0
15
16 The number of parallel test processes.
17
Luigi Toscanoe8a1f532017-11-16 15:22:07 +010018.. zuul:rolevar:: tempest_test_regex
19 :default: ''
20
21 A regular expression used to select the tests.
Michel Peterson515edd42017-12-21 17:22:49 +020022
Luigi Toscanoe8a1f532017-11-16 15:22:07 +010023 It works only when used with some specific tox environments
24 ('all', 'all-plugin'.)
25
Martin Kopec4af65402020-02-05 14:57:10 +000026 In the following example only api scenario and third party tests
27 will be executed.
Michel Peterson515edd42017-12-21 17:22:49 +020028
29 ::
30 vars:
Martin Kopec4af65402020-02-05 14:57:10 +000031 tempest_test_regex: (tempest\.(api|scenario|thirdparty)).*$
Michel Peterson515edd42017-12-21 17:22:49 +020032
Michel Petersonef1a16d2018-02-23 20:20:22 +020033.. zuul:rolevar:: tempest_test_blacklist
34
35 Specifies a blacklist file to skip tests that are not needed.
36
37 Pass a full path to the file.
38
Andreas Jaegerba2f4792018-01-12 16:48:52 +010039.. zuul:rolevar:: tox_envlist
Andrea Frittoli (andreaf)7d5445d2017-10-03 18:43:05 +010040 :default: smoke
41
42 The Tempest tox environment to run.
Chandan Kumara9445042018-02-26 10:22:29 +000043
44.. zuul:rolevar:: tempest_black_regex
45 :default: ''
46
47 A regular expression used to skip the tests.
48
49 It works only when used with some specific tox environments
50 ('all', 'all-plugin'.)
51
Chandan Kumara9445042018-02-26 10:22:29 +000052 ::
53 vars:
Martin Kopec4af65402020-02-05 14:57:10 +000054 tempest_black_regex: (tempest.api.identity).*$
Sergey Vilgelm2979bff2018-11-06 10:34:03 -060055
56.. zuul:rolevar:: tox_extra_args
57 :default: ''
58
59 String of extra command line options to pass to tox.
60
61 Here is an example of running tox with --sitepackages option:
62
63 ::
64 vars:
65 tox_extra_args: --sitepackages
Dmitry Tantsur5952f852019-08-29 14:06:12 +020066
67.. zuul:rolevar:: tempest_test_timeout
68 :default: ''
69
70 The timeout (in seconds) for each test.
Ghanshyam56149022020-02-05 15:53:26 -060071
72.. zuul:rolevar:: stable_constraints_file
73 :default: ''
74
75 Upper constraints file to be used for stable branch till stable/rocky.
76
77.. zuul:rolevar:: tempest_tox_environment
78 :default: ''
79
80 Environment variable to set for run-tempst task.
81
82 Env variables set in this variable will be combined with some more
83 defaults env variable set at runtime.