3 # Copyright (c) 2016 ZTE Corp 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 all Functest Features.
12 Feature is considered as TestCase offered by Third-party. It offers
13 helpers to run any python method or any bash command.
19 import functest.core.testcase as base
20 import functest.utils.functest_utils as ft_utils
21 from functest.utils.constants import CONST
23 __author__ = ("Serena Feng <feng.xiaowei@zte.com.cn>, "
24 "Cedric Ollivier <cedric.ollivier@orange.com>")
27 class Feature(base.TestCase):
28 """Base model for single feature."""
30 __logger = logging.getLogger(__name__)
32 def __init__(self, **kwargs):
33 super(Feature, self).__init__(**kwargs)
34 self.result_file = "{}/{}.log".format(
35 CONST.__getattribute__('dir_results'), self.project_name)
37 def execute(self, **kwargs):
38 """Execute the Python method.
40 The subclasses must override the default implementation which
43 The new implementation must return 0 if success or anything
47 kwargs: Arbitrary keyword arguments.
52 # pylint: disable=unused-argument,no-self-use
55 def run(self, **kwargs):
58 It allows executing any Python method by calling execute().
60 It sets the following attributes required to push the results
67 It doesn't fulfill details when pushing the results to the DB.
70 kwargs: Arbitrary keyword arguments.
73 TestCase.EX_OK if execute() returns 0,
74 TestCase.EX_RUN_ERROR otherwise.
76 self.start_time = time.time()
77 exit_code = base.TestCase.EX_RUN_ERROR
80 if self.execute(**kwargs) == 0:
81 exit_code = base.TestCase.EX_OK
83 ft_utils.logger_test_results(
84 self.project_name, self.case_name,
85 self.result, self.details)
86 self.__logger.info("%s %s", self.project_name, self.result)
87 except Exception: # pylint: disable=broad-except
88 self.__logger.exception("%s FAILED", self.project_name)
89 self.__logger.info("Test result is stored in '%s'", self.result_file)
90 self.stop_time = time.time()
94 class BashFeature(Feature):
95 """Class designed to run any bash command."""
97 __logger = logging.getLogger(__name__)
99 def execute(self, **kwargs):
100 """Execute the cmd passed as arg
103 kwargs: Arbitrary keyword arguments.
112 ret = ft_utils.execute_command(cmd, output_file=self.result_file)
114 self.__logger.error("Please give cmd as arg. kwargs: %s", kwargs)
115 except Exception: # pylint: disable=broad-except
116 self.__logger.exception("Execute cmd: %s failed", cmd)