Coverage for tempest/config.py : 92%

# Copyright 2012 OpenStack Foundation 

# All Rights Reserved. 

# 

# Licensed under the Apache License, Version 2.0 (the "License"); you may 

# not use this file except in compliance with the License. You may obtain 

# a copy of the License at 

# 

# http://www.apache.org/licenses/LICENSE-2.0 

# 

# Unless required by applicable law or agreed to in writing, software 

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 

# License for the specific language governing permissions and limitations 

# under the License. 

from __future__ import print_function 

import os 

import tempfile 

from oslo_concurrency import lockutils 

from oslo_config import cfg 

from oslo_config import types 

from oslo_log import log as logging 

from tempest.lib import exceptions 

from tempest.lib.services import clients 

from tempest.test_discover import plugins 

# TODO(marun) Replace use of oslo_config's global ConfigOpts 

# (cfg.CONF) instance with a local instance (cfg.ConfigOpts()) once 

# the cli tests move to the clients. The cli tests rely on oslo 

# incubator modules that use the global cfg.CONF. 

_CONF = cfg.CONF 

def register_opt_group(conf, opt_group, options): 

if opt_group: 

conf.register_group(opt_group) 

for opt in options: 

conf.register_opt(opt, group=getattr(opt_group, 'name', None)) 

auth_group = cfg.OptGroup(name='auth', 

title="Options for authentication and credentials") 

AuthGroup = [ 

cfg.StrOpt('test_accounts_file', 

help="Path to the yaml file that contains the list of " 

"credentials to use for running tests. If used when " 

"running in parallel you have to make sure sufficient " 

"credentials are provided in the accounts file. For " 

"example if no tests with roles are being run it requires " 

"at least `2 * CONC` distinct accounts configured in " 

" the `test_accounts_file`, with CONC == the " 

"number of concurrent test processes."), 

cfg.BoolOpt('use_dynamic_credentials', 

default=True, 

help="Allows test cases to create/destroy projects and " 

"users. This option requires that OpenStack Identity " 

"API admin credentials are known. If false, isolated " 

"test cases and parallel execution, can still be " 

"achieved configuring a list of test accounts"), 

cfg.ListOpt('tempest_roles', 

help="Roles to assign to all users created by tempest", 

default=[]), 

cfg.StrOpt('default_credentials_domain_name', 

default='Default', 

help="Default domain used when getting v3 credentials. " 

"This is the name keystone uses for v2 compatibility."), 

cfg.BoolOpt('create_isolated_networks', 

default=True, 

help="If use_dynamic_credentials is set to True and Neutron " 

"is enabled Tempest will try to create a usable network, " 

"subnet, and router when needed for each project it " 

"creates. However in some neutron configurations, like " 

"with VLAN provider networks, this doesn't work. So if " 

"set to False the isolated networks will not be created"), 

cfg.StrOpt('admin_username', 

help="Username for an administrative user. This is needed for " 

"authenticating requests made by project isolation to " 

"create users and projects"), 

cfg.StrOpt('admin_project_name', 

help="Project name to use for an administrative user. This is " 

"needed for authenticating requests made by project " 

"isolation to create users and projects"), 

cfg.StrOpt('admin_password', 

help="Password to use for an administrative user. This is " 

"needed for authenticating requests made by project " 

"isolation to create users and projects", 

secret=True), 

cfg.StrOpt('admin_domain_name', 

default='Default', 

help="Admin domain name for authentication (Keystone V3). " 

"The same domain applies to user and project"), 

] 

identity_group = cfg.OptGroup(name='identity', 

title="Keystone Configuration Options") 

