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("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("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 not network_dic:
  78             return testcase_base.TestcaseBase.EX_RUN_ERROR
  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 not self.IMAGE_ID:
  87                 return testcase_base.TestcaseBase.EX_RUN_ERROR
  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 not self.FLAVOR_ID:
  98                 return testcase_base.TestcaseBase.EX_RUN_ERROR
  99
 100         return testcase_base.TestcaseBase.EX_OK
 101
 102     def generate_test_list(self, verifier_repo_dir):
 103         logger.debug("Generating test case list...")
 104         if self.MODE == 'defcore':
 105             shutil.copyfile(
 106                 conf_utils.TEMPEST_DEFCORE, conf_utils.TEMPEST_RAW_LIST)
 107         elif self.MODE == 'custom':
 108             if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
 109                 shutil.copyfile(
 110                     conf_utils.TEMPEST_CUSTOM, conf_utils.TEMPEST_RAW_LIST)
 111             else:
 112                 logger.error("Tempest test list file %s NOT found."
 113                              % conf_utils.TEMPEST_CUSTOM)
 114                 return testcase_base.TestcaseBase.EX_RUN_ERROR
 115         else:
 116             if self.MODE == 'smoke':
 117                 testr_mode = "smoke"
 118             elif self.MODE == 'feature_multisite':
 119                 testr_mode = " | grep -i kingbird "
 120             elif self.MODE == 'full':
 121                 testr_mode = ""
 122             else:
 123                 testr_mode = 'tempest.api.' + self.MODE
 124             cmd = ("cd {0};"
 125                    "testr list-tests {1} > {2};"
 126                    "cd -;".format(verifier_repo_dir,
 127                                   testr_mode,
 128                                   conf_utils.TEMPEST_RAW_LIST))
 129             ft_utils.execute_command(cmd)
 130
 131         return testcase_base.TestcaseBase.EX_OK
 132
 133     def apply_tempest_blacklist(self):
 134         logger.debug("Applying tempest blacklist...")
 135         cases_file = self.read_file(conf_utils.TEMPEST_RAW_LIST)
 136         result_file = open(conf_utils.TEMPEST_LIST, 'w')
 137         black_tests = []
 138         try:
 139             installer_type = CONST.INSTALLER_TYPE
 140             deploy_scenario = CONST.DEPLOY_SCENARIO
 141             if (bool(installer_type) * bool(deploy_scenario)):
 142                 # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the
 143                 # file
 144                 black_list_file = open(conf_utils.TEMPEST_BLACKLIST)
 145                 black_list_yaml = yaml.safe_load(black_list_file)
 146                 black_list_file.close()
 147                 for item in black_list_yaml:
 148                     scenarios = item['scenarios']
 149                     installers = item['installers']
 150                     if (deploy_scenario in scenarios and
 151                             installer_type in installers):
 152                         tests = item['tests']
 153                         for test in tests:
 154                             black_tests.append(test)
 155                         break
 156         except Exception:
 157             black_tests = []
 158             logger.debug("Tempest blacklist file does not exist.")
 159
 160         for cases_line in cases_file:
 161             for black_tests_line in black_tests:
 162                 if black_tests_line in cases_line:
 163                     break
 164             else:
 165                 result_file.write(str(cases_line) + '\n')
 166         result_file.close()
 167         return testcase_base.TestcaseBase.EX_OK
 168
 169     def _parse_verification_id(line):
 170         first_pos = line.index("UUID=") + len("UUID=")
 171         last_pos = line.index(") for deployment")
 172         return line[first_pos:last_pos]
 173
 174     def run_verifier_tests(self):
 175         self.OPTION += (" --load-list {}".format(conf_utils.TEMPEST_LIST))
 176
 177         cmd_line = "rally verify start " + self.OPTION
 178         logger.info("Starting Tempest test suite: '%s'." % cmd_line)
 179
 180         header = ("Tempest environment:\n"
 181                   "  Installer: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
 182                   (CONST.INSTALLER_TYPE,
 183                    CONST.DEPLOY_SCENARIO,
 184                    CONST.NODE_NAME,
 185                    time.strftime("%a %b %d %H:%M:%S %Z %Y")))
 186
 187         f_stdout = open(
 188             os.path.join(conf_utils.TEMPEST_RESULTS_DIR, "tempest.log"), 'w+')
 189         f_stderr = open(
 190             os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 191                          "tempest-error.log"), 'w+')
 192         f_env = open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 193                                   "environment.log"), 'w+')
 194         f_env.write(header)
 195
 196         p = subprocess.Popen(
 197             cmd_line, shell=True,
 198             stdout=subprocess.PIPE,
 199             stderr=f_stderr,
 200             bufsize=1)
 201
 202         with p.stdout:
 203             for line in iter(p.stdout.readline, b''):
 204                 if re.search("\} tempest\.", line):
 205                     logger.info(line.replace('\n', ''))
 206                 elif re.search('Starting verification', line):
 207                     logger.info(line.replace('\n', ''))
 208                     first_pos = line.index("UUID=") + len("UUID=")
 209                     last_pos = line.index(") for deployment")
 210                     self.VERIFICATION_ID = line[first_pos:last_pos]
 211                     logger.debug('Verication UUID: %s' % self.VERIFICATION_ID)
 212                 f_stdout.write(line)
 213         p.wait()
 214
 215         f_stdout.close()
 216         f_stderr.close()
 217         f_env.close()
 218
 219     def parse_verifier_result(self):
 220         if not self.VERIFICATION_ID:
 221             raise Exception('Verification UUID not found')
 222
 223         cmd_line = "rally verify show --uuid {}".format(self.VERIFICATION_ID)
 224         logger.info("Showing result for a verification: '%s'." % cmd_line)
 225         p = subprocess.Popen(cmd_line,
 226                              shell=True,
 227                              stdout=subprocess.PIPE,
 228                              stderr=subprocess.STDOUT)
 229         for line in p.stdout:
 230             new_line = line.replace(' ', '').split('|')
 231             if 'Tests' in new_line:
 232                 break
 233
 234             logger.info(line)
 235             if 'Testscount' in new_line:
 236                 num_tests = new_line[2]
 237             elif 'Success' in new_line:
 238                 num_success = new_line[2]
 239             elif 'Skipped' in new_line:
 240                 num_skipped = new_line[2]
 241             elif 'Failures' in new_line:
 242                 num_failures = new_line[2]
 243
 244         try:
 245             num_executed = int(num_tests) - int(num_skipped)
 246             success_rate = 100 * int(num_success) / int(num_executed)
 247             with open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 248                                    "tempest.log"), 'r') as logfile:
 249                 output = logfile.read()
 250
 251             error_logs = ""
 252             for match in re.findall('(.*?)[. ]*FAILED', output):
 253                 error_logs += match
 254
 255             self.details = {"tests": int(num_tests),
 256                             "failures": int(num_failures),
 257                             "errors": error_logs}
 258         except Exception:
 259             success_rate = 0
 260
 261         self.criteria = ft_utils.check_success_rate(
 262             self.case_name, success_rate)
 263         logger.info("Tempest %s success_rate is %s%%, is marked as %s"
 264                     % (self.case_name, success_rate, self.criteria))
 265
 266     def run(self):
 267
 268         self.start_time = time.time()
 269
 270         if not os.path.exists(conf_utils.TEMPEST_RESULTS_DIR):
 271             os.makedirs(conf_utils.TEMPEST_RESULTS_DIR)
 272
 273         # Pre-configuration
 274         res = self.create_tempest_resources()
 275         if res != testcase_base.TestcaseBase.EX_OK:
 276             return res
 277
 278         res = conf_utils.configure_tempest(self.DEPLOYMENT_DIR,
 279                                            self.IMAGE_ID,
 280                                            self.FLAVOR_ID)
 281         if res != testcase_base.TestcaseBase.EX_OK:
 282             return res
 283
 284         res = self.generate_test_list(self.VERIFIER_REPO_DIR)
 285         if res != testcase_base.TestcaseBase.EX_OK:
 286             return res
 287
 288         res = self.apply_tempest_blacklist()
 289         if res != testcase_base.TestcaseBase.EX_OK:
 290             return res
 291
 292         self.run_verifier_tests()
 293         self.parse_verifier_result()
 294
 295         self.stop_time = time.time()
 296
 297         # If we are here, it means that the test case was successfully executed
 298         # criteria is managed by the criteria Field
 299         return testcase_base.TestcaseBase.EX_OK
 300
 301
 302 class TempestSmokeSerial(TempestCommon):
 303
 304     def __init__(self):
 305         TempestCommon.__init__(self)
 306         self.case_name = "tempest_smoke_serial"
 307         self.MODE = "smoke"
 308         self.OPTION = "--concurrency 1"
 309
 310
 311 class TempestSmokeParallel(TempestCommon):
 312
 313     def __init__(self):
 314         TempestCommon.__init__(self)
 315         self.case_name = "tempest_smoke_parallel"
 316         self.MODE = "smoke"
 317         self.OPTION = ""
 318
 319
 320 class TempestFullParallel(TempestCommon):
 321
 322     def __init__(self):
 323         TempestCommon.__init__(self)
 324         self.case_name = "tempest_full_parallel"
 325         self.MODE = "full"
 326
 327
 328 class TempestMultisite(TempestCommon):
 329
 330     def __init__(self):
 331         TempestCommon.__init__(self)
 332         self.case_name = "multisite"
 333         self.MODE = "feature_multisite"
 334         self.OPTION = "--concurrency 1"
 335         conf_utils.configure_tempest_multisite(self.DEPLOYMENT_DIR)
 336
 337
 338 class TempestCustom(TempestCommon):
 339
 340     def __init__(self, mode, option):
 341         TempestCommon.__init__(self)
 342         self.case_name = "tempest_custom"
 343         self.MODE = mode
 344         self.OPTION = option