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