IdentityGroup = [ 

cfg.StrOpt('catalog_type', 

default='identity', 

help="Catalog type of the Identity service."), 

cfg.BoolOpt('disable_ssl_certificate_validation', 

default=False, 

help="Set to True if using self-signed SSL certificates."), 

cfg.StrOpt('ca_certificates_file', 

default=None, 

help='Specify a CA bundle file to use in verifying a ' 

'TLS (https) server certificate.'), 

cfg.StrOpt('uri', 

help="Full URI of the OpenStack Identity API (Keystone), v2"), 

cfg.StrOpt('uri_v3', 

help='Full URI of the OpenStack Identity API (Keystone), v3'), 

cfg.StrOpt('auth_version', 

default='v3', 

help="Identity API version to be used for authentication " 

"for API tests."), 

cfg.StrOpt('region', 

default='RegionOne', 

help="The identity region name to use. Also used as the other " 

"services' region name unless they are set explicitly. " 

"If no such region is found in the service catalog, the " 

"first found one is used."), 

cfg.StrOpt('v2_admin_endpoint_type', 

default='adminURL', 

choices=['public', 'admin', 'internal', 

'publicURL', 'adminURL', 'internalURL'], 

help="The admin endpoint type to use for OpenStack Identity " 

"(Keystone) API v2"), 

cfg.StrOpt('v2_public_endpoint_type', 

default='publicURL', 

choices=['public', 'admin', 'internal', 

'publicURL', 'adminURL', 'internalURL'], 

help="The public endpoint type to use for OpenStack Identity " 

"(Keystone) API v2"), 

cfg.StrOpt('v3_endpoint_type', 

default='adminURL', 

choices=['public', 'admin', 'internal', 

'publicURL', 'adminURL', 'internalURL'], 

help="The endpoint type to use for OpenStack Identity " 

"(Keystone) API v3. The default value adminURL is " 

"deprecated and will be modified to publicURL in " 

"the next release."), 

cfg.StrOpt('admin_role', 

default='admin', 

help="Role required to administrate keystone."), 

cfg.StrOpt('default_domain_id', 

default='default', 

help="ID of the default domain"), 

cfg.BoolOpt('admin_domain_scope', 

default=False, 

help="Whether keystone identity v3 policy required " 

"a domain scoped token to use admin APIs"), 

# Security Compliance (PCI-DSS) 

cfg.IntOpt('user_lockout_failure_attempts', 

default=2, 

help="The number of unsuccessful login attempts the user is " 

"allowed before having the account locked. This only " 

"takes effect when identity-feature-enabled." 

"security_compliance is set to 'True'. For more details, " 

"refer to keystone config options keystone.conf:" 

"security_compliance.lockout_failure_attempts. " 

"This feature is disabled by default in keystone."), 

cfg.IntOpt('user_lockout_duration', 

default=5, 

help="The number of seconds a user account will remain " 

"locked. This only takes " 

"effect when identity-feature-enabled.security_compliance " 

"is set to 'True'. For more details, refer to " 

"keystone config options " 

"keystone.conf:security_compliance.lockout_duration. " 

"Setting this option will have no effect unless you also " 

"set identity.user_lockout_failure_attempts."), 

cfg.IntOpt('user_unique_last_password_count', 

default=2, 

help="The number of passwords for a user that must be unique " 

"before an old password can be reused. This only takes " 

"effect when identity-feature-enabled.security_compliance " 

"is set to 'True'. " 

"This config option corresponds to keystone.conf: " 

"security_compliance.unique_last_password_count, whose " 

"default value is 0 meaning disabling this feature. " 

"NOTE: This config option value must be same as " 

"keystone.conf: security_compliance.unique_last_password_" 

"count otherwise test might fail" 

), 

] 

service_clients_group = cfg.OptGroup(name='service-clients', 

title="Service Clients Options") 

ServiceClientsGroup = [ 

cfg.IntOpt('http_timeout', 

default=60, 

help='Timeout in seconds to wait for the http request to ' 

'return'), 

cfg.StrOpt('proxy_url', 

help='Specify an http proxy to use.') 

] 

identity_feature_group = cfg.OptGroup(name='identity-feature-enabled', 

title='Enabled Identity Features') 

