blob: 956b593d4dc5673bb38c0cc3550caa70619daebd [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.'),
Jay Pipes7c88eb22013-01-16 21:32:43 -0500129 cfg.StrOpt('uri',
Brant Knudsonc7ca3342013-03-28 21:08:50 -0500130 help="Full URI of the OpenStack Identity API (Keystone), v2"),
131 cfg.StrOpt('uri_v3',
132 help='Full URI of the OpenStack Identity API (Keystone), v3'),
Andrea Frittoli8bbdb162014-01-06 11:06:13 +0000133 cfg.StrOpt('auth_version',
Ken'ichi Ohmichia6065a62017-03-03 16:40:22 -0800134 default='v3',
Andrea Frittoli8bbdb162014-01-06 11:06:13 +0000135 help="Identity API version to be used for authentication "
Andrea Frittoli77f9da42014-02-06 11:18:19 +0000136 "for API tests."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500137 cfg.StrOpt('region',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100138 default='RegionOne',
Arata Notsu8f440392013-09-13 16:14:20 +0900139 help="The identity region name to use. Also used as the other "
140 "services' region name unless they are set explicitly. "
141 "If no such region is found in the service catalog, the "
142 "first found one is used."),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300143 cfg.StrOpt('v2_admin_endpoint_type',
144 default='adminURL',
145 choices=['public', 'admin', 'internal',
146 'publicURL', 'adminURL', 'internalURL'],
147 help="The admin endpoint type to use for OpenStack Identity "
ghanshyamf58b9fd2015-09-01 16:11:39 +0900148 "(Keystone) API v2"),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300149 cfg.StrOpt('v2_public_endpoint_type',
JordanP5d29b2c2013-12-18 13:56:03 +0000150 default='publicURL',
151 choices=['public', 'admin', 'internal',
152 'publicURL', 'adminURL', 'internalURL'],
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300153 help="The public endpoint type to use for OpenStack Identity "
zhuflf4d35922019-06-06 15:07:05 +0800154 "(Keystone) API v2"),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300155 cfg.StrOpt('v3_endpoint_type',
156 default='adminURL',
157 choices=['public', 'admin', 'internal',
158 'publicURL', 'adminURL', 'internalURL'],
159 help="The endpoint type to use for OpenStack Identity "
Hemanth Nakkinab4c0c822017-04-29 10:57:31 +0530160 "(Keystone) API v3. The default value adminURL is "
161 "deprecated and will be modified to publicURL in "
162 "the next release."),
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_"
204 "count otherwise test might fail"
205 ),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500206]
Jay Pipes3f981df2012-03-27 18:59:44 -0400207
zhufl071e94c2016-07-12 10:26:34 +0800208service_clients_group = cfg.OptGroup(name='service-clients',
209 title="Service Clients Options")
210
211ServiceClientsGroup = [
212 cfg.IntOpt('http_timeout',
213 default=60,
214 help='Timeout in seconds to wait for the http request to '
215 'return'),
Matthew Treinish74514402016-09-01 11:44:57 -0400216 cfg.StrOpt('proxy_url',
217 help='Specify an http proxy to use.')
zhufl071e94c2016-07-12 10:26:34 +0800218]
219
Matthew Treinishd5021a72014-01-09 18:42:51 +0000220identity_feature_group = cfg.OptGroup(name='identity-feature-enabled',
221 title='Enabled Identity Features')
222
223IdentityFeatureGroup = [
224 cfg.BoolOpt('trust',
225 default=True,
226 help='Does the identity service have delegation and '
Matthew Treinishdb2c5972014-01-31 22:18:59 +0000227 'impersonation enabled'),
228 cfg.BoolOpt('api_v2',
Lance Bragstad1fbad232017-09-22 18:58:53 +0000229 default=False,
230 help='Is the v2 identity API enabled',
231 deprecated_for_removal=True,
232 deprecated_reason='The identity v2.0 API was removed in the '
233 'Queens release. Tests that exercise the '
234 'v2.0 API will be removed from tempest in '
235 'the v22.0.0 release. They are kept only to '
236 'test stable branches.'),
Andrea Frittoli1413ba92017-04-21 14:33:23 +0100237 cfg.BoolOpt('api_v2_admin',
238 default=True,
239 help="Is the v2 identity admin API available? This setting "
240 "only applies if api_v2 is set to True."),
Matthew Treinishdb2c5972014-01-31 22:18:59 +0000241 cfg.BoolOpt('api_v3',
242 default=True,
243 help='Is the v3 identity API enabled'),
Jane Zadorozhna121576d2015-06-23 12:57:13 +0300244 cfg.ListOpt('api_extensions',
245 default=['all'],
246 help="A list of enabled identity extensions with a special "
247 "entry all which indicates every extension is enabled. "
248 "Empty list indicates all extensions are disabled. "
zhufld28a2712017-11-07 13:55:18 +0800249 "To get the list of extensions run: "
250 "'openstack extension list --identity'"),
Leticia Wanderley9cafd3d2017-08-04 00:22:34 -0300251 cfg.BoolOpt('domain_specific_drivers',
252 default=False,
253 help='Are domain specific drivers enabled? '
254 'This configuration value should be same as '
255 '[identity]->domain_specific_drivers_enabled '
256 'in keystone.conf.'),
Rodrigo Duarte Sousa2d78e8e2016-09-28 10:38:08 -0300257 cfg.BoolOpt('security_compliance',
258 default=False,
259 help='Does the environment have the security compliance '
Felipe Monteiro6f960782018-03-16 02:08:38 +0000260 'settings enabled?'),
261 cfg.BoolOpt('project_tags',
262 default=False,
Colleen Murphy0e52d4e2018-02-17 21:29:40 +0100263 help='Is the project tags identity v3 API available?'),
264 # Application credentials is a default feature in Queens. This config
265 # option can removed once Pike is EOL.
266 cfg.BoolOpt('application_credentials',
267 default=False,
268 help='Does the environment have application credentials '
Anna Pankiewicza0710662018-07-24 14:56:42 -0500269 'enabled?'),
Colleen Murphyd2cbd3a2019-12-17 16:31:14 -0800270 # Access rules for application credentials is a default feature in Train.
271 # This config option can removed once Stein is EOL.
272 cfg.BoolOpt('access_rules',
273 default=False,
274 help='Does the environment have access rules enabled?'),
Anna Pankiewicza0710662018-07-24 14:56:42 -0500275 cfg.BoolOpt('immutable_user_source',
276 default=False,
277 help='Set to True if the environment has a read-only '
278 'user source. This will skip all tests that attempt to '
279 'create, delete, or modify users. This should not be set '
280 'to True if using dynamic credentials')
Matthew Treinishd5021a72014-01-09 18:42:51 +0000281]
282
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500283compute_group = cfg.OptGroup(name='compute',
284 title='Compute Service Options')
Rohit Karajgie1b050d2011-12-02 16:13:18 -0800285
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500286ComputeGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500287 cfg.StrOpt('image_ref',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400288 help="Valid primary image reference to be used in tests. "
289 "This is a required option"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500290 cfg.StrOpt('image_ref_alt',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400291 help="Valid secondary image reference to be used in tests. "
292 "This is a required option, but if only one image is "
293 "available duplicate the value of image_ref above"),
Lee Yarwood7f7c2322019-06-06 10:57:19 +0100294 cfg.StrOpt('certified_image_ref',
295 help="Valid image reference to be used in image certificate "
296 "validation tests when enabled. This image must also "
297 "have the required img_signature_* properties set. "
298 "Additional details available within the following Nova "
299 "documentation: https://docs.openstack.org/nova/latest/"
300 "user/certificate-validation.html"),
301 cfg.ListOpt('certified_image_trusted_certs',
302 help="A list of trusted certificates to be used when the "
303 "image certificate validation compute feature is "
304 "enabled."),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900305 cfg.StrOpt('flavor_ref',
306 default="1",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500307 help="Valid primary flavor to use in tests."),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900308 cfg.StrOpt('flavor_ref_alt',
309 default="2",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500310 help='Valid secondary flavor to be used in tests.'),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500311 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400312 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500313 help="Time in seconds between build status checks."),
314 cfg.IntOpt('build_timeout',
315 default=300,
Hugh Saunders5b139ad2014-12-15 09:08:41 +0000316 help="Timeout in seconds to wait for an instance to build. "
317 "Other services that do not define build_timeout will "
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200318 "inherit this value."),
Attila Fazekas0abbc952013-07-01 19:19:42 +0200319 cfg.IntOpt('ready_wait',
320 default=0,
DennyZhang8912d012013-09-25 18:08:34 -0500321 help="Additional wait time for clean state, when there is "
322 "no OS-EXT-STS extension available"),
Attila Fazekasb0661652013-05-08 13:01:36 +0200323 cfg.StrOpt('fixed_network_name',
Chris Hoge8f1401b2014-11-19 14:00:37 -0800324 help="Name of the fixed network that is visible to all test "
Sean Dagueed6e5862016-04-04 10:49:13 -0400325 "projects. If multiple networks are available for a "
326 "project, this is the network which will be used for "
327 "creating servers if tempest does not create a network or "
zhufl0bad33e2016-10-14 17:21:46 +0800328 "a network is not specified elsewhere. It may be used for "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000329 "ssh validation only if floating IPs are disabled."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500330 cfg.StrOpt('catalog_type',
331 default='compute',
332 help="Catalog type of the Compute service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900333 cfg.StrOpt('region',
334 default='',
335 help="The compute region name to use. If empty, the value "
336 "of identity.region is used instead. If no such region "
337 "is found in the service catalog, the first found one is "
338 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000339 cfg.StrOpt('endpoint_type',
340 default='publicURL',
341 choices=['public', 'admin', 'internal',
342 'publicURL', 'adminURL', 'internalURL'],
343 help="The endpoint type to use for the compute service."),
Ryan Hsucb2e1252013-09-03 21:44:49 -0700344 cfg.StrOpt('volume_device_name',
345 default='vdb',
346 help="Expected device name when a volume is attached to "
Kevin_Zheng79ec3342017-03-25 17:33:27 +0800347 "an instance. Not all hypervisors guarantee that they "
348 "will respect the user defined device name, tests may "
349 "fail if inappropriate device name is set."),
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900350 cfg.IntOpt('shelved_offload_time',
351 default=0,
352 help='Time in seconds before a shelved instance is eligible '
353 'for removing from a host. -1 never offload, 0 offload '
zhufl917b5552017-11-27 16:07:24 +0800354 'when shelved. This configuration value should be same as '
zhufldc7eeb42018-09-12 11:10:16 +0800355 'nova.conf: DEFAULT.shelved_offload_time, and '
zhufl917b5552017-11-27 16:07:24 +0800356 'some tests will run for as long as the time.'),
Sean Dague782f6772015-11-11 11:26:45 -0500357 cfg.IntOpt('min_compute_nodes',
358 default=1,
359 help=('The minimum number of compute nodes expected. This will '
360 'be utilized by some multinode specific tests to ensure '
361 'that requests match the expected size of the cluster '
ghanshyam29591532016-03-11 17:12:43 +0900362 'you are testing with.')),
Ken'ichi Ohmichi49db4fe2016-08-12 15:26:51 -0700363 cfg.StrOpt('hypervisor_type',
364 default=None,
365 help="Hypervisor type of the test target on heterogeneous "
366 "compute environment. The value can be 'QEMU', 'xen' or "
367 "something."),
Ken'ichi Ohmichi4d237e72015-11-05 06:32:33 +0000368 cfg.StrOpt('min_microversion',
369 default=None,
370 help="Lower version of the test target microversion range. "
371 "The format is 'X.Y', where 'X' and 'Y' are int values. "
372 "Tempest selects tests based on the range between "
373 "min_microversion and max_microversion. "
Ghanshyam395c5b52015-12-04 17:27:16 +0900374 "If both values are not specified, Tempest avoids tests "
375 "which require a microversion. Valid values are string "
ghanshyam8889d2b2017-02-14 02:29:06 +0000376 "with format 'X.Y' or string 'latest'"),
Ken'ichi Ohmichi4d237e72015-11-05 06:32:33 +0000377 cfg.StrOpt('max_microversion',
378 default=None,
379 help="Upper version of the test target microversion range. "
380 "The format is 'X.Y', where 'X' and 'Y' are int values. "
381 "Tempest selects tests based on the range between "
382 "min_microversion and max_microversion. "
Ghanshyam395c5b52015-12-04 17:27:16 +0900383 "If both values are not specified, Tempest avoids tests "
384 "which require a microversion. Valid values are string "
ghanshyam8889d2b2017-02-14 02:29:06 +0000385 "with format 'X.Y' or string 'latest'"),
Marc Koderer979e4942016-12-08 10:07:59 +0100386 cfg.StrOpt('compute_volume_common_az',
387 default=None,
388 help='AZ to be used for Cinder and Nova. Set this parameter '
389 'when the cloud has nova.conf: cinder.cross_az_attach '
390 'set to false. Which means volumes attached to an '
391 'instance must be in the same availability zone in Cinder '
392 'as the instance availability zone in Nova. Set the '
393 'common availability zone in this config which will be '
394 'used to boot an instance as well as creating a volume. '
395 'NOTE: If that AZ is not in Cinder (or '
396 'allow_availability_zone_fallback=False in cinder.conf), '
397 'the volume create request will fail and the instance '
398 'will fail the build request.'),
ghanshyam29591532016-03-11 17:12:43 +0900399]
400
Lajos Katonaceb88212018-11-30 14:54:12 +0100401placement_group = cfg.OptGroup(name='placement',
402 title='Placement Service Options')
403
404PlacementGroup = [
405 cfg.StrOpt('endpoint_type',
406 default='public',
407 choices=['public', 'admin', 'internal'],
408 help="The endpoint type to use for the placement service."),
409 cfg.StrOpt('catalog_type',
410 default='placement',
411 help="Catalog type of the Placement service."),
412 cfg.StrOpt('region',
Swapnil Chhanikara89eea82020-01-24 17:04:42 +0530413 default='',
Lajos Katonaceb88212018-11-30 14:54:12 +0100414 help="The placement region name to use. If empty, the value "
415 "of [identity]/region is used instead. If no such region "
416 "is found in the service catalog, the first region found "
417 "is used."),
418 cfg.StrOpt('min_microversion',
419 default=None,
420 help="Lower version of the test target microversion range. "
421 "The format is 'X.Y', where 'X' and 'Y' are int values. "
422 "Valid values are string with format 'X.Y' or string "
423 "'latest'"),
424 cfg.StrOpt('max_microversion',
425 default=None,
426 help="Upper version of the test target microversion range. "
427 "The format is 'X.Y', where 'X' and 'Y' are int values. "
428 "Valid values are string with format 'X.Y' or string "
429 "'latest'"),
430]
431
432
ghanshyam29591532016-03-11 17:12:43 +0900433compute_features_group = cfg.OptGroup(name='compute-feature-enabled',
434 title="Enabled Compute Service Features")
435
436ComputeFeaturesGroup = [
Matthew Treinishd5c96022013-10-17 21:51:23 +0000437 cfg.BoolOpt('disk_config',
438 default=True,
439 help="If false, skip disk config tests"),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000440 cfg.ListOpt('api_extensions',
441 default=['all'],
Zhi Kun Liude25c022014-02-14 13:25:19 +0800442 help='A list of enabled compute extensions with a special '
Ken'ichi Ohmichia7e68712014-05-06 10:47:26 +0900443 'entry all which indicates every extension is enabled. '
Simeon Monov5d7effe2014-07-16 07:32:38 +0300444 'Each extension should be specified with alias name. '
Matthew Treinish5078e8b2016-09-16 11:13:11 -0400445 'Empty list indicates all extensions are disabled',
446 deprecated_for_removal=True,
447 deprecated_reason='The Nova extensions API and mechanism '
448 'is deprecated. This option will be '
449 'removed when all releases supported '
450 'by tempest no longer contain the Nova '
451 'extensions API and mechanism.'),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000452 cfg.BoolOpt('change_password',
453 default=False,
454 help="Does the test environment support changing the admin "
455 "password?"),
Adam Gandelmanc6eefb42014-07-15 16:44:08 -0700456 cfg.BoolOpt('console_output',
457 default=True,
458 help="Does the test environment support obtaining instance "
459 "serial console output?"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000460 cfg.BoolOpt('resize',
461 default=False,
Masayuki Igawad91094d2017-04-12 16:20:09 +0900462 help="Does the test environment support resizing? When you "
463 "enable this feature, 'flavor_ref_alt' should be set and "
464 "it should refer to a larger flavor than 'flavor_ref' "
465 "one."),
Eric Windischb5538072014-03-09 23:47:35 -0400466 cfg.BoolOpt('pause',
467 default=True,
468 help="Does the test environment support pausing?"),
David Shrewsbury25f666f2014-07-22 12:17:59 -0400469 cfg.BoolOpt('shelve',
470 default=True,
471 help="Does the test environment support shelving/unshelving?"),
Alexandre Arents0a9b8232020-07-29 09:52:57 +0000472 cfg.BoolOpt('shelve_migrate',
473 default=False,
474 help="Does the test environment support "
475 "cold migration of unshelved server?"),
Eric Windischaeb7e842014-03-10 01:10:50 -0400476 cfg.BoolOpt('suspend',
477 default=True,
478 help="Does the test environment support suspend/resume?"),
Ludovic Beliveauae314882016-09-15 13:34:14 -0400479 cfg.BoolOpt('cold_migration',
480 default=True,
zhufl0bad33e2016-10-14 17:21:46 +0800481 help="Does the test environment support cold migration?"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000482 cfg.BoolOpt('live_migration',
Joe Gordon31a139a2014-11-17 16:39:04 -0800483 default=True,
zhufl0bad33e2016-10-14 17:21:46 +0800484 help="Does the test environment support live migration?"),
Sarafraj Singh61e40452016-09-29 13:06:59 -0500485 cfg.BoolOpt('live_migrate_back_and_forth',
486 default=False,
487 help="Does the test environment support live migrating "
488 "VM back and forth between different versions of "
489 "nova-compute?"),
YAMAMOTO Takashi1f62af22015-06-16 03:29:50 +0900490 cfg.BoolOpt('metadata_service',
491 default=True,
492 help="Does the test environment support metadata service? "
493 "Ignored unless validation.run_validation=true."),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000494 cfg.BoolOpt('block_migration_for_live_migration',
495 default=False,
496 help="Does the test environment use block devices for live "
497 "migration"),
498 cfg.BoolOpt('block_migrate_cinder_iscsi',
499 default=False,
Matt Riedemann8cf5f902017-04-24 11:42:48 -0400500 help="Does the test environment support block migration with "
501 "Cinder iSCSI volumes. Note: libvirt >= 1.2.17 is required "
Lee Yarwood48fe99f2020-01-27 19:18:24 +0000502 "to support this if using the libvirt compute driver.",
503 deprecated_for_removal=True,
504 deprecated_reason='This option duplicates the more generic '
505 '[compute-feature-enabled]/block_migration '
506 '_for_live_migration now that '
507 'MIN_LIBVIRT_VERSION is >= 1.2.17 on all '
508 'branches from stable/rocky and will be '
509 'removed in a future release.'),
zhuflbe052d62019-11-04 10:56:02 +0800510 cfg.BoolOpt('can_migrate_between_any_hosts',
511 default=True,
512 help="Does the test environment support migrating between "
513 "any hosts? In environments with non-homogeneous compute "
514 "nodes you can set this to False so that it will select "
515 "destination host for migrating automatically"),
Ghanshyam Mann41c17572014-02-27 18:52:56 +0900516 cfg.BoolOpt('vnc_console',
517 default=False,
518 help='Enable VNC console. This configuration value should '
zhufldc7eeb42018-09-12 11:10:16 +0800519 'be same as nova.conf: vnc.enabled'),
Alex Savatieiev82b6aeb2018-03-28 17:56:49 +0200520 cfg.StrOpt('vnc_server_header',
521 default='WebSockify',
522 help='Expected VNC server name (WebSockify, nginx, etc) '
Leo Henkenfd01d152019-08-02 11:42:52 -0500523 'in response header.',
524 deprecated_for_removal=True,
525 deprecated_reason='This option will be ignored because the '
526 'usage of different response header fields '
527 'to accomplish the same goal (in accordance '
528 'with RFC7231 S6.2.2) makes it obsolete.'),
Ghanshyam70876d02014-03-11 11:40:18 +0900529 cfg.BoolOpt('spice_console',
530 default=False,
531 help='Enable Spice console. This configuration value should '
zhufld5bda712019-11-01 14:01:01 +0800532 'be same as nova.conf: spice.enabled',
533 deprecated_for_removal=True,
534 deprecated_reason="This config option is not being used "
535 "in Tempest, we can add it back when "
536 "adding the test cases."),
Ghanshyam70876d02014-03-11 11:40:18 +0900537 cfg.BoolOpt('rdp_console',
538 default=False,
539 help='Enable RDP console. This configuration value should '
zhufld5bda712019-11-01 14:01:01 +0800540 'be same as nova.conf: rdp.enabled',
541 deprecated_for_removal=True,
542 deprecated_reason="This config option is not being used "
543 "in Tempest, we can add it back when "
544 "adding the test cases."),
Markus Zoeller69d58b82017-02-17 10:09:22 +0100545 cfg.BoolOpt('serial_console',
546 default=False,
547 help='Enable serial console. This configuration value '
zhufldc7eeb42018-09-12 11:10:16 +0800548 'should be the same as '
549 'nova.conf: serial_console.enabled'),
Adam Gandelman2e37b4f2014-06-18 17:34:21 -0700550 cfg.BoolOpt('rescue',
551 default=True,
552 help='Does the test environment support instance rescue '
Ghanshyam9c2e50d2014-07-22 21:32:05 +0900553 'mode?'),
Lee Yarwoodc0ad55c2019-12-06 13:39:19 +0000554 cfg.BoolOpt('stable_rescue',
555 default=False,
556 help='Does the test environment support stable device '
557 'instance rescue mode?'),
Ghanshyam9c2e50d2014-07-22 21:32:05 +0900558 cfg.BoolOpt('enable_instance_password',
559 default=True,
560 help='Enables returning of the instance password by the '
561 'relevant server API calls such as create, rebuild '
zhufle8a703b2016-09-09 15:23:03 +0800562 'or rescue. This configuration value should be same as '
563 'nova.conf: DEFAULT.enable_instance_password'),
Adam Gandelman7186f7a2014-07-23 09:28:56 -0400564 cfg.BoolOpt('interface_attach',
565 default=True,
566 help='Does the test environment support dynamic network '
Adam Gandelmanfbc95ac2014-06-19 17:33:43 -0700567 'interface attachment?'),
568 cfg.BoolOpt('snapshot',
569 default=True,
570 help='Does the test environment support creating snapshot '
Matthew Treinishdfd7ac02015-02-09 17:47:31 -0500571 'images of running instances?'),
Takeaki Matsumotodf4ab7c2015-08-25 17:49:23 +0900572 cfg.BoolOpt('nova_cert',
Sean Dague6943acb2016-08-08 15:28:17 -0400573 default=False,
574 help='Does the test environment have the nova cert running?',
Ken'ichi Ohmichid65cf9c2016-11-23 16:56:04 -0800575 deprecated_for_removal=True,
576 deprecated_reason="On Nova side, the nova-cert service is "
577 "deprecated and the service will be removed "
578 "as early as Ocata."),
Takeaki Matsumotod7e04b22015-09-04 15:13:38 +0900579 cfg.BoolOpt('personality',
Matt Riedemann0baba702016-07-03 19:24:08 -0400580 default=False,
Takeaki Matsumotod7e04b22015-09-04 15:13:38 +0900581 help='Does the test environment support server personality'),
Matt Riedemann79b3b492015-06-20 14:20:44 -0700582 cfg.BoolOpt('attach_encrypted_volume',
583 default=True,
584 help='Does the test environment support attaching an '
585 'encrypted volume to a running server instance? This may '
586 'depend on the combination of compute_driver in nova and '
587 'the volume_driver(s) in cinder.'),
Alexander Gubanov509e2842015-06-09 15:29:51 +0300588 cfg.BoolOpt('config_drive',
589 default=True,
590 help='Enable special configuration drive with metadata.'),
Artom Lifshitz595ae162018-05-23 10:19:18 -0400591 cfg.ListOpt('scheduler_enabled_filters',
Artom Lifshitz1c976a92019-06-17 15:30:18 -0400592 default=["AvailabilityZoneFilter", "ComputeFilter",
593 "ComputeCapabilitiesFilter", "ImagePropertiesFilter",
Artom Lifshitz595ae162018-05-23 10:19:18 -0400594 "ServerGroupAntiAffinityFilter",
595 "ServerGroupAffinityFilter"],
596 help="A list of enabled filters that Nova will accept as "
597 "hints to the scheduler when creating a server. If the "
ghanshyam5817e142016-12-01 11:38:46 +0900598 "default value is overridden in nova.conf by the test "
599 "environment (which means that a different set of "
600 "filters is enabled than what is included in Nova by "
Artom Lifshitz595ae162018-05-23 10:19:18 -0400601 "default), then this option must be configured to "
ghanshyam5817e142016-12-01 11:38:46 +0900602 "contain the same filters that Nova uses in the test "
Artom Lifshitz595ae162018-05-23 10:19:18 -0400603 "environment. A special entry 'all' indicates all "
604 "filters that are included with Nova are enabled. If "
605 "using 'all', be sure to enable all filters in "
606 "nova.conf, as tests can fail in unpredictable ways if "
607 "Nova's and Tempest's enabled filters don't match. "
608 "Empty list indicates all filters are disabled. The "
609 "full list of enabled filters is in nova.conf: "
610 "filter_scheduler.enabled_filters.",
611 deprecated_opts=[cfg.DeprecatedOpt(
612 'scheduler_available_filters',
613 group='compute-feature-enabled')]),
Matt Riedemann342b37c2016-09-21 15:38:12 -0400614 cfg.BoolOpt('swap_volume',
615 default=False,
616 help='Does the test environment support in-place swapping of '
617 'volumes attached to a server instance?'),
melanie witt334f3132017-12-14 21:49:55 +0000618 cfg.BoolOpt('volume_backed_live_migration',
619 default=False,
620 help='Does the test environment support volume-backed live '
621 'migration?'),
Matt Riedemann81fa9b62016-01-14 13:04:38 -0800622 cfg.BoolOpt('volume_multiattach',
623 default=False,
624 help='Does the test environment support attaching a volume to '
625 'more than one instance? This depends on hypervisor and '
626 'volume backend/type and compute API version 2.60.'),
Stephen Finucane39fa9c12020-09-03 17:47:19 +0100627 cfg.BoolOpt('xenapi_apis',
628 default=False,
629 help='Does the test environment support the XenAPI-specific '
630 'APIs: os-agents, writeable server metadata and the '
631 'resetNetwork server action? '
632 'These were removed in Victoria alongside the XenAPI '
633 'virt driver.',
634 deprecated_for_removal=True,
635 deprecated_reason="On Nova side, XenAPI virt driver and the "
636 "APIs that only worked with that driver "
637 "have been removed and there's nothing to "
638 "test after Ussuri."),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000639]
640
641
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500642image_group = cfg.OptGroup(name='image',
643 title="Image Service Options")
Jay Pipesf38eaac2012-06-21 13:37:35 -0400644
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500645ImageGroup = [
Matthew Treinish72ea4422013-02-07 14:42:49 -0500646 cfg.StrOpt('catalog_type',
647 default='image',
Sean Dague83401992013-05-06 17:46:36 -0400648 help='Catalog type of the Image service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900649 cfg.StrOpt('region',
650 default='',
651 help="The image region name to use. If empty, the value "
652 "of identity.region is used instead. If no such region "
653 "is found in the service catalog, the first found one is "
654 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000655 cfg.StrOpt('endpoint_type',
656 default='publicURL',
657 choices=['public', 'admin', 'internal',
658 'publicURL', 'adminURL', 'internalURL'],
659 help="The endpoint type to use for the image service."),
Sean Dague83401992013-05-06 17:46:36 -0400660 cfg.StrOpt('http_image',
661 default='http://download.cirros-cloud.net/0.3.1/'
662 'cirros-0.3.1-x86_64-uec.tar.gz',
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200663 help='http accessible image'),
664 cfg.IntOpt('build_timeout',
665 default=300,
666 help="Timeout in seconds to wait for an image to "
667 "become available."),
668 cfg.IntOpt('build_interval',
669 default=1,
670 help="Time in seconds between image operation status "
Takashi NATSUME12a48512015-08-10 18:33:16 +0900671 "checks."),
672 cfg.ListOpt('container_formats',
673 default=['ami', 'ari', 'aki', 'bare', 'ovf', 'ova'],
674 help="A list of image's container formats "
675 "users can specify."),
676 cfg.ListOpt('disk_formats',
677 default=['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2',
Benny Kopilov97c74192017-03-30 09:34:59 +0300678 'vdi', 'iso', 'vhdx'],
Takashi NATSUME12a48512015-08-10 18:33:16 +0900679 help="A list of image's disk formats "
680 "users can specify.")
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500681]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400682
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000683image_feature_group = cfg.OptGroup(name='image-feature-enabled',
684 title='Enabled image service features')
685
686ImageFeaturesGroup = [
687 cfg.BoolOpt('api_v2',
688 default=True,
ghanshyam6b0b8b72017-03-08 04:22:53 +0000689 help="Is the v2 image API enabled",
690 deprecated_for_removal=True,
691 deprecated_reason='Glance v1 APIs are deprecated and v2 APIs '
692 'are current one. In future, Tempest will '
693 'test v2 APIs only so this config option '
694 'will be removed.'),
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000695 cfg.BoolOpt('api_v1',
zhufldc68af72018-09-05 15:47:39 +0800696 default=False,
ghanshyam6b0b8b72017-03-08 04:22:53 +0000697 help="Is the v1 image API enabled",
698 deprecated_for_removal=True,
699 deprecated_reason='Glance v1 APIs are deprecated and v2 APIs '
700 'are current one. In future, Tempest will '
701 'test v2 APIs only so this config option '
702 'will be removed.'),
Abhishek Kekane7cff1302020-07-16 10:30:13 +0000703 # Image import feature is setup in devstack victoria onwards.
704 # Once all stable branches setup the same via glance standalone
705 # mode or with uwsgi, we can remove this config option.
706 cfg.BoolOpt('import_image',
707 default=False,
708 help="Is image import feature enabled"),
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000709]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400710
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500711network_group = cfg.OptGroup(name='network',
712 title='Network Service Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600713
Noam Angel3c6b0162018-07-08 17:05:35 +0300714ProfileType = types.Dict(types.List(types.String(), bounds=True))
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500715NetworkGroup = [
716 cfg.StrOpt('catalog_type',
717 default='network',
Mark McClainf2982e82013-07-06 17:48:03 -0400718 help='Catalog type of the Neutron service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900719 cfg.StrOpt('region',
720 default='',
721 help="The network region name to use. If empty, the value "
722 "of identity.region is used instead. If no such region "
723 "is found in the service catalog, the first found one is "
724 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000725 cfg.StrOpt('endpoint_type',
726 default='publicURL',
727 choices=['public', 'admin', 'internal',
728 'publicURL', 'adminURL', 'internalURL'],
729 help="The endpoint type to use for the network service."),
Sean Dagueed6e5862016-04-04 10:49:13 -0400730 cfg.StrOpt('project_network_cidr',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500731 default="10.100.0.0/16",
Sean Dagueed6e5862016-04-04 10:49:13 -0400732 help="The cidr block to allocate project ipv4 subnets from"),
733 cfg.IntOpt('project_network_mask_bits',
Attila Fazekas8ea181b2013-07-13 16:26:14 +0200734 default=28,
Sean Dagueed6e5862016-04-04 10:49:13 -0400735 help="The mask bits for project ipv4 subnets"),
736 cfg.StrOpt('project_network_v6_cidr',
Brian Haley56893552019-09-19 17:50:37 -0400737 default="2001:db8::/48",
Sean Dagueed6e5862016-04-04 10:49:13 -0400738 help="The cidr block to allocate project ipv6 subnets from"),
739 cfg.IntOpt('project_network_v6_mask_bits',
Sergey Shnaidman1f3659a2014-08-27 18:26:42 +0400740 default=64,
Sean Dagueed6e5862016-04-04 10:49:13 -0400741 help="The mask bits for project ipv6 subnets"),
742 cfg.BoolOpt('project_networks_reachable',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500743 default=False,
Sean Dagueed6e5862016-04-04 10:49:13 -0400744 help="Whether project networks can be reached directly from "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000745 "the test client. This must be set to True when the "
Matt Riedemann4b0f7e72016-08-08 15:29:26 -0400746 "'fixed' connect_method is selected."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500747 cfg.StrOpt('public_network_id',
748 default="",
749 help="Id of the public network that provides external "
750 "connectivity"),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000751 cfg.StrOpt('floating_network_name',
752 help="Default floating network name. Used to allocate floating "
753 "IPs when neutron is enabled."),
Lukas Piwowarski2385e042020-01-31 12:28:20 +0000754 cfg.StrOpt('subnet_id',
755 default="",
756 help="Subnet id of subnet which is used for allocation of "
757 "floating IPs. Specify when two or more subnets are "
758 "present in network."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500759 cfg.StrOpt('public_router_id',
760 default="",
761 help="Id of the public router that provides external "
Yair Fried1eb27f52014-11-10 15:24:19 +0200762 "connectivity. This should only be used when Neutron's "
763 "'allow_overlapping_ips' is set to 'False' in "
764 "neutron.conf. usually not needed past 'Grizzly' release"),
izikpensod9a01a62014-02-17 20:02:32 +0200765 cfg.IntOpt('build_timeout',
766 default=300,
767 help="Timeout in seconds to wait for network operation to "
768 "complete."),
769 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400770 default=1,
izikpensod9a01a62014-02-17 20:02:32 +0200771 help="Time in seconds between network operation status "
772 "checks."),
Attila Fazekas640392b2014-06-12 15:58:10 +0200773 cfg.ListOpt('dns_servers',
774 default=["8.8.8.8", "8.8.4.4"],
Itzik Brown5be44582014-12-24 09:05:13 +0200775 help="List of dns servers which should be used"
zhufle027ea92019-05-07 14:02:23 +0800776 " for subnet creation",
777 deprecated_for_removal=True,
778 deprecated_reason="This config option is no longer "
779 "used anywhere, so it can be removed."),
Itzik Brown2ca01cd2014-12-08 12:58:20 +0200780 cfg.StrOpt('port_vnic_type',
Tom Stappaerts27fd5cb2020-11-26 12:07:47 +0100781 choices=[None, 'normal', 'direct', 'macvtap', 'direct-physical',
782 'baremetal', 'virtio-forwarder'],
Moshe Levie2c2fb12017-08-31 15:18:58 +0300783 help="vnic_type to use when launching instances"
Itzik Brown2ca01cd2014-12-08 12:58:20 +0200784 " with pre-configured ports."
785 " Supported ports are:"
Tom Stappaerts27fd5cb2020-11-26 12:07:47 +0100786 " ['normal', 'direct', 'macvtap', 'direct-physical', "
787 "'baremetal', 'virtio-forwarder']"),
Noam Angel3c6b0162018-07-08 17:05:35 +0300788 cfg.Opt('port_profile',
789 type=ProfileType,
790 default={},
791 help="port profile to use when launching instances"
792 " with pre-configured ports."),
piyush11078648e35d52015-09-24 12:56:43 +0530793 cfg.ListOpt('default_network',
794 default=["1.0.0.0/16", "2.0.0.0/16"],
795 help="List of ip pools"
796 " for subnetpools creation"),
Thiago Paiva66cded22016-08-15 14:55:58 -0300797 cfg.BoolOpt('shared_physical_network',
798 default=False,
799 help="The environment does not support network separation "
800 "between tenants."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500801]
Jay Pipes3f981df2012-03-27 18:59:44 -0400802
Matthew Treinishe3d26142013-11-26 19:14:58 +0000803network_feature_group = cfg.OptGroup(name='network-feature-enabled',
804 title='Enabled network service features')
805
806NetworkFeaturesGroup = [
Matthew Treinishe2e33cf2014-03-03 19:28:41 +0000807 cfg.BoolOpt('ipv6',
808 default=True,
Brian Haley3d701092020-11-23 14:03:25 -0500809 help="Allow the execution of IPv6 tests."),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000810 cfg.ListOpt('api_extensions',
811 default=['all'],
Alexander Gubanov36e1f9b2015-06-12 18:02:10 +0300812 help="A list of enabled network extensions with a special "
813 "entry all which indicates every extension is enabled. "
814 "Empty list indicates all extensions are disabled. "
Brian Haley3d701092020-11-23 14:03:25 -0500815 "To get the list of extensions run: "
816 "'openstack extension list --network'"),
elajkatf9bb8b82020-11-02 13:41:06 +0100817 cfg.ListOpt('available_features',
818 default=['all'],
819 help="A list of available network features with a special "
820 "entry all that indicates every feature is available. "
Brian Haley3d701092020-11-23 14:03:25 -0500821 "Empty list indicates all features are disabled. "
elajkatf9bb8b82020-11-02 13:41:06 +0100822 "This list can contain features that are not "
Brian Haley3d701092020-11-23 14:03:25 -0500823 "discoverable through the API."),
Sean M. Collinsdd27a4d2014-05-13 10:33:15 -0400824 cfg.BoolOpt('ipv6_subnet_attributes',
825 default=False,
826 help="Allow the execution of IPv6 subnet tests that use "
827 "the extended IPv6 attributes ipv6_ra_mode "
Brian Haley3d701092020-11-23 14:03:25 -0500828 "and ipv6_address_mode."
Mark McClain6e07c0d2014-10-10 11:25:03 -0400829 ),
Itzik Brownbeb30d32015-03-29 09:42:54 +0300830 cfg.BoolOpt('port_admin_state_change',
831 default=True,
Brian Haley3d701092020-11-23 14:03:25 -0500832 help="Does the test environment support changing "
833 "port admin state?"),
Matt Riedemann039b2fe2016-09-15 16:12:24 -0400834 cfg.BoolOpt('port_security',
835 default=False,
836 help="Does the test environment support port security?"),
Matthew Treinish3312de32017-05-19 12:08:17 -0400837 cfg.BoolOpt('floating_ips',
838 default=True,
Brian Haley3d701092020-11-23 14:03:25 -0500839 help='Does the test environment support floating_ips?'),
Lajos Katonac87a06b2019-01-04 13:21:48 +0100840 cfg.StrOpt('qos_placement_physnet', default=None,
841 help='Name of the physnet for placement based minimum '
842 'bandwidth allocation.'),
843 cfg.StrOpt('provider_net_base_segmentation_id', default=3000,
844 help='Base segmentation ID to create provider networks. '
845 'This value will be increased in case of conflict.')
Matthew Treinishe3d26142013-11-26 19:14:58 +0000846]
847
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -0600848dashboard_group = cfg.OptGroup(name="dashboard",
849 title="Dashboard options")
850
851DashboardGroup = [
852 cfg.StrOpt('dashboard_url',
853 default='http://localhost/',
854 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',
878 choices=['fixed', 'floating'],
879 help='Default IP type used for validation: '
880 '-fixed: uses the first IP belonging to the fixed network '
ghanshyamade71d22017-02-15 05:36:14 +0000881 '-floating: creates and uses a floating IP'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000882 cfg.StrOpt('auth_method',
883 default='keypair',
884 choices=['keypair'],
885 help='Default authentication method to the instance. '
886 'Only ssh via keypair is supported for now. '
ghanshyamade71d22017-02-15 05:36:14 +0000887 'Additional methods will be handled in a separate spec.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000888 cfg.IntOpt('ip_version_for_ssh',
889 default=4,
lanoux283273b2015-12-04 03:01:54 -0800890 help='Default IP version for ssh connections.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000891 cfg.IntOpt('ping_timeout',
892 default=120,
ghanshyam244cf7c2017-02-15 06:39:31 +0000893 help='Timeout in seconds to wait for ping to succeed.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000894 cfg.IntOpt('connect_timeout',
895 default=60,
896 help='Timeout in seconds to wait for the TCP connection to be '
lanoux283273b2015-12-04 03:01:54 -0800897 'successful.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000898 cfg.IntOpt('ssh_timeout',
899 default=300,
lanoux283273b2015-12-04 03:01:54 -0800900 help='Timeout in seconds to wait for the ssh banner.'),
901 cfg.StrOpt('image_ssh_user',
902 default="root",
ghanshyam244cf7c2017-02-15 06:39:31 +0000903 help="User name used to authenticate to an instance."),
Weronika Sikorac54a9112019-09-18 13:55:07 +0000904 cfg.StrOpt('image_alt_ssh_user',
905 default="root",
906 help="User name used to authenticate to an alt instance."),
lanoux283273b2015-12-04 03:01:54 -0800907 cfg.StrOpt('image_ssh_password',
908 default="password",
Doug Schveninger6a2be432020-04-29 17:42:31 -0500909 help="Password used to authenticate to an instance.",
910 secret=True),
Weronika Sikorac54a9112019-09-18 13:55:07 +0000911 cfg.StrOpt('image_alt_ssh_password',
912 default="password",
913 help="Password used to authenticate to an alt instance.",
914 secret=True),
lanoux283273b2015-12-04 03:01:54 -0800915 cfg.StrOpt('ssh_shell_prologue',
Lucian Petrut6a7472a2019-08-07 12:43:08 +0300916 default="set -eu -o pipefail; PATH=$$PATH:/sbin:/usr/sbin;",
lanoux283273b2015-12-04 03:01:54 -0800917 help="Shell fragments to use before executing a command "
ghanshyamade71d22017-02-15 05:36:14 +0000918 "when sshing to a guest."),
lanoux283273b2015-12-04 03:01:54 -0800919 cfg.IntOpt('ping_size',
920 default=56,
921 help="The packet size for ping packets originating "
ghanshyamade71d22017-02-15 05:36:14 +0000922 "from remote linux hosts"),
lanoux283273b2015-12-04 03:01:54 -0800923 cfg.IntOpt('ping_count',
924 default=1,
925 help="The number of ping packets originating from remote "
ghanshyamade71d22017-02-15 05:36:14 +0000926 "linux hosts"),
lanoux283273b2015-12-04 03:01:54 -0800927 cfg.StrOpt('floating_ip_range',
928 default='10.0.0.0/29',
929 help='Unallocated floating IP range, which will be used to '
930 'test the floating IP bulk feature for CRUD operation. '
931 'This block must not overlap an existing floating IP '
ghanshyamade71d22017-02-15 05:36:14 +0000932 'pool.'),
lanoux283273b2015-12-04 03:01:54 -0800933 cfg.StrOpt('network_for_ssh',
934 default='public',
935 help="Network used for SSH connections. Ignored if "
ghanshyam244cf7c2017-02-15 06:39:31 +0000936 "connect_method=floating."),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000937]
938
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500939volume_group = cfg.OptGroup(name='volume',
940 title='Block Storage Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600941
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500942VolumeGroup = [
943 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400944 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500945 help='Time in seconds between volume availability checks.'),
946 cfg.IntOpt('build_timeout',
947 default=300,
Eric Harney9b1f89c2014-10-14 14:40:19 -0400948 help='Timeout in seconds to wait for a volume to become '
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500949 'available.'),
950 cfg.StrOpt('catalog_type',
ghanshyam89c213f2017-12-14 07:22:12 +0000951 default='volumev3',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500952 help="Catalog type of the Volume Service"),
Arata Notsu8f440392013-09-13 16:14:20 +0900953 cfg.StrOpt('region',
954 default='',
955 help="The volume region name to use. If empty, the value "
956 "of identity.region is used instead. If no such region "
957 "is found in the service catalog, the first found one is "
958 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000959 cfg.StrOpt('endpoint_type',
960 default='publicURL',
961 choices=['public', 'admin', 'internal',
962 'publicURL', 'adminURL', 'internalURL'],
963 help="The endpoint type to use for the volume service."),
Benny Kopilovaf136a92015-11-10 07:37:23 +0200964 cfg.ListOpt('backend_names',
965 default=['BACKEND_1', 'BACKEND_2'],
april4be58dc2015-12-29 00:07:22 +0800966 help='A list of backend names separated by comma. '
bkopilov27905cc2016-04-12 14:29:13 +0300967 'The backend name must be declared in cinder.conf'),
Adam Gandelman827ad332013-06-24 17:04:09 -0700968 cfg.StrOpt('storage_protocol',
969 default='iSCSI',
970 help='Backend protocol to target when creating volume types'),
971 cfg.StrOpt('vendor_name',
972 default='Open Source',
973 help='Backend vendor to target when creating volume types'),
Ryan Hsua67f4632013-08-29 16:03:06 -0700974 cfg.StrOpt('disk_format',
975 default='raw',
976 help='Disk format to use when copying a volume to image'),
Jerry Cai9733d0e2014-03-19 15:50:49 +0800977 cfg.IntOpt('volume_size',
978 default=1,
979 help='Default size in GB for volumes created by volumes tests'),
jeremy.zhangf4fbf302017-03-22 11:25:53 +0800980 cfg.ListOpt('manage_volume_ref',
981 default=['source-name', 'volume-%s'],
982 help="A reference to existing volume for volume manage. "
983 "It contains two elements, the first is ref type "
984 "(like 'source-name', 'source-id', etc), the second is "
985 "volume name template used in storage backend"),
jeremy.zhangebc752b2017-06-14 13:58:37 +0800986 cfg.ListOpt('manage_snapshot_ref',
987 default=['source-name', '_snapshot-%s'],
988 help="A reference to existing snapshot for snapshot manage. "
989 "It contains two elements, the first is ref type "
990 "(like 'source-name', 'source-id', etc), the second is "
991 "snapshot name template used in storage backend"),
Andrew Kerrfcb0b682016-04-01 16:01:34 -0400992 cfg.StrOpt('min_microversion',
993 default=None,
994 help="Lower version of the test target microversion range. "
995 "The format is 'X.Y', where 'X' and 'Y' are int values. "
996 "Tempest selects tests based on the range between "
997 "min_microversion and max_microversion. "
998 "If both values are not specified, Tempest avoids tests "
999 "which require a microversion. Valid values are string "
1000 "with format 'X.Y' or string 'latest'",),
1001 cfg.StrOpt('max_microversion',
1002 default=None,
1003 help="Upper version of the test target microversion range. "
1004 "The format is 'X.Y', where 'X' and 'Y' are int values. "
1005 "Tempest selects tests based on the range between "
1006 "min_microversion and max_microversion. "
1007 "If both values are not specified, Tempest avoids tests "
1008 "which require a microversion. Valid values are string "
1009 "with format 'X.Y' or string 'latest'",),
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001010]
K Jonathan Harkerd6ba4b42012-12-18 13:50:47 -08001011
Matthew Treinishd5c96022013-10-17 21:51:23 +00001012volume_feature_group = cfg.OptGroup(name='volume-feature-enabled',
1013 title='Enabled Cinder Features')
1014
1015VolumeFeaturesGroup = [
1016 cfg.BoolOpt('multi_backend',
1017 default=False,
Matthew Treinishe3d26142013-11-26 19:14:58 +00001018 help="Runs Cinder multi-backend test (requires 2 backends)"),
Giulio Fidente74b08ad2014-01-18 04:02:51 +01001019 cfg.BoolOpt('backup',
1020 default=True,
1021 help='Runs Cinder volumes backup test'),
JordanPbce55532014-03-19 12:10:32 +01001022 cfg.BoolOpt('snapshot',
1023 default=True,
1024 help='Runs Cinder volume snapshot test'),
Takeaki Matsumoto1702aed2015-08-25 08:44:26 +09001025 cfg.BoolOpt('clone',
1026 default=True,
1027 help='Runs Cinder volume clone test'),
Jordan Pittier31256252017-01-11 14:29:49 +01001028 cfg.BoolOpt('manage_snapshot',
1029 default=False,
1030 help='Runs Cinder manage snapshot tests'),
jeremy.zhangf4fbf302017-03-22 11:25:53 +08001031 cfg.BoolOpt('manage_volume',
1032 default=False,
1033 help='Runs Cinder manage volume tests'),
Matthew Treinishe3d26142013-11-26 19:14:58 +00001034 cfg.ListOpt('api_extensions',
1035 default=['all'],
Zhi Kun Liude25c022014-02-14 13:25:19 +08001036 help='A list of enabled volume extensions with a special '
Simeon Monov5d7effe2014-07-16 07:32:38 +03001037 'entry all which indicates every extension is enabled. '
1038 'Empty list indicates all extensions are disabled'),
Zhi Kun Liu8cc3c842014-01-07 10:44:34 +08001039 cfg.BoolOpt('api_v2',
1040 default=True,
ghanshyamf2f43842018-08-09 07:13:46 +00001041 help="Is the v2 volume API enabled",
1042 deprecated_for_removal=True,
1043 deprecated_reason="The v2 volume API has been deprecated "
1044 "since Pike release. Now Tempest run all "
1045 "the volume tests against v2 or v3 API "
1046 "based on CONF.volume.catalog_type which "
1047 "makes this config option unusable. If "
1048 "catalog_type is volumev2, then all the "
1049 "volume tests will run against v2 API. "
1050 "Use ``CONF.volume.catalog_type`` to run "
1051 "the Tempest against volume v2 or v3 API"),
Andrew Kerrfcb0b682016-04-01 16:01:34 -04001052 cfg.BoolOpt('api_v3',
Ken'ichi Ohmichi0f107bc2017-03-17 09:55:55 -07001053 default=True,
ghanshyamf2f43842018-08-09 07:13:46 +00001054 help="Is the v3 volume API enabled",
1055 deprecated_for_removal=True,
1056 deprecated_reason="Tempest run all the volume tests against "
1057 "v2 or v3 API based on "
1058 "CONF.volume.catalog_type which makes this "
1059 "config option unusable. If catalog_type is "
1060 "volumev3 which is default, then all the "
1061 "volume tests will run against v3 API. "
1062 "Use ``CONF.volume.catalog_type`` to run "
1063 "the Tempest against volume v2 or v3 API"),
Matt Riedemann0cc76bf2017-07-05 17:29:31 -04001064 cfg.BoolOpt('extend_attached_volume',
1065 default=False,
1066 help='Does the cloud support extending the size of a volume '
1067 'which is currently attached to a server instance? This '
1068 'depends on the 3.42 volume API microversion and the '
1069 '2.51 compute API microversion. Also, not all volume or '
Lee Yarwood4bd9edb2020-01-31 17:26:25 +00001070 'compute backends support this operation.'),
1071 cfg.BoolOpt('extend_attached_encrypted_volume',
1072 default=False,
1073 help='Does the cloud support extending the size of an '
1074 'encrypted volume which is currently attached to a '
1075 'server instance? This depends on the 3.42 volume API '
1076 'microversion and the 2.51 compute API microversion. '
1077 'Also, not all volume or compute backends support this '
1078 'operation.')
Matthew Treinishd5c96022013-10-17 21:51:23 +00001079]
1080
Daryl Walleck587385b2012-03-03 13:00:26 -06001081
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001082object_storage_group = cfg.OptGroup(name='object-storage',
1083 title='Object Storage Service Options')
Attila Fazekasa23f5002012-10-23 19:32:45 +02001084
DennyZhang1e71b612013-09-26 12:35:40 -05001085ObjectStoreGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001086 cfg.StrOpt('catalog_type',
1087 default='object-store',
1088 help="Catalog type of the Object-Storage service."),
Arata Notsu8f440392013-09-13 16:14:20 +09001089 cfg.StrOpt('region',
1090 default='',
1091 help="The object-storage region name to use. If empty, the "
1092 "value of identity.region is used instead. If no such "
1093 "region is found in the service catalog, the first found "
1094 "one is used."),
JordanP5d29b2c2013-12-18 13:56:03 +00001095 cfg.StrOpt('endpoint_type',
1096 default='publicURL',
1097 choices=['public', 'admin', 'internal',
1098 'publicURL', 'adminURL', 'internalURL'],
1099 help="The endpoint type to use for the object-store service."),
Matthew Treinishf319a732013-10-24 21:39:24 +00001100 cfg.IntOpt('container_sync_timeout',
Daisuke Morita1ac3ee02014-08-25 12:59:18 +09001101 default=600,
Fabien Boucher2178d312013-12-31 15:38:57 +01001102 help="Number of seconds to time on waiting for a container "
nayna-patelb4989b32013-01-09 06:25:13 +00001103 "to container synchronization complete."),
Matthew Treinishf319a732013-10-24 21:39:24 +00001104 cfg.IntOpt('container_sync_interval',
nayna-patelb4989b32013-01-09 06:25:13 +00001105 default=5,
Fabien Boucher2178d312013-12-31 15:38:57 +01001106 help="Number of seconds to wait while looping to check the "
nayna-patelb4989b32013-01-09 06:25:13 +00001107 "status of a container to container synchronization"),
Matthew Treinish3fdb80c2013-08-15 11:13:19 -04001108 cfg.StrOpt('operator_role',
Martin Kopec99d4dae2020-05-27 10:33:17 +00001109 default='member',
Matthew Treinish3fdb80c2013-08-15 11:13:19 -04001110 help="Role to add to users created for swift tests to "
1111 "enable creating containers"),
Matthew Treinish998c91d2014-03-01 12:39:49 -05001112 cfg.StrOpt('reseller_admin_role',
1113 default='ResellerAdmin',
1114 help="User role that has reseller admin"),
Daisuke Morita1ac3ee02014-08-25 12:59:18 +09001115 cfg.StrOpt('realm_name',
1116 default='realm1',
1117 help="Name of sync realm. A sync realm is a set of clusters "
1118 "that have agreed to allow container syncing with each "
1119 "other. Set the same realm name as Swift's "
1120 "container-sync-realms.conf"),
1121 cfg.StrOpt('cluster_name',
1122 default='name1',
1123 help="One name of cluster which is set in the realm whose name "
1124 "is set in 'realm_name' item in this file. Set the "
1125 "same cluster name as Swift's container-sync-realms.conf"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -05001126]
Attila Fazekasa23f5002012-10-23 19:32:45 +02001127
Matthew Treinishd5c96022013-10-17 21:51:23 +00001128object_storage_feature_group = cfg.OptGroup(
1129 name='object-storage-feature-enabled',
1130 title='Enabled object-storage features')
1131
1132ObjectStoreFeaturesGroup = [
Matthew Treinish20345382013-12-13 17:04:23 +00001133 cfg.ListOpt('discoverable_apis',
1134 default=['all'],
1135 help="A list of the enabled optional discoverable apis. "
1136 "A single entry, all, indicates that all of these "
1137 "features are expected to be enabled"),
Daisuke Morita20a183f2014-08-25 14:43:36 +09001138 cfg.BoolOpt('container_sync',
1139 default=True,
1140 help="Execute (old style) container-sync tests"),
1141 cfg.BoolOpt('object_versioning',
1142 default=True,
1143 help="Execute object-versioning tests"),
1144 cfg.BoolOpt('discoverability',
1145 default=True,
1146 help="Execute discoverability tests"),
Matthew Treinishd5c96022013-10-17 21:51:23 +00001147]
1148
Luigi Toscano14d172d2015-01-23 16:37:47 +01001149
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001150scenario_group = cfg.OptGroup(name='scenario', title='Scenario Test Options')
1151
1152ScenarioGroup = [
1153 cfg.StrOpt('img_dir',
1154 default='/opt/stack/new/devstack/files/images/'
1155 'cirros-0.3.1-x86_64-uec',
Martin Kopec02af6a42020-03-03 12:39:12 +00001156 help='Directory containing image files, this has been '
1157 'deprecated - img_file option contains a full path now.',
Matthew Treinish5d5e20a2016-01-14 10:54:30 -05001158 deprecated_for_removal=True),
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001159 cfg.StrOpt('img_file', deprecated_name='qcow2_img_file',
Martin Kopec02af6a42020-03-03 12:39:12 +00001160 default='/opt/stack/new/devstack/files/images'
1161 '/cirros-0.3.1-x86_64-disk.img',
1162 help='Image full path.'),
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001163 cfg.StrOpt('img_disk_format',
1164 default='qcow2',
1165 help='Image disk format'),
1166 cfg.StrOpt('img_container_format',
1167 default='bare',
1168 help='Image container format'),
Evgeny Antyshev7ba0d5f2015-04-28 13:18:07 +00001169 cfg.DictOpt('img_properties', help='Glance image properties. '
1170 'Use for custom images which require them'),
Yair Fried413bf2d2014-11-19 17:07:11 +02001171 # TODO(yfried): add support for dhcpcd
1172 cfg.StrOpt('dhcp_client',
1173 default='udhcpc',
Yaroslav Lobankovceae2042015-09-09 19:25:14 +03001174 choices=["udhcpc", "dhclient", ""],
Yair Fried413bf2d2014-11-19 17:07:11 +02001175 help='DHCP client used by images to renew DCHP lease. '
1176 'If left empty, update operation will be skipped. '
Claudiu Belu33c3e602014-08-28 16:38:01 +03001177 'Supported clients: "udhcpc", "dhclient"'),
1178 cfg.StrOpt('protocol',
1179 default='icmp',
1180 choices=('icmp', 'tcp', 'udp'),
1181 help='The protocol used in security groups tests to check '
1182 'connectivity.'),
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001183]
1184
1185
Matthew Treinish4c412922013-07-16 15:27:42 -04001186service_available_group = cfg.OptGroup(name="service_available",
1187 title="Available OpenStack Services")
1188
1189ServiceAvailableGroup = [
1190 cfg.BoolOpt('cinder',
1191 default=True,
1192 help="Whether or not cinder is expected to be available"),
Matthew Treinishfaa340d2013-07-19 16:26:21 -04001193 cfg.BoolOpt('neutron',
1194 default=False,
1195 help="Whether or not neutron is expected to be available"),
Matthew Treinish853ae442013-07-19 16:36:07 -04001196 cfg.BoolOpt('glance',
1197 default=True,
1198 help="Whether or not glance is expected to be available"),
Matthew Treinish61e332b2013-07-19 16:42:31 -04001199 cfg.BoolOpt('swift',
1200 default=True,
1201 help="Whether or not swift is expected to be available"),
Matthew Treinish6b41e242013-07-19 16:49:28 -04001202 cfg.BoolOpt('nova',
1203 default=True,
1204 help="Whether or not nova is expected to be available"),
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -06001205 cfg.BoolOpt('horizon',
1206 default=True,
1207 help="Whether or not horizon is expected to be available"),
Matthew Treinish4c412922013-07-16 15:27:42 -04001208]
1209
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001210debug_group = cfg.OptGroup(name="debug",
1211 title="Debug System")
1212
1213DebugGroup = [
Sean Daguec522c092014-03-24 10:43:22 -04001214 cfg.StrOpt('trace_requests',
1215 default='',
1216 help="""A regex to determine which requests should be traced.
1217
1218This is a regex to match the caller for rest client requests to be able to
1219selectively trace calls out of specific classes and methods. It largely
1220exists for test development, and is not expected to be used in a real deploy
1221of tempest. This will be matched against the discovered ClassName:method
1222in the test environment.
1223
1224Expected values for this field are:
1225
1226 * ClassName:test_method_name - traces one test_method
1227 * ClassName:setUp(Class) - traces specific setup functions
1228 * ClassName:tearDown(Class) - traces specific teardown functions
1229 * ClassName:_run_cleanups - traces the cleanup functions
1230
1231If nothing is specified, this feature is not enabled. To trace everything
1232specify .* as the regex.
1233""")
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001234]
1235
Ilya Shakhat1291bb42017-11-29 18:08:16 +01001236
1237profiler_group = cfg.OptGroup(name="profiler",
1238 title="OpenStack Profiler")
1239
1240ProfilerGroup = [
1241 cfg.StrOpt('key',
1242 help="The secret key to enable OpenStack Profiler. The value "
1243 "should match the one configured in OpenStack services "
1244 "under `[profiler]/hmac_keys` property. The default empty "
1245 "value keeps profiling disabled"),
1246]
1247
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001248DefaultGroup = [
Martin Kopecae155b72017-06-26 09:41:21 +00001249 cfg.BoolOpt('pause_teardown',
1250 default=False,
1251 help="""Whether to pause a test in global teardown.
1252
1253The best use case is investigating used resources of one test.
1254A test can be run as follows:
Soniya Vyase42bd932019-11-26 16:14:33 +05301255 $ stestr run --pdb TEST_ID
Martin Kopecae155b72017-06-26 09:41:21 +00001256or
1257 $ python -m testtools.run TEST_ID"""),
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001258]
1259
Jon Grimm270bd7f2014-08-05 18:11:29 +00001260_opts = [
1261 (auth_group, AuthGroup),
1262 (compute_group, ComputeGroup),
1263 (compute_features_group, ComputeFeaturesGroup),
1264 (identity_group, IdentityGroup),
zhufl071e94c2016-07-12 10:26:34 +08001265 (service_clients_group, ServiceClientsGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001266 (identity_feature_group, IdentityFeatureGroup),
1267 (image_group, ImageGroup),
1268 (image_feature_group, ImageFeaturesGroup),
1269 (network_group, NetworkGroup),
1270 (network_feature_group, NetworkFeaturesGroup),
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -06001271 (dashboard_group, DashboardGroup),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001272 (validation_group, ValidationGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001273 (volume_group, VolumeGroup),
1274 (volume_feature_group, VolumeFeaturesGroup),
1275 (object_storage_group, ObjectStoreGroup),
1276 (object_storage_feature_group, ObjectStoreFeaturesGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001277 (scenario_group, ScenarioGroup),
1278 (service_available_group, ServiceAvailableGroup),
1279 (debug_group, DebugGroup),
Lajos Katonaceb88212018-11-30 14:54:12 +01001280 (placement_group, PlacementGroup),
Ilya Shakhat1291bb42017-11-29 18:08:16 +01001281 (profiler_group, ProfilerGroup),
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001282 (None, DefaultGroup)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001283]
1284
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001285
Matthew Treinish43b296a2014-02-28 15:23:00 -05001286def register_opts():
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001287 ext_plugins = plugins.TempestTestPluginManager()
1288 # Register in-tree tempest config options
Jon Grimm270bd7f2014-08-05 18:11:29 +00001289 for g, o in _opts:
Maru Newbyf440c292015-03-31 15:58:47 +00001290 register_opt_group(_CONF, g, o)
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001291 # Call external plugin config option registration
1292 ext_plugins.register_plugin_opts(_CONF)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001293
1294
1295def list_opts():
1296 """Return a list of oslo.config options available.
1297
1298 The purpose of this is to allow tools like the Oslo sample config file
1299 generator to discover the options exposed to users.
1300 """
Matthew Treinish83a19aa2015-07-23 13:06:13 -04001301 ext_plugins = plugins.TempestTestPluginManager()
Chris Hoged7b4fd12015-11-11 10:24:52 -08001302 # Make a shallow copy of the options list that can be
1303 # extended by plugins. Send back the group object
1304 # to allow group help text to be generated.
1305 opt_list = [(g, o) for g, o in _opts]
Matthew Treinish83a19aa2015-07-23 13:06:13 -04001306 opt_list.extend(ext_plugins.get_plugin_options_list())
1307 return opt_list
Matthew Treinish43b296a2014-02-28 15:23:00 -05001308
1309
Ken'ichi Ohmichi3f5c1392018-04-11 14:38:22 -07001310# This should never be called outside of this module
Sean Dague3b9b1f32013-12-20 17:04:54 -05001311class TempestConfigPrivate(object):
Daryl Walleck1465d612011-11-02 02:22:15 -05001312 """Provides OpenStack configuration information."""
1313
David Patersonbe9f9832015-10-15 09:10:45 -07001314 DEFAULT_CONFIG_DIR = os.path.join(os.getcwd(), "etc")
Daryl Walleck1465d612011-11-02 02:22:15 -05001315
Brian Waldon738cd632011-12-12 18:45:09 -05001316 DEFAULT_CONFIG_FILE = "tempest.conf"
1317
Andrea Frittolia96ee212014-08-15 18:34:20 +01001318 def __getattr__(self, attr):
1319 # Handles config options from the default group
Maru Newbyf440c292015-03-31 15:58:47 +00001320 return getattr(_CONF, attr)
Andrea Frittolia96ee212014-08-15 18:34:20 +01001321
Matthew Treinish43b296a2014-02-28 15:23:00 -05001322 def _set_attrs(self):
Andrea Frittoli382a6f12017-03-09 11:52:17 +00001323 # This methods ensures that config options in Tempest as well as
1324 # in Tempest plugins can be accessed via:
1325 # CONF.<normalised_group_name>.<key_name>
1326 # where:
1327 # normalised_group_name = group_name.replace('-', '_')
1328 # Attributes are set at __init__ time *only* for known option groups
Maru Newbyf440c292015-03-31 15:58:47 +00001329 self.auth = _CONF.auth
1330 self.compute = _CONF.compute
1331 self.compute_feature_enabled = _CONF['compute-feature-enabled']
1332 self.identity = _CONF.identity
zhufl071e94c2016-07-12 10:26:34 +08001333 self.service_clients = _CONF['service-clients']
Maru Newbyf440c292015-03-31 15:58:47 +00001334 self.identity_feature_enabled = _CONF['identity-feature-enabled']
1335 self.image = _CONF.image
1336 self.image_feature_enabled = _CONF['image-feature-enabled']
1337 self.network = _CONF.network
1338 self.network_feature_enabled = _CONF['network-feature-enabled']
Ghanshyam Manneb3c7e32021-01-20 15:27:16 -06001339 self.dashboard = _CONF.dashboard
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001340 self.validation = _CONF.validation
Maru Newbyf440c292015-03-31 15:58:47 +00001341 self.volume = _CONF.volume
1342 self.volume_feature_enabled = _CONF['volume-feature-enabled']
1343 self.object_storage = _CONF['object-storage']
1344 self.object_storage_feature_enabled = _CONF[
Matthew Treinishd5c96022013-10-17 21:51:23 +00001345 'object-storage-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001346 self.scenario = _CONF.scenario
1347 self.service_available = _CONF.service_available
1348 self.debug = _CONF.debug
Matthew Treinish46008082015-04-14 18:32:47 -04001349 logging.tempest_set_log_file('tempest.log')
Andrea Frittoli382a6f12017-03-09 11:52:17 +00001350 # Setting attributes for plugins
1351 # NOTE(andreaf) Plugins have no access to the TempestConfigPrivate
1352 # instance at discovery time, so they have no way of setting these
1353 # aliases themselves.
1354 ext_plugins = plugins.TempestTestPluginManager()
1355 for group, _ in ext_plugins.get_plugin_options_list():
1356 if isinstance(group, cfg.OptGroup):
1357 # If we have an OptGroup
1358 group_name = group.name
1359 group_dest = group.dest
1360 else:
1361 # If we have a group name as a string
1362 group_name = group
1363 group_dest = group.replace('-', '_')
1364 # NOTE(andreaf) We can set the attribute safely here since in
1365 # case of name conflict we would not have reached this point.
1366 setattr(self, group_dest, _CONF[group_name])
Sean Dague86bd8422013-12-20 09:56:44 -05001367
Joe Gordon28a84ae2014-07-17 15:38:28 +00001368 def __init__(self, parse_conf=True, config_path=None):
Matthew Treinish43b296a2014-02-28 15:23:00 -05001369 """Initialize a configuration from a conf directory and conf file."""
1370 super(TempestConfigPrivate, self).__init__()
1371 config_files = []
1372 failsafe_path = "/etc/tempest/" + self.DEFAULT_CONFIG_FILE
1373
Joe Gordon28a84ae2014-07-17 15:38:28 +00001374 if config_path:
1375 path = config_path
1376 else:
1377 # Environment variables override defaults...
1378 conf_dir = os.environ.get('TEMPEST_CONFIG_DIR',
1379 self.DEFAULT_CONFIG_DIR)
1380 conf_file = os.environ.get('TEMPEST_CONFIG',
1381 self.DEFAULT_CONFIG_FILE)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001382
Joe Gordon28a84ae2014-07-17 15:38:28 +00001383 path = os.path.join(conf_dir, conf_file)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001384
1385 if not os.path.isfile(path):
1386 path = failsafe_path
1387
1388 # only parse the config file if we expect one to exist. This is needed
1389 # to remove an issue with the config file up to date checker.
1390 if parse_conf:
1391 config_files.append(path)
Maru Newbyf440c292015-03-31 15:58:47 +00001392 logging.register_options(_CONF)
Matthew Treinish5440a402014-10-02 14:36:16 -04001393 if os.path.isfile(path):
Maru Newbyf440c292015-03-31 15:58:47 +00001394 _CONF([], project='tempest', default_config_files=config_files)
Matthew Treinish5440a402014-10-02 14:36:16 -04001395 else:
Maru Newbyf440c292015-03-31 15:58:47 +00001396 _CONF([], project='tempest')
Marc Kodererc81c7672015-12-17 12:10:12 +01001397
1398 logging_cfg_path = "%s/logging.conf" % os.path.dirname(path)
Tom Patzige6f7c7d2016-02-17 16:46:11 +01001399 if ((not hasattr(_CONF, 'log_config_append') or
afazekas40fcb9b2019-03-08 11:25:11 +01001400 _CONF.log_config_append is None) and
Marc Kodererc81c7672015-12-17 12:10:12 +01001401 os.path.isfile(logging_cfg_path)):
1402 # if logging conf is in place we need to set log_config_append
1403 _CONF.log_config_append = logging_cfg_path
1404
Maru Newbyf440c292015-03-31 15:58:47 +00001405 logging.setup(_CONF, 'tempest')
Matthew Treinish43b296a2014-02-28 15:23:00 -05001406 LOG = logging.getLogger('tempest')
Jordan Pittier525ec712016-12-07 17:51:26 +01001407 LOG.info("Using tempest config file %s", path)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001408 register_opts()
1409 self._set_attrs()
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001410 if parse_conf:
Anusha Raminenif3eb9472017-01-13 08:54:01 +05301411 _CONF.log_opt_values(LOG, logging.DEBUG)
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001412
Sean Dague86bd8422013-12-20 09:56:44 -05001413
1414class TempestConfigProxy(object):
1415 _config = None
Joe Gordon28a84ae2014-07-17 15:38:28 +00001416 _path = None
Sean Dague86bd8422013-12-20 09:56:44 -05001417
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001418 _extra_log_defaults = [
Anusha Raminenif3eb9472017-01-13 08:54:01 +05301419 ('paramiko.transport', logging.INFO),
1420 ('requests.packages.urllib3.connectionpool', logging.WARN),
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001421 ]
1422
1423 def _fix_log_levels(self):
1424 """Tweak the oslo log defaults."""
Doug Hellmann583ce2c2015-03-11 14:55:46 +00001425 for name, level in self._extra_log_defaults:
Anusha Raminenif3eb9472017-01-13 08:54:01 +05301426 logging.getLogger(name).logger.setLevel(level)
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001427
Sean Dague86bd8422013-12-20 09:56:44 -05001428 def __getattr__(self, attr):
1429 if not self._config:
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001430 self._fix_log_levels()
Matthew Treinishaa29c7e2015-04-23 16:35:09 -04001431 lock_dir = os.path.join(tempfile.gettempdir(), 'tempest-lock')
1432 lockutils.set_defaults(lock_dir)
Joe Gordon28a84ae2014-07-17 15:38:28 +00001433 self._config = TempestConfigPrivate(config_path=self._path)
Sean Dague86bd8422013-12-20 09:56:44 -05001434
Andrea Frittoli (andreaf)8420abe2016-07-27 11:47:43 +01001435 # Pushing tempest internal service client configuration to the
1436 # service clients register. Doing this in the config module ensures
1437 # that the configuration is available by the time we register the
1438 # service clients.
1439 # NOTE(andreaf) This has to be done at the time the first
1440 # attribute is accessed, to ensure all plugins have been already
1441 # loaded, options registered, and _config is set.
1442 _register_tempest_service_clients()
1443
Andrea Frittoli8b23c792017-03-09 13:17:01 +00001444 # Registering service clients and pushing their configuration to
1445 # the service clients register. Doing this in the config module
1446 # ensures that the configuration is available by the time we
1447 # discover tests from plugins.
1448 plugins.TempestTestPluginManager()._register_service_clients()
1449
Sean Dague86bd8422013-12-20 09:56:44 -05001450 return getattr(self._config, attr)
1451
Joe Gordon28a84ae2014-07-17 15:38:28 +00001452 def set_config_path(self, path):
1453 self._path = path
Masayuki Igawa79159f82018-07-27 15:00:37 +09001454 # FIXME(masayukig): bug#1783751 To pass the config file path to child
1455 # processes, we need to set the environment variables here as a
1456 # workaround.
1457 os.environ['TEMPEST_CONFIG_DIR'] = os.path.dirname(path)
1458 os.environ['TEMPEST_CONFIG'] = os.path.basename(path)
Joe Gordon28a84ae2014-07-17 15:38:28 +00001459
Sean Dague86bd8422013-12-20 09:56:44 -05001460
1461CONF = TempestConfigProxy()
Matthew Treinishca5a9ff2016-04-16 15:04:34 -04001462
1463
Andrea Frittoli (andreaf)de5fb0c2016-06-13 12:15:00 +01001464def service_client_config(service_client_name=None):
1465 """Return a dict with the parameters to init service clients
1466
1467 Extracts from CONF the settings specific to the service_client_name and
1468 api_version, and formats them as dict ready to be passed to the service
1469 clients __init__:
1470
1471 * `region` (default to identity)
1472 * `catalog_type`
1473 * `endpoint_type`
1474 * `build_timeout` (object-storage and identity default to compute)
1475 * `build_interval` (object-storage and identity default to compute)
1476
1477 The following common settings are always returned, even if
1478 `service_client_name` is None:
1479
1480 * `disable_ssl_certificate_validation`
1481 * `ca_certs`
1482 * `trace_requests`
zhufl071e94c2016-07-12 10:26:34 +08001483 * `http_timeout`
Matthew Treinish74514402016-09-01 11:44:57 -04001484 * `proxy_url`
Andrea Frittoli (andreaf)de5fb0c2016-06-13 12:15:00 +01001485
1486 The dict returned by this does not fit a few service clients:
1487
1488 * The endpoint type is not returned for identity client, since it takes
1489 three different values for v2 admin, v2 public and v3
1490 * The `ServersClient` from compute accepts an optional
1491 `enable_instance_password` parameter, which is not returned.
1492 * The `VolumesClient` for both v1 and v2 volume accept an optional
1493 `default_volume_size` parameter, which is not returned.
1494 * The `TokenClient` and `V3TokenClient` have a very different
1495 interface, only auth_url is needed for them.
1496
1497 :param service_client_name: str Name of the service. Supported values are
1498 'compute', 'identity', 'image', 'network', 'object-storage', 'volume'
1499 :return: dictionary of __init__ parameters for the service clients
1500 :rtype: dict
1501 """
1502 _parameters = {
1503 'disable_ssl_certificate_validation':
Daniel Melladocad3f3d2016-08-19 14:17:16 +00001504 CONF.identity.disable_ssl_certificate_validation,
1505 'ca_certs': CONF.identity.ca_certificates_file,
zhufl071e94c2016-07-12 10:26:34 +08001506 'trace_requests': CONF.debug.trace_requests,
Matthew Treinish74514402016-09-01 11:44:57 -04001507 'http_timeout': CONF.service_clients.http_timeout,
1508 'proxy_url': CONF.service_clients.proxy_url,
Andrea Frittoli (andreaf)de5fb0c2016-06-13 12:15:00 +01001509 }
1510
1511 if service_client_name is None:
1512 return _parameters
1513
1514 # Get the group of options first, by normalising the service_group_name
1515 # Services with a '-' in the name have an '_' in the option group name
1516 config_group = service_client_name.replace('-', '_')
1517 # NOTE(andreaf) Check if the config group exists. This allows for this
1518 # helper to be used for settings from registered plugins as well
1519 try:
1520 options = getattr(CONF, config_group)
1521 except cfg.NoSuchOptError:
1522 # Option group not defined
1523 raise exceptions.UnknownServiceClient(services=service_client_name)
1524 # Set endpoint_type
1525 # Identity uses different settings depending on API version, so do not
1526 # return the endpoint at all.
1527 if service_client_name != 'identity':
1528 _parameters['endpoint_type'] = getattr(options, 'endpoint_type')
1529 # Set build_*
1530 # Object storage and identity groups do not have conf settings for
1531 # build_* parameters, and we default to compute in any case
1532 for setting in ['build_timeout', 'build_interval']:
1533 if not hasattr(options, setting) or not getattr(options, setting):
1534 _parameters[setting] = getattr(CONF.compute, setting)
1535 else:
1536 _parameters[setting] = getattr(options, setting)
1537 # Set region
1538 # If a service client does not define region or region is not set
1539 # default to the identity region
1540 if not hasattr(options, 'region') or not getattr(options, 'region'):
1541 _parameters['region'] = CONF.identity.region
1542 else:
1543 _parameters['region'] = getattr(options, 'region')
1544 # Set service
1545 _parameters['service'] = getattr(options, 'catalog_type')
1546 return _parameters
Andrea Frittoli (andreaf)8420abe2016-07-27 11:47:43 +01001547
1548
1549def _register_tempest_service_clients():
1550 # Register tempest own service clients using the same mechanism used
1551 # for external plugins.
1552 # The configuration data is pushed to the registry so that automatic
1553 # configuration of tempest own service clients is possible both for
1554 # tempest as well as for the plugins.
1555 service_clients = clients.tempest_modules()
1556 registry = clients.ClientsRegistry()
1557 all_clients = []
1558 for service_client in service_clients:
1559 module = service_clients[service_client]
1560 configs = service_client.split('.')[0]
1561 service_client_data = dict(
Andrea Frittoli986407d2017-10-11 10:23:17 +00001562 name=service_client.replace('.', '_').replace('-', '_'),
Andrea Frittoli (andreaf)8420abe2016-07-27 11:47:43 +01001563 service_version=service_client,
1564 module_path=module.__name__,
1565 client_names=module.__all__,
1566 **service_client_config(configs)
1567 )
1568 all_clients.append(service_client_data)
1569 # NOTE(andreaf) Internal service clients do not actually belong
1570 # to a plugin, so using '__tempest__' to indicate a virtual plugin
1571 # which holds internal service clients.
1572 registry.register_service_client('__tempest__', all_clients)