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 testcases implementation."""
13 from __future__ import division
22 from six.moves import configparser
23 from xtesting.core import testcase
26 from functest.core import singlevm
27 from functest.opnfv_tests.openstack.tempest import conf_utils
28 from functest.utils import config
29 from functest.utils import env
30 from functest.utils import functest_utils
32 LOGGER = logging.getLogger(__name__)
35 class TempestCommon(singlevm.VmReady2):
36 # pylint: disable=too-many-instance-attributes
37 """TempestCommon testcases implementation class."""
40 filename_alt = '/home/opnfv/functest/images/cirros-0.4.0-x86_64-disk.img'
42 def __init__(self, **kwargs):
43 if "case_name" not in kwargs:
44 kwargs["case_name"] = 'tempest'
45 super(TempestCommon, self).__init__(**kwargs)
46 assert self.orig_cloud
49 if self.orig_cloud.get_role("admin"):
50 self.role_name = "admin"
51 elif self.orig_cloud.get_role("Admin"):
52 self.role_name = "Admin"
54 raise Exception("Cannot detect neither admin nor Admin")
55 self.orig_cloud.grant_role(
56 self.role_name, user=self.project.user.id,
57 project=self.project.project.id,
58 domain=self.project.domain.id)
59 self.orig_cloud.grant_role(
60 self.role_name, user=self.project.user.id,
61 domain=self.project.domain.id)
62 self.deployment_id = None
63 self.verifier_id = None
64 self.verifier_repo_dir = None
65 self.deployment_dir = None
66 self.verification_id = None
67 self.res_dir = os.path.join(
68 getattr(config.CONF, 'dir_results'), self.case_name)
69 self.raw_list = os.path.join(self.res_dir, 'test_raw_list.txt')
70 self.list = os.path.join(self.res_dir, 'test_list.txt')
73 self.flavor_alt = None
76 self.services = kwargs['run']['args']['services']
77 except Exception: # pylint: disable=broad-except
79 self.neutron_extensions = []
81 self.neutron_extensions = kwargs['run']['args'][
83 except Exception: # pylint: disable=broad-except
86 def create_network_resources(self):
89 def check_services(self):
90 """Check the mandatory services."""
91 for service in self.services:
93 self.cloud.search_services(service)[0]
94 except Exception: # pylint: disable=broad-except
95 self.is_skipped = True
98 def check_extensions(self):
99 """Check the mandatory network extensions."""
100 extensions = self.cloud.get_network_extensions()
101 for network_extension in self.neutron_extensions:
102 if network_extension not in extensions:
104 "Cannot find Neutron extension: %s", network_extension)
105 self.is_skipped = True
108 def check_requirements(self):
109 self.check_services()
110 self.check_extensions()
115 def read_file(filename):
116 """Read file and return content as a stripped list."""
117 with open(filename) as src:
118 return [line.strip() for line in src.readlines()]
121 def get_verifier_result(verif_id):
122 """Retrieve verification results."""
129 cmd = ["rally", "verify", "show", "--uuid", verif_id]
130 LOGGER.info("Showing result for a verification: '%s'.", cmd)
131 proc = subprocess.Popen(cmd,
132 stdout=subprocess.PIPE,
133 stderr=subprocess.STDOUT)
134 for line in proc.stdout:
135 LOGGER.info(line.rstrip())
136 new_line = line.replace(' ', '').split('|')
137 if 'Tests' in new_line:
139 if 'Testscount' in new_line:
140 result['num_tests'] = int(new_line[2])
141 elif 'Success' in new_line:
142 result['num_success'] = int(new_line[2])
143 elif 'Skipped' in new_line:
144 result['num_skipped'] = int(new_line[2])
145 elif 'Failures' in new_line:
146 result['num_failures'] = int(new_line[2])
150 def backup_tempest_config(conf_file, res_dir):
152 Copy config file to tempest results directory
154 if not os.path.exists(res_dir):
156 shutil.copyfile(conf_file,
157 os.path.join(res_dir, 'tempest.conf'))
159 def generate_test_list(self, **kwargs):
160 """Generate test list based on the test mode."""
161 LOGGER.debug("Generating test case list...")
162 self.backup_tempest_config(self.conf_file, '/etc')
163 if kwargs.get('mode') == 'custom':
164 if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
166 conf_utils.TEMPEST_CUSTOM, self.list)
168 raise Exception("Tempest test list file %s NOT found."
169 % conf_utils.TEMPEST_CUSTOM)
171 testr_mode = kwargs.get(
172 'mode', r'^tempest\.(api|scenario).*\[.*\bsmoke\b.*\]$')
173 cmd = "(cd {0}; stestr list '{1}' >{2} 2>/dev/null)".format(
174 self.verifier_repo_dir, testr_mode, self.list)
175 output = subprocess.check_output(cmd, shell=True)
176 LOGGER.info("%s\n%s", cmd, output)
177 os.remove('/etc/tempest.conf')
179 def apply_tempest_blacklist(self):
180 """Exclude blacklisted test cases."""
181 LOGGER.debug("Applying tempest blacklist...")
182 if os.path.exists(self.raw_list):
183 os.remove(self.raw_list)
184 os.rename(self.list, self.raw_list)
185 cases_file = self.read_file(self.raw_list)
186 result_file = open(self.list, 'w')
189 deploy_scenario = env.get('DEPLOY_SCENARIO')
190 if bool(deploy_scenario):
191 # if DEPLOY_SCENARIO is set we read the file
192 black_list_file = open(conf_utils.TEMPEST_BLACKLIST)
193 black_list_yaml = yaml.safe_load(black_list_file)
194 black_list_file.close()
195 for item in black_list_yaml:
196 scenarios = item['scenarios']
197 if deploy_scenario in scenarios:
198 tests = item['tests']
200 black_tests.append(test)
202 except Exception: # pylint: disable=broad-except
204 LOGGER.debug("Tempest blacklist file does not exist.")
206 for cases_line in cases_file:
207 for black_tests_line in black_tests:
208 if black_tests_line in cases_line:
211 result_file.write(str(cases_line) + '\n')
214 def run_verifier_tests(self, **kwargs):
215 """Execute tempest test cases."""
216 cmd = ["rally", "verify", "start", "--load-list",
218 cmd.extend(kwargs.get('option', []))
219 LOGGER.info("Starting Tempest test suite: '%s'.", cmd)
222 os.path.join(self.res_dir, "tempest.log"), 'w+')
224 proc = subprocess.Popen(
226 stdout=subprocess.PIPE,
227 stderr=subprocess.STDOUT,
231 for line in iter(proc.stdout.readline, b''):
232 if re.search(r"\} tempest\.", line):
233 LOGGER.info(line.rstrip())
234 elif re.search(r'(?=\(UUID=(.*)\))', line):
235 self.verification_id = re.search(
236 r'(?=\(UUID=(.*)\))', line).group(1)
241 if self.verification_id is None:
242 raise Exception('Verification UUID not found')
243 LOGGER.info('Verification UUID: %s', self.verification_id)
246 "{}/tempest.log".format(self.deployment_dir),
247 "{}/tempest.debug.log".format(self.res_dir))
249 def parse_verifier_result(self):
250 """Parse and save test results."""
251 stat = self.get_verifier_result(self.verification_id)
253 num_executed = stat['num_tests'] - stat['num_skipped']
255 self.result = 100 * stat['num_success'] / num_executed
256 except ZeroDivisionError:
258 if stat['num_tests'] > 0:
259 LOGGER.info("All tests have been skipped")
261 LOGGER.error("No test has been executed")
264 with open(os.path.join(self.res_dir,
265 "tempest.log"), 'r') as logfile:
266 output = logfile.read()
268 success_testcases = []
269 for match in re.findall(r'.*\{\d{1,2}\} (.*?) \.{3} success ',
271 success_testcases.append(match)
272 failed_testcases = []
273 for match in re.findall(r'.*\{\d{1,2}\} (.*?) \.{3} fail',
275 failed_testcases.append(match)
276 skipped_testcases = []
277 for match in re.findall(r'.*\{\d{1,2}\} (.*?) \.{3} skip:',
279 skipped_testcases.append(match)
281 self.details = {"tests_number": stat['num_tests'],
282 "success_number": stat['num_success'],
283 "skipped_number": stat['num_skipped'],
284 "failures_number": stat['num_failures'],
285 "success": success_testcases,
286 "skipped": skipped_testcases,
287 "failures": failed_testcases}
288 except Exception: # pylint: disable=broad-except
291 LOGGER.info("Tempest %s success_rate is %s%%",
292 self.case_name, self.result)
294 def generate_report(self):
295 """Generate verification report."""
296 html_file = os.path.join(self.res_dir,
297 "tempest-report.html")
298 cmd = ["rally", "verify", "report", "--type", "html", "--uuid",
299 self.verification_id, "--to", str(html_file)]
300 subprocess.check_output(cmd)
302 def update_rally_regex(self, rally_conf='/etc/rally/rally.conf'):
303 """Set image name as tempest img_name_regex"""
304 rconfig = configparser.RawConfigParser()
305 rconfig.read(rally_conf)
306 if not rconfig.has_section('openstack'):
307 rconfig.add_section('openstack')
308 rconfig.set('openstack', 'img_name_regex', '^{}$'.format(
310 with open(rally_conf, 'wb') as config_file:
311 rconfig.write(config_file)
313 def update_default_role(self, rally_conf='/etc/rally/rally.conf'):
314 """Detect and update the default role if required"""
315 role = self.get_default_role(self.cloud)
318 rconfig = configparser.RawConfigParser()
319 rconfig.read(rally_conf)
320 if not rconfig.has_section('openstack'):
321 rconfig.add_section('openstack')
322 rconfig.set('openstack', 'swift_operator_role', role.name)
323 with open(rally_conf, 'wb') as config_file:
324 rconfig.write(config_file)
326 def update_rally_logs(self, rally_conf='/etc/rally/rally.conf'):
327 """Print rally logs in res dir"""
328 if not os.path.exists(self.res_dir):
329 os.makedirs(self.res_dir)
330 rconfig = configparser.RawConfigParser()
331 rconfig.read(rally_conf)
332 rconfig.set('DEFAULT', 'debug', True)
333 rconfig.set('DEFAULT', 'use_stderr', False)
334 rconfig.set('DEFAULT', 'log-file', 'rally.log')
335 rconfig.set('DEFAULT', 'log_dir', self.res_dir)
336 with open(rally_conf, 'wb') as config_file:
337 rconfig.write(config_file)
340 def clean_rally_conf(rally_conf='/etc/rally/rally.conf'):
341 """Clean Rally config"""
342 rconfig = configparser.RawConfigParser()
343 rconfig.read(rally_conf)
344 if rconfig.has_option('openstack', 'img_name_regex'):
345 rconfig.remove_option('openstack', 'img_name_regex')
346 if rconfig.has_option('openstack', 'swift_operator_role'):
347 rconfig.remove_option('openstack', 'swift_operator_role')
348 if rconfig.has_option('DEFAULT', 'use_stderr'):
349 rconfig.remove_option('DEFAULT', 'use_stderr')
350 if rconfig.has_option('DEFAULT', 'debug'):
351 rconfig.remove_option('DEFAULT', 'debug')
352 if rconfig.has_option('DEFAULT', 'log-file'):
353 rconfig.remove_option('DEFAULT', 'log-file')
354 if rconfig.has_option('DEFAULT', 'log_dir'):
355 rconfig.remove_option('DEFAULT', 'log_dir')
356 with open(rally_conf, 'wb') as config_file:
357 rconfig.write(config_file)
359 def update_scenario_section(self):
360 """Update scenario section in tempest.conf"""
361 rconfig = configparser.RawConfigParser()
362 rconfig.read(self.conf_file)
364 config.CONF, '{}_image'.format(self.case_name), self.filename)
365 if not rconfig.has_section('scenario'):
366 rconfig.add_section('scenario')
367 rconfig.set('scenario', 'img_file', os.path.basename(filename))
368 rconfig.set('scenario', 'img_dir', os.path.dirname(filename))
369 rconfig.set('scenario', 'img_disk_format', getattr(
370 config.CONF, '{}_image_format'.format(self.case_name),
372 extra_properties = self.extra_properties.copy()
373 if env.get('IMAGE_PROPERTIES'):
374 extra_properties.update(
375 functest_utils.convert_ini_to_dict(
376 env.get('IMAGE_PROPERTIES')))
377 extra_properties.update(
378 getattr(config.CONF, '{}_extra_properties'.format(
379 self.case_name), {}))
381 'scenario', 'img_properties',
382 functest_utils.convert_dict_to_ini(extra_properties))
383 with open(self.conf_file, 'wb') as config_file:
384 rconfig.write(config_file)
386 def configure(self, **kwargs): # pylint: disable=unused-argument
388 Create all openstack resources for tempest-based testcases and write
391 if not os.path.exists(self.res_dir):
392 os.makedirs(self.res_dir)
395 OS_USERNAME=self.project.user.name,
396 OS_PROJECT_NAME=self.project.project.name,
397 OS_PROJECT_ID=self.project.project.id,
398 OS_PASSWORD=self.project.password)
400 del environ['OS_TENANT_NAME']
401 del environ['OS_TENANT_ID']
402 except Exception: # pylint: disable=broad-except
404 self.deployment_id = conf_utils.create_rally_deployment(
406 if not self.deployment_id:
407 raise Exception("Deployment create failed")
408 self.verifier_id = conf_utils.create_verifier()
409 if not self.verifier_id:
410 raise Exception("Verifier create failed")
411 self.verifier_repo_dir = conf_utils.get_verifier_repo_dir(
413 self.deployment_dir = conf_utils.get_verifier_deployment_dir(
414 self.verifier_id, self.deployment_id)
416 compute_cnt = len(self.orig_cloud.list_hypervisors())
418 self.image_alt = self.publish_image_alt()
419 self.flavor_alt = self.create_flavor_alt()
420 LOGGER.debug("flavor: %s", self.flavor_alt)
422 self.conf_file = conf_utils.configure_verifier(self.deployment_dir)
423 if not self.conf_file:
424 raise Exception("Tempest verifier configuring failed")
425 conf_utils.configure_tempest_update_params(
427 image_id=self.image.id,
428 flavor_id=self.flavor.id,
429 compute_cnt=compute_cnt,
430 image_alt_id=self.image_alt.id,
431 flavor_alt_id=self.flavor_alt.id,
432 admin_role_name=self.role_name, cidr=self.cidr,
433 domain_id=self.project.domain.id)
434 self.update_scenario_section()
435 self.backup_tempest_config(self.conf_file, self.res_dir)
437 def run(self, **kwargs):
438 self.start_time = time.time()
440 assert super(TempestCommon, self).run(
441 **kwargs) == testcase.TestCase.EX_OK
442 if not os.path.exists(self.res_dir):
443 os.makedirs(self.res_dir)
444 self.update_rally_regex()
445 self.update_default_role()
446 self.update_rally_logs()
447 shutil.copy("/etc/rally/rally.conf", self.res_dir)
448 self.configure(**kwargs)
449 self.generate_test_list(**kwargs)
450 self.apply_tempest_blacklist()
451 self.run_verifier_tests(**kwargs)
452 self.parse_verifier_result()
453 self.generate_report()
454 res = testcase.TestCase.EX_OK
455 except Exception: # pylint: disable=broad-except
456 LOGGER.exception('Error with run')
458 res = testcase.TestCase.EX_RUN_ERROR
459 self.stop_time = time.time()
464 Cleanup all OpenStack objects. Should be called on completion.
466 self.clean_rally_conf()
468 self.cloud.delete_image(self.image_alt)
470 self.orig_cloud.delete_flavor(self.flavor_alt.id)
471 super(TempestCommon, self).clean()