IdentityFeatureGroup = [ 

cfg.BoolOpt('trust', 

default=True, 

help='Does the identity service have delegation and ' 

'impersonation enabled'), 

cfg.BoolOpt('api_v2', 

default=False, 

help='Is the v2 identity API enabled', 

deprecated_for_removal=True, 

deprecated_reason='The identity v2.0 API was removed in the ' 

'Queens release. Tests that exercise the ' 

'v2.0 API will be removed from tempest in ' 

'the v22.0.0 release. They are kept only to ' 

'test stable branches.'), 

cfg.BoolOpt('api_v2_admin', 

default=True, 

help="Is the v2 identity admin API available? This setting " 

"only applies if api_v2 is set to True."), 

cfg.BoolOpt('api_v3', 

default=True, 

help='Is the v3 identity API enabled'), 

cfg.ListOpt('api_extensions', 

default=['all'], 

help="A list of enabled identity extensions with a special " 

"entry all which indicates every extension is enabled. " 

"Empty list indicates all extensions are disabled. " 

"To get the list of extensions run: " 

"'openstack extension list --identity'"), 

cfg.BoolOpt('domain_specific_drivers', 

default=False, 

help='Are domain specific drivers enabled? ' 

'This configuration value should be same as ' 

'[identity]->domain_specific_drivers_enabled ' 

'in keystone.conf.'), 

cfg.BoolOpt('security_compliance', 

default=False, 

help='Does the environment have the security compliance ' 

'settings enabled?'), 

cfg.BoolOpt('project_tags', 

default=False, 

help='Is the project tags identity v3 API available?'), 

# Application credentials is a default feature in Queens. This config 

# option can removed once Pike is EOL. 

cfg.BoolOpt('application_credentials', 

default=False, 

help='Does the environment have application credentials ' 

'enabled?'), 

cfg.BoolOpt('immutable_user_source', 

default=False, 

help='Set to True if the environment has a read-only ' 

'user source. This will skip all tests that attempt to ' 

'create, delete, or modify users. This should not be set ' 

'to True if using dynamic credentials') 

] 

compute_group = cfg.OptGroup(name='compute', 

title='Compute Service Options') 

ComputeGroup = [ 

cfg.StrOpt('image_ref', 

help="Valid primary image reference to be used in tests. " 

"This is a required option"), 

cfg.StrOpt('image_ref_alt', 

help="Valid secondary image reference to be used in tests. " 

"This is a required option, but if only one image is " 

"available duplicate the value of image_ref above"), 

cfg.StrOpt('certified_image_ref', 

help="Valid image reference to be used in image certificate " 

"validation tests when enabled. This image must also " 

"have the required img_signature_* properties set. " 

"Additional details available within the following Nova " 

"documentation: https://docs.openstack.org/nova/latest/" 

"user/certificate-validation.html"), 

cfg.ListOpt('certified_image_trusted_certs', 

help="A list of trusted certificates to be used when the " 

"image certificate validation compute feature is " 

"enabled."), 

cfg.StrOpt('flavor_ref', 

default="1", 

help="Valid primary flavor to use in tests."), 

cfg.StrOpt('flavor_ref_alt', 

default="2", 

help='Valid secondary flavor to be used in tests.'), 

cfg.IntOpt('build_interval', 

default=1, 

help="Time in seconds between build status checks."), 

cfg.IntOpt('build_timeout', 

default=300, 

help="Timeout in seconds to wait for an instance to build. " 

"Other services that do not define build_timeout will " 

"inherit this value."), 

cfg.IntOpt('ready_wait', 

default=0, 

help="Additional wait time for clean state, when there is " 

"no OS-EXT-STS extension available"), 

cfg.StrOpt('fixed_network_name', 

help="Name of the fixed network that is visible to all test " 

"projects. If multiple networks are available for a " 

"project, this is the network which will be used for " 

"creating servers if tempest does not create a network or " 

"a network is not specified elsewhere. It may be used for " 

"ssh validation only if floating IPs are disabled."), 

cfg.StrOpt('catalog_type', 

default='compute', 

help="Catalog type of the Compute service."), 

cfg.StrOpt('region', 

default='', 

help="The compute region name to use. If empty, the value " 

"of identity.region is used instead. If no such region " 

"is found in the service catalog, the first found one is " 

"used."), 

cfg.StrOpt('endpoint_type', 

default='publicURL', 

choices=['public', 'admin', 'internal', 

'publicURL', 'adminURL', 'internalURL'], 

help="The endpoint type to use for the compute service."), 

cfg.StrOpt('volume_device_name', 

default='vdb', 

help="Expected device name when a volume is attached to " 

"an instance. Not all hypervisors guarantee that they " 

"will respect the user defined device name, tests may " 

"fail if inappropriate device name is set."), 

cfg.IntOpt('shelved_offload_time', 

default=0, 

help='Time in seconds before a shelved instance is eligible ' 

'for removing from a host. -1 never offload, 0 offload ' 

'when shelved. This configuration value should be same as ' 

'nova.conf: DEFAULT.shelved_offload_time, and ' 

'some tests will run for as long as the time.'), 

cfg.IntOpt('min_compute_nodes', 

default=1, 

help=('The minimum number of compute nodes expected. This will ' 

'be utilized by some multinode specific tests to ensure ' 

'that requests match the expected size of the cluster ' 

'you are testing with.')), 

cfg.StrOpt('hypervisor_type', 

default=None, 

help="Hypervisor type of the test target on heterogeneous " 

"compute environment. The value can be 'QEMU', 'xen' or " 

"something."), 

cfg.StrOpt('min_microversion', 

default=None, 

help="Lower version of the test target microversion range. " 

"The format is 'X.Y', where 'X' and 'Y' are int values. " 

"Tempest selects tests based on the range between " 

"min_microversion and max_microversion. " 

"If both values are not specified, Tempest avoids tests " 

"which require a microversion. Valid values are string " 

"with format 'X.Y' or string 'latest'"), 

cfg.StrOpt('max_microversion', 

default=None, 

help="Upper version of the test target microversion range. " 

"The format is 'X.Y', where 'X' and 'Y' are int values. " 

"Tempest selects tests based on the range between " 

"min_microversion and max_microversion. " 

"If both values are not specified, Tempest avoids tests " 

"which require a microversion. Valid values are string " 

"with format 'X.Y' or string 'latest'"), 

cfg.StrOpt('compute_volume_common_az', 

default=None, 

help='AZ to be used for Cinder and Nova. Set this parameter ' 

'when the cloud has nova.conf: cinder.cross_az_attach ' 

'set to false. Which means volumes attached to an ' 

'instance must be in the same availability zone in Cinder ' 

'as the instance availability zone in Nova. Set the ' 

'common availability zone in this config which will be ' 

'used to boot an instance as well as creating a volume. ' 

'NOTE: If that AZ is not in Cinder (or ' 

'allow_availability_zone_fallback=False in cinder.conf), ' 

'the volume create request will fail and the instance ' 

'will fail the build request.'), 

] 

