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
  24 import logging
  25 import multiprocessing
  26 import time
  27 import traceback
  28
  29 import os
  30
  31 from yardstick.benchmark.runners import base
  32
  33 LOG = logging.getLogger(__name__)
  34
  35
  36 QUEUE_PUT_TIMEOUT = 10
  37
  38
  39 def _worker_process(queue, cls, method_name, scenario_cfg,
  40                     context_cfg, aborted, output_queue):
  41
  42     sequence = 1
  43
  44     runner_cfg = scenario_cfg['runner']
  45
  46     interval = runner_cfg.get("interval", 1)
  47     iterations = runner_cfg.get("iterations", 1)
  48     run_step = runner_cfg.get("run_step", "setup,run,teardown")
  49
  50     delta = runner_cfg.get("delta", 2)
  51     LOG.info("worker START, iterations %d times, class %s", iterations, cls)
  52
  53     runner_cfg['runner_id'] = os.getpid()
  54
  55     benchmark = cls(scenario_cfg, context_cfg)
  56     if "setup" in run_step:
  57         benchmark.setup()
  58
  59     method = getattr(benchmark, method_name)
  60
  61     sla_action = None
  62     if "sla" in scenario_cfg:
  63         sla_action = scenario_cfg["sla"].get("action", "assert")
  64     if "run" in run_step:
  65         while True:
  66
  67             LOG.debug("runner=%(runner)s seq=%(sequence)s START",
  68                       {"runner": runner_cfg["runner_id"],
  69                        "sequence": sequence})
  70
  71             data = {}
  72             errors = ""
  73
  74             try:
  75                 result = method(data)
  76             except AssertionError as assertion:
  77                 # SLA validation failed in scenario, determine what to do now
  78                 if sla_action == "assert":
  79                     raise
  80                 elif sla_action == "monitor":
  81                     LOG.warning("SLA validation failed: %s", assertion.args)
  82                     errors = assertion.args
  83                 elif sla_action == "rate-control":
  84                     try:
  85                         scenario_cfg['options']['rate']
  86                     except KeyError:
  87                         scenario_cfg.setdefault('options', {})
  88                         scenario_cfg['options']['rate'] = 100
  89
  90                     scenario_cfg['options']['rate'] -= delta
  91                     sequence = 1
  92                     continue
  93             except Exception:
  94                 errors = traceback.format_exc()
  95                 LOG.exception("")
  96             else:
  97                 if result:
  98                     # add timeout for put so we don't block test
  99                     # if we do timeout we don't care about dropping individual KPIs
 100                     output_queue.put(result, True, QUEUE_PUT_TIMEOUT)
 101
 102             time.sleep(interval)
 103
 104             benchmark_output = {
 105                 'timestamp': time.time(),
 106                 'sequence': sequence,
 107                 'data': data,
 108                 'errors': errors
 109             }
 110
 111             queue.put(benchmark_output, True, QUEUE_PUT_TIMEOUT)
 112
 113             LOG.debug("runner=%(runner)s seq=%(sequence)s END",
 114                       {"runner": runner_cfg["runner_id"],
 115                        "sequence": sequence})
 116
 117             sequence += 1
 118
 119             if (errors and sla_action is None) or \
 120                     (sequence > iterations or aborted.is_set()):
 121                 LOG.info("worker END")
 122                 break
 123     if "teardown" in run_step:
 124         try:
 125             benchmark.teardown()
 126         except Exception:
 127             # catch any exception in teardown and convert to simple exception
 128             # never pass exceptions back to multiprocessing, because some exceptions can
 129             # be unpicklable
 130             # https://bugs.python.org/issue9400
 131             LOG.exception("")
 132             raise SystemExit(1)
 133
 134     LOG.debug("queue.qsize() = %s", queue.qsize())
 135     LOG.debug("output_queue.qsize() = %s", output_queue.qsize())
 136
 137
 138 class IterationRunner(base.Runner):
 139     """Run a scenario for a configurable number of times
 140
 141 If the scenario ends before the time has elapsed, it will be started again.
 142
 143   Parameters
 144     iterations - amount of times the scenario will be run for
 145         type:    int
 146         unit:    na
 147         default: 1
 148     interval - time to wait between each scenario invocation
 149         type:    int
 150         unit:    seconds
 151         default: 1 sec
 152     """
 153     __execution_type__ = 'Iteration'
 154
 155     def _run_benchmark(self, cls, method, scenario_cfg, context_cfg):
 156         name = "{}-{}-{}".format(self.__execution_type__, scenario_cfg.get("type"), os.getpid())
 157         self.process = multiprocessing.Process(
 158             name=name,
 159             target=_worker_process,
 160             args=(self.result_queue, cls, method, scenario_cfg,
 161                   context_cfg, self.aborted, self.output_queue))
 162         self.process.start()