<p>Max <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/11936">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Pau Espin Pedrol: Looks good to me, approved
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Move common Trap-related code into separate file<br><br>The ctrl2cgi.py is heavily based upon soap.py - let's move all the<br>shared code into separate file to make further modifications easier.<br><br>Change-Id: I7b59f2dbded9074d15f2d2f40bf5a92ed02601e2<br>Related: SYS#4399<br>---<br>M README<br>M osmopy/__init__.py<br>A osmopy/trap_helper.py<br>M scripts/ctrl2cgi.py<br>M scripts/soap.py<br>5 files changed, 147 insertions(+), 194 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/README b/README</span><br><span>index 37cd847..76defb6 100644</span><br><span>--- a/README</span><br><span>+++ b/README</span><br><span>@@ -33,6 +33,7 @@</span><br><span> Libraries:</span><br><span> osmopy/osmoutil.py - code that's shared between the scripts</span><br><span> osmopy/osmo_ipa.py - generic implementation of IPA and Ctrl protocols in python</span><br><span style="color: hsl(120, 100%, 40%);">+osmopy/trap_helper.py - generic Trap class and related helpers used by soap.py and ctrl2cgi.py</span><br><span> osmopy/osmo_interact/{vty,ctrl}.py - general interactions with VTY and CTRL ports</span><br><span> osmopy/obscvty.py - connect to a vty, superseded by osmo_interact/vty</span><br><span> </span><br><span>diff --git a/osmopy/__init__.py b/osmopy/__init__.py</span><br><span>index 2195498..ce78caf 100644</span><br><span>--- a/osmopy/__init__.py</span><br><span>+++ b/osmopy/__init__.py</span><br><span>@@ -1,4 +1,4 @@</span><br><span> #!/usr/bin/env python</span><br><span style="color: hsl(0, 100%, 40%);">-__version__ = '0.0.9'</span><br><span style="color: hsl(120, 100%, 40%);">+__version__ = '0.1.0'</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-__all__ = ['obscvty', 'osmoutil', 'osmo_ipa', 'osmo_interact', 'twisted_ipa']</span><br><span style="color: hsl(120, 100%, 40%);">+__all__ = ['obscvty', 'osmoutil', 'osmo_ipa', 'osmo_interact', 'trap_helper', 'twisted_ipa']</span><br><span>diff --git a/osmopy/trap_helper.py b/osmopy/trap_helper.py</span><br><span>new file mode 100644</span><br><span>index 0000000..a3ffbff</span><br><span>--- /dev/null</span><br><span>+++ b/osmopy/trap_helper.py</span><br><span>@@ -0,0 +1,126 @@</span><br><span style="color: hsl(120, 100%, 40%);">+#!/usr/bin/python3</span><br><span style="color: hsl(120, 100%, 40%);">+# -*- mode: python-mode; py-indent-tabs-mode: nil -*-</span><br><span style="color: hsl(120, 100%, 40%);">+"""</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (C) 2018 sysmocom s.f.m.c. GmbH</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * All Rights Reserved</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; either version 3 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+ * (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU General Public License along</span><br><span style="color: hsl(120, 100%, 40%);">+ * with this program; if not, write to the Free Software Foundation, Inc.,</span><br><span style="color: hsl(120, 100%, 40%);">+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+"""</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+import sys, os, signal, logging, logging.handlers</span><br><span style="color: hsl(120, 100%, 40%);">+from functools import partial</span><br><span style="color: hsl(120, 100%, 40%);">+from osmopy.twisted_ipa import CTRL</span><br><span style="color: hsl(120, 100%, 40%);">+from twisted.internet import defer</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# keys from OpenBSC openbsc/src/libbsc/bsc_rf_ctrl.c, values SOAP-specific</span><br><span style="color: hsl(120, 100%, 40%);">+oper = { 'inoperational' : 0, 'operational' : 1 }</span><br><span style="color: hsl(120, 100%, 40%);">+admin = { 'locked' : 0, 'unlocked' : 1 }</span><br><span style="color: hsl(120, 100%, 40%);">+policy = { 'off' : 0, 'on' : 1, 'grace' : 2, 'unknown' : 3 }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# keys from OpenBSC openbsc/src/libbsc/bsc_vty.c</span><br><span style="color: hsl(120, 100%, 40%);">+fix = { 'invalid' : 0, 'fix2d' : 1, 'fix3d' : 1 } # SOAP server treats it as boolean but expects int</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class Trap(CTRL):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ TRAP handler (agnostic to factory's client object)</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ def ctrl_TRAP(self, data, op_id, v):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Parse CTRL TRAP and dispatch to appropriate handler after normalization</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ (l, r) = v.split()</span><br><span style="color: hsl(120, 100%, 40%);">+ loc = l.split('.')</span><br><span style="color: hsl(120, 100%, 40%);">+ t_type = loc[-1]</span><br><span style="color: hsl(120, 100%, 40%);">+ p = partial(lambda a, i: a[i] if len(a) > i else None, loc) # parse helper</span><br><span style="color: hsl(120, 100%, 40%);">+ method = getattr(self, 'handle_' + t_type.replace('-', ''), lambda: "Unhandled %s trap" % t_type)</span><br><span style="color: hsl(120, 100%, 40%);">+ method(p(1), p(3), p(5), p(7), r) # we expect net.0.bsc.666.bts.2.trx.1 format for trap prefix</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def ctrl_SET_REPLY(self, data, _, v):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Debug log for replies to our commands</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ self.factory.log.debug('SET REPLY %s' % v)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def ctrl_ERROR(self, data, op_id, v):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ We want to know if smth went wrong</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ self.factory.log.debug('CTRL ERROR [%s] %s' % (op_id, v))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def connectionMade(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Logging wrapper, calling super() is necessary not to break reconnection logic</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ self.factory.log.info("Connected to CTRL@%s:%d" % (self.factory.host, self.factory.port))</span><br><span style="color: hsl(120, 100%, 40%);">+ super(CTRL, self).connectionMade()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ @defer.inlineCallbacks</span><br><span style="color: hsl(120, 100%, 40%);">+ def handle_locationstate(self, net, bsc, bts, trx, data):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Handle location-state TRAP: parse trap content, prepare parameters and use treq's routines to post it while setting up async handlers</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ (ts, fx, lat, lon, height, opr, adm, pol, mcc, mnc) = data.split(',')</span><br><span style="color: hsl(120, 100%, 40%);">+ tstamp = datetime.datetime.fromtimestamp(float(ts)).isoformat()</span><br><span style="color: hsl(120, 100%, 40%);">+ self.factory.log.debug('location-state@%s.%s.%s.%s (%s) [%s/%s] => %s' % (net, bsc, bts, trx, tstamp, mcc, mnc, data))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ d = self.factory.prepare_params(bsc, lon, lat, fix.get(fx, 0), tstamp, oper.get(opr, 2), admin.get(adm, 2), policy.get(pol, 3))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ d.addErrback(lambda e, bsc: self.factory.log.critical("HTTP POST error %s while trying to register BSC %s on %s" % (e, bsc, self.factory.location)), bsc) # handle HTTP errors</span><br><span style="color: hsl(120, 100%, 40%);">+ # Ensure that we run only limited number of requests in parallel:</span><br><span style="color: hsl(120, 100%, 40%);">+ yield self.factory.semaphore.acquire()</span><br><span style="color: hsl(120, 100%, 40%);">+ yield d # we end up here only if semaphore is available which means it's ok to fire the request without exceeding the limit</span><br><span style="color: hsl(120, 100%, 40%);">+ self.factory.semaphore.release()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def handle_notificationrejectionv1(self, net, bsc, bts, trx, data):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Handle notification-rejection-v1 TRAP: just an example to show how more message types can be handled</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ self.factory.log.debug('notification-rejection-v1@bsc-id %s => %s' % (bsc, data))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def reloader(path, script, log, dbg1, dbg2, signum, _):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Signal handler: we have to use execl() because twisted's reactor is not restartable due to some bug in twisted implementation</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ log.info("Received Signal %d - restarting..." % signum)</span><br><span style="color: hsl(120, 100%, 40%);">+ if signum == signal.SIGUSR1 and dbg1 not in sys.argv and dbg2 not in sys.argv:</span><br><span style="color: hsl(120, 100%, 40%);">+ sys.argv.append(dbg1) # enforce debug</span><br><span style="color: hsl(120, 100%, 40%);">+ if signum == signal.SIGUSR2 and (dbg1 in sys.argv or dbg2 in sys.argv): # disable debug</span><br><span style="color: hsl(120, 100%, 40%);">+ if dbg1 in sys.argv:</span><br><span style="color: hsl(120, 100%, 40%);">+ sys.argv.remove(dbg1)</span><br><span style="color: hsl(120, 100%, 40%);">+ if dbg2 in sys.argv:</span><br><span style="color: hsl(120, 100%, 40%);">+ sys.argv.remove(dbg2)</span><br><span style="color: hsl(120, 100%, 40%);">+ os.execl(path, script, *sys.argv[1:])</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def debug_init(name, is_debug, output):</span><br><span style="color: hsl(120, 100%, 40%);">+ log = logging.getLogger(name)</span><br><span style="color: hsl(120, 100%, 40%);">+ if is_debug:</span><br><span style="color: hsl(120, 100%, 40%);">+ log.setLevel(logging.DEBUG)</span><br><span style="color: hsl(120, 100%, 40%);">+ else:</span><br><span style="color: hsl(120, 100%, 40%);">+ log.setLevel(logging.INFO)</span><br><span style="color: hsl(120, 100%, 40%);">+ log.addHandler(logging.handlers.SysLogHandler('/dev/log'))</span><br><span style="color: hsl(120, 100%, 40%);">+ if output:</span><br><span style="color: hsl(120, 100%, 40%);">+ log.addHandler(logging.StreamHandler(sys.stdout))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ reboot = partial(reloader, os.path.abspath(__file__), os.path.basename(__file__), log, '-d', '--debug') # keep in sync with caller's add_argument()</span><br><span style="color: hsl(120, 100%, 40%);">+ signal.signal(signal.SIGHUP, reboot)</span><br><span style="color: hsl(120, 100%, 40%);">+ signal.signal(signal.SIGQUIT, reboot)</span><br><span style="color: hsl(120, 100%, 40%);">+ signal.signal(signal.SIGUSR1, reboot) # restart and enabled debug output</span><br><span style="color: hsl(120, 100%, 40%);">+ signal.signal(signal.SIGUSR2, reboot) # restart and disable debug output</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return log</span><br><span>diff --git a/scripts/ctrl2cgi.py b/scripts/ctrl2cgi.py</span><br><span>index ed4522c..18cfdbe 100755</span><br><span>--- a/scripts/ctrl2cgi.py</span><br><span>+++ b/scripts/ctrl2cgi.py</span><br><span>@@ -29,6 +29,7 @@</span><br><span> from osmopy.osmo_ipa import Ctrl</span><br><span> from treq import post, collect</span><br><span> from functools import partial</span><br><span style="color: hsl(120, 100%, 40%);">+from osmopy.trap_helper import Trap, reloader, debug_init</span><br><span> from distutils.version import StrictVersion as V # FIXME: use NormalizedVersion from PEP-386 when available</span><br><span> import argparse, datetime, signal, sys, os, logging, logging.handlers</span><br><span> import hashlib</span><br><span>@@ -38,13 +39,6 @@</span><br><span> # we don't support older versions of TwistedIPA module</span><br><span> assert V(twisted_ipa_version) > V('0.4')</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-# keys from OpenBSC openbsc/src/libbsc/bsc_rf_ctrl.c, values CGI-specific</span><br><span style="color: hsl(0, 100%, 40%);">-oper = { 'inoperational' : 0, 'operational' : 1 }</span><br><span style="color: hsl(0, 100%, 40%);">-admin = { 'locked' : 0, 'unlocked' : 1 }</span><br><span style="color: hsl(0, 100%, 40%);">-policy = { 'off' : 0, 'on' : 1, 'grace' : 2, 'unknown' : 3 }</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-# keys from OpenBSC openbsc/src/libbsc/bsc_vty.c</span><br><span style="color: hsl(0, 100%, 40%);">-fix = { 'invalid' : 0, 'fix2d' : 1, 'fix3d' : 1 } # CGI server treats it as boolean but expects int</span><br><span> </span><br><span> @defer.inlineCallbacks</span><br><span> def handle_reply(f, log, resp):</span><br><span>@@ -81,65 +75,6 @@</span><br><span> #print('HASH: \nparams="%r"\ninput="%s" \nres="%s"' %(params, input, res))</span><br><span> return res</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-class Trap(CTRL):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- TRAP handler (agnostic to factory's client object)</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- def ctrl_TRAP(self, data, op_id, v):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Parse CTRL TRAP and dispatch to appropriate handler after normalization</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('TRAP %s' % v)</span><br><span style="color: hsl(0, 100%, 40%);">- (l, r) = v.split()</span><br><span style="color: hsl(0, 100%, 40%);">- loc = l.split('.')</span><br><span style="color: hsl(0, 100%, 40%);">- t_type = loc[-1]</span><br><span style="color: hsl(0, 100%, 40%);">- p = partial(lambda a, i: a[i] if len(a) > i else None, loc) # parse helper</span><br><span style="color: hsl(0, 100%, 40%);">- method = getattr(self, 'handle_' + t_type.replace('-', ''), lambda *_: "Unhandled %s trap" % t_type)</span><br><span style="color: hsl(0, 100%, 40%);">- method(p(1), p(3), p(5), p(7), r) # we expect net.0.bsc.666.bts.2.trx.1 format for trap prefix</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def ctrl_SET_REPLY(self, data, _, v):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Debug log for replies to our commands</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('SET REPLY %s' % v)</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def ctrl_ERROR(self, data, op_id, v):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- We want to know if smth went wrong</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('CTRL ERROR [%s] %s' % (op_id, v))</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def connectionMade(self):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Logging wrapper, calling super() is necessary not to break reconnection logic</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.info("Connected to CTRL@%s:%d" % (self.factory.host, self.factory.port))</span><br><span style="color: hsl(0, 100%, 40%);">- super(CTRL, self).connectionMade()</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- @defer.inlineCallbacks</span><br><span style="color: hsl(0, 100%, 40%);">- def handle_locationstate(self, net, bsc, bts, trx, data):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Handle location-state TRAP: parse trap content, build CGI Request and use treq's routines to post it while setting up async handlers</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- (ts, fx, lat, lon, height, opr, adm, pol, mcc, mnc) = data.split(',')</span><br><span style="color: hsl(0, 100%, 40%);">- tstamp = datetime.datetime.fromtimestamp(float(ts)).isoformat()</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('location-state@%s.%s.%s.%s (%s) [%s/%s] => %s' % (net, bsc, bts, trx, tstamp, mcc, mnc, data))</span><br><span style="color: hsl(0, 100%, 40%);">- params = {'bsc_id': bsc, 'lon': lon, 'lat': lat, 'position_validity': fix.get(fx, 0), 'time_stamp': tstamp, 'oper_status': oper.get(opr, 2), 'admin_status': admin.get(adm, 2), 'policy_status': policy.get(pol, 3) }</span><br><span style="color: hsl(0, 100%, 40%);">- params['h'] = gen_hash(params, self.factory.secret_key)</span><br><span style="color: hsl(0, 100%, 40%);">- d = post(self.factory.location, None, params=params)</span><br><span style="color: hsl(0, 100%, 40%);">- d.addCallback(partial(handle_reply, self.transport.write, self.factory.log)) # treq's collect helper is handy to get all reply content at once using closure on ctx</span><br><span style="color: hsl(0, 100%, 40%);">- d.addErrback(lambda e, bsc: self.factory.log.critical("HTTP POST error %s while trying to register BSC %s on %s" % (e, bsc, self.factory.location)), bsc) # handle HTTP errors</span><br><span style="color: hsl(0, 100%, 40%);">- # Ensure that we run only limited number of requests in parallel:</span><br><span style="color: hsl(0, 100%, 40%);">- yield self.factory.semaphore.acquire()</span><br><span style="color: hsl(0, 100%, 40%);">- yield d # we end up here only if semaphore is available which means it's ok to fire the request without exceeding the limit</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.semaphore.release()</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def handle_notificationrejectionv1(self, net, bsc, bts, trx, data):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Handle notification-rejection-v1 TRAP: just an example to show how more message types can be handled</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('notification-rejection-v1@bsc-id %s => %s' % (bsc, data))</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> </span><br><span> class TrapFactory(IPAFactory):</span><br><span> """</span><br><span>@@ -165,21 +100,12 @@</span><br><span> self.log.setLevel(level)</span><br><span> self.log.debug("Using IPA %s, CGI server: %s" % (Ctrl.version, self.location))</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-def reloader(path, script, log, dbg1, dbg2, signum, _):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Signal handler: we have to use execl() because twisted's reactor is not restartable due to some bug in twisted implementation</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- log.info("Received Signal %d - restarting..." % signum)</span><br><span style="color: hsl(0, 100%, 40%);">- if signum == signal.SIGUSR1 and dbg1 not in sys.argv and dbg2 not in sys.argv:</span><br><span style="color: hsl(0, 100%, 40%);">- sys.argv.append(dbg1) # enforce debug</span><br><span style="color: hsl(0, 100%, 40%);">- if signum == signal.SIGUSR2 and (dbg1 in sys.argv or dbg2 in sys.argv): # disable debug</span><br><span style="color: hsl(0, 100%, 40%);">- if dbg1 in sys.argv:</span><br><span style="color: hsl(0, 100%, 40%);">- sys.argv.remove(dbg1)</span><br><span style="color: hsl(0, 100%, 40%);">- if dbg2 in sys.argv:</span><br><span style="color: hsl(0, 100%, 40%);">- sys.argv.remove(dbg2)</span><br><span style="color: hsl(0, 100%, 40%);">- os.execl(path, script, *sys.argv[1:])</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+ def prepare_params(bsc, lon, lat, fix, tstamp, oper, admin, policy):</span><br><span style="color: hsl(120, 100%, 40%);">+ params = {'bsc_id': bsc, 'lon': lon, 'lat': lat, 'position_validity': fix, 'time_stamp': tstamp, 'oper_status': oper, 'admin_status': admin, 'policy_status': policy }</span><br><span style="color: hsl(120, 100%, 40%);">+ params['h'] = gen_hash(params, self.factory.secret_key)</span><br><span style="color: hsl(120, 100%, 40%);">+ d = post(self.factory.location, None, params=params)</span><br><span style="color: hsl(120, 100%, 40%);">+ d.addCallback(partial(handle_reply, self.transport.write, self.factory.log))</span><br><span style="color: hsl(120, 100%, 40%);">+ return d</span><br><span> </span><br><span> if __name__ == '__main__':</span><br><span> p = argparse.ArgumentParser(description='Proxy between given GCI service and Osmocom CTRL protocol.')</span><br><span>@@ -187,27 +113,14 @@</span><br><span> p.add_argument('-a', '--addr-ctrl', default='localhost', help="Adress to use for CTRL interface, defaults to localhost")</span><br><span> p.add_argument('-p', '--port-ctrl', type=int, default=4250, help="Port to use for CTRL interface, defaults to 4250")</span><br><span> p.add_argument('-n', '--num-max-conn', type=int, default=5, help="Max number of concurrent HTTP requests to CGI server")</span><br><span style="color: hsl(0, 100%, 40%);">- p.add_argument('-d', '--debug', action='store_true', help="Enable debug log")</span><br><span style="color: hsl(120, 100%, 40%);">+ p.add_argument('-d', '--debug', action='store_true', help="Enable debug log") # keep in sync with debug_init call below</span><br><span> p.add_argument('-o', '--output', action='store_true', help="Log to STDOUT in addition to SYSLOG")</span><br><span> p.add_argument('-l', '--location', help="Location URL of the CGI server")</span><br><span> p.add_argument('-s', '--secret-key', help="Secret key used to generate verification token")</span><br><span> p.add_argument('-c', '--config-file', help="Path Config file. Cmd line args override values in config file")</span><br><span> args = p.parse_args()</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- log = logging.getLogger('CTRL2CGI')</span><br><span style="color: hsl(0, 100%, 40%);">- if args.debug:</span><br><span style="color: hsl(0, 100%, 40%);">- log.setLevel(logging.DEBUG)</span><br><span style="color: hsl(0, 100%, 40%);">- else:</span><br><span style="color: hsl(0, 100%, 40%);">- log.setLevel(logging.INFO)</span><br><span style="color: hsl(0, 100%, 40%);">- log.addHandler(logging.handlers.SysLogHandler('/dev/log'))</span><br><span style="color: hsl(0, 100%, 40%);">- if args.output:</span><br><span style="color: hsl(0, 100%, 40%);">- log.addHandler(logging.StreamHandler(sys.stdout))</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- reboot = partial(reloader, os.path.abspath(__file__), os.path.basename(__file__), log, '-d', '--debug') # keep in sync with add_argument() call above</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGHUP, reboot)</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGQUIT, reboot)</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGUSR1, reboot) # restart and enabled debug output</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGUSR2, reboot) # restart and disable debug output</span><br><span style="color: hsl(120, 100%, 40%);">+ log = debug_init('CTRL2CGI', args.debug, args.output)</span><br><span> </span><br><span> location_cfgfile = None</span><br><span> secret_key_cfgfile = None</span><br><span>diff --git a/scripts/soap.py b/scripts/soap.py</span><br><span>index dc06e1e..156157c 100755</span><br><span>--- a/scripts/soap.py</span><br><span>+++ b/scripts/soap.py</span><br><span>@@ -30,20 +30,13 @@</span><br><span> from treq import post, collect</span><br><span> from suds.client import Client</span><br><span> from functools import partial</span><br><span style="color: hsl(120, 100%, 40%);">+from osmopy.trap_helper import Trap, reloader, debug_init</span><br><span> from distutils.version import StrictVersion as V # FIXME: use NormalizedVersion from PEP-386 when available</span><br><span> import argparse, datetime, signal, sys, os, logging, logging.handlers</span><br><span> </span><br><span> # we don't support older versions of TwistedIPA module</span><br><span> assert V(twisted_ipa_version) > V('0.4')</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-# keys from OpenBSC openbsc/src/libbsc/bsc_rf_ctrl.c, values SOAP-specific</span><br><span style="color: hsl(0, 100%, 40%);">-oper = { 'inoperational' : 0, 'operational' : 1 }</span><br><span style="color: hsl(0, 100%, 40%);">-admin = { 'locked' : 0, 'unlocked' : 1 }</span><br><span style="color: hsl(0, 100%, 40%);">-policy = { 'off' : 0, 'on' : 1, 'grace' : 2, 'unknown' : 3 }</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-# keys from OpenBSC openbsc/src/libbsc/bsc_vty.c</span><br><span style="color: hsl(0, 100%, 40%);">-fix = { 'invalid' : 0, 'fix2d' : 1, 'fix3d' : 1 } # SOAP server treats it as boolean but expects int</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> </span><br><span> def handle_reply(p, f, log, r):</span><br><span> """</span><br><span>@@ -58,64 +51,6 @@</span><br><span> f(m)</span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-class Trap(CTRL):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- TRAP handler (agnostic to factory's client object)</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- def ctrl_TRAP(self, data, op_id, v):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Parse CTRL TRAP and dispatch to appropriate handler after normalization</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- (l, r) = v.split()</span><br><span style="color: hsl(0, 100%, 40%);">- loc = l.split('.')</span><br><span style="color: hsl(0, 100%, 40%);">- t_type = loc[-1]</span><br><span style="color: hsl(0, 100%, 40%);">- p = partial(lambda a, i: a[i] if len(a) > i else None, loc) # parse helper</span><br><span style="color: hsl(0, 100%, 40%);">- method = getattr(self, 'handle_' + t_type.replace('-', ''), lambda: "Unhandled %s trap" % t_type)</span><br><span style="color: hsl(0, 100%, 40%);">- method(p(1), p(3), p(5), p(7), r) # we expect net.0.bsc.666.bts.2.trx.1 format for trap prefix</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def ctrl_SET_REPLY(self, data, _, v):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Debug log for replies to our commands</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('SET REPLY %s' % v)</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def ctrl_ERROR(self, data, op_id, v):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- We want to know if smth went wrong</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('CTRL ERROR [%s] %s' % (op_id, v))</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def connectionMade(self):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Logging wrapper, calling super() is necessary not to break reconnection logic</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.info("Connected to CTRL@%s:%d" % (self.factory.host, self.factory.port))</span><br><span style="color: hsl(0, 100%, 40%);">- super(CTRL, self).connectionMade()</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- @defer.inlineCallbacks</span><br><span style="color: hsl(0, 100%, 40%);">- def handle_locationstate(self, net, bsc, bts, trx, data):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Handle location-state TRAP: parse trap content, build SOAP context and use treq's routines to post it while setting up async handlers</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- (ts, fx, lat, lon, height, opr, adm, pol, mcc, mnc) = data.split(',')</span><br><span style="color: hsl(0, 100%, 40%);">- tstamp = datetime.datetime.fromtimestamp(float(ts)).isoformat()</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('location-state@%s.%s.%s.%s (%s) [%s/%s] => %s' % (net, bsc, bts, trx, tstamp, mcc, mnc, data))</span><br><span style="color: hsl(0, 100%, 40%);">- ctx = self.factory.client.registerSiteLocation(bsc, float(lon), float(lat), fix.get(fx, 0), tstamp, oper.get(opr, 2), admin.get(adm, 2), policy.get(pol, 3))</span><br><span style="color: hsl(0, 100%, 40%);">- d = post(self.factory.location, ctx.envelope)</span><br><span style="color: hsl(0, 100%, 40%);">- d.addCallback(collect, partial(handle_reply, ctx.process_reply, self.transport.write, self.factory.log)) # treq's collect helper is handy to get all reply content at once using closure on ctx</span><br><span style="color: hsl(0, 100%, 40%);">- d.addErrback(lambda e, bsc: self.factory.log.critical("HTTP POST error %s while trying to register BSC %s" % (e, bsc)), bsc) # handle HTTP errors</span><br><span style="color: hsl(0, 100%, 40%);">- # Ensure that we run only limited number of requests in parallel:</span><br><span style="color: hsl(0, 100%, 40%);">- yield self.factory.semaphore.acquire()</span><br><span style="color: hsl(0, 100%, 40%);">- yield d # we end up here only if semaphore is available which means it's ok to fire the request without exceeding the limit</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.semaphore.release()</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- def handle_notificationrejectionv1(self, net, bsc, bts, trx, data):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Handle notification-rejection-v1 TRAP: just an example to show how more message types can be handled</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- self.factory.log.debug('notification-rejection-v1@bsc-id %s => %s' % (bsc, data))</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> class TrapFactory(IPAFactory):</span><br><span> """</span><br><span> Store SOAP client object so TRAP handler can use it for requests</span><br><span>@@ -140,21 +75,12 @@</span><br><span> self.log.setLevel(level)</span><br><span> self.log.debug("Using IPA %s, SUDS client: %s" % (Ctrl.version, soap))</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-def reloader(path, script, log, dbg1, dbg2, signum, _):</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- Signal handler: we have to use execl() because twisted's reactor is not restartable due to some bug in twisted implementation</span><br><span style="color: hsl(0, 100%, 40%);">- """</span><br><span style="color: hsl(0, 100%, 40%);">- log.info("Received Signal %d - restarting..." % signum)</span><br><span style="color: hsl(0, 100%, 40%);">- if signum == signal.SIGUSR1 and dbg1 not in sys.argv and dbg2 not in sys.argv:</span><br><span style="color: hsl(0, 100%, 40%);">- sys.argv.append(dbg1) # enforce debug</span><br><span style="color: hsl(0, 100%, 40%);">- if signum == signal.SIGUSR2 and (dbg1 in sys.argv or dbg2 in sys.argv): # disable debug</span><br><span style="color: hsl(0, 100%, 40%);">- if dbg1 in sys.argv:</span><br><span style="color: hsl(0, 100%, 40%);">- sys.argv.remove(dbg1)</span><br><span style="color: hsl(0, 100%, 40%);">- if dbg2 in sys.argv:</span><br><span style="color: hsl(0, 100%, 40%);">- sys.argv.remove(dbg2)</span><br><span style="color: hsl(0, 100%, 40%);">- os.execl(path, script, *sys.argv[1:])</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+ def prepare_params(bsc, lon, lat, fix, tstamp, oper, admin, policy):</span><br><span style="color: hsl(120, 100%, 40%);">+ ctx = self.factory.client.registerSiteLocation(bsc, float(lon), float(lat), fix, tstamp, oper, admin, policy)</span><br><span style="color: hsl(120, 100%, 40%);">+ d = post(self.factory.location, ctx.envelope)</span><br><span style="color: hsl(120, 100%, 40%);">+ # treq's collect helper is handy to get all reply content at once using closure on ctx:</span><br><span style="color: hsl(120, 100%, 40%);">+ d.addCallback(collect, partial(handle_reply, ctx.process_reply, self.transport.write, self.factory.log))</span><br><span style="color: hsl(120, 100%, 40%);">+ return d</span><br><span> </span><br><span> if __name__ == '__main__':</span><br><span> p = argparse.ArgumentParser(description='Proxy between given SOAP service and Osmocom CTRL protocol.')</span><br><span>@@ -163,25 +89,12 @@</span><br><span> p.add_argument('-c', '--ctrl', default='localhost', help="Adress to use for CTRL interface, defaults to localhost")</span><br><span> p.add_argument('-w', '--wsdl', required=True, help="WSDL URL for SOAP")</span><br><span> p.add_argument('-n', '--num', type=int, default=5, help="Max number of concurrent HTTP requests to SOAP server")</span><br><span style="color: hsl(0, 100%, 40%);">- p.add_argument('-d', '--debug', action='store_true', help="Enable debug log")</span><br><span style="color: hsl(120, 100%, 40%);">+ p.add_argument('-d', '--debug', action='store_true', help="Enable debug log") # keep in sync with debug_init call below</span><br><span> p.add_argument('-o', '--output', action='store_true', help="Log to STDOUT in addition to SYSLOG")</span><br><span> p.add_argument('-l', '--location', help="Override location found in WSDL file (don't use unless you know what you're doing)")</span><br><span> args = p.parse_args()</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- log = logging.getLogger('CTRL2SOAP')</span><br><span style="color: hsl(0, 100%, 40%);">- if args.debug:</span><br><span style="color: hsl(0, 100%, 40%);">- log.setLevel(logging.DEBUG)</span><br><span style="color: hsl(0, 100%, 40%);">- else:</span><br><span style="color: hsl(0, 100%, 40%);">- log.setLevel(logging.INFO)</span><br><span style="color: hsl(0, 100%, 40%);">- log.addHandler(logging.handlers.SysLogHandler('/dev/log'))</span><br><span style="color: hsl(0, 100%, 40%);">- if args.output:</span><br><span style="color: hsl(0, 100%, 40%);">- log.addHandler(logging.StreamHandler(sys.stdout))</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- reboot = partial(reloader, os.path.abspath(__file__), os.path.basename(__file__), log, '-d', '--debug') # keep in sync with add_argument() call above</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGHUP, reboot)</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGQUIT, reboot)</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGUSR1, reboot) # restart and enabled debug output</span><br><span style="color: hsl(0, 100%, 40%);">- signal.signal(signal.SIGUSR2, reboot) # restart and disable debug output</span><br><span style="color: hsl(120, 100%, 40%);">+ log = debug_init('CTRL2SOAP', args.debug, args.output)</span><br><span> </span><br><span> log.info("SOAP proxy %s starting with PID %d ..." % (__version__, os.getpid()))</span><br><span> reactor.connectTCP(args.ctrl, args.port, TrapFactory(args.ctrl, args.port, Trap, defer.DeferredSemaphore(args.num), log, args.wsdl, args.location))</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/11936">change 11936</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/11936"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: python/osmo-python-tests </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I7b59f2dbded9074d15f2d2f40bf5a92ed02601e2 </div>
<div style="display:none"> Gerrit-Change-Number: 11936 </div>
<div style="display:none"> Gerrit-PatchSet: 4 </div>
<div style="display:none"> Gerrit-Owner: Max <msuraev@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Max <msuraev@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Pau Espin Pedrol <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: daniel <dwillmann@sysmocom.de> </div>