placement_group = cfg.OptGroup(name='placement', 

title='Placement Service Options') 

PlacementGroup = [ 

cfg.StrOpt('endpoint_type', 

default='public', 

choices=['public', 'admin', 'internal'], 

help="The endpoint type to use for the placement service."), 

cfg.StrOpt('catalog_type', 

default='placement', 

help="Catalog type of the Placement service."), 

cfg.StrOpt('region', 

default='RegionOne', 

help="The placement region name to use. If empty, the value " 

"of [identity]/region is used instead. If no such region " 

"is found in the service catalog, the first region found " 

"is used."), 

cfg.StrOpt('min_microversion', 

default=None, 

help="Lower version of the test target microversion range. " 

"The format is 'X.Y', where 'X' and 'Y' are int values. " 

"Valid values are string with format 'X.Y' or string " 

"'latest'"), 

cfg.StrOpt('max_microversion', 

default=None, 

help="Upper version of the test target microversion range. " 

"The format is 'X.Y', where 'X' and 'Y' are int values. " 

"Valid values are string with format 'X.Y' or string " 

"'latest'"), 

] 

compute_features_group = cfg.OptGroup(name='compute-feature-enabled', 

title="Enabled Compute Service Features") 

ComputeFeaturesGroup = [ 

cfg.BoolOpt('disk_config', 

default=True, 

help="If false, skip disk config tests"), 

cfg.ListOpt('api_extensions', 

default=['all'], 

help='A list of enabled compute extensions with a special ' 

'entry all which indicates every extension is enabled. ' 

'Each extension should be specified with alias name. ' 

'Empty list indicates all extensions are disabled', 

deprecated_for_removal=True, 

deprecated_reason='The Nova extensions API and mechanism ' 

'is deprecated. This option will be ' 

'removed when all releases supported ' 

'by tempest no longer contain the Nova ' 

'extensions API and mechanism.'), 

cfg.BoolOpt('change_password', 

default=False, 

help="Does the test environment support changing the admin " 

"password?"), 

cfg.BoolOpt('console_output', 

default=True, 

help="Does the test environment support obtaining instance " 

"serial console output?"), 

cfg.BoolOpt('resize', 

default=False, 

help="Does the test environment support resizing? When you " 

"enable this feature, 'flavor_ref_alt' should be set and " 

"it should refer to a larger flavor than 'flavor_ref' " 

"one."), 

cfg.BoolOpt('pause', 

default=True, 

help="Does the test environment support pausing?"), 

cfg.BoolOpt('shelve', 

default=True, 

help="Does the test environment support shelving/unshelving?"), 

cfg.BoolOpt('suspend', 

default=True, 

help="Does the test environment support suspend/resume?"), 

cfg.BoolOpt('cold_migration', 

default=True, 

help="Does the test environment support cold migration?"), 

cfg.BoolOpt('live_migration', 

default=True, 

help="Does the test environment support live migration?"), 

cfg.BoolOpt('live_migrate_back_and_forth', 

default=False, 

help="Does the test environment support live migrating " 

"VM back and forth between different versions of " 

"nova-compute?"), 

cfg.BoolOpt('metadata_service', 

default=True, 

help="Does the test environment support metadata service? " 

"Ignored unless validation.run_validation=true."), 

cfg.BoolOpt('block_migration_for_live_migration', 

default=False, 

help="Does the test environment use block devices for live " 

"migration"), 

cfg.BoolOpt('block_migrate_cinder_iscsi', 

default=False, 

help="Does the test environment support block migration with " 

"Cinder iSCSI volumes. Note: libvirt >= 1.2.17 is required " 

"to support this if using the libvirt compute driver."), 

cfg.BoolOpt('vnc_console', 

default=False, 

help='Enable VNC console. This configuration value should ' 

'be same as nova.conf: vnc.enabled'), 

cfg.StrOpt('vnc_server_header', 

default='WebSockify', 

help='Expected VNC server name (WebSockify, nginx, etc) ' 

'in response header.'), 

cfg.BoolOpt('spice_console', 

default=False, 

help='Enable Spice console. This configuration value should ' 

'be same as nova.conf: spice.enabled'), 

cfg.BoolOpt('rdp_console', 

default=False, 

help='Enable RDP console. This configuration value should ' 

'be same as nova.conf: rdp.enabled'), 

cfg.BoolOpt('serial_console', 

default=False, 

help='Enable serial console. This configuration value ' 

'should be the same as ' 

'nova.conf: serial_console.enabled'), 

cfg.BoolOpt('rescue', 

default=True, 

help='Does the test environment support instance rescue ' 

'mode?'), 

cfg.BoolOpt('enable_instance_password', 

default=True, 

help='Enables returning of the instance password by the ' 

'relevant server API calls such as create, rebuild ' 

'or rescue. This configuration value should be same as ' 

'nova.conf: DEFAULT.enable_instance_password'), 

cfg.BoolOpt('interface_attach', 

default=True, 

help='Does the test environment support dynamic network ' 

'interface attachment?'), 

cfg.BoolOpt('snapshot', 

default=True, 

help='Does the test environment support creating snapshot ' 

'images of running instances?'), 

cfg.BoolOpt('nova_cert', 

default=False, 

help='Does the test environment have the nova cert running?', 

deprecated_for_removal=True, 

deprecated_reason="On Nova side, the nova-cert service is " 

"deprecated and the service will be removed " 

"as early as Ocata."), 

cfg.BoolOpt('personality', 

default=False, 

help='Does the test environment support server personality'), 

cfg.BoolOpt('attach_encrypted_volume', 

default=True, 

help='Does the test environment support attaching an ' 

'encrypted volume to a running server instance? This may ' 

'depend on the combination of compute_driver in nova and ' 

'the volume_driver(s) in cinder.'), 

cfg.BoolOpt('config_drive', 

default=True, 

help='Enable special configuration drive with metadata.'), 

cfg.ListOpt('scheduler_enabled_filters', 

default=["AvailabilityZoneFilter", "ComputeFilter", 

"ComputeCapabilitiesFilter", "ImagePropertiesFilter", 

"ServerGroupAntiAffinityFilter", 

"ServerGroupAffinityFilter"], 

help="A list of enabled filters that Nova will accept as " 

"hints to the scheduler when creating a server. If the " 

"default value is overridden in nova.conf by the test " 

"environment (which means that a different set of " 

"filters is enabled than what is included in Nova by " 

"default), then this option must be configured to " 

"contain the same filters that Nova uses in the test " 

"environment. A special entry 'all' indicates all " 

"filters that are included with Nova are enabled. If " 

"using 'all', be sure to enable all filters in " 

"nova.conf, as tests can fail in unpredictable ways if " 

"Nova's and Tempest's enabled filters don't match. " 

"Empty list indicates all filters are disabled. The " 

"full list of enabled filters is in nova.conf: " 

"filter_scheduler.enabled_filters.", 

deprecated_opts=[cfg.DeprecatedOpt( 

'scheduler_available_filters', 

group='compute-feature-enabled')]), 

cfg.BoolOpt('swap_volume', 

default=False, 

help='Does the test environment support in-place swapping of ' 

'volumes attached to a server instance?'), 

cfg.BoolOpt('volume_backed_live_migration', 

default=False, 

help='Does the test environment support volume-backed live ' 

'migration?'), 

cfg.BoolOpt('volume_multiattach', 

default=False, 

help='Does the test environment support attaching a volume to ' 

'more than one instance? This depends on hypervisor and ' 

'volume backend/type and compute API version 2.60.'), 

] 

