Add support for Python 3
[yardstick.git] / yardstick / benchmark / scenarios / availability / monitor / basemonitor.py
1 ##############################################################################
2 # Copyright (c) 2015 Huawei Technologies Co.,Ltd. and others
3 #
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
9 from __future__ import absolute_import
10 import pkg_resources
11 import logging
12 import multiprocessing
13 import time
14 import os
15 import yardstick.common.utils as utils
16 import yaml
17
18 LOG = logging.getLogger(__name__)
19
20 monitor_conf_path = pkg_resources.resource_filename(
21     "yardstick.benchmark.scenarios.availability",
22     "monitor_conf.yaml")
23
24
25 class MonitorMgr(object):
26     """docstring for MonitorMgr"""
27
28     def __init__(self):
29         self._monitor_list = []
30
31     def init_monitors(self, monitor_cfgs, context):
32         LOG.debug("monitorMgr config: %s", monitor_cfgs)
33
34         for monitor_cfg in monitor_cfgs:
35             monitor_type = monitor_cfg["monitor_type"]
36             monitor_cls = BaseMonitor.get_monitor_cls(monitor_type)
37             monitor_ins = monitor_cls(monitor_cfg, context)
38             if "key" in monitor_cfg:
39                 monitor_ins.key = monitor_cfg["key"]
40             self._monitor_list.append(monitor_ins)
41
42     def __getitem__(self, item):
43         for obj in self._monitor_list:
44             if obj.key == item:
45                 return obj
46         raise KeyError("No such monitor instance of key - %s" % item)
47
48     def start_monitors(self):
49         for _monotor_instace in self._monitor_list:
50             _monotor_instace.start_monitor()
51
52     def wait_monitors(self):
53         for monitor in self._monitor_list:
54             monitor.wait_monitor()
55
56     def verify_SLA(self):
57         sla_pass = True
58         for monitor in self._monitor_list:
59             sla_pass = sla_pass & monitor.verify_SLA()
60         return sla_pass
61
62
63 class BaseMonitor(multiprocessing.Process):
64     """docstring for BaseMonitor"""
65     monitor_cfgs = {}
66
67     def __init__(self, config, context):
68         if not BaseMonitor.monitor_cfgs:
69             with open(monitor_conf_path) as stream:
70                 BaseMonitor.monitor_cfgs = yaml.load(stream)
71         multiprocessing.Process.__init__(self)
72         self._config = config
73         self._context = context
74         self._queue = multiprocessing.Queue()
75         self._event = multiprocessing.Event()
76         self.setup_done = False
77
78     @staticmethod
79     def get_monitor_cls(monitor_type):
80         '''return monitor class of specified type'''
81
82         for monitor in utils.itersubclasses(BaseMonitor):
83             if monitor_type == monitor.__monitor_type__:
84                 return monitor
85         raise RuntimeError("No such monitor_type %s" % monitor_type)
86
87     def get_script_fullpath(self, path):
88         base_path = os.path.dirname(monitor_conf_path)
89         return os.path.join(base_path, path)
90
91     def run(self):
92         LOG.debug("config:%s context:%s", self._config, self._context)
93
94         self.setup()
95         monitor_time = self._config.get("monitor_time", 0)
96
97         total_time = 0
98         outage_time = 0
99         total_count = 0
100         outage_count = 0
101         first_outage = 0
102         last_outage = 0
103
104         begin_time = time.time()
105         while True:
106             total_count = total_count + 1
107
108             one_check_begin_time = time.time()
109             exit_status = self.monitor_func()
110             one_check_end_time = time.time()
111
112             if exit_status is False:
113                 outage_count = outage_count + 1
114
115                 outage_time = outage_time + (
116                     one_check_end_time - one_check_begin_time)
117
118                 if not first_outage:
119                     first_outage = one_check_begin_time
120
121                 last_outage = one_check_end_time
122
123             if self._event.is_set():
124                 LOG.debug("the monitor process stop")
125                 break
126
127             if one_check_end_time - begin_time > monitor_time:
128                 LOG.debug("the monitor max_time finished and exit!")
129                 break
130
131         end_time = time.time()
132         total_time = end_time - begin_time
133
134         self._queue.put({"total_time": total_time,
135                          "outage_time": last_outage - first_outage,
136                          "total_count": total_count,
137                          "outage_count": outage_count})
138
139     def start_monitor(self):
140         self.start()
141
142     def wait_monitor(self):
143         self.join()
144         self._result = self._queue.get()
145         LOG.debug("the monitor result:%s", self._result)
146
147     def setup(self):  # pragma: no cover
148         pass
149
150     def monitor_func(self):  # pragma: no cover
151         pass
152
153     def verify_SLA(self):
154         pass