3 # Copyright (c) 2016 Orange 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
10 """Define the parent class of Functest TestCase."""
14 import functest.utils.functest_logger as ft_logger
15 import functest.utils.functest_utils as ft_utils
17 __author__ = "Cedric Ollivier <cedric.ollivier@orange.com>"
20 class TestCase(object):
21 """Parent class of Functest TestCase."""
24 """Status code returned when everything is OK"""
26 EX_RUN_ERROR = os.EX_SOFTWARE
27 """Status code returned when run() fails"""
29 EX_PUSH_TO_DB_ERROR = os.EX_SOFTWARE - 1
30 """Status code returned when push_to_db() fails"""
32 EX_TESTCASE_FAILED = os.EX_SOFTWARE - 2
33 """Status code returned when results are false"""
35 logger = ft_logger.Logger(__name__).getLogger()
37 def __init__(self, **kwargs):
39 self.project_name = kwargs.get('project_name', 'functest')
40 self.case_name = kwargs.get('case_name', '')
45 def check_criteria(self):
46 """Interpret the results of TestCase.
48 It allows getting the results of TestCase. It completes run()
49 which only returns the execution status.
51 It can be overriden if checking criteria is not suitable.
54 TestCase.EX_OK if criteria is 'PASS'.
55 TestCase.EX_TESTCASE_FAILED otherwise.
59 if self.criteria == 'PASS':
61 except AssertionError:
62 self.logger.error("Please run test before checking the results")
63 return TestCase.EX_TESTCASE_FAILED
65 def run(self, **kwargs):
68 It allows running TestCase and getting its execution
71 The subclasses must override the default implementation which
72 is false on purpose. The only prerequisite is to set the
73 following attributes to push the results to DB:
81 kwargs: Arbitrary keyword arguments.
84 TestCase.EX_RUN_ERROR.
86 # pylint: disable=unused-argument
87 self.logger.error("Run must be implemented")
88 return TestCase.EX_RUN_ERROR
91 """Push the results of TestCase to the DB.
93 It allows publishing the results and to check the status.
95 It could be overriden if the common implementation is not
96 suitable. The following attributes must be set before pushing
106 TestCase.EX_OK if results were pushed to DB.
107 TestCase.EX_PUSH_TO_DB_ERROR otherwise.
110 assert self.project_name
111 assert self.case_name
113 assert self.start_time
114 assert self.stop_time
115 if ft_utils.push_results_to_db(
116 self.project_name, self.case_name, self.start_time,
117 self.stop_time, self.criteria, self.details):
118 self.logger.info("The results were successfully pushed to DB")
119 return TestCase.EX_OK
121 self.logger.error("The results cannot be pushed to DB")
122 return TestCase.EX_PUSH_TO_DB_ERROR
123 except Exception: # pylint: disable=broad-except
124 self.logger.exception("The results cannot be pushed to DB")
125 return TestCase.EX_PUSH_TO_DB_ERROR