image_group = cfg.OptGroup(name='image', 

title="Image Service Options") 

ImageGroup = [ 

cfg.StrOpt('catalog_type', 

default='image', 

help='Catalog type of the Image service.'), 

cfg.StrOpt('region', 

default='', 

help="The image region name to use. If empty, the value " 

"of identity.region is used instead. If no such region " 

"is found in the service catalog, the first found one is " 

"used."), 

cfg.StrOpt('endpoint_type', 

default='publicURL', 

choices=['public', 'admin', 'internal', 

'publicURL', 'adminURL', 'internalURL'], 

help="The endpoint type to use for the image service."), 

cfg.StrOpt('http_image', 

default='http://download.cirros-cloud.net/0.3.1/' 

'cirros-0.3.1-x86_64-uec.tar.gz', 

help='http accessible image'), 

cfg.IntOpt('build_timeout', 

default=300, 

help="Timeout in seconds to wait for an image to " 

"become available."), 

cfg.IntOpt('build_interval', 

default=1, 

help="Time in seconds between image operation status " 

"checks."), 

cfg.ListOpt('container_formats', 

default=['ami', 'ari', 'aki', 'bare', 'ovf', 'ova'], 

help="A list of image's container formats " 

"users can specify."), 

cfg.ListOpt('disk_formats', 

default=['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', 

'vdi', 'iso', 'vhdx'], 

help="A list of image's disk formats " 

"users can specify.") 

] 

