Merge "Exclude Doctor from Joid scnenarios"
[functest.git] / functest / ci / run_tests.py
index 6a6516a..4a47ba5 100755 (executable)
@@ -10,6 +10,7 @@
 
 import argparse
 import datetime
+import enum
 import importlib
 import os
 import re
@@ -18,7 +19,6 @@ import sys
 import functest.ci.generate_report as generate_report
 import functest.ci.tier_builder as tb
 import functest.core.testcase_base as testcase_base
-import functest.utils.functest_constants as ft_constants
 import functest.utils.functest_logger as ft_logger
 import functest.utils.functest_utils as ft_utils
 import functest.utils.openstack_clean as os_clean
@@ -31,14 +31,16 @@ from functest.utils.constants import CONST
 logger = ft_logger.Logger("run_tests").getLogger()
 
 
-""" global variables """
-EXEC_SCRIPT = ("%s/functest/ci/exec_test.sh" % CONST.dir_repo_functest)
+class Result(enum.Enum):
+    EX_OK = os.EX_OK
+    EX_ERROR = -1
 
-# This will be the return code of this script. If any of the tests fails,
-# this variable will change to -1
 
+class BlockingTestFailed(Exception):
+    pass
 
-class RunTestsParser():
+
+class RunTestsParser(object):
 
     def __init__(self):
         self.parser = argparse.ArgumentParser()
@@ -60,7 +62,7 @@ class RunTestsParser():
 
 class GlobalVariables:
     EXECUTED_TEST_CASES = []
-    OVERALL_RESULT = 0
+    OVERALL_RESULT = Result.EX_OK
     CLEAN_FLAG = True
     REPORT_FLAG = False
 
@@ -75,23 +77,18 @@ def print_separator(str, count=45):
 def source_rc_file():
     rc_file = CONST.openstack_creds
     if not os.path.isfile(rc_file):
-        logger.error("RC file %s does not exist..." % rc_file)
-        sys.exit(1)
+        raise Exception("RC file %s does not exist..." % rc_file)
     logger.debug("Sourcing the OpenStack RC file...")
     os_utils.source_credentials(rc_file)
     for key, value in os.environ.iteritems():
         if re.search("OS_", key):
             if key == 'OS_AUTH_URL':
-                ft_constants.OS_AUTH_URL = value
                 CONST.OS_AUTH_URL = value
             elif key == 'OS_USERNAME':
-                ft_constants.OS_USERNAME = value
                 CONST.OS_USERNAME = value
             elif key == 'OS_TENANT_NAME':
-                ft_constants.OS_TENANT_NAME = value
                 CONST.OS_TENANT_NAME = value
             elif key == 'OS_PASSWORD':
-                ft_constants.OS_PASSWORD = value
                 CONST.OS_PASSWORD = value
 
 
@@ -110,7 +107,7 @@ def update_test_info(test_name, result, duration):
                          "duration": duration})
 
 
-def get_run_dict_if_defined(testname):
+def get_run_dict(testname):
     try:
         dict = ft_utils.get_dict_by_test(testname)
         if not dict:
@@ -134,7 +131,7 @@ def run_test(test, tier_name, testcases=None):
     logger.debug("\n%s" % test)
     source_rc_file()
 
-    if GlobalVariables.CLEAN_FLAG:
+    if test.needs_clean() and GlobalVariables.CLEAN_FLAG:
         generate_os_snapshot()
 
     flags = (" -t %s" % (test_name))
@@ -142,12 +139,13 @@ def run_test(test, tier_name, testcases=None):
         flags += " -r"
 
     result = testcase_base.TestcaseBase.EX_RUN_ERROR
-    run_dict = get_run_dict_if_defined(test_name)
+    run_dict = get_run_dict(test_name)
     if run_dict:
         try:
             module = importlib.import_module(run_dict['module'])
             cls = getattr(module, run_dict['class'])
             test_case = cls()
+
             try:
                 kwargs = run_dict['args']
                 result = test_case.run(**kwargs)
@@ -155,7 +153,7 @@ def run_test(test, tier_name, testcases=None):
                 result = test_case.run()
             if result == testcase_base.TestcaseBase.EX_OK:
                 if GlobalVariables.REPORT_FLAG:
