Holger Hans Peter Freyther | 799fe62 | 2018-11-07 03:48:58 +0000 | [diff] [blame] | 1 | # osmo_ms_driver: Location Update Test |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 2 | # Create MS's and wait for the Location Update to succeed. |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 3 | # |
| 4 | # Copyright (C) 2018 by Holger Hans Peter Freyther |
| 5 | # |
| 6 | # This program is free software: you can redistribute it and/or modify |
| 7 | # it under the terms of the GNU General Public License as |
| 8 | # published by the Free Software Foundation, either version 3 of the |
| 9 | # License, or (at your option) any later version. |
| 10 | # |
| 11 | # This program is distributed in the hope that it will be useful, |
| 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | # GNU General Public License for more details. |
| 15 | # |
| 16 | # You should have received a copy of the GNU General Public License |
| 17 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 18 | |
Holger Hans Peter Freyther | 99a6a41 | 2018-08-29 04:24:38 +0100 | [diff] [blame] | 19 | from copy import copy |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 20 | from osmo_gsm_tester import log |
| 21 | from .starter import OsmoVirtPhy, OsmoMobile |
Holger Hans Peter Freyther | 5e67ed4 | 2019-02-25 09:48:50 +0000 | [diff] [blame] | 22 | from .test_support import Results |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 23 | |
| 24 | from datetime import timedelta |
| 25 | |
Holger Hans Peter Freyther | 337141f | 2019-02-23 09:58:59 +0000 | [diff] [blame] | 26 | import collections |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 27 | import time |
| 28 | |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 29 | class LUResult(Results): |
Holger Hans Peter Freyther | 337141f | 2019-02-23 09:58:59 +0000 | [diff] [blame] | 30 | """Representation of a Location Updating Result.""" |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 31 | |
| 32 | def __init__(self, name): |
Holger Hans Peter Freyther | 574e62f | 2018-06-20 09:15:15 +0100 | [diff] [blame] | 33 | super().__init__(name) |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 34 | self._time_of_lu = None |
| 35 | |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 36 | def set_lu_time(self, time): |
| 37 | assert self._time_of_lu is None |
| 38 | self._time_of_lu = time |
| 39 | |
Holger Hans Peter Freyther | 0f6e410 | 2018-06-23 15:52:25 +0100 | [diff] [blame] | 40 | def has_lu_time(self): |
| 41 | return self._time_of_lu is not None |
| 42 | |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 43 | def lu_time(self): |
| 44 | return self._time_of_lu or 0 |
| 45 | |
| 46 | def lu_delay(self): |
| 47 | return self.lu_time() - self.start_time() |
| 48 | |
Holger Hans Peter Freyther | 337141f | 2019-02-23 09:58:59 +0000 | [diff] [blame] | 49 | |
| 50 | LUStats = collections.namedtuple("LUStats", ["num_attempted", "num_completed", |
| 51 | "min_latency", "max_latency"]) |
| 52 | |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 53 | class MassUpdateLocationTest(log.Origin): |
| 54 | """ |
| 55 | A test to launch a configurable amount of MS and make them |
| 56 | execute a Location Updating Procedure. |
| 57 | |
| 58 | Configure the number of MS to be tested and a function that |
| 59 | decides how quickly to start them and a timeout. |
| 60 | """ |
| 61 | |
| 62 | TEMPLATE_LUA = "osmo-mobile-lu.lua" |
| 63 | TEMPLATE_CFG = "osmo-mobile.cfg" |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 64 | |
Holger Hans Peter Freyther | 5e67ed4 | 2019-02-25 09:48:50 +0000 | [diff] [blame] | 65 | def __init__(self, name, options, cdf_function, |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 66 | event_server, tmp_dir, suite_run=None): |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 67 | super().__init__(log.C_RUN, name) |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 68 | self._binary_options = options |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 69 | self._cdf = cdf_function |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 70 | self._suite_run = suite_run |
Holger Hans Peter Freyther | 5e67ed4 | 2019-02-25 09:48:50 +0000 | [diff] [blame] | 71 | self._tmp_dir = tmp_dir |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 72 | self._unstarted = [] |
Holger Hans Peter Freyther | 99a6a41 | 2018-08-29 04:24:38 +0100 | [diff] [blame] | 73 | self._mobiles = [] |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 74 | self._phys = [] |
| 75 | self._results = {} |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 76 | |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 77 | self._event_server = event_server |
| 78 | self._event_server.register(self.handle_msg) |
Holger Hans Peter Freyther | b697b3b | 2018-08-29 04:26:20 +0100 | [diff] [blame] | 79 | self._started = [] |
Holger Hans Peter Freyther | 5e67ed4 | 2019-02-25 09:48:50 +0000 | [diff] [blame] | 80 | self._subscribers = [] |
Holger Hans Peter Freyther | 99a6a41 | 2018-08-29 04:24:38 +0100 | [diff] [blame] | 81 | |
Holger Hans Peter Freyther | 5e67ed4 | 2019-02-25 09:48:50 +0000 | [diff] [blame] | 82 | def subscriber_add(self, subscriber): |
| 83 | """ |
| 84 | Adds a subscriber to the list of subscribers. |
| 85 | |
| 86 | Must be called before starting the testcase. |
| 87 | """ |
| 88 | self._subscribers.append(subscriber) |
| 89 | |
| 90 | def configure_tasks(self): |
| 91 | """Sets up the test run.""" |
| 92 | |
| 93 | self._cdf.set_target(len(self._subscribers)) |
| 94 | self._outstanding = len(self._subscribers) |
| 95 | for i in range(0, self._outstanding): |
| 96 | ms_name = "%.5d" % i |
| 97 | |
| 98 | phy = OsmoVirtPhy(self._binary_options.virtphy, |
| 99 | self._binary_options.env, |
| 100 | ms_name, self._tmp_dir) |
| 101 | self._phys.append(phy) |
| 102 | |
| 103 | launcher = OsmoMobile(self._binary_options.mobile, |
| 104 | self._binary_options.env, |
| 105 | ms_name, self._tmp_dir, self.TEMPLATE_LUA, |
| 106 | self.TEMPLATE_CFG, self._subscribers[i], |
| 107 | phy.phy_filename(), |
| 108 | self._event_server.server_path()) |
| 109 | self._results[ms_name] = LUResult(ms_name) |
| 110 | self._mobiles.append(launcher) |
| 111 | self._unstarted = copy(self._mobiles) |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 112 | |
| 113 | def pre_launch(self, loop): |
| 114 | """ |
| 115 | We need the virtphy's be ready when the lua script in the |
| 116 | mobile comes and kicks-off the test. In lua we don't seem to |
| 117 | be able to just stat/check if a file/socket exists so we need |
| 118 | to do this from here. |
| 119 | """ |
| 120 | self.log("Pre-launching all virtphy's") |
| 121 | for phy in self._phys: |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 122 | phy.start(loop, self._suite_run) |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 123 | |
| 124 | self.log("Checking if sockets are in the filesystem") |
| 125 | for phy in self._phys: |
| 126 | phy.verify_ready() |
| 127 | |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 128 | def prepare(self, loop): |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 129 | self.log("Starting testcase") |
| 130 | |
Holger Hans Peter Freyther | 5e67ed4 | 2019-02-25 09:48:50 +0000 | [diff] [blame] | 131 | self.configure_tasks() |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 132 | self.pre_launch(loop) |
| 133 | |
| 134 | self._start_time = time.clock_gettime(time.CLOCK_MONOTONIC) |
| 135 | self._end_time = self._start_time + \ |
| 136 | self._cdf.duration().total_seconds() + \ |
| 137 | timedelta(seconds=120).total_seconds() |
| 138 | |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 139 | self._started = [] |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 140 | self._too_slow = 0 |
| 141 | |
| 142 | def step_once(self, loop, current_time): |
| 143 | if len(self._unstarted) <= 0: |
| 144 | return current_time, None |
| 145 | |
| 146 | step_size = self._cdf.step_size().total_seconds() |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 147 | |
| 148 | # Start |
| 149 | self._cdf.step_once() |
| 150 | |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 151 | # Check for timeout |
| 152 | # start pending MS |
| 153 | while len(self._started) < self._cdf.current_scaled_value() and len(self._unstarted) > 0: |
| 154 | ms = self._unstarted.pop(0) |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 155 | ms.start(loop, self._suite_run) |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 156 | launch_time = time.clock_gettime(time.CLOCK_MONOTONIC) |
| 157 | self._results[ms.name_number()].set_launch_time(launch_time) |
| 158 | self._started.append(ms) |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 159 | |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 160 | now_time = time.clock_gettime(time.CLOCK_MONOTONIC) |
| 161 | sleep_time = (current_time + step_size) - now_time |
| 162 | if sleep_time <= 0: |
| 163 | self.log("Starting too slowly. Moving on", |
| 164 | target=(current_time + step_size), now=now_time, sleep=sleep_time) |
| 165 | self._too_slow += 1 |
| 166 | sleep_time = 0 |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 167 | |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 168 | if len(self._unstarted) == 0: |
| 169 | end_time = time.clock_gettime(time.CLOCK_MONOTONIC) |
| 170 | self.log("All started...", too_slow=self._too_slow, duration=end_time - self._start_time) |
| 171 | return current_time, None |
| 172 | |
| 173 | return current_time + step_size, sleep_time |
| 174 | |
Holger Hans Peter Freyther | 1dc9a04 | 2018-06-23 22:27:23 +0100 | [diff] [blame] | 175 | def run_test(self, loop, test_duration): |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 176 | self.prepare(loop) |
| 177 | |
Holger Hans Peter Freyther | 1dc9a04 | 2018-06-23 22:27:23 +0100 | [diff] [blame] | 178 | to_complete_time = self._start_time + test_duration.total_seconds() |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 179 | tick_time = self._start_time |
| 180 | |
| 181 | while not self.all_completed(): |
| 182 | tick_time, sleep_time = self.step_once(loop, tick_time) |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 183 | now_time = time.clock_gettime(time.CLOCK_MONOTONIC) |
Holger Hans Peter Freyther | 6926c57 | 2018-06-23 19:58:38 +0100 | [diff] [blame] | 184 | if sleep_time is None: |
| 185 | sleep_time = to_complete_time - now_time |
| 186 | if sleep_time < 0: |
| 187 | break |
| 188 | loop.schedule_timeout(sleep_time) |
| 189 | loop.select() |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 190 | |
| 191 | def stop_all(self): |
| 192 | for launcher in self._started: |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 193 | launcher.terminate() |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 194 | |
Holger Hans Peter Freyther | 05895a9 | 2018-06-17 19:31:46 +0100 | [diff] [blame] | 195 | def handle_msg(self, _data, addr, time): |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 196 | import json |
| 197 | data = json.loads(_data.decode()) |
| 198 | |
| 199 | if data['type'] == 'register': |
| 200 | ms = self._results[data['ms']] |
| 201 | ms.set_start_time(time) |
| 202 | launch_delay = ms.start_time() - ms.launch_time() |
| 203 | self.log("MS start registered ", ms=ms, at=time, delay=launch_delay) |
| 204 | elif data['type'] == 'event': |
| 205 | if data['data']['lu_done'] == 1: |
| 206 | ms = self._results[data['ms']] |
Holger Hans Peter Freyther | 0f6e410 | 2018-06-23 15:52:25 +0100 | [diff] [blame] | 207 | if not ms.has_lu_time(): |
| 208 | self._outstanding = self._outstanding - 1 |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 209 | ms.set_lu_time(time) |
| 210 | self.log("MS performed LU ", ms=ms, at=time, lu_delay=ms.lu_delay()) |
| 211 | else: |
| 212 | print(time, data) |
| 213 | raise Exception("Unknown event type..:" + _data.decode()) |
| 214 | |
| 215 | |
Holger Hans Peter Freyther | 0f6e410 | 2018-06-23 15:52:25 +0100 | [diff] [blame] | 216 | def all_completed(self): |
| 217 | return self._outstanding == 0 |
| 218 | |
Holger Hans Peter Freyther | 77d6d55 | 2019-02-23 04:43:08 +0000 | [diff] [blame] | 219 | def find_min_max(self, results): |
Holger Hans Peter Freyther | af522fd | 2018-06-23 21:35:30 +0100 | [diff] [blame] | 220 | min_value = max_value = None |
| 221 | for result in results: |
| 222 | if min_value is None or result.lu_delay() < min_value: |
| 223 | min_value = result.lu_delay() |
| 224 | if max_value is None or result.lu_delay() > max_value: |
| 225 | max_value = result.lu_delay() |
| 226 | return min_value, max_value |
| 227 | |
Holger Hans Peter Freyther | 337141f | 2019-02-23 09:58:59 +0000 | [diff] [blame] | 228 | def get_result_values(self): |
| 229 | """ |
| 230 | Returns the raw result values of the test run in any order. |
| 231 | """ |
| 232 | return self._results.values() |
| 233 | |
| 234 | def get_stats(self): |
| 235 | """ |
| 236 | Returns a statistical summary of the test. |
| 237 | """ |
| 238 | attempted = len(self._subscribers) |
| 239 | completed = attempted - self._outstanding |
| 240 | min_latency, max_latency = self.find_min_max(filter(lambda x: x.has_lu_time(), self._results.values())) |
| 241 | return LUStats(attempted, completed, min_latency, max_latency) |
| 242 | |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 243 | def print_stats(self): |
Holger Hans Peter Freyther | 337141f | 2019-02-23 09:58:59 +0000 | [diff] [blame] | 244 | stats = self.get_stats() |
| 245 | all_completed = stats.num_attempted == stats.num_completed |
Holger Hans Peter Freyther | 30cc021 | 2018-02-25 21:34:35 +0000 | [diff] [blame] | 246 | |
| 247 | self.log("Tests done", all_completed=all_completed, |
Holger Hans Peter Freyther | 337141f | 2019-02-23 09:58:59 +0000 | [diff] [blame] | 248 | min=stats.min_latency, max=stats.max_latency) |