| Andrea Frittoli (andreaf) | 7d5445d | 2017-10-03 18:43:05 +0100 | [diff] [blame] | 1 | Run Tempest |
| 2 | |
| Luigi Toscano | b774666 | 2020-04-17 13:31:00 +0200 | [diff] [blame] | 3 | The result of the tempest run is stored in the `tempest_run_result` |
| 4 | variable (through the `register` statement). |
| 5 | |
| Andrea Frittoli (andreaf) | 7d5445d | 2017-10-03 18:43:05 +0100 | [diff] [blame] | 6 | **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 Toscano | e8a1f53 | 2017-11-16 15:22:07 +0100 | [diff] [blame] | 18 | .. zuul:rolevar:: tempest_test_regex |
| 19 | :default: '' |
| 20 | |
| 21 | A regular expression used to select the tests. |
| Michel Peterson | 515edd4 | 2017-12-21 17:22:49 +0200 | [diff] [blame] | 22 | |
| Luigi Toscano | e8a1f53 | 2017-11-16 15:22:07 +0100 | [diff] [blame] | 23 | It works only when used with some specific tox environments |
| Lukáš Piwowarski | be19f21 | 2022-10-07 13:47:11 +0200 | [diff] [blame] | 24 | ('all', 'all-site-packages'). |
| Luigi Toscano | e8a1f53 | 2017-11-16 15:22:07 +0100 | [diff] [blame] | 25 | |
| Martin Kopec | 4af6540 | 2020-02-05 14:57:10 +0000 | [diff] [blame] | 26 | In the following example only api scenario and third party tests |
| 27 | will be executed. |
| Michel Peterson | 515edd4 | 2017-12-21 17:22:49 +0200 | [diff] [blame] | 28 | |
| 29 | :: |
| 30 | vars: |
| Martin Kopec | 4af6540 | 2020-02-05 14:57:10 +0000 | [diff] [blame] | 31 | tempest_test_regex: (tempest\.(api|scenario|thirdparty)).*$ |
| Michel Peterson | 515edd4 | 2017-12-21 17:22:49 +0200 | [diff] [blame] | 32 | |
| Michel Peterson | ef1a16d | 2018-02-23 20:20:22 +0200 | [diff] [blame] | 33 | .. zuul:rolevar:: tempest_test_blacklist |
| 34 | |
| Martin Kopec | dc84423 | 2020-12-24 15:57:53 +0000 | [diff] [blame] | 35 | DEPRECATED option, please use tempest_test_exclude_list instead. |
| 36 | |
| 37 | .. zuul:rolevar:: tempest_test_exclude_list |
| 38 | |
| 39 | Specifies an excludelist file to skip tests that are not needed. |
| Michel Peterson | ef1a16d | 2018-02-23 20:20:22 +0200 | [diff] [blame] | 40 | |
| 41 | Pass a full path to the file. |
| 42 | |
| Andreas Jaeger | ba2f479 | 2018-01-12 16:48:52 +0100 | [diff] [blame] | 43 | .. zuul:rolevar:: tox_envlist |
| Andrea Frittoli (andreaf) | 7d5445d | 2017-10-03 18:43:05 +0100 | [diff] [blame] | 44 | :default: smoke |
| 45 | |
| 46 | The Tempest tox environment to run. |
| Chandan Kumar | a944504 | 2018-02-26 10:22:29 +0000 | [diff] [blame] | 47 | |
| 48 | .. zuul:rolevar:: tempest_black_regex |
| 49 | :default: '' |
| 50 | |
| Martin Kopec | dc84423 | 2020-12-24 15:57:53 +0000 | [diff] [blame] | 51 | DEPRECATED option, please use tempest_exclude_regex instead. |
| 52 | |
| 53 | .. zuul:rolevar:: tempest_exclude_regex |
| 54 | :default: '' |
| 55 | |
| Chandan Kumar | a944504 | 2018-02-26 10:22:29 +0000 | [diff] [blame] | 56 | A regular expression used to skip the tests. |
| 57 | |
| 58 | It works only when used with some specific tox environments |
| Lukáš Piwowarski | be19f21 | 2022-10-07 13:47:11 +0200 | [diff] [blame] | 59 | ('all', 'all-site-packages'). |
| Chandan Kumar | a944504 | 2018-02-26 10:22:29 +0000 | [diff] [blame] | 60 | |
| Chandan Kumar | a944504 | 2018-02-26 10:22:29 +0000 | [diff] [blame] | 61 | :: |
| 62 | vars: |
| Martin Kopec | dc84423 | 2020-12-24 15:57:53 +0000 | [diff] [blame] | 63 | tempest_exclude_regex: (tempest.api.identity).*$ |
| Sergey Vilgelm | 2979bff | 2018-11-06 10:34:03 -0600 | [diff] [blame] | 64 | |
| 65 | .. zuul:rolevar:: tox_extra_args |
| 66 | :default: '' |
| 67 | |
| 68 | String of extra command line options to pass to tox. |
| 69 | |
| 70 | Here is an example of running tox with --sitepackages option: |
| 71 | |
| 72 | :: |
| 73 | vars: |
| 74 | tox_extra_args: --sitepackages |
| Dmitry Tantsur | 5952f85 | 2019-08-29 14:06:12 +0200 | [diff] [blame] | 75 | |
| 76 | .. zuul:rolevar:: tempest_test_timeout |
| 77 | :default: '' |
| 78 | |
| 79 | The timeout (in seconds) for each test. |
| Ghanshyam | 5614902 | 2020-02-05 15:53:26 -0600 | [diff] [blame] | 80 | |
| 81 | .. zuul:rolevar:: stable_constraints_file |
| 82 | :default: '' |
| 83 | |
| Ghanshyam Mann | d9b6d7c | 2022-05-28 18:57:54 -0500 | [diff] [blame] | 84 | Upper constraints file to be used for stable branch till stable/victoria. |
| Ghanshyam | 5614902 | 2020-02-05 15:53:26 -0600 | [diff] [blame] | 85 | |
| 86 | .. zuul:rolevar:: tempest_tox_environment |
| 87 | :default: '' |
| 88 | |
| 89 | Environment variable to set for run-tempst task. |
| 90 | |
| 91 | Env variables set in this variable will be combined with some more |
| 92 | defaults env variable set at runtime. |