-                    test_case.publish_report()
+                    test_case.push_to_db()
                 result = test_case.check_criteria()
         except ImportError:
             logger.exception("Cannot import module {}".format(
@@ -164,14 +162,11 @@ def run_test(test, tier_name, testcases=None):
             logger.exception("Cannot get class {}".format(
                 run_dict['class']))
     else:
-        cmd = ("%s%s" % (EXEC_SCRIPT, flags))
-        logger.info("Executing command {} because {} "
-                    "doesn't implement the new framework".format(
-                        cmd, test_name))
-        result = ft_utils.execute_command(cmd)
+        raise Exception("Cannot import the class for the test case.")
 
-    if GlobalVariables.CLEAN_FLAG:
+    if test.needs_clean() and GlobalVariables.CLEAN_FLAG:
         cleanup()
+
     end = datetime.datetime.now()
     duration = (end - start).seconds
     duration_str = ("%02d:%02d" % divmod(duration, 60))
@@ -179,19 +174,16 @@ def run_test(test, tier_name, testcases=None):
 
     if result != 0:
         logger.error("The test case '%s' failed. " % test_name)
-        GlobalVariables.OVERALL_RESULT = -1
+        GlobalVariables.OVERALL_RESULT = Result.EX_ERROR
         result_str = "FAIL"
 
         if test.is_blocking():
             if not testcases or testcases == "all":
-                logger.info("This test case is blocking. Aborting overall "
-                            "execution.")
                 # if it is a single test we don't print the whole results table
                 update_test_info(test_name, result_str, duration_str)
                 generate_report.main(GlobalVariables.EXECUTED_TEST_CASES)
-            logger.info("Execution exit value: %s" %
-                        GlobalVariables.OVERALL_RESULT)
-            sys.exit(GlobalVariables.OVERALL_RESULT)
+            raise BlockingTestFailed("The test case {} failed and is blocking"
+                                     .format(test.get_name()))
 
     update_test_info(test_name, result_str, duration_str)
 
@@ -246,33 +238,37 @@ def main(**kwargs):
     if kwargs['report']:
         GlobalVariables.REPORT_FLAG = True
 
-    if kwargs['test']:
-        source_rc_file()
-        if _tiers.get_tier(kwargs['test']):
-            run_tier(_tiers.get_tier(kwargs['test']))
-
-        elif _tiers.get_test(kwargs['test']):
-            run_test(_tiers.get_test(kwargs['test']),
-                     _tiers.get_tier(kwargs['test']),
-                     kwargs['test'])
-
-        elif kwargs['test'] == "all":
-            run_all(_tiers)
-
+    try:
+        if kwargs['test']:
+            source_rc_file()
+            if _tiers.get_tier(kwargs['test']):
+                GlobalVariables.EXECUTED_TEST_CASES = generate_report.init(
+                    [_tiers.get_tier(kwargs['test'])])
+                run_tier(_tiers.get_tier(kwargs['test']))
+            elif _tiers.get_test(kwargs['test']):
+                run_test(_tiers.get_test(kwargs['test']),
+                         _tiers.get_tier(kwargs['test']),
+                         kwargs['test'])
+            elif kwargs['test'] == "all":
+                run_all(_tiers)
+            else:
+                logger.error("Unknown test case or tier '%s', "
+                             "or not supported by "
+                             "the given scenario '%s'."
+                             % (kwargs['test'], CI_SCENARIO))
+                logger.debug("Available tiers are:\n\n%s"
+                             % _tiers)
+                return Result.EX_ERROR
         else:
-            logger.error("Unknown test case or tier '%s', or not supported by "
-                         "the given scenario '%s'."
-                         % (kwargs['test'], CI_SCENARIO))
-            logger.debug("Available tiers are:\n\n%s"
-                         % _tiers)
-    else:
-        run_all(_tiers)
-
+            run_all(_tiers)
+    except Exception as e:
+        logger.error(e)
+        GlobalVariables.OVERALL_RESULT = Result.EX_ERROR
     logger.info("Execution exit value: %s" % GlobalVariables.OVERALL_RESULT)
-    sys.exit(GlobalVariables.OVERALL_RESULT)
+    return GlobalVariables.OVERALL_RESULT
 
 
 if __name__ == '__main__':
     parser = RunTestsParser()
     args = parser.parse_args(sys.argv[1:])
-    main(**args)
+    sys.exit(main(**args).value)