aboutsummaryrefslogtreecommitdiffstats
path: root/functest/core/feature.py
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2017-04-20 14:52:47 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2017-04-20 15:00:53 +0200
commit9b36d7fcfdbe45cd90723a6153863e4789d650cf (patch)
treefae6565189af33a8973b8e9f7938efe1dc357ca6 /functest/core/feature.py
parent6dbdeb1edc2d92be2c55a1b0dfdcf1fffc05c0a7 (diff)
Minor changes in docstrings
It removes case_name from the list of attributes that run() must set because it's now managed by run_tests.py (see __init__()) Change-Id: Id6228880257d0e9fb27483c56aa9985197feb04e Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Diffstat (limited to 'functest/core/feature.py')
-rw-r--r--functest/core/feature.py12
1 files changed, 7 insertions, 5 deletions
diff --git a/functest/core/feature.py b/functest/core/feature.py
index 00c7ec74..d8ddbdeb 100644
--- a/functest/core/feature.py
+++ b/functest/core/feature.py
@@ -25,7 +25,7 @@ __author__ = ("Serena Feng <feng.xiaowei@zte.com.cn>, "
class Feature(base.TestCase):
- """Parent class of Functest Feature."""
+ """Base model for single Functest feature."""
def __init__(self, **kwargs):
super(Feature, self).__init__(**kwargs)
@@ -34,11 +34,13 @@ class Feature(base.TestCase):
self.logger = ft_logger.Logger(self.project_name).getLogger()
def execute(self, **kwargs):
- """Execute Feature.
+ """Execute the Python method.
The subclasses must override the default implementation which
- is false on purpose. The only prerequisite is to return 0 if
- success or anything else if failure.
+ is false on purpose.
+
+ The new implementation must return 0 if success or anything
+ else if failure.
Args:
kwargs: Arbitrary keyword arguments.
@@ -50,7 +52,7 @@ class Feature(base.TestCase):
return -1
def run(self, **kwargs):
- """Run Feature.
+ """Run the feature.
It allows executing any Python method by calling execute().