aboutsummaryrefslogtreecommitdiffstats
path: root/yardstick/benchmark/scenarios/base.py
blob: 8146067ba78651af7bc39c4dcc0da8e747eedd21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
##############################################################################
# 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


class Scenario(object):

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

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

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

    @staticmethod
    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
    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
    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)