blob: 8ed1ff68a72f42f012090a36585b117019c44c85 [file] [log] [blame]
ZhiQiang Fan39f97222013-09-20 04:49:44 +08001# Copyright 2012 OpenStack Foundation
Jay Pipes3f981df2012-03-27 18:59:44 -04002# All Rights Reserved.
3#
4# Licensed under the Apache License, Version 2.0 (the "License"); you may
5# not use this file except in compliance with the License. You may obtain
6# a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13# License for the specific language governing permissions and limitations
14# under the License.
15
Jay Pipes7f757632011-12-02 15:53:32 -050016import os
Matthew Treinishaa29c7e2015-04-23 16:35:09 -040017import tempfile
Jay Pipes3f981df2012-03-27 18:59:44 -040018
Matthew Treinishaa29c7e2015-04-23 16:35:09 -040019from oslo_concurrency import lockutils
Doug Hellmann583ce2c2015-03-11 14:55:46 +000020from oslo_config import cfg
Noam Angel3c6b0162018-07-08 17:05:35 +030021from oslo_config import types
Doug Hellmann583ce2c2015-03-11 14:55:46 +000022from oslo_log import log as logging
Jay Pipes7f757632011-12-02 15:53:32 -050023
Andrea Frittoli (andreaf)de5fb0c2016-06-13 12:15:00 +010024from tempest.lib import exceptions
Andrea Frittoli (andreaf)8420abe2016-07-27 11:47:43 +010025from tempest.lib.services import clients
Matthew Treinisha966d0f2015-07-01 17:37:31 -040026from tempest.test_discover import plugins
27
Daryl Walleck1465d612011-11-02 02:22:15 -050028
Maru Newbyf440c292015-03-31 15:58:47 +000029# TODO(marun) Replace use of oslo_config's global ConfigOpts
30# (cfg.CONF) instance with a local instance (cfg.ConfigOpts()) once
31# the cli tests move to the clients. The cli tests rely on oslo
32# incubator modules that use the global cfg.CONF.
33_CONF = cfg.CONF
34
35
DennyZhang88a2dd82013-10-07 12:55:35 -050036def register_opt_group(conf, opt_group, options):
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +010037 if opt_group:
38 conf.register_group(opt_group)
DennyZhang88a2dd82013-10-07 12:55:35 -050039 for opt in options:
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +010040 conf.register_opt(opt, group=getattr(opt_group, 'name', None))
DennyZhang88a2dd82013-10-07 12:55:35 -050041
42
Matthew Treinishc791ac42014-07-16 09:15:23 -040043auth_group = cfg.OptGroup(name='auth',
44 title="Options for authentication and credentials")
45
46
47AuthGroup = [
48 cfg.StrOpt('test_accounts_file',
Matthew Treinishc791ac42014-07-16 09:15:23 -040049 help="Path to the yaml file that contains the list of "
Matthew Treinishfc7cd8f2015-03-30 11:51:55 -040050 "credentials to use for running tests. If used when "
51 "running in parallel you have to make sure sufficient "
52 "credentials are provided in the accounts file. For "
53 "example if no tests with roles are being run it requires "
54 "at least `2 * CONC` distinct accounts configured in "
55 " the `test_accounts_file`, with CONC == the "
56 "number of concurrent test processes."),
Andrea Frittoli (andreaf)17209bb2015-05-22 10:16:57 -070057 cfg.BoolOpt('use_dynamic_credentials',
Attila Fazekas5dda1582015-02-18 17:16:02 +010058 default=True,
Sean Dagueed6e5862016-04-04 10:49:13 -040059 help="Allows test cases to create/destroy projects and "
Andrea Frittoli8283b4e2014-07-17 13:28:58 +010060 "users. This option requires that OpenStack Identity "
61 "API admin credentials are known. If false, isolated "
62 "test cases and parallel execution, can still be "
Ken'ichi Ohmichi553d7cb2018-07-13 22:53:03 +000063 "achieved configuring a list of test accounts"),
Matthew Treinish167b2be2015-01-15 17:20:27 -050064 cfg.ListOpt('tempest_roles',
65 help="Roles to assign to all users created by tempest",
Andrea Frittolic3280152015-02-26 12:42:34 +000066 default=[]),
David Kranz87fc7e92015-07-28 14:05:20 -040067 cfg.StrOpt('default_credentials_domain_name',
68 default='Default',
69 help="Default domain used when getting v3 credentials. "
zhuflf4d35922019-06-06 15:07:05 +080070 "This is the name keystone uses for v2 compatibility."),
Matthew Treinish2219d382015-04-24 10:33:04 -040071 cfg.BoolOpt('create_isolated_networks',
72 default=True,
Andrea Frittoli (andreaf)17209bb2015-05-22 10:16:57 -070073 help="If use_dynamic_credentials is set to True and Neutron "
74 "is enabled Tempest will try to create a usable network, "
Sean Dagueed6e5862016-04-04 10:49:13 -040075 "subnet, and router when needed for each project it "
Matthew Treinish2219d382015-04-24 10:33:04 -040076 "creates. However in some neutron configurations, like "
77 "with VLAN provider networks, this doesn't work. So if "
78 "set to False the isolated networks will not be created"),
Matthew Treinish16cf1e52015-08-11 10:39:23 -040079 cfg.StrOpt('admin_username',
80 help="Username for an administrative user. This is needed for "
Sean Dagueed6e5862016-04-04 10:49:13 -040081 "authenticating requests made by project isolation to "
zhufl5402cc32019-05-28 09:49:15 +080082 "create users and projects"),
Sean Dagueed6e5862016-04-04 10:49:13 -040083 cfg.StrOpt('admin_project_name',
Ken'ichi Ohmichi79a71ac2016-04-22 20:02:51 -070084 help="Project name to use for an administrative user. This is "
Sean Dagueed6e5862016-04-04 10:49:13 -040085 "needed for authenticating requests made by project "
zhufl5402cc32019-05-28 09:49:15 +080086 "isolation to create users and projects"),
Matthew Treinish16cf1e52015-08-11 10:39:23 -040087 cfg.StrOpt('admin_password',
Ken'ichi Ohmichi79a71ac2016-04-22 20:02:51 -070088 help="Password to use for an administrative user. This is "
Sean Dagueed6e5862016-04-04 10:49:13 -040089 "needed for authenticating requests made by project "
Matthew Treinish16cf1e52015-08-11 10:39:23 -040090 "isolation to create users and projects",
zhufl5402cc32019-05-28 09:49:15 +080091 secret=True),
Matthew Treinish16cf1e52015-08-11 10:39:23 -040092 cfg.StrOpt('admin_domain_name',
zhuflc2aa1122018-02-14 09:46:10 +080093 default='Default',
Sergey Vilgelm36fdd202018-11-20 16:10:47 -060094 help="Admin domain name for authentication (Keystone V3). "
Colleen Murphycd0bbbd2019-10-01 16:18:36 -070095 "The same domain applies to user and project if "
96 "admin_user_domain_name and admin_project_domain_name "
97 "are not specified"),
98 cfg.StrOpt('admin_user_domain_name',
99 help="Domain name that contains the admin user (Keystone V3). "
100 "May be different from admin_project_domain_name and "
101 "admin_domain_name"),
102 cfg.StrOpt('admin_project_domain_name',
103 help="Domain name that contains the project given by "
104 "admin_project_name (Keystone V3). May be different from "
105 "admin_user_domain_name and admin_domain_name"),
106 cfg.StrOpt('admin_system',
107 default=None,
108 help="The system scope on which an admin user has an admin "
109 "role assignment, if any. Valid values are 'all' or None. "
110 "This must be set to 'all' if using the "
111 "[oslo_policy]/enforce_scope=true option for the "
112 "identity service."),
Matthew Treinishc791ac42014-07-16 09:15:23 -0400113]
114
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500115identity_group = cfg.OptGroup(name='identity',
116 title="Keystone Configuration Options")
Daryl Walleck1465d612011-11-02 02:22:15 -0500117
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500118IdentityGroup = [
119 cfg.StrOpt('catalog_type',
120 default='identity',
121 help="Catalog type of the Identity service."),
Daniel Melladocad3f3d2016-08-19 14:17:16 +0000122 cfg.BoolOpt('disable_ssl_certificate_validation',
123 default=False,
124 help="Set to True if using self-signed SSL certificates."),
125 cfg.StrOpt('ca_certificates_file',
126 default=None,
127 help='Specify a CA bundle file to use in verifying a '
128 'TLS (https) server certificate.'),
Takashi Kajinami0ed15dc2024-01-24 11:09:53 +0900129 cfg.URIOpt('uri',
130 schemes=['http', 'https'],
Brant Knudsonc7ca3342013-03-28 21:08:50 -0500131 help="Full URI of the OpenStack Identity API (Keystone), v2"),
Takashi Kajinami0ed15dc2024-01-24 11:09:53 +0900132 cfg.URIOpt('uri_v3',
133 schemes=['http', 'https'],
Brant Knudsonc7ca3342013-03-28 21:08:50 -0500134 help='Full URI of the OpenStack Identity API (Keystone), v3'),
Andrea Frittoli8bbdb162014-01-06 11:06:13 +0000135 cfg.StrOpt('auth_version',
Ken'ichi Ohmichia6065a62017-03-03 16:40:22 -0800136 default='v3',
Andrea Frittoli8bbdb162014-01-06 11:06:13 +0000137 help="Identity API version to be used for authentication "
Andrea Frittoli77f9da42014-02-06 11:18:19 +0000138 "for API tests."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500139 cfg.StrOpt('region',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100140 default='RegionOne',
Arata Notsu8f440392013-09-13 16:14:20 +0900141 help="The identity region name to use. Also used as the other "
142 "services' region name unless they are set explicitly. "
143 "If no such region is found in the service catalog, the "
144 "first found one is used."),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300145 cfg.StrOpt('v2_admin_endpoint_type',
146 default='adminURL',
147 choices=['public', 'admin', 'internal',
148 'publicURL', 'adminURL', 'internalURL'],
149 help="The admin endpoint type to use for OpenStack Identity "
ghanshyamf58b9fd2015-09-01 16:11:39 +0900150 "(Keystone) API v2"),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300151 cfg.StrOpt('v2_public_endpoint_type',
JordanP5d29b2c2013-12-18 13:56:03 +0000152 default='publicURL',
153 choices=['public', 'admin', 'internal',
154 'publicURL', 'adminURL', 'internalURL'],
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300155 help="The public endpoint type to use for OpenStack Identity "
zhuflf4d35922019-06-06 15:07:05 +0800156 "(Keystone) API v2"),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300157 cfg.StrOpt('v3_endpoint_type',
Arx Cruz05c805f2023-04-28 15:35:14 +0200158 default='public',
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300159 choices=['public', 'admin', 'internal',
160 'publicURL', 'adminURL', 'internalURL'],
161 help="The endpoint type to use for OpenStack Identity "
Arx Cruz05c805f2023-04-28 15:35:14 +0200162 "(Keystone) API v3."),
Russell Sim7f894a52013-09-13 10:35:21 +1000163 cfg.StrOpt('admin_role',
164 default='admin',
165 help="Role required to administrate keystone."),
Martin Pavlasek4c3f2ab2014-04-15 17:15:15 +0200166 cfg.StrOpt('default_domain_id',
167 default='default',
168 help="ID of the default domain"),
Andrea Frittoli (andreaf)100d18d2016-05-05 23:34:52 +0100169 cfg.BoolOpt('admin_domain_scope',
170 default=False,
171 help="Whether keystone identity v3 policy required "
Rodrigo Duarte Sousa2d78e8e2016-09-28 10:38:08 -0300172 "a domain scoped token to use admin APIs"),
173 # Security Compliance (PCI-DSS)
174 cfg.IntOpt('user_lockout_failure_attempts',
175 default=2,
176 help="The number of unsuccessful login attempts the user is "
ghanshyama5c28bf2018-10-19 07:51:09 +0000177 "allowed before having the account locked. This only "
178 "takes effect when identity-feature-enabled."
179 "security_compliance is set to 'True'. For more details, "
180 "refer to keystone config options keystone.conf:"
181 "security_compliance.lockout_failure_attempts. "
182 "This feature is disabled by default in keystone."),
Rodrigo Duarte Sousa2d78e8e2016-09-28 10:38:08 -0300183 cfg.IntOpt('user_lockout_duration',
184 default=5,
185 help="The number of seconds a user account will remain "
ghanshyama5c28bf2018-10-19 07:51:09 +0000186 "locked. This only takes "
187 "effect when identity-feature-enabled.security_compliance "
188 "is set to 'True'. For more details, refer to "
189 "keystone config options "
190 "keystone.conf:security_compliance.lockout_duration. "
191 "Setting this option will have no effect unless you also "
192 "set identity.user_lockout_failure_attempts."),
Rodrigo Duarte Sousa2d78e8e2016-09-28 10:38:08 -0300193 cfg.IntOpt('user_unique_last_password_count',
194 default=2,
195 help="The number of passwords for a user that must be unique "
zhuflb11f85a2018-10-15 15:21:34 +0800196 "before an old password can be reused. This only takes "
197 "effect when identity-feature-enabled.security_compliance "
Sergey Vilgelm36fdd202018-11-20 16:10:47 -0600198 "is set to 'True'. "
zhuflb11f85a2018-10-15 15:21:34 +0800199 "This config option corresponds to keystone.conf: "
200 "security_compliance.unique_last_password_count, whose "
201 "default value is 0 meaning disabling this feature. "
202 "NOTE: This config option value must be same as "
203 "keystone.conf: security_compliance.unique_last_password_"
Katarina Strenkova702f0be2023-08-07 12:53:28 +0000204 "count otherwise test might fail"),
205 cfg.IntOpt('user_minimum_password_age',
206 default=0,
207 help="The number of days that a password must be used before "
208 "the user can change it. This only takes effect when "
209 "identity-feature-enabled.security_compliance is set to "
210 "'True'. For more details, refer to keystone config "
211 "options "
212 "keystone.conf:security_compliance.minimum_password_age.")
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500213]
Jay Pipes3f981df2012-03-27 18:59:44 -0400214
zhufl071e94c2016-07-12 10:26:34 +0800215service_clients_group = cfg.OptGroup(name='service-clients',
216 title="Service Clients Options")
217
218ServiceClientsGroup = [
219 cfg.IntOpt('http_timeout',
220 default=60,
221 help='Timeout in seconds to wait for the http request to '
222 'return'),
Matthew Treinish74514402016-09-01 11:44:57 -0400223 cfg.StrOpt('proxy_url',
224 help='Specify an http proxy to use.')
zhufl071e94c2016-07-12 10:26:34 +0800225]
226
Matthew Treinishd5021a72014-01-09 18:42:51 +0000227identity_feature_group = cfg.OptGroup(name='identity-feature-enabled',
228 title='Enabled Identity Features')
229
230IdentityFeatureGroup = [
231 cfg.BoolOpt('trust',
232 default=True,
233 help='Does the identity service have delegation and '
Matthew Treinishdb2c5972014-01-31 22:18:59 +0000234 'impersonation enabled'),
235 cfg.BoolOpt('api_v2',
Lance Bragstad1fbad232017-09-22 18:58:53 +0000236 default=False,
237 help='Is the v2 identity API enabled',
238 deprecated_for_removal=True,
239 deprecated_reason='The identity v2.0 API was removed in the '
240 'Queens release. Tests that exercise the '
241 'v2.0 API will be removed from tempest in '
242 'the v22.0.0 release. They are kept only to '
243 'test stable branches.'),
Andrea Frittoli1413ba92017-04-21 14:33:23 +0100244 cfg.BoolOpt('api_v2_admin',
245 default=True,
246 help="Is the v2 identity admin API available? This setting "
247 "only applies if api_v2 is set to True."),
Matthew Treinishdb2c5972014-01-31 22:18:59 +0000248 cfg.BoolOpt('api_v3',
249 default=True,
250 help='Is the v3 identity API enabled'),
Jane Zadorozhna121576d2015-06-23 12:57:13 +0300251 cfg.ListOpt('api_extensions',
252 default=['all'],
253 help="A list of enabled identity extensions with a special "
254 "entry all which indicates every extension is enabled. "
255 "Empty list indicates all extensions are disabled. "
zhufld28a2712017-11-07 13:55:18 +0800256 "To get the list of extensions run: "
257 "'openstack extension list --identity'"),
Leticia Wanderley9cafd3d2017-08-04 00:22:34 -0300258 cfg.BoolOpt('domain_specific_drivers',
259 default=False,
260 help='Are domain specific drivers enabled? '
261 'This configuration value should be same as '
262 '[identity]->domain_specific_drivers_enabled '
263 'in keystone.conf.'),
Rodrigo Duarte Sousa2d78e8e2016-09-28 10:38:08 -0300264 cfg.BoolOpt('security_compliance',
265 default=False,
266 help='Does the environment have the security compliance '
Felipe Monteiro6f960782018-03-16 02:08:38 +0000267 'settings enabled?'),
Colleen Murphyd2cbd3a2019-12-17 16:31:14 -0800268 cfg.BoolOpt('access_rules',
Takashi Kajinami73005a12024-01-20 11:56:45 +0900269 default=True,
270 deprecated_for_removal=True,
271 deprecated_reason='Access rules for application credentials '
272 'is a default feature since Train',
Colleen Murphyd2cbd3a2019-12-17 16:31:14 -0800273 help='Does the environment have access rules enabled?'),
Anna Pankiewicza0710662018-07-24 14:56:42 -0500274 cfg.BoolOpt('immutable_user_source',
275 default=False,
276 help='Set to True if the environment has a read-only '
277 'user source. This will skip all tests that attempt to '
278 'create, delete, or modify users. This should not be set '
279 'to True if using dynamic credentials')
Matthew Treinishd5021a72014-01-09 18:42:51 +0000280]
281
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500282compute_group = cfg.OptGroup(name='compute',
283 title='Compute Service Options')
Rohit Karajgie1b050d2011-12-02 16:13:18 -0800284
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500285ComputeGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500286 cfg.StrOpt('image_ref',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400287 help="Valid primary image reference to be used in tests. "
288 "This is a required option"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500289 cfg.StrOpt('image_ref_alt',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400290 help="Valid secondary image reference to be used in tests. "
291 "This is a required option, but if only one image is "
292 "available duplicate the value of image_ref above"),
Lee Yarwood7f7c2322019-06-06 10:57:19 +0100293 cfg.StrOpt('certified_image_ref',
294 help="Valid image reference to be used in image certificate "
295 "validation tests when enabled. This image must also "
296 "have the required img_signature_* properties set. "
297 "Additional details available within the following Nova "
298 "documentation: https://docs.openstack.org/nova/latest/"
299 "user/certificate-validation.html"),
300 cfg.ListOpt('certified_image_trusted_certs',
301 help="A list of trusted certificates to be used when the "
302 "image certificate validation compute feature is "
303 "enabled."),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900304 cfg.StrOpt('flavor_ref',
305 default="1",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500306 help="Valid primary flavor to use in tests."),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900307 cfg.StrOpt('flavor_ref_alt',
308 default="2",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500309 help='Valid secondary flavor to be used in tests.'),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500310 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400311 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500312 help="Time in seconds between build status checks."),
313 cfg.IntOpt('build_timeout',
314 default=300,
Hugh Saunders5b139ad2014-12-15 09:08:41 +0000315 help="Timeout in seconds to wait for an instance to build. "
316 "Other services that do not define build_timeout will "
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200317 "inherit this value."),
Attila Fazekas0abbc952013-07-01 19:19:42 +0200318 cfg.IntOpt('ready_wait',
319 default=0,
DennyZhang8912d012013-09-25 18:08:34 -0500320 help="Additional wait time for clean state, when there is "
321 "no OS-EXT-STS extension available"),
Attila Fazekasb0661652013-05-08 13:01:36 +0200322 cfg.StrOpt('fixed_network_name',
Chris Hoge8f1401b2014-11-19 14:00:37 -0800323 help="Name of the fixed network that is visible to all test "
Sean Dagueed6e5862016-04-04 10:49:13 -0400324 "projects. If multiple networks are available for a "
325 "project, this is the network which will be used for "
326 "creating servers if tempest does not create a network or "
zhufl0bad33e2016-10-14 17:21:46 +0800327 "a network is not specified elsewhere. It may be used for "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000328 "ssh validation only if floating IPs are disabled."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500329 cfg.StrOpt('catalog_type',
330 default='compute',
331 help="Catalog type of the Compute service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900332 cfg.StrOpt('region',
333 default='',
334 help="The compute region name to use. If empty, the value "
335 "of identity.region is used instead. If no such region "
336 "is found in the service catalog, the first found one is "
337 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000338 cfg.StrOpt('endpoint_type',
339 default='publicURL',
340 choices=['public', 'admin', 'internal',
341 'publicURL', 'adminURL', 'internalURL'],
342 help="The endpoint type to use for the compute service."),
Ryan Hsucb2e1252013-09-03 21:44:49 -0700343 cfg.StrOpt('volume_device_name',
344 default='vdb',
345 help="Expected device name when a volume is attached to "
Kevin_Zheng79ec3342017-03-25 17:33:27 +0800346 "an instance. Not all hypervisors guarantee that they "
347 "will respect the user defined device name, tests may "
348 "fail if inappropriate device name is set."),
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900349 cfg.IntOpt('shelved_offload_time',
350 default=0,
351 help='Time in seconds before a shelved instance is eligible '
352 'for removing from a host. -1 never offload, 0 offload '
zhufl917b5552017-11-27 16:07:24 +0800353 'when shelved. This configuration value should be same as '
zhufldc7eeb42018-09-12 11:10:16 +0800354 'nova.conf: DEFAULT.shelved_offload_time, and '
zhufl917b5552017-11-27 16:07:24 +0800355 'some tests will run for as long as the time.'),
Sean Dague782f6772015-11-11 11:26:45 -0500356 cfg.IntOpt('min_compute_nodes',
357 default=1,
358 help=('The minimum number of compute nodes expected. This will '
359 'be utilized by some multinode specific tests to ensure '
360 'that requests match the expected size of the cluster '
ghanshyam29591532016-03-11 17:12:43 +0900361 'you are testing with.')),
Ken'ichi Ohmichi49db4fe2016-08-12 15:26:51 -0700362 cfg.StrOpt('hypervisor_type',
363 default=None,
364 help="Hypervisor type of the test target on heterogeneous "
365 "compute environment. The value can be 'QEMU', 'xen' or "
366 "something."),
Ken'ichi Ohmichi4d237e72015-11-05 06:32:33 +0000367 cfg.StrOpt('min_microversion',
368 default=None,
369 help="Lower version of the test target microversion range. "
370 "The format is 'X.Y', where 'X' and 'Y' are int values. "
371 "Tempest selects tests based on the range between "
372 "min_microversion and max_microversion. "
Ghanshyam395c5b52015-12-04 17:27:16 +0900373 "If both values are not specified, Tempest avoids tests "
374 "which require a microversion. Valid values are string "
ghanshyam8889d2b2017-02-14 02:29:06 +0000375 "with format 'X.Y' or string 'latest'"),
Ken'ichi Ohmichi4d237e72015-11-05 06:32:33 +0000376 cfg.StrOpt('max_microversion',
377 default=None,
378 help="Upper version of the test target microversion range. "
379 "The format is 'X.Y', where 'X' and 'Y' are int values. "
380 "Tempest selects tests based on the range between "
381 "min_microversion and max_microversion. "
Ghanshyam395c5b52015-12-04 17:27:16 +0900382 "If both values are not specified, Tempest avoids tests "
383 "which require a microversion. Valid values are string "
ghanshyam8889d2b2017-02-14 02:29:06 +0000384 "with format 'X.Y' or string 'latest'"),
Marc Koderer979e4942016-12-08 10:07:59 +0100385 cfg.StrOpt('compute_volume_common_az',
386 default=None,
387 help='AZ to be used for Cinder and Nova. Set this parameter '
388 'when the cloud has nova.conf: cinder.cross_az_attach '
389 'set to false. Which means volumes attached to an '
390 'instance must be in the same availability zone in Cinder '
391 'as the instance availability zone in Nova. Set the '
392 'common availability zone in this config which will be '
393 'used to boot an instance as well as creating a volume. '
394 'NOTE: If that AZ is not in Cinder (or '
395 'allow_availability_zone_fallback=False in cinder.conf), '
396 'the volume create request will fail and the instance '
397 'will fail the build request.'),
jskunda5a7ed972023-08-10 22:04:19 +0200398 cfg.StrOpt('migration_source_host',
399 default=None,
400 help="Specify source host for live-migration, cold-migration"
401 " and resize tests. If option is not set tests will use"
402 " host automatically."),
403 cfg.StrOpt('migration_dest_host',
404 default=None,
405 help="Specify destination host for live-migration and cold"
406 " migration. If option is not set tests will use host"
407 " automatically."),
408
ghanshyam29591532016-03-11 17:12:43 +0900409]
410
Lajos Katonaceb88212018-11-30 14:54:12 +0100411placement_group = cfg.OptGroup(name='placement',
412 title='Placement Service Options')
413
414PlacementGroup = [
415 cfg.StrOpt('endpoint_type',
416 default='public',
417 choices=['public', 'admin', 'internal'],
418 help="The endpoint type to use for the placement service."),
419 cfg.StrOpt('catalog_type',
420 default='placement',
421 help="Catalog type of the Placement service."),
422 cfg.StrOpt('region',
Swapnil Chhanikara89eea82020-01-24 17:04:42 +0530423 default='',
Lajos Katonaceb88212018-11-30 14:54:12 +0100424 help="The placement region name to use. If empty, the value "
425 "of [identity]/region is used instead. If no such region "
426 "is found in the service catalog, the first region found "
427 "is used."),
428 cfg.StrOpt('min_microversion',
429 default=None,
430 help="Lower version of the test target microversion range. "
431 "The format is 'X.Y', where 'X' and 'Y' are int values. "
432 "Valid values are string with format 'X.Y' or string "
433 "'latest'"),
434 cfg.StrOpt('max_microversion',
435 default=None,
436 help="Upper version of the test target microversion range. "
437 "The format is 'X.Y', where 'X' and 'Y' are int values. "
438 "Valid values are string with format 'X.Y' or string "
439 "'latest'"),
440]
441
442
ghanshyam29591532016-03-11 17:12:43 +0900443compute_features_group = cfg.OptGroup(name='compute-feature-enabled',
444 title="Enabled Compute Service Features")
445
446ComputeFeaturesGroup = [
Matthew Treinishd5c96022013-10-17 21:51:23 +0000447 cfg.BoolOpt('disk_config',
448 default=True,
449 help="If false, skip disk config tests"),
Pavan Kesava Raodeff57e2021-06-09 15:21:37 -0500450 # TODO(pkesav): Make it True by default once wallaby
451 # is oldest supported stable for Tempest.
452 cfg.BoolOpt('hostname_fqdn_sanitization',
453 default=False,
454 help="If false, skip fqdn instance sanitization tests. "
455 "Nova started sanitizing the instance name by replacing "
456 "the '.' with '-' to comply with fqdn hostname. Nova "
457 "changed that in Wallaby cycle, if your cloud is older "
458 "than wallaby then you can keep/make it False."),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000459 cfg.BoolOpt('change_password',
460 default=False,
461 help="Does the test environment support changing the admin "
462 "password?"),
Adam Gandelmanc6eefb42014-07-15 16:44:08 -0700463 cfg.BoolOpt('console_output',
464 default=True,
465 help="Does the test environment support obtaining instance "
466 "serial console output?"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000467 cfg.BoolOpt('resize',
468 default=False,
Masayuki Igawad91094d2017-04-12 16:20:09 +0900469 help="Does the test environment support resizing? When you "
470 "enable this feature, 'flavor_ref_alt' should be set and "
471 "it should refer to a larger flavor than 'flavor_ref' "
472 "one."),
Eric Windischb5538072014-03-09 23:47:35 -0400473 cfg.BoolOpt('pause',
474 default=True,
475 help="Does the test environment support pausing?"),
David Shrewsbury25f666f2014-07-22 12:17:59 -0400476 cfg.BoolOpt('shelve',
477 default=True,
478 help="Does the test environment support shelving/unshelving?"),
Alexandre Arents0a9b8232020-07-29 09:52:57 +0000479 cfg.BoolOpt('shelve_migrate',
480 default=False,
481 help="Does the test environment support "
482 "cold migration of unshelved server?"),
Eric Windischaeb7e842014-03-10 01:10:50 -0400483 cfg.BoolOpt('suspend',
484 default=True,
485 help="Does the test environment support suspend/resume?"),
Ludovic Beliveauae314882016-09-15 13:34:14 -0400486 cfg.BoolOpt('cold_migration',
487 default=True,
zhufl0bad33e2016-10-14 17:21:46 +0800488 help="Does the test environment support cold migration?"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000489 cfg.BoolOpt('live_migration',
Joe Gordon31a139a2014-11-17 16:39:04 -0800490 default=True,
zhufl0bad33e2016-10-14 17:21:46 +0800491 help="Does the test environment support live migration?"),
Sarafraj Singh61e40452016-09-29 13:06:59 -0500492 cfg.BoolOpt('live_migrate_back_and_forth',
493 default=False,
494 help="Does the test environment support live migrating "
495 "VM back and forth between different versions of "
496 "nova-compute?"),
YAMAMOTO Takashi1f62af22015-06-16 03:29:50 +0900497 cfg.BoolOpt('metadata_service',
498 default=True,
499 help="Does the test environment support metadata service? "
500 "Ignored unless validation.run_validation=true."),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000501 cfg.BoolOpt('block_migration_for_live_migration',
502 default=False,
503 help="Does the test environment use block devices for live "
504 "migration"),
zhuflbe052d62019-11-04 10:56:02 +0800505 cfg.BoolOpt('can_migrate_between_any_hosts',
506 default=True,
507 help="Does the test environment support migrating between "
508 "any hosts? In environments with non-homogeneous compute "
509 "nodes you can set this to False so that it will select "
510 "destination host for migrating automatically"),
Ghanshyam Mann41c17572014-02-27 18:52:56 +0900511 cfg.BoolOpt('vnc_console',
512 default=False,
513 help='Enable VNC console. This configuration value should '
zhufldc7eeb42018-09-12 11:10:16 +0800514 'be same as nova.conf: vnc.enabled'),
Ghanshyam70876d02014-03-11 11:40:18 +0900515 cfg.BoolOpt('spice_console',
516 default=False,
517 help='Enable Spice console. This configuration value should '
zhufld5bda712019-11-01 14:01:01 +0800518 'be same as nova.conf: spice.enabled',
519 deprecated_for_removal=True,
520 deprecated_reason="This config option is not being used "
521 "in Tempest, we can add it back when "
522 "adding the test cases."),
Markus Zoeller69d58b82017-02-17 10:09:22 +0100523 cfg.BoolOpt('serial_console',
524 default=False,
525 help='Enable serial console. This configuration value '
zhufldc7eeb42018-09-12 11:10:16 +0800526 'should be the same as '
527 'nova.conf: serial_console.enabled'),
Adam Gandelman2e37b4f2014-06-18 17:34:21 -0700528 cfg.BoolOpt('rescue',
529 default=True,
530 help='Does the test environment support instance rescue '
Ghanshyam9c2e50d2014-07-22 21:32:05 +0900531 'mode?'),
Lee Yarwoodc0ad55c2019-12-06 13:39:19 +0000532 cfg.BoolOpt('stable_rescue',
533 default=False,
534 help='Does the test environment support stable device '
535 'instance rescue mode?'),
Ghanshyam9c2e50d2014-07-22 21:32:05 +0900536 cfg.BoolOpt('enable_instance_password',
537 default=True,
538 help='Enables returning of the instance password by the '
539 'relevant server API calls such as create, rebuild '
zhufle8a703b2016-09-09 15:23:03 +0800540 'or rescue. This configuration value should be same as '
541 'nova.conf: DEFAULT.enable_instance_password'),
Adam Gandelman7186f7a2014-07-23 09:28:56 -0400542 cfg.BoolOpt('interface_attach',
543 default=True,
544 help='Does the test environment support dynamic network '
Adam Gandelmanfbc95ac2014-06-19 17:33:43 -0700545 'interface attachment?'),
546 cfg.BoolOpt('snapshot',
547 default=True,
548 help='Does the test environment support creating snapshot '
Matthew Treinishdfd7ac02015-02-09 17:47:31 -0500549 'images of running instances?'),
Takeaki Matsumotod7e04b22015-09-04 15:13:38 +0900550 cfg.BoolOpt('personality',
Matt Riedemann0baba702016-07-03 19:24:08 -0400551 default=False,
Takeaki Matsumotod7e04b22015-09-04 15:13:38 +0900552 help='Does the test environment support server personality'),
Matt Riedemann79b3b492015-06-20 14:20:44 -0700553 cfg.BoolOpt('attach_encrypted_volume',
554 default=True,
555 help='Does the test environment support attaching an '
556 'encrypted volume to a running server instance? This may '
557 'depend on the combination of compute_driver in nova and '
558 'the volume_driver(s) in cinder.'),
Alexander Gubanov509e2842015-06-09 15:29:51 +0300559 cfg.BoolOpt('config_drive',
560 default=True,
561 help='Enable special configuration drive with metadata.'),
Artom Lifshitz595ae162018-05-23 10:19:18 -0400562 cfg.ListOpt('scheduler_enabled_filters',
Artom Lifshitz1c976a92019-06-17 15:30:18 -0400563 default=["AvailabilityZoneFilter", "ComputeFilter",
564 "ComputeCapabilitiesFilter", "ImagePropertiesFilter",
Artom Lifshitz595ae162018-05-23 10:19:18 -0400565 "ServerGroupAntiAffinityFilter",
566 "ServerGroupAffinityFilter"],
567 help="A list of enabled filters that Nova will accept as "
568 "hints to the scheduler when creating a server. If the "
ghanshyam5817e142016-12-01 11:38:46 +0900569 "default value is overridden in nova.conf by the test "
570 "environment (which means that a different set of "
571 "filters is enabled than what is included in Nova by "
Artom Lifshitz595ae162018-05-23 10:19:18 -0400572 "default), then this option must be configured to "
ghanshyam5817e142016-12-01 11:38:46 +0900573 "contain the same filters that Nova uses in the test "
Artom Lifshitz595ae162018-05-23 10:19:18 -0400574 "environment. A special entry 'all' indicates all "
575 "filters that are included with Nova are enabled. If "
576 "using 'all', be sure to enable all filters in "
577 "nova.conf, as tests can fail in unpredictable ways if "
578 "Nova's and Tempest's enabled filters don't match. "
579 "Empty list indicates all filters are disabled. The "
580 "full list of enabled filters is in nova.conf: "
581 "filter_scheduler.enabled_filters.",
582 deprecated_opts=[cfg.DeprecatedOpt(
583 'scheduler_available_filters',
584 group='compute-feature-enabled')]),
Matt Riedemann342b37c2016-09-21 15:38:12 -0400585 cfg.BoolOpt('swap_volume',
586 default=False,
587 help='Does the test environment support in-place swapping of '
588 'volumes attached to a server instance?'),
melanie witt334f3132017-12-14 21:49:55 +0000589 cfg.BoolOpt('volume_backed_live_migration',
590 default=False,
591 help='Does the test environment support volume-backed live '
592 'migration?'),
Matt Riedemann81fa9b62016-01-14 13:04:38 -0800593 cfg.BoolOpt('volume_multiattach',
594 default=False,
595 help='Does the test environment support attaching a volume to '
596 'more than one instance? This depends on hypervisor and '
597 'volume backend/type and compute API version 2.60.'),
Stephen Finucane39fa9c12020-09-03 17:47:19 +0100598 cfg.BoolOpt('xenapi_apis',
599 default=False,
600 help='Does the test environment support the XenAPI-specific '
601 'APIs: os-agents, writeable server metadata and the '
602 'resetNetwork server action? '
603 'These were removed in Victoria alongside the XenAPI '
604 'virt driver.',
605 deprecated_for_removal=True,
606 deprecated_reason="On Nova side, XenAPI virt driver and the "
607 "APIs that only worked with that driver "
608 "have been removed and there's nothing to "
609 "test after Ussuri."),
Lee Yarwood56a446d2021-02-15 13:34:35 +0000610 cfg.BoolOpt('ide_bus',
611 default=True,
612 help='Does the test environment support attaching devices '
613 'using an IDE bus to the instance?'),
melanie witt74fa5052021-05-06 22:41:30 +0000614 cfg.BoolOpt('unified_limits',
615 default=False,
616 help='Does the test environment support unified limits?'),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000617]
618
619
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500620image_group = cfg.OptGroup(name='image',
621 title="Image Service Options")
Jay Pipesf38eaac2012-06-21 13:37:35 -0400622
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500623ImageGroup = [
Matthew Treinish72ea4422013-02-07 14:42:49 -0500624 cfg.StrOpt('catalog_type',
625 default='image',
Sean Dague83401992013-05-06 17:46:36 -0400626 help='Catalog type of the Image service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900627 cfg.StrOpt('region',
628 default='',
629 help="The image region name to use. If empty, the value "
630 "of identity.region is used instead. If no such region "
631 "is found in the service catalog, the first found one is "
632 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000633 cfg.StrOpt('endpoint_type',
634 default='publicURL',
635 choices=['public', 'admin', 'internal',
636 'publicURL', 'adminURL', 'internalURL'],
637 help="The endpoint type to use for the image service."),
Dan Smithd4bc9a82021-01-12 17:25:07 -0800638 cfg.StrOpt('alternate_image_endpoint',
639 default=None,
640 help="Alternate endpoint name for cross-worker testing"),
641 cfg.StrOpt('alternate_image_endpoint_type',
642 default='publicURL',
643 choices=['public', 'admin', 'internal',
644 'publicURL', 'adminURL', 'internalURL'],
645 help=("The endpoint type to use for the alternate image "
646 "service.")),
Abhishek Kekane0188f462022-01-18 06:47:28 +0000647 cfg.BoolOpt('image_caching_enabled',
648 default=False,
649 help=("Flag to enable if caching is enabled by image "
650 "service, operator should set this parameter to True"
651 "if 'image_cache_dir' is set in glance-api.conf")),
Sean Dague83401992013-05-06 17:46:36 -0400652 cfg.StrOpt('http_image',
653 default='http://download.cirros-cloud.net/0.3.1/'
654 'cirros-0.3.1-x86_64-uec.tar.gz',
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200655 help='http accessible image'),
656 cfg.IntOpt('build_timeout',
657 default=300,
658 help="Timeout in seconds to wait for an image to "
659 "become available."),
660 cfg.IntOpt('build_interval',
661 default=1,
662 help="Time in seconds between image operation status "
Takashi NATSUME12a48512015-08-10 18:33:16 +0900663 "checks."),
664 cfg.ListOpt('container_formats',
665 default=['ami', 'ari', 'aki', 'bare', 'ovf', 'ova'],
666 help="A list of image's container formats "
667 "users can specify."),
668 cfg.ListOpt('disk_formats',
669 default=['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2',
Benny Kopilov97c74192017-03-30 09:34:59 +0300670 'vdi', 'iso', 'vhdx'],
Takashi NATSUME12a48512015-08-10 18:33:16 +0900671 help="A list of image's disk formats "
672 "users can specify.")
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500673]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400674
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000675image_feature_group = cfg.OptGroup(name='image-feature-enabled',
676 title='Enabled image service features')
677
678ImageFeaturesGroup = [
679 cfg.BoolOpt('api_v2',
680 default=True,
ghanshyam6b0b8b72017-03-08 04:22:53 +0000681 help="Is the v2 image API enabled",
682 deprecated_for_removal=True,
683 deprecated_reason='Glance v1 APIs are deprecated and v2 APIs '
684 'are current one. In future, Tempest will '
685 'test v2 APIs only so this config option '
686 'will be removed.'),
Abhishek Kekane7cff1302020-07-16 10:30:13 +0000687 # Image import feature is setup in devstack victoria onwards.
688 # Once all stable branches setup the same via glance standalone
689 # mode or with uwsgi, we can remove this config option.
690 cfg.BoolOpt('import_image',
691 default=False,
692 help="Is image import feature enabled"),
Dan Smithe044dad2021-01-15 12:45:16 -0800693 # NOTE(danms): Starting mid-Wallaby glance began enforcing the
694 # previously-informal requirement that os_glance_* properties are
695 # reserved for internal use. Thus, we can only run these checks
696 # if we know we are on a new enough glance.
697 cfg.BoolOpt('os_glance_reserved',
698 default=False,
699 help="Should we check that os_glance namespace is reserved"),
Dan Smith9eaaa5a2022-10-07 09:16:20 -0700700 cfg.BoolOpt('manage_locations',
701 default=False,
702 help=('Is show_multiple_locations enabled in glance. '
703 'Note that at least one http store must be enabled as '
704 'well, because we use that location scheme to test.')),
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000705]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400706
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500707network_group = cfg.OptGroup(name='network',
708 title='Network Service Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600709
Noam Angel3c6b0162018-07-08 17:05:35 +0300710ProfileType = types.Dict(types.List(types.String(), bounds=True))
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500711NetworkGroup = [
712 cfg.StrOpt('catalog_type',
713 default='network',
Mark McClainf2982e82013-07-06 17:48:03 -0400714 help='Catalog type of the Neutron service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900715 cfg.StrOpt('region',
716 default='',
717 help="The network region name to use. If empty, the value "
718 "of identity.region is used instead. If no such region "
719 "is found in the service catalog, the first found one is "
720 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000721 cfg.StrOpt('endpoint_type',
722 default='publicURL',
723 choices=['public', 'admin', 'internal',
724 'publicURL', 'adminURL', 'internalURL'],
725 help="The endpoint type to use for the network service."),
Sean Dagueed6e5862016-04-04 10:49:13 -0400726 cfg.StrOpt('project_network_cidr',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500727 default="10.100.0.0/16",
Sean Dagueed6e5862016-04-04 10:49:13 -0400728 help="The cidr block to allocate project ipv4 subnets from"),
729 cfg.IntOpt('project_network_mask_bits',
Attila Fazekas8ea181b2013-07-13 16:26:14 +0200730 default=28,
Sean Dagueed6e5862016-04-04 10:49:13 -0400731 help="The mask bits for project ipv4 subnets"),
732 cfg.StrOpt('project_network_v6_cidr',
Brian Haley56893552019-09-19 17:50:37 -0400733 default="2001:db8::/48",
Sean Dagueed6e5862016-04-04 10:49:13 -0400734 help="The cidr block to allocate project ipv6 subnets from"),
735 cfg.IntOpt('project_network_v6_mask_bits',
Sergey Shnaidman1f3659a2014-08-27 18:26:42 +0400736 default=64,
Sean Dagueed6e5862016-04-04 10:49:13 -0400737 help="The mask bits for project ipv6 subnets"),
738 cfg.BoolOpt('project_networks_reachable',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500739 default=False,
Sean Dagueed6e5862016-04-04 10:49:13 -0400740 help="Whether project networks can be reached directly from "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000741 "the test client. This must be set to True when the "
Matt Riedemann4b0f7e72016-08-08 15:29:26 -0400742 "'fixed' connect_method is selected."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500743 cfg.StrOpt('public_network_id',
744 default="",
745 help="Id of the public network that provides external "
746 "connectivity"),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000747 cfg.StrOpt('floating_network_name',
748 help="Default floating network name. Used to allocate floating "
749 "IPs when neutron is enabled."),
Lukas Piwowarski2385e042020-01-31 12:28:20 +0000750 cfg.StrOpt('subnet_id',
751 default="",
752 help="Subnet id of subnet which is used for allocation of "
753 "floating IPs. Specify when two or more subnets are "
754 "present in network."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500755 cfg.StrOpt('public_router_id',
756 default="",
757 help="Id of the public router that provides external "
Yair Fried1eb27f52014-11-10 15:24:19 +0200758 "connectivity. This should only be used when Neutron's "
759 "'allow_overlapping_ips' is set to 'False' in "
760 "neutron.conf. usually not needed past 'Grizzly' release"),
izikpensod9a01a62014-02-17 20:02:32 +0200761 cfg.IntOpt('build_timeout',
762 default=300,
763 help="Timeout in seconds to wait for network operation to "
764 "complete."),
765 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400766 default=1,
izikpensod9a01a62014-02-17 20:02:32 +0200767 help="Time in seconds between network operation status "
768 "checks."),
Attila Fazekas640392b2014-06-12 15:58:10 +0200769 cfg.ListOpt('dns_servers',
770 default=["8.8.8.8", "8.8.4.4"],
Itzik Brown5be44582014-12-24 09:05:13 +0200771 help="List of dns servers which should be used"
zhufle027ea92019-05-07 14:02:23 +0800772 " for subnet creation",
773 deprecated_for_removal=True,
774 deprecated_reason="This config option is no longer "
775 "used anywhere, so it can be removed."),
Itzik Brown2ca01cd2014-12-08 12:58:20 +0200776 cfg.StrOpt('port_vnic_type',
Tom Stappaerts27fd5cb2020-11-26 12:07:47 +0100777 choices=[None, 'normal', 'direct', 'macvtap', 'direct-physical',
778 'baremetal', 'virtio-forwarder'],
Moshe Levie2c2fb12017-08-31 15:18:58 +0300779 help="vnic_type to use when launching instances"
Itzik Brown2ca01cd2014-12-08 12:58:20 +0200780 " with pre-configured ports."
781 " Supported ports are:"
Tom Stappaerts27fd5cb2020-11-26 12:07:47 +0100782 " ['normal', 'direct', 'macvtap', 'direct-physical', "
783 "'baremetal', 'virtio-forwarder']"),
Noam Angel3c6b0162018-07-08 17:05:35 +0300784 cfg.Opt('port_profile',
785 type=ProfileType,
786 default={},
787 help="port profile to use when launching instances"
788 " with pre-configured ports."),
piyush11078648e35d52015-09-24 12:56:43 +0530789 cfg.ListOpt('default_network',
790 default=["1.0.0.0/16", "2.0.0.0/16"],
791 help="List of ip pools"
792 " for subnetpools creation"),
Thiago Paiva66cded22016-08-15 14:55:58 -0300793 cfg.BoolOpt('shared_physical_network',
794 default=False,
795 help="The environment does not support network separation "
796 "between tenants."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500797]
Jay Pipes3f981df2012-03-27 18:59:44 -0400798
Matthew Treinishe3d26142013-11-26 19:14:58 +0000799network_feature_group = cfg.OptGroup(name='network-feature-enabled',
800 title='Enabled network service features')
801
802NetworkFeaturesGroup = [
Matthew Treinishe2e33cf2014-03-03 19:28:41 +0000803 cfg.BoolOpt('ipv6',
804 default=True,
Brian Haley3d701092020-11-23 14:03:25 -0500805 help="Allow the execution of IPv6 tests."),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000806 cfg.ListOpt('api_extensions',
807 default=['all'],
Alexander Gubanov36e1f9b2015-06-12 18:02:10 +0300808 help="A list of enabled network extensions with a special "
809 "entry all which indicates every extension is enabled. "
810 "Empty list indicates all extensions are disabled. "
Brian Haley3d701092020-11-23 14:03:25 -0500811 "To get the list of extensions run: "
812 "'openstack extension list --network'"),
elajkatf9bb8b82020-11-02 13:41:06 +0100813 cfg.ListOpt('available_features',
814 default=['all'],
815 help="A list of available network features with a special "
816 "entry all that indicates every feature is available. "
Brian Haley3d701092020-11-23 14:03:25 -0500817 "Empty list indicates all features are disabled. "
elajkatf9bb8b82020-11-02 13:41:06 +0100818 "This list can contain features that are not "
Brian Haley3d701092020-11-23 14:03:25 -0500819 "discoverable through the API."),
Sean M. Collinsdd27a4d2014-05-13 10:33:15 -0400820 cfg.BoolOpt('ipv6_subnet_attributes',
821 default=False,
822 help="Allow the execution of IPv6 subnet tests that use "
823 "the extended IPv6 attributes ipv6_ra_mode "
Brian Haley3d701092020-11-23 14:03:25 -0500824 "and ipv6_address_mode."
Mark McClain6e07c0d2014-10-10 11:25:03 -0400825 ),
Itzik Brownbeb30d32015-03-29 09:42:54 +0300826 cfg.BoolOpt('port_admin_state_change',
827 default=True,
Brian Haley3d701092020-11-23 14:03:25 -0500828 help="Does the test environment support changing "
829 "port admin state?"),
Matt Riedemann039b2fe2016-09-15 16:12:24 -0400830 cfg.BoolOpt('port_security',
831 default=False,
832 help="Does the test environment support port security?"),
Matthew Treinish3312de32017-05-19 12:08:17 -0400833 cfg.BoolOpt('floating_ips',
834 default=True,
Brian Haley3d701092020-11-23 14:03:25 -0500835 help='Does the test environment support floating_ips?'),
Lajos Katonac87a06b2019-01-04 13:21:48 +0100836 cfg.StrOpt('qos_placement_physnet', default=None,
837 help='Name of the physnet for placement based minimum '
838 'bandwidth allocation.'),
Takashi Kajinami7138e352022-02-03 09:16:34 +0900839 cfg.StrOpt('provider_net_base_segmentation_id', default='3000',
Lajos Katonac87a06b2019-01-04 13:21:48 +0100840 help='Base segmentation ID to create provider networks. '
Balazs Gibizerf294b0d2021-09-29 16:16:44 +0200841 'This value will be increased in case of conflict.'),
842 cfg.BoolOpt('qos_min_bw_and_pps', default=False,
843 help='Does the test environment have minimum bandwidth and '
844 'packet rate inventories configured?'),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000845]
846
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -0600847dashboard_group = cfg.OptGroup(name="dashboard",
848 title="Dashboard options")
849
850DashboardGroup = [
Takashi Kajinami0ed15dc2024-01-24 11:09:53 +0900851 cfg.URIOpt('dashboard_url',
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -0600852 default='http://localhost/',
Takashi Kajinami0ed15dc2024-01-24 11:09:53 +0900853 schemes=['http', 'https'],
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -0600854 help="Where the dashboard can be found"),
855 cfg.BoolOpt('disable_ssl_certificate_validation',
856 default=False,
857 help="Set to True if using self-signed SSL certificates."),
858]
859
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000860validation_group = cfg.OptGroup(name='validation',
861 title='SSH Validation options')
862
863ValidationGroup = [
Matthew Treinishe5cca002015-05-11 15:36:50 -0400864 cfg.BoolOpt('run_validation',
Attila Fazekas489e90f2018-09-12 17:30:01 -0600865 default=True,
Matthew Treinishe5cca002015-05-11 15:36:50 -0400866 help='Enable ssh on created servers and creation of additional'
Attila Fazekas489e90f2018-09-12 17:30:01 -0600867 ' validation resources to enable remote access.'
868 ' In case the guest does not support ssh set it'
869 ' to false'),
Brandon Palmc6cc91d2015-08-19 13:20:21 -0500870 cfg.BoolOpt('security_group',
871 default=True,
872 help='Enable/disable security groups.'),
873 cfg.BoolOpt('security_group_rules',
874 default=True,
875 help='Enable/disable security group rules.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000876 cfg.StrOpt('connect_method',
877 default='floating',
Takashi Kajinamib9f775d2024-01-20 11:17:33 +0900878 choices=[('fixed',
879 'uses the first IP belonging to the fixed network'),
880 ('floating',
881 'creates and uses a floating IP')],
882 help='Default IP type used for validation'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000883 cfg.StrOpt('auth_method',
884 default='keypair',
885 choices=['keypair'],
886 help='Default authentication method to the instance. '
887 'Only ssh via keypair is supported for now. '
ghanshyamade71d22017-02-15 05:36:14 +0000888 'Additional methods will be handled in a separate spec.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000889 cfg.IntOpt('ip_version_for_ssh',
890 default=4,
lanoux283273b2015-12-04 03:01:54 -0800891 help='Default IP version for ssh connections.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000892 cfg.IntOpt('ping_timeout',
893 default=120,
ghanshyam244cf7c2017-02-15 06:39:31 +0000894 help='Timeout in seconds to wait for ping to succeed.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000895 cfg.IntOpt('connect_timeout',
896 default=60,
897 help='Timeout in seconds to wait for the TCP connection to be '
lanoux283273b2015-12-04 03:01:54 -0800898 'successful.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000899 cfg.IntOpt('ssh_timeout',
900 default=300,
lanoux283273b2015-12-04 03:01:54 -0800901 help='Timeout in seconds to wait for the ssh banner.'),
902 cfg.StrOpt('image_ssh_user',
903 default="root",
ghanshyam244cf7c2017-02-15 06:39:31 +0000904 help="User name used to authenticate to an instance."),
Weronika Sikorac54a9112019-09-18 13:55:07 +0000905 cfg.StrOpt('image_alt_ssh_user',
906 default="root",
907 help="User name used to authenticate to an alt instance."),
lanoux283273b2015-12-04 03:01:54 -0800908 cfg.StrOpt('image_ssh_password',
909 default="password",
Doug Schveninger6a2be432020-04-29 17:42:31 -0500910 help="Password used to authenticate to an instance.",
911 secret=True),
Weronika Sikorac54a9112019-09-18 13:55:07 +0000912 cfg.StrOpt('image_alt_ssh_password',
913 default="password",
914 help="Password used to authenticate to an alt instance.",
915 secret=True),
lanoux283273b2015-12-04 03:01:54 -0800916 cfg.StrOpt('ssh_shell_prologue',
Lucian Petrut6a7472a2019-08-07 12:43:08 +0300917 default="set -eu -o pipefail; PATH=$$PATH:/sbin:/usr/sbin;",
lanoux283273b2015-12-04 03:01:54 -0800918 help="Shell fragments to use before executing a command "
ghanshyamade71d22017-02-15 05:36:14 +0000919 "when sshing to a guest."),
lanoux283273b2015-12-04 03:01:54 -0800920 cfg.IntOpt('ping_size',
921 default=56,
922 help="The packet size for ping packets originating "
ghanshyamade71d22017-02-15 05:36:14 +0000923 "from remote linux hosts"),
lanoux283273b2015-12-04 03:01:54 -0800924 cfg.IntOpt('ping_count',
925 default=1,
926 help="The number of ping packets originating from remote "
ghanshyamade71d22017-02-15 05:36:14 +0000927 "linux hosts"),
lanoux283273b2015-12-04 03:01:54 -0800928 cfg.StrOpt('floating_ip_range',
929 default='10.0.0.0/29',
930 help='Unallocated floating IP range, which will be used to '
931 'test the floating IP bulk feature for CRUD operation. '
932 'This block must not overlap an existing floating IP '
ghanshyamade71d22017-02-15 05:36:14 +0000933 'pool.'),
lanoux283273b2015-12-04 03:01:54 -0800934 cfg.StrOpt('network_for_ssh',
935 default='public',
936 help="Network used for SSH connections. Ignored if "
ghanshyam244cf7c2017-02-15 06:39:31 +0000937 "connect_method=floating."),
Ade Lee6ded0702021-09-04 15:56:34 -0400938 cfg.StrOpt('ssh_key_type',
Martin Kopec75ca0b82022-04-20 17:57:45 +0200939 default='ecdsa',
Ade Lee6ded0702021-09-04 15:56:34 -0400940 help='Type of key to use for ssh connections. '
941 'Valid types are rsa, ecdsa'),
Roman Safronovf2357852023-02-20 15:21:13 +0200942 cfg.FloatOpt('allowed_network_downtime',
943 default=5.0,
944 help="Allowed VM network connection downtime during live "
945 "migration, in seconds. "
946 "When the measured downtime exceeds this value, an "
947 "exception is raised."),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000948]
949
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500950volume_group = cfg.OptGroup(name='volume',
951 title='Block Storage Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600952
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500953VolumeGroup = [
954 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400955 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500956 help='Time in seconds between volume availability checks.'),
957 cfg.IntOpt('build_timeout',
958 default=300,
Eric Harney9b1f89c2014-10-14 14:40:19 -0400959 help='Timeout in seconds to wait for a volume to become '
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500960 'available.'),
961 cfg.StrOpt('catalog_type',
ghanshyam89c213f2017-12-14 07:22:12 +0000962 default='volumev3',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500963 help="Catalog type of the Volume Service"),
Arata Notsu8f440392013-09-13 16:14:20 +0900964 cfg.StrOpt('region',
965 default='',
966 help="The volume region name to use. If empty, the value "
967 "of identity.region is used instead. If no such region "
968 "is found in the service catalog, the first found one is "
969 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000970 cfg.StrOpt('endpoint_type',
971 default='publicURL',
972 choices=['public', 'admin', 'internal',
973 'publicURL', 'adminURL', 'internalURL'],
974 help="The endpoint type to use for the volume service."),
Lukáš Piwowarski553d91b2023-09-21 11:14:24 +0200975 cfg.StrOpt('backup_driver',
976 default='ceph',
977 choices=['ceph', 'swift', 'nfs', 'glusterfs', 'posix', 'google',
978 's3'],
979 help="What kind of backup_driver does cinder use?"
980 "https://docs.openstack.org/cinder/latest/configuration/"
981 "block-storage/backup-drivers.html"),
Benny Kopilovaf136a92015-11-10 07:37:23 +0200982 cfg.ListOpt('backend_names',
983 default=['BACKEND_1', 'BACKEND_2'],
april4be58dc2015-12-29 00:07:22 +0800984 help='A list of backend names separated by comma. '
bkopilov27905cc2016-04-12 14:29:13 +0300985 'The backend name must be declared in cinder.conf'),
Ansuman Bebarta46d540d2021-02-16 18:48:33 +0530986 cfg.StrOpt('volume_type',
987 default='',
988 help='Volume type to be used while creating volume.'),
whoami-rajatb04b1022023-02-27 09:41:22 +0000989 cfg.StrOpt('volume_type_multiattach',
990 default='',
991 help='Multiattach volume type used while creating multiattach '
992 'volume.'),
Adam Gandelman827ad332013-06-24 17:04:09 -0700993 cfg.StrOpt('storage_protocol',
994 default='iSCSI',
995 help='Backend protocol to target when creating volume types'),
996 cfg.StrOpt('vendor_name',
997 default='Open Source',
998 help='Backend vendor to target when creating volume types'),
Ryan Hsua67f4632013-08-29 16:03:06 -0700999 cfg.StrOpt('disk_format',
1000 default='raw',
1001 help='Disk format to use when copying a volume to image'),
Jerry Cai9733d0e2014-03-19 15:50:49 +08001002 cfg.IntOpt('volume_size',
1003 default=1,
1004 help='Default size in GB for volumes created by volumes tests'),
Martin Kopec37c4bd32021-06-24 15:46:00 +00001005 cfg.IntOpt('volume_size_extend',
1006 default=1,
1007 help="Size in GB a volume is extended by - if a test "
1008 "extends a volume, the size of the new volume will be "
1009 "volume_size + volume_size_extend."),
jeremy.zhangf4fbf302017-03-22 11:25:53 +08001010 cfg.ListOpt('manage_volume_ref',
1011 default=['source-name', 'volume-%s'],
1012 help="A reference to existing volume for volume manage. "
1013 "It contains two elements, the first is ref type "
1014 "(like 'source-name', 'source-id', etc), the second is "
1015 "volume name template used in storage backend"),
jeremy.zhangebc752b2017-06-14 13:58:37 +08001016 cfg.ListOpt('manage_snapshot_ref',
1017 default=['source-name', '_snapshot-%s'],
1018 help="A reference to existing snapshot for snapshot manage. "
1019 "It contains two elements, the first is ref type "
1020 "(like 'source-name', 'source-id', etc), the second is "
1021 "snapshot name template used in storage backend"),
Andrew Kerrfcb0b682016-04-01 16:01:34 -04001022 cfg.StrOpt('min_microversion',
1023 default=None,
1024 help="Lower version of the test target microversion range. "
1025 "The format is 'X.Y', where 'X' and 'Y' are int values. "
1026 "Tempest selects tests based on the range between "
1027 "min_microversion and max_microversion. "
1028 "If both values are not specified, Tempest avoids tests "
1029 "which require a microversion. Valid values are string "
1030 "with format 'X.Y' or string 'latest'",),
1031 cfg.StrOpt('max_microversion',
1032 default=None,
1033 help="Upper version of the test target microversion range. "
1034 "The format is 'X.Y', where 'X' and 'Y' are int values. "
1035 "Tempest selects tests based on the range between "
1036 "min_microversion and max_microversion. "
1037 "If both values are not specified, Tempest avoids tests "
1038 "which require a microversion. Valid values are string "
1039 "with format 'X.Y' or string 'latest'",),
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001040]
K Jonathan Harkerd6ba4b42012-12-18 13:50:47 -08001041
Matthew Treinishd5c96022013-10-17 21:51:23 +00001042volume_feature_group = cfg.OptGroup(name='volume-feature-enabled',
1043 title='Enabled Cinder Features')
1044
1045VolumeFeaturesGroup = [
1046 cfg.BoolOpt('multi_backend',
1047 default=False,
Matthew Treinishe3d26142013-11-26 19:14:58 +00001048 help="Runs Cinder multi-backend test (requires 2 backends)"),
Giulio Fidente74b08ad2014-01-18 04:02:51 +01001049 cfg.BoolOpt('backup',
1050 default=True,
1051 help='Runs Cinder volumes backup test'),
JordanPbce55532014-03-19 12:10:32 +01001052 cfg.BoolOpt('snapshot',
1053 default=True,
1054 help='Runs Cinder volume snapshot test'),
Takeaki Matsumoto1702aed2015-08-25 08:44:26 +09001055 cfg.BoolOpt('clone',
1056 default=True,
1057 help='Runs Cinder volume clone test'),
Jordan Pittier31256252017-01-11 14:29:49 +01001058 cfg.BoolOpt('manage_snapshot',
1059 default=False,
1060 help='Runs Cinder manage snapshot tests'),
jeremy.zhangf4fbf302017-03-22 11:25:53 +08001061 cfg.BoolOpt('manage_volume',
1062 default=False,
1063 help='Runs Cinder manage volume tests'),
Matthew Treinishe3d26142013-11-26 19:14:58 +00001064 cfg.ListOpt('api_extensions',
1065 default=['all'],
Zhi Kun Liude25c022014-02-14 13:25:19 +08001066 help='A list of enabled volume extensions with a special '
Simeon Monov5d7effe2014-07-16 07:32:38 +03001067 'entry all which indicates every extension is enabled. '
1068 'Empty list indicates all extensions are disabled'),
Matt Riedemann0cc76bf2017-07-05 17:29:31 -04001069 cfg.BoolOpt('extend_attached_volume',
1070 default=False,
1071 help='Does the cloud support extending the size of a volume '
1072 'which is currently attached to a server instance? This '
1073 'depends on the 3.42 volume API microversion and the '
1074 '2.51 compute API microversion. Also, not all volume or '
Lee Yarwood4bd9edb2020-01-31 17:26:25 +00001075 'compute backends support this operation.'),
1076 cfg.BoolOpt('extend_attached_encrypted_volume',
1077 default=False,
1078 help='Does the cloud support extending the size of an '
1079 'encrypted volume which is currently attached to a '
1080 'server instance? This depends on the 3.42 volume API '
1081 'microversion and the 2.51 compute API microversion. '
1082 'Also, not all volume or compute backends support this '
Jake Yip2ba26af2023-05-05 20:37:10 +10001083 'operation.'),
1084 cfg.BoolOpt('extend_volume_with_snapshot',
1085 default=True,
1086 help='Does the cloud support extending the size of a volume '
1087 'which has snapshot? Some drivers do not support this '
Lee Yarwood4bd9edb2020-01-31 17:26:25 +00001088 'operation.')
Jake Yip2ba26af2023-05-05 20:37:10 +10001089
Matthew Treinishd5c96022013-10-17 21:51:23 +00001090]
1091
Daryl Walleck587385b2012-03-03 13:00:26 -06001092
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001093object_storage_group = cfg.OptGroup(name='object-storage',
1094 title='Object Storage Service Options')
Attila Fazekasa23f5002012-10-23 19:32:45 +02001095
DennyZhang1e71b612013-09-26 12:35:40 -05001096ObjectStoreGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001097 cfg.StrOpt('catalog_type',
1098 default='object-store',
1099 help="Catalog type of the Object-Storage service."),
Arata Notsu8f440392013-09-13 16:14:20 +09001100 cfg.StrOpt('region',
1101 default='',
1102 help="The object-storage region name to use. If empty, the "
1103 "value of identity.region is used instead. If no such "
1104 "region is found in the service catalog, the first found "
1105 "one is used."),
JordanP5d29b2c2013-12-18 13:56:03 +00001106 cfg.StrOpt('endpoint_type',
1107 default='publicURL',
1108 choices=['public', 'admin', 'internal',
1109 'publicURL', 'adminURL', 'internalURL'],
1110 help="The endpoint type to use for the object-store service."),
Matthew Treinishf319a732013-10-24 21:39:24 +00001111 cfg.IntOpt('container_sync_timeout',
Daisuke Morita1ac3ee02014-08-25 12:59:18 +09001112 default=600,
Fabien Boucher2178d312013-12-31 15:38:57 +01001113 help="Number of seconds to time on waiting for a container "
nayna-patelb4989b32013-01-09 06:25:13 +00001114 "to container synchronization complete."),
Matthew Treinishf319a732013-10-24 21:39:24 +00001115 cfg.IntOpt('container_sync_interval',
nayna-patelb4989b32013-01-09 06:25:13 +00001116 default=5,
Fabien Boucher2178d312013-12-31 15:38:57 +01001117 help="Number of seconds to wait while looping to check the "
nayna-patelb4989b32013-01-09 06:25:13 +00001118 "status of a container to container synchronization"),
Matthew Treinish3fdb80c2013-08-15 11:13:19 -04001119 cfg.StrOpt('operator_role',
Martin Kopec99d4dae2020-05-27 10:33:17 +00001120 default='member',
Matthew Treinish3fdb80c2013-08-15 11:13:19 -04001121 help="Role to add to users created for swift tests to "
1122 "enable creating containers"),
Matthew Treinish998c91d2014-03-01 12:39:49 -05001123 cfg.StrOpt('reseller_admin_role',
1124 default='ResellerAdmin',
1125 help="User role that has reseller admin"),
Daisuke Morita1ac3ee02014-08-25 12:59:18 +09001126 cfg.StrOpt('realm_name',
1127 default='realm1',
1128 help="Name of sync realm. A sync realm is a set of clusters "
1129 "that have agreed to allow container syncing with each "
1130 "other. Set the same realm name as Swift's "
1131 "container-sync-realms.conf"),
1132 cfg.StrOpt('cluster_name',
1133 default='name1',
1134 help="One name of cluster which is set in the realm whose name "
1135 "is set in 'realm_name' item in this file. Set the "
1136 "same cluster name as Swift's container-sync-realms.conf"),
Bas de Bruijnec9f9a032022-07-19 11:16:02 -03001137 cfg.IntOpt('build_timeout',
1138 default=10,
1139 help="Timeout in seconds to wait for objects to create."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001140]
Attila Fazekasa23f5002012-10-23 19:32:45 +02001141
Matthew Treinishd5c96022013-10-17 21:51:23 +00001142object_storage_feature_group = cfg.OptGroup(
1143 name='object-storage-feature-enabled',
1144 title='Enabled object-storage features')
1145
1146ObjectStoreFeaturesGroup = [
Matthew Treinish20345382013-12-13 17:04:23 +00001147 cfg.ListOpt('discoverable_apis',
1148 default=['all'],
1149 help="A list of the enabled optional discoverable apis. "
1150 "A single entry, all, indicates that all of these "
1151 "features are expected to be enabled"),
Daisuke Morita20a183f2014-08-25 14:43:36 +09001152 cfg.BoolOpt('container_sync',
1153 default=True,
1154 help="Execute (old style) container-sync tests"),
1155 cfg.BoolOpt('object_versioning',
1156 default=True,
1157 help="Execute object-versioning tests"),
1158 cfg.BoolOpt('discoverability',
1159 default=True,
1160 help="Execute discoverability tests"),
Giulio Fidente95758b12022-07-14 15:14:24 +02001161 cfg.StrOpt('tempurl_digest_hashlib',
1162 default='sha256',
1163 help="Hashing algorithm to use for the temp_url tests. "
1164 "Needs to be supported both by Swift and the "
1165 "hashlib module, for example sha1 or sha256"),
Matthew Treinishd5c96022013-10-17 21:51:23 +00001166]
1167
Luigi Toscano14d172d2015-01-23 16:37:47 +01001168
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001169scenario_group = cfg.OptGroup(name='scenario', title='Scenario Test Options')
1170
1171ScenarioGroup = [
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001172 cfg.StrOpt('img_file', deprecated_name='qcow2_img_file',
Martin Kopec02af6a42020-03-03 12:39:12 +00001173 default='/opt/stack/new/devstack/files/images'
1174 '/cirros-0.3.1-x86_64-disk.img',
1175 help='Image full path.'),
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001176 cfg.StrOpt('img_disk_format',
1177 default='qcow2',
1178 help='Image disk format'),
1179 cfg.StrOpt('img_container_format',
1180 default='bare',
1181 help='Image container format'),
Evgeny Antyshev7ba0d5f2015-04-28 13:18:07 +00001182 cfg.DictOpt('img_properties', help='Glance image properties. '
1183 'Use for custom images which require them'),
Yair Fried413bf2d2014-11-19 17:07:11 +02001184 cfg.StrOpt('dhcp_client',
1185 default='udhcpc',
Slawek Kaplonski49163f92023-01-20 12:20:35 +01001186 choices=["udhcpc", "dhclient", "dhcpcd", ""],
Yair Fried413bf2d2014-11-19 17:07:11 +02001187 help='DHCP client used by images to renew DCHP lease. '
1188 'If left empty, update operation will be skipped. '
Slawek Kaplonski49163f92023-01-20 12:20:35 +01001189 'Supported clients: "udhcpc", "dhclient", "dhcpcd"'),
Claudiu Belu33c3e602014-08-28 16:38:01 +03001190 cfg.StrOpt('protocol',
1191 default='icmp',
1192 choices=('icmp', 'tcp', 'udp'),
1193 help='The protocol used in security groups tests to check '
1194 'connectivity.'),
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001195]
1196
1197
Matthew Treinish4c412922013-07-16 15:27:42 -04001198service_available_group = cfg.OptGroup(name="service_available",
1199 title="Available OpenStack Services")
1200
1201ServiceAvailableGroup = [
1202 cfg.BoolOpt('cinder',
1203 default=True,
1204 help="Whether or not cinder is expected to be available"),
Matthew Treinishfaa340d2013-07-19 16:26:21 -04001205 cfg.BoolOpt('neutron',
1206 default=False,
1207 help="Whether or not neutron is expected to be available"),
Matthew Treinish853ae442013-07-19 16:36:07 -04001208 cfg.BoolOpt('glance',
1209 default=True,
1210 help="Whether or not glance is expected to be available"),
Matthew Treinish61e332b2013-07-19 16:42:31 -04001211 cfg.BoolOpt('swift',
1212 default=True,
1213 help="Whether or not swift is expected to be available"),
Matthew Treinish6b41e242013-07-19 16:49:28 -04001214 cfg.BoolOpt('nova',
1215 default=True,
1216 help="Whether or not nova is expected to be available"),
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -06001217 cfg.BoolOpt('horizon',
1218 default=True,
1219 help="Whether or not horizon is expected to be available"),
Matthew Treinish4c412922013-07-16 15:27:42 -04001220]
1221
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001222enforce_scope_group = cfg.OptGroup(name="enforce_scope",
1223 title="OpenStack Services with "
1224 "enforce scope")
1225
1226
1227EnforceScopeGroup = [
1228 cfg.BoolOpt('nova',
1229 default=False,
Ghanshyam Mann0fe96632022-10-15 20:18:58 -05001230 help='Does the compute service API policies enforce scope and '
1231 'new defaults? This configuration value should be '
1232 'enabled when nova.conf: [oslo_policy]. '
1233 'enforce_new_defaults and nova.conf: [oslo_policy]. '
1234 'enforce_scope options are enabled in nova conf.'),
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001235 cfg.BoolOpt('neutron',
1236 default=False,
Ghanshyam Mann0fe96632022-10-15 20:18:58 -05001237 help='Does the network service API policies enforce scope and '
1238 'new defaults? This configuration value should be '
1239 'enabled when neutron.conf: [oslo_policy]. '
1240 'enforce_new_defaults and neutron.conf: [oslo_policy]. '
1241 'enforce_scope options are enabled in neutron conf.'),
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001242 cfg.BoolOpt('glance',
1243 default=False,
Ghanshyam Mann0fe96632022-10-15 20:18:58 -05001244 help='Does the Image service API policies enforce scope and '
1245 'new defaults? This configuration value should be '
1246 'enabled when glance.conf: [oslo_policy]. '
1247 'enforce_new_defaults and glance.conf: [oslo_policy]. '
1248 'enforce_scope options are enabled in glance conf.'),
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001249 cfg.BoolOpt('cinder',
1250 default=False,
Ghanshyam Mann0fe96632022-10-15 20:18:58 -05001251 help='Does the Volume service API policies enforce scope and '
1252 'new defaults? This configuration value should be '
1253 'enabled when cinder.conf: [oslo_policy]. '
1254 'enforce_new_defaults and cinder.conf: [oslo_policy]. '
1255 'enforce_scope options are enabled in cinder conf.'),
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001256 cfg.BoolOpt('keystone',
1257 default=False,
Ghanshyam Mann0fe96632022-10-15 20:18:58 -05001258 help='Does the Identity service API policies enforce scope '
1259 'and new defaults? This configuration value should be '
1260 'enabled when keystone.conf: [oslo_policy]. '
1261 'enforce_new_defaults and keystone.conf: [oslo_policy]. '
1262 'enforce_scope options are enabled in keystone conf.'),
Ghanshyam Mannb6521a82022-11-30 14:31:30 -06001263 cfg.BoolOpt('placement',
1264 default=False,
1265 help='Does the placement service API policies enforce scope '
1266 'and new defaults? This configuration value should be '
1267 'enabled when placement.conf: [oslo_policy]. '
1268 'enforce_new_defaults and nova.conf: [oslo_policy]. '
1269 'enforce_scope options are enabled in placement conf.'),
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001270]
1271
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001272debug_group = cfg.OptGroup(name="debug",
1273 title="Debug System")
1274
1275DebugGroup = [
Sean Daguec522c092014-03-24 10:43:22 -04001276 cfg.StrOpt('trace_requests',
1277 default='',
1278 help="""A regex to determine which requests should be traced.
1279
1280This is a regex to match the caller for rest client requests to be able to
1281selectively trace calls out of specific classes and methods. It largely
1282exists for test development, and is not expected to be used in a real deploy
1283of tempest. This will be matched against the discovered ClassName:method
1284in the test environment.
1285
1286Expected values for this field are:
1287
1288 * ClassName:test_method_name - traces one test_method
1289 * ClassName:setUp(Class) - traces specific setup functions
1290 * ClassName:tearDown(Class) - traces specific teardown functions
1291 * ClassName:_run_cleanups - traces the cleanup functions
1292
1293If nothing is specified, this feature is not enabled. To trace everything
1294specify .* as the regex.
1295""")
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001296]
1297
Ilya Shakhat1291bb42017-11-29 18:08:16 +01001298
1299profiler_group = cfg.OptGroup(name="profiler",
1300 title="OpenStack Profiler")
1301
1302ProfilerGroup = [
1303 cfg.StrOpt('key',
1304 help="The secret key to enable OpenStack Profiler. The value "
1305 "should match the one configured in OpenStack services "
1306 "under `[profiler]/hmac_keys` property. The default empty "
1307 "value keeps profiling disabled"),
1308]
1309
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001310DefaultGroup = [
Martin Kopecae155b72017-06-26 09:41:21 +00001311 cfg.BoolOpt('pause_teardown',
1312 default=False,
1313 help="""Whether to pause a test in global teardown.
1314
1315The best use case is investigating used resources of one test.
1316A test can be run as follows:
Soniya Vyase42bd932019-11-26 16:14:33 +05301317 $ stestr run --pdb TEST_ID
Martin Kopecae155b72017-06-26 09:41:21 +00001318or
1319 $ python -m testtools.run TEST_ID"""),
Luigi Dino Tamagnone17053d62023-10-03 14:05:25 +00001320 cfg.StrOpt('resource_name_prefix',
1321 default='tempest',
1322 help="Define the prefix name for the resources created by "
1323 "tempest. Tempest cleanup CLI will use this config option "
1324 "to cleanup only the resources that match the prefix. "
1325 "Make sure this prefix does not match with the resource "
1326 "name you do not want Tempest cleanup CLI to delete."),
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001327]
1328
Jon Grimm270bd7f2014-08-05 18:11:29 +00001329_opts = [
1330 (auth_group, AuthGroup),
1331 (compute_group, ComputeGroup),
1332 (compute_features_group, ComputeFeaturesGroup),
1333 (identity_group, IdentityGroup),
zhufl071e94c2016-07-12 10:26:34 +08001334 (service_clients_group, ServiceClientsGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001335 (identity_feature_group, IdentityFeatureGroup),
1336 (image_group, ImageGroup),
1337 (image_feature_group, ImageFeaturesGroup),
1338 (network_group, NetworkGroup),
1339 (network_feature_group, NetworkFeaturesGroup),
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -06001340 (dashboard_group, DashboardGroup),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001341 (validation_group, ValidationGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001342 (volume_group, VolumeGroup),
1343 (volume_feature_group, VolumeFeaturesGroup),
1344 (object_storage_group, ObjectStoreGroup),
1345 (object_storage_feature_group, ObjectStoreFeaturesGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001346 (scenario_group, ScenarioGroup),
1347 (service_available_group, ServiceAvailableGroup),
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001348 (enforce_scope_group, EnforceScopeGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001349 (debug_group, DebugGroup),
Lajos Katonaceb88212018-11-30 14:54:12 +01001350 (placement_group, PlacementGroup),
Ilya Shakhat1291bb42017-11-29 18:08:16 +01001351 (profiler_group, ProfilerGroup),
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001352 (None, DefaultGroup)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001353]
1354
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001355
Matthew Treinish43b296a2014-02-28 15:23:00 -05001356def register_opts():
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001357 ext_plugins = plugins.TempestTestPluginManager()
1358 # Register in-tree tempest config options
Jon Grimm270bd7f2014-08-05 18:11:29 +00001359 for g, o in _opts:
Maru Newbyf440c292015-03-31 15:58:47 +00001360 register_opt_group(_CONF, g, o)
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001361 # Call external plugin config option registration
1362 ext_plugins.register_plugin_opts(_CONF)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001363
1364
1365def list_opts():
1366 """Return a list of oslo.config options available.
1367
1368 The purpose of this is to allow tools like the Oslo sample config file
1369 generator to discover the options exposed to users.
1370 """
Matthew Treinish83a19aa2015-07-23 13:06:13 -04001371 ext_plugins = plugins.TempestTestPluginManager()
Chris Hoged7b4fd12015-11-11 10:24:52 -08001372 # Make a shallow copy of the options list that can be
1373 # extended by plugins. Send back the group object
1374 # to allow group help text to be generated.
1375 opt_list = [(g, o) for g, o in _opts]
Matthew Treinish83a19aa2015-07-23 13:06:13 -04001376 opt_list.extend(ext_plugins.get_plugin_options_list())
1377 return opt_list
Matthew Treinish43b296a2014-02-28 15:23:00 -05001378
1379
Ken'ichi Ohmichi3f5c1392018-04-11 14:38:22 -07001380# This should never be called outside of this module
Sean Dague3b9b1f32013-12-20 17:04:54 -05001381class TempestConfigPrivate(object):
Daryl Walleck1465d612011-11-02 02:22:15 -05001382 """Provides OpenStack configuration information."""
1383
David Patersonbe9f9832015-10-15 09:10:45 -07001384 DEFAULT_CONFIG_DIR = os.path.join(os.getcwd(), "etc")
Daryl Walleck1465d612011-11-02 02:22:15 -05001385
Brian Waldon738cd632011-12-12 18:45:09 -05001386 DEFAULT_CONFIG_FILE = "tempest.conf"
1387
Andrea Frittolia96ee212014-08-15 18:34:20 +01001388 def __getattr__(self, attr):
1389 # Handles config options from the default group
Maru Newbyf440c292015-03-31 15:58:47 +00001390 return getattr(_CONF, attr)
Andrea Frittolia96ee212014-08-15 18:34:20 +01001391
Matthew Treinish43b296a2014-02-28 15:23:00 -05001392 def _set_attrs(self):
Andrea Frittoli382a6f12017-03-09 11:52:17 +00001393 # This methods ensures that config options in Tempest as well as
1394 # in Tempest plugins can be accessed via:
1395 # CONF.<normalised_group_name>.<key_name>
1396 # where:
1397 # normalised_group_name = group_name.replace('-', '_')
1398 # Attributes are set at __init__ time *only* for known option groups
Maru Newbyf440c292015-03-31 15:58:47 +00001399 self.auth = _CONF.auth
1400 self.compute = _CONF.compute
1401 self.compute_feature_enabled = _CONF['compute-feature-enabled']
1402 self.identity = _CONF.identity
zhufl071e94c2016-07-12 10:26:34 +08001403 self.service_clients = _CONF['service-clients']
Maru Newbyf440c292015-03-31 15:58:47 +00001404 self.identity_feature_enabled = _CONF['identity-feature-enabled']
1405 self.image = _CONF.image
1406 self.image_feature_enabled = _CONF['image-feature-enabled']
1407 self.network = _CONF.network
1408 self.network_feature_enabled = _CONF['network-feature-enabled']
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -06001409 self.dashboard = _CONF.dashboard
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001410 self.validation = _CONF.validation
Maru Newbyf440c292015-03-31 15:58:47 +00001411 self.volume = _CONF.volume
1412 self.volume_feature_enabled = _CONF['volume-feature-enabled']
1413 self.object_storage = _CONF['object-storage']
1414 self.object_storage_feature_enabled = _CONF[
Matthew Treinishd5c96022013-10-17 21:51:23 +00001415 'object-storage-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001416 self.scenario = _CONF.scenario
1417 self.service_available = _CONF.service_available
Ghanshyam Mann6fb55c82021-02-02 17:14:21 -06001418 self.enforce_scope = _CONF.enforce_scope
Maru Newbyf440c292015-03-31 15:58:47 +00001419 self.debug = _CONF.debug
Matthew Treinish46008082015-04-14 18:32:47 -04001420 logging.tempest_set_log_file('tempest.log')
Andrea Frittoli382a6f12017-03-09 11:52:17 +00001421 # Setting attributes for plugins
1422 # NOTE(andreaf) Plugins have no access to the TempestConfigPrivate
1423 # instance at discovery time, so they have no way of setting these
1424 # aliases themselves.
1425 ext_plugins = plugins.TempestTestPluginManager()
1426 for group, _ in ext_plugins.get_plugin_options_list():
1427 if isinstance(group, cfg.OptGroup):
1428 # If we have an OptGroup
1429 group_name = group.name
1430 group_dest = group.dest
1431 else:
1432 # If we have a group name as a string
1433 group_name = group
1434 group_dest = group.replace('-', '_')
1435 # NOTE(andreaf) We can set the attribute safely here since in
1436 # case of name conflict we would not have reached this point.
1437 setattr(self, group_dest, _CONF[group_name])
Sean Dague86bd8422013-12-20 09:56:44 -05001438
Joe Gordon28a84ae2014-07-17 15:38:28 +00001439 def __init__(self, parse_conf=True, config_path=None):
Matthew Treinish43b296a2014-02-28 15:23:00 -05001440 """Initialize a configuration from a conf directory and conf file."""
1441 super(TempestConfigPrivate, self).__init__()
1442 config_files = []
1443 failsafe_path = "/etc/tempest/" + self.DEFAULT_CONFIG_FILE
1444
Joe Gordon28a84ae2014-07-17 15:38:28 +00001445 if config_path:
1446 path = config_path
1447 else:
1448 # Environment variables override defaults...
1449 conf_dir = os.environ.get('TEMPEST_CONFIG_DIR',
1450 self.DEFAULT_CONFIG_DIR)
1451 conf_file = os.environ.get('TEMPEST_CONFIG',
1452 self.DEFAULT_CONFIG_FILE)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001453
Joe Gordon28a84ae2014-07-17 15:38:28 +00001454 path = os.path.join(conf_dir, conf_file)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001455
1456 if not os.path.isfile(path):
1457 path = failsafe_path
1458
1459 # only parse the config file if we expect one to exist. This is needed
1460 # to remove an issue with the config file up to date checker.
1461 if parse_conf:
1462 config_files.append(path)
Maru Newbyf440c292015-03-31 15:58:47 +00001463 logging.register_options(_CONF)
Matthew Treinish5440a402014-10-02 14:36:16 -04001464 if os.path.isfile(path):
Maru Newbyf440c292015-03-31 15:58:47 +00001465 _CONF([], project='tempest', default_config_files=config_files)
Matthew Treinish5440a402014-10-02 14:36:16 -04001466 else:
Maru Newbyf440c292015-03-31 15:58:47 +00001467 _CONF([], project='tempest')
Marc Kodererc81c7672015-12-17 12:10:12 +01001468
1469 logging_cfg_path = "%s/logging.conf" % os.path.dirname(path)
Tom Patzige6f7c7d2016-02-17 16:46:11 +01001470 if ((not hasattr(_CONF, 'log_config_append') or
afazekas40fcb9b2019-03-08 11:25:11 +01001471 _CONF.log_config_append is None) and
Marc Kodererc81c7672015-12-17 12:10:12 +01001472 os.path.isfile(logging_cfg_path)):
1473 # if logging conf is in place we need to set log_config_append
1474 _CONF.log_config_append = logging_cfg_path
1475
Maru Newbyf440c292015-03-31 15:58:47 +00001476 logging.setup(_CONF, 'tempest')
Matthew Treinish43b296a2014-02-28 15:23:00 -05001477 LOG = logging.getLogger('tempest')
Jordan Pittier525ec712016-12-07 17:51:26 +01001478 LOG.info("Using tempest config file %s", path)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001479 register_opts()
1480 self._set_attrs()
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001481 if parse_conf:
Anusha Raminenif3eb9472017-01-13 08:54:01 +05301482 _CONF.log_opt_values(LOG, logging.DEBUG)
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001483
Sean Dague86bd8422013-12-20 09:56:44 -05001484
1485class TempestConfigProxy(object):
1486 _config = None
Joe Gordon28a84ae2014-07-17 15:38:28 +00001487 _path = None
Sean Dague86bd8422013-12-20 09:56:44 -05001488
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001489 _extra_log_defaults = [
Anusha Raminenif3eb9472017-01-13 08:54:01 +05301490 ('paramiko.transport', logging.INFO),
1491 ('requests.packages.urllib3.connectionpool', logging.WARN),
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001492 ]
1493
1494 def _fix_log_levels(self):
1495 """Tweak the oslo log defaults."""
Doug Hellmann583ce2c2015-03-11 14:55:46 +00001496 for name, level in self._extra_log_defaults:
Anusha Raminenif3eb9472017-01-13 08:54:01 +05301497 logging.getLogger(name).logger.setLevel(level)
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001498
Sean Dague86bd8422013-12-20 09:56:44 -05001499 def __getattr__(self, attr):
1500 if not self._config:
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001501 self._fix_log_levels()
Matthew Treinishaa29c7e2015-04-23 16:35:09 -04001502 lock_dir = os.path.join(tempfile.gettempdir(), 'tempest-lock')
1503 lockutils.set_defaults(lock_dir)
Joe Gordon28a84ae2014-07-17 15:38:28 +00001504 self._config = TempestConfigPrivate(config_path=self._path)
Sean Dague86bd8422013-12-20 09:56:44 -05001505
Andrea Frittoli (andreaf)8420abe2016-07-27 11:47:43 +01001506 # Pushing tempest internal service client configuration to the
1507 # service clients register. Doing this in the config module ensures
1508 # that the configuration is available by the time we register the
1509 # service clients.
1510 # NOTE(andreaf) This has to be done at the time the first
1511 # attribute is accessed, to ensure all plugins have been already
1512 # loaded, options registered, and _config is set.
1513 _register_tempest_service_clients()
1514
Andrea Frittoli8b23c792017-03-09 13:17:01 +00001515 # Registering service clients and pushing their configuration to
1516 # the service clients register. Doing this in the config module
1517 # ensures that the configuration is available by the time we
1518 # discover tests from plugins.
1519 plugins.TempestTestPluginManager()._register_service_clients()
1520
Sean Dague86bd8422013-12-20 09:56:44 -05001521 return getattr(self._config, attr)
1522
Joe Gordon28a84ae2014-07-17 15:38:28 +00001523 def set_config_path(self, path):
1524 self._path = path
Masayuki Igawa79159f82018-07-27 15:00:37 +09001525 # FIXME(masayukig): bug#1783751 To pass the config file path to child
1526 # processes, we need to set the environment variables here as a
1527 # workaround.
1528 os.environ['TEMPEST_CONFIG_DIR'] = os.path.dirname(path)
1529 os.environ['TEMPEST_CONFIG'] = os.path.basename(path)
Joe Gordon28a84ae2014-07-17 15:38:28 +00001530
Sean Dague86bd8422013-12-20 09:56:44 -05001531
1532CONF = TempestConfigProxy()
Matthew Treinishca5a9ff2016-04-16 15:04:34 -04001533
1534
Andrea Frittoli (andreaf)de5fb0c2016-06-13 12:15:00 +01001535def service_client_config(service_client_name=None):
1536 """Return a dict with the parameters to init service clients
1537
1538 Extracts from CONF the settings specific to the service_client_name and
1539 api_version, and formats them as dict ready to be passed to the service
1540 clients __init__:
1541
1542 * `region` (default to identity)
1543 * `catalog_type`
1544 * `endpoint_type`
1545 * `build_timeout` (object-storage and identity default to compute)
1546 * `build_interval` (object-storage and identity default to compute)
1547
1548 The following common settings are always returned, even if
1549 `service_client_name` is None:
1550
1551 * `disable_ssl_certificate_validation`
1552 * `ca_certs`
1553 * `trace_requests`
zhufl071e94c2016-07-12 10:26:34 +08001554 * `http_timeout`
Matthew Treinish74514402016-09-01 11:44:57 -04001555 * `proxy_url`
Andrea Frittoli (andreaf)de5fb0c2016-06-13 12:15:00 +01001556
1557 The dict returned by this does not fit a few service clients:
1558
1559 * The endpoint type is not returned for identity client, since it takes
1560 three different values for v2 admin, v2 public and v3
1561 * The `ServersClient` from compute accepts an optional
1562 `enable_instance_password` parameter, which is not returned.
1563 * The `VolumesClient` for both v1 and v2 volume accept an optional
1564 `default_volume_size` parameter, which is not returned.
1565 * The `TokenClient` and `V3TokenClient` have a very different
1566 interface, only auth_url is needed for them.
1567
1568 :param service_client_name: str Name of the service. Supported values are
1569 'compute', 'identity', 'image', 'network', 'object-storage', 'volume'
1570 :return: dictionary of __init__ parameters for the service clients
1571 :rtype: dict
1572 """
1573 _parameters = {
1574 'disable_ssl_certificate_validation':
Daniel Melladocad3f3d2016-08-19 14:17:16 +00001575 CONF.identity.disable_ssl_certificate_validation,
1576 'ca_certs': CONF.identity.ca_certificates_file,
zhufl071e94c2016-07-12 10:26:34 +08001577 'trace_requests': CONF.debug.trace_requests,
Matthew Treinish74514402016-09-01 11:44:57 -04001578 'http_timeout': CONF.service_clients.http_timeout,
1579 'proxy_url': CONF.service_clients.proxy_url,
Andrea Frittoli (andreaf)de5fb0c2016-06-13 12:15:00 +01001580 }
1581
1582 if service_client_name is None:
1583 return _parameters
1584
1585 # Get the group of options first, by normalising the service_group_name
1586 # Services with a '-' in the name have an '_' in the option group name
1587 config_group = service_client_name.replace('-', '_')
1588 # NOTE(andreaf) Check if the config group exists. This allows for this
1589 # helper to be used for settings from registered plugins as well
1590 try:
1591 options = getattr(CONF, config_group)
1592 except cfg.NoSuchOptError:
1593 # Option group not defined
1594 raise exceptions.UnknownServiceClient(services=service_client_name)
1595 # Set endpoint_type
1596 # Identity uses different settings depending on API version, so do not
1597 # return the endpoint at all.
1598 if service_client_name != 'identity':
1599 _parameters['endpoint_type'] = getattr(options, 'endpoint_type')
1600 # Set build_*
1601 # Object storage and identity groups do not have conf settings for
1602 # build_* parameters, and we default to compute in any case
1603 for setting in ['build_timeout', 'build_interval']:
1604 if not hasattr(options, setting) or not getattr(options, setting):
1605 _parameters[setting] = getattr(CONF.compute, setting)
1606 else:
1607 _parameters[setting] = getattr(options, setting)
1608 # Set region
1609 # If a service client does not define region or region is not set
1610 # default to the identity region
1611 if not hasattr(options, 'region') or not getattr(options, 'region'):
1612 _parameters['region'] = CONF.identity.region
1613 else:
1614 _parameters['region'] = getattr(options, 'region')
1615 # Set service
1616 _parameters['service'] = getattr(options, 'catalog_type')
1617 return _parameters
Andrea Frittoli (andreaf)8420abe2016-07-27 11:47:43 +01001618
1619
1620def _register_tempest_service_clients():
1621 # Register tempest own service clients using the same mechanism used
1622 # for external plugins.
1623 # The configuration data is pushed to the registry so that automatic
1624 # configuration of tempest own service clients is possible both for
1625 # tempest as well as for the plugins.
1626 service_clients = clients.tempest_modules()
1627 registry = clients.ClientsRegistry()
1628 all_clients = []
1629 for service_client in service_clients:
1630 module = service_clients[service_client]
1631 configs = service_client.split('.')[0]
1632 service_client_data = dict(
Andrea Frittoli986407d2017-10-11 10:23:17 +00001633 name=service_client.replace('.', '_').replace('-', '_'),
Andrea Frittoli (andreaf)8420abe2016-07-27 11:47:43 +01001634 service_version=service_client,
1635 module_path=module.__name__,
1636 client_names=module.__all__,
1637 **service_client_config(configs)
1638 )
1639 all_clients.append(service_client_data)
1640 # NOTE(andreaf) Internal service clients do not actually belong
1641 # to a plugin, so using '__tempest__' to indicate a virtual plugin
1642 # which holds internal service clients.
1643 registry.register_service_client('__tempest__', all_clients)