image_feature_group = cfg.OptGroup(name='image-feature-enabled', 

title='Enabled image service features') 

ImageFeaturesGroup = [ 

cfg.BoolOpt('api_v2', 

default=True, 

help="Is the v2 image API enabled", 

deprecated_for_removal=True, 

deprecated_reason='Glance v1 APIs are deprecated and v2 APIs ' 

'are current one. In future, Tempest will ' 

'test v2 APIs only so this config option ' 

'will be removed.'), 

cfg.BoolOpt('api_v1', 

default=False, 

help="Is the v1 image API enabled", 

deprecated_for_removal=True, 

deprecated_reason='Glance v1 APIs are deprecated and v2 APIs ' 

'are current one. In future, Tempest will ' 

'test v2 APIs only so this config option ' 

'will be removed.'), 

] 

network_group = cfg.OptGroup(name='network', 

title='Network Service Options') 

ProfileType = types.Dict(types.List(types.String(), bounds=True)) 

NetworkGroup = [ 

cfg.StrOpt('catalog_type', 

default='network', 

help='Catalog type of the Neutron service.'), 

cfg.StrOpt('region', 

default='', 

help="The network region name to use. If empty, the value " 

"of identity.region is used instead. If no such region " 

"is found in the service catalog, the first found one is " 

"used."), 

cfg.StrOpt('endpoint_type', 

default='publicURL', 

choices=['public', 'admin', 'internal', 

'publicURL', 'adminURL', 'internalURL'], 

help="The endpoint type to use for the network service."), 

cfg.StrOpt('project_network_cidr', 

default="10.100.0.0/16", 

help="The cidr block to allocate project ipv4 subnets from"), 

cfg.IntOpt('project_network_mask_bits', 

default=28, 

help="The mask bits for project ipv4 subnets"), 

cfg.StrOpt('project_network_v6_cidr', 

default="2003::/48", 

help="The cidr block to allocate project ipv6 subnets from"), 

cfg.IntOpt('project_network_v6_mask_bits', 

default=64, 

help="The mask bits for project ipv6 subnets"), 

cfg.BoolOpt('project_networks_reachable', 

default=False, 

help="Whether project networks can be reached directly from " 

"the test client. This must be set to True when the " 

"'fixed' connect_method is selected."), 

cfg.StrOpt('public_network_id', 

default="", 

help="Id of the public network that provides external " 

"connectivity"), 

cfg.StrOpt('floating_network_name', 

help="Default floating network name. Used to allocate floating " 

"IPs when neutron is enabled."), 

cfg.StrOpt('public_router_id', 

default="", 

help="Id of the public router that provides external " 

"connectivity. This should only be used when Neutron's " 

"'allow_overlapping_ips' is set to 'False' in " 

"neutron.conf. usually not needed past 'Grizzly' release"), 

cfg.IntOpt('build_timeout', 

default=300, 

help="Timeout in seconds to wait for network operation to " 

"complete."), 

cfg.IntOpt('build_interval', 

default=1, 

help="Time in seconds between network operation status " 

"checks."), 

cfg.ListOpt('dns_servers', 

default=["8.8.8.8", "8.8.4.4"], 

help="List of dns servers which should be used" 

" for subnet creation", 

deprecated_for_removal=True, 

deprecated_reason="This config option is no longer " 

"used anywhere, so it can be removed."), 

cfg.StrOpt('port_vnic_type', 

choices=[None, 'normal', 'direct', 'macvtap'], 

help="vnic_type to use when launching instances" 

" with pre-configured ports." 

" Supported ports are:" 

" ['normal','direct','macvtap']"), 

cfg.Opt('port_profile', 

type=ProfileType, 

default={}, 

help="port profile to use when launching instances" 

" with pre-configured ports."), 

cfg.ListOpt('default_network', 

default=["1.0.0.0/16", "2.0.0.0/16"], 

help="List of ip pools" 

" for subnetpools creation"), 

cfg.BoolOpt('shared_physical_network', 

default=False, 

help="The environment does not support network separation " 

"between tenants."), 

] 

