Pau Espin Pedrol | 0696c60 | 2021-03-16 14:25:37 +0100 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an Open5GS mmed process |
| 2 | # |
| 3 | # Copyright (C) 2021 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 |
| 22 | |
| 23 | from ..core import log, util, config, template, process, remote |
| 24 | from ..core import schema |
| 25 | from . import epc |
| 26 | |
| 27 | def on_register_schemas(): |
| 28 | pass |
| 29 | |
| 30 | class Open5gsMME(log.Origin): |
| 31 | |
| 32 | REMOTE_DIR = '/osmo-gsm-tester-open5gs' |
| 33 | BINFILE = 'open5gs-mmed' |
| 34 | CFGFILE = 'open5gs-mmed.yaml' |
| 35 | LOGFILE = 'open5gs-mmed.log' |
| 36 | DIAMETERFILE = 'open5gs-freediameter.conf' |
| 37 | |
| 38 | def __init__(self, testenv, o5gs_epc): |
| 39 | super().__init__(log.C_RUN, 'open5gs-mmed') |
| 40 | self.testenv = testenv |
| 41 | self.o5gs_epc = o5gs_epc |
| 42 | self._run_node = o5gs_epc.run_node() |
| 43 | self.run_dir = None |
| 44 | self.config_file = None |
| 45 | self.log_file = None |
| 46 | self.diameter_file = None |
| 47 | self.process = None |
| 48 | self.rem_host = None |
| 49 | self.remote_inst = None |
| 50 | self.remote_config_file = None |
| 51 | self.remote_log_file = None |
| 52 | self.remote_diameter_file = None |
| 53 | |
| 54 | def cleanup(self): |
| 55 | if self.process is None: |
| 56 | return |
| 57 | if self._run_node.is_local(): |
| 58 | return |
| 59 | # copy back files (may not exist, for instance if there was an early error of process): |
| 60 | try: |
| 61 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 62 | except Exception as e: |
| 63 | self.log(repr(e)) |
| 64 | |
| 65 | def start(self): |
| 66 | self.log('Starting %s' % Open5gsMME.BINFILE) |
| 67 | if self._run_node.is_local(): |
| 68 | self.start_locally() |
| 69 | else: |
| 70 | self.start_remotely() |
| 71 | |
| 72 | def start_remotely(self): |
| 73 | remote_lib = self.remote_inst.child('lib') |
| 74 | remote_binary = self.remote_inst.child('bin', Open5gsMME.BINFILE) |
| 75 | |
| 76 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 77 | self.log('Setting RPATH for open5gs-mmed') |
| 78 | self.rem_host.change_elf_rpath(remote_binary, remote_lib) |
| 79 | # open5gs-mmed requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 80 | self.log('Applying CAP_NET_ADMIN capability to open5gs-mmed') |
| 81 | self.rem_host.setcap_net_admin(remote_binary) |
| 82 | |
| 83 | args = (remote_binary, '-c', self.remote_config_file) |
| 84 | |
| 85 | self.process = self.rem_host.RemoteProcess(Open5gsMME.BINFILE, args) |
| 86 | self.testenv.remember_to_stop(self.process) |
| 87 | self.process.launch() |
| 88 | |
| 89 | def start_locally(self): |
| 90 | binary = self.inst.child('bin', Open5gsMME.BINFILE) |
| 91 | lib = self.inst.child('lib') |
| 92 | env = {} |
| 93 | |
| 94 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 95 | self.log('Setting RPATH for open5gs-mmed') |
| 96 | # open5gs-mmed binary needs patchelf <= 0.9 (0.10 and current master fail) to avoid failing during patch. OS#4389, patchelf-GH#192. |
| 97 | util.change_elf_rpath(binary, util.prepend_library_path(lib), self.run_dir.new_dir('patchelf')) |
| 98 | # open5gs-mmed requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 99 | self.log('Applying CAP_NET_ADMIN capability to open5gs-mmed') |
| 100 | util.setcap_net_admin(binary, self.run_dir.new_dir('setcap_net_admin')) |
| 101 | |
| 102 | args = (binary, '-c', os.path.abspath(self.config_file)) |
| 103 | |
| 104 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
| 105 | self.testenv.remember_to_stop(self.process) |
| 106 | self.process.launch() |
| 107 | |
| 108 | def configure(self, values): |
| 109 | self.run_dir = util.Dir(self.o5gs_epc.run_dir.new_dir(self.name())) |
| 110 | self.inst = util.Dir(os.path.abspath(self.testenv.suite().trial().get_inst('open5gs', self._run_node.run_label()))) |
| 111 | if not os.path.isdir(self.inst.child('lib')): |
| 112 | raise log.Error('No lib/ in', self.inst) |
| 113 | if not self.inst.isfile('bin', Open5gsMME.BINFILE): |
| 114 | raise log.Error('No %s binary in' % Open5gsMME.BINFILE, self.inst) |
| 115 | |
| 116 | self.config_file = self.run_dir.child(Open5gsMME.CFGFILE) |
| 117 | self.log_file = self.run_dir.child(Open5gsMME.LOGFILE) |
| 118 | self.diameter_file = self.run_dir.child(Open5gsMME.DIAMETERFILE) |
| 119 | |
| 120 | if not self._run_node.is_local(): |
| 121 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr()) |
| 122 | remote_prefix_dir = util.Dir(Open5gsMME.REMOTE_DIR) |
| 123 | self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
| 124 | remote_run_dir = util.Dir(remote_prefix_dir.child(Open5gsMME.BINFILE)) |
| 125 | |
| 126 | self.remote_config_file = remote_run_dir.child(Open5gsMME.CFGFILE) |
| 127 | self.remote_log_file = remote_run_dir.child(Open5gsMME.LOGFILE) |
| 128 | self.remote_diameter_file = remote_run_dir.child(Open5gsMME.DIAMETERFILE) |
| 129 | |
| 130 | logfile = self.log_file if self._run_node.is_local() else self.remote_log_file |
| 131 | diameter_file = self.diameter_file if self._run_node.is_local() else self.remote_diameter_file |
| 132 | inst_prefix = str(self.inst) if self._run_node.is_local() else str(self.remote_inst) |
| 133 | config.overlay(values, dict(mme=dict(log_filename=logfile, |
| 134 | diameter_filename=diameter_file, |
| 135 | inst_prefix=inst_prefix))) |
| 136 | config.overlay(values, dict(diameter=dict(identity=self.diameter_name(), |
| 137 | inst_prefix=inst_prefix, |
| 138 | listen_address=self.o5gs_epc.addr(), |
| 139 | listen_port=self.diameter_port(), |
| 140 | connect_name=self.o5gs_epc.hss.diameter_name(), |
| 141 | connect_address=self.o5gs_epc.addr(), |
| 142 | connect_port=self.o5gs_epc.hss.diameter_port()))) |
| 143 | |
| 144 | self.dbg('OPEN5GS-MME CONFIG:\n' + pprint.pformat(values)) |
| 145 | |
| 146 | with open(self.config_file, 'w') as f: |
| 147 | r = template.render(Open5gsMME.CFGFILE, values) |
| 148 | self.dbg(r) |
| 149 | f.write(r) |
| 150 | |
| 151 | with open(self.diameter_file, 'w') as f: |
| 152 | r = template.render(Open5gsMME.DIAMETERFILE, values) |
| 153 | self.dbg(r) |
| 154 | f.write(r) |
| 155 | |
| 156 | if not self._run_node.is_local(): |
| 157 | self.rem_host.recreate_remote_dir(self.remote_inst) |
| 158 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
| 159 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 160 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 161 | self.rem_host.scp('scp-diam-to-remote', self.diameter_file, self.remote_diameter_file) |
| 162 | |
| 163 | def running(self): |
| 164 | return not self.process.terminated() |
| 165 | |
| 166 | def diameter_name(self): |
| 167 | return 'mme' |
| 168 | |
| 169 | def diameter_port(self): |
| 170 | return 3868 + 1; |
| 171 | |
| 172 | # vim: expandtab tabstop=4 shiftwidth=4 |