Yardstick output format unified
[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, output_queue):
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
45     delta = runner_cfg.get("delta", 2)
46     LOG.info("worker START, iterations %d times, class %s", iterations, cls)
47
48     runner_cfg['runner_id'] = os.getpid()
49
50     benchmark = cls(scenario_cfg, context_cfg)
51     if "setup" in run_step:
52         benchmark.setup()
53
54     method = getattr(benchmark, method_name)
55
56     sla_action = None
57     if "sla" in scenario_cfg:
58         sla_action = scenario_cfg["sla"].get("action", "assert")
59     if "run" in run_step:
60         while True:
61
62             LOG.debug("runner=%(runner)s seq=%(sequence)s START",
63                       {"runner": runner_cfg["runner_id"],
64                        "sequence": sequence})
65
66             data = {}
67             errors = ""
68
69             try:
70                 result = method(data)
71             except AssertionError as assertion:
72                 # SLA validation failed in scenario, determine what to do now
73                 if sla_action == "assert":
74                     raise
75                 elif sla_action == "monitor":
76                     LOG.warning("SLA validation failed: %s", assertion.args)
77                     errors = assertion.args
78                 elif sla_action == "rate-control":
79                     try:
80                         scenario_cfg['options']['rate']
81                     except KeyError:
82                         scenario_cfg.setdefault('options', {})
83                         scenario_cfg['options']['rate'] = 100
84
85                     scenario_cfg['options']['rate'] -= delta
86                     sequence = 1
87                     continue
88             except Exception as e:
89                 errors = traceback.format_exc()
90                 LOG.exception(e)
91             else:
92                 if result:
93                     output_queue.put(result)
94
95             time.sleep(interval)
96
97             benchmark_output = {
98                 'timestamp': time.time(),
99                 'sequence': sequence,
100                 'data': data,
101                 'errors': errors
102             }
103
104             queue.put(benchmark_output)
105
106             LOG.debug("runner=%(runner)s seq=%(sequence)s END",
107                       {"runner": runner_cfg["runner_id"],
108                        "sequence": sequence})
109
110             sequence += 1
111
112             if (errors and sla_action is None) or \
113                     (sequence > iterations or aborted.is_set()):
114                 LOG.info("worker END")
115                 break
116     if "teardown" in run_step:
117         benchmark.teardown()
118
119
120 class IterationRunner(base.Runner):
121     """Run a scenario for a configurable number of times
122
123 If the scenario ends before the time has elapsed, it will be started again.
124
125   Parameters
126     iterations - amount of times the scenario will be run for
127         type:    int
128         unit:    na
129         default: 1
130     interval - time to wait between each scenario invocation
131         type:    int
132         unit:    seconds
133         default: 1 sec
134     """
135     __execution_type__ = 'Iteration'
136
137     def _run_benchmark(self, cls, method, scenario_cfg, context_cfg):
138         self.process = multiprocessing.Process(
139             target=_worker_process,
140             args=(self.result_queue, cls, method, scenario_cfg,
141                   context_cfg, self.aborted, self.output_queue))
142         self.process.start()