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 = self.get_verifier_id()
  39         self.VERIFIER_REPO_DIR = self.get_verifier_repo_dir()
  40         self.DEPLOYMENT_ID = self.get_verifier_deployment_id()
  41         self.DEPLOYMENT_DIR = self.get_verifier_deployment_dir()
  42         self.VERIFICATION_ID = None
  43
  44     @staticmethod
  45     def get_verifier_id():
  46         """
  47         Returns verifer id for current Tempest
  48         """
  49         cmd = ("rally verify list-verifiers | awk '/" +
  50                CONST.tempest_deployment_name +
  51                "/ {print $2}'")
  52         p = subprocess.Popen(cmd, shell=True,
  53                              stdout=subprocess.PIPE,
  54                              stderr=subprocess.STDOUT)
  55         deployment_uuid = p.stdout.readline().rstrip()
  56         if deployment_uuid == "":
  57             logger.error("Tempest verifier not found.")
  58             raise Exception('Error with command:%s' % cmd)
  59         return deployment_uuid
  60
  61     @staticmethod
  62     def get_verifier_deployment_id():
  63         """
  64         Returns deployment id for active Rally deployment
  65         """
  66         cmd = ("rally deployment list | awk '/" +
  67                CONST.rally_deployment_name +
  68                "/ {print $2}'")
  69         p = subprocess.Popen(cmd, shell=True,
  70                              stdout=subprocess.PIPE,
  71                              stderr=subprocess.STDOUT)
  72         deployment_uuid = p.stdout.readline().rstrip()
  73         if deployment_uuid == "":
  74             logger.error("Rally deployment not found.")
  75             raise Exception('Error with command:%s' % cmd)
  76         return deployment_uuid
  77
  78     def get_verifier_repo_dir(self):
  79         """
  80         Returns installed verfier repo directory for Tempest
  81         """
  82         if not self.VERIFIER_ID:
  83             self.VERIFIER_ID = self.get_verifier_id()
  84
  85         return os.path.join(CONST.dir_rally_inst,
  86                             'verification',
  87                             'verifier-{}'.format(self.VERIFIER_ID),
  88                             'repo')
  89
  90     def get_verifier_deployment_dir(self):
  91         """
  92         Returns Rally deployment directory for current verifier
  93         """
  94         if not self.VERIFIER_ID:
  95             self.VERIFIER_ID = self.get_verifier_id()
  96
  97         if not self.DEPLOYMENT_ID:
  98             self.DEPLOYMENT_ID = self.get_verifier_deployment_id()
  99
 100         return os.path.join(CONST.dir_rally_inst,
 101                             'verification',
 102                             'verifier-{}'.format(self.VERIFIER_ID),
 103                             'for-deployment-{}'.format(self.DEPLOYMENT_ID))
 104
 105     @staticmethod
 106     def read_file(filename):
 107         with open(filename) as src:
 108             return [line.strip() for line in src.readlines()]
 109
 110     def create_tempest_resources(self):
 111         keystone_client = os_utils.get_keystone_client()
 112
 113         logger.debug("Creating tenant and user for Tempest suite")
 114         tenant_id = os_utils.create_tenant(
 115             keystone_client,
 116             CONST.tempest_identity_tenant_name,
 117             CONST.tempest_identity_tenant_description)
 118         if not tenant_id:
 119             logger.error("Error : Failed to create %s tenant"
 120                          % CONST.tempest_identity_tenant_name)
 121
 122         user_id = os_utils.create_user(keystone_client,
 123                                        CONST.tempest_identity_user_name,
 124                                        CONST.tempest_identity_user_password,
 125                                        None, tenant_id)
 126         if not user_id:
 127             logger.error("Error : Failed to create %s user" %
 128                          CONST.tempest_identity_user_name)
 129
 130         logger.debug("Creating private network for Tempest suite")
 131         network_dic = os_utils.create_shared_network_full(
 132             CONST.tempest_private_net_name,
 133             CONST.tempest_private_subnet_name,
 134             CONST.tempest_router_name,
 135             CONST.tempest_private_subnet_cidr)
 136         if not network_dic:
 137             return testcase_base.TestcaseBase.EX_RUN_ERROR
 138
 139         if CONST.tempest_use_custom_images:
 140             # adding alternative image should be trivial should we need it
 141             logger.debug("Creating image for Tempest suite")
 142             _, self.IMAGE_ID = os_utils.get_or_create_image(
 143                 CONST.openstack_image_name, conf_utils.GLANCE_IMAGE_PATH,
 144                 CONST.openstack_image_disk_format)
 145             if not self.IMAGE_ID:
 146                 return testcase_base.TestcaseBase.EX_RUN_ERROR
 147
 148         if CONST.tempest_use_custom_flavors:
 149             # adding alternative flavor should be trivial should we need it
 150             logger.debug("Creating flavor for Tempest suite")
 151             _, self.FLAVOR_ID = os_utils.get_or_create_flavor(
 152                 CONST.openstack_flavor_name,
 153                 CONST.openstack_flavor_ram,
 154                 CONST.openstack_flavor_disk,
 155                 CONST.openstack_flavor_vcpus)
 156             if not self.FLAVOR_ID:
 157                 return testcase_base.TestcaseBase.EX_RUN_ERROR
 158
 159         return testcase_base.TestcaseBase.EX_OK
 160
 161     def generate_test_list(self, verifier_repo_dir):
 162         logger.debug("Generating test case list...")
 163         if self.MODE == 'defcore':
 164             shutil.copyfile(
 165                 conf_utils.TEMPEST_DEFCORE, conf_utils.TEMPEST_RAW_LIST)
 166         elif self.MODE == 'custom':
 167             if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
 168                 shutil.copyfile(
 169                     conf_utils.TEMPEST_CUSTOM, conf_utils.TEMPEST_RAW_LIST)
 170             else:
 171                 logger.error("Tempest test list file %s NOT found."
 172                              % conf_utils.TEMPEST_CUSTOM)
 173                 return testcase_base.TestcaseBase.EX_RUN_ERROR
 174         else:
 175             if self.MODE == 'smoke':
 176                 testr_mode = "smoke"
 177             elif self.MODE == 'feature_multisite':
 178                 testr_mode = " | grep -i kingbird "
 179             elif self.MODE == 'full':
 180                 testr_mode = ""
 181             else:
 182                 testr_mode = 'tempest.api.' + self.MODE
 183             cmd = ("cd {0};"
 184                    "testr list-tests {1} > {2};"
 185                    "cd -;".format(verifier_repo_dir,
 186                                   testr_mode,
 187                                   conf_utils.TEMPEST_RAW_LIST))
 188             ft_utils.execute_command(cmd)
 189
 190         return testcase_base.TestcaseBase.EX_OK
 191
 192     def apply_tempest_blacklist(self):
 193         logger.debug("Applying tempest blacklist...")
 194         cases_file = self.read_file(conf_utils.TEMPEST_RAW_LIST)
 195         result_file = open(conf_utils.TEMPEST_LIST, 'w')
 196         black_tests = []
 197         try:
 198             installer_type = CONST.INSTALLER_TYPE
 199             deploy_scenario = CONST.DEPLOY_SCENARIO
 200             if (bool(installer_type) * bool(deploy_scenario)):
 201                 # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the
 202                 # file
 203                 black_list_file = open(conf_utils.TEMPEST_BLACKLIST)
 204                 black_list_yaml = yaml.safe_load(black_list_file)
 205                 black_list_file.close()
 206                 for item in black_list_yaml:
 207                     scenarios = item['scenarios']
 208                     installers = item['installers']
 209                     if (deploy_scenario in scenarios and
 210                             installer_type in installers):
 211                         tests = item['tests']
 212                         for test in tests:
 213                             black_tests.append(test)
 214                         break
 215         except Exception:
 216             black_tests = []
 217             logger.debug("Tempest blacklist file does not exist.")
 218
 219         for cases_line in cases_file:
 220             for black_tests_line in black_tests:
 221                 if black_tests_line in cases_line:
 222                     break
 223             else:
 224                 result_file.write(str(cases_line) + '\n')
 225         result_file.close()
 226         return testcase_base.TestcaseBase.EX_OK
 227
 228     def _parse_verification_id(line):
 229         first_pos = line.index("UUID=") + len("UUID=")
 230         last_pos = line.index(") for deployment")
 231         return line[first_pos:last_pos]
 232
 233     def run_verifier_tests(self):
 234         self.OPTION += (" --load-list {}".format(conf_utils.TEMPEST_LIST))
 235
 236         cmd_line = "rally verify start " + self.OPTION
 237         logger.info("Starting Tempest test suite: '%s'." % cmd_line)
 238
 239         header = ("Tempest environment:\n"
 240                   "  Installer: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
 241                   (CONST.INSTALLER_TYPE,
 242                    CONST.DEPLOY_SCENARIO,
 243                    CONST.NODE_NAME,
 244                    time.strftime("%a %b %d %H:%M:%S %Z %Y")))
 245
 246         f_stdout = open(
 247             os.path.join(conf_utils.TEMPEST_RESULTS_DIR, "tempest.log"), 'w+')
 248         f_stderr = open(
 249             os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 250                          "tempest-error.log"), 'w+')
 251         f_env = open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
 252                                   "environment.log"), 'w+')
 253         f_env.write(header)
 254
 255         p = subprocess.Popen(
 256             cmd_line, shell=True,
 257             stdout=subprocess.PIPE,
 258             stderr=f_stderr,
 259             bufsize=1)
 260
 261         with p.stdout:
 262             for line in iter(p.stdout.readline, b''):
 263                 if re.search("\} tempest\.", line):
 264                     logger.info(line.replace('\n', ''))
 265                 elif re.search('Starting verification', line):
 266                     logger.info(line.replace('\n', ''))
 267                     first_pos = line.index("UUID=") + len("UUID=")
 268                     last_pos = line.index(") for deployment")
 269                     self.VERIFICATION_ID = line[first_pos:last_pos]
 270                     logger.debug('Verication UUID: %s' % self.VERIFICATION_ID)
 271                 f_stdout.write(line)
 272         p.wait()
 273
 274         f_stdout.close()
 275         f_stderr.close()
 276         f_env.close()
 277
 278     def parse_verifier_result(self):
 279         if not self.VERIFICATION_ID:
 280             raise Exception('Verification UUID not found')
 281
 282         cmd_line = "rally verify show --uuid {}".format(self.VERIFICATION_ID)
 283         logger.info("Showing result for a verification: '%s'." % cmd_line)
 284         p = subprocess.Popen(cmd_line,
 285                              shell=True,
 286                              stdout=subprocess.PIPE,
 287                              stderr=subprocess.STDOUT)
 288         for line in p.stdout:
 289             new_line = line.replace(' ', '').split('|')
 290             if 'Tests' in new_line:
 291                 break
 292
 293             logger.info(line)
 294             if 'Testscount' in new_line:
 295                 num_tests = new_line[2]
 296             elif 'Success' in new_line:
 297                 num_success = new_line[2]
 298             elif 'Skipped' in new_line:
 299                 num_skipped = new_line[2]
 300
 301         try:
 302             num_executed = int(num_tests) - int(num_skipped)
 303             success_rate = 100 * int(num_success) / int(num_executed)
 304         except Exception:
 305             success_rate = 0
 306
 307         self.criteria = ft_utils.check_success_rate(
 308             self.case_name, success_rate)
 309         logger.info("Tempest %s success_rate is %s%%, is marked as %s"
 310                     % (self.case_name, success_rate, self.criteria))
 311
 312     def run(self):
 313
 314         self.start_time = time.time()
 315
 316         if not os.path.exists(conf_utils.TEMPEST_RESULTS_DIR):
 317             os.makedirs(conf_utils.TEMPEST_RESULTS_DIR)
 318
 319         # Pre-configuration
 320         res = self.create_tempest_resources()
 321         if res != testcase_base.TestcaseBase.EX_OK:
 322             return res
 323
 324         res = conf_utils.configure_tempest(logger,
 325                                            self.DEPLOYMENT_DIR,
 326                                            self.IMAGE_ID,
 327                                            self.FLAVOR_ID)
 328         if res != testcase_base.TestcaseBase.EX_OK:
 329             return res
 330
 331         res = self.generate_test_list(self.VERIFIER_REPO_DIR)
 332         if res != testcase_base.TestcaseBase.EX_OK:
 333             return res
 334
 335         res = self.apply_tempest_blacklist()
 336         if res != testcase_base.TestcaseBase.EX_OK:
 337             return res
 338
 339         self.run_verifier_tests()
 340         self.parse_verifier_result()
 341
 342         self.stop_time = time.time()
 343
 344         if self.criteria == "PASS":
 345             return testcase_base.TestcaseBase.EX_OK
 346         else:
 347             return testcase_base.TestcaseBase.EX_TESTCASE_FAILED
 348
 349
 350 class TempestSmokeSerial(TempestCommon):
 351
 352     def __init__(self):
 353         TempestCommon.__init__(self)
 354         self.case_name = "tempest_smoke_serial"
 355         self.MODE = "smoke"
 356         self.OPTION = "--concurrency 1"
 357
 358
 359 class TempestSmokeParallel(TempestCommon):
 360
 361     def __init__(self):
 362         TempestCommon.__init__(self)
 363         self.case_name = "tempest_smoke_parallel"
 364         self.MODE = "smoke"
 365         self.OPTION = ""
 366
 367
 368 class TempestFullParallel(TempestCommon):
 369
 370     def __init__(self):
 371         TempestCommon.__init__(self)
 372         self.case_name = "tempest_full_parallel"
 373         self.MODE = "full"
 374
 375
 376 class TempestMultisite(TempestCommon):
 377
 378     def __init__(self):
 379         TempestCommon.__init__(self)
 380         self.case_name = "multisite"
 381         self.MODE = "feature_multisite"
 382         self.OPTION = "--concurrency 1"
 383         conf_utils.configure_tempest_multisite(logger, self.DEPLOYMENT_DIR)
 384
 385
 386 class TempestCustom(TempestCommon):
 387
 388     def __init__(self, mode, option):
 389         TempestCommon.__init__(self)
 390         self.case_name = "tempest_custom"
 391         self.MODE = mode
 392         self.OPTION = option