network_feature_group = cfg.OptGroup(name='network-feature-enabled', 

title='Enabled network service features') 

NetworkFeaturesGroup = [ 

cfg.BoolOpt('ipv6', 

default=True, 

help="Allow the execution of IPv6 tests"), 

cfg.ListOpt('api_extensions', 

default=['all'], 

help="A list of enabled network extensions with a special " 

"entry all which indicates every extension is enabled. " 

"Empty list indicates all extensions are disabled. " 

"To get the list of extensions run: 'neutron ext-list'"), 

cfg.BoolOpt('ipv6_subnet_attributes', 

default=False, 

help="Allow the execution of IPv6 subnet tests that use " 

"the extended IPv6 attributes ipv6_ra_mode " 

"and ipv6_address_mode" 

), 

cfg.BoolOpt('port_admin_state_change', 

default=True, 

help="Does the test environment support changing" 

" port admin state"), 

cfg.BoolOpt('port_security', 

default=False, 

help="Does the test environment support port security?"), 

cfg.BoolOpt('floating_ips', 

default=True, 

help='Does the test environment support floating_ips'), 

cfg.StrOpt('qos_placement_physnet', default=None, 

help='Name of the physnet for placement based minimum ' 

'bandwidth allocation.'), 

cfg.StrOpt('provider_net_base_segmentation_id', default=3000, 

help='Base segmentation ID to create provider networks. ' 

'This value will be increased in case of conflict.') 

] 

validation_group = cfg.OptGroup(name='validation', 

title='SSH Validation options') 

