blob: eaf7b44821a237962a631a19896d1590805abe1b [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
Dirk Muellere746fc22013-06-29 16:29:29 +020016from __future__ import print_function
17
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +090018import logging as std_logging
Jay Pipes7f757632011-12-02 15:53:32 -050019import os
Jay Pipes3f981df2012-03-27 18:59:44 -040020
Doug Hellmann583ce2c2015-03-11 14:55:46 +000021from oslo_config import cfg
Matthew Treinish90aedd12013-02-25 17:56:49 -050022
Doug Hellmann583ce2c2015-03-11 14:55:46 +000023from oslo_log import log as logging
Jay Pipes7f757632011-12-02 15:53:32 -050024
Matthew Treinisha966d0f2015-07-01 17:37:31 -040025from tempest.test_discover import plugins
26
Daryl Walleck1465d612011-11-02 02:22:15 -050027
Maru Newbyf440c292015-03-31 15:58:47 +000028# TODO(marun) Replace use of oslo_config's global ConfigOpts
29# (cfg.CONF) instance with a local instance (cfg.ConfigOpts()) once
30# the cli tests move to the clients. The cli tests rely on oslo
31# incubator modules that use the global cfg.CONF.
32_CONF = cfg.CONF
33
34
DennyZhang88a2dd82013-10-07 12:55:35 -050035def register_opt_group(conf, opt_group, options):
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +010036 if opt_group:
37 conf.register_group(opt_group)
DennyZhang88a2dd82013-10-07 12:55:35 -050038 for opt in options:
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +010039 conf.register_opt(opt, group=getattr(opt_group, 'name', None))
DennyZhang88a2dd82013-10-07 12:55:35 -050040
41
Matthew Treinishc791ac42014-07-16 09:15:23 -040042auth_group = cfg.OptGroup(name='auth',
43 title="Options for authentication and credentials")
44
45
46AuthGroup = [
47 cfg.StrOpt('test_accounts_file',
Matthew Treinishc791ac42014-07-16 09:15:23 -040048 help="Path to the yaml file that contains the list of "
Matthew Treinishfc7cd8f2015-03-30 11:51:55 -040049 "credentials to use for running tests. If used when "
50 "running in parallel you have to make sure sufficient "
51 "credentials are provided in the accounts file. For "
52 "example if no tests with roles are being run it requires "
53 "at least `2 * CONC` distinct accounts configured in "
54 " the `test_accounts_file`, with CONC == the "
55 "number of concurrent test processes."),
Andrea Frittoli8283b4e2014-07-17 13:28:58 +010056 cfg.BoolOpt('allow_tenant_isolation',
Attila Fazekas5dda1582015-02-18 17:16:02 +010057 default=True,
Andrea Frittoli8283b4e2014-07-17 13:28:58 +010058 help="Allows test cases to create/destroy tenants and "
59 "users. This option requires that OpenStack Identity "
60 "API admin credentials are known. If false, isolated "
61 "test cases and parallel execution, can still be "
62 "achieved configuring a list of test accounts",
63 deprecated_opts=[cfg.DeprecatedOpt('allow_tenant_isolation',
64 group='compute'),
65 cfg.DeprecatedOpt('allow_tenant_isolation',
66 group='orchestration')]),
Matthew Treinish167b2be2015-01-15 17:20:27 -050067 cfg.ListOpt('tempest_roles',
68 help="Roles to assign to all users created by tempest",
Andrea Frittolic3280152015-02-26 12:42:34 +000069 default=[]),
David Kranz87fc7e92015-07-28 14:05:20 -040070 cfg.StrOpt('default_credentials_domain_name',
71 default='Default',
72 help="Default domain used when getting v3 credentials. "
73 "This is the name keystone uses for v2 compatibility.",
74 deprecated_opts=[cfg.DeprecatedOpt(
75 'tenant_isolation_domain_name',
76 group='auth')]),
Matthew Treinish2219d382015-04-24 10:33:04 -040077 cfg.BoolOpt('create_isolated_networks',
78 default=True,
79 help="If allow_tenant_isolation is set to True and Neutron is "
Castulo J. Martinez7964b332015-08-26 12:29:43 -070080 "enabled Tempest will try to create a usable network, "
Matthew Treinish2219d382015-04-24 10:33:04 -040081 "subnet, and router when needed for each tenant it "
82 "creates. However in some neutron configurations, like "
83 "with VLAN provider networks, this doesn't work. So if "
84 "set to False the isolated networks will not be created"),
Matthew Treinishc791ac42014-07-16 09:15:23 -040085]
86
Matthew Treinish39e48ef2012-12-21 13:36:15 -050087identity_group = cfg.OptGroup(name='identity',
88 title="Keystone Configuration Options")
Daryl Walleck1465d612011-11-02 02:22:15 -050089
Matthew Treinish39e48ef2012-12-21 13:36:15 -050090IdentityGroup = [
91 cfg.StrOpt('catalog_type',
92 default='identity',
93 help="Catalog type of the Identity service."),
Jay Pipescd8eaec2013-01-16 21:03:48 -050094 cfg.BoolOpt('disable_ssl_certificate_validation',
95 default=False,
96 help="Set to True if using self-signed SSL certificates."),
Rob Crittendena7db6692014-11-23 18:44:38 -050097 cfg.StrOpt('ca_certificates_file',
98 default=None,
99 help='Specify a CA bundle file to use in verifying a '
100 'TLS (https) server certificate.'),
Jay Pipes7c88eb22013-01-16 21:32:43 -0500101 cfg.StrOpt('uri',
Brant Knudsonc7ca3342013-03-28 21:08:50 -0500102 help="Full URI of the OpenStack Identity API (Keystone), v2"),
103 cfg.StrOpt('uri_v3',
104 help='Full URI of the OpenStack Identity API (Keystone), v3'),
Andrea Frittoli8bbdb162014-01-06 11:06:13 +0000105 cfg.StrOpt('auth_version',
106 default='v2',
107 help="Identity API version to be used for authentication "
Andrea Frittoli77f9da42014-02-06 11:18:19 +0000108 "for API tests."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500109 cfg.StrOpt('region',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100110 default='RegionOne',
Arata Notsu8f440392013-09-13 16:14:20 +0900111 help="The identity region name to use. Also used as the other "
112 "services' region name unless they are set explicitly. "
113 "If no such region is found in the service catalog, the "
114 "first found one is used."),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300115 cfg.StrOpt('v2_admin_endpoint_type',
116 default='adminURL',
117 choices=['public', 'admin', 'internal',
118 'publicURL', 'adminURL', 'internalURL'],
119 help="The admin endpoint type to use for OpenStack Identity "
ghanshyamf58b9fd2015-09-01 16:11:39 +0900120 "(Keystone) API v2"),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300121 cfg.StrOpt('v2_public_endpoint_type',
JordanP5d29b2c2013-12-18 13:56:03 +0000122 default='publicURL',
123 choices=['public', 'admin', 'internal',
124 'publicURL', 'adminURL', 'internalURL'],
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300125 help="The public endpoint type to use for OpenStack Identity "
126 "(Keystone) API v2",
127 deprecated_opts=[cfg.DeprecatedOpt('endpoint_type',
128 group='identity')]),
129 cfg.StrOpt('v3_endpoint_type',
130 default='adminURL',
131 choices=['public', 'admin', 'internal',
132 'publicURL', 'adminURL', 'internalURL'],
133 help="The endpoint type to use for OpenStack Identity "
ghanshyamf58b9fd2015-09-01 16:11:39 +0900134 "(Keystone) API v3"),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100135 cfg.StrOpt('username',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100136 help="Username to use for Nova API requests."),
137 cfg.StrOpt('tenant_name',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100138 help="Tenant name to use for Nova API requests."),
Russell Sim7f894a52013-09-13 10:35:21 +1000139 cfg.StrOpt('admin_role',
140 default='admin',
141 help="Role required to administrate keystone."),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100142 cfg.StrOpt('password',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100143 help="API key to use when authenticating.",
144 secret=True),
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100145 cfg.StrOpt('domain_name',
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100146 help="Domain name for authentication (Keystone V3)."
147 "The same domain applies to user and project"),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100148 cfg.StrOpt('alt_username',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100149 help="Username of alternate user to use for Nova API "
150 "requests."),
151 cfg.StrOpt('alt_tenant_name',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100152 help="Alternate user's Tenant name to use for Nova API "
153 "requests."),
154 cfg.StrOpt('alt_password',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100155 help="API key to use when authenticating as alternate user.",
156 secret=True),
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100157 cfg.StrOpt('alt_domain_name',
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100158 help="Alternate domain name for authentication (Keystone V3)."
159 "The same domain applies to user and project"),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100160 cfg.StrOpt('admin_username',
Dirk Mueller14bd5622014-01-14 19:33:05 +0100161 help="Administrative Username to use for "
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100162 "Keystone API requests."),
163 cfg.StrOpt('admin_tenant_name',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100164 help="Administrative Tenant name to use for Keystone API "
165 "requests."),
166 cfg.StrOpt('admin_password',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100167 help="API key to use when authenticating as admin.",
168 secret=True),
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100169 cfg.StrOpt('admin_domain_name',
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100170 help="Admin domain name for authentication (Keystone V3)."
171 "The same domain applies to user and project"),
Martin Pavlasek4c3f2ab2014-04-15 17:15:15 +0200172 cfg.StrOpt('default_domain_id',
173 default='default',
174 help="ID of the default domain"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500175]
Jay Pipes3f981df2012-03-27 18:59:44 -0400176
Matthew Treinishd5021a72014-01-09 18:42:51 +0000177identity_feature_group = cfg.OptGroup(name='identity-feature-enabled',
178 title='Enabled Identity Features')
179
180IdentityFeatureGroup = [
181 cfg.BoolOpt('trust',
182 default=True,
183 help='Does the identity service have delegation and '
Matthew Treinishdb2c5972014-01-31 22:18:59 +0000184 'impersonation enabled'),
185 cfg.BoolOpt('api_v2',
186 default=True,
187 help='Is the v2 identity API enabled'),
188 cfg.BoolOpt('api_v3',
189 default=True,
190 help='Is the v3 identity API enabled'),
Matthew Treinishd5021a72014-01-09 18:42:51 +0000191]
192
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500193compute_group = cfg.OptGroup(name='compute',
194 title='Compute Service Options')
Rohit Karajgie1b050d2011-12-02 16:13:18 -0800195
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500196ComputeGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500197 cfg.StrOpt('image_ref',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400198 help="Valid primary image reference to be used in tests. "
199 "This is a required option"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500200 cfg.StrOpt('image_ref_alt',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400201 help="Valid secondary image reference to be used in tests. "
202 "This is a required option, but if only one image is "
203 "available duplicate the value of image_ref above"),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900204 cfg.StrOpt('flavor_ref',
205 default="1",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500206 help="Valid primary flavor to use in tests."),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900207 cfg.StrOpt('flavor_ref_alt',
208 default="2",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500209 help='Valid secondary flavor to be used in tests.'),
Maru Newbyaf292e82013-05-20 21:32:28 +0000210 cfg.StrOpt('image_ssh_user',
211 default="root",
212 help="User name used to authenticate to an instance."),
Ryan Hsucb2e1252013-09-03 21:44:49 -0700213 cfg.StrOpt('image_ssh_password',
214 default="password",
215 help="Password used to authenticate to an instance."),
Maru Newbyaf292e82013-05-20 21:32:28 +0000216 cfg.StrOpt('image_alt_ssh_user',
217 default="root",
218 help="User name used to authenticate to an instance using "
219 "the alternate image."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500220 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400221 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500222 help="Time in seconds between build status checks."),
223 cfg.IntOpt('build_timeout',
224 default=300,
Hugh Saunders5b139ad2014-12-15 09:08:41 +0000225 help="Timeout in seconds to wait for an instance to build. "
226 "Other services that do not define build_timeout will "
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200227 "inherit this value."),
David Kranz968f1b32015-06-18 16:58:18 -0400228 cfg.StrOpt('ssh_shell_prologue',
229 default="set -eu -o pipefail; PATH=$$PATH:/sbin;",
230 help="Shell fragments to use before executing a command "
231 "when sshing to a guest."),
Attila Fazekas423834d2014-03-14 17:33:13 +0100232 cfg.StrOpt('ssh_auth_method',
233 default='keypair',
234 help="Auth method used for authenticate to the instance. "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000235 "Valid choices are: keypair, configured, adminpass "
236 "and disabled. "
237 "Keypair: start the servers with a ssh keypair. "
238 "Configured: use the configured user and password. "
239 "Adminpass: use the injected adminPass. "
240 "Disabled: avoid using ssh when it is an option."),
Attila Fazekas423834d2014-03-14 17:33:13 +0100241 cfg.StrOpt('ssh_connect_method',
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000242 default='floating',
Attila Fazekas423834d2014-03-14 17:33:13 +0100243 help="How to connect to the instance? "
244 "fixed: using the first ip belongs the fixed network "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000245 "floating: creating and using a floating ip."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500246 cfg.StrOpt('ssh_user',
247 default='root',
248 help="User name used to authenticate to an instance."),
Nachi Ueno6d580be2013-07-24 10:58:11 -0700249 cfg.IntOpt('ping_timeout',
Darragh O'Reilly6b636672014-01-24 12:17:40 +0000250 default=120,
Nachi Ueno6d580be2013-07-24 10:58:11 -0700251 help="Timeout in seconds to wait for ping to "
252 "succeed."),
Richard Wintersf87059b2015-02-17 11:46:54 -0500253 cfg.IntOpt('ping_size',
254 default=56,
255 help="The packet size for ping packets originating "
256 "from remote linux hosts"),
257 cfg.IntOpt('ping_count',
258 default=1,
259 help="The number of ping packets originating from remote "
260 "linux hosts"),
Attila Fazekas0abbc952013-07-01 19:19:42 +0200261 cfg.IntOpt('ready_wait',
262 default=0,
DennyZhang8912d012013-09-25 18:08:34 -0500263 help="Additional wait time for clean state, when there is "
264 "no OS-EXT-STS extension available"),
Attila Fazekasb0661652013-05-08 13:01:36 +0200265 cfg.StrOpt('fixed_network_name',
Chris Hoge8f1401b2014-11-19 14:00:37 -0800266 help="Name of the fixed network that is visible to all test "
Matthew Treinish03feae02015-03-27 10:25:45 -0400267 "tenants. If multiple networks are available for a tenant"
268 " this is the network which will be used for creating "
269 "servers if tempest does not create a network or a "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000270 "network is not specified elsewhere. It may be used for "
271 "ssh validation only if floating IPs are disabled."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500272 cfg.StrOpt('network_for_ssh',
273 default='public',
Chris Hoge8f1401b2014-11-19 14:00:37 -0800274 help="Network used for SSH connections. Ignored if "
Matthew Treinishe5cca002015-05-11 15:36:50 -0400275 "use_floatingip_for_ssh=true or run_validation=false."),
fujioka yuuichia11994e2013-07-09 11:19:51 +0900276 cfg.BoolOpt('use_floatingip_for_ssh',
277 default=True,
Tushar Kalra95a482d2014-03-25 14:24:43 -0700278 help="Does SSH use Floating IPs?"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500279 cfg.StrOpt('catalog_type',
280 default='compute',
281 help="Catalog type of the Compute service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900282 cfg.StrOpt('region',
283 default='',
284 help="The compute region name to use. If empty, the value "
285 "of identity.region is used instead. If no such region "
286 "is found in the service catalog, the first found one is "
287 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000288 cfg.StrOpt('endpoint_type',
289 default='publicURL',
290 choices=['public', 'admin', 'internal',
291 'publicURL', 'adminURL', 'internalURL'],
292 help="The endpoint type to use for the compute service."),
Ryan Hsucb2e1252013-09-03 21:44:49 -0700293 cfg.StrOpt('volume_device_name',
294 default='vdb',
295 help="Expected device name when a volume is attached to "
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900296 "an instance"),
297 cfg.IntOpt('shelved_offload_time',
298 default=0,
299 help='Time in seconds before a shelved instance is eligible '
300 'for removing from a host. -1 never offload, 0 offload '
301 'when shelved. This time should be the same as the time '
302 'of nova.conf, and some tests will run for as long as the '
Ghanshyam06a5b4a2014-04-11 17:32:45 +0900303 'time.'),
304 cfg.StrOpt('floating_ip_range',
305 default='10.0.0.0/29',
306 help='Unallocated floating IP range, which will be used to '
Chris Hoge8f1401b2014-11-19 14:00:37 -0800307 'test the floating IP bulk feature for CRUD operation. '
308 'This block must not overlap an existing floating IP '
309 'pool.')
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500310]
Rohit Karajgie1b050d2011-12-02 16:13:18 -0800311
Matthew Treinishd5c96022013-10-17 21:51:23 +0000312compute_features_group = cfg.OptGroup(name='compute-feature-enabled',
313 title="Enabled Compute Service Features")
314
315ComputeFeaturesGroup = [
316 cfg.BoolOpt('disk_config',
317 default=True,
318 help="If false, skip disk config tests"),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000319 cfg.ListOpt('api_extensions',
320 default=['all'],
Zhi Kun Liude25c022014-02-14 13:25:19 +0800321 help='A list of enabled compute extensions with a special '
Ken'ichi Ohmichia7e68712014-05-06 10:47:26 +0900322 'entry all which indicates every extension is enabled. '
Simeon Monov5d7effe2014-07-16 07:32:38 +0300323 'Each extension should be specified with alias name. '
324 'Empty list indicates all extensions are disabled'),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000325 cfg.BoolOpt('change_password',
326 default=False,
327 help="Does the test environment support changing the admin "
328 "password?"),
Adam Gandelmanc6eefb42014-07-15 16:44:08 -0700329 cfg.BoolOpt('console_output',
330 default=True,
331 help="Does the test environment support obtaining instance "
332 "serial console output?"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000333 cfg.BoolOpt('resize',
334 default=False,
335 help="Does the test environment support resizing?"),
Eric Windischb5538072014-03-09 23:47:35 -0400336 cfg.BoolOpt('pause',
337 default=True,
338 help="Does the test environment support pausing?"),
David Shrewsbury25f666f2014-07-22 12:17:59 -0400339 cfg.BoolOpt('shelve',
340 default=True,
341 help="Does the test environment support shelving/unshelving?"),
Eric Windischaeb7e842014-03-10 01:10:50 -0400342 cfg.BoolOpt('suspend',
343 default=True,
344 help="Does the test environment support suspend/resume?"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000345 cfg.BoolOpt('live_migration',
Joe Gordon31a139a2014-11-17 16:39:04 -0800346 default=True,
Matthew Treinishd5c96022013-10-17 21:51:23 +0000347 help="Does the test environment support live migration "
348 "available?"),
YAMAMOTO Takashi1f62af22015-06-16 03:29:50 +0900349 cfg.BoolOpt('metadata_service',
350 default=True,
351 help="Does the test environment support metadata service? "
352 "Ignored unless validation.run_validation=true."),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000353 cfg.BoolOpt('block_migration_for_live_migration',
354 default=False,
355 help="Does the test environment use block devices for live "
356 "migration"),
357 cfg.BoolOpt('block_migrate_cinder_iscsi',
358 default=False,
359 help="Does the test environment block migration support "
Joe Gordon0a5788f2015-03-17 11:29:38 -0700360 "cinder iSCSI volumes. Note, libvirt doesn't support this, "
361 "see https://bugs.launchpad.net/nova/+bug/1398999"),
Matt Riedemannbb9f7042015-03-03 08:53:11 -0800362 # TODO(gilliard): Remove live_migrate_paused_instances at juno-eol.
363 cfg.BoolOpt('live_migrate_paused_instances',
364 default=False,
365 help="Does the test system allow live-migration of paused "
366 "instances? Note, this is more than just the ANDing of "
367 "paused and live_migrate, but all 3 should be set to True "
368 "to run those tests"),
Ghanshyam Mann41c17572014-02-27 18:52:56 +0900369 cfg.BoolOpt('vnc_console',
370 default=False,
371 help='Enable VNC console. This configuration value should '
Ghanshyam70876d02014-03-11 11:40:18 +0900372 'be same as [nova.vnc]->vnc_enabled in nova.conf'),
373 cfg.BoolOpt('spice_console',
374 default=False,
375 help='Enable Spice console. This configuration value should '
376 'be same as [nova.spice]->enabled in nova.conf'),
377 cfg.BoolOpt('rdp_console',
378 default=False,
379 help='Enable RDP console. This configuration value should '
Adam Gandelman2e37b4f2014-06-18 17:34:21 -0700380 'be same as [nova.rdp]->enabled in nova.conf'),
381 cfg.BoolOpt('rescue',
382 default=True,
383 help='Does the test environment support instance rescue '
Ghanshyam9c2e50d2014-07-22 21:32:05 +0900384 'mode?'),
385 cfg.BoolOpt('enable_instance_password',
386 default=True,
387 help='Enables returning of the instance password by the '
388 'relevant server API calls such as create, rebuild '
Adam Gandelman7186f7a2014-07-23 09:28:56 -0400389 'or rescue.'),
390 cfg.BoolOpt('interface_attach',
391 default=True,
392 help='Does the test environment support dynamic network '
Adam Gandelmanfbc95ac2014-06-19 17:33:43 -0700393 'interface attachment?'),
394 cfg.BoolOpt('snapshot',
395 default=True,
396 help='Does the test environment support creating snapshot '
Matthew Treinishdfd7ac02015-02-09 17:47:31 -0500397 'images of running instances?'),
398 cfg.BoolOpt('ec2_api',
399 default=True,
Matt Riedemann17940732015-03-13 14:18:19 +0000400 help='Does the test environment have the ec2 api running?'),
401 # TODO(mriedem): Remove preserve_ports once juno-eol happens.
402 cfg.BoolOpt('preserve_ports',
403 default=False,
404 help='Does Nova preserve preexisting ports from Neutron '
405 'when deleting an instance? This should be set to True '
Matt Riedemann79b3b492015-06-20 14:20:44 -0700406 'if testing Kilo+ Nova.'),
407 cfg.BoolOpt('attach_encrypted_volume',
408 default=True,
409 help='Does the test environment support attaching an '
410 'encrypted volume to a running server instance? This may '
411 'depend on the combination of compute_driver in nova and '
412 'the volume_driver(s) in cinder.'),
Matt Riedemann778b5f92015-03-11 12:44:28 -0700413 # TODO(mriedem): Remove allow_duplicate_networks once kilo-eol happens
414 # since the option was removed from nova in Liberty and is the default
415 # behavior starting in Liberty.
416 cfg.BoolOpt('allow_duplicate_networks',
417 default=False,
418 help='Does the test environment support creating instances '
419 'with multiple ports on the same network? This is only '
420 'valid when using Neutron.'),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000421]
422
423
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500424image_group = cfg.OptGroup(name='image',
425 title="Image Service Options")
Jay Pipesf38eaac2012-06-21 13:37:35 -0400426
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500427ImageGroup = [
Matthew Treinish72ea4422013-02-07 14:42:49 -0500428 cfg.StrOpt('catalog_type',
429 default='image',
Sean Dague83401992013-05-06 17:46:36 -0400430 help='Catalog type of the Image service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900431 cfg.StrOpt('region',
432 default='',
433 help="The image region name to use. If empty, the value "
434 "of identity.region is used instead. If no such region "
435 "is found in the service catalog, the first found one is "
436 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000437 cfg.StrOpt('endpoint_type',
438 default='publicURL',
439 choices=['public', 'admin', 'internal',
440 'publicURL', 'adminURL', 'internalURL'],
441 help="The endpoint type to use for the image service."),
Sean Dague83401992013-05-06 17:46:36 -0400442 cfg.StrOpt('http_image',
443 default='http://download.cirros-cloud.net/0.3.1/'
444 'cirros-0.3.1-x86_64-uec.tar.gz',
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200445 help='http accessible image'),
446 cfg.IntOpt('build_timeout',
447 default=300,
448 help="Timeout in seconds to wait for an image to "
449 "become available."),
450 cfg.IntOpt('build_interval',
451 default=1,
452 help="Time in seconds between image operation status "
453 "checks.")
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500454]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400455
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000456image_feature_group = cfg.OptGroup(name='image-feature-enabled',
457 title='Enabled image service features')
458
459ImageFeaturesGroup = [
460 cfg.BoolOpt('api_v2',
461 default=True,
462 help="Is the v2 image API enabled"),
463 cfg.BoolOpt('api_v1',
464 default=True,
465 help="Is the v1 image API enabled"),
bkopilov81aaae72015-05-15 23:46:25 +0300466 cfg.BoolOpt('deactivate_image',
467 default=False,
468 help="Is the deactivate-image feature enabled."
469 " The feature has been integrated since Kilo."),
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000470]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400471
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500472network_group = cfg.OptGroup(name='network',
473 title='Network Service Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600474
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500475NetworkGroup = [
476 cfg.StrOpt('catalog_type',
477 default='network',
Mark McClainf2982e82013-07-06 17:48:03 -0400478 help='Catalog type of the Neutron service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900479 cfg.StrOpt('region',
480 default='',
481 help="The network region name to use. If empty, the value "
482 "of identity.region is used instead. If no such region "
483 "is found in the service catalog, the first found one is "
484 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000485 cfg.StrOpt('endpoint_type',
486 default='publicURL',
487 choices=['public', 'admin', 'internal',
488 'publicURL', 'adminURL', 'internalURL'],
489 help="The endpoint type to use for the network service."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500490 cfg.StrOpt('tenant_network_cidr',
491 default="10.100.0.0/16",
Henry Gessauffda37a2014-01-16 11:17:55 -0500492 help="The cidr block to allocate tenant ipv4 subnets from"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500493 cfg.IntOpt('tenant_network_mask_bits',
Attila Fazekas8ea181b2013-07-13 16:26:14 +0200494 default=28,
Henry Gessauffda37a2014-01-16 11:17:55 -0500495 help="The mask bits for tenant ipv4 subnets"),
496 cfg.StrOpt('tenant_network_v6_cidr',
Sergey Shnaidman1f3659a2014-08-27 18:26:42 +0400497 default="2003::/48",
Henry Gessauffda37a2014-01-16 11:17:55 -0500498 help="The cidr block to allocate tenant ipv6 subnets from"),
499 cfg.IntOpt('tenant_network_v6_mask_bits',
Sergey Shnaidman1f3659a2014-08-27 18:26:42 +0400500 default=64,
Henry Gessauffda37a2014-01-16 11:17:55 -0500501 help="The mask bits for tenant ipv6 subnets"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500502 cfg.BoolOpt('tenant_networks_reachable',
503 default=False,
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000504 help="Whether tenant networks can be reached directly from "
505 "the test client. This must be set to True when the "
506 "'fixed' ssh_connect_method is selected."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500507 cfg.StrOpt('public_network_id',
508 default="",
509 help="Id of the public network that provides external "
510 "connectivity"),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000511 cfg.StrOpt('floating_network_name',
512 help="Default floating network name. Used to allocate floating "
513 "IPs when neutron is enabled."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500514 cfg.StrOpt('public_router_id',
515 default="",
516 help="Id of the public router that provides external "
Yair Fried1eb27f52014-11-10 15:24:19 +0200517 "connectivity. This should only be used when Neutron's "
518 "'allow_overlapping_ips' is set to 'False' in "
519 "neutron.conf. usually not needed past 'Grizzly' release"),
izikpensod9a01a62014-02-17 20:02:32 +0200520 cfg.IntOpt('build_timeout',
521 default=300,
522 help="Timeout in seconds to wait for network operation to "
523 "complete."),
524 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400525 default=1,
izikpensod9a01a62014-02-17 20:02:32 +0200526 help="Time in seconds between network operation status "
527 "checks."),
Attila Fazekas640392b2014-06-12 15:58:10 +0200528 cfg.ListOpt('dns_servers',
529 default=["8.8.8.8", "8.8.4.4"],
Itzik Brown5be44582014-12-24 09:05:13 +0200530 help="List of dns servers which should be used"
Itzik Brown2ca01cd2014-12-08 12:58:20 +0200531 " for subnet creation"),
532 cfg.StrOpt('port_vnic_type',
533 choices=[None, 'normal', 'direct', 'macvtap'],
534 help="vnic_type to use when Launching instances"
535 " with pre-configured ports."
536 " Supported ports are:"
537 " ['normal','direct','macvtap']"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500538]
Jay Pipes3f981df2012-03-27 18:59:44 -0400539
Matthew Treinishe3d26142013-11-26 19:14:58 +0000540network_feature_group = cfg.OptGroup(name='network-feature-enabled',
541 title='Enabled network service features')
542
543NetworkFeaturesGroup = [
Matthew Treinishe2e33cf2014-03-03 19:28:41 +0000544 cfg.BoolOpt('ipv6',
545 default=True,
546 help="Allow the execution of IPv6 tests"),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000547 cfg.ListOpt('api_extensions',
548 default=['all'],
Alexander Gubanov36e1f9b2015-06-12 18:02:10 +0300549 help="A list of enabled network extensions with a special "
550 "entry all which indicates every extension is enabled. "
551 "Empty list indicates all extensions are disabled. "
552 "To get the list of extensions run: 'neutron ext-list'"),
Sean M. Collinsdd27a4d2014-05-13 10:33:15 -0400553 cfg.BoolOpt('ipv6_subnet_attributes',
554 default=False,
555 help="Allow the execution of IPv6 subnet tests that use "
556 "the extended IPv6 attributes ipv6_ra_mode "
557 "and ipv6_address_mode"
Mark McClain6e07c0d2014-10-10 11:25:03 -0400558 ),
Itzik Brownbeb30d32015-03-29 09:42:54 +0300559 cfg.BoolOpt('port_admin_state_change',
560 default=True,
561 help="Does the test environment support changing"
562 " port admin state"),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000563]
564
Victoria Martínez de la Cruz1173b6e2014-09-22 18:32:13 -0300565messaging_group = cfg.OptGroup(name='messaging',
566 title='Messaging Service')
Malini Kamalambal6e7b3b82014-02-06 06:49:04 -0500567
Victoria Martínez de la Cruz1173b6e2014-09-22 18:32:13 -0300568MessagingGroup = [
Malini Kamalambal6e7b3b82014-02-06 06:49:04 -0500569 cfg.StrOpt('catalog_type',
Victoria Martínez de la Cruz1173b6e2014-09-22 18:32:13 -0300570 default='messaging',
571 help='Catalog type of the Messaging service.'),
Jorge Chai83ba4ee2014-04-15 18:58:08 +0000572 cfg.IntOpt('max_queues_per_page',
573 default=20,
574 help='The maximum number of queue records per page when '
575 'listing queues'),
Malini Kamalambal7458b4b2014-05-29 11:47:28 -0400576 cfg.IntOpt('max_queue_metadata',
577 default=65536,
578 help='The maximum metadata size for a queue'),
579 cfg.IntOpt('max_messages_per_page',
580 default=20,
581 help='The maximum number of queue message per page when '
582 'listing (or) posting messages'),
583 cfg.IntOpt('max_message_size',
584 default=262144,
585 help='The maximum size of a message body'),
586 cfg.IntOpt('max_messages_per_claim',
587 default=20,
588 help='The maximum number of messages per claim'),
589 cfg.IntOpt('max_message_ttl',
590 default=1209600,
591 help='The maximum ttl for a message'),
592 cfg.IntOpt('max_claim_ttl',
593 default=43200,
594 help='The maximum ttl for a claim'),
595 cfg.IntOpt('max_claim_grace',
596 default=43200,
597 help='The maximum grace period for a claim'),
Malini Kamalambal6e7b3b82014-02-06 06:49:04 -0500598]
599
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000600validation_group = cfg.OptGroup(name='validation',
601 title='SSH Validation options')
602
603ValidationGroup = [
Matthew Treinishe5cca002015-05-11 15:36:50 -0400604 cfg.BoolOpt('run_validation',
605 default=False,
606 help='Enable ssh on created servers and creation of additional'
607 ' validation resources to enable remote access',
608 deprecated_opts=[cfg.DeprecatedOpt('run_ssh',
609 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000610 cfg.StrOpt('connect_method',
611 default='floating',
612 choices=['fixed', 'floating'],
613 help='Default IP type used for validation: '
614 '-fixed: uses the first IP belonging to the fixed network '
615 '-floating: creates and uses a floating IP'),
616 cfg.StrOpt('auth_method',
617 default='keypair',
618 choices=['keypair'],
619 help='Default authentication method to the instance. '
620 'Only ssh via keypair is supported for now. '
621 'Additional methods will be handled in a separate spec.'),
622 cfg.IntOpt('ip_version_for_ssh',
623 default=4,
nithya-ganesan67da2872015-02-08 23:13:48 +0000624 help='Default IP version for ssh connections.',
625 deprecated_opts=[cfg.DeprecatedOpt('ip_version_for_ssh',
626 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000627 cfg.IntOpt('ping_timeout',
628 default=120,
629 help='Timeout in seconds to wait for ping to succeed.'),
630 cfg.IntOpt('connect_timeout',
631 default=60,
632 help='Timeout in seconds to wait for the TCP connection to be '
nithya-ganesan67da2872015-02-08 23:13:48 +0000633 'successful.',
634 deprecated_opts=[cfg.DeprecatedOpt('ssh_channel_timeout',
635 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000636 cfg.IntOpt('ssh_timeout',
637 default=300,
nithya-ganesan67da2872015-02-08 23:13:48 +0000638 help='Timeout in seconds to wait for the ssh banner.',
639 deprecated_opts=[cfg.DeprecatedOpt('ssh_timeout',
640 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000641]
642
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500643volume_group = cfg.OptGroup(name='volume',
644 title='Block Storage Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600645
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500646VolumeGroup = [
647 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400648 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500649 help='Time in seconds between volume availability checks.'),
650 cfg.IntOpt('build_timeout',
651 default=300,
Eric Harney9b1f89c2014-10-14 14:40:19 -0400652 help='Timeout in seconds to wait for a volume to become '
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500653 'available.'),
654 cfg.StrOpt('catalog_type',
Matthew Treinisheb724512013-10-25 15:12:59 +0000655 default='volume',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500656 help="Catalog type of the Volume Service"),
Arata Notsu8f440392013-09-13 16:14:20 +0900657 cfg.StrOpt('region',
658 default='',
659 help="The volume region name to use. If empty, the value "
660 "of identity.region is used instead. If no such region "
661 "is found in the service catalog, the first found one is "
662 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000663 cfg.StrOpt('endpoint_type',
664 default='publicURL',
665 choices=['public', 'admin', 'internal',
666 'publicURL', 'adminURL', 'internalURL'],
667 help="The endpoint type to use for the volume service."),
Jérôme Gallard86551ce2013-03-08 11:41:26 +0100668 cfg.StrOpt('backend1_name',
Giulio Fidentef4fa8942013-05-28 18:48:03 +0200669 default='BACKEND_1',
Jérôme Gallard86551ce2013-03-08 11:41:26 +0100670 help="Name of the backend1 (must be declared in cinder.conf)"),
671 cfg.StrOpt('backend2_name',
Giulio Fidentef4fa8942013-05-28 18:48:03 +0200672 default='BACKEND_2',
Jérôme Gallard86551ce2013-03-08 11:41:26 +0100673 help="Name of the backend2 (must be declared in cinder.conf)"),
Adam Gandelman827ad332013-06-24 17:04:09 -0700674 cfg.StrOpt('storage_protocol',
675 default='iSCSI',
676 help='Backend protocol to target when creating volume types'),
677 cfg.StrOpt('vendor_name',
678 default='Open Source',
679 help='Backend vendor to target when creating volume types'),
Ryan Hsua67f4632013-08-29 16:03:06 -0700680 cfg.StrOpt('disk_format',
681 default='raw',
682 help='Disk format to use when copying a volume to image'),
Jerry Cai9733d0e2014-03-19 15:50:49 +0800683 cfg.IntOpt('volume_size',
684 default=1,
685 help='Default size in GB for volumes created by volumes tests'),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500686]
K Jonathan Harkerd6ba4b42012-12-18 13:50:47 -0800687
Matthew Treinishd5c96022013-10-17 21:51:23 +0000688volume_feature_group = cfg.OptGroup(name='volume-feature-enabled',
689 title='Enabled Cinder Features')
690
691VolumeFeaturesGroup = [
692 cfg.BoolOpt('multi_backend',
693 default=False,
Matthew Treinishe3d26142013-11-26 19:14:58 +0000694 help="Runs Cinder multi-backend test (requires 2 backends)"),
Giulio Fidente74b08ad2014-01-18 04:02:51 +0100695 cfg.BoolOpt('backup',
696 default=True,
697 help='Runs Cinder volumes backup test'),
JordanPbce55532014-03-19 12:10:32 +0100698 cfg.BoolOpt('snapshot',
699 default=True,
700 help='Runs Cinder volume snapshot test'),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000701 cfg.ListOpt('api_extensions',
702 default=['all'],
Zhi Kun Liude25c022014-02-14 13:25:19 +0800703 help='A list of enabled volume extensions with a special '
Simeon Monov5d7effe2014-07-16 07:32:38 +0300704 'entry all which indicates every extension is enabled. '
705 'Empty list indicates all extensions are disabled'),
Zhi Kun Liubb363a22013-11-28 18:47:39 +0800706 cfg.BoolOpt('api_v1',
707 default=True,
708 help="Is the v1 volume API enabled"),
Zhi Kun Liu8cc3c842014-01-07 10:44:34 +0800709 cfg.BoolOpt('api_v2',
710 default=True,
711 help="Is the v2 volume API enabled"),
bkopilov8a657ae2015-05-11 11:45:23 +0300712 cfg.BoolOpt('bootable',
713 default=False,
714 help='Update bootable status of a volume '
715 'Not implemented on icehouse ')
Matthew Treinishd5c96022013-10-17 21:51:23 +0000716]
717
Daryl Walleck587385b2012-03-03 13:00:26 -0600718
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500719object_storage_group = cfg.OptGroup(name='object-storage',
720 title='Object Storage Service Options')
Attila Fazekasa23f5002012-10-23 19:32:45 +0200721
DennyZhang1e71b612013-09-26 12:35:40 -0500722ObjectStoreGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500723 cfg.StrOpt('catalog_type',
724 default='object-store',
725 help="Catalog type of the Object-Storage service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900726 cfg.StrOpt('region',
727 default='',
728 help="The object-storage region name to use. If empty, the "
729 "value of identity.region is used instead. If no such "
730 "region is found in the service catalog, the first found "
731 "one is used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000732 cfg.StrOpt('endpoint_type',
733 default='publicURL',
734 choices=['public', 'admin', 'internal',
735 'publicURL', 'adminURL', 'internalURL'],
736 help="The endpoint type to use for the object-store service."),
Matthew Treinishf319a732013-10-24 21:39:24 +0000737 cfg.IntOpt('container_sync_timeout',
Daisuke Morita1ac3ee02014-08-25 12:59:18 +0900738 default=600,
Fabien Boucher2178d312013-12-31 15:38:57 +0100739 help="Number of seconds to time on waiting for a container "
nayna-patelb4989b32013-01-09 06:25:13 +0000740 "to container synchronization complete."),
Matthew Treinishf319a732013-10-24 21:39:24 +0000741 cfg.IntOpt('container_sync_interval',
nayna-patelb4989b32013-01-09 06:25:13 +0000742 default=5,
Fabien Boucher2178d312013-12-31 15:38:57 +0100743 help="Number of seconds to wait while looping to check the "
nayna-patelb4989b32013-01-09 06:25:13 +0000744 "status of a container to container synchronization"),
Matthew Treinish3fdb80c2013-08-15 11:13:19 -0400745 cfg.StrOpt('operator_role',
746 default='Member',
747 help="Role to add to users created for swift tests to "
748 "enable creating containers"),
Matthew Treinish998c91d2014-03-01 12:39:49 -0500749 cfg.StrOpt('reseller_admin_role',
750 default='ResellerAdmin',
751 help="User role that has reseller admin"),
Daisuke Morita1ac3ee02014-08-25 12:59:18 +0900752 cfg.StrOpt('realm_name',
753 default='realm1',
754 help="Name of sync realm. A sync realm is a set of clusters "
755 "that have agreed to allow container syncing with each "
756 "other. Set the same realm name as Swift's "
757 "container-sync-realms.conf"),
758 cfg.StrOpt('cluster_name',
759 default='name1',
760 help="One name of cluster which is set in the realm whose name "
761 "is set in 'realm_name' item in this file. Set the "
762 "same cluster name as Swift's container-sync-realms.conf"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500763]
Attila Fazekasa23f5002012-10-23 19:32:45 +0200764
Matthew Treinishd5c96022013-10-17 21:51:23 +0000765object_storage_feature_group = cfg.OptGroup(
766 name='object-storage-feature-enabled',
767 title='Enabled object-storage features')
768
769ObjectStoreFeaturesGroup = [
Matthew Treinish20345382013-12-13 17:04:23 +0000770 cfg.ListOpt('discoverable_apis',
771 default=['all'],
772 help="A list of the enabled optional discoverable apis. "
773 "A single entry, all, indicates that all of these "
774 "features are expected to be enabled"),
Daisuke Morita20a183f2014-08-25 14:43:36 +0900775 cfg.BoolOpt('container_sync',
776 default=True,
777 help="Execute (old style) container-sync tests"),
778 cfg.BoolOpt('object_versioning',
779 default=True,
780 help="Execute object-versioning tests"),
781 cfg.BoolOpt('discoverability',
782 default=True,
783 help="Execute discoverability tests"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000784]
785
Nikhil Manchandadd6886f2014-03-03 01:58:45 -0800786database_group = cfg.OptGroup(name='database',
787 title='Database Service Options')
788
789DatabaseGroup = [
790 cfg.StrOpt('catalog_type',
791 default='database',
792 help="Catalog type of the Database service."),
793 cfg.StrOpt('db_flavor_ref',
794 default="1",
795 help="Valid primary flavor to use in database tests."),
Peter Stachowski320f9c72014-04-21 16:13:23 -0400796 cfg.StrOpt('db_current_version',
797 default="v1.0",
798 help="Current database version to use in database tests."),
Nikhil Manchandadd6886f2014-03-03 01:58:45 -0800799]
Attila Fazekasa23f5002012-10-23 19:32:45 +0200800
Steve Bakerc60e4e32013-05-06 15:22:41 +1200801orchestration_group = cfg.OptGroup(name='orchestration',
802 title='Orchestration Service Options')
803
804OrchestrationGroup = [
805 cfg.StrOpt('catalog_type',
806 default='orchestration',
807 help="Catalog type of the Orchestration service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900808 cfg.StrOpt('region',
809 default='',
810 help="The orchestration region name to use. If empty, the "
811 "value of identity.region is used instead. If no such "
812 "region is found in the service catalog, the first found "
813 "one is used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000814 cfg.StrOpt('endpoint_type',
815 default='publicURL',
816 choices=['public', 'admin', 'internal',
817 'publicURL', 'adminURL', 'internalURL'],
818 help="The endpoint type to use for the orchestration service."),
Matthew Treinishdb9721d2015-03-18 14:21:28 -0400819 cfg.StrOpt('stack_owner_role', default='heat_stack_owner',
820 help='Role required for users to be able to manage stacks'),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200821 cfg.IntOpt('build_interval',
822 default=1,
823 help="Time in seconds between build status checks."),
824 cfg.IntOpt('build_timeout',
Matthew Treinisha2dfd492014-04-15 11:15:34 -0400825 default=1200,
Steve Bakerc60e4e32013-05-06 15:22:41 +1200826 help="Timeout in seconds to wait for a stack to build."),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200827 cfg.StrOpt('instance_type',
Steve Baker9e86b832013-05-22 15:40:28 +1200828 default='m1.micro',
Steve Bakerc60e4e32013-05-06 15:22:41 +1200829 help="Instance type for tests. Needs to be big enough for a "
830 "full OS plus the test workload"),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200831 cfg.StrOpt('keypair_name',
Steve Bakerc60e4e32013-05-06 15:22:41 +1200832 help="Name of existing keypair to launch servers with."),
Clint Byrum71f27632013-09-09 11:41:32 -0700833 cfg.IntOpt('max_template_size',
Joe Gordon0e51b222013-10-24 14:11:10 +0100834 default=524288,
Clint Byrum71f27632013-09-09 11:41:32 -0700835 help="Value must match heat configuration of the same name."),
Steven Hardyfdc6bd72014-03-21 16:56:04 +0000836 cfg.IntOpt('max_resources_per_stack',
837 default=1000,
838 help="Value must match heat configuration of the same name."),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200839]
840
841
Yassine Lamgarchalb158d412013-12-27 19:29:42 +0100842telemetry_group = cfg.OptGroup(name='telemetry',
843 title='Telemetry Service Options')
844
845TelemetryGroup = [
846 cfg.StrOpt('catalog_type',
847 default='metering',
848 help="Catalog type of the Telemetry service."),
JordanPfc62c902014-02-26 14:47:28 +0000849 cfg.StrOpt('endpoint_type',
850 default='publicURL',
851 choices=['public', 'admin', 'internal',
852 'publicURL', 'adminURL', 'internalURL'],
853 help="The endpoint type to use for the telemetry service."),
Vadim Rovachev7bcea352013-12-26 15:56:17 +0400854 cfg.BoolOpt('too_slow_to_test',
855 default=True,
856 help="This variable is used as flag to enable "
857 "notification tests")
Yassine Lamgarchalb158d412013-12-27 19:29:42 +0100858]
859
860
gordon chungee23ddb2015-02-11 20:05:07 -0500861telemetry_feature_group = cfg.OptGroup(name='telemetry-feature-enabled',
862 title='Enabled Ceilometer Features')
863
864TelemetryFeaturesGroup = [
865 cfg.BoolOpt('events',
866 default=False,
867 help="Runs Ceilometer event-related tests"),
868]
869
870
Julie Pichond1017642013-07-24 16:37:23 +0100871dashboard_group = cfg.OptGroup(name="dashboard",
872 title="Dashboard options")
873
874DashboardGroup = [
875 cfg.StrOpt('dashboard_url',
876 default='http://localhost/',
877 help="Where the dashboard can be found"),
878 cfg.StrOpt('login_url',
879 default='http://localhost/auth/login/',
Yaroslav Lobankov002bfab2015-08-19 14:45:02 +0300880 help="Login page for the dashboard",
881 deprecated_for_removal=True),
Julie Pichond1017642013-07-24 16:37:23 +0100882]
883
884
Sergey Lukjanovcec6c3f2013-12-10 12:38:21 +0400885data_processing_group = cfg.OptGroup(name="data_processing",
886 title="Data Processing options")
887
888DataProcessingGroup = [
889 cfg.StrOpt('catalog_type',
890 default='data_processing',
JordanPfc62c902014-02-26 14:47:28 +0000891 help="Catalog type of the data processing service."),
892 cfg.StrOpt('endpoint_type',
893 default='publicURL',
894 choices=['public', 'admin', 'internal',
895 'publicURL', 'adminURL', 'internalURL'],
896 help="The endpoint type to use for the data processing "
897 "service."),
Sergey Lukjanovcec6c3f2013-12-10 12:38:21 +0400898]
899
900
Luigi Toscano14d172d2015-01-23 16:37:47 +0100901data_processing_feature_group = cfg.OptGroup(
902 name="data_processing-feature-enabled",
903 title="Enabled Data Processing features")
904
905DataProcessingFeaturesGroup = [
906 cfg.ListOpt('plugins',
907 default=["vanilla", "hdp"],
908 help="List of enabled data processing plugins")
909]
910
911
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500912boto_group = cfg.OptGroup(name='boto',
913 title='EC2/S3 options')
DennyZhang1e71b612013-09-26 12:35:40 -0500914BotoGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500915 cfg.StrOpt('ec2_url',
916 default="http://localhost:8773/services/Cloud",
917 help="EC2 URL"),
918 cfg.StrOpt('s3_url',
919 default="http://localhost:8080",
920 help="S3 URL"),
921 cfg.StrOpt('aws_secret',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500922 help="AWS Secret Key",
923 secret=True),
924 cfg.StrOpt('aws_access',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500925 help="AWS Access Key"),
Attila Fazekas27dd92e2014-02-21 14:49:40 +0100926 cfg.StrOpt('aws_zone',
927 default="nova",
928 help="AWS Zone for EC2 tests"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500929 cfg.StrOpt('s3_materials_path',
930 default="/opt/stack/devstack/files/images/"
931 "s3-materials/cirros-0.3.0",
932 help="S3 Materials Path"),
933 cfg.StrOpt('ari_manifest',
934 default="cirros-0.3.0-x86_64-initrd.manifest.xml",
935 help="ARI Ramdisk Image manifest"),
936 cfg.StrOpt('ami_manifest',
937 default="cirros-0.3.0-x86_64-blank.img.manifest.xml",
938 help="AMI Machine Image manifest"),
939 cfg.StrOpt('aki_manifest',
940 default="cirros-0.3.0-x86_64-vmlinuz.manifest.xml",
941 help="AKI Kernel Image manifest"),
942 cfg.StrOpt('instance_type',
943 default="m1.tiny",
944 help="Instance type"),
945 cfg.IntOpt('http_socket_timeout',
946 default=3,
947 help="boto Http socket timeout"),
948 cfg.IntOpt('num_retries',
949 default=1,
950 help="boto num_retries on error"),
951 cfg.IntOpt('build_timeout',
952 default=60,
953 help="Status Change Timeout"),
954 cfg.IntOpt('build_interval',
955 default=1,
956 help="Status Change Test Interval"),
957]
Attila Fazekasf7f2d932012-12-13 09:14:38 +0100958
Matthew Treinish615ea6a2013-02-25 17:26:59 -0500959stress_group = cfg.OptGroup(name='stress', title='Stress Test Options')
960
961StressGroup = [
962 cfg.StrOpt('nova_logdir',
Matthew Treinish615ea6a2013-02-25 17:26:59 -0500963 help='Directory containing log files on the compute nodes'),
964 cfg.IntOpt('max_instances',
965 default=16,
966 help='Maximum number of instances to create during test.'),
967 cfg.StrOpt('controller',
David Kranzb9d97502013-05-01 15:55:04 -0400968 help='Controller host.'),
969 # new stress options
970 cfg.StrOpt('target_controller',
David Kranzb9d97502013-05-01 15:55:04 -0400971 help='Controller host.'),
972 cfg.StrOpt('target_ssh_user',
David Kranzb9d97502013-05-01 15:55:04 -0400973 help='ssh user.'),
974 cfg.StrOpt('target_private_key_path',
David Kranzb9d97502013-05-01 15:55:04 -0400975 help='Path to private key.'),
976 cfg.StrOpt('target_logfiles',
David Kranzb9d97502013-05-01 15:55:04 -0400977 help='regexp for list of log files.'),
Matthew Treinishf319a732013-10-24 21:39:24 +0000978 cfg.IntOpt('log_check_interval',
David Kranzb9d97502013-05-01 15:55:04 -0400979 default=60,
Marc Koderer32221b8e2013-08-23 13:57:50 +0200980 help='time (in seconds) between log file error checks.'),
Matthew Treinishf319a732013-10-24 21:39:24 +0000981 cfg.IntOpt('default_thread_number_per_action',
Marc Koderer32221b8e2013-08-23 13:57:50 +0200982 default=4,
Julien Leloup04d40f72014-01-28 11:17:18 +0100983 help='The number of threads created while stress test.'),
984 cfg.BoolOpt('leave_dirty_stack',
985 default=False,
986 help='Prevent the cleaning (tearDownClass()) between'
987 ' each stress test run if an exception occurs'
Julien Leloupa5ee5422014-02-13 14:29:02 +0100988 ' during this run.'),
989 cfg.BoolOpt('full_clean_stack',
990 default=False,
991 help='Allows a full cleaning process after a stress test.'
992 ' Caution : this cleanup will remove every objects of'
993 ' every tenant.')
Matthew Treinish615ea6a2013-02-25 17:26:59 -0500994]
995
996
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +0900997scenario_group = cfg.OptGroup(name='scenario', title='Scenario Test Options')
998
999ScenarioGroup = [
1000 cfg.StrOpt('img_dir',
1001 default='/opt/stack/new/devstack/files/images/'
1002 'cirros-0.3.1-x86_64-uec',
1003 help='Directory containing image files'),
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001004 cfg.StrOpt('img_file', deprecated_name='qcow2_img_file',
Masayuki Igawa4f71bf02014-02-21 14:02:29 +09001005 default='cirros-0.3.1-x86_64-disk.img',
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001006 help='Image file name'),
1007 cfg.StrOpt('img_disk_format',
1008 default='qcow2',
1009 help='Image disk format'),
1010 cfg.StrOpt('img_container_format',
1011 default='bare',
1012 help='Image container format'),
Evgeny Antyshev7ba0d5f2015-04-28 13:18:07 +00001013 cfg.DictOpt('img_properties', help='Glance image properties. '
1014 'Use for custom images which require them'),
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001015 cfg.StrOpt('ami_img_file',
1016 default='cirros-0.3.1-x86_64-blank.img',
1017 help='AMI image file name'),
1018 cfg.StrOpt('ari_img_file',
1019 default='cirros-0.3.1-x86_64-initrd',
1020 help='ARI image file name'),
1021 cfg.StrOpt('aki_img_file',
1022 default='cirros-0.3.1-x86_64-vmlinuz',
1023 help='AKI image file name'),
1024 cfg.StrOpt('ssh_user',
1025 default='cirros',
Joe Gordonb5e10cd2013-07-10 15:51:12 +00001026 help='ssh username for the image file'),
1027 cfg.IntOpt(
1028 'large_ops_number',
1029 default=0,
1030 help="specifies how many resources to request at once. Used "
Yair Fried413bf2d2014-11-19 17:07:11 +02001031 "for large operations testing."),
1032 # TODO(yfried): add support for dhcpcd
1033 cfg.StrOpt('dhcp_client',
1034 default='udhcpc',
1035 choices=["udhcpc", "dhclient"],
1036 help='DHCP client used by images to renew DCHP lease. '
1037 'If left empty, update operation will be skipped. '
1038 'Supported clients: "udhcpc", "dhclient"')
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001039]
1040
1041
Matthew Treinish4c412922013-07-16 15:27:42 -04001042service_available_group = cfg.OptGroup(name="service_available",
1043 title="Available OpenStack Services")
1044
1045ServiceAvailableGroup = [
1046 cfg.BoolOpt('cinder',
1047 default=True,
1048 help="Whether or not cinder is expected to be available"),
Matthew Treinishfaa340d2013-07-19 16:26:21 -04001049 cfg.BoolOpt('neutron',
1050 default=False,
1051 help="Whether or not neutron is expected to be available"),
Matthew Treinish853ae442013-07-19 16:36:07 -04001052 cfg.BoolOpt('glance',
1053 default=True,
1054 help="Whether or not glance is expected to be available"),
Matthew Treinish61e332b2013-07-19 16:42:31 -04001055 cfg.BoolOpt('swift',
1056 default=True,
1057 help="Whether or not swift is expected to be available"),
Matthew Treinish6b41e242013-07-19 16:49:28 -04001058 cfg.BoolOpt('nova',
1059 default=True,
1060 help="Whether or not nova is expected to be available"),
Matthew Treinisha9d43882013-07-19 16:54:52 -04001061 cfg.BoolOpt('heat',
1062 default=False,
1063 help="Whether or not Heat is expected to be available"),
Mehdi Abaakouk8581c0b2013-10-04 10:45:42 +02001064 cfg.BoolOpt('ceilometer',
1065 default=True,
1066 help="Whether or not Ceilometer is expected to be available"),
Julie Pichond1017642013-07-24 16:37:23 +01001067 cfg.BoolOpt('horizon',
1068 default=True,
1069 help="Whether or not Horizon is expected to be available"),
Sergey Lukjanov9c95a252014-03-13 23:59:22 +04001070 cfg.BoolOpt('sahara',
Sergey Lukjanovcec6c3f2013-12-10 12:38:21 +04001071 default=False,
Sergey Lukjanov9c95a252014-03-13 23:59:22 +04001072 help="Whether or not Sahara is expected to be available"),
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001073 cfg.BoolOpt('ironic',
1074 default=False,
1075 help="Whether or not Ironic is expected to be available"),
Nikhil Manchandadd6886f2014-03-03 01:58:45 -08001076 cfg.BoolOpt('trove',
1077 default=False,
1078 help="Whether or not Trove is expected to be available"),
Malini Kamalambal8681e922014-08-18 10:10:45 -04001079 cfg.BoolOpt('zaqar',
Malini Kamalambal6e7b3b82014-02-06 06:49:04 -05001080 default=False,
Malini Kamalambal8681e922014-08-18 10:10:45 -04001081 help="Whether or not Zaqar is expected to be available"),
Matthew Treinish4c412922013-07-16 15:27:42 -04001082]
1083
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001084debug_group = cfg.OptGroup(name="debug",
1085 title="Debug System")
1086
1087DebugGroup = [
Sean Daguec522c092014-03-24 10:43:22 -04001088 cfg.StrOpt('trace_requests',
1089 default='',
1090 help="""A regex to determine which requests should be traced.
1091
1092This is a regex to match the caller for rest client requests to be able to
1093selectively trace calls out of specific classes and methods. It largely
1094exists for test development, and is not expected to be used in a real deploy
1095of tempest. This will be matched against the discovered ClassName:method
1096in the test environment.
1097
1098Expected values for this field are:
1099
1100 * ClassName:test_method_name - traces one test_method
1101 * ClassName:setUp(Class) - traces specific setup functions
1102 * ClassName:tearDown(Class) - traces specific teardown functions
1103 * ClassName:_run_cleanups - traces the cleanup functions
1104
1105If nothing is specified, this feature is not enabled. To trace everything
1106specify .* as the regex.
1107""")
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001108]
1109
Andrea Frittolif5da28b2013-12-06 07:08:07 +00001110input_scenario_group = cfg.OptGroup(name="input-scenario",
1111 title="Filters and values for"
1112 " input scenarios")
1113
1114InputScenarioGroup = [
1115 cfg.StrOpt('image_regex',
1116 default='^cirros-0.3.1-x86_64-uec$',
1117 help="Matching images become parameters for scenario tests"),
1118 cfg.StrOpt('flavor_regex',
Andrea Frittoli99901c02014-01-30 18:06:49 +00001119 default='^m1.nano$',
Andrea Frittolif5da28b2013-12-06 07:08:07 +00001120 help="Matching flavors become parameters for scenario tests"),
1121 cfg.StrOpt('non_ssh_image_regex',
1122 default='^.*[Ww]in.*$',
1123 help="SSH verification in tests is skipped"
1124 "for matching images"),
1125 cfg.StrOpt('ssh_user_regex',
Marc Koderer07f5a522015-03-27 15:02:41 +01001126 default="[[\"^.*[Cc]irros.*$\", \"cirros\"]]",
Andrea Frittolif5da28b2013-12-06 07:08:07 +00001127 help="List of user mapped to regex "
1128 "to matching image names."),
1129]
1130
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001131
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001132baremetal_group = cfg.OptGroup(name='baremetal',
Chris Hoge8f1401b2014-11-19 14:00:37 -08001133 title='Baremetal provisioning service options',
1134 help='When enabling baremetal tests, Nova '
1135 'must be configured to use the Ironic '
1136 'driver. The following paremeters for the '
1137 '[compute] section must be disabled: '
1138 'console_output, interface_attach, '
1139 'live_migration, pause, rescue, resize '
1140 'shelve, snapshot, and suspend')
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001141
1142BaremetalGroup = [
1143 cfg.StrOpt('catalog_type',
1144 default='baremetal',
Adam Gandelman4a48a602014-03-20 18:23:18 -07001145 help="Catalog type of the baremetal provisioning service"),
1146 cfg.BoolOpt('driver_enabled',
1147 default=False,
1148 help="Whether the Ironic nova-compute driver is enabled"),
Yuiko Takada1ee1b322014-07-04 09:55:30 +09001149 cfg.StrOpt('driver',
1150 default='fake',
1151 help="Driver name which Ironic uses"),
JordanPfc62c902014-02-26 14:47:28 +00001152 cfg.StrOpt('endpoint_type',
1153 default='publicURL',
1154 choices=['public', 'admin', 'internal',
1155 'publicURL', 'adminURL', 'internalURL'],
1156 help="The endpoint type to use for the baremetal provisioning "
Adam Gandelman4a48a602014-03-20 18:23:18 -07001157 "service"),
1158 cfg.IntOpt('active_timeout',
1159 default=300,
1160 help="Timeout for Ironic node to completely provision"),
1161 cfg.IntOpt('association_timeout',
Adam Gandelmane42f0922014-06-10 15:26:37 -07001162 default=30,
Adam Gandelman4a48a602014-03-20 18:23:18 -07001163 help="Timeout for association of Nova instance and Ironic "
1164 "node"),
1165 cfg.IntOpt('power_timeout',
Adam Gandelmane42f0922014-06-10 15:26:37 -07001166 default=60,
Adam Gandelman4a48a602014-03-20 18:23:18 -07001167 help="Timeout for Ironic power transitions."),
1168 cfg.IntOpt('unprovision_timeout',
Devananda van der Veend1e52a92015-04-13 12:58:49 -07001169 default=300,
1170 help="Timeout for unprovisioning an Ironic node. "
1171 "Takes longer since Kilo as Ironic performs an extra "
1172 "step in Node cleaning.")
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001173]
1174
Marc Koderer6ee82dc2014-02-17 10:26:29 +01001175negative_group = cfg.OptGroup(name='negative', title="Negative Test Options")
1176
1177NegativeGroup = [
1178 cfg.StrOpt('test_generator',
1179 default='tempest.common.' +
1180 'generator.negative_generator.NegativeTestGenerator',
1181 help="Test generator class for all negative tests"),
1182]
1183
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001184DefaultGroup = [
1185 cfg.StrOpt('resources_prefix',
1186 default='tempest',
1187 help="Prefix to be added when generating the name for "
1188 "test resources. It can be used to discover all "
1189 "resources associated with a specific test run when "
1190 "running tempest on a real-life cloud"),
1191]
1192
Jon Grimm270bd7f2014-08-05 18:11:29 +00001193_opts = [
1194 (auth_group, AuthGroup),
1195 (compute_group, ComputeGroup),
1196 (compute_features_group, ComputeFeaturesGroup),
1197 (identity_group, IdentityGroup),
1198 (identity_feature_group, IdentityFeatureGroup),
1199 (image_group, ImageGroup),
1200 (image_feature_group, ImageFeaturesGroup),
1201 (network_group, NetworkGroup),
1202 (network_feature_group, NetworkFeaturesGroup),
1203 (messaging_group, MessagingGroup),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001204 (validation_group, ValidationGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001205 (volume_group, VolumeGroup),
1206 (volume_feature_group, VolumeFeaturesGroup),
1207 (object_storage_group, ObjectStoreGroup),
1208 (object_storage_feature_group, ObjectStoreFeaturesGroup),
1209 (database_group, DatabaseGroup),
1210 (orchestration_group, OrchestrationGroup),
1211 (telemetry_group, TelemetryGroup),
gordon chungee23ddb2015-02-11 20:05:07 -05001212 (telemetry_feature_group, TelemetryFeaturesGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001213 (dashboard_group, DashboardGroup),
1214 (data_processing_group, DataProcessingGroup),
Luigi Toscano14d172d2015-01-23 16:37:47 +01001215 (data_processing_feature_group, DataProcessingFeaturesGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001216 (boto_group, BotoGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001217 (stress_group, StressGroup),
1218 (scenario_group, ScenarioGroup),
1219 (service_available_group, ServiceAvailableGroup),
1220 (debug_group, DebugGroup),
1221 (baremetal_group, BaremetalGroup),
1222 (input_scenario_group, InputScenarioGroup),
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001223 (negative_group, NegativeGroup),
1224 (None, DefaultGroup)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001225]
1226
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001227
Matthew Treinish43b296a2014-02-28 15:23:00 -05001228def register_opts():
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001229 ext_plugins = plugins.TempestTestPluginManager()
1230 # Register in-tree tempest config options
Jon Grimm270bd7f2014-08-05 18:11:29 +00001231 for g, o in _opts:
Maru Newbyf440c292015-03-31 15:58:47 +00001232 register_opt_group(_CONF, g, o)
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001233 # Call external plugin config option registration
1234 ext_plugins.register_plugin_opts(_CONF)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001235
1236
1237def list_opts():
1238 """Return a list of oslo.config options available.
1239
1240 The purpose of this is to allow tools like the Oslo sample config file
1241 generator to discover the options exposed to users.
1242 """
Matthew Treinish83a19aa2015-07-23 13:06:13 -04001243 ext_plugins = plugins.TempestTestPluginManager()
1244 opt_list = [(getattr(g, 'name', None), o) for g, o in _opts]
1245 opt_list.extend(ext_plugins.get_plugin_options_list())
1246 return opt_list
Matthew Treinish43b296a2014-02-28 15:23:00 -05001247
1248
Sean Dague3b9b1f32013-12-20 17:04:54 -05001249# this should never be called outside of this class
1250class TempestConfigPrivate(object):
Daryl Walleck1465d612011-11-02 02:22:15 -05001251 """Provides OpenStack configuration information."""
1252
Brian Waldon738cd632011-12-12 18:45:09 -05001253 DEFAULT_CONFIG_DIR = os.path.join(
Zhongyue Luoa1343de2013-01-04 16:21:35 +08001254 os.path.abspath(os.path.dirname(os.path.dirname(__file__))),
Brian Waldon738cd632011-12-12 18:45:09 -05001255 "etc")
Daryl Walleck1465d612011-11-02 02:22:15 -05001256
Brian Waldon738cd632011-12-12 18:45:09 -05001257 DEFAULT_CONFIG_FILE = "tempest.conf"
1258
Andrea Frittolia96ee212014-08-15 18:34:20 +01001259 def __getattr__(self, attr):
1260 # Handles config options from the default group
Maru Newbyf440c292015-03-31 15:58:47 +00001261 return getattr(_CONF, attr)
Andrea Frittolia96ee212014-08-15 18:34:20 +01001262
Matthew Treinish43b296a2014-02-28 15:23:00 -05001263 def _set_attrs(self):
Maru Newbyf440c292015-03-31 15:58:47 +00001264 self.auth = _CONF.auth
1265 self.compute = _CONF.compute
1266 self.compute_feature_enabled = _CONF['compute-feature-enabled']
1267 self.identity = _CONF.identity
1268 self.identity_feature_enabled = _CONF['identity-feature-enabled']
1269 self.image = _CONF.image
1270 self.image_feature_enabled = _CONF['image-feature-enabled']
1271 self.network = _CONF.network
1272 self.network_feature_enabled = _CONF['network-feature-enabled']
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001273 self.validation = _CONF.validation
Maru Newbyf440c292015-03-31 15:58:47 +00001274 self.volume = _CONF.volume
1275 self.volume_feature_enabled = _CONF['volume-feature-enabled']
1276 self.object_storage = _CONF['object-storage']
1277 self.object_storage_feature_enabled = _CONF[
Matthew Treinishd5c96022013-10-17 21:51:23 +00001278 'object-storage-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001279 self.database = _CONF.database
1280 self.orchestration = _CONF.orchestration
1281 self.messaging = _CONF.messaging
1282 self.telemetry = _CONF.telemetry
gordon chungee23ddb2015-02-11 20:05:07 -05001283 self.telemetry_feature_enabled = _CONF['telemetry-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001284 self.dashboard = _CONF.dashboard
1285 self.data_processing = _CONF.data_processing
1286 self.data_processing_feature_enabled = _CONF[
Luigi Toscano14d172d2015-01-23 16:37:47 +01001287 'data_processing-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001288 self.boto = _CONF.boto
1289 self.stress = _CONF.stress
1290 self.scenario = _CONF.scenario
1291 self.service_available = _CONF.service_available
1292 self.debug = _CONF.debug
1293 self.baremetal = _CONF.baremetal
1294 self.input_scenario = _CONF['input-scenario']
Maru Newbyf440c292015-03-31 15:58:47 +00001295 self.negative = _CONF.negative
David Kranz87fc7e92015-07-28 14:05:20 -04001296 _CONF.set_default('domain_name',
1297 self.auth.default_credentials_domain_name,
Maru Newbyf440c292015-03-31 15:58:47 +00001298 group='identity')
David Kranz87fc7e92015-07-28 14:05:20 -04001299 _CONF.set_default('alt_domain_name',
1300 self.auth.default_credentials_domain_name,
Maru Newbyf440c292015-03-31 15:58:47 +00001301 group='identity')
Sean Dague86bd8422013-12-20 09:56:44 -05001302
Joe Gordon28a84ae2014-07-17 15:38:28 +00001303 def __init__(self, parse_conf=True, config_path=None):
Matthew Treinish43b296a2014-02-28 15:23:00 -05001304 """Initialize a configuration from a conf directory and conf file."""
1305 super(TempestConfigPrivate, self).__init__()
1306 config_files = []
1307 failsafe_path = "/etc/tempest/" + self.DEFAULT_CONFIG_FILE
1308
Joe Gordon28a84ae2014-07-17 15:38:28 +00001309 if config_path:
1310 path = config_path
1311 else:
1312 # Environment variables override defaults...
1313 conf_dir = os.environ.get('TEMPEST_CONFIG_DIR',
1314 self.DEFAULT_CONFIG_DIR)
1315 conf_file = os.environ.get('TEMPEST_CONFIG',
1316 self.DEFAULT_CONFIG_FILE)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001317
Joe Gordon28a84ae2014-07-17 15:38:28 +00001318 path = os.path.join(conf_dir, conf_file)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001319
1320 if not os.path.isfile(path):
1321 path = failsafe_path
1322
1323 # only parse the config file if we expect one to exist. This is needed
1324 # to remove an issue with the config file up to date checker.
1325 if parse_conf:
1326 config_files.append(path)
Maru Newbyf440c292015-03-31 15:58:47 +00001327 logging.register_options(_CONF)
Matthew Treinish5440a402014-10-02 14:36:16 -04001328 if os.path.isfile(path):
Maru Newbyf440c292015-03-31 15:58:47 +00001329 _CONF([], project='tempest', default_config_files=config_files)
Matthew Treinish5440a402014-10-02 14:36:16 -04001330 else:
Maru Newbyf440c292015-03-31 15:58:47 +00001331 _CONF([], project='tempest')
1332 logging.setup(_CONF, 'tempest')
Matthew Treinish43b296a2014-02-28 15:23:00 -05001333 LOG = logging.getLogger('tempest')
1334 LOG.info("Using tempest config file %s" % path)
1335 register_opts()
1336 self._set_attrs()
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001337 if parse_conf:
Maru Newbyf440c292015-03-31 15:58:47 +00001338 _CONF.log_opt_values(LOG, std_logging.DEBUG)
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001339
Sean Dague86bd8422013-12-20 09:56:44 -05001340
1341class TempestConfigProxy(object):
1342 _config = None
Joe Gordon28a84ae2014-07-17 15:38:28 +00001343 _path = None
Sean Dague86bd8422013-12-20 09:56:44 -05001344
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001345 _extra_log_defaults = [
Doug Hellmann583ce2c2015-03-11 14:55:46 +00001346 ('paramiko.transport', std_logging.INFO),
1347 ('requests.packages.urllib3.connectionpool', std_logging.WARN),
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001348 ]
1349
1350 def _fix_log_levels(self):
1351 """Tweak the oslo log defaults."""
Doug Hellmann583ce2c2015-03-11 14:55:46 +00001352 for name, level in self._extra_log_defaults:
1353 std_logging.getLogger(name).setLevel(level)
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001354
Sean Dague86bd8422013-12-20 09:56:44 -05001355 def __getattr__(self, attr):
1356 if not self._config:
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001357 self._fix_log_levels()
Joe Gordon28a84ae2014-07-17 15:38:28 +00001358 self._config = TempestConfigPrivate(config_path=self._path)
Sean Dague86bd8422013-12-20 09:56:44 -05001359
1360 return getattr(self._config, attr)
1361
Joe Gordon28a84ae2014-07-17 15:38:28 +00001362 def set_config_path(self, path):
1363 self._path = path
1364
Sean Dague86bd8422013-12-20 09:56:44 -05001365
1366CONF = TempestConfigProxy()