Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an osmo-nitb |
| 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 | 3531a19 | 2017-03-28 14:30:28 +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 | 3531a19 | 2017-03-28 14:30:28 +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 | 3531a19 | 2017-03-28 14:30:28 +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 re |
Neels Hofmeyr | 943c81d | 2017-05-22 20:16:03 +0200 | [diff] [blame] | 22 | import pprint |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 23 | |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 24 | from . import log, util, config, template, process, osmo_ctrl, pcap_recorder, smsc |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 25 | |
| 26 | class OsmoNitb(log.Origin): |
| 27 | suite_run = None |
Neels Hofmeyr | 76d8103 | 2017-05-18 18:35:32 +0200 | [diff] [blame] | 28 | ip_address = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 29 | run_dir = None |
| 30 | config_file = None |
| 31 | process = None |
| 32 | bts = None |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 33 | smsc = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 34 | |
Neels Hofmeyr | 76d8103 | 2017-05-18 18:35:32 +0200 | [diff] [blame] | 35 | def __init__(self, suite_run, ip_address): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 36 | super().__init__(log.C_RUN, 'osmo-nitb_%s' % ip_address.get('addr')) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 37 | self.suite_run = suite_run |
Neels Hofmeyr | 76d8103 | 2017-05-18 18:35:32 +0200 | [diff] [blame] | 38 | self.ip_address = ip_address |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 39 | self.bts = [] |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 40 | self.smsc = smsc.Smsc((ip_address.get('addr'), 2775)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 41 | |
| 42 | def start(self): |
| 43 | self.log('Starting osmo-nitb') |
Pau Espin Pedrol | d091233 | 2017-06-14 13:27:08 +0200 | [diff] [blame] | 44 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 45 | self.configure() |
Your Name | 3c6673a | 2017-04-08 18:52:39 +0200 | [diff] [blame] | 46 | inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('osmo-nitb'))) |
| 47 | binary = inst.child('bin', 'osmo-nitb') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 48 | if not os.path.isfile(binary): |
| 49 | raise RuntimeError('Binary missing: %r' % binary) |
Your Name | 3c6673a | 2017-04-08 18:52:39 +0200 | [diff] [blame] | 50 | lib = inst.child('lib') |
| 51 | if not os.path.isdir(lib): |
| 52 | raise RuntimeError('No lib/ in %r' % inst) |
Pau Espin Pedrol | e39c6f1 | 2017-05-08 16:21:38 +0200 | [diff] [blame] | 53 | |
Pau Espin Pedrol | 13143bc | 2017-05-08 17:07:28 +0200 | [diff] [blame] | 54 | iface = util.ip_to_iface(self.addr()) |
Neels Hofmeyr | 95fd673 | 2017-05-15 14:03:07 +0200 | [diff] [blame] | 55 | pcap_recorder.PcapRecorder(self.suite_run, self.run_dir.new_dir('pcap'), iface, |
Pau Espin Pedrol | 8cd347b | 2017-05-12 16:24:21 +0200 | [diff] [blame] | 56 | 'host %s and port not 22' % self.addr()) |
Pau Espin Pedrol | 13143bc | 2017-05-08 17:07:28 +0200 | [diff] [blame] | 57 | |
Pau Espin Pedrol | e39c6f1 | 2017-05-08 16:21:38 +0200 | [diff] [blame] | 58 | env = { 'LD_LIBRARY_PATH': util.prepend_library_path(lib) } |
| 59 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 60 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 61 | self.process = process.Process(self.name(), self.run_dir, |
| 62 | (binary, '-c', |
| 63 | os.path.abspath(self.config_file)), |
| 64 | env=env) |
| 65 | self.suite_run.remember_to_stop(self.process) |
| 66 | self.process.launch() |
| 67 | |
| 68 | def configure(self): |
| 69 | self.config_file = self.run_dir.new_file('osmo-nitb.cfg') |
| 70 | self.dbg(config_file=self.config_file) |
| 71 | |
| 72 | values = dict(nitb=config.get_defaults('nitb')) |
| 73 | config.overlay(values, self.suite_run.config()) |
Neels Hofmeyr | 4f59ba6 | 2017-05-22 20:04:05 +0200 | [diff] [blame] | 74 | config.overlay(values, dict(nitb=dict(ip_address=self.ip_address))) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 75 | |
| 76 | bts_list = [] |
| 77 | for bts in self.bts: |
Neels Hofmeyr | c4ba4a6 | 2017-05-18 19:31:44 +0200 | [diff] [blame] | 78 | bts_list.append(bts.conf_for_bsc()) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 79 | config.overlay(values, dict(nitb=dict(net=dict(bts_list=bts_list)))) |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 80 | config.overlay(values, self.smsc.get_config()) |
Pau Espin Pedrol | 0e57aad | 2017-05-29 14:25:22 +0200 | [diff] [blame] | 81 | self.config = values |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 82 | |
Neels Hofmeyr | 943c81d | 2017-05-22 20:16:03 +0200 | [diff] [blame] | 83 | self.dbg('NITB CONFIG:\n' + pprint.pformat(values)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 84 | |
| 85 | with open(self.config_file, 'w') as f: |
| 86 | r = template.render('osmo-nitb.cfg', values) |
| 87 | self.dbg(r) |
| 88 | f.write(r) |
| 89 | |
| 90 | def addr(self): |
Neels Hofmeyr | 76d8103 | 2017-05-18 18:35:32 +0200 | [diff] [blame] | 91 | return self.ip_address.get('addr') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 92 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 93 | def bts_add(self, bts): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 94 | self.bts.append(bts) |
Neels Hofmeyr | c4ba4a6 | 2017-05-18 19:31:44 +0200 | [diff] [blame] | 95 | bts.set_bsc(self) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 96 | |
Pau Espin Pedrol | 0e57aad | 2017-05-29 14:25:22 +0200 | [diff] [blame] | 97 | def mcc(self): |
| 98 | return self.config['nitb']['net']['mcc'] |
| 99 | |
| 100 | def mnc(self): |
| 101 | return self.config['nitb']['net']['mnc'] |
| 102 | |
| 103 | def mcc_mnc(self): |
| 104 | return (self.mcc(), self.mnc()) |
| 105 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 106 | def subscriber_add(self, modem, msisdn=None): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 107 | if msisdn is None: |
| 108 | msisdn = self.suite_run.resources_pool.next_msisdn(modem) |
| 109 | modem.set_msisdn(msisdn) |
| 110 | self.log('Add subscriber', msisdn=msisdn, imsi=modem.imsi()) |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 111 | OsmoNitbCtrl(self).subscriber_add(modem.imsi(), msisdn, modem.ki()) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 112 | |
| 113 | def subscriber_attached(self, *modems): |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 114 | return self.imsi_attached(*[m.imsi() for m in modems]) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 115 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 116 | def imsi_attached(self, *imsis): |
| 117 | attached = self.imsi_list_attached() |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 118 | self.dbg('attached:', attached) |
| 119 | return all([(imsi in attached) for imsi in imsis]) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 120 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 121 | def imsi_list_attached(self): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 122 | return OsmoNitbCtrl(self).subscriber_list_active() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 123 | |
| 124 | def running(self): |
| 125 | return not self.process.terminated() |
| 126 | |
| 127 | |
| 128 | class OsmoNitbCtrl(log.Origin): |
| 129 | PORT = 4249 |
| 130 | SUBSCR_MODIFY_VAR = 'subscriber-modify-v1' |
| 131 | SUBSCR_MODIFY_REPLY_RE = re.compile("SET_REPLY (\d+) %s OK" % SUBSCR_MODIFY_VAR) |
| 132 | SUBSCR_LIST_ACTIVE_VAR = 'subscriber-list-active-v1' |
| 133 | |
| 134 | def __init__(self, nitb): |
| 135 | self.nitb = nitb |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 136 | super().__init__(log.C_BUS, 'CTRL(%s:%d)' % (self.nitb.addr(), OsmoNitbCtrl.PORT)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 137 | |
| 138 | def ctrl(self): |
| 139 | return osmo_ctrl.OsmoCtrl(self.nitb.addr(), OsmoNitbCtrl.PORT) |
| 140 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 141 | def subscriber_add(self, imsi, msisdn, ki=None, algo=None): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 142 | created = False |
| 143 | if ki and not algo: |
| 144 | algo = 'comp128v1' |
| 145 | |
| 146 | if algo: |
| 147 | value = '%s,%s,%s,%s' % (imsi,msisdn,algo,ki) |
| 148 | else: |
| 149 | value = '%s,%s' % (imsi, msisdn) |
| 150 | |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 151 | with self.ctrl() as ctrl: |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 152 | ctrl.do_set(OsmoNitbCtrl.SUBSCR_MODIFY_VAR, value) |
| 153 | data = ctrl.receive() |
| 154 | (answer, data) = ctrl.remove_ipa_ctrl_header(data) |
| 155 | answer_str = answer.decode('utf-8') |
| 156 | res = OsmoNitbCtrl.SUBSCR_MODIFY_REPLY_RE.match(answer_str) |
| 157 | if not res: |
| 158 | raise RuntimeError('Cannot create subscriber %r (answer=%r)' % (imsi, answer_str)) |
| 159 | self.dbg('Created subscriber', imsi=imsi, msisdn=msisdn) |
| 160 | return True |
| 161 | |
| 162 | def subscriber_list_active(self): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 163 | aslist_str = "" |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 164 | with self.ctrl() as ctrl: |
| 165 | ctrl.do_get(OsmoNitbCtrl.SUBSCR_LIST_ACTIVE_VAR) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 166 | # This is legacy code from the old osmo-gsm-tester. |
| 167 | # looks like this doesn't work for long data. |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 168 | data = ctrl.receive() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 169 | while (len(data) > 0): |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 170 | (answer, data) = ctrl.remove_ipa_ctrl_header(data) |
| 171 | answer_str = answer.decode('utf-8') |
| 172 | answer_str = answer_str.replace('\n', ' ') |
| 173 | aslist_str = answer_str |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 174 | return aslist_str |
| 175 | |
| 176 | # vim: expandtab tabstop=4 shiftwidth=4 |