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 |
Your Name | 44af341 | 2017-04-13 03:11:59 +0200 | [diff] [blame] | 23 | import copy |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 24 | import traceback |
Neels Hofmeyr | 2d1d561 | 2017-05-22 20:02:41 +0200 | [diff] [blame] | 25 | import pprint |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 26 | from . import config, log, template, util, resource, schema, ofono_client, event_loop, esme, sms |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 27 | from . import osmo_nitb |
Neels Hofmeyr | 38b051c | 2017-06-13 16:26:06 +0200 | [diff] [blame] | 28 | from . import osmo_hlr, osmo_mgcpgw, osmo_msc, osmo_bsc, osmo_stp |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 29 | from . import test |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 30 | |
Neels Hofmeyr | 1ffc3fe | 2017-05-07 02:15:21 +0200 | [diff] [blame] | 31 | class Timeout(Exception): |
| 32 | pass |
| 33 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 34 | class SuiteDefinition(log.Origin): |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 35 | '''A test suite reserves resources for a number of tests. |
| 36 | Each test requires a specific number of modems, BTSs etc., which are |
| 37 | reserved beforehand by a test suite. This way several test suites can be |
| 38 | scheduled dynamically without resource conflicts arising halfway through |
| 39 | the tests.''' |
| 40 | |
| 41 | CONF_FILENAME = 'suite.conf' |
| 42 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 43 | def __init__(self, suite_dir): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 44 | self.suite_dir = suite_dir |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 45 | super().__init__(log.C_CNF, os.path.basename(self.suite_dir)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 46 | self.read_conf() |
| 47 | |
| 48 | def read_conf(self): |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 49 | self.dbg('reading %s' % SuiteDefinition.CONF_FILENAME) |
| 50 | if not os.path.isdir(self.suite_dir): |
| 51 | raise RuntimeError('No such directory: %r' % self.suite_dir) |
| 52 | self.conf = config.read(os.path.join(self.suite_dir, |
| 53 | SuiteDefinition.CONF_FILENAME), |
Pau Espin Pedrol | 0b30279 | 2017-09-10 16:33:10 +0200 | [diff] [blame] | 54 | resource.CONF_SCHEMA) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 55 | self.load_test_basenames() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 56 | |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 57 | def load_test_basenames(self): |
| 58 | self.test_basenames = [] |
| 59 | for basename in sorted(os.listdir(self.suite_dir)): |
| 60 | if not basename.endswith('.py'): |
| 61 | continue |
| 62 | self.test_basenames.append(basename) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 63 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 64 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 65 | class Test(log.Origin): |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 66 | UNKNOWN = 'UNKNOWN' |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 67 | SKIP = 'skip' |
| 68 | PASS = 'pass' |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 69 | FAIL = 'FAIL' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 70 | |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 71 | _run_dir = None |
| 72 | |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 73 | def __init__(self, suite_run, test_basename): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 74 | self.basename = test_basename |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 75 | super().__init__(log.C_TST, self.basename) |
| 76 | self.suite_run = suite_run |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 77 | self.path = os.path.join(self.suite_run.definition.suite_dir, self.basename) |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 78 | self.status = Test.UNKNOWN |
| 79 | self.start_timestamp = 0 |
| 80 | self.duration = 0 |
| 81 | self.fail_type = None |
| 82 | self.fail_message = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 83 | |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 84 | def get_run_dir(self): |
| 85 | if self._run_dir is None: |
| 86 | self._run_dir = util.Dir(self.suite_run.get_run_dir().new_dir(self._name)) |
| 87 | return self._run_dir |
| 88 | |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 89 | def run(self): |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 90 | try: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 91 | log.large_separator(self.suite_run.trial.name(), self.suite_run.name(), self.name(), sublevel=3) |
| 92 | self.status = Test.UNKNOWN |
| 93 | self.start_timestamp = time.time() |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 94 | test.setup(self.suite_run, self, ofono_client, sys.modules[__name__], event_loop, sms) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 95 | with self.redirect_stdout(): |
| 96 | util.run_python_file('%s.%s' % (self.suite_run.definition.name(), self.basename), |
| 97 | self.path) |
| 98 | if self.status == Test.UNKNOWN: |
| 99 | self.set_pass() |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 100 | except Exception as e: |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 101 | if hasattr(e, 'msg'): |
| 102 | msg = e.msg |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 103 | else: |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 104 | msg = str(e) |
| 105 | if isinstance(e, AssertionError): |
| 106 | # AssertionError lacks further information on what was |
| 107 | # asserted. Find the line where the code asserted: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 108 | msg += log.get_src_from_exc_info(sys.exc_info()) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 109 | # add source file information to failure report |
| 110 | if hasattr(e, 'origins'): |
| 111 | msg += ' [%s]' % e.origins |
| 112 | tb_str = traceback.format_exc() |
| 113 | if isinstance(e, resource.NoResourceExn): |
| 114 | tb_str += self.suite_run.resource_status_str() |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 115 | self.set_fail(type(e).__name__, msg, tb_str, log.get_src_from_exc_info()) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 116 | except BaseException as e: |
| 117 | # when the program is aborted by a signal (like Ctrl-C), escalate to abort all. |
| 118 | self.err('TEST RUN ABORTED: %s' % type(e).__name__) |
| 119 | raise |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 120 | |
| 121 | def name(self): |
| 122 | l = log.get_line_for_src(self.path) |
| 123 | if l is not None: |
| 124 | return '%s:%s' % (self._name, l) |
| 125 | return super().name() |
| 126 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 127 | def set_fail(self, fail_type, fail_message, tb_str=None, src=4): |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 128 | self.status = Test.FAIL |
| 129 | self.duration = time.time() - self.start_timestamp |
| 130 | self.fail_type = fail_type |
| 131 | self.fail_message = fail_message |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 132 | |
| 133 | if tb_str is None: |
| 134 | # populate an exception-less call to set_fail() with traceback info |
| 135 | tb_str = ''.join(traceback.format_stack()[:-1]) |
| 136 | |
| 137 | self.fail_tb = tb_str |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 138 | self.err('%s: %s' % (self.fail_type, self.fail_message), _src=src) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 139 | if self.fail_tb: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 140 | self.log(self.fail_tb, _level=log.L_TRACEBACK) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 141 | self.log('Test FAILED (%.1f sec)' % self.duration) |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 142 | |
| 143 | def set_pass(self): |
| 144 | self.status = Test.PASS |
| 145 | self.duration = time.time() - self.start_timestamp |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 146 | self.log('Test passed (%.1f sec)' % self.duration) |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 147 | |
| 148 | def set_skip(self): |
| 149 | self.status = Test.SKIP |
| 150 | self.duration = 0 |
| 151 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 152 | class SuiteRun(log.Origin): |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 153 | UNKNOWN = 'UNKNOWN' |
| 154 | PASS = 'PASS' |
| 155 | FAIL = 'FAIL' |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 156 | |
| 157 | trial = None |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 158 | status = None |
Neels Hofmeyr | f8e6186 | 2017-06-06 23:08:07 +0200 | [diff] [blame] | 159 | start_timestamp = None |
| 160 | duration = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 161 | resources_pool = None |
| 162 | reserved_resources = None |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 163 | objects_to_clean_up = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 164 | _resource_requirements = None |
| 165 | _config = None |
| 166 | _processes = None |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 167 | _run_dir = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 168 | |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 169 | def __init__(self, trial, suite_scenario_str, suite_definition, scenarios=[]): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 170 | super().__init__(log.C_TST, suite_scenario_str) |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 171 | self.trial = trial |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 172 | self.definition = suite_definition |
| 173 | self.scenarios = scenarios |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 174 | self.resources_pool = resource.ResourcesPool() |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 175 | self.status = SuiteRun.UNKNOWN |
| 176 | self.load_tests() |
| 177 | |
| 178 | def load_tests(self): |
| 179 | self.tests = [] |
| 180 | for test_basename in self.definition.test_basenames: |
| 181 | self.tests.append(Test(self, test_basename)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 182 | |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 183 | def register_for_cleanup(self, *obj): |
| 184 | assert all([hasattr(o, 'cleanup') for o in obj]) |
| 185 | self.objects_to_clean_up = self.objects_to_clean_up or [] |
| 186 | self.objects_to_clean_up.extend(obj) |
| 187 | |
| 188 | def objects_cleanup(self): |
| 189 | while self.objects_to_clean_up: |
| 190 | obj = self.objects_to_clean_up.pop() |
Pau Espin Pedrol | 6100b62 | 2017-07-31 18:19:06 +0200 | [diff] [blame] | 191 | try: |
| 192 | obj.cleanup() |
| 193 | except Exception: |
| 194 | log.log_exn() |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 195 | |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 196 | def mark_start(self): |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 197 | self.start_timestamp = time.time() |
| 198 | self.duration = 0 |
Pau Espin Pedrol | 0ffb414 | 2017-05-15 18:24:35 +0200 | [diff] [blame] | 199 | self.status = SuiteRun.UNKNOWN |
| 200 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 201 | def combined(self, conf_name): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 202 | log.dbg(combining=conf_name) |
| 203 | log.ctx(combining_scenarios=conf_name) |
Pau Espin Pedrol | 0b30279 | 2017-09-10 16:33:10 +0200 | [diff] [blame] | 204 | combination = config.replicate_times(self.definition.conf.get(conf_name, {})) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 205 | log.dbg(definition_conf=combination) |
| 206 | for scenario in self.scenarios: |
| 207 | log.ctx(combining_scenarios=conf_name, scenario=scenario.name()) |
Pau Espin Pedrol | 0b30279 | 2017-09-10 16:33:10 +0200 | [diff] [blame] | 208 | c = config.replicate_times(scenario.get(conf_name, {})) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 209 | log.dbg(scenario=scenario.name(), conf=c) |
| 210 | if c is None: |
| 211 | continue |
| 212 | config.combine(combination, c) |
| 213 | return combination |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 214 | |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 215 | def get_run_dir(self): |
| 216 | if self._run_dir is None: |
| 217 | self._run_dir = util.Dir(self.trial.get_run_dir().new_dir(self.name())) |
| 218 | return self._run_dir |
| 219 | |
| 220 | def get_test_run_dir(self): |
| 221 | if self.current_test: |
| 222 | return self.current_test.get_run_dir() |
| 223 | return self.get_run_dir() |
| 224 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 225 | def resource_requirements(self): |
| 226 | if self._resource_requirements is None: |
| 227 | self._resource_requirements = self.combined('resources') |
| 228 | return self._resource_requirements |
| 229 | |
| 230 | def config(self): |
| 231 | if self._config is None: |
| 232 | self._config = self.combined('config') |
| 233 | return self._config |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 234 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 235 | def reserve_resources(self): |
| 236 | if self.reserved_resources: |
| 237 | raise RuntimeError('Attempt to reserve resources twice for a SuiteRun') |
Neels Hofmeyr | 7e2e8f1 | 2017-05-14 03:37:13 +0200 | [diff] [blame] | 238 | self.log('reserving resources in', self.resources_pool.state_dir, '...') |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 239 | self.reserved_resources = self.resources_pool.reserve(self, self.resource_requirements()) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 240 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 241 | def run_tests(self, names=None): |
Pau Espin Pedrol | 469316f | 2017-05-17 14:51:31 +0200 | [diff] [blame] | 242 | try: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 243 | log.large_separator(self.trial.name(), self.name(), sublevel=2) |
| 244 | self.mark_start() |
| 245 | event_loop.register_poll_func(self.poll) |
| 246 | if not self.reserved_resources: |
| 247 | self.reserve_resources() |
| 248 | for test in self.tests: |
| 249 | if names and not test.name() in names: |
| 250 | test.set_skip() |
| 251 | continue |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 252 | self.current_test = test |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 253 | test.run() |
Pau Espin Pedrol | 1dd2955 | 2017-06-13 18:07:57 +0200 | [diff] [blame] | 254 | self.stop_processes() |
| 255 | self.objects_cleanup() |
| 256 | self.reserved_resources.put_all() |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 257 | except Exception: |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 258 | log.log_exn() |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 259 | except BaseException as e: |
| 260 | # when the program is aborted by a signal (like Ctrl-C), escalate to abort all. |
| 261 | self.err('SUITE RUN ABORTED: %s' % type(e).__name__) |
| 262 | raise |
Pau Espin Pedrol | 469316f | 2017-05-17 14:51:31 +0200 | [diff] [blame] | 263 | finally: |
| 264 | # if sys.exit() called from signal handler (e.g. SIGINT), SystemExit |
| 265 | # base exception is raised. Make sure to stop processes in this |
| 266 | # finally section. Resources are automatically freed with 'atexit'. |
| 267 | self.stop_processes() |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 268 | self.objects_cleanup() |
Neels Hofmeyr | ed4e528 | 2017-05-29 02:53:54 +0200 | [diff] [blame] | 269 | self.free_resources() |
Neels Hofmeyr | 6ccda11 | 2017-06-06 19:41:17 +0200 | [diff] [blame] | 270 | event_loop.unregister_poll_func(self.poll) |
| 271 | self.duration = time.time() - self.start_timestamp |
| 272 | |
| 273 | passed, skipped, failed = self.count_test_results() |
| 274 | # if no tests ran, count it as failure |
| 275 | if passed and not failed: |
| 276 | self.status = SuiteRun.PASS |
| 277 | else: |
| 278 | self.status = SuiteRun.FAIL |
| 279 | |
| 280 | log.large_separator(self.trial.name(), self.name(), self.status, sublevel=2, space_above=False) |
| 281 | |
| 282 | def passed(self): |
| 283 | return self.status == SuiteRun.PASS |
| 284 | |
| 285 | def count_test_results(self): |
| 286 | passed = 0 |
| 287 | skipped = 0 |
| 288 | failed = 0 |
| 289 | for test in self.tests: |
| 290 | if test.status == Test.PASS: |
| 291 | passed += 1 |
| 292 | elif test.status == Test.FAIL: |
| 293 | failed += 1 |
| 294 | else: |
| 295 | skipped += 1 |
| 296 | return (passed, skipped, failed) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 297 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 298 | def remember_to_stop(self, process): |
| 299 | if self._processes is None: |
| 300 | self._processes = [] |
Pau Espin Pedrol | ecf1079 | 2017-05-08 16:56:38 +0200 | [diff] [blame] | 301 | self._processes.insert(0, process) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 302 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 303 | def stop_processes(self): |
Pau Espin Pedrol | 1dd2955 | 2017-06-13 18:07:57 +0200 | [diff] [blame] | 304 | while self._processes: |
| 305 | self._processes.pop().terminate() |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 306 | |
Neels Hofmeyr | ed4e528 | 2017-05-29 02:53:54 +0200 | [diff] [blame] | 307 | def free_resources(self): |
| 308 | if self.reserved_resources is None: |
| 309 | return |
| 310 | self.reserved_resources.free() |
| 311 | |
Neels Hofmeyr | b902b29 | 2017-06-06 21:52:03 +0200 | [diff] [blame] | 312 | def ip_address(self, specifics=None): |
| 313 | return self.reserved_resources.get(resource.R_IP_ADDRESS, specifics=specifics) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 314 | |
Neels Hofmeyr | 76d8103 | 2017-05-18 18:35:32 +0200 | [diff] [blame] | 315 | def nitb(self, ip_address=None): |
| 316 | if ip_address is None: |
| 317 | ip_address = self.ip_address() |
| 318 | return osmo_nitb.OsmoNitb(self, ip_address) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 319 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 320 | def hlr(self, ip_address=None): |
| 321 | if ip_address is None: |
| 322 | ip_address = self.ip_address() |
| 323 | return osmo_hlr.OsmoHlr(self, ip_address) |
| 324 | |
| 325 | def mgcpgw(self, ip_address=None, bts_ip=None): |
| 326 | if ip_address is None: |
| 327 | ip_address = self.ip_address() |
| 328 | return osmo_mgcpgw.OsmoMgcpgw(self, ip_address, bts_ip) |
| 329 | |
| 330 | def msc(self, hlr, mgcpgw, ip_address=None): |
| 331 | if ip_address is None: |
| 332 | ip_address = self.ip_address() |
| 333 | return osmo_msc.OsmoMsc(self, hlr, mgcpgw, ip_address) |
| 334 | |
| 335 | def bsc(self, msc, ip_address=None): |
| 336 | if ip_address is None: |
| 337 | ip_address = self.ip_address() |
| 338 | return osmo_bsc.OsmoBsc(self, msc, ip_address) |
| 339 | |
Neels Hofmeyr | 38b051c | 2017-06-13 16:26:06 +0200 | [diff] [blame] | 340 | def stp(self, ip_address=None): |
| 341 | if ip_address is None: |
| 342 | ip_address = self.ip_address() |
| 343 | return osmo_stp.OsmoStp(self, ip_address) |
| 344 | |
Neels Hofmeyr | b902b29 | 2017-06-06 21:52:03 +0200 | [diff] [blame] | 345 | def bts(self, specifics=None): |
Pau Espin Pedrol | 15aae98 | 2017-09-08 13:55:54 +0200 | [diff] [blame] | 346 | bts = bts_obj(self, self.reserved_resources.get(resource.R_BTS, specifics=specifics)) |
| 347 | self.register_for_cleanup(bts) |
| 348 | return bts |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 349 | |
Neels Hofmeyr | b902b29 | 2017-06-06 21:52:03 +0200 | [diff] [blame] | 350 | def modem(self, specifics=None): |
| 351 | conf = self.reserved_resources.get(resource.R_MODEM, specifics=specifics) |
Neels Hofmeyr | 4d688c2 | 2017-05-29 04:13:58 +0200 | [diff] [blame] | 352 | self.dbg('create Modem object', conf=conf) |
| 353 | modem = ofono_client.Modem(conf) |
| 354 | self.register_for_cleanup(modem) |
| 355 | return modem |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 356 | |
Neels Hofmeyr | f2d279c | 2017-05-06 15:05:02 +0200 | [diff] [blame] | 357 | def modems(self, count): |
| 358 | l = [] |
| 359 | for i in range(count): |
| 360 | l.append(self.modem()) |
| 361 | return l |
| 362 | |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 363 | def esme(self): |
| 364 | esme_obj = esme.Esme(self.msisdn()) |
Pau Espin Pedrol | ac9c1bb | 2017-08-10 10:59:40 +0200 | [diff] [blame] | 365 | self.register_for_cleanup(esme_obj) |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 366 | return esme_obj |
| 367 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 368 | def msisdn(self): |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 369 | msisdn = self.resources_pool.next_msisdn(self) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 370 | self.log('using MSISDN', msisdn) |
| 371 | return msisdn |
| 372 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 373 | def poll(self): |
| 374 | if self._processes: |
| 375 | for process in self._processes: |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 376 | if process.terminated(): |
Neels Hofmeyr | 85eb324 | 2017-04-09 22:01:16 +0200 | [diff] [blame] | 377 | process.log_stdout_tail() |
| 378 | process.log_stderr_tail() |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 379 | log.ctx(process) |
Pau Espin Pedrol | 800a697 | 2017-07-03 18:34:09 +0200 | [diff] [blame] | 380 | raise log.Error('Process ended prematurely: %s' % process.name()) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 381 | |
| 382 | def prompt(self, *msgs, **msg_details): |
| 383 | 'ask for user interaction. Do not use in tests that should run automatically!' |
| 384 | if msg_details: |
| 385 | msgs = list(msgs) |
| 386 | msgs.append('{%s}' % |
| 387 | (', '.join(['%s=%r' % (k,v) |
| 388 | for k,v in sorted(msg_details.items())]))) |
| 389 | msg = ' '.join(msgs) or 'Hit Enter to continue' |
| 390 | self.log('prompt:', msg) |
Neels Hofmeyr | acf0c93 | 2017-05-06 16:05:33 +0200 | [diff] [blame] | 391 | sys.__stdout__.write('\n\n--- PROMPT ---\n') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 392 | sys.__stdout__.write(msg) |
Neels Hofmeyr | acf0c93 | 2017-05-06 16:05:33 +0200 | [diff] [blame] | 393 | sys.__stdout__.write('\n') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 394 | sys.__stdout__.flush() |
Pau Espin Pedrol | 90c23cc | 2017-07-03 13:12:37 +0200 | [diff] [blame] | 395 | entered = util.input_polling('> ', event_loop.poll) |
Neels Hofmeyr | acf0c93 | 2017-05-06 16:05:33 +0200 | [diff] [blame] | 396 | self.log('prompt entered:', repr(entered)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 397 | return entered |
| 398 | |
Neels Hofmeyr | 2d1d561 | 2017-05-22 20:02:41 +0200 | [diff] [blame] | 399 | def resource_status_str(self): |
| 400 | return '\n'.join(('', |
| 401 | 'SUITE RUN: %s' % self.origin_id(), |
| 402 | 'ASKED FOR:', pprint.pformat(self._resource_requirements), |
| 403 | 'RESERVED COUNT:', pprint.pformat(self.reserved_resources.counts()), |
| 404 | 'RESOURCES STATE:', repr(self.reserved_resources))) |
| 405 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 406 | loaded_suite_definitions = {} |
| 407 | |
| 408 | def load(suite_name): |
| 409 | global loaded_suite_definitions |
| 410 | |
| 411 | suite = loaded_suite_definitions.get(suite_name) |
| 412 | if suite is not None: |
| 413 | return suite |
| 414 | |
| 415 | suites_dir = config.get_suites_dir() |
| 416 | suite_dir = suites_dir.child(suite_name) |
| 417 | if not suites_dir.exists(suite_name): |
| 418 | raise RuntimeError('Suite not found: %r in %r' % (suite_name, suites_dir)) |
| 419 | if not suites_dir.isdir(suite_name): |
| 420 | raise RuntimeError('Suite name found, but not a directory: %r' % (suite_dir)) |
| 421 | |
| 422 | suite_def = SuiteDefinition(suite_dir) |
| 423 | loaded_suite_definitions[suite_name] = suite_def |
| 424 | return suite_def |
| 425 | |
| 426 | def parse_suite_scenario_str(suite_scenario_str): |
| 427 | tokens = suite_scenario_str.split(':') |
| 428 | if len(tokens) > 2: |
| 429 | raise RuntimeError('invalid combination string: %r' % suite_scenario_str) |
| 430 | |
| 431 | suite_name = tokens[0] |
| 432 | if len(tokens) <= 1: |
| 433 | scenario_names = [] |
| 434 | else: |
| 435 | scenario_names = tokens[1].split('+') |
| 436 | |
| 437 | return suite_name, scenario_names |
| 438 | |
| 439 | def load_suite_scenario_str(suite_scenario_str): |
| 440 | suite_name, scenario_names = parse_suite_scenario_str(suite_scenario_str) |
| 441 | suite = load(suite_name) |
Pau Espin Pedrol | 0b30279 | 2017-09-10 16:33:10 +0200 | [diff] [blame] | 442 | 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] | 443 | return (suite_scenario_str, suite, scenarios) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 444 | |
| 445 | def bts_obj(suite_run, conf): |
| 446 | bts_type = conf.get('type') |
Neels Hofmeyr | d28d1a7 | 2017-06-14 02:59:55 +0200 | [diff] [blame] | 447 | log.dbg('create BTS object', type=bts_type) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 448 | bts_class = resource.KNOWN_BTS_TYPES.get(bts_type) |
| 449 | if bts_class is None: |
| 450 | raise RuntimeError('No such BTS type is defined: %r' % bts_type) |
| 451 | return bts_class(suite_run, conf) |
| 452 | |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 453 | # vim: expandtab tabstop=4 shiftwidth=4 |