summaryrefslogtreecommitdiffstats
path: root/vnftest/runners/iteration.py
blob: 1d62bca198be90d8a2ae8c297d781bbd136a4fae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
##############################################################################
# Copyright 2018 EuropeanSoftwareMarketingLtd.
# ===================================================================
#  Licensed under the ApacheLicense, Version2.0 (the"License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#  http://www.apache.org/licenses/LICENSE-2.0
#
# software distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and limitations under
# the License
##############################################################################
# vnftest comment: this is a modified copy of
# rally/rally/benchmark/runners/vnf_type_crawler.py

"""A runner that runs a configurable number of times before it returns
"""

from __future__ import absolute_import

import logging
import multiprocessing
import time
import traceback

import os

from vnftest.common.exceptions import VnftestException
from vnftest.runners import base

LOG = logging.getLogger(__name__)


QUEUE_PUT_TIMEOUT = 10


def _worker_process(result_queue, cls, method_name, step_cfg,
                    context_cfg, input_params, aborted, output_queue):

    sequence = 1

    runner_cfg = step_cfg['runner']

    interval = runner_cfg.get("interval", 1)
    iterations = runner_cfg.get("iterations", 1)
    run_step = runner_cfg.get("run_step", "setup,run,teardown")

    delta = runner_cfg.get("delta", 2)
    LOG.info("worker START, iterations %d times, class %s", iterations, cls)

    runner_cfg['runner_id'] = os.getpid()

    step = cls(step_cfg, context_cfg, input_params)
    if "setup" in run_step:
        step.setup()

    method = getattr(step, method_name)

    sla_action = None
    if "sla" in step_cfg:
        sla_action = step_cfg["sla"].get("action", "assert")
    if "run" in run_step:
        while True:

            LOG.debug("runner=%(runner)s seq=%(sequence)s START",
                      {"runner": runner_cfg["runner_id"],
                       "sequence": sequence})

            results = {}
            errors = []
            fatal_error = False

            try:
                output = method(results)
                if output:
                    # add timeout for put so we don't block test
                    # if we do timeout we don't care about dropping individual KPIs
                    output_queue.put(output, True, QUEUE_PUT_TIMEOUT)
            except AssertionError as assertion:
                LOG.exception("Assertion error: %s", assertion)
                # SLA validation failed in step, determine what to do now
                if sla_action == "assert":
                    errors.append(assertion)
                    fatal_error = True
                elif sla_action == "monitor":
                    LOG.warning("SLA validation failed: %s", assertion.args)
                    errors.append(assertion.args)
                elif sla_action == "rate-control":
                    try:
                        step_cfg['options']['rate']
                    except KeyError:
                        step_cfg.setdefault('options', {})
                        step_cfg['options']['rate'] = 100

                    step_cfg['options']['rate'] -= delta
                    sequence = 1
                    continue
            except Exception:
                errors.append(traceback.format_exc())
                LOG.exception("")
                LOG.info("Abort the task")
                fatal_error = True

            time.sleep(interval)

            step_results = {
                'timestamp': time.time(),
                'sequence': sequence,
                'data': results,
                'errors': errors
            }

            result_queue.put(step_results, True, QUEUE_PUT_TIMEOUT)

            LOG.debug("runner=%(runner)s seq=%(sequence)s END",
                      {"runner": runner_cfg["runner_id"],
                       "sequence": sequence})

            sequence += 1

            if (errors and sla_action is None) or \
                    (sequence > iterations or aborted.is_set()) or fatal_error:
                LOG.info("worker END")
                break
    if "teardown" in run_step:
        try:
            step.teardown()
        except Exception:
            # catch any exception in teardown and convert to simple exception
            # never pass exceptions back to multiprocessing, because some exceptions can
            # be unpicklable
            # https://bugs.python.org/issue9400
            LOG.exception("")
            raise SystemExit(1)

    LOG.debug("queue.qsize() = %s", result_queue.qsize())
    LOG.debug("output_queue.qsize() = %s", output_queue.qsize())
    if fatal_error:
        raise SystemExit(1)


class IterationRunner(base.Runner):
    """Run a step for a configurable number of times

If the step ends before the time has elapsed, it will be started again.

  Parameters
    iterations - amount of times the step will be run for
        type:    int
        unit:    na
        default: 1
    interval - time to wait between each step invocation
        type:    int
        unit:    seconds
        default: 1 sec
    """
    __execution_type__ = 'Iteration'

    def _run_step(self, cls, method, step_cfg, context_cfg, input_params):
        name = "{}-{}-{}".format(self.__execution_type__, step_cfg.get("type"), os.getpid())
        self.process = multiprocessing.Process(
            name=name,
            target=_worker_process,
            args=(self.result_queue, cls, method, step_cfg,
                  context_cfg, input_params, self.aborted, self.output_queue))
        self.process.start()