Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 1 | # osmo_ms_driver: Starter for processes |
| 2 | # Help to start processes over time. |
| 3 | # |
| 4 | # Copyright (C) 2018 by Holger Hans Peter Freyther |
| 5 | # |
| 6 | # This program is free software: you can redistribute it and/or modify |
| 7 | # it under the terms of the GNU General Public License as |
| 8 | # published by the Free Software Foundation, either version 3 of the |
| 9 | # License, or (at your option) any later version. |
| 10 | # |
| 11 | # This program is distributed in the hope that it will be useful, |
| 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | # GNU General Public License for more details. |
| 15 | # |
| 16 | # You should have received a copy of the GNU General Public License |
| 17 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 18 | |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 19 | from osmo_gsm_tester import log, process, template |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 20 | |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 21 | import collections |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 22 | import os |
| 23 | import os.path |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 24 | import time |
| 25 | |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 26 | BinaryOptions = collections.namedtuple("BinaryOptions", ["virtphy", "mobile", "env"]) |
| 27 | |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 28 | class Launcher(log.Origin): |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 29 | def __init__(self, binary, env, base_name, name_number, tmp_dir): |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 30 | super().__init__(log.C_RUN, "{}/{}".format(base_name, name_number)) |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 31 | self._binary = binary |
| 32 | self._env = env |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 33 | self._name_number = name_number |
Holger Hans Peter Freyther | 792614f | 2018-11-05 06:23:39 +0000 | [diff] [blame] | 34 | self._tmp_dir = tmp_dir.new_dir(self.name()) |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 35 | |
| 36 | def name_number(self): |
| 37 | return self._name_number |
| 38 | |
| 39 | class OsmoVirtPhy(Launcher): |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 40 | def __init__(self, binary, env, name_number, tmp_dir): |
| 41 | super().__init__(binary, env, "osmo-ms-virt-phy", name_number, tmp_dir) |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 42 | self._phy_filename = os.path.join(self._tmp_dir, "osmocom_l2_" + self._name_number) |
Holger Hans Peter Freyther | b5e86b7 | 2018-11-05 03:43:27 +0000 | [diff] [blame] | 43 | self._vphy_proc = None |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 44 | |
| 45 | def phy_filename(self): |
| 46 | return self._phy_filename |
| 47 | |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 48 | def start(self, loop, suite_run=None): |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 49 | if len(self._phy_filename.encode()) > 107: |
| 50 | raise log.Error('Path for unix socket is longer than max allowed len for unix socket path (107):', self._phy_filename) |
| 51 | |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 52 | self.log("Starting virtphy") |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 53 | args = [self._binary, "--l1ctl-sock=" + self._phy_filename] |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 54 | self._vphy_proc = process.Process(self.name(), self._tmp_dir, |
| 55 | args, env=self._env) |
| 56 | if suite_run: |
| 57 | suite_run.remember_to_stop(self._vphy_proc) |
| 58 | self._vphy_proc.launch() |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 59 | |
| 60 | def verify_ready(self): |
| 61 | while True: |
| 62 | if os.path.exists(self._phy_filename): |
| 63 | return |
| 64 | time.sleep(0.2) |
| 65 | |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 66 | def terminate(self): |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 67 | """Clean up things.""" |
| 68 | if self._vphy_proc: |
Holger Hans Peter Freyther | b5e86b7 | 2018-11-05 03:43:27 +0000 | [diff] [blame] | 69 | self._vphy_proc.terminate() |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 70 | |
| 71 | class OsmoMobile(Launcher): |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 72 | def __init__(self, binary, env, name_number, tmp_dir, lua_tmpl, cfg_tmpl, imsi_ki_generator, phy_filename, ev_server_path): |
| 73 | super().__init__(binary, env, "osmo-ms-mob", name_number, tmp_dir) |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 74 | self._lua_template = lua_tmpl |
| 75 | self._cfg_template = cfg_tmpl |
| 76 | self._imsi_ki_generator = imsi_ki_generator |
| 77 | self._phy_filename = phy_filename |
| 78 | self._ev_server_path = ev_server_path |
Holger Hans Peter Freyther | a7b61f3 | 2018-08-28 11:00:11 +0100 | [diff] [blame] | 79 | self._imsi, self._ki = next(self._imsi_ki_generator) |
Holger Hans Peter Freyther | b5e86b7 | 2018-11-05 03:43:27 +0000 | [diff] [blame] | 80 | self._omob_proc = None |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 81 | |
Holger Hans Peter Freyther | 8ae38a6 | 2018-08-29 04:25:30 +0100 | [diff] [blame] | 82 | def imsi(self): |
| 83 | return self._imsi |
| 84 | |
| 85 | def ki(self): |
| 86 | return self._ki |
| 87 | |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 88 | def write_lua_cfg(self): |
| 89 | lua_support = os.path.join(os.path.dirname(__file__), 'lua') |
| 90 | cfg = { |
| 91 | 'test': { |
| 92 | 'event_path': self._ev_server_path, |
| 93 | 'lua_support': lua_support, |
| 94 | } |
| 95 | } |
| 96 | lua_cfg_file = os.path.join(self._tmp_dir, "lua_" + self._name_number + ".lua") |
| 97 | lua_script = template.render(self._lua_template, cfg) |
| 98 | with open(lua_cfg_file, 'w') as w: |
| 99 | w.write(lua_script) |
| 100 | return lua_cfg_file |
| 101 | |
| 102 | def write_mob_cfg(self, lua_filename, phy_filename): |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 103 | cfg = { |
| 104 | 'test': { |
| 105 | 'script': lua_filename, |
| 106 | 'virt_phy': phy_filename, |
Holger Hans Peter Freyther | a7b61f3 | 2018-08-28 11:00:11 +0100 | [diff] [blame] | 107 | 'imsi': self._imsi, |
| 108 | 'ki_comp128': self._ki, |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 109 | 'ms_number': self._name_number, |
| 110 | } |
| 111 | } |
| 112 | mob_cfg_file = os.path.join(self._tmp_dir, "mob_" + self._name_number + ".cfg") |
| 113 | mob_vty = template.render(self._cfg_template, cfg) |
| 114 | with open(mob_cfg_file, 'w') as w: |
| 115 | w.write(mob_vty) |
| 116 | return mob_cfg_file |
| 117 | |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 118 | def start(self, loop, suite_run=None): |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 119 | lua_filename = self.write_lua_cfg() |
| 120 | mob_filename = self.write_mob_cfg(lua_filename, self._phy_filename) |
| 121 | |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 122 | self.log("Starting mobile") |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 123 | # Let the kernel pick an unused port for the VTY. |
Holger Hans Peter Freyther | f658b83 | 2018-11-05 05:05:43 +0000 | [diff] [blame] | 124 | args = [self._binary, "-c", mob_filename, "--vty-port=0"] |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 125 | self._omob_proc = process.Process(self.name(), self._tmp_dir, |
| 126 | args, env=self._env) |
| 127 | if suite_run: |
| 128 | suite_run.remember_to_stop(self._omob_proc) |
| 129 | self._omob_proc.launch() |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 130 | |
Holger Hans Peter Freyther | f743afb | 2018-11-05 06:07:57 +0000 | [diff] [blame] | 131 | def terminate(self): |
Holger Hans Peter Freyther | ff19a5e | 2018-02-25 21:29:35 +0000 | [diff] [blame] | 132 | """Clean up things.""" |
| 133 | if self._omob_proc: |
Holger Hans Peter Freyther | b5e86b7 | 2018-11-05 03:43:27 +0000 | [diff] [blame] | 134 | self._omob_proc.terminate() |