testcases/OpenStack/tempest/run_tempest.py

   1 #!/usr/bin/env python
   2 #
   3 # Description:
   4 #    Runs tempest and pushes the results to the DB
   5 #
   6 # Authors:
   7 #    morgan.richomme@orange.com
   8 #    jose.lausuch@ericsson.com
   9 #    viktor.tikkanen@nokia.com
  10 #
  11 # All rights reserved. This program and the accompanying materials
  12 # are made available under the terms of the Apache License, Version 2.0
  13 # which accompanies this distribution, and is available at
  14 # http://www.apache.org/licenses/LICENSE-2.0
  15 #
  16 import ConfigParser
  17 import argparse
  18 import os
  19 import re
  20 import shutil
  21 import subprocess
  22 import sys
  23 import time
  24
  25 import functest.utils.functest_logger as ft_logger
  26 import functest.utils.functest_utils as ft_utils
  27 import functest.utils.openstack_utils as os_utils
  28 import yaml
  29
  30
  31 modes = ['full', 'smoke', 'baremetal', 'compute', 'data_processing',
  32          'identity', 'image', 'network', 'object_storage', 'orchestration',
  33          'telemetry', 'volume', 'custom', 'defcore', 'feature_multisite']
  34
  35 """ tests configuration """
  36 parser = argparse.ArgumentParser()
  37 parser.add_argument("-d", "--debug",
  38                     help="Debug mode",
  39                     action="store_true")
  40 parser.add_argument("-s", "--serial",
  41                     help="Run tests in one thread",
  42                     action="store_true")
  43 parser.add_argument("-m", "--mode",
  44                     help="Tempest test mode [smoke, all]",
  45                     default="smoke")
  46 parser.add_argument("-r", "--report",
  47                     help="Create json result file",
  48                     action="store_true")
  49 parser.add_argument("-n", "--noclean",
  50                     help="Don't clean the created resources for this test.",
  51                     action="store_true")
  52
  53 args = parser.parse_args()
  54
  55 """ logging configuration """
  56 logger = ft_logger.Logger("run_tempest").getLogger()
  57
  58 REPO_PATH = os.environ['repos_dir'] + '/functest/'
  59
  60 with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
  61     functest_yaml = yaml.safe_load(f)
  62 f.close()
  63 TEST_DB = functest_yaml.get("results").get("test_db_url")
  64
  65 MODE = "smoke"
  66 GLANCE_IMAGE_NAME = functest_yaml.get("general").get(
  67     "openstack").get("image_name")
  68 GLANCE_IMAGE_FILENAME = functest_yaml.get("general").get(
  69     "openstack").get("image_file_name")
  70 GLANCE_IMAGE_FORMAT = functest_yaml.get("general").get(
  71     "openstack").get("image_disk_format")
  72 GLANCE_IMAGE_PATH = functest_yaml.get("general").get("directories").get(
  73     "dir_functest_data") + "/" + GLANCE_IMAGE_FILENAME
  74 PRIVATE_NET_NAME = functest_yaml.get("tempest").get("private_net_name")
  75 PRIVATE_SUBNET_NAME = functest_yaml.get("tempest").get("private_subnet_name")
  76 PRIVATE_SUBNET_CIDR = functest_yaml.get("tempest").get("private_subnet_cidr")
  77 ROUTER_NAME = functest_yaml.get("tempest").get("router_name")
  78 TENANT_NAME = functest_yaml.get("tempest").get("identity").get("tenant_name")
  79 TENANT_DESCRIPTION = functest_yaml.get("tempest").get("identity").get(
  80     "tenant_description")
  81 USER_NAME = functest_yaml.get("tempest").get("identity").get("user_name")
  82 USER_PASSWORD = functest_yaml.get("tempest").get("identity").get(
  83     "user_password")
  84 SSH_TIMEOUT = functest_yaml.get("tempest").get("validation").get(
  85     "ssh_timeout")
  86 DEPLOYMENT_MAME = functest_yaml.get("rally").get("deployment_name")
  87 RALLY_INSTALLATION_DIR = functest_yaml.get("general").get("directories").get(
  88     "dir_rally_inst")
  89 RESULTS_DIR = functest_yaml.get("general").get("directories").get(
  90     "dir_results")
  91 TEMPEST_RESULTS_DIR = RESULTS_DIR + '/tempest'
  92 TEST_LIST_DIR = functest_yaml.get("general").get("directories").get(
  93     "dir_tempest_cases")
  94 TEMPEST_CUSTOM = REPO_PATH + TEST_LIST_DIR + 'test_list.txt'
  95 TEMPEST_BLACKLIST = REPO_PATH + TEST_LIST_DIR + 'blacklist.txt'
  96 TEMPEST_DEFCORE = REPO_PATH + TEST_LIST_DIR + 'defcore_req.txt'
  97 TEMPEST_RAW_LIST = TEMPEST_RESULTS_DIR + '/test_raw_list.txt'
  98 TEMPEST_LIST = TEMPEST_RESULTS_DIR + '/test_list.txt'
  99
 100
 101 def get_info(file_result):
 102     test_run = ""
 103     duration = ""
 104     test_failed = ""
 105
 106     p = subprocess.Popen('cat tempest.log',
 107                          shell=True, stdout=subprocess.PIPE,
 108                          stderr=subprocess.STDOUT)
 109     for line in p.stdout.readlines():
 110         # print line,
 111         if (len(test_run) < 1):
 112             test_run = re.findall("[0-9]*\.[0-9]*s", line)
 113         if (len(duration) < 1):
 114             duration = re.findall("[0-9]*\ tests", line)
 115         regexp = r"(failures=[0-9]+)"
 116         if (len(test_failed) < 1):
 117             test_failed = re.findall(regexp, line)
 118
 119     logger.debug("test_run:" + test_run)
 120     logger.debug("duration:" + duration)
 121
 122
 123 def create_tempest_resources():
 124     keystone_client = os_utils.get_keystone_client()
 125     neutron_client = os_utils.get_neutron_client()
 126     glance_client = os_utils.get_glance_client()
 127
 128     logger.debug("Creating tenant and user for Tempest suite")
 129     tenant_id = os_utils.create_tenant(keystone_client,
 130                                        TENANT_NAME,
 131                                        TENANT_DESCRIPTION)
 132     if tenant_id == '':
 133         logger.error("Error : Failed to create %s tenant" % TENANT_NAME)
 134
 135     user_id = os_utils.create_user(keystone_client, USER_NAME, USER_PASSWORD,
 136                                    None, tenant_id)
 137     if user_id == '':
 138         logger.error("Error : Failed to create %s user" % USER_NAME)
 139
 140     logger.debug("Creating private network for Tempest suite")
 141     network_dic = os_utils.create_network_full(neutron_client,
 142                                                PRIVATE_NET_NAME,
 143                                                PRIVATE_SUBNET_NAME,
 144                                                ROUTER_NAME,
 145                                                PRIVATE_SUBNET_CIDR)
 146     if network_dic:
 147         if not os_utils.update_neutron_net(neutron_client,
 148                                            network_dic['net_id'],
 149                                            shared=True):
 150             logger.error("Failed to update private network...")
 151             exit(-1)
 152         else:
 153             logger.debug("Network '%s' is available..." % PRIVATE_NET_NAME)
 154     else:
 155         logger.error("Private network creation failed")
 156         exit(-1)
 157
 158     logger.debug("Creating image for Tempest suite")
 159     # Check if the given image exists
 160     image_id = os_utils.get_image_id(glance_client, GLANCE_IMAGE_NAME)
 161     if image_id != '':
 162         logger.info("Using existing image '%s'..." % GLANCE_IMAGE_NAME)
 163     else:
 164         logger.info("Creating image '%s' from '%s'..." % (GLANCE_IMAGE_NAME,
 165                                                           GLANCE_IMAGE_PATH))
 166         image_id = os_utils.create_glance_image(glance_client,
 167                                                 GLANCE_IMAGE_NAME,
 168                                                 GLANCE_IMAGE_PATH)
 169         if not image_id:
 170             logger.error("Failed to create a Glance image...")
 171             exit(-1)
 172         logger.debug("Image '%s' with ID=%s created successfully."
 173                      % (GLANCE_IMAGE_NAME, image_id))
 174
 175
 176 def configure_tempest(deployment_dir):
 177     """
 178     Add/update needed parameters into tempest.conf file generated by Rally
 179     """
 180
 181     tempest_conf_file = deployment_dir + "/tempest.conf"
 182     if os.path.isfile(tempest_conf_file):
 183         logger.debug("Deleting old tempest.conf file...")
 184         os.remove(tempest_conf_file)
 185
 186     logger.debug("Generating new tempest.conf file...")
 187     cmd = "rally verify genconfig"
 188     ft_utils.execute_command(cmd, logger)
 189
 190     logger.debug("Finding tempest.conf file...")
 191     if not os.path.isfile(tempest_conf_file):
 192         logger.error("Tempest configuration file %s NOT found."
 193                      % tempest_conf_file)
 194         exit(-1)
 195
 196     logger.debug("Updating selected tempest.conf parameters...")
 197     config = ConfigParser.RawConfigParser()
 198     config.read(tempest_conf_file)
 199     config.set('compute', 'fixed_network_name', PRIVATE_NET_NAME)
 200     config.set('identity', 'tenant_name', TENANT_NAME)
 201     config.set('identity', 'username', USER_NAME)
 202     config.set('identity', 'password', USER_PASSWORD)
 203     config.set('validation', 'ssh_timeout', SSH_TIMEOUT)
 204
 205     if os.getenv('OS_ENDPOINT_TYPE') is not None:
 206         services_list = ['compute', 'volume', 'image', 'network',
 207                          'data-processing', 'object-storage', 'orchestration']
 208         sections = config.sections()
 209         for service in services_list:
 210             if service not in sections:
 211                 config.add_section(service)
 212             config.set(service, 'endpoint_type',
 213                        os.environ.get("OS_ENDPOINT_TYPE"))
 214
 215     with open(tempest_conf_file, 'wb') as config_file:
 216         config.write(config_file)
 217
 218     # Copy tempest.conf to /home/opnfv/functest/results/tempest/
 219     shutil.copyfile(tempest_conf_file, TEMPEST_RESULTS_DIR + '/tempest.conf')
 220     return True
 221
 222
 223 def configure_tempest_feature(deployment_dir, mode):
 224     """Add/update needed parameters into tempest.conf file generated by Rally
 225
 226     """
 227
 228     logger.debug("Finding tempest.conf file...")
 229     tempest_conf_file = deployment_dir + "/tempest.conf"
 230     if not os.path.isfile(tempest_conf_file):
 231         logger.error("Tempest configuration file %s NOT found."
 232                      % tempest_conf_file)
 233         exit(-1)
 234
 235     logger.debug("Updating selected tempest.conf parameters...")
 236     config = ConfigParser.RawConfigParser()
 237     config.read(tempest_conf_file)
 238     if mode == 'feature_multisite':
 239         config.set('service_available', 'kingbird', 'true')
 240         cmd = "openstack endpoint show kingbird | grep publicurl |\
 241                awk '{print $4}'"
 242         kingbird_endpoint_details = "".join(os.popen(cmd).read().split())
 243         kingbird_endpoint_url = kingbird_endpoint_details.rsplit('/', 1)[0] + \
 244             '/'
 245         kingbird_api_version = kingbird_endpoint_details.rsplit('/', 1)[1]
 246         try:
 247             config.add_section("kingbird")
 248         except Exception:
 249             logger.info('kingbird section exist')
 250         config.set('kingbird', 'endpoint_type', 'publicURL')
 251         config.set('kingbird', 'TIME_TO_SYNC', '20')
 252         config.set('kingbird', 'endpoint_url', kingbird_endpoint_url)
 253         config.set('kingbird', 'api_version', kingbird_api_version)
 254     with open(tempest_conf_file, 'wb') as config_file:
 255         config.write(config_file)
 256
 257     # Copy tempest.conf to /home/opnfv/functest/results/tempest/
 258     shutil.copyfile(tempest_conf_file, TEMPEST_RESULTS_DIR + '/tempest.conf')
 259     return True
 260
 261
 262 def read_file(filename):
 263     with open(filename) as src:
 264         return [line.strip() for line in src.readlines()]
 265
 266
 267 def generate_test_list(deployment_dir, mode):
 268     logger.debug("Generating test case list...")
 269     if mode == 'defcore':
 270         shutil.copyfile(TEMPEST_DEFCORE, TEMPEST_RAW_LIST)
 271     elif mode == 'custom':
 272         if os.path.isfile(TEMPEST_CUSTOM):
 273             shutil.copyfile(TEMPEST_CUSTOM, TEMPEST_RAW_LIST)
 274         else:
 275             logger.error("Tempest test list file %s NOT found."
 276                          % TEMPEST_CUSTOM)
 277             exit(-1)
 278     else:
 279         if mode == 'smoke':
 280             testr_mode = "smoke"
 281         elif mode == 'feature_multisite':
 282             testr_mode = " | grep -i kingbird "
 283         elif mode == 'full':
 284             testr_mode = ""
 285         else:
 286             testr_mode = 'tempest.api.' + mode
 287         cmd = ("cd " + deployment_dir + ";" + "testr list-tests " +
 288                testr_mode + ">" + TEMPEST_RAW_LIST + ";cd")
 289         ft_utils.execute_command(cmd, logger)
 290
 291
 292 def apply_tempest_blacklist():
 293     logger.debug("Applying tempest blacklist...")
 294     cases_file = read_file(TEMPEST_RAW_LIST)
 295     result_file = open(TEMPEST_LIST, 'w')
 296     black_tests = []
 297     try:
 298         installer_type = os.getenv('INSTALLER_TYPE')
 299         deploy_scenario = os.getenv('DEPLOY_SCENARIO')
 300         if (bool(installer_type) * bool(deploy_scenario)):
 301             # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the file
 302             black_list_file = open(TEMPEST_BLACKLIST)
 303             black_list_yaml = yaml.safe_load(black_list_file)
 304             black_list_file.close()
 305             for item in black_list_yaml:
 306                 scenarios = item['scenarios']
 307                 installers = item['installers']
 308                 if (deploy_scenario in scenarios and
 309                         installer_type in installers):
 310                     tests = item['tests']
 311                     for test in tests:
 312                         black_tests.append(test)
 313                     break
 314     except:
 315         black_tests = []
 316         logger.debug("Tempest blacklist file does not exist.")
 317
 318     for cases_line in cases_file:
 319         for black_tests_line in black_tests:
 320             if black_tests_line in cases_line:
 321                 break
 322         else:
 323             result_file.write(str(cases_line) + '\n')
 324     result_file.close()
 325
 326
 327 def run_tempest(OPTION):
 328     #
 329     # the "main" function of the script which launches Rally to run Tempest
 330     # :param option: tempest option (smoke, ..)
 331     # :return: void
 332     #
 333     logger.info("Starting Tempest test suite: '%s'." % OPTION)
 334     start_time = time.time()
 335     stop_time = start_time
 336     cmd_line = "rally verify start " + OPTION + " --system-wide"
 337
 338     header = ("Tempest environment:\n"
 339               "  Installer: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
 340               (os.getenv('INSTALLER_TYPE', 'Unknown'),
 341                os.getenv('DEPLOY_SCENARIO', 'Unknown'),
 342                os.getenv('NODE_NAME', 'Unknown'),
 343                time.strftime("%a %b %d %H:%M:%S %Z %Y")))
 344
 345     f_stdout = open(TEMPEST_RESULTS_DIR + "/tempest.log", 'w+')
 346     f_stderr = open(TEMPEST_RESULTS_DIR + "/tempest-error.log", 'w+')
 347     f_env = open(TEMPEST_RESULTS_DIR + "/environment.log", 'w+')
 348     f_env.write(header)
 349
 350     # subprocess.call(cmd_line, shell=True, stdout=f_stdout, stderr=f_stderr)
 351     p = subprocess.Popen(
 352         cmd_line, shell=True,
 353         stdout=subprocess.PIPE,
 354         stderr=f_stderr,
 355         bufsize=1)
 356
 357     with p.stdout:
 358         for line in iter(p.stdout.readline, b''):
 359             if re.search("\} tempest\.", line):
 360                 logger.info(line.replace('\n', ''))
 361             f_stdout.write(line)
 362     p.wait()
 363
 364     f_stdout.close()
 365     f_stderr.close()
 366     f_env.close()
 367
 368     cmd_line = "rally verify show"
 369     output = ""
 370     p = subprocess.Popen(
 371         cmd_line, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 372     for line in p.stdout:
 373         if re.search("Tests\:", line):
 374             break
 375         output += line
 376     logger.info(output)
 377
 378     cmd_line = "rally verify list"
 379     cmd = os.popen(cmd_line)
 380     output = (((cmd.read()).splitlines()[-2]).replace(" ", "")).split("|")
 381     # Format:
 382     # | UUID | Deployment UUID | smoke | tests | failures | Created at |
 383     # Duration | Status  |
 384     num_tests = output[4]
 385     num_failures = output[5]
 386     time_start = output[6]
 387     duration = output[7]
 388     # Compute duration (lets assume it does not take more than 60 min)
 389     dur_min = int(duration.split(':')[1])
 390     dur_sec_float = float(duration.split(':')[2])
 391     dur_sec_int = int(round(dur_sec_float, 0))
 392     dur_sec_int = dur_sec_int + 60 * dur_min
 393     stop_time = time.time()
 394
 395     try:
 396         diff = (int(num_tests) - int(num_failures))
 397         success_rate = 100 * diff / int(num_tests)
 398     except:
 399         success_rate = 0
 400
 401     if 'smoke' in args.mode:
 402         case_name = 'tempest_smoke_serial'
 403     else:
 404         case_name = 'tempest_full_parallel'
 405
 406     status = ft_utils.check_success_rate(case_name, success_rate)
 407     logger.info("Tempest %s success_rate is %s%%, is marked as %s"
 408                 % (case_name, success_rate, status))
 409
 410     # Push results in payload of testcase
 411     if args.report:
 412         # add the test in error in the details sections
 413         # should be possible to do it during the test
 414         logger.debug("Pushing tempest results into DB...")
 415         with open(TEMPEST_RESULTS_DIR + "/tempest.log", 'r') as myfile:
 416             output = myfile.read()
 417         error_logs = ""
 418
 419         for match in re.findall('(.*?)[. ]*FAILED', output):
 420             error_logs += match
 421
 422         # Generate json results for DB
 423         json_results = {"timestart": time_start, "duration": dur_sec_int,
 424                         "tests": int(num_tests), "failures": int(num_failures),
 425                         "errors": error_logs}
 426         logger.info("Results: " + str(json_results))
 427         # split Tempest smoke and full
 428
 429         try:
 430             ft_utils.push_results_to_db("functest",
 431                                         case_name,
 432                                         None,
 433                                         start_time,
 434                                         stop_time,
 435                                         status,
 436                                         json_results)
 437         except:
 438             logger.error("Error pushing results into Database '%s'"
 439                          % sys.exc_info()[0])
 440
 441     if status == "PASS":
 442         return 0
 443     else:
 444         return -1
 445
 446
 447 def main():
 448     global MODE
 449
 450     if not (args.mode in modes):
 451         logger.error("Tempest mode not valid. "
 452                      "Possible values are:\n" + str(modes))
 453         exit(-1)
 454
 455     if not os.path.exists(TEMPEST_RESULTS_DIR):
 456         os.makedirs(TEMPEST_RESULTS_DIR)
 457
 458     deployment_dir = ft_utils.get_deployment_dir(logger)
 459     configure_tempest(deployment_dir)
 460     configure_tempest_feature(deployment_dir, args.mode)
 461     create_tempest_resources()
 462     generate_test_list(deployment_dir, args.mode)
 463     apply_tempest_blacklist()
 464
 465     MODE = "--tests-file " + TEMPEST_LIST
 466     if args.serial:
 467         MODE += " --concur 1"
 468
 469     ret_val = run_tempest(MODE)
 470     if ret_val != 0:
 471         sys.exit(-1)
 472
 473     sys.exit(0)
 474
 475
 476 if __name__ == '__main__':
 477     main()