3 # Copyright (c) 2015 All rights reserved
4 # This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
11 """Tempest configuration utilities."""
23 from functest.utils import config
24 from functest.utils import env
25 import functest.utils.functest_utils as ft_utils
30 RALLY_CONF_PATH = "/etc/rally/rally.conf"
31 RALLY_AARCH64_PATCH_PATH = pkg_resources.resource_filename(
32 'functest', 'ci/rally_aarch64_patch.conf')
33 GLANCE_IMAGE_PATH = os.path.join(
34 getattr(config.CONF, 'dir_functest_images'),
35 getattr(config.CONF, 'openstack_image_file_name'))
36 TEMPEST_CUSTOM = pkg_resources.resource_filename(
37 'functest', 'opnfv_tests/openstack/tempest/custom_tests/test_list.txt')
38 TEMPEST_BLACKLIST = pkg_resources.resource_filename(
39 'functest', 'opnfv_tests/openstack/tempest/custom_tests/blacklist.txt')
40 TEMPEST_CONF_YAML = pkg_resources.resource_filename(
41 'functest', 'opnfv_tests/openstack/tempest/custom_tests/tempest_conf.yaml')
42 TEST_ACCOUNTS_FILE = pkg_resources.resource_filename(
44 'opnfv_tests/openstack/tempest/custom_tests/test_accounts.yaml')
46 CI_INSTALLER_TYPE = env.get('INSTALLER_TYPE')
48 """ logging configuration """
49 LOGGER = logging.getLogger(__name__)
52 def create_rally_deployment():
53 """Create new rally deployment"""
54 # set the architecture to default
55 pod_arch = env.get("POD_ARCH")
56 arch_filter = ['aarch64']
58 if pod_arch and pod_arch in arch_filter:
59 LOGGER.info("Apply aarch64 specific to rally config...")
60 with open(RALLY_AARCH64_PATCH_PATH, "r") as pfile:
61 rally_patch_conf = pfile.read()
63 for line in fileinput.input(RALLY_CONF_PATH, inplace=1):
65 if "cirros|testvm" in line:
66 print rally_patch_conf
68 LOGGER.info("Creating Rally environment...")
70 cmd = "rally deployment destroy opnfv-rally"
71 ft_utils.execute_command(cmd, error_msg=(
72 "Deployment %s does not exist."
73 % getattr(config.CONF, 'rally_deployment_name')), verbose=False)
75 cmd = ("rally deployment create --fromenv --name={0}"
76 .format(getattr(config.CONF, 'rally_deployment_name')))
77 error_msg = "Problem while creating Rally deployment"
78 ft_utils.execute_command_raise(cmd, error_msg=error_msg)
80 cmd = "rally deployment check"
81 error_msg = "OpenStack not responding or faulty Rally deployment."
82 ft_utils.execute_command_raise(cmd, error_msg=error_msg)
85 def create_verifier():
86 """Create new verifier"""
87 LOGGER.info("Create verifier from existing repo...")
88 cmd = ("rally verify delete-verifier --id '{0}' --force").format(
89 getattr(config.CONF, 'tempest_verifier_name'))
90 ft_utils.execute_command(cmd, error_msg=(
91 "Verifier %s does not exist."
92 % getattr(config.CONF, 'tempest_verifier_name')), verbose=False)
93 cmd = ("rally verify create-verifier --source {0} "
94 "--name {1} --type tempest --system-wide"
95 .format(getattr(config.CONF, 'dir_repo_tempest'),
96 getattr(config.CONF, 'tempest_verifier_name')))
97 ft_utils.execute_command_raise(cmd,
98 error_msg='Problem while creating verifier')
101 def get_verifier_id():
103 Returns verifier id for current Tempest
105 create_rally_deployment()
107 cmd = ("rally verify list-verifiers | awk '/" +
108 getattr(config.CONF, 'tempest_verifier_name') +
110 proc = subprocess.Popen(cmd, shell=True,
111 stdout=subprocess.PIPE,
112 stderr=subprocess.STDOUT)
113 deployment_uuid = proc.stdout.readline().rstrip()
114 if deployment_uuid == "":
115 LOGGER.error("Tempest verifier not found.")
116 raise Exception('Error with command:%s' % cmd)
117 return deployment_uuid
120 def get_verifier_deployment_id():
122 Returns deployment id for active Rally deployment
124 cmd = ("rally deployment list | awk '/" +
125 getattr(config.CONF, 'rally_deployment_name') +
127 proc = subprocess.Popen(cmd, shell=True,
128 stdout=subprocess.PIPE,
129 stderr=subprocess.STDOUT)
130 deployment_uuid = proc.stdout.readline().rstrip()
131 if deployment_uuid == "":
132 LOGGER.error("Rally deployment not found.")
133 raise Exception('Error with command:%s' % cmd)
134 return deployment_uuid
137 def get_verifier_repo_dir(verifier_id):
139 Returns installed verifier repo directory for Tempest
142 verifier_id = get_verifier_id()
144 return os.path.join(getattr(config.CONF, 'dir_rally_inst'),
146 'verifier-{}'.format(verifier_id),
150 def get_verifier_deployment_dir(verifier_id, deployment_id):
152 Returns Rally deployment directory for current verifier
155 verifier_id = get_verifier_id()
157 if not deployment_id:
158 deployment_id = get_verifier_deployment_id()
160 return os.path.join(getattr(config.CONF, 'dir_rally_inst'),
162 'verifier-{}'.format(verifier_id),
163 'for-deployment-{}'.format(deployment_id))
166 def backup_tempest_config(conf_file, res_dir):
168 Copy config file to tempest results directory
170 if not os.path.exists(res_dir):
172 shutil.copyfile(conf_file,
173 os.path.join(res_dir, 'tempest.conf'))
176 def configure_tempest(deployment_dir, res_dir, network_name=None,
177 image_id=None, flavor_id=None, compute_cnt=None):
178 # pylint: disable=too-many-arguments
180 Calls rally verify and updates the generated tempest.conf with
183 conf_file = configure_verifier(deployment_dir)
184 configure_tempest_update_params(conf_file, res_dir, network_name, image_id,
185 flavor_id, compute_cnt)
188 def generate_test_accounts_file(tenant_id):
190 Add needed tenant and user params into test_accounts.yaml
193 LOGGER.debug("Add needed params into test_accounts.yaml...")
196 'tenant_name': getattr(
197 config.CONF, 'tempest_identity_tenant_name'),
198 'tenant_id': str(tenant_id),
199 'username': getattr(config.CONF, 'tempest_identity_user_name'),
200 'password': getattr(config.CONF, 'tempest_identity_user_password')
204 with open(TEST_ACCOUNTS_FILE, "w") as tfile:
205 yaml.dump(accounts_list, tfile, default_flow_style=False)
208 def update_tempest_conf_file(conf_file, rconfig):
209 """Update defined paramters into tempest config file"""
210 with open(TEMPEST_CONF_YAML) as yfile:
211 conf_yaml = yaml.safe_load(yfile)
213 sections = rconfig.sections()
214 for section in conf_yaml:
215 if section not in sections:
216 rconfig.add_section(section)
217 sub_conf = conf_yaml.get(section)
218 for key, value in sub_conf.items():
219 rconfig.set(section, key, value)
221 with open(conf_file, 'wb') as config_file:
222 rconfig.write(config_file)
225 def configure_tempest_update_params(tempest_conf_file, res_dir,
226 network_name=None, image_id=None,
227 flavor_id=None, compute_cnt=1):
228 # pylint: disable=too-many-branches, too-many-arguments
230 Add/update needed parameters into tempest.conf file
232 LOGGER.debug("Updating selected tempest.conf parameters...")
233 rconfig = ConfigParser.RawConfigParser()
234 rconfig.read(tempest_conf_file)
235 rconfig.set('compute', 'fixed_network_name', network_name)
236 if CI_INSTALLER_TYPE == 'fuel':
237 # backward compatibility till Fuel jobs set the right env var
238 rconfig.set('compute', 'volume_device_name', 'vdc')
241 'compute', 'volume_device_name', env.get('VOLUME_DEVICE_NAME'))
242 if image_id is not None:
243 rconfig.set('compute', 'image_ref', image_id)
244 if IMAGE_ID_ALT is not None:
245 rconfig.set('compute', 'image_ref_alt', IMAGE_ID_ALT)
246 if getattr(config.CONF, 'tempest_use_custom_flavors'):
247 if flavor_id is not None:
248 rconfig.set('compute', 'flavor_ref', flavor_id)
249 if FLAVOR_ID_ALT is not None:
250 rconfig.set('compute', 'flavor_ref_alt', FLAVOR_ID_ALT)
252 # enable multinode tests
253 rconfig.set('compute', 'min_compute_nodes', compute_cnt)
254 rconfig.set('compute-feature-enabled', 'live_migration', True)
256 rconfig.set('identity', 'region', os.environ.get('OS_REGION_NAME'))
257 identity_api_version = os.environ.get("OS_IDENTITY_API_VERSION", '3')
258 if identity_api_version == '3':
260 rconfig.set('identity-feature-enabled', 'api_v2', False)
263 rconfig.set('identity', 'auth_version', auth_version)
265 'validation', 'ssh_timeout',
266 getattr(config.CONF, 'tempest_validation_ssh_timeout'))
267 rconfig.set('object-storage', 'operator_role',
268 getattr(config.CONF, 'tempest_object_storage_operator_role'))
270 if os.environ.get('OS_ENDPOINT_TYPE') is not None:
271 rconfig.set('identity', 'v3_endpoint_type',
272 os.environ.get('OS_ENDPOINT_TYPE'))
274 if os.environ.get('OS_ENDPOINT_TYPE') is not None:
275 sections = rconfig.sections()
277 'compute', 'volume', 'image', 'network', 'data-processing',
278 'object-storage', 'orchestration']
279 for service in services_list:
280 if service not in sections:
281 rconfig.add_section(service)
282 rconfig.set(service, 'endpoint_type',
283 os.environ.get('OS_ENDPOINT_TYPE'))
285 LOGGER.debug('Add/Update required params defined in tempest_conf.yaml '
286 'into tempest.conf file')
287 update_tempest_conf_file(tempest_conf_file, rconfig)
289 backup_tempest_config(tempest_conf_file, res_dir)
292 def configure_verifier(deployment_dir):
294 Execute rally verify configure-verifier, which generates tempest.conf
296 tempest_conf_file = os.path.join(deployment_dir, "tempest.conf")
297 if os.path.isfile(tempest_conf_file):
298 LOGGER.debug("Verifier is already configured.")
299 LOGGER.debug("Reconfiguring the current verifier...")
300 cmd = "rally verify configure-verifier --reconfigure"
302 LOGGER.info("Configuring the verifier...")
303 cmd = "rally verify configure-verifier"
304 ft_utils.execute_command(cmd)
306 LOGGER.debug("Looking for tempest.conf file...")
307 if not os.path.isfile(tempest_conf_file):
308 LOGGER.error("Tempest configuration file %s NOT found.",
310 raise Exception("Tempest configuration file %s NOT found."
313 return tempest_conf_file