Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an iperf3 client and server |
| 2 | # |
| 3 | # Copyright (C) 2018 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 json |
| 22 | |
Pau Espin Pedrol | e1a58bd | 2020-04-10 20:46:07 +0200 | [diff] [blame] | 23 | from ..core import log, util, config, process, remote |
Pau Espin Pedrol | e8bbcbf | 2020-04-10 19:51:31 +0200 | [diff] [blame] | 24 | from . import pcap_recorder, run_node |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 25 | |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 26 | def iperf3_result_to_json(log_obj, data): |
| 27 | try: |
| 28 | # Drop non-interesting self-generated output before json: |
| 29 | if not data.startswith('{\n'): |
| 30 | data = "{\n" + data.split("\n{\n")[1] |
| 31 | # Sometimes iperf3 provides 2 dictionaries, the 2nd one being an error about being interrupted (by us). |
| 32 | # json parser doesn't support (raises exception) parsing several dictionaries at a time (not a valid json object). |
| 33 | # We are only interested in the first dictionary, the regular results one: |
| 34 | data = data.split("\n}")[0] + "\n}" |
| 35 | j = json.loads(data) |
| 36 | return j |
| 37 | except Exception as e: |
| 38 | log_obj.log('failed parsing iperf3 output: "%s"' % data) |
| 39 | raise e |
Pau Espin Pedrol | 64f0b1b | 2018-11-09 17:44:10 +0100 | [diff] [blame] | 40 | |
| 41 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 42 | class IPerf3Server(log.Origin): |
| 43 | |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 44 | DEFAULT_SRV_PORT = 5003 |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 45 | LOGFILE = 'iperf3_srv.json' |
| 46 | REMOTE_DIR = '/tmp' |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 47 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 48 | def __init__(self, suite_run, ip_address): |
| 49 | super().__init__(log.C_RUN, 'iperf3-srv_%s' % ip_address.get('addr')) |
| 50 | self.run_dir = None |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 51 | self.process = None |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 52 | self._run_node = None |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 53 | self.suite_run = suite_run |
| 54 | self.ip_address = ip_address |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 55 | self._port = IPerf3Server.DEFAULT_SRV_PORT |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 56 | self.log_file = None |
| 57 | self.rem_host = None |
| 58 | self.remote_log_file = None |
| 59 | self.log_copied = False |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 60 | self.logfile_supported = False # some older versions of iperf doesn't support --logfile arg |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 61 | |
| 62 | def cleanup(self): |
| 63 | if self.process is None: |
| 64 | return |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 65 | if self.runs_locally() or not self.logfile_supported: |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 66 | return |
| 67 | # copy back files (may not exist, for instance if there was an early error of process): |
| 68 | try: |
| 69 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 70 | except Exception as e: |
| 71 | self.log(repr(e)) |
| 72 | |
| 73 | def runs_locally(self): |
| 74 | locally = not self._run_node or self._run_node.is_local() |
| 75 | return locally |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 76 | |
| 77 | def start(self): |
| 78 | self.log('Starting iperf3-srv') |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 79 | self.log_copied = False |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 80 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 81 | self.log_file = self.run_dir.new_file(IPerf3Server.LOGFILE) |
| 82 | if self.runs_locally(): |
| 83 | self.start_locally() |
| 84 | else: |
| 85 | self.start_remotely() |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 86 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 87 | def start_remotely(self): |
| 88 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr()) |
| 89 | remote_prefix_dir = util.Dir(IPerf3Server.REMOTE_DIR) |
| 90 | remote_run_dir = util.Dir(remote_prefix_dir.child('srv-' + str(self))) |
| 91 | self.remote_log_file = remote_run_dir.child(IPerf3Server.LOGFILE) |
| 92 | |
| 93 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 94 | |
| 95 | args = ('iperf3', '-s', '-B', self.addr(), |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 96 | '-p', str(self._port), '-J') |
| 97 | if self.logfile_supported: |
| 98 | args += ('--logfile', self.remote_log_file,) |
| 99 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 100 | self.process = self.rem_host.RemoteProcess(self.name(), args) |
| 101 | self.suite_run.remember_to_stop(self.process) |
| 102 | self.process.launch() |
| 103 | |
| 104 | def start_locally(self): |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 105 | pcap_recorder.PcapRecorder(self.suite_run, self.run_dir.new_dir('pcap'), None, |
| 106 | 'host %s and port not 22' % self.addr()) |
| 107 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 108 | args = ('iperf3', '-s', '-B', self.addr(), |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 109 | '-p', str(self._port), '-J') |
| 110 | if self.logfile_supported: |
| 111 | args += ('--logfile', os.path.abspath(self.log_file),) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 112 | |
| 113 | self.process = process.Process(self.name(), self.run_dir, args, env={}) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 114 | self.suite_run.remember_to_stop(self.process) |
| 115 | self.process.launch() |
| 116 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 117 | def set_run_node(self, run_node): |
| 118 | self._run_node = run_node |
| 119 | |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 120 | def set_port(self, port): |
| 121 | self._port = port |
| 122 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 123 | def stop(self): |
| 124 | self.suite_run.stop_process(self.process) |
| 125 | |
| 126 | def get_results(self): |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 127 | if self.logfile_supported: |
| 128 | if not self.runs_locally() and not self.log_copied: |
| 129 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 130 | self.log_copied = True |
| 131 | with open(self.log_file) as f: |
| 132 | return iperf3_result_to_json(self, f.read()) |
| 133 | else: |
| 134 | return iperf3_result_to_json(self, self.process.get_stdout()) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 135 | |
| 136 | def addr(self): |
| 137 | return self.ip_address.get('addr') |
| 138 | |
| 139 | def port(self): |
| 140 | return self._port |
| 141 | |
Pau Espin Pedrol | 0df6317 | 2018-11-14 16:39:30 +0100 | [diff] [blame] | 142 | def __str__(self): |
| 143 | return "%s:%u" %(self.addr(), self.port()) |
| 144 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 145 | def running(self): |
| 146 | return not self.process.terminated() |
| 147 | |
| 148 | def create_client(self): |
| 149 | return IPerf3Client(self.suite_run, self) |
| 150 | |
| 151 | class IPerf3Client(log.Origin): |
| 152 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 153 | REMOTE_DIR = '/tmp' |
| 154 | LOGFILE = 'iperf3_cli.json' |
| 155 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 156 | def __init__(self, suite_run, iperf3srv): |
| 157 | super().__init__(log.C_RUN, 'iperf3-cli_%s' % iperf3srv.addr()) |
| 158 | self.run_dir = None |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 159 | self.process = None |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 160 | self._run_node = None |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 161 | self.server = iperf3srv |
| 162 | self.suite_run = suite_run |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 163 | self.log_file = None |
| 164 | self.rem_host = None |
| 165 | self.remote_log_file = None |
| 166 | self.log_copied = False |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 167 | self.logfile_supported = False # some older versions of iperf doesn't support --logfile arg |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 168 | |
| 169 | def runs_locally(self): |
| 170 | locally = not self._run_node or self._run_node.is_local() |
| 171 | return locally |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 172 | |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 173 | def prepare_test_proc(self, downlink=False, netns=None, time_sec=None): |
| 174 | if time_sec is None: |
| 175 | values = config.get_defaults('iperf3cli') |
| 176 | config.overlay(values, self.suite_run.config().get('iperf3cli', {})) |
| 177 | time_sec_str = values.get('time', time_sec) |
| 178 | |
| 179 | # Convert duration to seconds |
| 180 | if isinstance(time_sec_str, str) and time_sec_str.endswith('h'): |
| 181 | time_sec = int(time_sec_str[:-1]) * 3600 |
| 182 | elif isinstance(time_sec_str, str) and time_sec_str.endswith('m'): |
| 183 | time_sec = int(time_sec_str[:-1]) * 60 |
| 184 | else: |
| 185 | time_sec = int(time_sec_str) |
| 186 | |
| 187 | assert(time_sec) |
| 188 | |
| 189 | self.log('Preparing iperf3-client connecting to %s:%d (time=%ds)' % (self.server.addr(), self.server.port(), time_sec)) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 190 | self.log_copied = False |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 191 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 192 | self.log_file = self.run_dir.new_file(IPerf3Client.LOGFILE) |
| 193 | if self.runs_locally(): |
Pau Espin Pedrol | 085a17e | 2020-03-02 18:14:02 +0100 | [diff] [blame] | 194 | return self.prepare_test_proc_locally(downlink, netns, time_sec) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 195 | else: |
Pau Espin Pedrol | 085a17e | 2020-03-02 18:14:02 +0100 | [diff] [blame] | 196 | return self.prepare_test_proc_remotely(downlink, netns, time_sec) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 197 | |
Pau Espin Pedrol | 085a17e | 2020-03-02 18:14:02 +0100 | [diff] [blame] | 198 | def prepare_test_proc_remotely(self, downlink, netns, time_sec): |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 199 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr()) |
| 200 | |
| 201 | remote_prefix_dir = util.Dir(IPerf3Client.REMOTE_DIR) |
| 202 | remote_run_dir = util.Dir(remote_prefix_dir.child('cli-' + str(self))) |
| 203 | self.remote_log_file = remote_run_dir.child(IPerf3Client.LOGFILE) |
| 204 | |
| 205 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 206 | |
| 207 | popen_args = ('iperf3', '-c', self.server.addr(), |
| 208 | '-p', str(self.server.port()), '-J', |
Pau Espin Pedrol | 085a17e | 2020-03-02 18:14:02 +0100 | [diff] [blame] | 209 | '-t', str(time_sec)) |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 210 | if self.logfile_supported: |
| 211 | popen_args += ('--logfile', self.remote_log_file,) |
Pau Espin Pedrol | 905e503 | 2020-03-02 15:35:33 +0100 | [diff] [blame] | 212 | if downlink: |
| 213 | popen_args += ('-R',) |
| 214 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 215 | if netns: |
| 216 | self.process = self.rem_host.RemoteNetNSProcess(self.name(), netns, popen_args, env={}) |
| 217 | else: |
| 218 | self.process = self.rem_host.RemoteProcess(self.name(), popen_args, env={}) |
| 219 | return self.process |
| 220 | |
Pau Espin Pedrol | 085a17e | 2020-03-02 18:14:02 +0100 | [diff] [blame] | 221 | def prepare_test_proc_locally(self, downlink, netns, time_sec): |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 222 | pcap_recorder.PcapRecorder(self.suite_run, self.run_dir.new_dir('pcap'), None, |
| 223 | 'host %s and port not 22' % self.server.addr(), netns) |
| 224 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 225 | popen_args = ('iperf3', '-c', self.server.addr(), |
| 226 | '-p', str(self.server.port()), '-J', |
Pau Espin Pedrol | 085a17e | 2020-03-02 18:14:02 +0100 | [diff] [blame] | 227 | '-t', str(time_sec)) |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 228 | if self.logfile_supported: |
| 229 | popen_args += ('--logfile', os.path.abspath(self.log_file),) |
Pau Espin Pedrol | 905e503 | 2020-03-02 15:35:33 +0100 | [diff] [blame] | 230 | if downlink: |
| 231 | popen_args += ('-R',) |
| 232 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 233 | if netns: |
| 234 | self.process = process.NetNSProcess(self.name(), self.run_dir, netns, popen_args, env={}) |
| 235 | else: |
| 236 | self.process = process.Process(self.name(), self.run_dir, popen_args, env={}) |
Pau Espin Pedrol | 0fc7437 | 2018-11-14 16:44:57 +0100 | [diff] [blame] | 237 | return self.process |
| 238 | |
| 239 | def run_test_sync(self, netns=None): |
| 240 | self.prepare_test_proc(netns) |
Pau Espin Pedrol | 79df739 | 2018-11-12 18:15:30 +0100 | [diff] [blame] | 241 | self.process.launch_sync() |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 242 | return self.get_results() |
| 243 | |
| 244 | def get_results(self): |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 245 | if self.logfile_supported: |
| 246 | if not self.runs_locally() and not self.log_copied: |
| 247 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 248 | self.log_copied = True |
| 249 | with open(self.log_file) as f: |
| 250 | return iperf3_result_to_json(self, f.read()) |
| 251 | else: |
| 252 | return iperf3_result_to_json(self, self.process.get_stdout()) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 253 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 254 | def set_run_node(self, run_node): |
| 255 | self._run_node = run_node |
| 256 | |
| 257 | def __str__(self): |
| 258 | # FIXME: somehow differentiate between several clients connected to same server? |
| 259 | return "%s:%u" %(self.server.addr(), self.server.port()) |
| 260 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 261 | # vim: expandtab tabstop=4 shiftwidth=4 |