yardstick/benchmark/scenarios/base.py

   1 # Copyright 2013: Mirantis Inc.
   2 # All Rights Reserved.
   3 #
   4 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   5 #    not use this file except in compliance with the License. You may obtain
   6 #    a copy of the License at
   7 #
   8 #         http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #    Unless required by applicable law or agreed to in writing, software
  11 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13 #    License for the specific language governing permissions and limitations
  14 #    under the License.
  15
  16 # yardstick comment: this is a modified copy of
  17 # rally/rally/benchmark/scenarios/base.py
  18
  19 from stevedore import extension
  20
  21 import yardstick.common.utils as utils
  22
  23
  24 def _iter_scenario_classes(scenario_type=None):
  25     """Generator over all 'Scenario' subclasses
  26
  27     This function will iterate over all 'Scenario' subclasses defined in this
  28     project and will load any class introduced by any installed plugin project,
  29     defined in 'entry_points' section, under 'yardstick.scenarios' subsection.
  30     """
  31     extension.ExtensionManager(namespace='yardstick.scenarios',
  32                                invoke_on_load=False)
  33     for scenario in utils.itersubclasses(Scenario):
  34         if not scenario_type:
  35             yield scenario
  36         elif getattr(scenario, '__scenario_type__', None) == scenario_type:
  37             yield scenario
  38
  39
  40 class Scenario(object):
  41
  42     def setup(self):
  43         """ default impl for scenario setup """
  44         pass
  45
  46     def run(self, *args):
  47         """ catcher for not implemented run methods in subclasses """
  48         raise RuntimeError("run method not implemented")
  49
  50     def teardown(self):
  51         """ default impl for scenario teardown """
  52         pass
  53
  54     @staticmethod
  55     def get_types():
  56         """return a list of known runner type (class) names"""
  57         scenarios = []
  58         for scenario in _iter_scenario_classes():
  59             scenarios.append(scenario)
  60         return scenarios
  61
  62     @staticmethod
  63     def get_cls(scenario_type):
  64         """return class of specified type"""
  65         for scenario in _iter_scenario_classes(scenario_type):
  66             return scenario
  67
  68         raise RuntimeError("No such scenario type %s" % scenario_type)
  69
  70     @staticmethod
  71     def get(scenario_type):
  72         """Returns instance of a scenario runner for execution type.
  73         """
  74         scenario = Scenario.get_cls(scenario_type)
  75         return scenario.__module__ + "." + scenario.__name__
  76
  77     @classmethod
  78     def get_scenario_type(cls):
  79         """Return a string with the scenario type, if defined"""
  80         return str(getattr(cls, '__scenario_type__', None))
  81
  82     @classmethod
  83     def get_description(cls):
  84         """Return a single line string with the class description
  85
  86         This function will retrieve the class docstring and return the first
  87         line, or 'None' if it's empty.
  88         """
  89         return cls.__doc__.splitlines()[0] if cls.__doc__ else str(None)
  90
  91     def _push_to_outputs(self, keys, values):
  92         return dict(zip(keys, values))
  93
  94     def _change_obj_to_dict(self, obj):
  95         dic = {}
  96         for k, v in vars(obj).items():
  97             try:
  98                 vars(v)
  99             except TypeError:
 100                 dic[k] = v
 101         return dic