Merge "Refactor userguide "Yardstick Installation""

[yardstick.git] / yardstick / benchmark / scenarios / base.py

diff --git a/yardstick/benchmark/scenarios/base.py b/yardstick/benchmark/scenarios/base.py
index 5f5c07d..7af8583 100644 (file)
--- a/yardstick/benchmark/scenarios/base.py
+++ b/yardstick/benchmark/scenarios/base.py
@@ -26,20 +26,20 @@ import yardstick.common.utils as utils
 class Scenario(object):
 
     def setup(self):
-        ''' default impl for scenario setup '''
+        """ default impl for scenario setup """
         pass
 
     def run(self, args):
-        ''' catcher for not implemented run methods in subclasses '''
+        """ catcher for not implemented run methods in subclasses """
         raise RuntimeError("run method not implemented")
 
     def teardown(self):
-        ''' default impl for scenario teardown '''
+        """ default impl for scenario teardown """
         pass
 
     @staticmethod
     def get_types():
-        '''return a list of known runner type (class) names'''
+        """return a list of known runner type (class) names"""
         scenarios = []
         for scenario in utils.itersubclasses(Scenario):
             scenarios.append(scenario)
@@ -47,7 +47,7 @@ class Scenario(object):
 
     @staticmethod
     def get_cls(scenario_type):
-        '''return class of specified type'''
+        """return class of specified type"""
         for scenario in utils.itersubclasses(Scenario):
             if scenario_type == scenario.__scenario_type__:
                 return scenario
@@ -63,3 +63,29 @@ class Scenario(object):
                 return scenario.__module__ + "." + scenario.__name__
 
         raise RuntimeError("No such scenario type %s" % scenario_type)
+
+    @classmethod
+    def get_scenario_type(cls):
+        """Return a string with the scenario type, if defined"""
+        return str(getattr(cls, '__scenario_type__', None))
+
+    @classmethod
+    def get_description(cls):
+        """Return a single line string with the class description
+
+        This function will retrieve the class docstring and return the first
+        line, or 'None' if it's empty.
+        """
+        return cls.__doc__.splitlines()[0] if cls.__doc__ else str(None)
+
+    def _push_to_outputs(self, keys, values):
+        return dict(zip(keys, values))
+
+    def _change_obj_to_dict(self, obj):
+        dic = {}
+        for k, v in vars(obj).items():
+            try:
+                vars(v)
+            except TypeError:
+                dic[k] = v
+        return dic