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 DEPLOYMENT_MAME = functest_yaml.get("rally").get("deployment_name")
  85 RALLY_INSTALLATION_DIR = functest_yaml.get("general").get("directories").get(
  86     "dir_rally_inst")
  87 RESULTS_DIR = functest_yaml.get("general").get("directories").get(
  88     "dir_results")
  89 TEMPEST_RESULTS_DIR = RESULTS_DIR + '/tempest'
  90 TEST_LIST_DIR = functest_yaml.get("general").get("directories").get(
  91     "dir_tempest_cases")
  92 TEMPEST_CUSTOM = REPO_PATH + TEST_LIST_DIR + 'test_list.txt'
  93 TEMPEST_BLACKLIST = REPO_PATH + TEST_LIST_DIR + 'blacklist.txt'
  94 TEMPEST_DEFCORE = REPO_PATH + TEST_LIST_DIR + 'defcore_req.txt'
  95 TEMPEST_RAW_LIST = TEMPEST_RESULTS_DIR + '/test_raw_list.txt'
  96 TEMPEST_LIST = TEMPEST_RESULTS_DIR + '/test_list.txt'
  97
  98
  99 def get_info(file_result):
 100     test_run = ""
 101     duration = ""
 102     test_failed = ""
 103
 104     p = subprocess.Popen('cat tempest.log',
 105                          shell=True, stdout=subprocess.PIPE,
 106                          stderr=subprocess.STDOUT)
 107     for line in p.stdout.readlines():
 108         # print line,
 109         if (len(test_run) < 1):
 110             test_run = re.findall("[0-9]*\.[0-9]*s", line)
 111         if (len(duration) < 1):
 112             duration = re.findall("[0-9]*\ tests", line)
 113         regexp = r"(failures=[0-9]+)"
 114         if (len(test_failed) < 1):
 115             test_failed = re.findall(regexp, line)
 116
 117     logger.debug("test_run:" + test_run)
 118     logger.debug("duration:" + duration)
 119
 120
 121 def create_tempest_resources():
 122     keystone_client = os_utils.get_keystone_client()
 123     neutron_client = os_utils.get_neutron_client()
 124     glance_client = os_utils.get_glance_client()
 125
 126     logger.debug("Creating tenant and user for Tempest suite")
 127     tenant_id = os_utils.create_tenant(keystone_client,
 128                                        TENANT_NAME,
 129                                        TENANT_DESCRIPTION)
 130     if tenant_id == '':
 131         logger.error("Error : Failed to create %s tenant" % TENANT_NAME)
 132
 133     user_id = os_utils.create_user(keystone_client, USER_NAME, USER_PASSWORD,
 134                                    None, tenant_id)
 135     if user_id == '':
 136         logger.error("Error : Failed to create %s user" % USER_NAME)
 137
 138     logger.debug("Creating private network for Tempest suite")
 139     network_dic = os_utils.create_network_full(neutron_client,
 140                                                PRIVATE_NET_NAME,
 141                                                PRIVATE_SUBNET_NAME,
 142                                                ROUTER_NAME,
 143                                                PRIVATE_SUBNET_CIDR)
 144     if network_dic:
 145         if not os_utils.update_neutron_net(neutron_client,
 146                                            network_dic['net_id'],
 147                                            shared=True):
 148             logger.error("Failed to update private network...")
 149             exit(-1)
 150         else:
 151             logger.debug("Network '%s' is available..." % PRIVATE_NET_NAME)
 152     else:
 153         logger.error("Private network creation failed")
 154         exit(-1)
 155
 156     logger.debug("Creating image for Tempest suite")
 157     # Check if the given image exists
 158     image_id = os_utils.get_image_id(glance_client, GLANCE_IMAGE_NAME)
 159     if image_id != '':
 160         logger.info("Using existing image '%s'..." % GLANCE_IMAGE_NAME)
 161     else:
 162         logger.info("Creating image '%s' from '%s'..." % (GLANCE_IMAGE_NAME,
 163                                                           GLANCE_IMAGE_PATH))
 164         image_id = os_utils.create_glance_image(glance_client,
 165                                                 GLANCE_IMAGE_NAME,
 166                                                 GLANCE_IMAGE_PATH)
 167         if not image_id:
 168             logger.error("Failed to create a Glance image...")
 169             exit(-1)
 170         logger.debug("Image '%s' with ID=%s created successfully."
 171                      % (GLANCE_IMAGE_NAME, image_id))
 172
 173
 174 def configure_tempest(deployment_dir):
 175     """
 176     Add/update needed parameters into tempest.conf file generated by Rally
 177     """
 178
 179     logger.debug("Generating tempest.conf file...")
 180     cmd = "rally verify genconfig"
 181     ft_utils.execute_command(cmd, logger)
 182
 183     logger.debug("Finding tempest.conf file...")
 184     tempest_conf_file = deployment_dir + "/tempest.conf"
 185     if not os.path.isfile(tempest_conf_file):
 186         logger.error("Tempest configuration file %s NOT found."
 187                      % tempest_conf_file)
 188         exit(-1)
 189
 190     logger.debug("Updating selected tempest.conf parameters...")
 191     config = ConfigParser.RawConfigParser()
 192     config.read(tempest_conf_file)
 193     config.set('compute', 'fixed_network_name', PRIVATE_NET_NAME)
 194     config.set('identity', 'tenant_name', TENANT_NAME)
 195     config.set('identity', 'username', USER_NAME)
 196     config.set('identity', 'password', USER_PASSWORD)
 197
 198     if os.getenv('OS_ENDPOINT_TYPE') is not None:
 199         services_list = ['compute', 'volume', 'image', 'network',
 200                          'data-processing', 'object-storage', 'orchestration']
 201         sections = config.sections()
 202         for service in services_list:
 203             if service not in sections:
 204                 config.add_section(service)
 205             config.set(service, 'endpoint_type',
 206                        os.environ.get("OS_ENDPOINT_TYPE"))
 207
 208     with open(tempest_conf_file, 'wb') as config_file:
 209         config.write(config_file)
 210
 211     # Copy tempest.conf to /home/opnfv/functest/results/tempest/
 212     shutil.copyfile(tempest_conf_file, TEMPEST_RESULTS_DIR + '/tempest.conf')
 213     return True
 214
 215
 216 def configure_tempest_feature(deployment_dir, mode):
 217     """
 218     Add/update needed parameters into tempest.conf file generated by Rally
 219     """
 220
 221     logger.debug("Finding tempest.conf file...")
 222     tempest_conf_file = deployment_dir + "/tempest.conf"
 223     if not os.path.isfile(tempest_conf_file):
 224         logger.error("Tempest configuration file %s NOT found."
 225                      % tempest_conf_file)
 226         exit(-1)
 227
 228     logger.debug("Updating selected tempest.conf parameters...")
 229     config = ConfigParser.RawConfigParser()
 230     config.read(tempest_conf_file)
 231     if mode == 'feature_multisite':
 232         config.set('service_available', 'kingbird', 'true')
 233         cmd = "openstack endpoint show kingbird | grep publicurl |\
 234                awk '{print $4}' | awk -F '/' '{print $4}'"
 235         kingbird_api_version = os.popen(cmd).read()
 236         if os.environ.get("INSTALLER_TYPE") == 'fuel':
 237             # For MOS based setup, the service is accessible
 238             # via bind host
 239             kingbird_conf_path = "/etc/kingbird/kingbird.conf"
 240             installer_type = os.getenv('INSTALLER_TYPE', 'Unknown')
 241             installer_ip = os.getenv('INSTALLER_IP', 'Unknown')
 242             installer_username = ft_utils.get_parameter_from_yaml(
 243                 "multisite." + installer_type +
 244                 "_environment.installer_username")
 245             installer_password = ft_utils.get_parameter_from_yaml(
 246                 "multisite." + installer_type +
 247                 "_environment.installer_password")
 248
 249             ssh_options = "-o UserKnownHostsFile=/dev/null -o \
 250                 StrictHostKeyChecking=no"
 251
 252             # Get the controller IP from the fuel node
 253             cmd = 'sshpass -p %s ssh 2>/dev/null %s %s@%s \
 254                     \'fuel node --env 1| grep controller | grep "True\|  1" \
 255                     | awk -F\| "{print \$5}"\'' % (installer_password,
 256                                                    ssh_options,
 257                                                    installer_username,
 258                                                    installer_ip)
 259             multisite_controller_ip = \
 260                 "".join(os.popen(cmd).read().split())
 261
 262             # Login to controller and get bind host details
 263             cmd = 'sshpass -p %s ssh 2>/dev/null  %s %s@%s "ssh %s \\" \
 264                 grep -e "^bind_" %s  \\""' % (installer_password,
 265                                               ssh_options,
 266                                               installer_username,
 267                                               installer_ip,
 268                                               multisite_controller_ip,
 269                                               kingbird_conf_path)
 270             bind_details = os.popen(cmd).read()
 271             bind_details = "".join(bind_details.split())
 272             # Extract port number from the bind details
 273             bind_port = re.findall(r"\D(\d{4})", bind_details)[0]
 274             # Extract ip address from the bind details
 275             bind_host = re.findall(r"\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}",
 276                                    bind_details)[0]
 277             kingbird_endpoint_url = "http://" + bind_host + ":" + bind_port + \
 278                                     "/"
 279         else:
 280             cmd = "openstack endpoint show kingbird | grep publicurl |\
 281                    awk '{print $4}' | awk -F '/' '{print $3}'"
 282             kingbird_endpoint_url = os.popen(cmd).read()
 283
 284         try:
 285             config.add_section("kingbird")
 286         except Exception:
 287             logger.info('kingbird section exist')
 288         config.set('kingbird', 'endpoint_type', 'publicURL')
 289         config.set('kingbird', 'TIME_TO_SYNC', '20')
 290         config.set('kingbird', 'endpoint_url', kingbird_endpoint_url)
 291         config.set('kingbird', 'api_version', kingbird_api_version)
 292     with open(tempest_conf_file, 'wb') as config_file:
 293         config.write(config_file)
 294
 295     # Copy tempest.conf to /home/opnfv/functest/results/tempest/
 296     shutil.copyfile(tempest_conf_file, TEMPEST_RESULTS_DIR + '/tempest.conf')
 297     return True
 298
 299
 300 def read_file(filename):
 301     with open(filename) as src:
 302         return [line.strip() for line in src.readlines()]
 303
 304
 305 def generate_test_list(deployment_dir, mode):
 306     logger.debug("Generating test case list...")
 307     if mode == 'defcore':
 308         shutil.copyfile(TEMPEST_DEFCORE, TEMPEST_RAW_LIST)
 309     elif mode == 'custom':
 310         if os.path.isfile(TEMPEST_CUSTOM):
 311             shutil.copyfile(TEMPEST_CUSTOM, TEMPEST_RAW_LIST)
 312         else:
 313             logger.error("Tempest test list file %s NOT found."
 314                          % TEMPEST_CUSTOM)
 315             exit(-1)
 316     else:
 317         if mode == 'smoke':
 318             testr_mode = "smoke"
 319         elif mode == 'feature_multisite':
 320             testr_mode = " | grep -i kingbird "
 321         elif mode == 'full':
 322             testr_mode = ""
 323         else:
 324             testr_mode = 'tempest.api.' + mode
 325         cmd = ("cd " + deployment_dir + ";" + "testr list-tests " +
 326                testr_mode + ">" + TEMPEST_RAW_LIST + ";cd")
 327         ft_utils.execute_command(cmd, logger)
 328
 329
 330 def apply_tempest_blacklist():
 331     logger.debug("Applying tempest blacklist...")
 332     cases_file = read_file(TEMPEST_RAW_LIST)
 333     result_file = open(TEMPEST_LIST, 'w')
 334     black_tests = []
 335     try:
 336         installer_type = os.getenv('INSTALLER_TYPE')
 337         deploy_scenario = os.getenv('DEPLOY_SCENARIO')
 338         if (bool(installer_type) * bool(deploy_scenario)):
 339             # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the file
 340             black_list_file = open(TEMPEST_BLACKLIST)
 341             black_list_yaml = yaml.safe_load(black_list_file)
 342             black_list_file.close()
 343             for item in black_list_yaml:
 344                 scenarios = item['scenarios']
 345                 installers = item['installers']
 346                 if (deploy_scenario in scenarios and
 347                         installer_type in installers):
 348                     tests = item['tests']
 349                     for test in tests:
 350                         black_tests.append(test)
 351                     break
 352     except:
 353         black_tests = []
 354         logger.debug("Tempest blacklist file does not exist.")
 355
 356     for line in cases_file:
 357         if line not in black_tests:
 358             result_file.write(str(line) + '\n')
 359     result_file.close()
 360
 361
 362 def run_tempest(OPTION):
 363     #
 364     # the "main" function of the script which launches Rally to run Tempest
 365     # :param option: tempest option (smoke, ..)
 366     # :return: void
 367     #
 368     logger.info("Starting Tempest test suite: '%s'." % OPTION)
 369     start_time = time.time()
 370     stop_time = start_time
 371     cmd_line = "rally verify start " + OPTION + " --system-wide"
 372
 373     header = ("Tempest environment:\n"
 374               "  Installer: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
 375               (os.getenv('INSTALLER_TYPE', 'Unknown'),
 376                os.getenv('DEPLOY_SCENARIO', 'Unknown'),
 377                os.getenv('NODE_NAME', 'Unknown'),
 378                time.strftime("%a %b %d %H:%M:%S %Z %Y")))
 379
 380     f_stdout = open(TEMPEST_RESULTS_DIR + "/tempest.log", 'w+')
 381     f_stderr = open(TEMPEST_RESULTS_DIR + "/tempest-error.log", 'w+')
 382     f_env = open(TEMPEST_RESULTS_DIR + "/environment.log", 'w+')
 383     f_env.write(header)
 384
 385     # subprocess.call(cmd_line, shell=True, stdout=f_stdout, stderr=f_stderr)
 386     p = subprocess.Popen(
 387         cmd_line, shell=True,
 388         stdout=subprocess.PIPE,
 389         stderr=f_stderr,
 390         bufsize=1)
 391
 392     with p.stdout:
 393         for line in iter(p.stdout.readline, b''):
 394             if re.search("\} tempest\.", line):
 395                 logger.info(line.replace('\n', ''))
 396             f_stdout.write(line)
 397     p.wait()
 398
 399     f_stdout.close()
 400     f_stderr.close()
 401     f_env.close()
 402
 403     cmd_line = "rally verify show"
 404     output = ""
 405     p = subprocess.Popen(
 406         cmd_line, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 407     for line in p.stdout:
 408         if re.search("Tests\:", line):
 409             break
 410         output += line
 411     logger.info(output)
 412
 413     cmd_line = "rally verify list"
 414     cmd = os.popen(cmd_line)
 415     output = (((cmd.read()).splitlines()[-2]).replace(" ", "")).split("|")
 416     # Format:
 417     # | UUID | Deployment UUID | smoke | tests | failures | Created at |
 418     # Duration | Status  |
 419     num_tests = output[4]
 420     num_failures = output[5]
 421     time_start = output[6]
 422     duration = output[7]
 423     # Compute duration (lets assume it does not take more than 60 min)
 424     dur_min = int(duration.split(':')[1])
 425     dur_sec_float = float(duration.split(':')[2])
 426     dur_sec_int = int(round(dur_sec_float, 0))
 427     dur_sec_int = dur_sec_int + 60 * dur_min
 428     stop_time = time.time()
 429
 430     status = "FAIL"
 431     try:
 432         diff = (int(num_tests) - int(num_failures))
 433         success_rate = 100 * diff / int(num_tests)
 434     except:
 435         success_rate = 0
 436
 437     # For Tempest we assume that the success rate is above 90%
 438     if "smoke" in args.mode:
 439         case_name = "tempest_smoke_serial"
 440         # Note criteria hardcoded...TODO read it from testcases.yaml
 441         success_criteria = 100
 442         if success_rate >= success_criteria:
 443             status = "PASS"
 444         else:
 445             logger.info("Tempest success rate: %s%%. The success criteria to "
 446                         "pass this test is %s%%. Marking the test as FAILED." %
 447                         (success_rate, success_criteria))
 448     else:
 449         case_name = "tempest_full_parallel"
 450         # Note criteria hardcoded...TODO read it from testcases.yaml
 451         success_criteria = 80
 452         if success_rate >= success_criteria:
 453             status = "PASS"
 454         else:
 455             logger.info("Tempest success rate: %s%%. The success criteria to "
 456                         "pass this test is %s%%. Marking the test as FAILED." %
 457                         (success_rate, success_criteria))
 458
 459     # Push results in payload of testcase
 460     if args.report:
 461         # add the test in error in the details sections
 462         # should be possible to do it during the test
 463         logger.debug("Pushing tempest results into DB...")
 464         with open(TEMPEST_RESULTS_DIR + "/tempest.log", 'r') as myfile:
 465             output = myfile.read()
 466         error_logs = ""
 467
 468         for match in re.findall('(.*?)[. ]*FAILED', output):
 469             error_logs += match
 470
 471         # Generate json results for DB
 472         json_results = {"timestart": time_start, "duration": dur_sec_int,
 473                         "tests": int(num_tests), "failures": int(num_failures),
 474                         "errors": error_logs}
 475         logger.info("Results: " + str(json_results))
 476         # split Tempest smoke and full
 477
 478         try:
 479             ft_utils.push_results_to_db("functest",
 480                                         case_name,
 481                                         None,
 482                                         start_time,
 483                                         stop_time,
 484                                         status,
 485                                         json_results)
 486         except:
 487             logger.error("Error pushing results into Database '%s'"
 488                          % sys.exc_info()[0])
 489
 490     if status == "PASS":
 491         return 0
 492     else:
 493         return -1
 494
 495
 496 def main():
 497     global MODE
 498
 499     if not (args.mode in modes):
 500         logger.error("Tempest mode not valid. "
 501                      "Possible values are:\n" + str(modes))
 502         exit(-1)
 503
 504     if not os.path.exists(TEMPEST_RESULTS_DIR):
 505         os.makedirs(TEMPEST_RESULTS_DIR)
 506
 507     deployment_dir = ft_utils.get_deployment_dir(logger)
 508     configure_tempest(deployment_dir)
 509     configure_tempest_feature(deployment_dir, args.mode)
 510     create_tempest_resources()
 511     generate_test_list(deployment_dir, args.mode)
 512     apply_tempest_blacklist()
 513
 514     MODE = "--tests-file " + TEMPEST_LIST
 515     if args.serial:
 516         MODE += " --concur 1"
 517
 518     ret_val = run_tempest(MODE)
 519     if ret_val != 0:
 520         sys.exit(-1)
 521
 522     sys.exit(0)
 523
 524
 525 if __name__ == '__main__':
 526     main()