osmo-gsm-tester/src/osmo_gsm_tester/obj/msc_osmo.py

178 lines
6.2 KiB
Python

# osmo_gsm_tester: specifics for running an osmo-msc
#
# Copyright (C) 2016-2017 by sysmocom - s.f.m.c. GmbH
#
# Author: Neels Hofmeyr <neels@hofmeyr.de>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import pprint
from ..core import log, util, config, template, process
from ..core import schema
from . import osmo_ctrl, pcap_recorder, smsc
def on_register_schemas():
resource_schema = {
'path': schema.STR,
'emergency_call_msisdn': schema.MSISDN,
}
schema.register_resource_schema('modem', resource_schema)
class OsmoMsc(log.Origin):
def __init__(self, testenv, hlr, mgw, stp, ip_address):
super().__init__(log.C_RUN, 'osmo-msc_%s' % ip_address.get('addr'))
self.run_dir = None
self.config_file = None
self.process = None
self.config = None
self.encryption = None
self.authentication = None
self.use_osmux = "off"
self.testenv = testenv
self.ip_address = ip_address
self._emergency_call_msisdn = None
self.hlr = hlr
self.mgw = mgw
self.stp = stp
self.smsc = smsc.Smsc((ip_address.get('addr'), 2775))
self.ctrl = None
def start(self):
self.log('Starting osmo-msc')
self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name()))
self.configure()
inst = util.Dir(os.path.abspath(self.testenv.suite().trial().get_inst('osmo-msc')))
binary = inst.child('bin', 'osmo-msc')
if not os.path.isfile(binary):
raise RuntimeError('Binary missing: %r' % binary)
lib = inst.child('lib')
if not os.path.isdir(lib):
raise RuntimeError('No lib/ in %r' % inst)
pcap_recorder.PcapRecorder(self.testenv, self.run_dir.new_dir('pcap'), None,
'host %s and port not 22' % self.addr())
env = { 'LD_LIBRARY_PATH': util.prepend_library_path(lib) }
self.dbg(run_dir=self.run_dir, binary=binary, env=env)
self.process = process.Process(self.name(), self.run_dir,
(binary, '-c',
os.path.abspath(self.config_file)),
env=env)
self.testenv.remember_to_stop(self.process)
self.process.launch()
self.ctrl = OsmoMscCtrl(self)
self.ctrl.connect()
def configure(self):
self.config_file = self.run_dir.new_file('osmo-msc.cfg')
self.dbg(config_file=self.config_file)
values = dict(msc=config.get_defaults('msc'))
config.overlay(values, self.testenv.suite().config())
config.overlay(values, dict(msc=dict(ip_address=self.ip_address)))
config.overlay(values, self.mgw.conf_for_client())
config.overlay(values, self.hlr.conf_for_client())
config.overlay(values, self.stp.conf_for_client())
config.overlay(values, self.smsc.get_config())
# runtime parameters:
if self.encryption is not None:
encryption_vty = util.encryption2osmovty(self.encryption)
else:
encryption_vty = util.encryption2osmovty(values['msc']['net']['encryption'])
config.overlay(values, dict(msc=dict(net=dict(encryption=encryption_vty))))
if self.authentication is not None:
config.overlay(values, dict(msc=dict(net=dict(authentication=self.authentication))))
config.overlay(values, dict(msc=dict(use_osmux=self.use_osmux)))
if self._emergency_call_msisdn is not None:
config.overlay(values, dict(msc=dict(emergency_call_msisdn=self._emergency_call_msisdn)))
self.config = values
self.dbg('MSC CONFIG:\n' + pprint.pformat(values))
with open(self.config_file, 'w') as f:
r = template.render('osmo-msc.cfg', values)
self.dbg(r)
f.write(r)
def addr(self):
return self.ip_address.get('addr')
def set_encryption(self, val):
self.encryption = val
def set_authentication(self, val):
if val is None:
self.authroziation = None
return
self.authentication = "required" if val else "optional"
def set_use_osmux(self, use=False, force=False):
if not use:
self.use_osmux = "off"
else:
if not force:
self.use_osmux = "on"
else:
self.use_osmux = "only"
def mcc(self):
return self.config['msc']['net']['mcc']
def mnc(self):
return self.config['msc']['net']['mnc']
def mcc_mnc(self):
return (self.mcc(), self.mnc())
def subscriber_attached(self, *modems):
return self.imsi_attached(*[m.imsi() for m in modems])
def imsi_attached(self, *imsis):
attached = self.imsi_list_attached()
log.dbg('attached:', attached)
return all([(imsi in attached) for imsi in imsis])
def imsi_list_attached(self):
return self.ctrl.subscriber_list_active()
def set_emergency_call_msisdn(self, msisdn):
self.dbg('Setting Emergency Call MSISDN', msisdn=msisdn)
self._emergency_call_msisdn = msisdn
def running(self):
return not self.process.terminated()
def cleanup(self):
if self.ctrl is not None:
self.ctrl.disconnect()
self.ctrl = None
class OsmoMscCtrl(osmo_ctrl.OsmoCtrl):
def __init__(self, msc, port=4255):
self.msc = msc
super().__init__(self.msc.addr(), port)
def subscriber_list_active(self):
return self.get_var('subscriber-list-active-v1').replace('\n', ' ')
# vim: expandtab tabstop=4 shiftwidth=4