functest/ci/run_tests.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2016 Ericsson AB and others.
   4 #
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9
  10 import argparse
  11 import enum
  12 import importlib
  13 import logging
  14 import logging.config
  15 import os
  16 import pkg_resources
  17 import re
  18 import sys
  19 import textwrap
  20
  21 import prettytable
  22 import six
  23
  24 import functest.ci.tier_builder as tb
  25 import functest.core.testcase as testcase
  26 import functest.utils.functest_utils as ft_utils
  27 import functest.utils.openstack_utils as os_utils
  28 from functest.utils.constants import CONST
  29
  30 # __name__ cannot be used here
  31 logger = logging.getLogger('functest.ci.run_tests')
  32
  33 CONFIG_FUNCTEST_PATH = pkg_resources.resource_filename(
  34     'functest', 'ci/config_functest.yaml')
  35
  36
  37 class Result(enum.Enum):
  38     EX_OK = os.EX_OK
  39     EX_ERROR = -1
  40
  41
  42 class BlockingTestFailed(Exception):
  43     pass
  44
  45
  46 class TestNotEnabled(Exception):
  47     pass
  48
  49
  50 class RunTestsParser(object):
  51
  52     def __init__(self):
  53         self.parser = argparse.ArgumentParser()
  54         self.parser.add_argument("-t", "--test", dest="test", action='store',
  55                                  help="Test case or tier (group of tests) "
  56                                  "to be executed. It will run all the test "
  57                                  "if not specified.")
  58         self.parser.add_argument("-n", "--noclean", help="Do not clean "
  59                                  "OpenStack resources after running each "
  60                                  "test (default=false).",
  61                                  action="store_true")
  62         self.parser.add_argument("-r", "--report", help="Push results to "
  63                                  "database (default=false).",
  64                                  action="store_true")
  65
  66     def parse_args(self, argv=[]):
  67         return vars(self.parser.parse_args(argv))
  68
  69
  70 class Runner(object):
  71
  72     def __init__(self):
  73         self.executed_test_cases = {}
  74         self.overall_result = Result.EX_OK
  75         self.clean_flag = True
  76         self.report_flag = False
  77         self._tiers = tb.TierBuilder(
  78             CONST.__getattribute__('INSTALLER_TYPE'),
  79             CONST.__getattribute__('DEPLOY_SCENARIO'),
  80             pkg_resources.resource_filename('functest', 'ci/testcases.yaml'))
  81
  82     @staticmethod
  83     def source_rc_file():
  84         rc_file = CONST.__getattribute__('openstack_creds')
  85         if not os.path.isfile(rc_file):
  86             raise Exception("RC file %s does not exist..." % rc_file)
  87         logger.debug("Sourcing the OpenStack RC file...")
  88         os_utils.source_credentials(rc_file)
  89         for key, value in six.iteritems(os.environ):
  90             if re.search("OS_", key):
  91                 if key == 'OS_AUTH_URL':
  92                     CONST.__setattr__('OS_AUTH_URL', value)
  93                 elif key == 'OS_USERNAME':
  94                     CONST.__setattr__('OS_USERNAME', value)
  95                 elif key == 'OS_TENANT_NAME':
  96                     CONST.__setattr__('OS_TENANT_NAME', value)
  97                 elif key == 'OS_PASSWORD':
  98                     CONST.__setattr__('OS_PASSWORD', value)
  99                 elif key == "OS_PROJECT_DOMAIN_NAME":
 100                     CONST.__setattr__('OS_PROJECT_DOMAIN_NAME', value)
 101
 102     @staticmethod
 103     def get_run_dict(testname):
 104         try:
 105             dict = ft_utils.get_dict_by_test(testname)
 106             if not dict:
 107                 logger.error("Cannot get {}'s config options".format(testname))
 108             elif 'run' in dict:
 109                 return dict['run']
 110             return None
 111         except Exception:
 112             logger.exception("Cannot get {}'s config options".format(testname))
 113             return None
 114
 115     def run_test(self, test):
 116         if not test.is_enabled():
 117             raise TestNotEnabled(
 118                 "The test case {} is not enabled".format(test.get_name()))
 119         logger.info("Running test case '%s'...", test.get_name())
 120         result = testcase.TestCase.EX_RUN_ERROR
 121         run_dict = self.get_run_dict(test.get_name())
 122         if run_dict:
 123             try:
 124                 module = importlib.import_module(run_dict['module'])
 125                 cls = getattr(module, run_dict['class'])
 126                 test_dict = ft_utils.get_dict_by_test(test.get_name())
 127                 test_case = cls(**test_dict)
 128                 self.executed_test_cases[test.get_name()] = test_case
 129                 if self.clean_flag:
 130                     if test_case.create_snapshot() != test_case.EX_OK:
 131                         return testcase.TestCase.EX_RUN_ERROR
 132                 try:
 133                     kwargs = run_dict['args']
 134                     test_case.run(**kwargs)
 135                 except KeyError:
 136                     test_case.run()
 137                 if self.report_flag:
 138                     test_case.push_to_db()
 139                 if test.get_project() == "functest":
 140                     result = test_case.is_successful()
 141                 else:
 142                     result = testcase.TestCase.EX_OK
 143                 logger.info("Test result:\n\n%s\n", test_case)
 144                 if self.clean_flag:
 145                     test_case.clean()
 146             except ImportError:
 147                 logger.exception("Cannot import module {}".format(
 148                     run_dict['module']))
 149             except AttributeError:
 150                 logger.exception("Cannot get class {}".format(
 151                     run_dict['class']))
 152         else:
 153             raise Exception("Cannot import the class for the test case.")
 154         return result
 155
 156     def run_tier(self, tier):
 157         tier_name = tier.get_name()
 158         tests = tier.get_tests()
 159         if tests is None or len(tests) == 0:
 160             logger.info("There are no supported test cases in this tier "
 161                         "for the given scenario")
 162             self.overall_result = Result.EX_ERROR
 163         else:
 164             logger.info("Running tier '%s'" % tier_name)
 165             for test in tests:
 166                 self.run_test(test)
 167                 test_case = self.executed_test_cases[test.get_name()]
 168                 if test_case.is_successful() != testcase.TestCase.EX_OK:
 169                     logger.error("The test case '%s' failed.", test.get_name())
 170                     if test.get_project() == "functest":
 171                         self.overall_result = Result.EX_ERROR
 172                     if test.is_blocking():
 173                         raise BlockingTestFailed(
 174                             "The test case {} failed and is blocking".format(
 175                                 test.get_name()))
 176         return self.overall_result
 177
 178     def run_all(self):
 179         tiers_to_run = []
 180         msg = prettytable.PrettyTable(
 181             header_style='upper', padding_width=5,
 182             field_names=['tiers', 'order', 'CI Loop', 'description',
 183                          'testcases'])
 184         for tier in self._tiers.get_tiers():
 185             if (len(tier.get_tests()) != 0 and
 186                     re.search(CONST.__getattribute__('CI_LOOP'),
 187                               tier.get_ci_loop()) is not None):
 188                 tiers_to_run.append(tier)
 189                 msg.add_row([tier.get_name(), tier.get_order(),
 190                              tier.get_ci_loop(),
 191                              textwrap.fill(tier.description, width=40),
 192                              textwrap.fill(' '.join([str(x.get_name(
 193                                  )) for x in tier.get_tests()]), width=40)])
 194         logger.info("TESTS TO BE EXECUTED:\n\n%s\n", msg)
 195         for tier in tiers_to_run:
 196             self.run_tier(tier)
 197
 198     def main(self, **kwargs):
 199         if 'noclean' in kwargs:
 200             self.clean_flag = not kwargs['noclean']
 201         if 'report' in kwargs:
 202             self.report_flag = kwargs['report']
 203         try:
 204             if 'test' in kwargs:
 205                 self.source_rc_file()
 206                 logger.debug("Test args: %s", kwargs['test'])
 207                 if self._tiers.get_tier(kwargs['test']):
 208                     self.run_tier(self._tiers.get_tier(kwargs['test']))
 209                 elif self._tiers.get_test(kwargs['test']):
 210                     result = self.run_test(
 211                         self._tiers.get_test(kwargs['test']))
 212                     if result != testcase.TestCase.EX_OK:
 213                         logger.error("The test case '%s' failed.",
 214                                      kwargs['test'])
 215                         self.overall_result = Result.EX_ERROR
 216                 elif kwargs['test'] == "all":
 217                     self.run_all()
 218                 else:
 219                     logger.error("Unknown test case or tier '%s', "
 220                                  "or not supported by "
 221                                  "the given scenario '%s'."
 222                                  % (kwargs['test'],
 223                                     CONST.__getattribute__('DEPLOY_SCENARIO')))
 224                     logger.debug("Available tiers are:\n\n%s",
 225                                  self._tiers)
 226                     return Result.EX_ERROR
 227             else:
 228                 self.run_all()
 229         except BlockingTestFailed:
 230             pass
 231         except Exception:
 232             logger.exception("Failures when running testcase(s)")
 233             self.overall_result = Result.EX_ERROR
 234         if not self._tiers.get_test(kwargs['test']):
 235             self.summary(self._tiers.get_tier(kwargs['test']))
 236         logger.info("Execution exit value: %s" % self.overall_result)
 237         return self.overall_result
 238
 239     def summary(self, tier=None):
 240         msg = prettytable.PrettyTable(
 241             header_style='upper', padding_width=5,
 242             field_names=['env var', 'value'])
 243         for env_var in ['INSTALLER_TYPE', 'DEPLOY_SCENARIO', 'BUILD_TAG',
 244                         'CI_LOOP']:
 245             msg.add_row([env_var, CONST.__getattribute__(env_var)])
 246         logger.info("Deployment description:\n\n%s\n", msg)
 247         msg = prettytable.PrettyTable(
 248             header_style='upper', padding_width=5,
 249             field_names=['test case', 'project', 'tier',
 250                          'duration', 'result'])
 251         tiers = [tier] if tier else self._tiers.get_tiers()
 252         for tier in tiers:
 253             for test in tier.get_tests():
 254                 try:
 255                     test_case = self.executed_test_cases[test.get_name()]
 256                 except KeyError:
 257                     msg.add_row([test.get_name(), test.get_project(),
 258                                  tier.get_name(), "00:00", "SKIP"])
 259                 else:
 260                     result = 'PASS' if(test_case.is_successful(
 261                         ) == test_case.EX_OK) else 'FAIL'
 262                     msg.add_row(
 263                         [test_case.case_name, test_case.project_name,
 264                          self._tiers.get_tier_name(test_case.case_name),
 265                          test_case.get_duration(), result])
 266             for test in tier.get_skipped_test():
 267                 msg.add_row([test.get_name(), test.get_project(),
 268                              tier.get_name(), "00:00", "SKIP"])
 269         logger.info("FUNCTEST REPORT:\n\n%s\n", msg)
 270
 271
 272 def main():
 273     logging.config.fileConfig(pkg_resources.resource_filename(
 274         'functest', 'ci/logging.ini'))
 275     logging.captureWarnings(True)
 276     parser = RunTestsParser()
 277     args = parser.parse_args(sys.argv[1:])
 278     runner = Runner()
 279     return runner.main(**args).value