functest/opnfv_tests/openstack/tempest/tempest.py

   1 #!/usr/bin/python
   2 #
   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
   7 #
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10
  11 import os
  12 import re
  13 import shutil
  14 import subprocess
  15 import time
  16
  17 import yaml
  18
  19 from functest.core import testcase_base
  20 from functest.opnfv_tests.openstack.tempest import conf_utils
  21 from functest.utils.constants import CONST
  22 import functest.utils.functest_logger as ft_logger
  23 import functest.utils.functest_utils as ft_utils
  24 import functest.utils.openstack_utils as os_utils
  25
  26 """ logging configuration """
  27 logger = ft_logger.Logger("Tempest").getLogger()
  28
  29
  30 class TempestCommon(testcase_base.TestcaseBase):
  31
  32     def __init__(self):
  33         super(TempestCommon, self).__init__()
  34         self.MODE = ""
  35         self.OPTION = ""
  36         self.FLAVOR_ID = None
  37         self.IMAGE_ID = None
  38         self.VERIFIER_ID = conf_utils.get_verifier_id()
  39         self.VERIFIER_REPO_DIR = conf_utils.get_verifier_repo_dir(
  40             self.VERIFIER_ID)
  41         self.DEPLOYMENT_ID = conf_utils.get_verifier_deployment_id()
  42         self.DEPLOYMENT_DIR = conf_utils.get_verifier_deployment_dir(
  43             self.VERIFIER_ID, self.DEPLOYMENT_ID)
  44         self.VERIFICATION_ID = None
  45
  46     @staticmethod
  47     def read_file(filename):
  48         with open(filename) as src:
  49             return [line.strip() for line in src.readlines()]
  50
  51     def create_tempest_resources(self):
  52         keystone_client = os_utils.get_keystone_client()
  53
  54         logger.debug("Creating tenant and user for Tempest suite")
  55         tenant_id = os_utils.create_tenant(
  56             keystone_client,
  57             CONST.tempest_identity_tenant_name,
  58             CONST.tempest_identity_tenant_description)
  59         if not tenant_id:
  60             logger.error("Failed to create %s tenant"
  61                          % CONST.tempest_identity_tenant_name)
  62
  63         user_id = os_utils.create_user(keystone_client,
  64                                        CONST.tempest_identity_user_name,
  65                                        CONST.tempest_identity_user_password,
  66                                        None, tenant_id)
  67         if not user_id:
  68             logger.error("Failed to create %s user" %
  69                          CONST.tempest_identity_user_name)
  70
  71         logger.debug("Creating private network for Tempest suite")
  72         network_dic = os_utils.create_shared_network_full(
  73             CONST.tempest_private_net_name,
  74             CONST.tempest_private_subnet_name,
  75             CONST.tempest_router_name,
  76             CONST.tempest_private_subnet_cidr)
  77         if network_dic is None:
  78             raise Exception('Failed to create private network')
  79
  80         if CONST.tempest_use_custom_images:
  81             # adding alternative image should be trivial should we need it
  82             logger.debug("Creating image for Tempest suite")
  83             _, self.IMAGE_ID = os_utils.get_or_create_image(
  84                 CONST.openstack_image_name, conf_utils.GLANCE_IMAGE_PATH,
  85                 CONST.openstack_image_disk_format)
  86             if self.IMAGE_ID is None:
  87                 raise Exception('Failed to create image')
  88
  89         if CONST.tempest_use_custom_flavors:
  90             # adding alternative flavor should be trivial should we need it
  91             logger.debug("Creating flavor for Tempest suite")
  92             _, self.FLAVOR_ID = os_utils.get_or_create_flavor(
  93                 CONST.openstack_flavor_name,
  94                 CONST.openstack_flavor_ram,
  95                 CONST.openstack_flavor_disk,
  96                 CONST.openstack_flavor_vcpus)
  97             if self.FLAVOR_ID is None:
  98                 raise Exception('Failed to create flavor')
  99
 100     def generate_test_list(self, verifier_repo_dir):
 101         logger.debug("Generating test case list...")
 102         if self.MODE == 'defcore':
 103             shutil.copyfile(
 104                 conf_utils.TEMPEST_DEFCORE, conf_utils.TEMPEST_RAW_LIST)
 105         elif self.MODE == 'custom':
 106             if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
 107                 shutil.copyfile(
 108                     conf_utils.TEMPEST_CUSTOM, conf_utils.TEMPEST_RAW_LIST)
 109             else:
 110                 raise Exception("Tempest test list file %s NOT found."
 111                                 % conf_utils.TEMPEST_CUSTOM)
 112         else:
 113             if self.MODE == 'smoke':
 114                 testr_mode = "smoke"
 115             elif self.MODE == 'feature_multisite':
 116                 testr_mode = "'[Kk]ingbird'"
 117             elif self.MODE == 'full':
 118                 testr_mode = ""
 119             else:
 120                 testr_mode = 'tempest.api.' + self.MODE
 121             cmd = ("cd {0};"
 122                    "testr list-tests {1} > {2};"
 123                    "cd -;".format(verifier_repo_dir,
 124                                   testr_mode,
 125                                   conf_utils.TEMPEST_RAW_LIST))
 126             ft_utils.execute_command(cmd)
 127
 128     def apply_tempest_blacklist(self):
 129         logger.debug("Applying tempest blacklist...")
 130         cases_file = self.read_file(conf_utils.TEMPEST_RAW_LIST)
 131         result_file = open(conf_utils.TEMPEST_LIST, 'w')
 132         black_tests = []
 133         try:
 134             installer_type = CONST.INSTALLER_TYPE
 135             deploy_scenario = CONST.DEPLOY_SCENARIO
 136             if (bool(installer_type) * bool(deploy_scenario)):
 137                 # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the
 138                 # file
 139                 black_list_file = open(conf_utils.TEMPEST_BLACKLIST)
 140                 black_list_yaml = yaml.safe_load(black_list_file)
 141                 black_list_file.close()
 142                 for item in black_list_yaml:
 143                     scenarios = item['scenarios']
 144                     installers = item['installers']
 145                     if (deploy_scenario in scenarios and
 146                             installer_type in installers):
 147                         tests = item['tests']
 148                         for test in tests:
 149                             black_tests.append(test)
 150                         break
 151         except Exception:
 152             black_tests = []
 153             logger.debug("Tempest blacklist file does not exist.")
 154
 155         for cases_line in cases_file:
 156             for black_tests_line in black_tests:
 157                 if black_tests_line in cases_line:
 158                     break
 159             else:
 160                 result_file.write(str(cases_line) + '\n')
 161         result_file.close()
 162
 163     def _parse_verification_id(line):
 164         first_pos = line.index("UUID=") + len("UUID=")
 165         last_pos = line.index(") for deployment")
 166         return line[first_pos:last_pos]
 167
 168     def run_verifier_tests(self):
 169         self.OPTION += (" --load-list {}".format(conf_utils.TEMPEST_LIST))
 170
 171         cmd_line = "rally verify start " + self.OPTION
 172         logger.info("Starting Tempest test suite: '%s'." % cmd_line)
 173
 174         header = ("Tempest environment:\n"
 175                   "  Installer: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
 176                   (CONST.INSTALLER_TYPE,
 177                    CONST.DEPLOY_SCENARIO,
 178                    CONST.NODE_NAME,
 179                    time.strftime("%a %b %d %H:%M:%S %Z %Y")))
 180
 181         f_stdout = open(
 182             os.path.join(conf_utils.TEMPEST_RESULTS_DIR, "tempest.log"), 'w+')
 183         f_stderr = open(
 184             os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 185                          "tempest-error.log"), 'w+')
 186         f_env = open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 187                                   "environment.log"), 'w+')
 188         f_env.write(header)
 189
 190         p = subprocess.Popen(
 191             cmd_line, shell=True,
 192             stdout=subprocess.PIPE,
 193             stderr=f_stderr,
 194             bufsize=1)
 195
 196         with p.stdout:
 197             for line in iter(p.stdout.readline, b''):
 198                 if re.search("\} tempest\.", line):
 199                     logger.info(line.replace('\n', ''))
 200                 elif re.search('Starting verification', line):
 201                     logger.info(line.replace('\n', ''))
 202                     first_pos = line.index("UUID=") + len("UUID=")
 203                     last_pos = line.index(") for deployment")
 204                     self.VERIFICATION_ID = line[first_pos:last_pos]
 205                     logger.debug('Verication UUID: %s' % self.VERIFICATION_ID)
 206                 f_stdout.write(line)
 207         p.wait()
 208
 209         f_stdout.close()
 210         f_stderr.close()
 211         f_env.close()
 212
 213     def parse_verifier_result(self):
 214         if self.VERIFICATION_ID is None:
 215             raise Exception('Verification UUID not found')
 216
 217         cmd_line = "rally verify show --uuid {}".format(self.VERIFICATION_ID)
 218         logger.info("Showing result for a verification: '%s'." % cmd_line)
 219         p = subprocess.Popen(cmd_line,
 220                              shell=True,
 221                              stdout=subprocess.PIPE,
 222                              stderr=subprocess.STDOUT)
 223         for line in p.stdout:
 224             new_line = line.replace(' ', '').split('|')
 225             if 'Tests' in new_line:
 226                 break
 227
 228             logger.info(line)
 229             if 'Testscount' in new_line:
 230                 num_tests = new_line[2]
 231             elif 'Success' in new_line:
 232                 num_success = new_line[2]
 233             elif 'Skipped' in new_line:
 234                 num_skipped = new_line[2]
 235             elif 'Failures' in new_line:
 236                 num_failures = new_line[2]
 237
 238         try:
 239             num_executed = int(num_tests) - int(num_skipped)
 240             success_rate = 100 * int(num_success) / int(num_executed)
 241             with open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 242                                    "tempest.log"), 'r') as logfile:
 243                 output = logfile.read()
 244
 245             error_logs = ""
 246             for match in re.findall('(.*?)[. ]*fail ', output):
 247                 error_logs += match
 248             skipped_testcase = ""
 249             for match in re.findall('(.*?)[. ]*skip:', output):
 250                 skipped_testcase += match
 251
 252             self.details = {"tests": int(num_tests),
 253                             "failures": int(num_failures),
 254                             "errors": error_logs,
 255                             "skipped": skipped_testcase}
 256         except Exception:
 257             success_rate = 0
 258
 259         self.criteria = ft_utils.check_success_rate(
 260             self.case_name, success_rate)
 261         logger.info("Tempest %s success_rate is %s%%, is marked as %s"
 262                     % (self.case_name, success_rate, self.criteria))
 263
 264     def run(self):
 265
 266         self.start_time = time.time()
 267
 268         if not os.path.exists(conf_utils.TEMPEST_RESULTS_DIR):
 269             os.makedirs(conf_utils.TEMPEST_RESULTS_DIR)
 270
 271         try:
 272             self.create_tempest_resources()
 273             conf_utils.configure_tempest(self.DEPLOYMENT_DIR,
 274                                          self.IMAGE_ID,
 275                                          self.FLAVOR_ID,
 276                                          self.MODE)
 277             self.generate_test_list(self.VERIFIER_REPO_DIR)
 278             self.apply_tempest_blacklist()
 279             self.run_verifier_tests()
 280             self.parse_verifier_result()
 281             res = testcase_base.TestcaseBase.EX_OK
 282         except Exception as e:
 283             logger.error('Error with run: %s' % e)
 284             res = testcase_base.TestcaseBase.EX_RUN_ERROR
 285
 286         self.stop_time = time.time()
 287         return res
 288
 289
 290 class TempestSmokeSerial(TempestCommon):
 291
 292     def __init__(self):
 293         TempestCommon.__init__(self)
 294         self.case_name = "tempest_smoke_serial"
 295         self.MODE = "smoke"
 296         self.OPTION = "--concurrency 1"
 297
 298
 299 class TempestSmokeParallel(TempestCommon):
 300
 301     def __init__(self):
 302         TempestCommon.__init__(self)
 303         self.case_name = "tempest_smoke_parallel"
 304         self.MODE = "smoke"
 305         self.OPTION = ""
 306
 307
 308 class TempestFullParallel(TempestCommon):
 309
 310     def __init__(self):
 311         TempestCommon.__init__(self)
 312         self.case_name = "tempest_full_parallel"
 313         self.MODE = "full"
 314
 315
 316 class TempestMultisite(TempestCommon):
 317
 318     def __init__(self):
 319         TempestCommon.__init__(self)
 320         self.case_name = "multisite"
 321         self.MODE = "feature_multisite"
 322         self.OPTION = "--concurrency 1"
 323
 324
 325 class TempestCustom(TempestCommon):
 326
 327     def __init__(self):
 328         TempestCommon.__init__(self)
 329         self.case_name = "tempest_custom"
 330         self.MODE = "custom"
 331         self.OPTION = "--concurrency 1"
 332
 333
 334 class TempestDefcore(TempestCommon):
 335
 336     def __init__(self):
 337         TempestCommon.__init__(self)
 338         self.case_name = "tempest_defcore"
 339         self.MODE = "defcore"
 340         self.OPTION = "--concurrency 1"