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 |
| 8 | # it under the terms of the GNU Affero General Public License as |
| 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 |
| 15 | # GNU Affero General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU Affero General Public License |
| 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 |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 23 | import copy |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 24 | from . import config, log, template, util, resource, schema, ofono_client, osmo_nitb |
| 25 | from . import test |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 26 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 27 | class SuiteDefinition(log.Origin): |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 28 | '''A test suite reserves resources for a number of tests. |
| 29 | Each test requires a specific number of modems, BTSs etc., which are |
| 30 | reserved beforehand by a test suite. This way several test suites can be |
| 31 | scheduled dynamically without resource conflicts arising halfway through |
| 32 | the tests.''' |
| 33 | |
| 34 | CONF_FILENAME = 'suite.conf' |
| 35 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 36 | CONF_SCHEMA = util.dict_add( |
| 37 | { |
| 38 | 'defaults.timeout': schema.STR, |
| 39 | }, |
| 40 | dict([('resources.%s' % k, t) for k,t in resource.WANT_SCHEMA.items()]) |
| 41 | ) |
| 42 | |
| 43 | |
| 44 | def __init__(self, suite_dir): |
| 45 | self.set_log_category(log.C_CNF) |
| 46 | self.suite_dir = suite_dir |
| 47 | self.set_name(os.path.basename(self.suite_dir)) |
| 48 | self.read_conf() |
| 49 | |
| 50 | def read_conf(self): |
| 51 | with self: |
| 52 | self.dbg('reading %s' % SuiteDefinition.CONF_FILENAME) |
| 53 | if not os.path.isdir(self.suite_dir): |
| 54 | raise RuntimeError('No such directory: %r' % self.suite_dir) |
| 55 | self.conf = config.read(os.path.join(self.suite_dir, |
| 56 | SuiteDefinition.CONF_FILENAME), |
| 57 | SuiteDefinition.CONF_SCHEMA) |
| 58 | self.load_tests() |
| 59 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 60 | def load_tests(self): |
| 61 | with self: |
| 62 | self.tests = [] |
| 63 | for basename in sorted(os.listdir(self.suite_dir)): |
| 64 | if not basename.endswith('.py'): |
| 65 | continue |
| 66 | self.tests.append(Test(self, basename)) |
| 67 | |
| 68 | def add_test(self, test): |
| 69 | with self: |
| 70 | if not isinstance(test, Test): |
| 71 | raise ValueError('add_test(): pass a Test() instance, not %s' % type(test)) |
| 72 | if test.suite is None: |
| 73 | test.suite = self |
| 74 | if test.suite is not self: |
| 75 | raise ValueError('add_test(): test already belongs to another suite') |
| 76 | self.tests.append(test) |
| 77 | |
| 78 | |
| 79 | |
| 80 | class Test(log.Origin): |
| 81 | |
| 82 | def __init__(self, suite, test_basename): |
| 83 | self.suite = suite |
| 84 | self.basename = test_basename |
| 85 | self.path = os.path.join(self.suite.suite_dir, self.basename) |
| 86 | super().__init__(self.path) |
| 87 | self.set_name(self.basename) |
| 88 | self.set_log_category(log.C_TST) |
| 89 | |
| 90 | def run(self, suite_run): |
| 91 | assert self.suite is suite_run.definition |
| 92 | with self: |
| 93 | test.setup(suite_run, self, ofono_client) |
| 94 | success = False |
| 95 | try: |
| 96 | self.log('START') |
| 97 | with self.redirect_stdout(): |
| 98 | util.run_python_file('%s.%s' % (self.suite.name(), self.name()), |
| 99 | self.path) |
| 100 | success = True |
| 101 | except resource.NoResourceExn: |
Neels Hofmeyr | c86ab21 | 2017-05-06 22:51:29 +0200 | [diff] [blame] | 102 | self.err('Current resource state:\n', repr(suite_run.reserved_resources)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 103 | raise |
| 104 | finally: |
| 105 | if success: |
| 106 | self.log('PASS') |
| 107 | else: |
| 108 | self.log('FAIL') |
| 109 | |
| 110 | def name(self): |
| 111 | l = log.get_line_for_src(self.path) |
| 112 | if l is not None: |
| 113 | return '%s:%s' % (self._name, l) |
| 114 | return super().name() |
| 115 | |
| 116 | class SuiteRun(log.Origin): |
| 117 | |
| 118 | trial = None |
| 119 | resources_pool = None |
| 120 | reserved_resources = None |
| 121 | _resource_requirements = None |
| 122 | _config = None |
| 123 | _processes = None |
| 124 | |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 125 | def __init__(self, current_trial, suite_scenario_str, suite_definition, scenarios=[]): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 126 | self.trial = current_trial |
| 127 | self.definition = suite_definition |
| 128 | self.scenarios = scenarios |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 129 | self.set_name(suite_scenario_str) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 130 | self.set_log_category(log.C_TST) |
| 131 | self.resources_pool = resource.ResourcesPool() |
| 132 | |
| 133 | def combined(self, conf_name): |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 134 | self.dbg(combining=conf_name) |
| 135 | with log.Origin(combining_scenarios=conf_name): |
| 136 | combination = copy.deepcopy(self.definition.conf.get(conf_name) or {}) |
| 137 | self.dbg(definition_conf=combination) |
| 138 | for scenario in self.scenarios: |
| 139 | with scenario: |
| 140 | c = scenario.get(conf_name) |
| 141 | self.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 | |
| 147 | def resource_requirements(self): |
| 148 | if self._resource_requirements is None: |
| 149 | self._resource_requirements = self.combined('resources') |
| 150 | return self._resource_requirements |
| 151 | |
| 152 | def config(self): |
| 153 | if self._config is None: |
| 154 | self._config = self.combined('config') |
| 155 | return self._config |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 156 | |
| 157 | class Results: |
| 158 | def __init__(self): |
| 159 | self.passed = [] |
| 160 | self.failed = [] |
| 161 | self.all_passed = None |
| 162 | |
| 163 | def add_pass(self, test): |
| 164 | self.passed.append(test) |
| 165 | |
| 166 | def add_fail(self, test): |
| 167 | self.failed.append(test) |
| 168 | |
| 169 | def conclude(self): |
| 170 | self.all_passed = bool(self.passed) and not bool(self.failed) |
| 171 | return self |
| 172 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 173 | def __str__(self): |
| 174 | if self.failed: |
| 175 | return 'FAIL: %d of %d tests failed:\n %s' % ( |
| 176 | len(self.failed), |
| 177 | len(self.failed) + len(self.passed), |
| 178 | '\n '.join([t.name() for t in self.failed])) |
| 179 | if not self.passed: |
| 180 | return 'no tests were run.' |
| 181 | return 'pass: all %d tests passed.' % len(self.passed) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 182 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 183 | def reserve_resources(self): |
| 184 | if self.reserved_resources: |
| 185 | raise RuntimeError('Attempt to reserve resources twice for a SuiteRun') |
| 186 | self.log('reserving resources...') |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 187 | with self: |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 188 | self.reserved_resources = self.resources_pool.reserve(self, self.resource_requirements()) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 189 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 190 | def run_tests(self, names=None): |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 191 | self.log('Suite run start') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 192 | if not self.reserved_resources: |
| 193 | self.reserve_resources() |
| 194 | results = SuiteRun.Results() |
| 195 | for test in self.definition.tests: |
| 196 | if names and not test.name() in names: |
| 197 | continue |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 198 | self._run_test(test, results) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 199 | self.stop_processes() |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 200 | return results.conclude() |
| 201 | |
| 202 | def _run_test(self, test, results): |
| 203 | try: |
| 204 | with self: |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 205 | test.run(self) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 206 | results.add_pass(test) |
| 207 | except: |
| 208 | results.add_fail(test) |
| 209 | self.log_exn() |
| 210 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 211 | def remember_to_stop(self, process): |
| 212 | if self._processes is None: |
| 213 | self._processes = [] |
| 214 | self._processes.append(process) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 215 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 216 | def stop_processes(self): |
| 217 | if not self._processes: |
| 218 | return |
| 219 | for process in self._processes: |
| 220 | process.terminate() |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 221 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 222 | def nitb_iface(self): |
| 223 | return self.reserved_resources.get(resource.R_NITB_IFACE) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 224 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 225 | def nitb(self, nitb_iface=None): |
| 226 | if nitb_iface is None: |
| 227 | nitb_iface = self.nitb_iface() |
| 228 | return osmo_nitb.OsmoNitb(self, nitb_iface) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 229 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 230 | def bts(self): |
| 231 | return bts_obj(self, self.reserved_resources.get(resource.R_BTS)) |
| 232 | |
| 233 | def modem(self): |
| 234 | return modem_obj(self.reserved_resources.get(resource.R_MODEM)) |
| 235 | |
| 236 | def msisdn(self): |
| 237 | msisdn = self.resources_pool.next_msisdn(self.origin) |
| 238 | self.log('using MSISDN', msisdn) |
| 239 | return msisdn |
| 240 | |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 241 | def _wait(self, condition, condition_args, condition_kwargs, timeout, timestep): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 242 | if not timeout or timeout < 0: |
| 243 | raise RuntimeError('wait() *must* time out at some point. timeout=%r' % timeout) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 244 | if timestep < 0.1: |
| 245 | timestep = 0.1 |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 246 | |
| 247 | started = time.time() |
| 248 | while True: |
| 249 | self.poll() |
| 250 | if condition(*condition_args, **condition_kwargs): |
| 251 | return True |
| 252 | waited = time.time() - started |
| 253 | if waited > timeout: |
| 254 | return False |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 255 | time.sleep(timestep) |
| 256 | |
| 257 | def wait(self, condition, *condition_args, timeout=300, timestep=1, **condition_kwargs): |
| 258 | if not self._wait(condition, condition_args, condition_kwargs, timeout, timestep): |
| 259 | raise RuntimeError('Timeout expired') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 260 | |
| 261 | def sleep(self, seconds): |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 262 | assert seconds > 0. |
| 263 | self._wait(lambda: False, [], {}, timeout=seconds, timestep=min(seconds, 1)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 264 | |
| 265 | def poll(self): |
Neels Hofmeyr | 85eb324 | 2017-04-09 22:01:16 +0200 | [diff] [blame] | 266 | ofono_client.poll() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 267 | if self._processes: |
| 268 | for process in self._processes: |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 269 | if process.terminated(): |
Neels Hofmeyr | 85eb324 | 2017-04-09 22:01:16 +0200 | [diff] [blame] | 270 | process.log_stdout_tail() |
| 271 | process.log_stderr_tail() |
| 272 | process.raise_exn('Process ended prematurely') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 273 | |
| 274 | def prompt(self, *msgs, **msg_details): |
| 275 | 'ask for user interaction. Do not use in tests that should run automatically!' |
| 276 | if msg_details: |
| 277 | msgs = list(msgs) |
| 278 | msgs.append('{%s}' % |
| 279 | (', '.join(['%s=%r' % (k,v) |
| 280 | for k,v in sorted(msg_details.items())]))) |
| 281 | msg = ' '.join(msgs) or 'Hit Enter to continue' |
| 282 | self.log('prompt:', msg) |
| 283 | sys.__stdout__.write(msg) |
| 284 | sys.__stdout__.write('\n> ') |
| 285 | sys.__stdout__.flush() |
| 286 | entered = util.input_polling(self.poll) |
| 287 | self.log('prompt entered:', entered) |
| 288 | return entered |
| 289 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 290 | loaded_suite_definitions = {} |
| 291 | |
| 292 | def load(suite_name): |
| 293 | global loaded_suite_definitions |
| 294 | |
| 295 | suite = loaded_suite_definitions.get(suite_name) |
| 296 | if suite is not None: |
| 297 | return suite |
| 298 | |
| 299 | suites_dir = config.get_suites_dir() |
| 300 | suite_dir = suites_dir.child(suite_name) |
| 301 | if not suites_dir.exists(suite_name): |
| 302 | raise RuntimeError('Suite not found: %r in %r' % (suite_name, suites_dir)) |
| 303 | if not suites_dir.isdir(suite_name): |
| 304 | raise RuntimeError('Suite name found, but not a directory: %r' % (suite_dir)) |
| 305 | |
| 306 | suite_def = SuiteDefinition(suite_dir) |
| 307 | loaded_suite_definitions[suite_name] = suite_def |
| 308 | return suite_def |
| 309 | |
| 310 | def parse_suite_scenario_str(suite_scenario_str): |
| 311 | tokens = suite_scenario_str.split(':') |
| 312 | if len(tokens) > 2: |
| 313 | raise RuntimeError('invalid combination string: %r' % suite_scenario_str) |
| 314 | |
| 315 | suite_name = tokens[0] |
| 316 | if len(tokens) <= 1: |
| 317 | scenario_names = [] |
| 318 | else: |
| 319 | scenario_names = tokens[1].split('+') |
| 320 | |
| 321 | return suite_name, scenario_names |
| 322 | |
| 323 | def load_suite_scenario_str(suite_scenario_str): |
| 324 | suite_name, scenario_names = parse_suite_scenario_str(suite_scenario_str) |
| 325 | suite = load(suite_name) |
| 326 | scenarios = [config.get_scenario(scenario_name) for scenario_name in scenario_names] |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 327 | return (suite_scenario_str, suite, scenarios) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 328 | |
| 329 | def bts_obj(suite_run, conf): |
| 330 | bts_type = conf.get('type') |
| 331 | log.dbg(None, None, 'create BTS object', type=bts_type) |
| 332 | bts_class = resource.KNOWN_BTS_TYPES.get(bts_type) |
| 333 | if bts_class is None: |
| 334 | raise RuntimeError('No such BTS type is defined: %r' % bts_type) |
| 335 | return bts_class(suite_run, conf) |
| 336 | |
| 337 | def modem_obj(conf): |
| 338 | log.dbg(None, None, 'create Modem object', conf=conf) |
| 339 | return ofono_client.Modem(conf) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 340 | |
| 341 | # vim: expandtab tabstop=4 shiftwidth=4 |