Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an SRS EPC process |
| 2 | # |
| 3 | # Copyright (C) 2020 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Pau Espin Pedrol <pespin@sysmocom.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 | import os |
| 21 | import pprint |
Andre Puschmann | 0acc75c | 2021-03-08 16:32:28 +0100 | [diff] [blame] | 22 | import time |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 23 | |
Pau Espin Pedrol | e1a58bd | 2020-04-10 20:46:07 +0200 | [diff] [blame] | 24 | from ..core import log, util, config, template, process, remote |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 25 | from ..core import schema |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 26 | from . import epc |
| 27 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 28 | def on_register_schemas(): |
| 29 | config_schema = { |
| 30 | 'license_server_addr': schema.IPV4, |
| 31 | } |
| 32 | schema.register_config_schema('amarisoft', config_schema) |
| 33 | |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 34 | class AmarisoftEPC(epc.EPC): |
| 35 | |
| 36 | REMOTE_DIR = '/osmo-gsm-tester-amarisoftepc' |
| 37 | BINFILE = 'ltemme' |
| 38 | CFGFILE = 'amarisoft_ltemme.cfg' |
| 39 | LOGFILE = 'ltemme.log' |
| 40 | IFUPFILE = 'mme-ifup' |
Andre Puschmann | 0acc75c | 2021-03-08 16:32:28 +0100 | [diff] [blame] | 41 | LTESIM_BINFILE = 'ltesim_server' |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 42 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 43 | def __init__(self, testenv, run_node): |
| 44 | super().__init__(testenv, run_node, 'amarisoftepc') |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 45 | self.run_dir = None |
| 46 | self.config_file = None |
| 47 | self.log_file = None |
| 48 | self.ifup_file = None |
| 49 | self.process = None |
| 50 | self.rem_host = None |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 51 | self.remote_run_dir = None |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 52 | self.remote_inst = None |
| 53 | self.remote_config_file = None |
| 54 | self.remote_log_file = None |
Andre Puschmann | 0acc75c | 2021-03-08 16:32:28 +0100 | [diff] [blame] | 55 | self.remote_ifup_file = None |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 56 | self._bin_prefix = None |
| 57 | self.inst = None |
| 58 | self.subscriber_list = [] |
| 59 | |
| 60 | def bin_prefix(self): |
| 61 | if self._bin_prefix is None: |
Pau Espin Pedrol | 17253af | 2020-04-02 21:11:19 +0200 | [diff] [blame] | 62 | self._bin_prefix = os.getenv('AMARISOFT_PATH_EPC', None) |
| 63 | if self._bin_prefix == None: |
Pau Espin Pedrol | e921995 | 2020-05-25 20:04:52 +0200 | [diff] [blame] | 64 | self._bin_prefix = self.testenv.suite().trial().get_inst('amarisoftepc', self._run_node.run_label()) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 65 | return self._bin_prefix |
| 66 | |
| 67 | def cleanup(self): |
| 68 | if self.process is None: |
| 69 | return |
| 70 | if self._run_node.is_local(): |
| 71 | return |
| 72 | # copy back files (may not exist, for instance if there was an early error of process): |
| 73 | try: |
| 74 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 75 | except Exception as e: |
| 76 | self.log(repr(e)) |
| 77 | |
| 78 | def start(self): |
| 79 | self.log('Starting amarisoftepc') |
Pau Espin Pedrol | 2a2d846 | 2020-05-11 10:56:52 +0200 | [diff] [blame] | 80 | self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name())) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 81 | self.configure() |
| 82 | if self._run_node.is_local(): |
| 83 | self.start_locally() |
| 84 | else: |
| 85 | self.start_remotely() |
Andre Puschmann | 0acc75c | 2021-03-08 16:32:28 +0100 | [diff] [blame] | 86 | self.start_ltesim_remotely() |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 87 | |
| 88 | def start_remotely(self): |
| 89 | remote_binary = self.remote_inst.child('', AmarisoftEPC.BINFILE) |
| 90 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 91 | self.log('Setting RPATH for amarisoftepc') |
| 92 | self.rem_host.change_elf_rpath(remote_binary, str(self.remote_inst)) |
| 93 | # amarisoftepc requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 94 | self.log('Applying CAP_NET_ADMIN capability to amarisoftepc') |
| 95 | self.rem_host.setcap_net_admin(remote_binary) |
| 96 | |
| 97 | args = (remote_binary, self.remote_config_file) |
| 98 | |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 99 | self.process = self.rem_host.RemoteProcessSafeExit(AmarisoftEPC.BINFILE, self.remote_run_dir, args) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 100 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 101 | self.process.launch() |
| 102 | |
| 103 | def start_locally(self): |
| 104 | binary = self.inst.child('', BINFILE) |
| 105 | |
| 106 | env = {} |
| 107 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 108 | self.log('Setting RPATH for amarisoftepc') |
| 109 | util.change_elf_rpath(binary, util.prepend_library_path(str(self.inst)), self.run_dir.new_dir('patchelf')) |
| 110 | # amarisoftepc requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 111 | self.log('Applying CAP_NET_ADMIN capability to amarisoftepc') |
| 112 | util.setcap_net_admin(binary, self.run_dir.new_dir('setcap_net_admin')) |
| 113 | |
| 114 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 115 | args = (binary, os.path.abspath(self.config_file)) |
| 116 | |
| 117 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 118 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 119 | self.process.launch() |
| 120 | |
Andre Puschmann | 0acc75c | 2021-03-08 16:32:28 +0100 | [diff] [blame] | 121 | def start_ltesim_remotely(self): |
| 122 | # Sleep for a moment to give MME time to start up create TUN device |
| 123 | time.sleep(5) |
| 124 | remote_binary = self.remote_inst.child('', AmarisoftEPC.LTESIM_BINFILE) |
| 125 | args = (remote_binary, "-a " + self.tun_addr()) |
| 126 | self.log('Launching ltesim_server') |
| 127 | self.ltesim_process = self.rem_host.RemoteProcess(AmarisoftEPC.LTESIM_BINFILE, args) |
| 128 | self.testenv.remember_to_stop(self.ltesim_process) |
| 129 | self.ltesim_process.launch() |
| 130 | |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 131 | def configure(self): |
| 132 | self.inst = util.Dir(os.path.abspath(self.bin_prefix())) |
| 133 | if not self.inst.isfile('', AmarisoftEPC.BINFILE): |
| 134 | raise log.Error('No %s binary in' % AmarisoftEPC.BINFILE, self.inst) |
| 135 | |
| 136 | self.config_file = self.run_dir.child(AmarisoftEPC.CFGFILE) |
| 137 | self.log_file = self.run_dir.child(AmarisoftEPC.LOGFILE) |
| 138 | self.ifup_file = self.run_dir.new_file(AmarisoftEPC.IFUPFILE) |
| 139 | os.chmod(self.ifup_file, 0o744) # add execution permission |
| 140 | self.dbg(config_file=self.config_file) |
| 141 | with open(self.ifup_file, 'w') as f: |
| 142 | r = '''#!/bin/sh |
| 143 | set -x -e |
| 144 | # script + sudoers file available in osmo-gsm-tester.git/utils/{bin,sudoers.d} |
| 145 | sudo /usr/local/bin/osmo-gsm-tester_amarisoft_ltemme_ifup.sh "$@" |
| 146 | ''' |
| 147 | f.write(r) |
| 148 | |
| 149 | if not self._run_node.is_local(): |
| 150 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr()) |
| 151 | remote_prefix_dir = util.Dir(AmarisoftEPC.REMOTE_DIR) |
| 152 | self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 153 | self.remote_run_dir = util.Dir(remote_prefix_dir.child(AmarisoftEPC.BINFILE)) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 154 | |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 155 | self.remote_config_file = self.remote_run_dir.child(AmarisoftEPC.CFGFILE) |
| 156 | self.remote_log_file = self.remote_run_dir.child(AmarisoftEPC.LOGFILE) |
| 157 | self.remote_ifup_file = self.remote_run_dir.child(AmarisoftEPC.IFUPFILE) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 158 | |
Pau Espin Pedrol | c04528c | 2020-04-01 13:55:51 +0200 | [diff] [blame] | 159 | values = super().configure(['amarisoft', 'amarisoftepc']) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 160 | |
| 161 | logfile = self.log_file if self._run_node.is_local() else self.remote_log_file |
| 162 | ifupfile = self.ifup_file if self._run_node.is_local() else self.remote_ifup_file |
| 163 | config.overlay(values, dict(epc=dict(log_filename=logfile, |
| 164 | ifup_filename=ifupfile))) |
| 165 | |
Andre Puschmann | 0e72f9d | 2021-01-28 21:22:01 +0100 | [diff] [blame] | 166 | # Retrieve and overlay UE count parameter to first subscriber |
| 167 | sub_count = self.testenv.suite().config().get('modem', None) |
| 168 | sub_count = sub_count['count'] if sub_count is not None and 'count' in sub_count else 1 |
| 169 | self.subscriber_list[0]['count'] = sub_count |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 170 | config.overlay(values, dict(epc=dict(hss=dict(subscribers=self.subscriber_list)))) |
| 171 | |
| 172 | self.dbg('SRSEPC CONFIG:\n' + pprint.pformat(values)) |
| 173 | |
| 174 | with open(self.config_file, 'w') as f: |
| 175 | r = template.render(AmarisoftEPC.CFGFILE, values) |
| 176 | self.dbg(r) |
| 177 | f.write(r) |
| 178 | |
| 179 | if not self._run_node.is_local(): |
| 180 | self.rem_host.recreate_remote_dir(self.remote_inst) |
| 181 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 182 | self.rem_host.recreate_remote_dir(self.remote_run_dir) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 183 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 184 | self.rem_host.scp('scp-ifup-to-remote', self.ifup_file, self.remote_ifup_file) |
| 185 | |
| 186 | def subscriber_add(self, modem, msisdn=None, algo_str=None): |
| 187 | if msisdn is None: |
Pau Espin Pedrol | 83a2fdc | 2020-10-15 16:33:47 +0200 | [diff] [blame] | 188 | msisdn = modem.msisdn() |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 189 | |
| 190 | if algo_str is None: |
| 191 | algo_str = modem.auth_algo() or util.OSMO_AUTH_ALGO_NONE |
| 192 | |
| 193 | if algo_str != util.OSMO_AUTH_ALGO_NONE and not modem.ki(): |
| 194 | raise log.Error("Auth algo %r selected but no KI specified" % algo_str) |
| 195 | |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 196 | if algo_str == 'milenage' and not modem.opc(): |
| 197 | raise log.Error("Auth algo milenage selected but no OPC specified") |
| 198 | |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 199 | subscriber_id = len(self.subscriber_list) # list index |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 200 | self.subscriber_list.append({'id': subscriber_id, 'imsi': modem.imsi(), 'msisdn': msisdn, 'auth_algo': algo_str, 'ki': modem.ki(), 'opc': modem.opc(), 'apn_ipaddr': modem.apn_ipaddr()}) |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 201 | |
| 202 | self.log('Add subscriber', msisdn=msisdn, imsi=modem.imsi(), subscriber_id=subscriber_id, |
| 203 | algo_str=algo_str) |
| 204 | return subscriber_id |
| 205 | |
| 206 | def enb_is_connected(self, enb): |
| 207 | # TODO: improve this a bit, like matching IP addr of enb. CTRL iface? |
| 208 | # The string is only available in log file, not in stdout: |
| 209 | #return 'S1 setup response' in (self.process.get_stdout() or '') |
| 210 | return True |
| 211 | |
| 212 | def running(self): |
| 213 | return not self.process.terminated() |
| 214 | |
| 215 | def tun_addr(self): |
| 216 | # TODO: set proper addr |
| 217 | return '192.168.4.1' |
| 218 | |
Andre Puschmann | 3ce6725 | 2021-01-29 17:45:18 +0100 | [diff] [blame] | 219 | def get_kpis(self): |
| 220 | return {} |
| 221 | |
Pau Espin Pedrol | da2e31f | 2020-03-31 13:45:01 +0200 | [diff] [blame] | 222 | # vim: expandtab tabstop=4 shiftwidth=4 |