Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 1 | # osmo_gsm_tester: Base class for Mobile Stations (MS) |
| 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 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 General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | from abc import ABCMeta, abstractmethod |
Pau Espin Pedrol | e1a58bd | 2020-04-10 20:46:07 +0200 | [diff] [blame] | 21 | from ..core import log |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 22 | from ..core import schema |
| 23 | |
| 24 | def on_register_schemas(): |
| 25 | resource_schema = { |
| 26 | 'type': schema.STR, |
| 27 | 'label': schema.STR, |
| 28 | 'path': schema.STR, |
| 29 | 'imsi': schema.IMSI, |
| 30 | 'ki': schema.KI, |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 31 | 'opc': schema.OPC, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 32 | 'auth_algo': schema.AUTH_ALGO, |
| 33 | 'apn_ipaddr': schema.IPV4, |
| 34 | 'ciphers[]': schema.CIPHER, |
| 35 | 'features[]': schema.MODEM_FEATURE |
| 36 | } |
| 37 | schema.register_resource_schema('modem', resource_schema) |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 38 | |
Andre Puschmann | 65a9e74 | 2020-11-20 11:48:38 +0100 | [diff] [blame] | 39 | config_schema = { |
| 40 | 'count': schema.UINT |
| 41 | } |
| 42 | schema.register_config_schema('modem', config_schema) |
| 43 | |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 44 | class MS(log.Origin, metaclass=ABCMeta): |
| 45 | """Base for everything about mobile/modem and SIMs.""" |
| 46 | |
Pau Espin Pedrol | 1ee5ec5 | 2020-05-04 17:16:39 +0200 | [diff] [blame] | 47 | ############## |
| 48 | # PROTECTED |
| 49 | ############## |
Pau Espin Pedrol | 83a2fdc | 2020-10-15 16:33:47 +0200 | [diff] [blame] | 50 | def __init__(self, name, testenv, conf): |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 51 | super().__init__(log.C_TST, name) |
Pau Espin Pedrol | 83a2fdc | 2020-10-15 16:33:47 +0200 | [diff] [blame] | 52 | self.testenv = testenv |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 53 | self._conf = conf |
Pau Espin Pedrol | 4b7c585 | 2020-10-14 14:48:21 +0200 | [diff] [blame] | 54 | self._msisdn = None |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 55 | |
Pau Espin Pedrol | 1ee5ec5 | 2020-05-04 17:16:39 +0200 | [diff] [blame] | 56 | ######################## |
| 57 | # PUBLIC - INTERNAL API |
| 58 | ######################## |
| 59 | @abstractmethod |
| 60 | def cleanup(self): |
| 61 | """Cleans up resources allocated.""" |
| 62 | pass |
| 63 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 64 | def get_instance_by_type(testenv, conf): |
Pau Espin Pedrol | 1ee5ec5 | 2020-05-04 17:16:39 +0200 | [diff] [blame] | 65 | """Allocate a MS child class based on type. Opts are passed to the newly created object.""" |
| 66 | ms_type = conf.get('type') |
| 67 | if ms_type is None: |
| 68 | # Map None to ofono for forward compability |
| 69 | ms_type = 'ofono' |
| 70 | |
| 71 | if ms_type == 'ofono': |
| 72 | from .ms_ofono import Modem |
| 73 | ms_class = Modem |
| 74 | elif ms_type == 'osmo-mobile': |
| 75 | from .ms_osmo_mobile import MSOsmoMobile |
| 76 | ms_class = MSOsmoMobile |
| 77 | elif ms_type == 'srsue': |
| 78 | from .ms_srs import srsUE |
| 79 | ms_class = srsUE |
| 80 | elif ms_type == 'amarisoftue': |
| 81 | from .ms_amarisoft import AmarisoftUE |
| 82 | ms_class = AmarisoftUE |
| 83 | else: |
| 84 | raise log.Error('MS type not supported:', ms_type) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 85 | return ms_class(testenv, conf) |
Pau Espin Pedrol | 1ee5ec5 | 2020-05-04 17:16:39 +0200 | [diff] [blame] | 86 | |
Andre Puschmann | 419a662 | 2020-05-27 18:46:12 +0200 | [diff] [blame] | 87 | @abstractmethod |
| 88 | def is_registered(self, mcc_mnc=None): |
| 89 | '''Check whether MS is considered registered with the target network. In |
| 90 | 2G networks, and MS is registered if it had a successful Location Update |
| 91 | in CS. In 4G networks, an UE is considered registered with the core |
| 92 | network if it has obtained and IP address. If MCC/MNC are given it tries |
| 93 | to manually register against that specific network.''' |
| 94 | pass |
| 95 | |
| 96 | @abstractmethod |
| 97 | def get_assigned_addr(self, ipv6=False): |
| 98 | ''' Returns last assigned IP address ''' |
| 99 | pass |
| 100 | |
Pau Espin Pedrol | 1ee5ec5 | 2020-05-04 17:16:39 +0200 | [diff] [blame] | 101 | ################### |
| 102 | # PUBLIC (test API included) |
| 103 | ################### |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 104 | def imsi(self): |
| 105 | return self._conf.get('imsi') |
| 106 | |
| 107 | def ki(self): |
| 108 | return self._conf.get('ki') |
| 109 | |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 110 | def opc(self): |
| 111 | return self._conf.get('opc', None) |
| 112 | |
Andre Puschmann | 22ec00a | 2020-03-24 09:58:06 +0100 | [diff] [blame] | 113 | def apn_ipaddr(self): |
| 114 | return self._conf.get('apn_ipaddr', 'dynamic') |
| 115 | |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 116 | def auth_algo(self): |
| 117 | return self._conf.get('auth_algo', None) |
| 118 | |
| 119 | def set_msisdn(self, msisdn): |
Pau Espin Pedrol | 4b7c585 | 2020-10-14 14:48:21 +0200 | [diff] [blame] | 120 | self._msisdn = msisdn |
Holger Hans Peter Freyther | 48c83a8 | 2019-02-27 08:27:46 +0000 | [diff] [blame] | 121 | |
| 122 | def msisdn(self): |
Pau Espin Pedrol | 83a2fdc | 2020-10-15 16:33:47 +0200 | [diff] [blame] | 123 | # If none was set, allocate next one available: |
| 124 | if self._msisdn is None: |
| 125 | self.set_msisdn(self.testenv.msisdn()) |
Pau Espin Pedrol | 4b7c585 | 2020-10-14 14:48:21 +0200 | [diff] [blame] | 126 | return self._msisdn |
Pau Espin Pedrol | eaefe6b | 2020-04-20 13:29:59 +0200 | [diff] [blame] | 127 | |
Pau Espin Pedrol | 680ba03 | 2020-10-14 14:49:05 +0200 | [diff] [blame] | 128 | def emergency_numbers(self): |
| 129 | return ['112'] |
| 130 | |
Pau Espin Pedrol | eaefe6b | 2020-04-20 13:29:59 +0200 | [diff] [blame] | 131 | def get_counter(self, counter_name): |
| 132 | raise log.Error('get_counter() not implemented!') |
Andre Puschmann | 65a9e74 | 2020-11-20 11:48:38 +0100 | [diff] [blame] | 133 | |
| 134 | def features(self): |
| 135 | return self._conf.get('features', []) |