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 import conf_utils
  20 import functest.core.testcase_base as testcase_base
  21 import functest.utils.functest_logger as ft_logger
  22 import functest.utils.functest_utils as ft_utils
  23 import functest.utils.openstack_utils as os_utils
  24 import functest.utils.functest_constants as ft_constants
  25 import opnfv.utils.constants as releng_constants
  26
  27 """ logging configuration """
  28 logger = ft_logger.Logger("Tempest").getLogger()
  29
  30
  31 class TempestCommon(testcase_base.TestcaseBase):
  32
  33     def __init__(self):
  34         self.case_name = ""
  35         self.MODE = ""
  36         self.OPTION = ""
  37         self.FLAVOR_ID = None
  38         self.IMAGE_ID = None
  39         self.DEPLOYMENT_DIR = ft_utils.get_deployment_dir()
  40
  41     def read_file(self, filename):
  42         with open(filename) as src:
  43             return [line.strip() for line in src.readlines()]
  44
  45     def create_tempest_resources(self):
  46         keystone_client = os_utils.get_keystone_client()
  47
  48         logger.debug("Creating tenant and user for Tempest suite")
  49         tenant_id = os_utils.create_tenant(
  50             keystone_client,
  51             ft_constants.TEMPEST_TENANT_NAME,
  52             ft_constants.TEMPEST_TENANT_DESCRIPTION)
  53         if not tenant_id:
  54             logger.error("Error : Failed to create %s tenant"
  55                          % ft_constants.TEMPEST_TENANT_NAME)
  56
  57         user_id = os_utils.create_user(keystone_client,
  58                                        ft_constants.TEMPEST_USER_NAME,
  59                                        ft_constants.TEMPEST_USER_PASSWORD,
  60                                        None, tenant_id)
  61         if not user_id:
  62             logger.error("Error : Failed to create %s user" %
  63                          ft_constants.TEMPEST_USER_NAME)
  64
  65         logger.debug("Creating private network for Tempest suite")
  66         network_dic = \
  67             os_utils.create_shared_network_full(
  68                 ft_constants.TEMPEST_PRIVATE_NET_NAME,
  69                 ft_constants.TEMPEST_PRIVATE_SUBNET_NAME,
  70                 ft_constants.TEMPEST_ROUTER_NAME,
  71                 ft_constants.TEMPEST_PRIVATE_SUBNET_CIDR)
  72         if not network_dic:
  73             return releng_constants.EXIT_RUN_ERROR
  74
  75         if ft_constants.TEMPEST_USE_CUSTOM_IMAGES:
  76             # adding alternative image should be trivial should we need it
  77             logger.debug("Creating image for Tempest suite")
  78             _, self.IMAGE_ID = os_utils.get_or_create_image(
  79                 ft_constants.GLANCE_IMAGE_NAME, conf_utils.GLANCE_IMAGE_PATH,
  80                 ft_constants.GLANCE_IMAGE_FORMAT)
  81             if not self.IMAGE_ID:
  82                 return releng_constants.EXIT_RUN_ERROR
  83
  84         if ft_constants.TEMPEST_USE_CUSTOM_FLAVORS:
  85             # adding alternative flavor should be trivial should we need it
  86             logger.debug("Creating flavor for Tempest suite")
  87             _, self.FLAVOR_ID = os_utils.get_or_create_flavor(
  88                 ft_constants.FLAVOR_NAME,
  89                 ft_constants.FLAVOR_RAM,
  90                 ft_constants.FLAVOR_DISK,
  91                 ft_constants.FLAVOR_VCPUS)
  92             if not self.FLAVOR_ID:
  93                 return releng_constants.EXIT_RUN_ERROR
  94
  95         return releng_constants.EXIT_OK
  96
  97     def generate_test_list(self, DEPLOYMENT_DIR):
  98         logger.debug("Generating test case list...")
  99         if self.MODE == 'defcore':
 100             shutil.copyfile(
 101                 conf_utils.TEMPEST_DEFCORE, conf_utils.TEMPEST_RAW_LIST)
 102         elif self.MODE == 'custom':
 103             if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
 104                 shutil.copyfile(
 105                     conf_utils.TEMPEST_CUSTOM, conf_utils.TEMPEST_RAW_LIST)
 106             else:
 107                 logger.error("Tempest test list file %s NOT found."
 108                              % conf_utils.TEMPEST_CUSTOM)
 109                 return releng_constants.EXIT_RUN_ERROR
 110         else:
 111             if self.MODE == 'smoke':
 112                 testr_mode = "smoke"
 113             elif self.MODE == 'feature_multisite':
 114                 testr_mode = " | grep -i kingbird "
 115             elif self.MODE == 'full':
 116                 testr_mode = ""
 117             else:
 118                 testr_mode = 'tempest.api.' + self.MODE
 119             cmd = ("cd " + DEPLOYMENT_DIR + ";" + "testr list-tests " +
 120                    testr_mode + ">" + conf_utils.TEMPEST_RAW_LIST + ";cd")
 121             ft_utils.execute_command(cmd)
 122
 123         return releng_constants.EXIT_OK
 124
 125     def apply_tempest_blacklist(self):
 126         logger.debug("Applying tempest blacklist...")
 127         cases_file = self.read_file(conf_utils.TEMPEST_RAW_LIST)
 128         result_file = open(conf_utils.TEMPEST_LIST, 'w')
 129         black_tests = []
 130         try:
 131             installer_type = ft_constants.CI_INSTALLER_TYPE
 132             deploy_scenario = ft_constants.CI_SCENARIO
 133             if (bool(installer_type) * bool(deploy_scenario)):
 134                 # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the
 135                 # file
 136                 black_list_file = open(conf_utils.TEMPEST_BLACKLIST)
 137                 black_list_yaml = yaml.safe_load(black_list_file)
 138                 black_list_file.close()
 139                 for item in black_list_yaml:
 140                     scenarios = item['scenarios']
 141                     installers = item['installers']
 142                     if (deploy_scenario in scenarios and
 143                             installer_type in installers):
 144                         tests = item['tests']
 145                         for test in tests:
 146                             black_tests.append(test)
 147                         break
 148         except:
 149             black_tests = []
 150             logger.debug("Tempest blacklist file does not exist.")
 151
 152         for cases_line in cases_file:
 153             for black_tests_line in black_tests:
 154                 if black_tests_line in cases_line:
 155                     break
 156             else:
 157                 result_file.write(str(cases_line) + '\n')
 158         result_file.close()
 159         return releng_constants.EXIT_OK
 160
 161     def run(self):
 162         if not os.path.exists(conf_utils.TEMPEST_RESULTS_DIR):
 163             os.makedirs(conf_utils.TEMPEST_RESULTS_DIR)
 164
 165         # Pre-configuration
 166         res = self.create_tempest_resources()
 167         if res != releng_constants.EXIT_OK:
 168             return res
 169
 170         res = conf_utils.configure_tempest(logger,
 171                                            self.DEPLOYMENT_DIR,
 172                                            self.IMAGE_ID,
 173                                            self.FLAVOR_ID)
 174         if res != releng_constants.EXIT_OK:
 175             return res
 176
 177         res = self.generate_test_list(self.DEPLOYMENT_DIR)
 178         if res != releng_constants.EXIT_OK:
 179             return res
 180
 181         res = self.apply_tempest_blacklist()
 182         if res != releng_constants.EXIT_OK:
 183             return res
 184
 185         self.OPTION += (" --tests-file %s " % conf_utils.TEMPEST_LIST)
 186
 187         cmd_line = "rally verify start " + self.OPTION + " --system-wide"
 188         logger.info("Starting Tempest test suite: '%s'." % cmd_line)
 189
 190         header = ("Tempest environment:\n"
 191                   "  Installer: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
 192                   (ft_constants.CI_INSTALLER_TYPE,
 193                    ft_constants.CI_SCENARIO,
 194                    ft_constants.CI_NODE,
 195                    time.strftime("%a %b %d %H:%M:%S %Z %Y")))
 196
 197         f_stdout = open(conf_utils.TEMPEST_RESULTS_DIR + "/tempest.log", 'w+')
 198         f_stderr = open(
 199             conf_utils.TEMPEST_RESULTS_DIR + "/tempest-error.log", 'w+')
 200         f_env = open(conf_utils.TEMPEST_RESULTS_DIR + "/environment.log", 'w+')
 201         f_env.write(header)
 202
 203         # subprocess.call(cmd_line, shell=True,
 204         # stdout=f_stdout, stderr=f_stderr)
 205         p = subprocess.Popen(
 206             cmd_line, shell=True,
 207             stdout=subprocess.PIPE,
 208             stderr=f_stderr,
 209             bufsize=1)
 210
 211         with p.stdout:
 212             for line in iter(p.stdout.readline, b''):
 213                 if re.search("\} tempest\.", line):
 214                     logger.info(line.replace('\n', ''))
 215                 f_stdout.write(line)
 216         p.wait()
 217
 218         f_stdout.close()
 219         f_stderr.close()
 220         f_env.close()
 221
 222         cmd_line = "rally verify show"
 223         output = ""
 224         p = subprocess.Popen(cmd_line,
 225                              shell=True,
 226                              stdout=subprocess.PIPE,
 227                              stderr=subprocess.PIPE)
 228         for line in p.stdout:
 229             if re.search("Tests\:", line):
 230                 break
 231             output += line
 232         logger.info(output)
 233
 234         cmd_line = "rally verify list"
 235         cmd = os.popen(cmd_line)
 236         output = (((cmd.read()).splitlines()[-2]).replace(" ", "")).split("|")
 237         # Format:
 238         # | UUID | Deployment UUID | smoke | tests | failures | Created at |
 239         # Duration | Status  |
 240         num_tests = output[4]
 241         num_failures = output[5]
 242         duration = output[7]
 243         # Compute duration (lets assume it does not take more than 60 min)
 244         dur_min = int(duration.split(':')[1])
 245         dur_sec_float = float(duration.split(':')[2])
 246         dur_sec_int = int(round(dur_sec_float, 0))
 247         dur_sec_int = dur_sec_int + 60 * dur_min
 248
 249         try:
 250             diff = (int(num_tests) - int(num_failures))
 251             success_rate = 100 * diff / int(num_tests)
 252         except:
 253             success_rate = 0
 254
 255         if 'smoke' in self.MODE:
 256             self.CASE_NAME = 'tempest_smoke_serial'
 257         elif 'feature' in self.MODE:
 258             self.CASE_NAME = self.MODE.replace(
 259                 "feature_", "")
 260         else:
 261             self.CASE_NAME = 'tempest_full_parallel'
 262
 263         status = ft_utils.check_success_rate(
 264             self.CASE_NAME, success_rate)
 265         logger.info("Tempest %s success_rate is %s%%, is marked as %s"
 266                     % (self.CASE_NAME, success_rate, status))
 267
 268         if status == "PASS":
 269             return releng_constants.EXIT_OK
 270         else:
 271             return releng_constants.EXIT_RUN_ERROR
 272
 273
 274 class TempestSmokeSerial(TempestCommon):
 275
 276     def __init__(self):
 277         TempestCommon.__init__(self)
 278         self.case_name = "tempest_smoke_serial"
 279         self.MODE = "smoke"
 280         self.OPTION = "--concur 1"
 281
 282
 283 class TempestSmokeParallel(TempestCommon):
 284
 285     def __init__(self):
 286         TempestCommon.__init__(self)
 287         self.case_name = "tempest_smoke_parallel"
 288         self.MODE = "smoke"
 289         self.OPTION = ""
 290
 291
 292 class TempestFullParallel(TempestCommon):
 293
 294     def __init__(self):
 295         TempestCommon.__init__(self)
 296         self.case_name = "tempest_full_parallel"
 297         self.MODE = "full"
 298
 299
 300 class TempestMultisite(TempestCommon):
 301
 302     def __init__(self):
 303         TempestCommon.__init__(self)
 304         self.case_name = "multisite"
 305         self.MODE = "feature_multisite"
 306         self.OPTION = "--concur 1"
 307         conf_utils.configure_tempest_multisite(logger, self.DEPLOYMENT_DIR)
 308
 309
 310 class TempestCustom(TempestCommon):
 311
 312     def __init__(self, mode, option):
 313         TempestCommon.__init__(self)
 314         self.case_name = "tempest_custom"
 315         self.MODE = mode
 316         self.OPTION = option