Source code for yardstick.benchmark.scenarios.base

##############################################################################
# Copyright (c) 2015 Ericsson AB and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################

""" Scenario base class
"""

import yardstick.common.utils as utils


[docs]class Scenario(object):

[docs]    def setup(self):
        ''' default impl for scenario setup '''
        pass

[docs]    def run(self, args):
        ''' catcher for not implemented run methods in subclasses '''
        raise RuntimeError("run method not implemented")

[docs]    def teardown(self):
        ''' default impl for scenario teardown '''
        pass

    @staticmethod
[docs]    def get_types():
        '''return a list of known runner type (class) names'''
        scenarios = []
        for scenario in utils.itersubclasses(Scenario):
            scenarios.append(scenario)
        return scenarios

    @staticmethod
[docs]    def get_cls(scenario_type):
        '''return class of specified type'''
        for scenario in utils.itersubclasses(Scenario):
            if scenario_type == scenario.__scenario_type__:
                return scenario

        raise RuntimeError("No such scenario type %s" % scenario_type)

    @staticmethod
[docs]    def get(scenario_type):
        """Returns instance of a scenario runner for execution type.
        """
        for scenario in utils.itersubclasses(Scenario):
            if scenario_type == scenario.__scenario_type__:
                return scenario.__module__ + "." + scenario.__name__

        raise RuntimeError("No such scenario type %s" % scenario_type)