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