ValidationGroup = [ 

cfg.BoolOpt('run_validation', 

default=True, 

help='Enable ssh on created servers and creation of additional' 

' validation resources to enable remote access.' 

' In case the guest does not support ssh set it' 

' to false'), 

cfg.BoolOpt('security_group', 

default=True, 

help='Enable/disable security groups.'), 

cfg.BoolOpt('security_group_rules', 

default=True, 

help='Enable/disable security group rules.'), 

cfg.StrOpt('connect_method', 

default='floating', 

choices=['fixed', 'floating'], 

help='Default IP type used for validation: ' 

'-fixed: uses the first IP belonging to the fixed network ' 

'-floating: creates and uses a floating IP'), 

cfg.StrOpt('auth_method', 

default='keypair', 

choices=['keypair'], 

help='Default authentication method to the instance. ' 

'Only ssh via keypair is supported for now. ' 

'Additional methods will be handled in a separate spec.'), 

cfg.IntOpt('ip_version_for_ssh', 

default=4, 

help='Default IP version for ssh connections.'), 

cfg.IntOpt('ping_timeout', 

default=120, 

help='Timeout in seconds to wait for ping to succeed.'), 

cfg.IntOpt('connect_timeout', 

default=60, 

help='Timeout in seconds to wait for the TCP connection to be ' 

'successful.'), 

cfg.IntOpt('ssh_timeout', 

default=300, 

help='Timeout in seconds to wait for the ssh banner.'), 

cfg.StrOpt('image_ssh_user', 

default="root", 

help="User name used to authenticate to an instance."), 

cfg.StrOpt('image_ssh_password', 

default="password", 

help="Password used to authenticate to an instance."), 

cfg.StrOpt('ssh_shell_prologue', 

default="set -eu -o pipefail; PATH=$$PATH:/sbin;", 

help="Shell fragments to use before executing a command " 

"when sshing to a guest."), 

cfg.IntOpt('ping_size', 

default=56, 

help="The packet size for ping packets originating " 

"from remote linux hosts"), 

cfg.IntOpt('ping_count', 

default=1, 

help="The number of ping packets originating from remote " 

"linux hosts"), 

cfg.StrOpt('floating_ip_range', 

default='10.0.0.0/29', 

help='Unallocated floating IP range, which will be used to ' 

'test the floating IP bulk feature for CRUD operation. ' 

'This block must not overlap an existing floating IP ' 

'pool.'), 

cfg.StrOpt('network_for_ssh', 

default='public', 

help="Network used for SSH connections. Ignored if " 

"connect_method=floating."), 

] 

volume_group = cfg.OptGroup(name='volume', 

title='Block Storage Options') 

VolumeGroup = [ 

cfg.IntOpt('build_interval', 

default=1, 

help='Time in seconds between volume availability checks.'), 

cfg.IntOpt('build_timeout', 

default=300, 

help='Timeout in seconds to wait for a volume to become ' 

'available.'), 

cfg.StrOpt('catalog_type', 

default='volumev3', 

help="Catalog type of the Volume Service"), 

cfg.StrOpt('region', 

default='', 

help="The volume region name to use. If empty, the value " 

"of identity.region is used instead. If no such region " 

"is found in the service catalog, the first found one is " 

"used."), 

cfg.StrOpt('endpoint_type', 

default='publicURL', 

choices=['public', 'admin', 'internal', 

'publicURL', 'adminURL', 'internalURL'], 

help="The endpoint type to use for the volume service."), 

cfg.ListOpt('backend_names', 

default=['BACKEND_1', 'BACKEND_2'], 

help='A list of backend names separated by comma. ' 

'The backend name must be declared in cinder.conf'), 

cfg.StrOpt('storage_protocol', 

default='iSCSI', 

help='Backend protocol to target when creating volume types'), 

cfg.StrOpt('vendor_name', 

default='Open Source', 

help='Backend vendor to target when creating volume types'), 

cfg.StrOpt('disk_format', 

default='raw', 

help='Disk format to use when copying a volume to image'), 

cfg.IntOpt('volume_size', 

default=1, 

help='Default size in GB for volumes created by volumes tests'), 

cfg.ListOpt('manage_volume_ref', 

default=['source-name', 'volume-%s'], 

help="A reference to existing volume for volume manage. " 

"It contains two elements, the first is ref type " 

"(like 'source-name', 'source-id', etc), the second is " 

"volume name template used in storage backend"), 

cfg.ListOpt('manage_snapshot_ref', 

default=['source-name', '_snapshot-%s'], 

help="A reference to existing snapshot for snapshot manage. " 

"It contains two elements, the first is ref type " 

"(like 'source-name', 'source-id', etc), the second is " 

"snapshot name template used in storage backend"), 

cfg.StrOpt('min_microversion', 

default=None, 

help="Lower version of the test target microversion range. " 

"The format is 'X.Y', where 'X' and 'Y' are int values. " 

"Tempest selects tests based on the range between " 

"min_microversion and max_microversion. " 

"If both values are not specified, Tempest avoids tests " 

"which require a microversion. Valid values are string " 

"with format 'X.Y' or string 'latest'",), 

cfg.StrOpt('max_microversion', 

default=None, 

help="Upper version of the test target microversion range. "