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
25 from functest.core import testcase
26 from functest.opnfv_tests.openstack.snaps import snaps_utils
27 from functest.opnfv_tests.openstack.tempest import conf_utils
28 from functest.utils.constants import CONST
29 from functest.utils import env
30 import functest.utils.functest_utils as ft_utils
32 from snaps.config.flavor import FlavorConfig
33 from snaps.config.network import NetworkConfig, SubnetConfig
34 from snaps.config.project import ProjectConfig
35 from snaps.config.user import UserConfig
37 from snaps.openstack import create_flavor
38 from snaps.openstack.create_flavor import OpenStackFlavor
39 from snaps.openstack.tests import openstack_tests
40 from snaps.openstack.utils import deploy_utils
43 LOGGER = logging.getLogger(__name__)
46 class TempestCommon(testcase.TestCase):
47 # pylint: disable=too-many-instance-attributes
48 """TempestCommon testcases implementation class."""
50 def __init__(self, **kwargs):
51 super(TempestCommon, self).__init__(**kwargs)
52 self.resources = TempestResourcesManager(**kwargs)
55 self.verifier_id = conf_utils.get_verifier_id()
56 self.verifier_repo_dir = conf_utils.get_verifier_repo_dir(
58 self.deployment_id = conf_utils.get_verifier_deployment_id()
59 self.deployment_dir = conf_utils.get_verifier_deployment_dir(
60 self.verifier_id, self.deployment_id)
61 self.verification_id = None
64 def read_file(filename):
65 """Read file and return content as a stripped list."""
66 with open(filename) as src:
67 return [line.strip() for line in src.readlines()]
70 def get_verifier_result(verif_id):
71 """Retrieve verification results."""
78 cmd = ["rally", "verify", "show", "--uuid", verif_id]
79 LOGGER.info("Showing result for a verification: '%s'.", cmd)
80 proc = subprocess.Popen(cmd,
81 stdout=subprocess.PIPE,
82 stderr=subprocess.STDOUT)
83 for line in proc.stdout:
84 new_line = line.replace(' ', '').split('|')
85 if 'Tests' in new_line:
88 if 'Testscount' in new_line:
89 result['num_tests'] = int(new_line[2])
90 elif 'Success' in new_line:
91 result['num_success'] = int(new_line[2])
92 elif 'Skipped' in new_line:
93 result['num_skipped'] = int(new_line[2])
94 elif 'Failures' in new_line:
95 result['num_failures'] = int(new_line[2])
98 def generate_test_list(self, verifier_repo_dir):
99 """Generate test list based on the test mode."""
100 LOGGER.debug("Generating test case list...")
101 if self.mode == 'defcore':
103 conf_utils.TEMPEST_DEFCORE, conf_utils.TEMPEST_RAW_LIST)
104 elif self.mode == 'custom':
105 if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
107 conf_utils.TEMPEST_CUSTOM, conf_utils.TEMPEST_RAW_LIST)
109 raise Exception("Tempest test list file %s NOT found."
110 % conf_utils.TEMPEST_CUSTOM)
112 if self.mode == 'smoke':
113 testr_mode = r"'tempest\.(api|scenario).*\[.*\bsmoke\b.*\]'"
114 elif self.mode == 'full':
115 testr_mode = r"'^tempest\.'"
117 testr_mode = self.mode
119 "testr list-tests {1} > {2};"
120 "cd -;".format(verifier_repo_dir,
122 conf_utils.TEMPEST_RAW_LIST))
123 ft_utils.execute_command(cmd)
125 def apply_tempest_blacklist(self):
126 """Exclude blacklisted test cases."""
127 LOGGER.debug("Applying tempest blacklist...")
128 cases_file = self.read_file(conf_utils.TEMPEST_RAW_LIST)
129 result_file = open(conf_utils.TEMPEST_LIST, 'w')
132 installer_type = env.get('INSTALLER_TYPE')
133 deploy_scenario = env.get('DEPLOY_SCENARIO')
134 if bool(installer_type) * bool(deploy_scenario):
135 # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the
137 black_list_file = open(conf_utils.TEMPEST_BLACKLIST)
138 black_list_yaml = yaml.safe_load(black_list_file)
139 black_list_file.close()
140 for item in black_list_yaml:
141 scenarios = item['scenarios']
142 installers = item['installers']
143 if (deploy_scenario in scenarios and
144 installer_type in installers):
145 tests = item['tests']
147 black_tests.append(test)
149 except Exception: # pylint: disable=broad-except
151 LOGGER.debug("Tempest blacklist file does not exist.")
153 for cases_line in cases_file:
154 for black_tests_line in black_tests:
155 if black_tests_line in cases_line:
158 result_file.write(str(cases_line) + '\n')
161 def run_verifier_tests(self):
162 """Execute tempest test cases."""
163 cmd = ["rally", "verify", "start", "--load-list",
164 conf_utils.TEMPEST_LIST]
165 cmd.extend(self.option)
166 LOGGER.info("Starting Tempest test suite: '%s'.", cmd)
169 os.path.join(conf_utils.TEMPEST_RESULTS_DIR, "tempest.log"), 'w+')
171 os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
172 "tempest-error.log"), 'w+')
174 proc = subprocess.Popen(
176 stdout=subprocess.PIPE,
181 for line in iter(proc.stdout.readline, b''):
182 if re.search(r"\} tempest\.", line):
183 LOGGER.info(line.replace('\n', ''))
184 elif re.search('Starting verification', line):
185 LOGGER.info(line.replace('\n', ''))
186 first_pos = line.index("UUID=") + len("UUID=")
187 last_pos = line.index(") for deployment")
188 self.verification_id = line[first_pos:last_pos]
189 LOGGER.debug('Verification UUID: %s', self.verification_id)
196 if self.verification_id is None:
197 raise Exception('Verification UUID not found')
199 def parse_verifier_result(self):
200 """Parse and save test results."""
201 stat = self.get_verifier_result(self.verification_id)
203 num_executed = stat['num_tests'] - stat['num_skipped']
205 self.result = 100 * stat['num_success'] / num_executed
206 except ZeroDivisionError:
208 if stat['num_tests'] > 0:
209 LOGGER.info("All tests have been skipped")
211 LOGGER.error("No test has been executed")
214 with open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
215 "tempest.log"), 'r') as logfile:
216 output = logfile.read()
218 success_testcases = []
219 for match in re.findall(r'.*\{0\} (.*?)[. ]*success ', output):
220 success_testcases.append(match)
221 failed_testcases = []
222 for match in re.findall(r'.*\{0\} (.*?)[. ]*fail ', output):
223 failed_testcases.append(match)
224 skipped_testcases = []
225 for match in re.findall(r'.*\{0\} (.*?)[. ]*skip:', output):
226 skipped_testcases.append(match)
228 self.details = {"tests": stat['num_tests'],
229 "failures": stat['num_failures'],
230 "success": success_testcases,
231 "skipped": skipped_testcases,
232 "errors": failed_testcases}
233 except Exception: # pylint: disable=broad-except
236 LOGGER.info("Tempest %s success_rate is %s%%",
237 self.case_name, self.result)
239 def generate_report(self):
240 """Generate verification report."""
241 html_file = os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
242 "tempest-report.html")
243 cmd = ["rally", "verify", "report", "--type", "html", "--uuid",
244 self.verification_id, "--to", html_file]
245 subprocess.Popen(cmd, stdout=subprocess.PIPE,
246 stderr=subprocess.STDOUT)
248 def run(self, **kwargs):
250 self.start_time = time.time()
252 if not os.path.exists(conf_utils.TEMPEST_RESULTS_DIR):
253 os.makedirs(conf_utils.TEMPEST_RESULTS_DIR)
254 resources = self.resources.create()
255 compute_cnt = snaps_utils.get_active_compute_cnt(
256 self.resources.os_creds)
257 conf_utils.configure_tempest(
259 network_name=resources.get("network_name"),
260 image_id=resources.get("image_id"),
261 flavor_id=resources.get("flavor_id"),
262 compute_cnt=compute_cnt)
263 self.generate_test_list(self.verifier_repo_dir)
264 self.apply_tempest_blacklist()
265 self.run_verifier_tests()
266 self.parse_verifier_result()
267 self.generate_report()
268 res = testcase.TestCase.EX_OK
269 except Exception as err: # pylint: disable=broad-except
270 LOGGER.error('Error with run: %s', err)
271 res = testcase.TestCase.EX_RUN_ERROR
273 self.resources.cleanup()
275 self.stop_time = time.time()
279 class TempestSmokeSerial(TempestCommon):
280 """Tempest smoke serial testcase implementation."""
281 def __init__(self, **kwargs):
282 if "case_name" not in kwargs:
283 kwargs["case_name"] = 'tempest_smoke_serial'
284 TempestCommon.__init__(self, **kwargs)
286 self.option = ["--concurrency", "1"]
289 class TempestSmokeParallel(TempestCommon):
290 """Tempest smoke parallel testcase implementation."""
291 def __init__(self, **kwargs):
292 if "case_name" not in kwargs:
293 kwargs["case_name"] = 'tempest_smoke_parallel'
294 TempestCommon.__init__(self, **kwargs)
298 class TempestFullParallel(TempestCommon):
299 """Tempest full parallel testcase implementation."""
300 def __init__(self, **kwargs):
301 if "case_name" not in kwargs:
302 kwargs["case_name"] = 'tempest_full_parallel'
303 TempestCommon.__init__(self, **kwargs)
307 class TempestCustom(TempestCommon):
308 """Tempest custom testcase implementation."""
309 def __init__(self, **kwargs):
310 if "case_name" not in kwargs:
311 kwargs["case_name"] = 'tempest_custom'
312 TempestCommon.__init__(self, **kwargs)
314 self.option = ["--concurrency", "1"]
317 class TempestDefcore(TempestCommon):
318 """Tempest Defcore testcase implementation."""
319 def __init__(self, **kwargs):
320 if "case_name" not in kwargs:
321 kwargs["case_name"] = 'tempest_defcore'
322 TempestCommon.__init__(self, **kwargs)
323 self.mode = "defcore"
324 self.option = ["--concurrency", "1"]
327 class TempestResourcesManager(object):
328 """Tempest resource manager."""
329 def __init__(self, **kwargs):
330 self.os_creds = kwargs.get('os_creds') or snaps_utils.get_credentials()
331 self.guid = '-' + str(uuid.uuid4())
332 self.creators = list()
333 self.cirros_image_config = getattr(CONST, 'snaps_images_cirros', None)
335 def _create_project(self):
336 """Create project for tests."""
337 project_creator = deploy_utils.create_project(
338 self.os_creds, ProjectConfig(
340 CONST, 'tempest_identity_tenant_name') + self.guid,
342 CONST, 'tempest_identity_tenant_description')))
343 if project_creator is None or project_creator.get_project() is None:
344 raise Exception("Failed to create tenant")
345 self.creators.append(project_creator)
346 return project_creator.get_project().id
348 def _create_user(self):
349 """Create user for tests."""
350 user_creator = deploy_utils.create_user(
351 self.os_creds, UserConfig(
353 CONST, 'tempest_identity_user_name') + self.guid,
355 CONST, 'tempest_identity_user_password'),
356 project_name=getattr(
357 CONST, 'tempest_identity_tenant_name') + self.guid))
358 if user_creator is None or user_creator.get_user() is None:
359 raise Exception("Failed to create user")
360 self.creators.append(user_creator)
361 return user_creator.get_user().id
363 def _create_network(self, project_name):
364 """Create network for tests."""
365 tempest_network_type = None
366 tempest_physical_network = None
367 tempest_segmentation_id = None
369 tempest_network_type = getattr(
370 CONST, 'tempest_network_type', None)
371 tempest_physical_network = getattr(
372 CONST, 'tempest_physical_network', None)
373 tempest_segmentation_id = getattr(
374 CONST, 'tempest_segmentation_id', None)
375 tempest_net_name = getattr(
376 CONST, 'tempest_private_net_name') + self.guid
378 network_creator = deploy_utils.create_network(
379 self.os_creds, NetworkConfig(
380 name=tempest_net_name,
381 project_name=project_name,
382 network_type=tempest_network_type,
383 physical_network=tempest_physical_network,
384 segmentation_id=tempest_segmentation_id,
385 subnet_settings=[SubnetConfig(
387 CONST, 'tempest_private_subnet_name') + self.guid,
388 project_name=project_name,
390 CONST, 'tempest_private_subnet_cidr'))]))
391 if network_creator is None or network_creator.get_network() is None:
392 raise Exception("Failed to create private network")
393 self.creators.append(network_creator)
394 return tempest_net_name
396 def _create_image(self, name):
397 """Create image for tests"""
398 os_image_settings = openstack_tests.cirros_image_settings(
400 image_metadata=self.cirros_image_config)
401 image_creator = deploy_utils.create_image(
402 self.os_creds, os_image_settings)
403 if image_creator is None:
404 raise Exception('Failed to create image')
405 self.creators.append(image_creator)
406 return image_creator.get_image().id
408 def _create_flavor(self, name):
409 """Create flavor for tests."""
410 scenario = env.get('DEPLOY_SCENARIO')
411 flavor_metadata = None
412 if 'ovs' in scenario or 'fdio' in scenario:
413 flavor_metadata = create_flavor.MEM_PAGE_SIZE_LARGE
414 flavor_creator = OpenStackFlavor(
415 self.os_creds, FlavorConfig(
417 ram=getattr(CONST, 'openstack_flavor_ram'),
418 disk=getattr(CONST, 'openstack_flavor_disk'),
419 vcpus=getattr(CONST, 'openstack_flavor_vcpus'),
420 metadata=flavor_metadata))
421 flavor = flavor_creator.create()
423 raise Exception('Failed to create flavor')
424 self.creators.append(flavor_creator)
427 def create(self, use_custom_images=False, use_custom_flavors=False,
428 create_project=False):
429 """Create resources for Tempest test suite."""
431 'tempest_net_name': None,
433 'image_id_alt': None,
435 'flavor_id_alt': None
440 LOGGER.debug("Creating project and user for Tempest suite")
441 project_name = getattr(
442 CONST, 'tempest_identity_tenant_name') + self.guid
443 result['project_id'] = self._create_project()
444 result['user_id'] = self._create_user()
445 result['tenant_id'] = result['project_id'] # for compatibility
447 LOGGER.debug("Creating private network for Tempest suite")
448 result['tempest_net_name'] = self._create_network(project_name)
450 LOGGER.debug("Creating image for Tempest suite")
451 image_name = getattr(CONST, 'openstack_image_name') + self.guid
452 result['image_id'] = self._create_image(image_name)
454 if use_custom_images:
455 LOGGER.debug("Creating 2nd image for Tempest suite")
456 image_name = getattr(CONST, 'openstack_image_name_alt') + self.guid
457 result['image_id_alt'] = self._create_image(image_name)
459 if (getattr(CONST, 'tempest_use_custom_flavors') == 'True' or
461 LOGGER.info("Creating flavor for Tempest suite")
462 name = getattr(CONST, 'openstack_flavor_name') + self.guid
463 result['flavor_id'] = self._create_flavor(name)
465 if use_custom_flavors:
466 LOGGER.info("Creating 2nd flavor for Tempest suite")
467 scenario = env.get('DEPLOY_SCENARIO')
468 if 'ovs' in scenario or 'fdio' in scenario:
469 setattr(CONST, 'openstack_flavor_ram', 1024)
470 name = getattr(CONST, 'openstack_flavor_name_alt') + self.guid
471 result['flavor_id_alt'] = self._create_flavor(name)
477 Cleanup all OpenStack objects. Should be called on completion.
479 for creator in reversed(self.creators):
482 except Exception as err: # pylint: disable=broad-except
483 LOGGER.error('Unexpected error cleaning - %s', err)