Merge "collectd: typo and call super()"
[yardstick.git] / yardstick / benchmark / runners / iteration.py
1 # Copyright 2014: 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/runners/constant.py
18
19 """A runner that runs a configurable number of times before it returns
20 """
21
22 from __future__ import absolute_import
23 import os
24 import multiprocessing
25 import logging
26 import traceback
27 import time
28
29 from yardstick.benchmark.runners import base
30
31 LOG = logging.getLogger(__name__)
32
33
34 def _worker_process(queue, cls, method_name, scenario_cfg,
35                     context_cfg, aborted):
36
37     sequence = 1
38
39     runner_cfg = scenario_cfg['runner']
40
41     interval = runner_cfg.get("interval", 1)
42     iterations = runner_cfg.get("iterations", 1)
43     run_step = runner_cfg.get("run_step", "setup,run,teardown")
44     LOG.info("worker START, iterations %d times, class %s", iterations, cls)
45
46     runner_cfg['runner_id'] = os.getpid()
47
48     benchmark = cls(scenario_cfg, context_cfg)
49     if "setup" in run_step:
50         benchmark.setup()
51
52     method = getattr(benchmark, method_name)
53
54     queue.put({'runner_id': runner_cfg['runner_id'],
55                'scenario_cfg': scenario_cfg,
56                'context_cfg': context_cfg})
57
58     sla_action = None
59     if "sla" in scenario_cfg:
60         sla_action = scenario_cfg["sla"].get("action", "assert")
61     if "run" in run_step:
62         while True:
63
64             LOG.debug("runner=%(runner)s seq=%(sequence)s START",
65                       {"runner": runner_cfg["runner_id"],
66                        "sequence": sequence})
67
68             data = {}
69             errors = ""
70
71             try:
72                 method(data)
73             except AssertionError as assertion:
74                 # SLA validation failed in scenario, determine what to do now
75                 if sla_action == "assert":
76                     raise
77                 elif sla_action == "monitor":
78                     LOG.warning("SLA validation failed: %s", assertion.args)
79                     errors = assertion.args
80             except Exception as e:
81                 errors = traceback.format_exc()
82                 LOG.exception(e)
83
84             time.sleep(interval)
85
86             benchmark_output = {
87                 'timestamp': time.time(),
88                 'sequence': sequence,
89                 'data': data,
90                 'errors': errors
91             }
92
93             record = {'runner_id': runner_cfg['runner_id'],
94                       'benchmark': benchmark_output}
95
96             queue.put(record)
97
98             LOG.debug("runner=%(runner)s seq=%(sequence)s END",
99                       {"runner": runner_cfg["runner_id"],
100                        "sequence": sequence})
101
102             sequence += 1
103
104             if (errors and sla_action is None) or \
105                     (sequence > iterations or aborted.is_set()):
106                 LOG.info("worker END")
107                 break
108     if "teardown" in run_step:
109         benchmark.teardown()
110
111
112 class IterationRunner(base.Runner):
113     """Run a scenario for a configurable number of times
114
115 If the scenario ends before the time has elapsed, it will be started again.
116
117   Parameters
118     iterations - amount of times the scenario will be run for
119         type:    int
120         unit:    na
121         default: 1
122     interval - time to wait between each scenario invocation
123         type:    int
124         unit:    seconds
125         default: 1 sec
126     """
127     __execution_type__ = 'Iteration'
128
129     def _run_benchmark(self, cls, method, scenario_cfg, context_cfg):
130         self.process = multiprocessing.Process(
131             target=_worker_process,
132             args=(self.result_queue, cls, method, scenario_cfg,
133                   context_cfg, self.aborted))
134         self.process.start()