2017-05-18 13:24:02 +00:00
|
|
|
# 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
|
2017-06-03 07:51:45 +00:00
|
|
|
# it under the terms of the GNU General Public License as
|
2017-05-18 13:24:02 +00:00
|
|
|
# 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
|
2017-06-03 07:51:45 +00:00
|
|
|
# GNU General Public License for more details.
|
2017-05-18 13:24:02 +00:00
|
|
|
#
|
2017-06-03 07:51:45 +00:00
|
|
|
# You should have received a copy of the GNU General Public License
|
2017-05-18 13:24:02 +00:00
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
import os
|
|
|
|
import pprint
|
|
|
|
|
2020-04-10 18:46:07 +00:00
|
|
|
from ..core import log, util, config, template, process
|
2020-05-04 10:05:05 +00:00
|
|
|
from ..core import schema
|
2020-04-10 17:51:31 +00:00
|
|
|
from . import osmo_ctrl, pcap_recorder, smsc
|
2017-05-18 13:24:02 +00:00
|
|
|
|
2020-05-04 10:05:05 +00:00
|
|
|
def on_register_schemas():
|
|
|
|
resource_schema = {
|
|
|
|
'path': schema.STR,
|
2020-10-14 12:49:05 +00:00
|
|
|
'emergency_call_msisdn': schema.MSISDN,
|
2020-05-04 10:05:05 +00:00
|
|
|
}
|
|
|
|
schema.register_resource_schema('modem', resource_schema)
|
|
|
|
|
2017-05-18 13:24:02 +00:00
|
|
|
class OsmoMsc(log.Origin):
|
|
|
|
|
2020-05-05 10:54:37 +00:00
|
|
|
def __init__(self, testenv, hlr, mgw, stp, ip_address):
|
fix and refactor logging: drop 'with', simplify
With the recent fix of the junit report related issues, another issue arose:
the 'with log.Origin' was changed to disallow __enter__ing an object twice to
fix problems, now still code would fail because it tries to do 'with' on the
same object twice. The only reason is to ensure that logging is associated with
a given object. Instead of complicating even more, implement differently.
Refactor logging to simplify use: drop the 'with Origin' style completely, and
instead use the python stack to determine which objects are created by which,
and which object to associate a log statement with.
The new way: we rely on the convention that each class instance has a local
'self' referencing the object instance. If we need to find an origin as a new
object's parent, or to associate a log message with, we traverse each stack
frame, fetching the first local 'self' object that is a log.Origin class
instance.
How to use:
Simply call log.log() anywhere, and it finds an Origin object to log for, from
the stack. Alternatively call self.log() for any Origin() object to skip the
lookup.
Create classes as child class of log.Origin and make sure to call
super().__init__(category, name). This constructor will magically find a parent
Origin on the stack.
When an exception happens, we first escalate the exception up through call
scopes to where ever it is handled by log.log_exn(). This then finds an Origin
object in the traceback's stack frames, no need to nest in 'with' scopes.
Hence the 'with log.Origin' now "happens implicitly", we can write pure natural
python code, no more hassles with scope ordering.
Furthermore, any frame can place additional logging information in a frame by
calling log.ctx(). This is automatically inserted in the ancestry associated
with a log statement / exception.
Change-Id: I5f9b53150f2bb6fa9d63ce27f0806f0ca6a45e90
2017-06-09 23:18:27 +00:00
|
|
|
super().__init__(log.C_RUN, 'osmo-msc_%s' % ip_address.get('addr'))
|
2018-08-09 11:45:55 +00:00
|
|
|
self.run_dir = None
|
|
|
|
self.config_file = None
|
|
|
|
self.process = None
|
|
|
|
self.config = None
|
|
|
|
self.encryption = None
|
|
|
|
self.authentication = None
|
2019-06-19 15:18:43 +00:00
|
|
|
self.use_osmux = "off"
|
2020-05-05 10:54:37 +00:00
|
|
|
self.testenv = testenv
|
2017-05-18 13:24:02 +00:00
|
|
|
self.ip_address = ip_address
|
2020-10-14 12:49:05 +00:00
|
|
|
self._emergency_call_msisdn = None
|
2017-05-18 13:24:02 +00:00
|
|
|
self.hlr = hlr
|
2018-02-26 11:14:46 +00:00
|
|
|
self.mgw = mgw
|
2017-11-16 17:06:37 +00:00
|
|
|
self.stp = stp
|
2017-05-30 13:33:57 +00:00
|
|
|
self.smsc = smsc.Smsc((ip_address.get('addr'), 2775))
|
2020-12-08 16:36:04 +00:00
|
|
|
self.ctrl = None
|
2017-05-18 13:24:02 +00:00
|
|
|
|
|
|
|
def start(self):
|
|
|
|
self.log('Starting osmo-msc')
|
2020-05-11 08:56:52 +00:00
|
|
|
self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name()))
|
2017-05-18 13:24:02 +00:00
|
|
|
self.configure()
|
2020-05-05 10:54:37 +00:00
|
|
|
inst = util.Dir(os.path.abspath(self.testenv.suite().trial().get_inst('osmo-msc')))
|
2017-05-18 13:24:02 +00:00
|
|
|
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)
|
|
|
|
|
2020-05-05 10:54:37 +00:00
|
|
|
pcap_recorder.PcapRecorder(self.testenv, self.run_dir.new_dir('pcap'), None,
|
2017-05-18 13:24:02 +00:00
|
|
|
'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)
|
2020-05-05 10:54:37 +00:00
|
|
|
self.testenv.remember_to_stop(self.process)
|
2017-05-18 13:24:02 +00:00
|
|
|
self.process.launch()
|
|
|
|
|
2020-12-08 16:36:04 +00:00
|
|
|
self.ctrl = OsmoMscCtrl(self)
|
|
|
|
self.ctrl.connect()
|
|
|
|
|
2017-05-18 13:24:02 +00:00
|
|
|
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'))
|
2020-05-05 10:54:37 +00:00
|
|
|
config.overlay(values, self.testenv.suite().config())
|
2017-05-18 13:24:02 +00:00
|
|
|
config.overlay(values, dict(msc=dict(ip_address=self.ip_address)))
|
2018-02-26 11:14:46 +00:00
|
|
|
config.overlay(values, self.mgw.conf_for_client())
|
2017-11-23 10:07:02 +00:00
|
|
|
config.overlay(values, self.hlr.conf_for_client())
|
2017-11-16 17:06:37 +00:00
|
|
|
config.overlay(values, self.stp.conf_for_client())
|
2017-05-30 13:33:57 +00:00
|
|
|
config.overlay(values, self.smsc.get_config())
|
2017-08-22 17:04:06 +00:00
|
|
|
|
|
|
|
# runtime parameters:
|
|
|
|
if self.encryption is not None:
|
2017-09-04 14:26:08 +00:00
|
|
|
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))))
|
2017-08-23 15:39:54 +00:00
|
|
|
if self.authentication is not None:
|
|
|
|
config.overlay(values, dict(msc=dict(net=dict(authentication=self.authentication))))
|
2019-06-19 15:18:43 +00:00
|
|
|
config.overlay(values, dict(msc=dict(use_osmux=self.use_osmux)))
|
2020-10-14 12:49:05 +00:00
|
|
|
if self._emergency_call_msisdn is not None:
|
|
|
|
config.overlay(values, dict(msc=dict(emergency_call_msisdn=self._emergency_call_msisdn)))
|
2017-08-22 17:04:06 +00:00
|
|
|
|
ofono_client: Implement network registration during connect()
A new mcc_mnc parameter is now optionally passed to connect() in order
to manually register to a specific network with a given MCC+MNC pair.
If no parameter is passed (or None), then the modem will be instructed
to attempt an automatic registration with any available network which
permits it.
We get the MCC+MNC parameter from the MSC/NITB and we pass it to the
modem object at connect time as shown in the modified tests. Two new
simple tests to check network registration is working are added in this
commit.
Ofono modems seem to be automatically registering at some point after
they are set Online=true, and we were actually using that 'feature'
before this patch. Thus, it is possible that a modem quickly becomes
registered, and we then check so before starting the scan+registration
process, which can take a few seconds.
The scanning method can take a few seconds to complete. To avoid
blocking in the dbus ofono Scan() method, this commit adds some code to
make use of glib/gdbus async methods, which are not yet supported
directly by pydbus. This way, we can continue polling while waiting for
the scan process to complete and we can register several modems in
parallel. When scan completes, a callback is run which attempts to
register. If no MCC+MNC was passed, as we just finished scanning the
modem should have enough fresh operator information to take good and
quick decisions on where to connect. If we have an MCC+MNC, then we check
the operator list received by Scan() method. If operator with desired
MCC+MNC is there, we register with it. If it's not there, we start
scanning() again asynchronously hoping the operator will show up in next
scan.
As scanning() and registration is done in the background, tests are
expected to call connect(), and then later on wait for the modem to
register by waiting/polling the method "modem.is_connected()". Tests
first check for the modem being connected and after with MSC
subscriber_attached(). The order is intentional because the later has to
poll through network and adds unneeded garbage to the pcap files bein
recorded.
Change-Id: I8d9eb47eac1044550d3885adb55105c304b0c15c
2017-05-29 12:25:22 +00:00
|
|
|
self.config = values
|
2017-05-18 13:24:02 +00:00
|
|
|
|
|
|
|
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')
|
|
|
|
|
2017-08-22 17:04:06 +00:00
|
|
|
def set_encryption(self, val):
|
|
|
|
self.encryption = val
|
|
|
|
|
2017-08-23 15:39:54 +00:00
|
|
|
def set_authentication(self, val):
|
|
|
|
if val is None:
|
|
|
|
self.authroziation = None
|
|
|
|
return
|
|
|
|
self.authentication = "required" if val else "optional"
|
|
|
|
|
2019-06-19 15:18:43 +00:00
|
|
|
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"
|
|
|
|
|
ofono_client: Implement network registration during connect()
A new mcc_mnc parameter is now optionally passed to connect() in order
to manually register to a specific network with a given MCC+MNC pair.
If no parameter is passed (or None), then the modem will be instructed
to attempt an automatic registration with any available network which
permits it.
We get the MCC+MNC parameter from the MSC/NITB and we pass it to the
modem object at connect time as shown in the modified tests. Two new
simple tests to check network registration is working are added in this
commit.
Ofono modems seem to be automatically registering at some point after
they are set Online=true, and we were actually using that 'feature'
before this patch. Thus, it is possible that a modem quickly becomes
registered, and we then check so before starting the scan+registration
process, which can take a few seconds.
The scanning method can take a few seconds to complete. To avoid
blocking in the dbus ofono Scan() method, this commit adds some code to
make use of glib/gdbus async methods, which are not yet supported
directly by pydbus. This way, we can continue polling while waiting for
the scan process to complete and we can register several modems in
parallel. When scan completes, a callback is run which attempts to
register. If no MCC+MNC was passed, as we just finished scanning the
modem should have enough fresh operator information to take good and
quick decisions on where to connect. If we have an MCC+MNC, then we check
the operator list received by Scan() method. If operator with desired
MCC+MNC is there, we register with it. If it's not there, we start
scanning() again asynchronously hoping the operator will show up in next
scan.
As scanning() and registration is done in the background, tests are
expected to call connect(), and then later on wait for the modem to
register by waiting/polling the method "modem.is_connected()". Tests
first check for the modem being connected and after with MSC
subscriber_attached(). The order is intentional because the later has to
poll through network and adds unneeded garbage to the pcap files bein
recorded.
Change-Id: I8d9eb47eac1044550d3885adb55105c304b0c15c
2017-05-29 12:25:22 +00:00
|
|
|
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())
|
|
|
|
|
2017-05-18 13:24:02 +00:00
|
|
|
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()
|
fix and refactor logging: drop 'with', simplify
With the recent fix of the junit report related issues, another issue arose:
the 'with log.Origin' was changed to disallow __enter__ing an object twice to
fix problems, now still code would fail because it tries to do 'with' on the
same object twice. The only reason is to ensure that logging is associated with
a given object. Instead of complicating even more, implement differently.
Refactor logging to simplify use: drop the 'with Origin' style completely, and
instead use the python stack to determine which objects are created by which,
and which object to associate a log statement with.
The new way: we rely on the convention that each class instance has a local
'self' referencing the object instance. If we need to find an origin as a new
object's parent, or to associate a log message with, we traverse each stack
frame, fetching the first local 'self' object that is a log.Origin class
instance.
How to use:
Simply call log.log() anywhere, and it finds an Origin object to log for, from
the stack. Alternatively call self.log() for any Origin() object to skip the
lookup.
Create classes as child class of log.Origin and make sure to call
super().__init__(category, name). This constructor will magically find a parent
Origin on the stack.
When an exception happens, we first escalate the exception up through call
scopes to where ever it is handled by log.log_exn(). This then finds an Origin
object in the traceback's stack frames, no need to nest in 'with' scopes.
Hence the 'with log.Origin' now "happens implicitly", we can write pure natural
python code, no more hassles with scope ordering.
Furthermore, any frame can place additional logging information in a frame by
calling log.ctx(). This is automatically inserted in the ancestry associated
with a log statement / exception.
Change-Id: I5f9b53150f2bb6fa9d63ce27f0806f0ca6a45e90
2017-06-09 23:18:27 +00:00
|
|
|
log.dbg('attached:', attached)
|
2017-05-18 13:24:02 +00:00
|
|
|
return all([(imsi in attached) for imsi in imsis])
|
|
|
|
|
|
|
|
def imsi_list_attached(self):
|
2020-12-08 16:36:04 +00:00
|
|
|
return self.ctrl.subscriber_list_active()
|
2020-10-14 12:49:05 +00:00
|
|
|
|
|
|
|
def set_emergency_call_msisdn(self, msisdn):
|
|
|
|
self.dbg('Setting Emergency Call MSISDN', msisdn=msisdn)
|
|
|
|
self._emergency_call_msisdn = msisdn
|
2017-05-18 13:24:02 +00:00
|
|
|
|
|
|
|
def running(self):
|
|
|
|
return not self.process.terminated()
|
|
|
|
|
2020-12-08 16:36:04 +00:00
|
|
|
def cleanup(self):
|
|
|
|
if self.ctrl is not None:
|
|
|
|
self.ctrl.disconnect()
|
|
|
|
self.ctrl = None
|
|
|
|
|
2017-05-18 13:24:02 +00:00
|
|
|
|
OsmoCtrl cleanup: get_var(), set_var(), get_trap()
CTRL interface interaction was mostly inherited from the first legacy
implementation of osmo-gsm-tester, and it was a pain to look at from the
start. Now, while I'm close to the topic, I want this to improve:
Properly match a GET_REPLY/SET_REPLY to a sent GET/SET by the message
ID.
Completely drop the do_get() and do_set(), which were not useful for
correct handling of the CTRL request and response messaging. The API to
use by callers is set_var(), get_var()/get_int_var() and get_trap().
These call the internal _sendrecv() (or for TRAP only _recv())
functions. Make it so that tese work both on an already connected
OsmoCtrl, as well as one that needs to establish a (short) connection,
so that both are trivially possible:
# one CTRL connection stays open
with OsmoCtrl(...) as ctrl:
ctrl.get_var('var1')
ctrl.get_var('var2')
ctrl.get_var('var3')
and
# get_var() opens a connection, does the GET and closes again
OsmoCtrl(...).get_var('var1')
Do away with doubling the instances OsmoCtrl and e.g. OsmoBscCtrl.
Rather make OsmoBscCtrl a child class of OsmoCtrl, which means that we
no longer have bsc.ctrl().ctrl(), just bsc.ctrl().
Have VERB_* constants instead of dup'd strings.
Apply to / simplify all callers of OsmoCtrl.
Some of these changes are similar to recently added OsmoVty.
Change-Id: Id561e5a55d8057a997a8ec9e7fa6f94840194df1
2020-12-01 03:48:38 +00:00
|
|
|
class OsmoMscCtrl(osmo_ctrl.OsmoCtrl):
|
|
|
|
def __init__(self, msc, port=4255):
|
2017-05-18 13:24:02 +00:00
|
|
|
self.msc = msc
|
OsmoCtrl cleanup: get_var(), set_var(), get_trap()
CTRL interface interaction was mostly inherited from the first legacy
implementation of osmo-gsm-tester, and it was a pain to look at from the
start. Now, while I'm close to the topic, I want this to improve:
Properly match a GET_REPLY/SET_REPLY to a sent GET/SET by the message
ID.
Completely drop the do_get() and do_set(), which were not useful for
correct handling of the CTRL request and response messaging. The API to
use by callers is set_var(), get_var()/get_int_var() and get_trap().
These call the internal _sendrecv() (or for TRAP only _recv())
functions. Make it so that tese work both on an already connected
OsmoCtrl, as well as one that needs to establish a (short) connection,
so that both are trivially possible:
# one CTRL connection stays open
with OsmoCtrl(...) as ctrl:
ctrl.get_var('var1')
ctrl.get_var('var2')
ctrl.get_var('var3')
and
# get_var() opens a connection, does the GET and closes again
OsmoCtrl(...).get_var('var1')
Do away with doubling the instances OsmoCtrl and e.g. OsmoBscCtrl.
Rather make OsmoBscCtrl a child class of OsmoCtrl, which means that we
no longer have bsc.ctrl().ctrl(), just bsc.ctrl().
Have VERB_* constants instead of dup'd strings.
Apply to / simplify all callers of OsmoCtrl.
Some of these changes are similar to recently added OsmoVty.
Change-Id: Id561e5a55d8057a997a8ec9e7fa6f94840194df1
2020-12-01 03:48:38 +00:00
|
|
|
super().__init__(self.msc.addr(), port)
|
2017-05-18 13:24:02 +00:00
|
|
|
|
|
|
|
def subscriber_list_active(self):
|
OsmoCtrl cleanup: get_var(), set_var(), get_trap()
CTRL interface interaction was mostly inherited from the first legacy
implementation of osmo-gsm-tester, and it was a pain to look at from the
start. Now, while I'm close to the topic, I want this to improve:
Properly match a GET_REPLY/SET_REPLY to a sent GET/SET by the message
ID.
Completely drop the do_get() and do_set(), which were not useful for
correct handling of the CTRL request and response messaging. The API to
use by callers is set_var(), get_var()/get_int_var() and get_trap().
These call the internal _sendrecv() (or for TRAP only _recv())
functions. Make it so that tese work both on an already connected
OsmoCtrl, as well as one that needs to establish a (short) connection,
so that both are trivially possible:
# one CTRL connection stays open
with OsmoCtrl(...) as ctrl:
ctrl.get_var('var1')
ctrl.get_var('var2')
ctrl.get_var('var3')
and
# get_var() opens a connection, does the GET and closes again
OsmoCtrl(...).get_var('var1')
Do away with doubling the instances OsmoCtrl and e.g. OsmoBscCtrl.
Rather make OsmoBscCtrl a child class of OsmoCtrl, which means that we
no longer have bsc.ctrl().ctrl(), just bsc.ctrl().
Have VERB_* constants instead of dup'd strings.
Apply to / simplify all callers of OsmoCtrl.
Some of these changes are similar to recently added OsmoVty.
Change-Id: Id561e5a55d8057a997a8ec9e7fa6f94840194df1
2020-12-01 03:48:38 +00:00
|
|
|
return self.get_var('subscriber-list-active-v1').replace('\n', ' ')
|
2017-05-18 13:24:02 +00:00
|
|
|
|
|
|
|
# vim: expandtab tabstop=4 shiftwidth=4
|