blob: 910f110b7ae6dbd99d5d9c5b6ac0168e57ab5f1e [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
Matthew Treinishaa29c7e2015-04-23 16:35:09 -040020import tempfile
Jay Pipes3f981df2012-03-27 18:59:44 -040021
Matthew Treinishaa29c7e2015-04-23 16:35:09 -040022from oslo_concurrency import lockutils
Doug Hellmann583ce2c2015-03-11 14:55:46 +000023from oslo_config import cfg
Doug Hellmann583ce2c2015-03-11 14:55:46 +000024from oslo_log import log as logging
Jay Pipes7f757632011-12-02 15:53:32 -050025
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 "
63 "achieved configuring a list of test accounts",
64 deprecated_opts=[cfg.DeprecatedOpt('allow_tenant_isolation',
Andrea Frittoli (andreaf)17209bb2015-05-22 10:16:57 -070065 group='auth'),
66 cfg.DeprecatedOpt('allow_tenant_isolation',
Andrea Frittoli8283b4e2014-07-17 13:28:58 +010067 group='compute'),
68 cfg.DeprecatedOpt('allow_tenant_isolation',
69 group='orchestration')]),
Matthew Treinish167b2be2015-01-15 17:20:27 -050070 cfg.ListOpt('tempest_roles',
71 help="Roles to assign to all users created by tempest",
Andrea Frittolic3280152015-02-26 12:42:34 +000072 default=[]),
David Kranz87fc7e92015-07-28 14:05:20 -040073 cfg.StrOpt('default_credentials_domain_name',
74 default='Default',
75 help="Default domain used when getting v3 credentials. "
76 "This is the name keystone uses for v2 compatibility.",
77 deprecated_opts=[cfg.DeprecatedOpt(
78 'tenant_isolation_domain_name',
79 group='auth')]),
Matthew Treinish2219d382015-04-24 10:33:04 -040080 cfg.BoolOpt('create_isolated_networks',
81 default=True,
Andrea Frittoli (andreaf)17209bb2015-05-22 10:16:57 -070082 help="If use_dynamic_credentials is set to True and Neutron "
83 "is enabled Tempest will try to create a usable network, "
Sean Dagueed6e5862016-04-04 10:49:13 -040084 "subnet, and router when needed for each project it "
Matthew Treinish2219d382015-04-24 10:33:04 -040085 "creates. However in some neutron configurations, like "
86 "with VLAN provider networks, this doesn't work. So if "
87 "set to False the isolated networks will not be created"),
Matthew Treinish16cf1e52015-08-11 10:39:23 -040088 cfg.StrOpt('admin_username',
89 help="Username for an administrative user. This is needed for "
Sean Dagueed6e5862016-04-04 10:49:13 -040090 "authenticating requests made by project isolation to "
Matthew Treinish16cf1e52015-08-11 10:39:23 -040091 "create users and projects",
92 deprecated_group='identity'),
Sean Dagueed6e5862016-04-04 10:49:13 -040093 cfg.StrOpt('admin_project_name',
94 help="Project name to use for an administrative user. This is "
95 "needed for authenticating requests made by project "
Matthew Treinish16cf1e52015-08-11 10:39:23 -040096 "isolation to create users and projects",
Sean Dagueed6e5862016-04-04 10:49:13 -040097 deprecated_opts=[cfg.DeprecatedOpt('admin_tenant_name',
98 group='auth'),
99 cfg.DeprecatedOpt('admin_tenant_name',
100 group='identity')]),
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400101 cfg.StrOpt('admin_password',
102 help="Password to use for an administrative user. This is "
Sean Dagueed6e5862016-04-04 10:49:13 -0400103 "needed for authenticating requests made by project "
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400104 "isolation to create users and projects",
105 secret=True,
106 deprecated_group='identity'),
107 cfg.StrOpt('admin_domain_name',
108 help="Admin domain name for authentication (Keystone V3)."
109 "The same domain applies to user and project",
110 deprecated_group='identity'),
Matthew Treinishc791ac42014-07-16 09:15:23 -0400111]
112
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500113identity_group = cfg.OptGroup(name='identity',
114 title="Keystone Configuration Options")
Daryl Walleck1465d612011-11-02 02:22:15 -0500115
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500116IdentityGroup = [
117 cfg.StrOpt('catalog_type',
118 default='identity',
119 help="Catalog type of the Identity service."),
Jay Pipescd8eaec2013-01-16 21:03:48 -0500120 cfg.BoolOpt('disable_ssl_certificate_validation',
121 default=False,
122 help="Set to True if using self-signed SSL certificates."),
Rob Crittendena7db6692014-11-23 18:44:38 -0500123 cfg.StrOpt('ca_certificates_file',
124 default=None,
125 help='Specify a CA bundle file to use in verifying a '
126 'TLS (https) server certificate.'),
Jay Pipes7c88eb22013-01-16 21:32:43 -0500127 cfg.StrOpt('uri',
Brant Knudsonc7ca3342013-03-28 21:08:50 -0500128 help="Full URI of the OpenStack Identity API (Keystone), v2"),
129 cfg.StrOpt('uri_v3',
130 help='Full URI of the OpenStack Identity API (Keystone), v3'),
Andrea Frittoli8bbdb162014-01-06 11:06:13 +0000131 cfg.StrOpt('auth_version',
132 default='v2',
133 help="Identity API version to be used for authentication "
Andrea Frittoli77f9da42014-02-06 11:18:19 +0000134 "for API tests."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500135 cfg.StrOpt('region',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100136 default='RegionOne',
Arata Notsu8f440392013-09-13 16:14:20 +0900137 help="The identity region name to use. Also used as the other "
138 "services' region name unless they are set explicitly. "
139 "If no such region is found in the service catalog, the "
140 "first found one is used."),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300141 cfg.StrOpt('v2_admin_endpoint_type',
142 default='adminURL',
143 choices=['public', 'admin', 'internal',
144 'publicURL', 'adminURL', 'internalURL'],
145 help="The admin endpoint type to use for OpenStack Identity "
ghanshyamf58b9fd2015-09-01 16:11:39 +0900146 "(Keystone) API v2"),
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300147 cfg.StrOpt('v2_public_endpoint_type',
JordanP5d29b2c2013-12-18 13:56:03 +0000148 default='publicURL',
149 choices=['public', 'admin', 'internal',
150 'publicURL', 'adminURL', 'internalURL'],
Jane Zadorozhnac7862132015-07-10 14:34:50 +0300151 help="The public endpoint type to use for OpenStack Identity "
152 "(Keystone) API v2",
153 deprecated_opts=[cfg.DeprecatedOpt('endpoint_type',
154 group='identity')]),
155 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 "
ghanshyamf58b9fd2015-09-01 16:11:39 +0900160 "(Keystone) API v3"),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100161 cfg.StrOpt('username',
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400162 help="Username to use for Nova API requests.",
163 deprecated_for_removal=True),
Sean Dagueed6e5862016-04-04 10:49:13 -0400164 cfg.StrOpt('project_name',
165 deprecated_name='tenant_name',
166 help="Project name to use for Nova API requests.",
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400167 deprecated_for_removal=True),
Russell Sim7f894a52013-09-13 10:35:21 +1000168 cfg.StrOpt('admin_role',
169 default='admin',
170 help="Role required to administrate keystone."),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100171 cfg.StrOpt('password',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100172 help="API key to use when authenticating.",
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400173 secret=True,
174 deprecated_for_removal=True),
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100175 cfg.StrOpt('domain_name',
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100176 help="Domain name for authentication (Keystone V3)."
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400177 "The same domain applies to user and project",
178 deprecated_for_removal=True),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100179 cfg.StrOpt('alt_username',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100180 help="Username of alternate user to use for Nova API "
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400181 "requests.",
182 deprecated_for_removal=True),
Sean Dagueed6e5862016-04-04 10:49:13 -0400183 cfg.StrOpt('alt_project_name',
184 deprecated_name='alt_tenant_name',
185 help="Alternate user's Project name to use for Nova API "
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400186 "requests.",
187 deprecated_for_removal=True),
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100188 cfg.StrOpt('alt_password',
Attila Fazekascadcb1f2013-01-21 23:10:53 +0100189 help="API key to use when authenticating as alternate user.",
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400190 secret=True,
191 deprecated_for_removal=True),
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100192 cfg.StrOpt('alt_domain_name',
Andrea Frittolib1b04bb2014-04-06 11:57:07 +0100193 help="Alternate domain name for authentication (Keystone V3)."
Matthew Treinish16cf1e52015-08-11 10:39:23 -0400194 "The same domain applies to user and project",
195 deprecated_for_removal=True),
Martin Pavlasek4c3f2ab2014-04-15 17:15:15 +0200196 cfg.StrOpt('default_domain_id',
197 default='default',
198 help="ID of the default domain"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500199]
Jay Pipes3f981df2012-03-27 18:59:44 -0400200
Matthew Treinishd5021a72014-01-09 18:42:51 +0000201identity_feature_group = cfg.OptGroup(name='identity-feature-enabled',
202 title='Enabled Identity Features')
203
204IdentityFeatureGroup = [
205 cfg.BoolOpt('trust',
206 default=True,
207 help='Does the identity service have delegation and '
Matthew Treinishdb2c5972014-01-31 22:18:59 +0000208 'impersonation enabled'),
209 cfg.BoolOpt('api_v2',
210 default=True,
211 help='Is the v2 identity API enabled'),
212 cfg.BoolOpt('api_v3',
213 default=True,
214 help='Is the v3 identity API enabled'),
Jane Zadorozhna121576d2015-06-23 12:57:13 +0300215 cfg.ListOpt('api_extensions',
216 default=['all'],
217 help="A list of enabled identity extensions with a special "
218 "entry all which indicates every extension is enabled. "
219 "Empty list indicates all extensions are disabled. "
220 "To get the list of extensions run: 'keystone discover'")
Matthew Treinishd5021a72014-01-09 18:42:51 +0000221]
222
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500223compute_group = cfg.OptGroup(name='compute',
224 title='Compute Service Options')
Rohit Karajgie1b050d2011-12-02 16:13:18 -0800225
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500226ComputeGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500227 cfg.StrOpt('image_ref',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400228 help="Valid primary image reference to be used in tests. "
229 "This is a required option"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500230 cfg.StrOpt('image_ref_alt',
Matthew Treinishafcb6b42014-05-27 13:50:02 -0400231 help="Valid secondary image reference to be used in tests. "
232 "This is a required option, but if only one image is "
233 "available duplicate the value of image_ref above"),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900234 cfg.StrOpt('flavor_ref',
235 default="1",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500236 help="Valid primary flavor to use in tests."),
Ken'ichi Ohmichi35772602013-11-14 15:03:27 +0900237 cfg.StrOpt('flavor_ref_alt',
238 default="2",
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500239 help='Valid secondary flavor to be used in tests.'),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500240 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400241 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500242 help="Time in seconds between build status checks."),
243 cfg.IntOpt('build_timeout',
244 default=300,
Hugh Saunders5b139ad2014-12-15 09:08:41 +0000245 help="Timeout in seconds to wait for an instance to build. "
246 "Other services that do not define build_timeout will "
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200247 "inherit this value."),
Attila Fazekas0abbc952013-07-01 19:19:42 +0200248 cfg.IntOpt('ready_wait',
249 default=0,
DennyZhang8912d012013-09-25 18:08:34 -0500250 help="Additional wait time for clean state, when there is "
251 "no OS-EXT-STS extension available"),
Attila Fazekasb0661652013-05-08 13:01:36 +0200252 cfg.StrOpt('fixed_network_name',
Chris Hoge8f1401b2014-11-19 14:00:37 -0800253 help="Name of the fixed network that is visible to all test "
Sean Dagueed6e5862016-04-04 10:49:13 -0400254 "projects. If multiple networks are available for a "
255 "project, this is the network which will be used for "
256 "creating servers if tempest does not create a network or "
257 "s network is not specified elsewhere. It may be used for "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000258 "ssh validation only if floating IPs are disabled."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500259 cfg.StrOpt('catalog_type',
260 default='compute',
261 help="Catalog type of the Compute service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900262 cfg.StrOpt('region',
263 default='',
264 help="The compute region name to use. If empty, the value "
265 "of identity.region is used instead. If no such region "
266 "is found in the service catalog, the first found one is "
267 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000268 cfg.StrOpt('endpoint_type',
269 default='publicURL',
270 choices=['public', 'admin', 'internal',
271 'publicURL', 'adminURL', 'internalURL'],
272 help="The endpoint type to use for the compute service."),
Ryan Hsucb2e1252013-09-03 21:44:49 -0700273 cfg.StrOpt('volume_device_name',
274 default='vdb',
275 help="Expected device name when a volume is attached to "
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900276 "an instance"),
277 cfg.IntOpt('shelved_offload_time',
278 default=0,
279 help='Time in seconds before a shelved instance is eligible '
280 'for removing from a host. -1 never offload, 0 offload '
281 'when shelved. This time should be the same as the time '
282 'of nova.conf, and some tests will run for as long as the '
Ghanshyam06a5b4a2014-04-11 17:32:45 +0900283 'time.'),
Sean Dague782f6772015-11-11 11:26:45 -0500284 cfg.IntOpt('min_compute_nodes',
285 default=1,
286 help=('The minimum number of compute nodes expected. This will '
287 'be utilized by some multinode specific tests to ensure '
288 'that requests match the expected size of the cluster '
ghanshyam29591532016-03-11 17:12:43 +0900289 'you are testing with.')),
Ken'ichi Ohmichi4d237e72015-11-05 06:32:33 +0000290 cfg.StrOpt('min_microversion',
291 default=None,
292 help="Lower version of the test target microversion range. "
293 "The format is 'X.Y', where 'X' and 'Y' are int values. "
294 "Tempest selects tests based on the range between "
295 "min_microversion and max_microversion. "
Ghanshyam395c5b52015-12-04 17:27:16 +0900296 "If both values are not specified, Tempest avoids tests "
297 "which require a microversion. Valid values are string "
ghanshyam29591532016-03-11 17:12:43 +0900298 "with format 'X.Y' or string 'latest'",
299 deprecated_group='compute-feature-enabled'),
Ken'ichi Ohmichi4d237e72015-11-05 06:32:33 +0000300 cfg.StrOpt('max_microversion',
301 default=None,
302 help="Upper version of the test target microversion range. "
303 "The format is 'X.Y', where 'X' and 'Y' are int values. "
304 "Tempest selects tests based on the range between "
305 "min_microversion and max_microversion. "
Ghanshyam395c5b52015-12-04 17:27:16 +0900306 "If both values are not specified, Tempest avoids tests "
307 "which require a microversion. Valid values are string "
ghanshyam29591532016-03-11 17:12:43 +0900308 "with format 'X.Y' or string 'latest'",
309 deprecated_group='compute-feature-enabled'),
310]
311
312compute_features_group = cfg.OptGroup(name='compute-feature-enabled',
313 title="Enabled Compute Service Features")
314
315ComputeFeaturesGroup = [
Matthew Treinishd5c96022013-10-17 21:51:23 +0000316 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"),
Ghanshyam Mann41c17572014-02-27 18:52:56 +0900362 cfg.BoolOpt('vnc_console',
363 default=False,
364 help='Enable VNC console. This configuration value should '
Ghanshyam70876d02014-03-11 11:40:18 +0900365 'be same as [nova.vnc]->vnc_enabled in nova.conf'),
366 cfg.BoolOpt('spice_console',
367 default=False,
368 help='Enable Spice console. This configuration value should '
369 'be same as [nova.spice]->enabled in nova.conf'),
370 cfg.BoolOpt('rdp_console',
371 default=False,
372 help='Enable RDP console. This configuration value should '
Adam Gandelman2e37b4f2014-06-18 17:34:21 -0700373 'be same as [nova.rdp]->enabled in nova.conf'),
374 cfg.BoolOpt('rescue',
375 default=True,
376 help='Does the test environment support instance rescue '
Ghanshyam9c2e50d2014-07-22 21:32:05 +0900377 'mode?'),
378 cfg.BoolOpt('enable_instance_password',
379 default=True,
380 help='Enables returning of the instance password by the '
381 'relevant server API calls such as create, rebuild '
Adam Gandelman7186f7a2014-07-23 09:28:56 -0400382 'or rescue.'),
383 cfg.BoolOpt('interface_attach',
384 default=True,
385 help='Does the test environment support dynamic network '
Adam Gandelmanfbc95ac2014-06-19 17:33:43 -0700386 'interface attachment?'),
387 cfg.BoolOpt('snapshot',
388 default=True,
389 help='Does the test environment support creating snapshot '
Matthew Treinishdfd7ac02015-02-09 17:47:31 -0500390 'images of running instances?'),
Takeaki Matsumotodf4ab7c2015-08-25 17:49:23 +0900391 cfg.BoolOpt('nova_cert',
392 default=True,
393 help='Does the test environment have the nova cert running?'),
Takeaki Matsumotod7e04b22015-09-04 15:13:38 +0900394 cfg.BoolOpt('personality',
395 default=True,
396 help='Does the test environment support server personality'),
Matt Riedemann79b3b492015-06-20 14:20:44 -0700397 cfg.BoolOpt('attach_encrypted_volume',
398 default=True,
399 help='Does the test environment support attaching an '
400 'encrypted volume to a running server instance? This may '
401 'depend on the combination of compute_driver in nova and '
402 'the volume_driver(s) in cinder.'),
Matt Riedemann778b5f92015-03-11 12:44:28 -0700403 # TODO(mriedem): Remove allow_duplicate_networks once kilo-eol happens
404 # since the option was removed from nova in Liberty and is the default
405 # behavior starting in Liberty.
406 cfg.BoolOpt('allow_duplicate_networks',
407 default=False,
408 help='Does the test environment support creating instances '
409 'with multiple ports on the same network? This is only '
410 'valid when using Neutron.'),
Alexander Gubanov509e2842015-06-09 15:29:51 +0300411 cfg.BoolOpt('config_drive',
412 default=True,
413 help='Enable special configuration drive with metadata.'),
Yair Friedca5cfb52016-01-04 15:41:55 +0200414 cfg.ListOpt('scheduler_available_filters',
415 default=['all'],
416 help="A list of enabled filters that nova will accept as hints"
417 " to the scheduler when creating a server. A special "
418 "entry 'all' indicates all filters are enabled. Empty "
419 "list indicates all filters are disabled. The full "
420 "available list of filters is in nova.conf: "
421 "DEFAULT.scheduler_available_filters"),
422
Matthew Treinishd5c96022013-10-17 21:51:23 +0000423]
424
425
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500426image_group = cfg.OptGroup(name='image',
427 title="Image Service Options")
Jay Pipesf38eaac2012-06-21 13:37:35 -0400428
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500429ImageGroup = [
Matthew Treinish72ea4422013-02-07 14:42:49 -0500430 cfg.StrOpt('catalog_type',
431 default='image',
Sean Dague83401992013-05-06 17:46:36 -0400432 help='Catalog type of the Image service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900433 cfg.StrOpt('region',
434 default='',
435 help="The image region name to use. If empty, the value "
436 "of identity.region is used instead. If no such region "
437 "is found in the service catalog, the first found one is "
438 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000439 cfg.StrOpt('endpoint_type',
440 default='publicURL',
441 choices=['public', 'admin', 'internal',
442 'publicURL', 'adminURL', 'internalURL'],
443 help="The endpoint type to use for the image service."),
Sean Dague83401992013-05-06 17:46:36 -0400444 cfg.StrOpt('http_image',
445 default='http://download.cirros-cloud.net/0.3.1/'
446 'cirros-0.3.1-x86_64-uec.tar.gz',
Lucian Petrut1cfe2982015-01-06 13:57:36 +0200447 help='http accessible image'),
448 cfg.IntOpt('build_timeout',
449 default=300,
450 help="Timeout in seconds to wait for an image to "
451 "become available."),
452 cfg.IntOpt('build_interval',
453 default=1,
454 help="Time in seconds between image operation status "
Takashi NATSUME12a48512015-08-10 18:33:16 +0900455 "checks."),
456 cfg.ListOpt('container_formats',
457 default=['ami', 'ari', 'aki', 'bare', 'ovf', 'ova'],
458 help="A list of image's container formats "
459 "users can specify."),
460 cfg.ListOpt('disk_formats',
461 default=['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2',
462 'vdi', 'iso'],
463 help="A list of image's disk formats "
464 "users can specify.")
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500465]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400466
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000467image_feature_group = cfg.OptGroup(name='image-feature-enabled',
468 title='Enabled image service features')
469
470ImageFeaturesGroup = [
471 cfg.BoolOpt('api_v2',
472 default=True,
473 help="Is the v2 image API enabled"),
474 cfg.BoolOpt('api_v1',
475 default=True,
476 help="Is the v1 image API enabled"),
bkopilov81aaae72015-05-15 23:46:25 +0300477 cfg.BoolOpt('deactivate_image',
478 default=False,
479 help="Is the deactivate-image feature enabled."
480 " The feature has been integrated since Kilo."),
Matthew Treinish2b5287d2013-10-22 17:40:34 +0000481]
Jay Pipesf38eaac2012-06-21 13:37:35 -0400482
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500483network_group = cfg.OptGroup(name='network',
484 title='Network Service Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600485
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500486NetworkGroup = [
487 cfg.StrOpt('catalog_type',
488 default='network',
Mark McClainf2982e82013-07-06 17:48:03 -0400489 help='Catalog type of the Neutron service.'),
Arata Notsu8f440392013-09-13 16:14:20 +0900490 cfg.StrOpt('region',
491 default='',
492 help="The network region name to use. If empty, the value "
493 "of identity.region is used instead. If no such region "
494 "is found in the service catalog, the first found one is "
495 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000496 cfg.StrOpt('endpoint_type',
497 default='publicURL',
498 choices=['public', 'admin', 'internal',
499 'publicURL', 'adminURL', 'internalURL'],
500 help="The endpoint type to use for the network service."),
Sean Dagueed6e5862016-04-04 10:49:13 -0400501 cfg.StrOpt('project_network_cidr',
502 deprecated_name='tenant_network_cidr',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500503 default="10.100.0.0/16",
Sean Dagueed6e5862016-04-04 10:49:13 -0400504 help="The cidr block to allocate project ipv4 subnets from"),
505 cfg.IntOpt('project_network_mask_bits',
506 deprecated_name='tenant_network_mask_bits',
Attila Fazekas8ea181b2013-07-13 16:26:14 +0200507 default=28,
Sean Dagueed6e5862016-04-04 10:49:13 -0400508 help="The mask bits for project ipv4 subnets"),
509 cfg.StrOpt('project_network_v6_cidr',
510 deprecated_name='tenant_network_v6_cidr',
Sergey Shnaidman1f3659a2014-08-27 18:26:42 +0400511 default="2003::/48",
Sean Dagueed6e5862016-04-04 10:49:13 -0400512 help="The cidr block to allocate project ipv6 subnets from"),
513 cfg.IntOpt('project_network_v6_mask_bits',
514 deprecated_name='tenant_network_v6_mask_bits',
Sergey Shnaidman1f3659a2014-08-27 18:26:42 +0400515 default=64,
Sean Dagueed6e5862016-04-04 10:49:13 -0400516 help="The mask bits for project ipv6 subnets"),
517 cfg.BoolOpt('project_networks_reachable',
518 deprecated_name='tenant_networks_reachable',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500519 default=False,
Sean Dagueed6e5862016-04-04 10:49:13 -0400520 help="Whether project networks can be reached directly from "
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000521 "the test client. This must be set to True when the "
522 "'fixed' ssh_connect_method is selected."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500523 cfg.StrOpt('public_network_id',
524 default="",
525 help="Id of the public network that provides external "
526 "connectivity"),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000527 cfg.StrOpt('floating_network_name',
528 help="Default floating network name. Used to allocate floating "
529 "IPs when neutron is enabled."),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500530 cfg.StrOpt('public_router_id',
531 default="",
532 help="Id of the public router that provides external "
Yair Fried1eb27f52014-11-10 15:24:19 +0200533 "connectivity. This should only be used when Neutron's "
534 "'allow_overlapping_ips' is set to 'False' in "
535 "neutron.conf. usually not needed past 'Grizzly' release"),
izikpensod9a01a62014-02-17 20:02:32 +0200536 cfg.IntOpt('build_timeout',
537 default=300,
538 help="Timeout in seconds to wait for network operation to "
539 "complete."),
540 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400541 default=1,
izikpensod9a01a62014-02-17 20:02:32 +0200542 help="Time in seconds between network operation status "
543 "checks."),
Attila Fazekas640392b2014-06-12 15:58:10 +0200544 cfg.ListOpt('dns_servers',
545 default=["8.8.8.8", "8.8.4.4"],
Itzik Brown5be44582014-12-24 09:05:13 +0200546 help="List of dns servers which should be used"
Itzik Brown2ca01cd2014-12-08 12:58:20 +0200547 " for subnet creation"),
548 cfg.StrOpt('port_vnic_type',
549 choices=[None, 'normal', 'direct', 'macvtap'],
550 help="vnic_type to use when Launching instances"
551 " with pre-configured ports."
552 " Supported ports are:"
553 " ['normal','direct','macvtap']"),
piyush11078648e35d52015-09-24 12:56:43 +0530554 cfg.ListOpt('default_network',
555 default=["1.0.0.0/16", "2.0.0.0/16"],
556 help="List of ip pools"
557 " for subnetpools creation"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500558]
Jay Pipes3f981df2012-03-27 18:59:44 -0400559
Matthew Treinishe3d26142013-11-26 19:14:58 +0000560network_feature_group = cfg.OptGroup(name='network-feature-enabled',
561 title='Enabled network service features')
562
563NetworkFeaturesGroup = [
Matthew Treinishe2e33cf2014-03-03 19:28:41 +0000564 cfg.BoolOpt('ipv6',
565 default=True,
566 help="Allow the execution of IPv6 tests"),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000567 cfg.ListOpt('api_extensions',
568 default=['all'],
Alexander Gubanov36e1f9b2015-06-12 18:02:10 +0300569 help="A list of enabled network extensions with a special "
570 "entry all which indicates every extension is enabled. "
571 "Empty list indicates all extensions are disabled. "
572 "To get the list of extensions run: 'neutron ext-list'"),
Sean M. Collinsdd27a4d2014-05-13 10:33:15 -0400573 cfg.BoolOpt('ipv6_subnet_attributes',
574 default=False,
575 help="Allow the execution of IPv6 subnet tests that use "
576 "the extended IPv6 attributes ipv6_ra_mode "
577 "and ipv6_address_mode"
Mark McClain6e07c0d2014-10-10 11:25:03 -0400578 ),
Itzik Brownbeb30d32015-03-29 09:42:54 +0300579 cfg.BoolOpt('port_admin_state_change',
580 default=True,
581 help="Does the test environment support changing"
582 " port admin state"),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000583]
584
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000585validation_group = cfg.OptGroup(name='validation',
586 title='SSH Validation options')
587
588ValidationGroup = [
Matthew Treinishe5cca002015-05-11 15:36:50 -0400589 cfg.BoolOpt('run_validation',
590 default=False,
591 help='Enable ssh on created servers and creation of additional'
lanoux283273b2015-12-04 03:01:54 -0800592 ' validation resources to enable remote access'),
Brandon Palmc6cc91d2015-08-19 13:20:21 -0500593 cfg.BoolOpt('security_group',
594 default=True,
595 help='Enable/disable security groups.'),
596 cfg.BoolOpt('security_group_rules',
597 default=True,
598 help='Enable/disable security group rules.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000599 cfg.StrOpt('connect_method',
600 default='floating',
601 choices=['fixed', 'floating'],
602 help='Default IP type used for validation: '
603 '-fixed: uses the first IP belonging to the fixed network '
lanoux283273b2015-12-04 03:01:54 -0800604 '-floating: creates and uses a floating IP',
605 deprecated_opts=[cfg.DeprecatedOpt('use_floatingip_for_ssh',
606 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000607 cfg.StrOpt('auth_method',
608 default='keypair',
609 choices=['keypair'],
610 help='Default authentication method to the instance. '
611 'Only ssh via keypair is supported for now. '
lanoux283273b2015-12-04 03:01:54 -0800612 'Additional methods will be handled in a separate spec.',
613 deprecated_opts=[cfg.DeprecatedOpt('ssh_auth_method',
614 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000615 cfg.IntOpt('ip_version_for_ssh',
616 default=4,
lanoux283273b2015-12-04 03:01:54 -0800617 help='Default IP version for ssh connections.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000618 cfg.IntOpt('ping_timeout',
619 default=120,
lanoux283273b2015-12-04 03:01:54 -0800620 help='Timeout in seconds to wait for ping to succeed.',
621 deprecated_opts=[cfg.DeprecatedOpt('ping_timeout',
622 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000623 cfg.IntOpt('connect_timeout',
624 default=60,
625 help='Timeout in seconds to wait for the TCP connection to be '
lanoux283273b2015-12-04 03:01:54 -0800626 'successful.'),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000627 cfg.IntOpt('ssh_timeout',
628 default=300,
lanoux283273b2015-12-04 03:01:54 -0800629 help='Timeout in seconds to wait for the ssh banner.'),
630 cfg.StrOpt('image_ssh_user',
631 default="root",
632 help="User name used to authenticate to an instance.",
633 deprecated_opts=[cfg.DeprecatedOpt('image_ssh_user',
634 group='compute'),
635 cfg.DeprecatedOpt('ssh_user',
636 group='compute'),
637 cfg.DeprecatedOpt('ssh_user',
638 group='scenario')]),
639 cfg.StrOpt('image_ssh_password',
640 default="password",
641 help="Password used to authenticate to an instance.",
642 deprecated_opts=[cfg.DeprecatedOpt('image_ssh_password',
643 group='compute')]),
644 cfg.StrOpt('ssh_shell_prologue',
645 default="set -eu -o pipefail; PATH=$$PATH:/sbin;",
646 help="Shell fragments to use before executing a command "
647 "when sshing to a guest.",
648 deprecated_opts=[cfg.DeprecatedOpt('ssh_shell_prologue',
649 group='compute')]),
650 cfg.IntOpt('ping_size',
651 default=56,
652 help="The packet size for ping packets originating "
653 "from remote linux hosts",
654 deprecated_opts=[cfg.DeprecatedOpt('ping_size',
655 group='compute')]),
656 cfg.IntOpt('ping_count',
657 default=1,
658 help="The number of ping packets originating from remote "
659 "linux hosts",
660 deprecated_opts=[cfg.DeprecatedOpt('ping_count',
661 group='compute')]),
662 cfg.StrOpt('floating_ip_range',
663 default='10.0.0.0/29',
664 help='Unallocated floating IP range, which will be used to '
665 'test the floating IP bulk feature for CRUD operation. '
666 'This block must not overlap an existing floating IP '
667 'pool.',
668 deprecated_opts=[cfg.DeprecatedOpt('floating_ip_range',
669 group='compute')]),
670 cfg.StrOpt('network_for_ssh',
671 default='public',
672 help="Network used for SSH connections. Ignored if "
673 "use_floatingip_for_ssh=true or run_validation=false.",
674 deprecated_opts=[cfg.DeprecatedOpt('network_for_ssh',
nithya-ganesan67da2872015-02-08 23:13:48 +0000675 group='compute')]),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +0000676]
677
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500678volume_group = cfg.OptGroup(name='volume',
679 title='Block Storage Options')
Daryl Walleck587385b2012-03-03 13:00:26 -0600680
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500681VolumeGroup = [
682 cfg.IntOpt('build_interval',
Sean Dague82190852014-05-24 07:42:59 -0400683 default=1,
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500684 help='Time in seconds between volume availability checks.'),
685 cfg.IntOpt('build_timeout',
686 default=300,
Eric Harney9b1f89c2014-10-14 14:40:19 -0400687 help='Timeout in seconds to wait for a volume to become '
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500688 'available.'),
689 cfg.StrOpt('catalog_type',
Matthew Treinisheb724512013-10-25 15:12:59 +0000690 default='volume',
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500691 help="Catalog type of the Volume Service"),
Arata Notsu8f440392013-09-13 16:14:20 +0900692 cfg.StrOpt('region',
693 default='',
694 help="The volume region name to use. If empty, the value "
695 "of identity.region is used instead. If no such region "
696 "is found in the service catalog, the first found one is "
697 "used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000698 cfg.StrOpt('endpoint_type',
699 default='publicURL',
700 choices=['public', 'admin', 'internal',
701 'publicURL', 'adminURL', 'internalURL'],
702 help="The endpoint type to use for the volume service."),
Benny Kopilovaf136a92015-11-10 07:37:23 +0200703 cfg.ListOpt('backend_names',
704 default=['BACKEND_1', 'BACKEND_2'],
april4be58dc2015-12-29 00:07:22 +0800705 help='A list of backend names separated by comma. '
bkopilov27905cc2016-04-12 14:29:13 +0300706 'The backend name must be declared in cinder.conf'),
Adam Gandelman827ad332013-06-24 17:04:09 -0700707 cfg.StrOpt('storage_protocol',
708 default='iSCSI',
709 help='Backend protocol to target when creating volume types'),
710 cfg.StrOpt('vendor_name',
711 default='Open Source',
712 help='Backend vendor to target when creating volume types'),
Ryan Hsua67f4632013-08-29 16:03:06 -0700713 cfg.StrOpt('disk_format',
714 default='raw',
715 help='Disk format to use when copying a volume to image'),
Jerry Cai9733d0e2014-03-19 15:50:49 +0800716 cfg.IntOpt('volume_size',
717 default=1,
718 help='Default size in GB for volumes created by volumes tests'),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500719]
K Jonathan Harkerd6ba4b42012-12-18 13:50:47 -0800720
Matthew Treinishd5c96022013-10-17 21:51:23 +0000721volume_feature_group = cfg.OptGroup(name='volume-feature-enabled',
722 title='Enabled Cinder Features')
723
724VolumeFeaturesGroup = [
725 cfg.BoolOpt('multi_backend',
726 default=False,
Matthew Treinishe3d26142013-11-26 19:14:58 +0000727 help="Runs Cinder multi-backend test (requires 2 backends)"),
Giulio Fidente74b08ad2014-01-18 04:02:51 +0100728 cfg.BoolOpt('backup',
729 default=True,
730 help='Runs Cinder volumes backup test'),
JordanPbce55532014-03-19 12:10:32 +0100731 cfg.BoolOpt('snapshot',
732 default=True,
733 help='Runs Cinder volume snapshot test'),
Takeaki Matsumoto1702aed2015-08-25 08:44:26 +0900734 cfg.BoolOpt('clone',
735 default=True,
736 help='Runs Cinder volume clone test'),
Matthew Treinishe3d26142013-11-26 19:14:58 +0000737 cfg.ListOpt('api_extensions',
738 default=['all'],
Zhi Kun Liude25c022014-02-14 13:25:19 +0800739 help='A list of enabled volume extensions with a special '
Simeon Monov5d7effe2014-07-16 07:32:38 +0300740 'entry all which indicates every extension is enabled. '
741 'Empty list indicates all extensions are disabled'),
Zhi Kun Liubb363a22013-11-28 18:47:39 +0800742 cfg.BoolOpt('api_v1',
743 default=True,
744 help="Is the v1 volume API enabled"),
Zhi Kun Liu8cc3c842014-01-07 10:44:34 +0800745 cfg.BoolOpt('api_v2',
746 default=True,
747 help="Is the v2 volume API enabled"),
bkopilov8a657ae2015-05-11 11:45:23 +0300748 cfg.BoolOpt('bootable',
Benny Kopilov618359f2015-11-11 13:46:33 +0200749 default=True,
bkopilov8a657ae2015-05-11 11:45:23 +0300750 help='Update bootable status of a volume '
Benny Kopilov618359f2015-11-11 13:46:33 +0200751 'Not implemented on icehouse ',
Yuriy Nesenenko86d90f22016-01-13 14:01:39 +0200752 deprecated_for_removal=True),
753 # TODO(ynesenenko): Remove volume_services once liberty-eol happens.
754 cfg.BoolOpt('volume_services',
755 default=False,
756 help='Extract correct host info from host@backend')
Matthew Treinishd5c96022013-10-17 21:51:23 +0000757]
758
Daryl Walleck587385b2012-03-03 13:00:26 -0600759
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500760object_storage_group = cfg.OptGroup(name='object-storage',
761 title='Object Storage Service Options')
Attila Fazekasa23f5002012-10-23 19:32:45 +0200762
DennyZhang1e71b612013-09-26 12:35:40 -0500763ObjectStoreGroup = [
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500764 cfg.StrOpt('catalog_type',
765 default='object-store',
766 help="Catalog type of the Object-Storage service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900767 cfg.StrOpt('region',
768 default='',
769 help="The object-storage region name to use. If empty, the "
770 "value of identity.region is used instead. If no such "
771 "region is found in the service catalog, the first found "
772 "one is used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000773 cfg.StrOpt('endpoint_type',
774 default='publicURL',
775 choices=['public', 'admin', 'internal',
776 'publicURL', 'adminURL', 'internalURL'],
777 help="The endpoint type to use for the object-store service."),
Matthew Treinishf319a732013-10-24 21:39:24 +0000778 cfg.IntOpt('container_sync_timeout',
Daisuke Morita1ac3ee02014-08-25 12:59:18 +0900779 default=600,
Fabien Boucher2178d312013-12-31 15:38:57 +0100780 help="Number of seconds to time on waiting for a container "
nayna-patelb4989b32013-01-09 06:25:13 +0000781 "to container synchronization complete."),
Matthew Treinishf319a732013-10-24 21:39:24 +0000782 cfg.IntOpt('container_sync_interval',
nayna-patelb4989b32013-01-09 06:25:13 +0000783 default=5,
Fabien Boucher2178d312013-12-31 15:38:57 +0100784 help="Number of seconds to wait while looping to check the "
nayna-patelb4989b32013-01-09 06:25:13 +0000785 "status of a container to container synchronization"),
Matthew Treinish3fdb80c2013-08-15 11:13:19 -0400786 cfg.StrOpt('operator_role',
787 default='Member',
788 help="Role to add to users created for swift tests to "
789 "enable creating containers"),
Matthew Treinish998c91d2014-03-01 12:39:49 -0500790 cfg.StrOpt('reseller_admin_role',
791 default='ResellerAdmin',
792 help="User role that has reseller admin"),
Daisuke Morita1ac3ee02014-08-25 12:59:18 +0900793 cfg.StrOpt('realm_name',
794 default='realm1',
795 help="Name of sync realm. A sync realm is a set of clusters "
796 "that have agreed to allow container syncing with each "
797 "other. Set the same realm name as Swift's "
798 "container-sync-realms.conf"),
799 cfg.StrOpt('cluster_name',
800 default='name1',
801 help="One name of cluster which is set in the realm whose name "
802 "is set in 'realm_name' item in this file. Set the "
803 "same cluster name as Swift's container-sync-realms.conf"),
Matthew Treinish39e48ef2012-12-21 13:36:15 -0500804]
Attila Fazekasa23f5002012-10-23 19:32:45 +0200805
Matthew Treinishd5c96022013-10-17 21:51:23 +0000806object_storage_feature_group = cfg.OptGroup(
807 name='object-storage-feature-enabled',
808 title='Enabled object-storage features')
809
810ObjectStoreFeaturesGroup = [
Matthew Treinish20345382013-12-13 17:04:23 +0000811 cfg.ListOpt('discoverable_apis',
812 default=['all'],
813 help="A list of the enabled optional discoverable apis. "
814 "A single entry, all, indicates that all of these "
815 "features are expected to be enabled"),
Daisuke Morita20a183f2014-08-25 14:43:36 +0900816 cfg.BoolOpt('container_sync',
817 default=True,
818 help="Execute (old style) container-sync tests"),
819 cfg.BoolOpt('object_versioning',
820 default=True,
821 help="Execute object-versioning tests"),
822 cfg.BoolOpt('discoverability',
823 default=True,
824 help="Execute discoverability tests"),
Matthew Treinishd5c96022013-10-17 21:51:23 +0000825]
826
Nikhil Manchandadd6886f2014-03-03 01:58:45 -0800827database_group = cfg.OptGroup(name='database',
828 title='Database Service Options')
829
830DatabaseGroup = [
831 cfg.StrOpt('catalog_type',
832 default='database',
833 help="Catalog type of the Database service."),
834 cfg.StrOpt('db_flavor_ref',
835 default="1",
836 help="Valid primary flavor to use in database tests."),
Peter Stachowski320f9c72014-04-21 16:13:23 -0400837 cfg.StrOpt('db_current_version',
838 default="v1.0",
839 help="Current database version to use in database tests."),
Nikhil Manchandadd6886f2014-03-03 01:58:45 -0800840]
Attila Fazekasa23f5002012-10-23 19:32:45 +0200841
Steve Bakerc60e4e32013-05-06 15:22:41 +1200842orchestration_group = cfg.OptGroup(name='orchestration',
843 title='Orchestration Service Options')
844
845OrchestrationGroup = [
846 cfg.StrOpt('catalog_type',
847 default='orchestration',
848 help="Catalog type of the Orchestration service."),
Arata Notsu8f440392013-09-13 16:14:20 +0900849 cfg.StrOpt('region',
850 default='',
851 help="The orchestration region name to use. If empty, the "
852 "value of identity.region is used instead. If no such "
853 "region is found in the service catalog, the first found "
854 "one is used."),
JordanP5d29b2c2013-12-18 13:56:03 +0000855 cfg.StrOpt('endpoint_type',
856 default='publicURL',
857 choices=['public', 'admin', 'internal',
858 'publicURL', 'adminURL', 'internalURL'],
859 help="The endpoint type to use for the orchestration service."),
Matthew Treinishdb9721d2015-03-18 14:21:28 -0400860 cfg.StrOpt('stack_owner_role', default='heat_stack_owner',
861 help='Role required for users to be able to manage stacks'),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200862 cfg.IntOpt('build_interval',
863 default=1,
864 help="Time in seconds between build status checks."),
865 cfg.IntOpt('build_timeout',
Matthew Treinisha2dfd492014-04-15 11:15:34 -0400866 default=1200,
Steve Bakerc60e4e32013-05-06 15:22:41 +1200867 help="Timeout in seconds to wait for a stack to build."),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200868 cfg.StrOpt('instance_type',
Steve Baker9e86b832013-05-22 15:40:28 +1200869 default='m1.micro',
Steve Bakerc60e4e32013-05-06 15:22:41 +1200870 help="Instance type for tests. Needs to be big enough for a "
871 "full OS plus the test workload"),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200872 cfg.StrOpt('keypair_name',
Steve Bakerc60e4e32013-05-06 15:22:41 +1200873 help="Name of existing keypair to launch servers with."),
Clint Byrum71f27632013-09-09 11:41:32 -0700874 cfg.IntOpt('max_template_size',
Joe Gordon0e51b222013-10-24 14:11:10 +0100875 default=524288,
Clint Byrum71f27632013-09-09 11:41:32 -0700876 help="Value must match heat configuration of the same name."),
Steven Hardyfdc6bd72014-03-21 16:56:04 +0000877 cfg.IntOpt('max_resources_per_stack',
878 default=1000,
879 help="Value must match heat configuration of the same name."),
Steve Bakerc60e4e32013-05-06 15:22:41 +1200880]
881
882
Yassine Lamgarchalb158d412013-12-27 19:29:42 +0100883telemetry_group = cfg.OptGroup(name='telemetry',
884 title='Telemetry Service Options')
885
886TelemetryGroup = [
887 cfg.StrOpt('catalog_type',
888 default='metering',
889 help="Catalog type of the Telemetry service."),
JordanPfc62c902014-02-26 14:47:28 +0000890 cfg.StrOpt('endpoint_type',
891 default='publicURL',
892 choices=['public', 'admin', 'internal',
893 'publicURL', 'adminURL', 'internalURL'],
894 help="The endpoint type to use for the telemetry service."),
Vadim Rovachev7bcea352013-12-26 15:56:17 +0400895 cfg.BoolOpt('too_slow_to_test',
896 default=True,
gordon chung0d99a082015-08-28 15:24:53 -0400897 deprecated_for_removal=True,
Vadim Rovachev7bcea352013-12-26 15:56:17 +0400898 help="This variable is used as flag to enable "
899 "notification tests")
Yassine Lamgarchalb158d412013-12-27 19:29:42 +0100900]
901
liu-sheng67b730e2015-07-16 15:19:33 +0800902alarming_group = cfg.OptGroup(name='alarming',
903 title='Alarming Service Options')
904
905AlarmingGroup = [
906 cfg.StrOpt('catalog_type',
907 default='alarming',
908 help="Catalog type of the Alarming service."),
909 cfg.StrOpt('endpoint_type',
910 default='publicURL',
911 choices=['public', 'admin', 'internal',
912 'publicURL', 'adminURL', 'internalURL'],
913 help="The endpoint type to use for the alarming service."),
914]
915
Yassine Lamgarchalb158d412013-12-27 19:29:42 +0100916
gordon chungee23ddb2015-02-11 20:05:07 -0500917telemetry_feature_group = cfg.OptGroup(name='telemetry-feature-enabled',
918 title='Enabled Ceilometer Features')
919
920TelemetryFeaturesGroup = [
921 cfg.BoolOpt('events',
922 default=False,
923 help="Runs Ceilometer event-related tests"),
924]
925
926
Julie Pichond1017642013-07-24 16:37:23 +0100927dashboard_group = cfg.OptGroup(name="dashboard",
928 title="Dashboard options")
929
930DashboardGroup = [
931 cfg.StrOpt('dashboard_url',
932 default='http://localhost/',
933 help="Where the dashboard can be found"),
934 cfg.StrOpt('login_url',
935 default='http://localhost/auth/login/',
Yaroslav Lobankov002bfab2015-08-19 14:45:02 +0300936 help="Login page for the dashboard",
937 deprecated_for_removal=True),
Julie Pichond1017642013-07-24 16:37:23 +0100938]
939
940
Telles Nobrega6189b0a2014-11-18 23:22:17 -0300941data_processing_group = cfg.OptGroup(name="data-processing",
Sergey Lukjanovcec6c3f2013-12-10 12:38:21 +0400942 title="Data Processing options")
943
944DataProcessingGroup = [
945 cfg.StrOpt('catalog_type',
Telles Nobrega6189b0a2014-11-18 23:22:17 -0300946 default='data-processing',
947 deprecated_group="data_processing",
JordanPfc62c902014-02-26 14:47:28 +0000948 help="Catalog type of the data processing service."),
949 cfg.StrOpt('endpoint_type',
950 default='publicURL',
951 choices=['public', 'admin', 'internal',
952 'publicURL', 'adminURL', 'internalURL'],
Telles Nobrega6189b0a2014-11-18 23:22:17 -0300953 deprecated_group="data_processing",
JordanPfc62c902014-02-26 14:47:28 +0000954 help="The endpoint type to use for the data processing "
955 "service."),
Sergey Lukjanovcec6c3f2013-12-10 12:38:21 +0400956]
957
958
Luigi Toscano14d172d2015-01-23 16:37:47 +0100959data_processing_feature_group = cfg.OptGroup(
Telles Nobrega6189b0a2014-11-18 23:22:17 -0300960 name="data-processing-feature-enabled",
Luigi Toscano14d172d2015-01-23 16:37:47 +0100961 title="Enabled Data Processing features")
962
963DataProcessingFeaturesGroup = [
964 cfg.ListOpt('plugins',
Javier Penad750c2d2016-03-08 16:04:09 +0100965 default=["vanilla", "cdh"],
Telles Nobrega6189b0a2014-11-18 23:22:17 -0300966 deprecated_group="data_processing-feature-enabled",
Luigi Toscano14d172d2015-01-23 16:37:47 +0100967 help="List of enabled data processing plugins")
968]
969
Matthew Treinish615ea6a2013-02-25 17:26:59 -0500970stress_group = cfg.OptGroup(name='stress', title='Stress Test Options')
971
972StressGroup = [
973 cfg.StrOpt('nova_logdir',
Matthew Treinish615ea6a2013-02-25 17:26:59 -0500974 help='Directory containing log files on the compute nodes'),
975 cfg.IntOpt('max_instances',
976 default=16,
977 help='Maximum number of instances to create during test.'),
978 cfg.StrOpt('controller',
David Kranzb9d97502013-05-01 15:55:04 -0400979 help='Controller host.'),
980 # new stress options
981 cfg.StrOpt('target_controller',
David Kranzb9d97502013-05-01 15:55:04 -0400982 help='Controller host.'),
983 cfg.StrOpt('target_ssh_user',
David Kranzb9d97502013-05-01 15:55:04 -0400984 help='ssh user.'),
985 cfg.StrOpt('target_private_key_path',
David Kranzb9d97502013-05-01 15:55:04 -0400986 help='Path to private key.'),
987 cfg.StrOpt('target_logfiles',
David Kranzb9d97502013-05-01 15:55:04 -0400988 help='regexp for list of log files.'),
Matthew Treinishf319a732013-10-24 21:39:24 +0000989 cfg.IntOpt('log_check_interval',
David Kranzb9d97502013-05-01 15:55:04 -0400990 default=60,
Marc Koderer32221b8e2013-08-23 13:57:50 +0200991 help='time (in seconds) between log file error checks.'),
Matthew Treinishf319a732013-10-24 21:39:24 +0000992 cfg.IntOpt('default_thread_number_per_action',
Marc Koderer32221b8e2013-08-23 13:57:50 +0200993 default=4,
Julien Leloup04d40f72014-01-28 11:17:18 +0100994 help='The number of threads created while stress test.'),
995 cfg.BoolOpt('leave_dirty_stack',
996 default=False,
997 help='Prevent the cleaning (tearDownClass()) between'
998 ' each stress test run if an exception occurs'
Julien Leloupa5ee5422014-02-13 14:29:02 +0100999 ' during this run.'),
1000 cfg.BoolOpt('full_clean_stack',
1001 default=False,
1002 help='Allows a full cleaning process after a stress test.'
1003 ' Caution : this cleanup will remove every objects of'
Sean Dagueed6e5862016-04-04 10:49:13 -04001004 ' every project.')
Matthew Treinish615ea6a2013-02-25 17:26:59 -05001005]
1006
1007
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001008scenario_group = cfg.OptGroup(name='scenario', title='Scenario Test Options')
1009
1010ScenarioGroup = [
1011 cfg.StrOpt('img_dir',
1012 default='/opt/stack/new/devstack/files/images/'
1013 'cirros-0.3.1-x86_64-uec',
Matthew Treinish5d5e20a2016-01-14 10:54:30 -05001014 help='Directory containing image files',
1015 deprecated_for_removal=True),
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001016 cfg.StrOpt('img_file', deprecated_name='qcow2_img_file',
Masayuki Igawa4f71bf02014-02-21 14:02:29 +09001017 default='cirros-0.3.1-x86_64-disk.img',
Alessandro Pilottib7c1daa2014-08-16 14:24:13 +03001018 help='Image file name'),
1019 cfg.StrOpt('img_disk_format',
1020 default='qcow2',
1021 help='Image disk format'),
1022 cfg.StrOpt('img_container_format',
1023 default='bare',
1024 help='Image container format'),
Evgeny Antyshev7ba0d5f2015-04-28 13:18:07 +00001025 cfg.DictOpt('img_properties', help='Glance image properties. '
1026 'Use for custom images which require them'),
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001027 cfg.StrOpt('ami_img_file',
1028 default='cirros-0.3.1-x86_64-blank.img',
Matthew Treinish5d5e20a2016-01-14 10:54:30 -05001029 help='AMI image file name',
1030 deprecated_for_removal=True),
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001031 cfg.StrOpt('ari_img_file',
1032 default='cirros-0.3.1-x86_64-initrd',
Matthew Treinish5d5e20a2016-01-14 10:54:30 -05001033 help='ARI image file name',
1034 deprecated_for_removal=True),
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001035 cfg.StrOpt('aki_img_file',
1036 default='cirros-0.3.1-x86_64-vmlinuz',
Matthew Treinish5d5e20a2016-01-14 10:54:30 -05001037 help='AKI image file name',
1038 deprecated_for_removal=True),
Yair Fried413bf2d2014-11-19 17:07:11 +02001039 # TODO(yfried): add support for dhcpcd
1040 cfg.StrOpt('dhcp_client',
1041 default='udhcpc',
Yaroslav Lobankovceae2042015-09-09 19:25:14 +03001042 choices=["udhcpc", "dhclient", ""],
Yair Fried413bf2d2014-11-19 17:07:11 +02001043 help='DHCP client used by images to renew DCHP lease. '
1044 'If left empty, update operation will be skipped. '
1045 'Supported clients: "udhcpc", "dhclient"')
Masayuki Igawa73d9f3a2013-05-24 10:30:01 +09001046]
1047
1048
Matthew Treinish4c412922013-07-16 15:27:42 -04001049service_available_group = cfg.OptGroup(name="service_available",
1050 title="Available OpenStack Services")
1051
1052ServiceAvailableGroup = [
1053 cfg.BoolOpt('cinder',
1054 default=True,
1055 help="Whether or not cinder is expected to be available"),
Matthew Treinishfaa340d2013-07-19 16:26:21 -04001056 cfg.BoolOpt('neutron',
1057 default=False,
1058 help="Whether or not neutron is expected to be available"),
Matthew Treinish853ae442013-07-19 16:36:07 -04001059 cfg.BoolOpt('glance',
1060 default=True,
1061 help="Whether or not glance is expected to be available"),
Matthew Treinish61e332b2013-07-19 16:42:31 -04001062 cfg.BoolOpt('swift',
1063 default=True,
1064 help="Whether or not swift is expected to be available"),
Matthew Treinish6b41e242013-07-19 16:49:28 -04001065 cfg.BoolOpt('nova',
1066 default=True,
1067 help="Whether or not nova is expected to be available"),
Matthew Treinisha9d43882013-07-19 16:54:52 -04001068 cfg.BoolOpt('heat',
1069 default=False,
1070 help="Whether or not Heat is expected to be available"),
Mehdi Abaakouk8581c0b2013-10-04 10:45:42 +02001071 cfg.BoolOpt('ceilometer',
1072 default=True,
1073 help="Whether or not Ceilometer is expected to be available"),
liu-sheng67b730e2015-07-16 15:19:33 +08001074 cfg.BoolOpt('aodh',
1075 default=False,
1076 help="Whether or not Aodh is expected to be available"),
Julie Pichond1017642013-07-24 16:37:23 +01001077 cfg.BoolOpt('horizon',
1078 default=True,
1079 help="Whether or not Horizon is expected to be available"),
Sergey Lukjanov9c95a252014-03-13 23:59:22 +04001080 cfg.BoolOpt('sahara',
Sergey Lukjanovcec6c3f2013-12-10 12:38:21 +04001081 default=False,
Sergey Lukjanov9c95a252014-03-13 23:59:22 +04001082 help="Whether or not Sahara is expected to be available"),
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001083 cfg.BoolOpt('ironic',
1084 default=False,
1085 help="Whether or not Ironic is expected to be available"),
Nikhil Manchandadd6886f2014-03-03 01:58:45 -08001086 cfg.BoolOpt('trove',
1087 default=False,
1088 help="Whether or not Trove is expected to be available"),
Matthew Treinish4c412922013-07-16 15:27:42 -04001089]
1090
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001091debug_group = cfg.OptGroup(name="debug",
1092 title="Debug System")
1093
1094DebugGroup = [
Sean Daguec522c092014-03-24 10:43:22 -04001095 cfg.StrOpt('trace_requests',
1096 default='',
1097 help="""A regex to determine which requests should be traced.
1098
1099This is a regex to match the caller for rest client requests to be able to
1100selectively trace calls out of specific classes and methods. It largely
1101exists for test development, and is not expected to be used in a real deploy
1102of tempest. This will be matched against the discovered ClassName:method
1103in the test environment.
1104
1105Expected values for this field are:
1106
1107 * ClassName:test_method_name - traces one test_method
1108 * ClassName:setUp(Class) - traces specific setup functions
1109 * ClassName:tearDown(Class) - traces specific teardown functions
1110 * ClassName:_run_cleanups - traces the cleanup functions
1111
1112If nothing is specified, this feature is not enabled. To trace everything
1113specify .* as the regex.
1114""")
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001115]
1116
Andrea Frittolif5da28b2013-12-06 07:08:07 +00001117input_scenario_group = cfg.OptGroup(name="input-scenario",
1118 title="Filters and values for"
1119 " input scenarios")
1120
1121InputScenarioGroup = [
1122 cfg.StrOpt('image_regex',
1123 default='^cirros-0.3.1-x86_64-uec$',
1124 help="Matching images become parameters for scenario tests"),
1125 cfg.StrOpt('flavor_regex',
Andrea Frittoli99901c02014-01-30 18:06:49 +00001126 default='^m1.nano$',
Andrea Frittolif5da28b2013-12-06 07:08:07 +00001127 help="Matching flavors become parameters for scenario tests"),
1128 cfg.StrOpt('non_ssh_image_regex',
1129 default='^.*[Ww]in.*$',
1130 help="SSH verification in tests is skipped"
1131 "for matching images"),
1132 cfg.StrOpt('ssh_user_regex',
Marc Koderer07f5a522015-03-27 15:02:41 +01001133 default="[[\"^.*[Cc]irros.*$\", \"cirros\"]]",
Andrea Frittolif5da28b2013-12-06 07:08:07 +00001134 help="List of user mapped to regex "
1135 "to matching image names."),
1136]
1137
Attila Fazekasaeeeefd2013-08-06 17:01:56 +02001138
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001139baremetal_group = cfg.OptGroup(name='baremetal',
Chris Hoge8f1401b2014-11-19 14:00:37 -08001140 title='Baremetal provisioning service options',
1141 help='When enabling baremetal tests, Nova '
1142 'must be configured to use the Ironic '
Shuquan Huang33376522015-08-27 11:20:50 +00001143 'driver. The following parameters for the '
Chris Hoge8f1401b2014-11-19 14:00:37 -08001144 '[compute] section must be disabled: '
1145 'console_output, interface_attach, '
1146 'live_migration, pause, rescue, resize '
1147 'shelve, snapshot, and suspend')
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001148
Devananda van der Veenf385bde2016-02-03 07:56:01 -08001149
1150# NOTE(deva): Ironic tests have been ported to tempest-lib. New config options
1151# should be added to ironic/ironic_tempest_plugin/config.py.
1152# However, these options need to remain here for testing stable
1153# branches until Liberty release reaches EOL.
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001154BaremetalGroup = [
1155 cfg.StrOpt('catalog_type',
1156 default='baremetal',
Adam Gandelman4a48a602014-03-20 18:23:18 -07001157 help="Catalog type of the baremetal provisioning service"),
1158 cfg.BoolOpt('driver_enabled',
1159 default=False,
1160 help="Whether the Ironic nova-compute driver is enabled"),
Yuiko Takada1ee1b322014-07-04 09:55:30 +09001161 cfg.StrOpt('driver',
1162 default='fake',
1163 help="Driver name which Ironic uses"),
JordanPfc62c902014-02-26 14:47:28 +00001164 cfg.StrOpt('endpoint_type',
1165 default='publicURL',
1166 choices=['public', 'admin', 'internal',
1167 'publicURL', 'adminURL', 'internalURL'],
1168 help="The endpoint type to use for the baremetal provisioning "
Adam Gandelman4a48a602014-03-20 18:23:18 -07001169 "service"),
1170 cfg.IntOpt('active_timeout',
1171 default=300,
1172 help="Timeout for Ironic node to completely provision"),
1173 cfg.IntOpt('association_timeout',
Adam Gandelmane42f0922014-06-10 15:26:37 -07001174 default=30,
Adam Gandelman4a48a602014-03-20 18:23:18 -07001175 help="Timeout for association of Nova instance and Ironic "
1176 "node"),
1177 cfg.IntOpt('power_timeout',
Adam Gandelmane42f0922014-06-10 15:26:37 -07001178 default=60,
Adam Gandelman4a48a602014-03-20 18:23:18 -07001179 help="Timeout for Ironic power transitions."),
1180 cfg.IntOpt('unprovision_timeout',
Devananda van der Veend1e52a92015-04-13 12:58:49 -07001181 default=300,
1182 help="Timeout for unprovisioning an Ironic node. "
1183 "Takes longer since Kilo as Ironic performs an extra "
1184 "step in Node cleaning.")
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001185]
1186
Marc Koderer6ee82dc2014-02-17 10:26:29 +01001187negative_group = cfg.OptGroup(name='negative', title="Negative Test Options")
1188
1189NegativeGroup = [
1190 cfg.StrOpt('test_generator',
1191 default='tempest.common.' +
1192 'generator.negative_generator.NegativeTestGenerator',
1193 help="Test generator class for all negative tests"),
1194]
1195
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001196DefaultGroup = [
1197 cfg.StrOpt('resources_prefix',
1198 default='tempest',
1199 help="Prefix to be added when generating the name for "
1200 "test resources. It can be used to discover all "
1201 "resources associated with a specific test run when "
1202 "running tempest on a real-life cloud"),
1203]
1204
Jon Grimm270bd7f2014-08-05 18:11:29 +00001205_opts = [
1206 (auth_group, AuthGroup),
1207 (compute_group, ComputeGroup),
1208 (compute_features_group, ComputeFeaturesGroup),
1209 (identity_group, IdentityGroup),
1210 (identity_feature_group, IdentityFeatureGroup),
1211 (image_group, ImageGroup),
1212 (image_feature_group, ImageFeaturesGroup),
1213 (network_group, NetworkGroup),
1214 (network_feature_group, NetworkFeaturesGroup),
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001215 (validation_group, ValidationGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001216 (volume_group, VolumeGroup),
1217 (volume_feature_group, VolumeFeaturesGroup),
1218 (object_storage_group, ObjectStoreGroup),
1219 (object_storage_feature_group, ObjectStoreFeaturesGroup),
1220 (database_group, DatabaseGroup),
1221 (orchestration_group, OrchestrationGroup),
1222 (telemetry_group, TelemetryGroup),
gordon chungee23ddb2015-02-11 20:05:07 -05001223 (telemetry_feature_group, TelemetryFeaturesGroup),
liu-sheng67b730e2015-07-16 15:19:33 +08001224 (alarming_group, AlarmingGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001225 (dashboard_group, DashboardGroup),
1226 (data_processing_group, DataProcessingGroup),
Luigi Toscano14d172d2015-01-23 16:37:47 +01001227 (data_processing_feature_group, DataProcessingFeaturesGroup),
Jon Grimm270bd7f2014-08-05 18:11:29 +00001228 (stress_group, StressGroup),
1229 (scenario_group, ScenarioGroup),
1230 (service_available_group, ServiceAvailableGroup),
1231 (debug_group, DebugGroup),
1232 (baremetal_group, BaremetalGroup),
1233 (input_scenario_group, InputScenarioGroup),
Andrea Frittoli (andreaf)8def7ca2015-05-13 14:24:19 +01001234 (negative_group, NegativeGroup),
1235 (None, DefaultGroup)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001236]
1237
Roman Prykhodchenko62b1ed12013-10-16 21:51:47 +03001238
Matthew Treinish43b296a2014-02-28 15:23:00 -05001239def register_opts():
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001240 ext_plugins = plugins.TempestTestPluginManager()
1241 # Register in-tree tempest config options
Jon Grimm270bd7f2014-08-05 18:11:29 +00001242 for g, o in _opts:
Maru Newbyf440c292015-03-31 15:58:47 +00001243 register_opt_group(_CONF, g, o)
Matthew Treinisha966d0f2015-07-01 17:37:31 -04001244 # Call external plugin config option registration
1245 ext_plugins.register_plugin_opts(_CONF)
Jon Grimm270bd7f2014-08-05 18:11:29 +00001246
1247
1248def list_opts():
1249 """Return a list of oslo.config options available.
1250
1251 The purpose of this is to allow tools like the Oslo sample config file
1252 generator to discover the options exposed to users.
1253 """
Matthew Treinish83a19aa2015-07-23 13:06:13 -04001254 ext_plugins = plugins.TempestTestPluginManager()
Chris Hoged7b4fd12015-11-11 10:24:52 -08001255 # Make a shallow copy of the options list that can be
1256 # extended by plugins. Send back the group object
1257 # to allow group help text to be generated.
1258 opt_list = [(g, o) for g, o in _opts]
Matthew Treinish83a19aa2015-07-23 13:06:13 -04001259 opt_list.extend(ext_plugins.get_plugin_options_list())
1260 return opt_list
Matthew Treinish43b296a2014-02-28 15:23:00 -05001261
1262
Sean Dague3b9b1f32013-12-20 17:04:54 -05001263# this should never be called outside of this class
1264class TempestConfigPrivate(object):
Daryl Walleck1465d612011-11-02 02:22:15 -05001265 """Provides OpenStack configuration information."""
1266
David Patersonbe9f9832015-10-15 09:10:45 -07001267 DEFAULT_CONFIG_DIR = os.path.join(os.getcwd(), "etc")
Daryl Walleck1465d612011-11-02 02:22:15 -05001268
Brian Waldon738cd632011-12-12 18:45:09 -05001269 DEFAULT_CONFIG_FILE = "tempest.conf"
1270
Andrea Frittolia96ee212014-08-15 18:34:20 +01001271 def __getattr__(self, attr):
1272 # Handles config options from the default group
Maru Newbyf440c292015-03-31 15:58:47 +00001273 return getattr(_CONF, attr)
Andrea Frittolia96ee212014-08-15 18:34:20 +01001274
Matthew Treinish43b296a2014-02-28 15:23:00 -05001275 def _set_attrs(self):
Maru Newbyf440c292015-03-31 15:58:47 +00001276 self.auth = _CONF.auth
1277 self.compute = _CONF.compute
1278 self.compute_feature_enabled = _CONF['compute-feature-enabled']
1279 self.identity = _CONF.identity
1280 self.identity_feature_enabled = _CONF['identity-feature-enabled']
1281 self.image = _CONF.image
1282 self.image_feature_enabled = _CONF['image-feature-enabled']
1283 self.network = _CONF.network
1284 self.network_feature_enabled = _CONF['network-feature-enabled']
Joseph Lanoux2f81cc12015-01-12 16:01:20 +00001285 self.validation = _CONF.validation
Maru Newbyf440c292015-03-31 15:58:47 +00001286 self.volume = _CONF.volume
1287 self.volume_feature_enabled = _CONF['volume-feature-enabled']
1288 self.object_storage = _CONF['object-storage']
1289 self.object_storage_feature_enabled = _CONF[
Matthew Treinishd5c96022013-10-17 21:51:23 +00001290 'object-storage-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001291 self.database = _CONF.database
1292 self.orchestration = _CONF.orchestration
Maru Newbyf440c292015-03-31 15:58:47 +00001293 self.telemetry = _CONF.telemetry
gordon chungee23ddb2015-02-11 20:05:07 -05001294 self.telemetry_feature_enabled = _CONF['telemetry-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001295 self.dashboard = _CONF.dashboard
Telles Nobrega6189b0a2014-11-18 23:22:17 -03001296 self.data_processing = _CONF['data-processing']
Maru Newbyf440c292015-03-31 15:58:47 +00001297 self.data_processing_feature_enabled = _CONF[
Telles Nobrega6189b0a2014-11-18 23:22:17 -03001298 'data-processing-feature-enabled']
Maru Newbyf440c292015-03-31 15:58:47 +00001299 self.stress = _CONF.stress
1300 self.scenario = _CONF.scenario
1301 self.service_available = _CONF.service_available
1302 self.debug = _CONF.debug
1303 self.baremetal = _CONF.baremetal
1304 self.input_scenario = _CONF['input-scenario']
Maru Newbyf440c292015-03-31 15:58:47 +00001305 self.negative = _CONF.negative
David Kranz87fc7e92015-07-28 14:05:20 -04001306 _CONF.set_default('domain_name',
1307 self.auth.default_credentials_domain_name,
Maru Newbyf440c292015-03-31 15:58:47 +00001308 group='identity')
David Kranz87fc7e92015-07-28 14:05:20 -04001309 _CONF.set_default('alt_domain_name',
1310 self.auth.default_credentials_domain_name,
Maru Newbyf440c292015-03-31 15:58:47 +00001311 group='identity')
Matthew Treinish46008082015-04-14 18:32:47 -04001312 logging.tempest_set_log_file('tempest.log')
Sean Dague86bd8422013-12-20 09:56:44 -05001313
Joe Gordon28a84ae2014-07-17 15:38:28 +00001314 def __init__(self, parse_conf=True, config_path=None):
Matthew Treinish43b296a2014-02-28 15:23:00 -05001315 """Initialize a configuration from a conf directory and conf file."""
1316 super(TempestConfigPrivate, self).__init__()
1317 config_files = []
1318 failsafe_path = "/etc/tempest/" + self.DEFAULT_CONFIG_FILE
1319
Joe Gordon28a84ae2014-07-17 15:38:28 +00001320 if config_path:
1321 path = config_path
1322 else:
1323 # Environment variables override defaults...
1324 conf_dir = os.environ.get('TEMPEST_CONFIG_DIR',
1325 self.DEFAULT_CONFIG_DIR)
1326 conf_file = os.environ.get('TEMPEST_CONFIG',
1327 self.DEFAULT_CONFIG_FILE)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001328
Joe Gordon28a84ae2014-07-17 15:38:28 +00001329 path = os.path.join(conf_dir, conf_file)
Matthew Treinish43b296a2014-02-28 15:23:00 -05001330
1331 if not os.path.isfile(path):
1332 path = failsafe_path
1333
1334 # only parse the config file if we expect one to exist. This is needed
1335 # to remove an issue with the config file up to date checker.
1336 if parse_conf:
1337 config_files.append(path)
Maru Newbyf440c292015-03-31 15:58:47 +00001338 logging.register_options(_CONF)
Matthew Treinish5440a402014-10-02 14:36:16 -04001339 if os.path.isfile(path):
Maru Newbyf440c292015-03-31 15:58:47 +00001340 _CONF([], project='tempest', default_config_files=config_files)
Matthew Treinish5440a402014-10-02 14:36:16 -04001341 else:
Maru Newbyf440c292015-03-31 15:58:47 +00001342 _CONF([], project='tempest')
Marc Kodererc81c7672015-12-17 12:10:12 +01001343
1344 logging_cfg_path = "%s/logging.conf" % os.path.dirname(path)
Tom Patzige6f7c7d2016-02-17 16:46:11 +01001345 if ((not hasattr(_CONF, 'log_config_append') or
1346 _CONF.log_config_append is None) and
Marc Kodererc81c7672015-12-17 12:10:12 +01001347 os.path.isfile(logging_cfg_path)):
1348 # if logging conf is in place we need to set log_config_append
1349 _CONF.log_config_append = logging_cfg_path
1350
Maru Newbyf440c292015-03-31 15:58:47 +00001351 logging.setup(_CONF, 'tempest')
Matthew Treinish43b296a2014-02-28 15:23:00 -05001352 LOG = logging.getLogger('tempest')
1353 LOG.info("Using tempest config file %s" % path)
1354 register_opts()
1355 self._set_attrs()
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001356 if parse_conf:
Maru Newbyf440c292015-03-31 15:58:47 +00001357 _CONF.log_opt_values(LOG, std_logging.DEBUG)
Masayuki Igawa9ec4cd82014-02-05 15:04:16 +09001358
Sean Dague86bd8422013-12-20 09:56:44 -05001359
1360class TempestConfigProxy(object):
1361 _config = None
Joe Gordon28a84ae2014-07-17 15:38:28 +00001362 _path = None
Sean Dague86bd8422013-12-20 09:56:44 -05001363
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001364 _extra_log_defaults = [
Doug Hellmann583ce2c2015-03-11 14:55:46 +00001365 ('paramiko.transport', std_logging.INFO),
1366 ('requests.packages.urllib3.connectionpool', std_logging.WARN),
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001367 ]
1368
1369 def _fix_log_levels(self):
1370 """Tweak the oslo log defaults."""
Doug Hellmann583ce2c2015-03-11 14:55:46 +00001371 for name, level in self._extra_log_defaults:
1372 std_logging.getLogger(name).setLevel(level)
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001373
Sean Dague86bd8422013-12-20 09:56:44 -05001374 def __getattr__(self, attr):
1375 if not self._config:
Sean Daguedb6ac6c2014-06-06 16:52:44 -04001376 self._fix_log_levels()
Matthew Treinishaa29c7e2015-04-23 16:35:09 -04001377 lock_dir = os.path.join(tempfile.gettempdir(), 'tempest-lock')
1378 lockutils.set_defaults(lock_dir)
Joe Gordon28a84ae2014-07-17 15:38:28 +00001379 self._config = TempestConfigPrivate(config_path=self._path)
Sean Dague86bd8422013-12-20 09:56:44 -05001380
1381 return getattr(self._config, attr)
1382
Joe Gordon28a84ae2014-07-17 15:38:28 +00001383 def set_config_path(self, path):
1384 self._path = path
1385
Sean Dague86bd8422013-12-20 09:56:44 -05001386
1387CONF = TempestConfigProxy()