Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: DBUS client to talk to ofono |
| 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 |
| 8 | # it under the terms of the GNU Affero General Public License as |
| 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 |
| 15 | # GNU Affero General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU Affero General Public License |
| 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 20 | from . import log, test |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 21 | |
| 22 | from pydbus import SystemBus, Variant |
| 23 | import time |
| 24 | import pprint |
| 25 | |
| 26 | from gi.repository import GLib |
| 27 | glib_main_loop = GLib.MainLoop() |
| 28 | glib_main_ctx = glib_main_loop.get_context() |
| 29 | bus = SystemBus() |
| 30 | |
Pau Espin Pedrol | 504a664 | 2017-05-04 11:38:23 +0200 | [diff] [blame] | 31 | I_MODEM = 'org.ofono.Modem' |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 32 | I_NETREG = 'org.ofono.NetworkRegistration' |
| 33 | I_SMS = 'org.ofono.MessageManager' |
| 34 | |
Neels Hofmeyr | 035cda8 | 2017-05-05 17:52:45 +0200 | [diff] [blame] | 35 | class DeferredHandling: |
| 36 | defer_queue = [] |
| 37 | |
| 38 | def __init__(self, dbus_iface, handler): |
| 39 | self.handler = handler |
| 40 | dbus_iface.connect(self.receive_signal) |
| 41 | |
| 42 | def receive_signal(self, *args, **kwargs): |
| 43 | DeferredHandling.defer_queue.append((self.handler, args, kwargs)) |
| 44 | |
| 45 | @staticmethod |
| 46 | def handle_queue(): |
| 47 | while DeferredHandling.defer_queue: |
| 48 | handler, args, kwargs = DeferredHandling.defer_queue.pop(0) |
| 49 | handler(*args, **kwargs) |
| 50 | |
| 51 | def dbus_connect(dbus_iface, handler): |
| 52 | '''This function shall be used instead of directly connecting DBus signals. |
| 53 | It ensures that we don't nest a glib main loop within another, and also |
| 54 | that we receive exceptions raised within the signal handlers. This makes it |
| 55 | so that a signal handler is invoked only after the DBus polling is through |
| 56 | by enlisting signals that should be handled in the |
| 57 | DeferredHandling.defer_queue.''' |
| 58 | DeferredHandling(dbus_iface, handler) |
| 59 | |
| 60 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 61 | def poll(): |
| 62 | global glib_main_ctx |
| 63 | while glib_main_ctx.pending(): |
| 64 | glib_main_ctx.iteration() |
Neels Hofmeyr | 035cda8 | 2017-05-05 17:52:45 +0200 | [diff] [blame] | 65 | DeferredHandling.handle_queue() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 66 | |
Neels Hofmeyr | 93f5866 | 2017-05-03 16:32:16 +0200 | [diff] [blame] | 67 | def systembus_get(path): |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 68 | global bus |
| 69 | return bus.get('org.ofono', path) |
| 70 | |
| 71 | def list_modems(): |
Neels Hofmeyr | 93f5866 | 2017-05-03 16:32:16 +0200 | [diff] [blame] | 72 | root = systembus_get('/') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 73 | return sorted(root.GetModems()) |
| 74 | |
| 75 | |
| 76 | class Modem(log.Origin): |
| 77 | 'convenience for ofono Modem interaction' |
| 78 | msisdn = None |
Neels Hofmeyr | fec7d16 | 2017-05-02 16:29:09 +0200 | [diff] [blame] | 79 | sms_received_list = None |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 80 | |
| 81 | def __init__(self, conf): |
| 82 | self.conf = conf |
| 83 | self.path = conf.get('path') |
| 84 | self.set_name(self.path) |
| 85 | self.set_log_category(log.C_BUS) |
| 86 | self._dbus_obj = None |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 87 | self._interfaces = set() |
Neels Hofmeyr | fec7d16 | 2017-05-02 16:29:09 +0200 | [diff] [blame] | 88 | self.sms_received_list = [] |
Pau Espin Pedrol | 107f275 | 2017-05-04 11:37:16 +0200 | [diff] [blame] | 89 | # init interfaces and connect to signals: |
| 90 | self.dbus_obj() |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 91 | test.poll() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 92 | |
| 93 | def set_msisdn(self, msisdn): |
| 94 | self.msisdn = msisdn |
| 95 | |
| 96 | def imsi(self): |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 97 | imsi = self.conf.get('imsi') |
| 98 | if not imsi: |
| 99 | with self: |
| 100 | raise RuntimeError('No IMSI') |
| 101 | return imsi |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 102 | |
| 103 | def ki(self): |
| 104 | return self.conf.get('ki') |
| 105 | |
Pau Espin Pedrol | 504a664 | 2017-05-04 11:38:23 +0200 | [diff] [blame] | 106 | def _dbus_set_bool(self, name, bool_val, iface=I_MODEM): |
Neels Hofmeyr | 9dbcb82 | 2017-05-02 14:57:57 +0200 | [diff] [blame] | 107 | # to make sure any pending signals are received before we send out more DBus requests |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 108 | test.poll() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 109 | |
Neels Hofmeyr | 9dbcb82 | 2017-05-02 14:57:57 +0200 | [diff] [blame] | 110 | val = bool(bool_val) |
| 111 | self.log('Setting', name, val) |
Pau Espin Pedrol | 504a664 | 2017-05-04 11:38:23 +0200 | [diff] [blame] | 112 | self.dbus_obj()[iface].SetProperty(name, Variant('b', val)) |
Neels Hofmeyr | 9dbcb82 | 2017-05-02 14:57:57 +0200 | [diff] [blame] | 113 | |
Neels Hofmeyr | 27d459c | 2017-05-02 16:30:18 +0200 | [diff] [blame] | 114 | test.wait(self.property_is, name, bool_val) |
| 115 | |
| 116 | def property_is(self, name, val): |
| 117 | is_val = self.properties().get(name) |
| 118 | self.dbg(name, '==', is_val) |
| 119 | return is_val is not None and is_val == val |
Neels Hofmeyr | 9dbcb82 | 2017-05-02 14:57:57 +0200 | [diff] [blame] | 120 | |
| 121 | def set_powered(self, on=True): |
| 122 | self._dbus_set_bool('Powered', on) |
| 123 | |
Pau Espin Pedrol | b995576 | 2017-05-02 09:39:27 +0200 | [diff] [blame] | 124 | def set_online(self, on=True): |
Neels Hofmeyr | 9dbcb82 | 2017-05-02 14:57:57 +0200 | [diff] [blame] | 125 | self._dbus_set_bool('Online', on) |
Pau Espin Pedrol | b995576 | 2017-05-02 09:39:27 +0200 | [diff] [blame] | 126 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 127 | def dbus_obj(self): |
| 128 | if self._dbus_obj is not None: |
| 129 | return self._dbus_obj |
Neels Hofmeyr | 93f5866 | 2017-05-03 16:32:16 +0200 | [diff] [blame] | 130 | self._dbus_obj = systembus_get(self.path) |
Neels Hofmeyr | 035cda8 | 2017-05-05 17:52:45 +0200 | [diff] [blame] | 131 | dbus_connect(self._dbus_obj.PropertyChanged, self._on_property_change) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 132 | self._on_interfaces_change(self.properties().get('Interfaces')) |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 133 | return self._dbus_obj |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 134 | |
Pau Espin Pedrol | 504a664 | 2017-05-04 11:38:23 +0200 | [diff] [blame] | 135 | def properties(self, iface=I_MODEM): |
| 136 | return self.dbus_obj()[iface].GetProperties() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 137 | |
| 138 | def _on_property_change(self, name, value): |
| 139 | if name == 'Interfaces': |
| 140 | self._on_interfaces_change(value) |
| 141 | |
| 142 | def _on_interfaces_change(self, interfaces_now): |
| 143 | now = set(interfaces_now) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 144 | additions = now - self._interfaces |
| 145 | removals = self._interfaces - now |
| 146 | self._interfaces = now |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 147 | for iface in removals: |
Neels Hofmeyr | 5a602b7 | 2017-05-06 22:45:15 +0200 | [diff] [blame] | 148 | self._on_interface_disabled(iface) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 149 | for iface in additions: |
Neels Hofmeyr | 5a602b7 | 2017-05-06 22:45:15 +0200 | [diff] [blame] | 150 | self._on_interface_enabled(iface) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 151 | |
| 152 | def _on_interface_enabled(self, interface_name): |
| 153 | self.dbg('Interface enabled:', interface_name) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 154 | if interface_name == I_SMS: |
Neels Hofmeyr | 943f8a2 | 2017-05-03 17:37:53 +0200 | [diff] [blame] | 155 | retries = 3 |
Neels Hofmeyr | 5fe8881 | 2017-05-03 17:20:17 +0200 | [diff] [blame] | 156 | while True: |
Neels Hofmeyr | 5fe8881 | 2017-05-03 17:20:17 +0200 | [diff] [blame] | 157 | try: |
Neels Hofmeyr | 035cda8 | 2017-05-05 17:52:45 +0200 | [diff] [blame] | 158 | dbus_connect(self.dbus_obj()[I_SMS].IncomingMessage, self._on_incoming_message) |
Neels Hofmeyr | 5fe8881 | 2017-05-03 17:20:17 +0200 | [diff] [blame] | 159 | break |
Neels Hofmeyr | 035cda8 | 2017-05-05 17:52:45 +0200 | [diff] [blame] | 160 | except KeyError: |
Neels Hofmeyr | 5fe8881 | 2017-05-03 17:20:17 +0200 | [diff] [blame] | 161 | self.dbg('Interface not yet available:', I_SMS) |
| 162 | retries -= 1 |
| 163 | time.sleep(1) |
| 164 | if retries <= 0: |
| 165 | self.err('Interface enabled by signal, but not available:', I_SMS) |
| 166 | raise |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 167 | |
| 168 | def _on_interface_disabled(self, interface_name): |
| 169 | self.dbg('Interface disabled:', interface_name) |
| 170 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 171 | def has_interface(self, name): |
| 172 | return name in self._interfaces |
| 173 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 174 | def connect(self, nitb): |
| 175 | 'set the modem up to connect to MCC+MNC from NITB config' |
| 176 | self.log('connect to', nitb) |
Pau Espin Pedrol | 107f275 | 2017-05-04 11:37:16 +0200 | [diff] [blame] | 177 | prepowered = self.properties().get('Powered') |
| 178 | if prepowered is not None and prepowered: |
| 179 | self.set_online(False) |
| 180 | self.set_powered(False) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 181 | self.set_powered() |
Pau Espin Pedrol | b995576 | 2017-05-02 09:39:27 +0200 | [diff] [blame] | 182 | self.set_online() |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 183 | if not self.has_interface(I_NETREG): |
| 184 | self.log('No %r interface, hoping that the modem connects by itself' % I_NETREG) |
| 185 | else: |
| 186 | self.log('Use of %r interface not implemented yet, hoping that the modem connects by itself' % I_NETREG) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 187 | |
Neels Hofmeyr | 8d8b03e | 2017-05-06 18:19:46 +0200 | [diff] [blame] | 188 | def sms_send(self, to_msisdn, *tokens): |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 189 | if hasattr(to_msisdn, 'msisdn'): |
| 190 | to_msisdn = to_msisdn.msisdn |
Neels Hofmeyr | 8d8b03e | 2017-05-06 18:19:46 +0200 | [diff] [blame] | 191 | sms = Sms(self.msisdn, to_msisdn, 'from ' + self.name(), *tokens) |
Neels Hofmeyr | 1ea59ea | 2017-05-02 14:41:54 +0200 | [diff] [blame] | 192 | self.log('sending sms to MSISDN', to_msisdn, sms=sms) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 193 | if not self.has_interface(I_SMS): |
| 194 | raise RuntimeError('Modem cannot send SMS, interface not active: %r' % I_SMS) |
Neels Hofmeyr | b02c211 | 2017-04-09 18:46:48 +0200 | [diff] [blame] | 195 | mm = self.dbus_obj()[I_SMS] |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 196 | mm.SendMessage(to_msisdn, str(sms)) |
| 197 | return sms |
| 198 | |
| 199 | def _on_incoming_message(self, message, info): |
Neels Hofmeyr | 2e41def | 2017-05-06 22:42:57 +0200 | [diff] [blame] | 200 | self.log('Incoming SMS:', repr(message)) |
Neels Hofmeyr | f49c7da | 2017-05-06 22:43:32 +0200 | [diff] [blame] | 201 | self.dbg(info=info) |
Neels Hofmeyr | fec7d16 | 2017-05-02 16:29:09 +0200 | [diff] [blame] | 202 | self.sms_received_list.append((message, info)) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 203 | |
Neels Hofmeyr | 863cb56 | 2017-05-02 16:27:59 +0200 | [diff] [blame] | 204 | def sms_was_received(self, sms): |
Neels Hofmeyr | fec7d16 | 2017-05-02 16:29:09 +0200 | [diff] [blame] | 205 | for msg, info in self.sms_received_list: |
| 206 | if sms.matches(msg): |
Neels Hofmeyr | 2e41def | 2017-05-06 22:42:57 +0200 | [diff] [blame] | 207 | self.log('SMS received as expected:', repr(msg)) |
Neels Hofmeyr | f49c7da | 2017-05-06 22:43:32 +0200 | [diff] [blame] | 208 | self.dbg(info=info) |
Neels Hofmeyr | fec7d16 | 2017-05-02 16:29:09 +0200 | [diff] [blame] | 209 | return True |
| 210 | return False |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 211 | |
| 212 | class Sms: |
| 213 | _last_sms_idx = 0 |
| 214 | msg = None |
| 215 | |
Neels Hofmeyr | 8d8b03e | 2017-05-06 18:19:46 +0200 | [diff] [blame] | 216 | def __init__(self, from_msisdn=None, to_msisdn=None, *tokens): |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 217 | Sms._last_sms_idx += 1 |
| 218 | msgs = ['message nr. %d' % Sms._last_sms_idx] |
Neels Hofmeyr | 8d8b03e | 2017-05-06 18:19:46 +0200 | [diff] [blame] | 219 | msgs.extend(tokens) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 220 | if from_msisdn: |
Neels Hofmeyr | 8d8b03e | 2017-05-06 18:19:46 +0200 | [diff] [blame] | 221 | msgs.append('from %s' % from_msisdn) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 222 | if to_msisdn: |
Neels Hofmeyr | 8d8b03e | 2017-05-06 18:19:46 +0200 | [diff] [blame] | 223 | msgs.append('to %s' % to_msisdn) |
| 224 | self.msg = ', '.join(msgs) |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 225 | |
| 226 | def __str__(self): |
| 227 | return self.msg |
| 228 | |
Neels Hofmeyr | fec7d16 | 2017-05-02 16:29:09 +0200 | [diff] [blame] | 229 | def __repr__(self): |
| 230 | return repr(self.msg) |
| 231 | |
Neels Hofmeyr | b3daaea | 2017-04-09 14:18:34 +0200 | [diff] [blame] | 232 | def __eq__(self, other): |
| 233 | if isinstance(other, Sms): |
| 234 | return self.msg == other.msg |
| 235 | return inself.msg == other |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 236 | |
Neels Hofmeyr | fec7d16 | 2017-05-02 16:29:09 +0200 | [diff] [blame] | 237 | def matches(self, msg): |
| 238 | return self.msg == msg |
| 239 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 240 | # vim: expandtab tabstop=4 shiftwidth=4 |