yardstick/benchmark/runners/sequence.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 every run changes a specified input value to the scenario.
  20 The input value in the sequence is specified in a list in the input file.
  21 """
  22
  23 from __future__ import absolute_import
  24
  25 import logging
  26 import multiprocessing
  27 import time
  28 import traceback
  29
  30 import os
  31
  32 from yardstick.benchmark.runners import base
  33 from yardstick.common import exceptions as y_exc
  34
  35 LOG = logging.getLogger(__name__)
  36
  37
  38 def _worker_process(queue, cls, method_name, scenario_cfg,
  39                     context_cfg, aborted, output_queue):
  40
  41     sequence = 1
  42
  43     runner_cfg = scenario_cfg['runner']
  44
  45     interval = runner_cfg.get("interval", 1)
  46     arg_name = runner_cfg.get('scenario_option_name')
  47     sequence_values = runner_cfg.get('sequence')
  48
  49     if 'options' not in scenario_cfg:
  50         scenario_cfg['options'] = {}
  51
  52     options = scenario_cfg['options']
  53
  54     runner_cfg['runner_id'] = os.getpid()
  55
  56     LOG.info("worker START, sequence_values(%s, %s), class %s",
  57              arg_name, sequence_values, cls)
  58
  59     benchmark = cls(scenario_cfg, context_cfg)
  60     benchmark.setup()
  61     method = getattr(benchmark, method_name)
  62
  63     sla_action = None
  64     if "sla" in scenario_cfg:
  65         sla_action = scenario_cfg["sla"].get("action", "assert")
  66
  67     for value in sequence_values:
  68         options[arg_name] = value
  69
  70         LOG.debug("runner=%(runner)s seq=%(sequence)s START",
  71                   {"runner": runner_cfg["runner_id"], "sequence": sequence})
  72
  73         data = {}
  74         errors = ""
  75
  76         try:
  77             result = method(data)
  78         except y_exc.SLAValidationError as error:
  79             # SLA validation failed in scenario, determine what to do now
  80             if sla_action == "assert":
  81                 raise
  82             elif sla_action == "monitor":
  83                 LOG.warning("SLA validation failed: %s", error.args)
  84                 errors = error.args
  85         except Exception as e:  # pylint: disable=broad-except
  86             errors = traceback.format_exc()
  87             LOG.exception(e)
  88         else:
  89             if result:
  90                 output_queue.put(result)
  91
  92         time.sleep(interval)
  93
  94         benchmark_output = {
  95             'timestamp': time.time(),
  96             'sequence': sequence,
  97             'data': data,
  98             'errors': errors
  99         }
 100
 101         queue.put(benchmark_output)
 102
 103         LOG.debug("runner=%(runner)s seq=%(sequence)s END",
 104                   {"runner": runner_cfg["runner_id"], "sequence": sequence})
 105
 106         sequence += 1
 107
 108         if (errors and sla_action is None) or aborted.is_set():
 109             break
 110
 111     try:
 112         benchmark.teardown()
 113     except Exception:
 114         # catch any exception in teardown and convert to simple exception
 115         # never pass exceptions back to multiprocessing, because some exceptions can
 116         # be unpicklable
 117         # https://bugs.python.org/issue9400
 118         LOG.exception("")
 119         raise SystemExit(1)
 120     LOG.info("worker END")
 121     LOG.debug("queue.qsize() = %s", queue.qsize())
 122     LOG.debug("output_queue.qsize() = %s", output_queue.qsize())
 123
 124
 125 class SequenceRunner(base.Runner):
 126     """Run a scenario by changing an input value defined in a list
 127
 128   Parameters
 129     interval - time to wait between each scenario invocation
 130         type:    int
 131         unit:    seconds
 132         default: 1 sec
 133     scenario_option_name - name of the option that is increased each invocation
 134         type:    string
 135         unit:    na
 136         default: none
 137     sequence - list of values which are executed in their respective scenarios
 138         type:    [int]
 139         unit:    na
 140         default: none
 141     """
 142
 143     __execution_type__ = 'Sequence'
 144
 145     def _run_benchmark(self, cls, method, scenario_cfg, context_cfg):
 146         name = "{}-{}-{}".format(self.__execution_type__, scenario_cfg.get("type"), os.getpid())
 147         self.process = multiprocessing.Process(
 148             name=name,
 149             target=_worker_process,
 150             args=(self.result_queue, cls, method, scenario_cfg,
 151                   context_cfg, self.aborted, self.output_queue))
 152         self.process.start()