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