Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an osmo-msc |
| 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 | 798e592 | 2017-05-18 15:24:02 +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 | 798e592 | 2017-05-18 15:24:02 +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 | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import os |
| 21 | import pprint |
| 22 | |
Pau Espin Pedrol | e1a58bd | 2020-04-10 20:46:07 +0200 | [diff] [blame] | 23 | from ..core import log, util, config, template, process |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 24 | from ..core import schema |
Pau Espin Pedrol | e8bbcbf | 2020-04-10 19:51:31 +0200 | [diff] [blame] | 25 | from . import osmo_ctrl, pcap_recorder, smsc |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 26 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 27 | def on_register_schemas(): |
| 28 | resource_schema = { |
| 29 | 'path': schema.STR, |
Pau Espin Pedrol | 680ba03 | 2020-10-14 14:49:05 +0200 | [diff] [blame] | 30 | 'emergency_call_msisdn': schema.MSISDN, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 31 | } |
| 32 | schema.register_resource_schema('modem', resource_schema) |
| 33 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 34 | class OsmoMsc(log.Origin): |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 35 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 36 | def __init__(self, testenv, hlr, mgw, stp, ip_address): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 37 | super().__init__(log.C_RUN, 'osmo-msc_%s' % ip_address.get('addr')) |
Pau Espin Pedrol | 5860367 | 2018-08-09 13:45:55 +0200 | [diff] [blame] | 38 | self.run_dir = None |
| 39 | self.config_file = None |
| 40 | self.process = None |
| 41 | self.config = None |
| 42 | self.encryption = None |
| 43 | self.authentication = None |
Pau Espin Pedrol | fed578e | 2019-06-19 17:18:43 +0200 | [diff] [blame] | 44 | self.use_osmux = "off" |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 45 | self.testenv = testenv |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 46 | self.ip_address = ip_address |
Pau Espin Pedrol | 680ba03 | 2020-10-14 14:49:05 +0200 | [diff] [blame] | 47 | self._emergency_call_msisdn = None |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 48 | self.hlr = hlr |
Pau Espin Pedrol | 86ea02f | 2018-02-26 12:14:46 +0100 | [diff] [blame] | 49 | self.mgw = mgw |
Pau Espin Pedrol | 1e1d381 | 2017-11-16 18:06:37 +0100 | [diff] [blame] | 50 | self.stp = stp |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 51 | self.smsc = smsc.Smsc((ip_address.get('addr'), 2775)) |
Neels Hofmeyr | 012a17d | 2020-12-08 17:36:04 +0100 | [diff] [blame] | 52 | self.ctrl = None |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 53 | |
| 54 | def start(self): |
| 55 | self.log('Starting osmo-msc') |
Pau Espin Pedrol | 2a2d846 | 2020-05-11 10:56:52 +0200 | [diff] [blame] | 56 | self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name())) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 57 | self.configure() |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 58 | inst = util.Dir(os.path.abspath(self.testenv.suite().trial().get_inst('osmo-msc'))) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 59 | binary = inst.child('bin', 'osmo-msc') |
| 60 | if not os.path.isfile(binary): |
| 61 | raise RuntimeError('Binary missing: %r' % binary) |
| 62 | lib = inst.child('lib') |
| 63 | if not os.path.isdir(lib): |
| 64 | raise RuntimeError('No lib/ in %r' % inst) |
| 65 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 66 | pcap_recorder.PcapRecorder(self.testenv, self.run_dir.new_dir('pcap'), None, |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 67 | 'host %s and port not 22' % self.addr()) |
| 68 | |
| 69 | env = { 'LD_LIBRARY_PATH': util.prepend_library_path(lib) } |
| 70 | |
| 71 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 72 | self.process = process.Process(self.name(), self.run_dir, |
| 73 | (binary, '-c', |
| 74 | os.path.abspath(self.config_file)), |
| 75 | env=env) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 76 | self.testenv.remember_to_stop(self.process) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 77 | self.process.launch() |
| 78 | |
Neels Hofmeyr | 012a17d | 2020-12-08 17:36:04 +0100 | [diff] [blame] | 79 | self.ctrl = OsmoMscCtrl(self) |
| 80 | self.ctrl.connect() |
| 81 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 82 | def configure(self): |
| 83 | self.config_file = self.run_dir.new_file('osmo-msc.cfg') |
| 84 | self.dbg(config_file=self.config_file) |
| 85 | |
| 86 | values = dict(msc=config.get_defaults('msc')) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 87 | config.overlay(values, self.testenv.suite().config()) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 88 | config.overlay(values, dict(msc=dict(ip_address=self.ip_address))) |
Pau Espin Pedrol | 86ea02f | 2018-02-26 12:14:46 +0100 | [diff] [blame] | 89 | config.overlay(values, self.mgw.conf_for_client()) |
Pau Espin Pedrol | 5bbb300 | 2017-11-23 11:07:02 +0100 | [diff] [blame] | 90 | config.overlay(values, self.hlr.conf_for_client()) |
Pau Espin Pedrol | 1e1d381 | 2017-11-16 18:06:37 +0100 | [diff] [blame] | 91 | config.overlay(values, self.stp.conf_for_client()) |
Pau Espin Pedrol | 2d16f6f | 2017-05-30 15:33:57 +0200 | [diff] [blame] | 92 | config.overlay(values, self.smsc.get_config()) |
Pau Espin Pedrol | ca126b1 | 2017-08-22 19:04:06 +0200 | [diff] [blame] | 93 | |
| 94 | # runtime parameters: |
| 95 | if self.encryption is not None: |
Pau Espin Pedrol | abd556a | 2017-09-04 16:26:08 +0200 | [diff] [blame] | 96 | encryption_vty = util.encryption2osmovty(self.encryption) |
| 97 | else: |
| 98 | encryption_vty = util.encryption2osmovty(values['msc']['net']['encryption']) |
| 99 | config.overlay(values, dict(msc=dict(net=dict(encryption=encryption_vty)))) |
Pau Espin Pedrol | b5a8614 | 2017-08-23 17:39:54 +0200 | [diff] [blame] | 100 | if self.authentication is not None: |
| 101 | config.overlay(values, dict(msc=dict(net=dict(authentication=self.authentication)))) |
Pau Espin Pedrol | fed578e | 2019-06-19 17:18:43 +0200 | [diff] [blame] | 102 | config.overlay(values, dict(msc=dict(use_osmux=self.use_osmux))) |
Pau Espin Pedrol | 680ba03 | 2020-10-14 14:49:05 +0200 | [diff] [blame] | 103 | if self._emergency_call_msisdn is not None: |
| 104 | config.overlay(values, dict(msc=dict(emergency_call_msisdn=self._emergency_call_msisdn))) |
Pau Espin Pedrol | ca126b1 | 2017-08-22 19:04:06 +0200 | [diff] [blame] | 105 | |
Pau Espin Pedrol | 0e57aad | 2017-05-29 14:25:22 +0200 | [diff] [blame] | 106 | self.config = values |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 107 | |
| 108 | self.dbg('MSC CONFIG:\n' + pprint.pformat(values)) |
| 109 | |
| 110 | with open(self.config_file, 'w') as f: |
| 111 | r = template.render('osmo-msc.cfg', values) |
| 112 | self.dbg(r) |
| 113 | f.write(r) |
| 114 | |
| 115 | def addr(self): |
| 116 | return self.ip_address.get('addr') |
| 117 | |
Pau Espin Pedrol | ca126b1 | 2017-08-22 19:04:06 +0200 | [diff] [blame] | 118 | def set_encryption(self, val): |
| 119 | self.encryption = val |
| 120 | |
Pau Espin Pedrol | b5a8614 | 2017-08-23 17:39:54 +0200 | [diff] [blame] | 121 | def set_authentication(self, val): |
| 122 | if val is None: |
| 123 | self.authroziation = None |
| 124 | return |
| 125 | self.authentication = "required" if val else "optional" |
| 126 | |
Pau Espin Pedrol | fed578e | 2019-06-19 17:18:43 +0200 | [diff] [blame] | 127 | def set_use_osmux(self, use=False, force=False): |
| 128 | if not use: |
| 129 | self.use_osmux = "off" |
| 130 | else: |
| 131 | if not force: |
| 132 | self.use_osmux = "on" |
| 133 | else: |
| 134 | self.use_osmux = "only" |
| 135 | |
Pau Espin Pedrol | 0e57aad | 2017-05-29 14:25:22 +0200 | [diff] [blame] | 136 | def mcc(self): |
| 137 | return self.config['msc']['net']['mcc'] |
| 138 | |
| 139 | def mnc(self): |
| 140 | return self.config['msc']['net']['mnc'] |
| 141 | |
| 142 | def mcc_mnc(self): |
| 143 | return (self.mcc(), self.mnc()) |
| 144 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 145 | def subscriber_attached(self, *modems): |
| 146 | return self.imsi_attached(*[m.imsi() for m in modems]) |
| 147 | |
| 148 | def imsi_attached(self, *imsis): |
| 149 | attached = self.imsi_list_attached() |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 150 | log.dbg('attached:', attached) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 151 | return all([(imsi in attached) for imsi in imsis]) |
| 152 | |
| 153 | def imsi_list_attached(self): |
Neels Hofmeyr | 012a17d | 2020-12-08 17:36:04 +0100 | [diff] [blame] | 154 | return self.ctrl.subscriber_list_active() |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 155 | |
Pau Espin Pedrol | 680ba03 | 2020-10-14 14:49:05 +0200 | [diff] [blame] | 156 | def set_emergency_call_msisdn(self, msisdn): |
| 157 | self.dbg('Setting Emergency Call MSISDN', msisdn=msisdn) |
| 158 | self._emergency_call_msisdn = msisdn |
| 159 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 160 | def running(self): |
| 161 | return not self.process.terminated() |
| 162 | |
Neels Hofmeyr | 012a17d | 2020-12-08 17:36:04 +0100 | [diff] [blame] | 163 | def cleanup(self): |
| 164 | if self.ctrl is not None: |
| 165 | self.ctrl.disconnect() |
| 166 | self.ctrl = None |
| 167 | |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 168 | |
Neels Hofmeyr | 5b04ef2 | 2020-12-01 04:48:38 +0100 | [diff] [blame] | 169 | class OsmoMscCtrl(osmo_ctrl.OsmoCtrl): |
| 170 | def __init__(self, msc, port=4255): |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 171 | self.msc = msc |
Neels Hofmeyr | 5b04ef2 | 2020-12-01 04:48:38 +0100 | [diff] [blame] | 172 | super().__init__(self.msc.addr(), port) |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 173 | |
| 174 | def subscriber_list_active(self): |
Neels Hofmeyr | 5b04ef2 | 2020-12-01 04:48:38 +0100 | [diff] [blame] | 175 | return self.get_var('subscriber-list-active-v1').replace('\n', ' ') |
Neels Hofmeyr | 798e592 | 2017-05-18 15:24:02 +0200 | [diff] [blame] | 176 | |
| 177 | # vim: expandtab tabstop=4 shiftwidth=4 |