Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: test suite |
| 2 | # |
| 3 | # Copyright (C) 2016-2017 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Neels Hofmeyr <neels@hofmeyr.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 8 | # it under the terms of the GNU General Public License as |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 9 | # published by the Free Software Foundation, either version 3 of the |
| 10 | # License, or (at your option) any later version. |
| 11 | # |
| 12 | # This program is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 15 | # GNU General Public License for more details. |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 16 | # |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 17 | # You should have received a copy of the GNU General Public License |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import os |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 21 | import sys |
| 22 | import time |
Neels Hofmeyr | 2d1d561 | 2017-05-22 20:02:41 +0200 | [diff] [blame] | 23 | import pprint |
Holger Hans Peter Freyther | d03acdf | 2018-09-23 18:06:48 +0100 | [diff] [blame] | 24 | from . import config, log, util, resource, test |
Pau Espin Pedrol | 9a4631c | 2018-03-28 19:17:34 +0200 | [diff] [blame] | 25 | from .event_loop import MainLoop |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 26 | from . import osmo_nitb, osmo_hlr, osmo_mgcpgw, osmo_mgw, osmo_msc, osmo_bsc, osmo_stp, osmo_ggsn, osmo_sgsn, modem, esme, osmocon, ms_driver, iperf3 |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 27 | |
Neels Hofmeyr | 1ffc3fe | 2017-05-07 02:15:21 +0200 | [diff] [blame] | 28 | class Timeout(Exception): |
| 29 | pass |
| 30 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 31 | class SuiteDefinition(log.Origin): |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 32 | '''A test suite reserves resources for a number of tests. |
| 33 | Each test requires a specific number of modems, BTSs etc., which are |
| 34 | reserved beforehand by a test suite. This way several test suites can be |
| 35 | scheduled dynamically without resource conflicts arising halfway through |
| 36 | the tests.''' |
| 37 | |
| 38 | CONF_FILENAME = 'suite.conf' |
| 39 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 40 | def __init__(self, suite_dir): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 41 | self.suite_dir = suite_dir |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 42 | super().__init__(log.C_CNF, os.path.basename(self.suite_dir)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 43 | self.read_conf() |
| 44 | |
| 45 | def read_conf(self): |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 46 | self.dbg('reading %s' % SuiteDefinition.CONF_FILENAME) |
| 47 | if not os.path.isdir(self.suite_dir): |
| 48 | raise RuntimeError('No such directory: %r' % self.suite_dir) |
| 49 | self.conf = config.read(os.path.join(self.suite_dir, |
| 50 | SuiteDefinition.CONF_FILENAME), |
Pau Espin Pedrol | 0b30279 | 2017-09-10 16:33:10 +0200 | [diff] [blame] | 51 | resource.CONF_SCHEMA) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 52 | self.load_test_basenames() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 53 | |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 54 | def load_test_basenames(self): |
| 55 | self.test_basenames = [] |
| 56 | for basename in sorted(os.listdir(self.suite_dir)): |
| 57 | if not basename.endswith('.py'): |
| 58 | continue |
| 59 | self.test_basenames.append(basename) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 60 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 61 | class SuiteRun(log.Origin): |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 62 | UNKNOWN = 'UNKNOWN' |
| 63 | PASS = 'PASS' |
| 64 | FAIL = 'FAIL' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 65 | |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 66 | def __init__(self, trial, suite_scenario_str, suite_definition, scenarios=[]): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 67 | super().__init__(log.C_TST, suite_scenario_str) |
Pau Espin Pedrol | 5860367 | 2018-08-09 13:45:55 +0200 | [diff] [blame] | 68 | self.start_timestamp = None |
| 69 | self.duration = None |
| 70 | self.reserved_resources = None |
| 71 | self.objects_to_clean_up = None |
| 72 | self.test_import_modules_to_clean_up = [] |
| 73 | self._resource_requirements = None |
Pau Espin Pedrol | aab5692 | 2018-08-21 14:58:29 +0200 | [diff] [blame] | 74 | self._resource_modifiers = None |
Pau Espin Pedrol | 5860367 | 2018-08-09 13:45:55 +0200 | [diff] [blame] | 75 | self._config = None |
| 76 | self._processes = None |
| 77 | self._run_dir = None |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 78 | self.trial = trial |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 79 | self.definition = suite_definition |
| 80 | self.scenarios = scenarios |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 81 | self.resources_pool = resource.ResourcesPool() |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 82 | self.status = SuiteRun.UNKNOWN |
| 83 | self.load_tests() |
| 84 | |
| 85 | def load_tests(self): |
| 86 | self.tests = [] |
| 87 | for test_basename in self.definition.test_basenames: |
Pau Espin Pedrol | fd5de3d | 2017-11-09 14:26:35 +0100 | [diff] [blame] | 88 | self.tests.append(test.Test(self, test_basename)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 89 | |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 90 | def register_for_cleanup(self, *obj): |
| 91 | assert all([hasattr(o, 'cleanup') for o in obj]) |
| 92 | self.objects_to_clean_up = self.objects_to_clean_up or [] |
| 93 | self.objects_to_clean_up.extend(obj) |
| 94 | |
| 95 | def objects_cleanup(self): |
| 96 | while self.objects_to_clean_up: |
| 97 | obj = self.objects_to_clean_up.pop() |
Pau Espin Pedrol | 6100b62 | 2017-07-31 18:19:06 +0200 | [diff] [blame] | 98 | try: |
| 99 | obj.cleanup() |
| 100 | except Exception: |
| 101 | log.log_exn() |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 102 | |
Pau Espin Pedrol | 155a355 | 2018-05-09 11:24:23 +0200 | [diff] [blame] | 103 | def test_import_modules_register_for_cleanup(self, mod): |
| 104 | ''' |
| 105 | Tests are required to call this API for any module loaded from its own |
| 106 | lib subdir, because they are loaded in the global namespace. Otherwise |
| 107 | later tests importing modules with the same name will re-use an already |
| 108 | loaded module. |
| 109 | ''' |
| 110 | if mod not in self.test_import_modules_to_clean_up: |
| 111 | self.dbg('registering module %r for cleanup' % mod) |
| 112 | self.test_import_modules_to_clean_up.append(mod) |
| 113 | |
| 114 | def test_import_modules_cleanup(self): |
| 115 | while self.test_import_modules_to_clean_up: |
| 116 | mod = self.test_import_modules_to_clean_up.pop() |
| 117 | try: |
| 118 | self.dbg('Cleaning up module %r' % mod) |
| 119 | del sys.modules[mod.__name__] |
| 120 | del mod |
| 121 | except Exception: |
| 122 | log.log_exn() |
| 123 | |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 124 | def mark_start(self): |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 125 | self.start_timestamp = time.time() |
| 126 | self.duration = 0 |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 127 | self.status = SuiteRun.UNKNOWN |
| 128 | |
Pau Espin Pedrol | c264d3d | 2018-08-27 12:49:35 +0200 | [diff] [blame] | 129 | def combined(self, conf_name, replicate_times=True): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 130 | log.dbg(combining=conf_name) |
| 131 | log.ctx(combining_scenarios=conf_name) |
Pau Espin Pedrol | c264d3d | 2018-08-27 12:49:35 +0200 | [diff] [blame] | 132 | combination = self.definition.conf.get(conf_name, {}) |
| 133 | if replicate_times: |
| 134 | combination = config.replicate_times(combination) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 135 | log.dbg(definition_conf=combination) |
| 136 | for scenario in self.scenarios: |
| 137 | log.ctx(combining_scenarios=conf_name, scenario=scenario.name()) |
Pau Espin Pedrol | c264d3d | 2018-08-27 12:49:35 +0200 | [diff] [blame] | 138 | c = scenario.get(conf_name, {}) |
| 139 | if replicate_times: |
| 140 | c = config.replicate_times(c) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 141 | log.dbg(scenario=scenario.name(), conf=c) |
| 142 | if c is None: |
| 143 | continue |
| 144 | config.combine(combination, c) |
| 145 | return combination |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 146 | |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 147 | def get_run_dir(self): |
| 148 | if self._run_dir is None: |
| 149 | self._run_dir = util.Dir(self.trial.get_run_dir().new_dir(self.name())) |
| 150 | return self._run_dir |
| 151 | |
| 152 | def get_test_run_dir(self): |
| 153 | if self.current_test: |
| 154 | return self.current_test.get_run_dir() |
| 155 | return self.get_run_dir() |
| 156 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 157 | def resource_requirements(self): |
| 158 | if self._resource_requirements is None: |
| 159 | self._resource_requirements = self.combined('resources') |
| 160 | return self._resource_requirements |
| 161 | |
Pau Espin Pedrol | aab5692 | 2018-08-21 14:58:29 +0200 | [diff] [blame] | 162 | def resource_modifiers(self): |
| 163 | if self._resource_modifiers is None: |
| 164 | self._resource_modifiers = self.combined('modifiers') |
| 165 | return self._resource_modifiers |
| 166 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 167 | def config(self): |
| 168 | if self._config is None: |
Pau Espin Pedrol | c264d3d | 2018-08-27 12:49:35 +0200 | [diff] [blame] | 169 | self._config = self.combined('config', False) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 170 | return self._config |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 171 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 172 | def reserve_resources(self): |
| 173 | if self.reserved_resources: |
| 174 | raise RuntimeError('Attempt to reserve resources twice for a SuiteRun') |
Neels Hofmeyr | 7e2e8f1 | 2017-05-14 03:37:13 +0200 | [diff] [blame] | 175 | self.log('reserving resources in', self.resources_pool.state_dir, '...') |
Pau Espin Pedrol | aab5692 | 2018-08-21 14:58:29 +0200 | [diff] [blame] | 176 | self.reserved_resources = self.resources_pool.reserve(self, self.resource_requirements(), self.resource_modifiers()) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 177 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 178 | def run_tests(self, names=None): |
Pau Espin Pedrol | 7e02d20 | 2018-05-08 15:28:48 +0200 | [diff] [blame] | 179 | suite_libdir = os.path.join(self.definition.suite_dir, 'lib') |
Pau Espin Pedrol | 469316f | 2017-05-17 14:51:31 +0200 | [diff] [blame] | 180 | try: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 181 | log.large_separator(self.trial.name(), self.name(), sublevel=2) |
| 182 | self.mark_start() |
Pau Espin Pedrol | 7e02d20 | 2018-05-08 15:28:48 +0200 | [diff] [blame] | 183 | util.import_path_prepend(suite_libdir) |
Pau Espin Pedrol | 9a4631c | 2018-03-28 19:17:34 +0200 | [diff] [blame] | 184 | MainLoop.register_poll_func(self.poll) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 185 | if not self.reserved_resources: |
| 186 | self.reserve_resources() |
Pau Espin Pedrol | fd5de3d | 2017-11-09 14:26:35 +0100 | [diff] [blame] | 187 | for t in self.tests: |
| 188 | if names and not t.name() in names: |
| 189 | t.set_skip() |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 190 | continue |
Pau Espin Pedrol | fd5de3d | 2017-11-09 14:26:35 +0100 | [diff] [blame] | 191 | self.current_test = t |
| 192 | t.run() |
Pau Espin Pedrol | 1dd2955 | 2017-06-13 18:07:57 +0200 | [diff] [blame] | 193 | self.stop_processes() |
| 194 | self.objects_cleanup() |
| 195 | self.reserved_resources.put_all() |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 196 | except Exception: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 197 | log.log_exn() |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 198 | except BaseException as e: |
| 199 | # when the program is aborted by a signal (like Ctrl-C), escalate to abort all. |
| 200 | self.err('SUITE RUN ABORTED: %s' % type(e).__name__) |
| 201 | raise |
Pau Espin Pedrol | 469316f | 2017-05-17 14:51:31 +0200 | [diff] [blame] | 202 | finally: |
| 203 | # if sys.exit() called from signal handler (e.g. SIGINT), SystemExit |
| 204 | # base exception is raised. Make sure to stop processes in this |
| 205 | # finally section. Resources are automatically freed with 'atexit'. |
| 206 | self.stop_processes() |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 207 | self.objects_cleanup() |
Neels Hofmeyr | ed4e528 | 2017-05-29 02:53:54 +0200 | [diff] [blame] | 208 | self.free_resources() |
Pau Espin Pedrol | 9a4631c | 2018-03-28 19:17:34 +0200 | [diff] [blame] | 209 | MainLoop.unregister_poll_func(self.poll) |
Pau Espin Pedrol | 155a355 | 2018-05-09 11:24:23 +0200 | [diff] [blame] | 210 | self.test_import_modules_cleanup() |
Pau Espin Pedrol | 7e02d20 | 2018-05-08 15:28:48 +0200 | [diff] [blame] | 211 | util.import_path_remove(suite_libdir) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 212 | self.duration = time.time() - self.start_timestamp |
| 213 | |
| 214 | passed, skipped, failed = self.count_test_results() |
| 215 | # if no tests ran, count it as failure |
| 216 | if passed and not failed: |
| 217 | self.status = SuiteRun.PASS |
| 218 | else: |
| 219 | self.status = SuiteRun.FAIL |
| 220 | |
| 221 | log.large_separator(self.trial.name(), self.name(), self.status, sublevel=2, space_above=False) |
| 222 | |
| 223 | def passed(self): |
| 224 | return self.status == SuiteRun.PASS |
| 225 | |
| 226 | def count_test_results(self): |
| 227 | passed = 0 |
| 228 | skipped = 0 |
| 229 | failed = 0 |
Pau Espin Pedrol | fd5de3d | 2017-11-09 14:26:35 +0100 | [diff] [blame] | 230 | for t in self.tests: |
| 231 | if t.status == test.Test.PASS: |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 232 | passed += 1 |
Pau Espin Pedrol | fd5de3d | 2017-11-09 14:26:35 +0100 | [diff] [blame] | 233 | elif t.status == test.Test.FAIL: |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 234 | failed += 1 |
| 235 | else: |
| 236 | skipped += 1 |
| 237 | return (passed, skipped, failed) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 238 | |
Pau Espin Pedrol | b1526b9 | 2018-05-22 20:32:30 +0200 | [diff] [blame] | 239 | def remember_to_stop(self, process, respawn=False): |
| 240 | '''Ask suite to monitor and manage lifecycle of the Process object. If a |
| 241 | process managed by suite finishes before cleanup time, the current test |
| 242 | will be marked as FAIL and end immediatelly. If respwan=True, then suite |
| 243 | will respawn() the process instead.''' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 244 | if self._processes is None: |
| 245 | self._processes = [] |
Pau Espin Pedrol | b1526b9 | 2018-05-22 20:32:30 +0200 | [diff] [blame] | 246 | self._processes.insert(0, (process, respawn)) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 247 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 248 | def stop_processes(self): |
Pau Espin Pedrol | 1dd2955 | 2017-06-13 18:07:57 +0200 | [diff] [blame] | 249 | while self._processes: |
Pau Espin Pedrol | b1526b9 | 2018-05-22 20:32:30 +0200 | [diff] [blame] | 250 | process, respawn = self._processes.pop() |
| 251 | process.terminate() |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 252 | |
Pau Espin Pedrol | 1b28a58 | 2018-03-08 21:01:26 +0100 | [diff] [blame] | 253 | def stop_process(self, process): |
| 254 | 'Remove process from monitored list and stop it' |
Pau Espin Pedrol | b1526b9 | 2018-05-22 20:32:30 +0200 | [diff] [blame] | 255 | for proc_respawn in self._processes: |
| 256 | proc, respawn = proc_respawn |
| 257 | if proc == process: |
| 258 | self._processes.remove(proc_respawn) |
| 259 | proc.terminate() |
Pau Espin Pedrol | 1b28a58 | 2018-03-08 21:01:26 +0100 | [diff] [blame] | 260 | |
Neels Hofmeyr | ed4e528 | 2017-05-29 02:53:54 +0200 | [diff] [blame] | 261 | def free_resources(self): |
| 262 | if self.reserved_resources is None: |
| 263 | return |
| 264 | self.reserved_resources.free() |
| 265 | |
Neels Hofmeyr | b902b29 | 2017-06-06 21:52:03 +0200 | [diff] [blame] | 266 | def ip_address(self, specifics=None): |
| 267 | return self.reserved_resources.get(resource.R_IP_ADDRESS, specifics=specifics) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 268 | |
Neels Hofmeyr | 76d8103 | 2017-05-18 18:35:32 +0200 | [diff] [blame] | 269 | def nitb(self, ip_address=None): |
| 270 | if ip_address is None: |
| 271 | ip_address = self.ip_address() |
| 272 | return osmo_nitb.OsmoNitb(self, ip_address) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 273 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 274 | def hlr(self, ip_address=None): |
| 275 | if ip_address is None: |
| 276 | ip_address = self.ip_address() |
| 277 | return osmo_hlr.OsmoHlr(self, ip_address) |
| 278 | |
Pau Espin Pedrol | 30ceb5c | 2017-08-31 18:30:11 +0200 | [diff] [blame] | 279 | def ggsn(self, ip_address=None): |
| 280 | if ip_address is None: |
| 281 | ip_address = self.ip_address() |
| 282 | return osmo_ggsn.OsmoGgsn(self, ip_address) |
| 283 | |
Pau Espin Pedrol | 4796b35 | 2017-11-23 11:07:42 +0100 | [diff] [blame] | 284 | def sgsn(self, hlr, ggsn, ip_address=None): |
| 285 | if ip_address is None: |
| 286 | ip_address = self.ip_address() |
| 287 | return osmo_sgsn.OsmoSgsn(self, hlr, ggsn, ip_address) |
| 288 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 289 | def mgcpgw(self, ip_address=None, bts_ip=None): |
| 290 | if ip_address is None: |
| 291 | ip_address = self.ip_address() |
| 292 | return osmo_mgcpgw.OsmoMgcpgw(self, ip_address, bts_ip) |
| 293 | |
Pau Espin Pedrol | 386b78d | 2017-11-09 13:02:09 +0100 | [diff] [blame] | 294 | def mgw(self, ip_address=None): |
| 295 | if ip_address is None: |
| 296 | ip_address = self.ip_address() |
| 297 | return osmo_mgw.OsmoMgw(self, ip_address) |
| 298 | |
Pau Espin Pedrol | 1e1d381 | 2017-11-16 18:06:37 +0100 | [diff] [blame] | 299 | def msc(self, hlr, mgcpgw, stp, ip_address=None): |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 300 | if ip_address is None: |
| 301 | ip_address = self.ip_address() |
Pau Espin Pedrol | 1e1d381 | 2017-11-16 18:06:37 +0100 | [diff] [blame] | 302 | return osmo_msc.OsmoMsc(self, hlr, mgcpgw, stp, ip_address) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 303 | |
Pau Espin Pedrol | 1e1d381 | 2017-11-16 18:06:37 +0100 | [diff] [blame] | 304 | def bsc(self, msc, mgw, stp, ip_address=None): |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 305 | if ip_address is None: |
| 306 | ip_address = self.ip_address() |
Pau Espin Pedrol | 1e1d381 | 2017-11-16 18:06:37 +0100 | [diff] [blame] | 307 | return osmo_bsc.OsmoBsc(self, msc, mgw, stp, ip_address) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 308 | |
Neels Hofmeyr | 38b051c | 2017-06-13 16:26:06 +0200 | [diff] [blame] | 309 | def stp(self, ip_address=None): |
| 310 | if ip_address is None: |
| 311 | ip_address = self.ip_address() |
| 312 | return osmo_stp.OsmoStp(self, ip_address) |
| 313 | |
Holger Hans Peter Freyther | b484aab | 2018-08-29 04:28:33 +0100 | [diff] [blame] | 314 | def ms_driver(self): |
| 315 | ms = ms_driver.MsDriver(self) |
| 316 | self.register_for_cleanup(ms) |
| 317 | return ms |
| 318 | |
Neels Hofmeyr | b902b29 | 2017-06-06 21:52:03 +0200 | [diff] [blame] | 319 | def bts(self, specifics=None): |
Pau Espin Pedrol | 15aae98 | 2017-09-08 13:55:54 +0200 | [diff] [blame] | 320 | bts = bts_obj(self, self.reserved_resources.get(resource.R_BTS, specifics=specifics)) |
Pau Espin Pedrol | 5e0c251 | 2017-11-06 18:40:23 +0100 | [diff] [blame] | 321 | bts.set_lac(self.lac()) |
Pau Espin Pedrol | 8a3a7b5 | 2017-11-28 15:50:02 +0100 | [diff] [blame] | 322 | bts.set_rac(self.rac()) |
Pau Espin Pedrol | 4ccce7c | 2017-11-07 11:13:20 +0100 | [diff] [blame] | 323 | bts.set_cellid(self.cellid()) |
Pau Espin Pedrol | 8a3a7b5 | 2017-11-28 15:50:02 +0100 | [diff] [blame] | 324 | bts.set_bvci(self.bvci()) |
Pau Espin Pedrol | 15aae98 | 2017-09-08 13:55:54 +0200 | [diff] [blame] | 325 | self.register_for_cleanup(bts) |
| 326 | return bts |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 327 | |
Neels Hofmeyr | b902b29 | 2017-06-06 21:52:03 +0200 | [diff] [blame] | 328 | def modem(self, specifics=None): |
| 329 | conf = self.reserved_resources.get(resource.R_MODEM, specifics=specifics) |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 330 | self.dbg('create Modem object', conf=conf) |
Pau Espin Pedrol | fd4c144 | 2018-10-25 17:37:23 +0200 | [diff] [blame] | 331 | ms = modem.Modem(self, conf) |
Pau Espin Pedrol | 6cdd2fd | 2017-11-07 11:57:42 +0100 | [diff] [blame] | 332 | self.register_for_cleanup(ms) |
| 333 | return ms |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 334 | |
Neels Hofmeyr | f2d279c | 2017-05-06 15:05:02 +0200 | [diff] [blame] | 335 | def modems(self, count): |
| 336 | l = [] |
| 337 | for i in range(count): |
| 338 | l.append(self.modem()) |
| 339 | return l |
| 340 | |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 341 | def esme(self): |
| 342 | esme_obj = esme.Esme(self.msisdn()) |
Pau Espin Pedrol | ac9c1bb | 2017-08-10 10:59:40 +0200 | [diff] [blame] | 343 | self.register_for_cleanup(esme_obj) |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 344 | return esme_obj |
| 345 | |
Pau Espin Pedrol | bc1ed88 | 2018-05-17 16:59:58 +0200 | [diff] [blame] | 346 | def osmocon(self, specifics=None): |
| 347 | conf = self.reserved_resources.get(resource.R_OSMOCON, specifics=specifics) |
| 348 | osmocon_obj = osmocon.Osmocon(self, conf=conf) |
| 349 | self.register_for_cleanup(osmocon_obj) |
| 350 | return osmocon_obj |
| 351 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 352 | def iperf3srv(self, ip_address=None): |
| 353 | if ip_address is None: |
| 354 | ip_address = self.ip_address() |
| 355 | iperf3srv_obj = iperf3.IPerf3Server(self, ip_address) |
| 356 | return iperf3srv_obj |
| 357 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 358 | def msisdn(self): |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 359 | msisdn = self.resources_pool.next_msisdn(self) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 360 | self.log('using MSISDN', msisdn) |
| 361 | return msisdn |
| 362 | |
Pau Espin Pedrol | 5e0c251 | 2017-11-06 18:40:23 +0100 | [diff] [blame] | 363 | def lac(self): |
| 364 | lac = self.resources_pool.next_lac(self) |
| 365 | self.log('using LAC', lac) |
| 366 | return lac |
| 367 | |
Pau Espin Pedrol | 8a3a7b5 | 2017-11-28 15:50:02 +0100 | [diff] [blame] | 368 | def rac(self): |
| 369 | rac = self.resources_pool.next_rac(self) |
| 370 | self.log('using RAC', rac) |
| 371 | return rac |
| 372 | |
Pau Espin Pedrol | 4ccce7c | 2017-11-07 11:13:20 +0100 | [diff] [blame] | 373 | def cellid(self): |
| 374 | cellid = self.resources_pool.next_cellid(self) |
| 375 | self.log('using CellId', cellid) |
| 376 | return cellid |
| 377 | |
Pau Espin Pedrol | 8a3a7b5 | 2017-11-28 15:50:02 +0100 | [diff] [blame] | 378 | def bvci(self): |
| 379 | bvci = self.resources_pool.next_bvci(self) |
| 380 | self.log('using BVCI', bvci) |
| 381 | return bvci |
| 382 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 383 | def poll(self): |
| 384 | if self._processes: |
Pau Espin Pedrol | b1526b9 | 2018-05-22 20:32:30 +0200 | [diff] [blame] | 385 | for process, respawn in self._processes: |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 386 | if process.terminated(): |
Pau Espin Pedrol | b1526b9 | 2018-05-22 20:32:30 +0200 | [diff] [blame] | 387 | if respawn == True: |
| 388 | process.respawn() |
| 389 | else: |
| 390 | process.log_stdout_tail() |
| 391 | process.log_stderr_tail() |
| 392 | log.ctx(process) |
| 393 | raise log.Error('Process ended prematurely: %s' % process.name()) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 394 | |
| 395 | def prompt(self, *msgs, **msg_details): |
| 396 | 'ask for user interaction. Do not use in tests that should run automatically!' |
| 397 | if msg_details: |
| 398 | msgs = list(msgs) |
| 399 | msgs.append('{%s}' % |
| 400 | (', '.join(['%s=%r' % (k,v) |
| 401 | for k,v in sorted(msg_details.items())]))) |
| 402 | msg = ' '.join(msgs) or 'Hit Enter to continue' |
| 403 | self.log('prompt:', msg) |
Neels Hofmeyr | acf0c93 | 2017-05-06 16:05:33 +0200 | [diff] [blame] | 404 | sys.__stdout__.write('\n\n--- PROMPT ---\n') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 405 | sys.__stdout__.write(msg) |
Neels Hofmeyr | acf0c93 | 2017-05-06 16:05:33 +0200 | [diff] [blame] | 406 | sys.__stdout__.write('\n') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 407 | sys.__stdout__.flush() |
Pau Espin Pedrol | 9a4631c | 2018-03-28 19:17:34 +0200 | [diff] [blame] | 408 | entered = util.input_polling('> ', MainLoop.poll) |
Neels Hofmeyr | acf0c93 | 2017-05-06 16:05:33 +0200 | [diff] [blame] | 409 | self.log('prompt entered:', repr(entered)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 410 | return entered |
| 411 | |
Neels Hofmeyr | 2d1d561 | 2017-05-22 20:02:41 +0200 | [diff] [blame] | 412 | def resource_status_str(self): |
| 413 | return '\n'.join(('', |
| 414 | 'SUITE RUN: %s' % self.origin_id(), |
| 415 | 'ASKED FOR:', pprint.pformat(self._resource_requirements), |
| 416 | 'RESERVED COUNT:', pprint.pformat(self.reserved_resources.counts()), |
| 417 | 'RESOURCES STATE:', repr(self.reserved_resources))) |
| 418 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 419 | loaded_suite_definitions = {} |
| 420 | |
| 421 | def load(suite_name): |
| 422 | global loaded_suite_definitions |
| 423 | |
| 424 | suite = loaded_suite_definitions.get(suite_name) |
| 425 | if suite is not None: |
| 426 | return suite |
| 427 | |
| 428 | suites_dir = config.get_suites_dir() |
| 429 | suite_dir = suites_dir.child(suite_name) |
| 430 | if not suites_dir.exists(suite_name): |
| 431 | raise RuntimeError('Suite not found: %r in %r' % (suite_name, suites_dir)) |
| 432 | if not suites_dir.isdir(suite_name): |
| 433 | raise RuntimeError('Suite name found, but not a directory: %r' % (suite_dir)) |
| 434 | |
| 435 | suite_def = SuiteDefinition(suite_dir) |
| 436 | loaded_suite_definitions[suite_name] = suite_def |
| 437 | return suite_def |
| 438 | |
| 439 | def parse_suite_scenario_str(suite_scenario_str): |
| 440 | tokens = suite_scenario_str.split(':') |
| 441 | if len(tokens) > 2: |
| 442 | raise RuntimeError('invalid combination string: %r' % suite_scenario_str) |
| 443 | |
| 444 | suite_name = tokens[0] |
| 445 | if len(tokens) <= 1: |
| 446 | scenario_names = [] |
| 447 | else: |
| 448 | scenario_names = tokens[1].split('+') |
| 449 | |
| 450 | return suite_name, scenario_names |
| 451 | |
| 452 | def load_suite_scenario_str(suite_scenario_str): |
| 453 | suite_name, scenario_names = parse_suite_scenario_str(suite_scenario_str) |
| 454 | suite = load(suite_name) |
Pau Espin Pedrol | 0b30279 | 2017-09-10 16:33:10 +0200 | [diff] [blame] | 455 | scenarios = [config.get_scenario(scenario_name, resource.CONF_SCHEMA) for scenario_name in scenario_names] |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 456 | return (suite_scenario_str, suite, scenarios) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 457 | |
| 458 | def bts_obj(suite_run, conf): |
| 459 | bts_type = conf.get('type') |
Neels Hofmeyr | d28d1a7 | 2017-06-14 02:59:55 +0200 | [diff] [blame] | 460 | log.dbg('create BTS object', type=bts_type) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 461 | bts_class = resource.KNOWN_BTS_TYPES.get(bts_type) |
| 462 | if bts_class is None: |
| 463 | raise RuntimeError('No such BTS type is defined: %r' % bts_type) |
| 464 | return bts_class(suite_run, conf) |
| 465 | |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 466 | # vim: expandtab tabstop=4 shiftwidth=4 |