3 # Copyright (c) 2016 Ericsson AB and others.
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
23 import functest.ci.tier_builder as tb
24 import functest.core.testcase as testcase
25 import functest.utils.functest_utils as ft_utils
26 import functest.utils.openstack_utils as os_utils
27 from functest.utils.constants import CONST
29 # __name__ cannot be used here
30 logger = logging.getLogger('functest.ci.run_tests')
33 class Result(enum.Enum):
38 class BlockingTestFailed(Exception):
42 class TestNotEnabled(Exception):
46 class RunTestsParser(object):
49 self.parser = argparse.ArgumentParser()
50 self.parser.add_argument("-t", "--test", dest="test", action='store',
51 help="Test case or tier (group of tests) "
52 "to be executed. It will run all the test "
54 self.parser.add_argument("-n", "--noclean", help="Do not clean "
55 "OpenStack resources after running each "
56 "test (default=false).",
58 self.parser.add_argument("-r", "--report", help="Push results to "
59 "database (default=false).",
62 def parse_args(self, argv=[]):
63 return vars(self.parser.parse_args(argv))
69 self.executed_test_cases = {}
70 self.overall_result = Result.EX_OK
71 self.clean_flag = True
72 self.report_flag = False
73 self._tiers = tb.TierBuilder(
74 CONST.__getattribute__('INSTALLER_TYPE'),
75 CONST.__getattribute__('DEPLOY_SCENARIO'),
76 pkg_resources.resource_filename('functest', 'ci/testcases.yaml'))
80 rc_file = CONST.__getattribute__('openstack_creds')
81 if not os.path.isfile(rc_file):
82 raise Exception("RC file %s does not exist..." % rc_file)
83 logger.debug("Sourcing the OpenStack RC file...")
84 os_utils.source_credentials(rc_file)
85 for key, value in os.environ.iteritems():
86 if re.search("OS_", key):
87 if key == 'OS_AUTH_URL':
88 CONST.__setattr__('OS_AUTH_URL', value)
89 elif key == 'OS_USERNAME':
90 CONST.__setattr__('OS_USERNAME', value)
91 elif key == 'OS_TENANT_NAME':
92 CONST.__setattr__('OS_TENANT_NAME', value)
93 elif key == 'OS_PASSWORD':
94 CONST.__setattr__('OS_PASSWORD', value)
97 def get_run_dict(testname):
99 dict = ft_utils.get_dict_by_test(testname)
101 logger.error("Cannot get {}'s config options".format(testname))
106 logger.exception("Cannot get {}'s config options".format(testname))
109 def run_test(self, test):
110 if not test.is_enabled():
111 raise TestNotEnabled(
112 "The test case {} is not enabled".format(test.get_name()))
113 logger.info("Running test case '%s'...", test.get_name())
114 result = testcase.TestCase.EX_RUN_ERROR
115 run_dict = self.get_run_dict(test.get_name())
118 module = importlib.import_module(run_dict['module'])
119 cls = getattr(module, run_dict['class'])
120 test_dict = ft_utils.get_dict_by_test(test.get_name())
121 test_case = cls(**test_dict)
122 self.executed_test_cases[test.get_name()] = test_case
124 if test_case.create_snapshot() != test_case.EX_OK:
127 kwargs = run_dict['args']
128 result = test_case.run(**kwargs)
130 result = test_case.run()
131 if result == testcase.TestCase.EX_OK:
133 test_case.push_to_db()
134 result = test_case.is_successful()
135 logger.info("Test result:\n\n%s\n", test_case)
139 logger.exception("Cannot import module {}".format(
141 except AttributeError:
142 logger.exception("Cannot get class {}".format(
145 raise Exception("Cannot import the class for the test case.")
148 def run_tier(self, tier):
149 tier_name = tier.get_name()
150 tests = tier.get_tests()
151 if tests is None or len(tests) == 0:
152 logger.info("There are no supported test cases in this tier "
153 "for the given scenario")
154 self.overall_result = Result.EX_ERROR
156 logger.info("Running tier '%s'" % tier_name)
158 result = self.run_test(test)
159 if result != testcase.TestCase.EX_OK:
160 logger.error("The test case '%s' failed.", test.get_name())
161 self.overall_result = Result.EX_ERROR
162 if test.is_blocking():
163 raise BlockingTestFailed(
164 "The test case {} failed and is blocking".format(
166 return self.overall_result
170 msg = prettytable.PrettyTable(
171 header_style='upper', padding_width=5,
172 field_names=['tiers', 'order', 'CI Loop', 'description',
174 for tier in self._tiers.get_tiers():
175 if (len(tier.get_tests()) != 0 and
176 re.search(CONST.__getattribute__('CI_LOOP'),
177 tier.get_ci_loop()) is not None):
178 tiers_to_run.append(tier)
179 msg.add_row([tier.get_name(), tier.get_order(),
181 textwrap.fill(tier.description, width=40),
182 textwrap.fill(' '.join([str(x.get_name(
183 )) for x in tier.get_tests()]), width=40)])
184 logger.info("TESTS TO BE EXECUTED:\n\n%s\n", msg)
185 for tier in tiers_to_run:
188 def main(self, **kwargs):
189 if kwargs['noclean']:
190 self.clean_flag = False
192 self.report_flag = True
195 self.source_rc_file()
196 logger.debug("Test args: %s", kwargs['test'])
197 if self._tiers.get_tier(kwargs['test']):
198 self.run_tier(self._tiers.get_tier(kwargs['test']))
199 elif self._tiers.get_test(kwargs['test']):
200 result = self.run_test(
201 self._tiers.get_test(kwargs['test']))
202 if result != testcase.TestCase.EX_OK:
203 logger.error("The test case '%s' failed.",
205 self.overall_result = Result.EX_ERROR
206 elif kwargs['test'] == "all":
209 logger.error("Unknown test case or tier '%s', "
210 "or not supported by "
211 "the given scenario '%s'."
213 CONST.__getattribute__('DEPLOY_SCENARIO')))
214 logger.debug("Available tiers are:\n\n%s",
216 return Result.EX_ERROR
219 except BlockingTestFailed:
222 logger.exception("Failures when running testcase(s)")
223 self.overall_result = Result.EX_ERROR
224 if not self._tiers.get_test(kwargs['test']):
225 self.summary(self._tiers.get_tier(kwargs['test']))
226 logger.info("Execution exit value: %s" % self.overall_result)
227 return self.overall_result
229 def summary(self, tier=None):
230 msg = prettytable.PrettyTable(
231 header_style='upper', padding_width=5,
232 field_names=['env var', 'value'])
233 for env_var in ['INSTALLER_TYPE', 'DEPLOY_SCENARIO', 'BUILD_TAG',
235 msg.add_row([env_var, CONST.__getattribute__(env_var)])
236 logger.info("Deployment description:\n\n%s\n", msg)
237 msg = prettytable.PrettyTable(
238 header_style='upper', padding_width=5,
239 field_names=['test case', 'project', 'tier',
240 'duration', 'result'])
241 tiers = [tier] if tier else self._tiers.get_tiers()
243 for test in tier.get_tests():
245 test_case = self.executed_test_cases[test.get_name()]
247 msg.add_row([test.get_name(), test.get_project(),
248 tier.get_name(), "00:00", "SKIP"])
250 result = 'PASS' if(test_case.is_successful(
251 ) == test_case.EX_OK) else 'FAIL'
253 [test_case.case_name, test_case.project_name,
254 self._tiers.get_tier_name(test_case.case_name),
255 test_case.get_duration(), result])
256 for test in tier.get_skipped_test():
257 msg.add_row([test.get_name(), test.get_project(),
258 tier.get_name(), "00:00", "SKIP"])
259 logger.info("FUNCTEST REPORT:\n\n%s\n", msg)
263 logging.config.fileConfig(pkg_resources.resource_filename(
264 'functest', 'ci/logging.ini'))
265 parser = RunTestsParser()
266 args = parser.parse_args(sys.argv[1:])
268 return runner.main(**args).value