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 | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 24 | from ..core import schema |
Pau Espin Pedrol | e8bbcbf | 2020-04-10 19:51:31 +0200 | [diff] [blame] | 25 | from . import pcap_recorder, run_node |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 26 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 27 | def on_register_schemas(): |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 28 | schema_types = { |
| 29 | 'iperf3_protocol': IPerf3Client.validate_protocol, |
| 30 | } |
| 31 | schema.register_schema_types(schema_types) |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 32 | config_schema = { |
| 33 | 'time': schema.DURATION, |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 34 | 'protocol': 'iperf3_protocol', |
AlaiaL | e9d7f5f | 2021-05-10 16:10:14 +0200 | [diff] [blame] | 35 | 'packet_length' : schema.UINT, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 36 | } |
| 37 | schema.register_config_schema('iperf3cli', config_schema) |
| 38 | |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 39 | def iperf3_result_to_json(log_obj, data): |
| 40 | try: |
| 41 | # Drop non-interesting self-generated output before json: |
| 42 | if not data.startswith('{\n'): |
| 43 | data = "{\n" + data.split("\n{\n")[1] |
| 44 | # Sometimes iperf3 provides 2 dictionaries, the 2nd one being an error about being interrupted (by us). |
| 45 | # json parser doesn't support (raises exception) parsing several dictionaries at a time (not a valid json object). |
| 46 | # We are only interested in the first dictionary, the regular results one: |
| 47 | data = data.split("\n}")[0] + "\n}" |
| 48 | j = json.loads(data) |
| 49 | return j |
| 50 | except Exception as e: |
| 51 | log_obj.log('failed parsing iperf3 output: "%s"' % data) |
| 52 | raise e |
Pau Espin Pedrol | 64f0b1b | 2018-11-09 17:44:10 +0100 | [diff] [blame] | 53 | |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 54 | def print_result_node_udp(result, node_str): |
| 55 | try: |
| 56 | sum = result['end']['sum'] |
| 57 | print("Result %s:" % node_str) |
| 58 | print("\tSUM: %d KB, %d kbps, %d seconds %d/%d lost" % (sum['bytes']/1000, sum['bits_per_second']/1000, sum['seconds'], sum['lost_packets'], sum['packets'])) |
| 59 | except Exception as e: |
| 60 | print("Exception while using iperf3 %s results: %r" % (node_str, repr(result))) |
| 61 | raise e |
| 62 | |
| 63 | def print_result_node_tcp(result, node_str): |
| 64 | try: |
| 65 | sent = result['end']['sum_sent'] |
| 66 | recv = result['end']['sum_received'] |
| 67 | print("Result %s:" % node_str) |
| 68 | print("\tSEND: %d KB, %d kbps, %d seconds (%s retrans)" % (sent['bytes']/1000, sent['bits_per_second']/1000, sent['seconds'], str(sent.get('retransmits', 'unknown')))) |
| 69 | print("\tRECV: %d KB, %d kbps, %d seconds" % (recv['bytes']/1000, recv['bits_per_second']/1000, recv['seconds'])) |
| 70 | except Exception as e: |
| 71 | print("Exception while using iperf3 %s results: %r" % (node_str, repr(result))) |
| 72 | raise e |
Pau Espin Pedrol | 64f0b1b | 2018-11-09 17:44:10 +0100 | [diff] [blame] | 73 | |
Andre Puschmann | 55b455c | 2020-06-17 15:36:30 +0200 | [diff] [blame] | 74 | def get_received_mbps(result, isUdp=True): |
| 75 | try: |
| 76 | recv = result['end']['sum' if isUdp else 'sum_received'] |
| 77 | return recv['bits_per_second']/1e6 |
| 78 | except Exception as e: |
| 79 | print("Exception while using iperf3 results: %r" % (repr(result))) |
| 80 | raise e |
| 81 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 82 | class IPerf3Server(log.Origin): |
| 83 | |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 84 | DEFAULT_SRV_PORT = 5003 |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 85 | LOGFILE = 'iperf3_srv.json' |
| 86 | REMOTE_DIR = '/tmp' |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 87 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 88 | def __init__(self, testenv, ip_address): |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 89 | super().__init__(log.C_RUN, 'iperf3-srv_%s' % ip_address.get('addr')) |
| 90 | self.run_dir = None |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 91 | self.process = None |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 92 | self._run_node = None |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 93 | self.testenv = testenv |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 94 | self.ip_address = ip_address |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 95 | self._port = IPerf3Server.DEFAULT_SRV_PORT |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 96 | self.log_file = None |
| 97 | self.rem_host = None |
| 98 | self.remote_log_file = None |
| 99 | self.log_copied = False |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 100 | 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] | 101 | |
| 102 | def cleanup(self): |
| 103 | if self.process is None: |
| 104 | return |
Pau Espin Pedrol | 03fab09 | 2020-07-13 19:13:52 +0200 | [diff] [blame] | 105 | if self.runs_locally() or not self.logfile_supported or self.log_copied: |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 106 | return |
| 107 | # copy back files (may not exist, for instance if there was an early error of process): |
| 108 | try: |
| 109 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
Pau Espin Pedrol | 03fab09 | 2020-07-13 19:13:52 +0200 | [diff] [blame] | 110 | self.log_copied = True |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 111 | except Exception as e: |
| 112 | self.log(repr(e)) |
| 113 | |
| 114 | def runs_locally(self): |
| 115 | locally = not self._run_node or self._run_node.is_local() |
| 116 | return locally |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 117 | |
| 118 | def start(self): |
| 119 | self.log('Starting iperf3-srv') |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 120 | self.log_copied = False |
Pau Espin Pedrol | 2a2d846 | 2020-05-11 10:56:52 +0200 | [diff] [blame] | 121 | self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name())) |
Pau Espin Pedrol | 6b9a50e | 2020-07-13 19:07:20 +0200 | [diff] [blame] | 122 | self.log_file = self.run_dir.new_child(IPerf3Server.LOGFILE) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 123 | if self.runs_locally(): |
| 124 | self.start_locally() |
| 125 | else: |
| 126 | self.start_remotely() |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 127 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 128 | def start_remotely(self): |
| 129 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr()) |
| 130 | remote_prefix_dir = util.Dir(IPerf3Server.REMOTE_DIR) |
| 131 | remote_run_dir = util.Dir(remote_prefix_dir.child('srv-' + str(self))) |
| 132 | self.remote_log_file = remote_run_dir.child(IPerf3Server.LOGFILE) |
| 133 | |
| 134 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 135 | |
| 136 | args = ('iperf3', '-s', '-B', self.addr(), |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 137 | '-p', str(self._port), '-J') |
| 138 | if self.logfile_supported: |
| 139 | args += ('--logfile', self.remote_log_file,) |
| 140 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 141 | self.process = self.rem_host.RemoteProcess(self.name(), args) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 142 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 143 | self.process.launch() |
| 144 | |
| 145 | def start_locally(self): |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 146 | pcap_recorder.PcapRecorder(self.testenv, self.run_dir.new_dir('pcap'), None, |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 147 | 'host %s and port not 22' % self.addr()) |
| 148 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 149 | args = ('iperf3', '-s', '-B', self.addr(), |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 150 | '-p', str(self._port), '-J') |
| 151 | if self.logfile_supported: |
| 152 | args += ('--logfile', os.path.abspath(self.log_file),) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 153 | |
| 154 | self.process = process.Process(self.name(), self.run_dir, args, env={}) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 155 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 156 | self.process.launch() |
| 157 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 158 | def set_run_node(self, run_node): |
| 159 | self._run_node = run_node |
| 160 | |
Pau Espin Pedrol | cf6a360 | 2018-11-14 16:38:19 +0100 | [diff] [blame] | 161 | def set_port(self, port): |
| 162 | self._port = port |
| 163 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 164 | def stop(self): |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 165 | self.testenv.stop_process(self.process) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 166 | |
| 167 | def get_results(self): |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 168 | if self.logfile_supported: |
| 169 | if not self.runs_locally() and not self.log_copied: |
| 170 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 171 | self.log_copied = True |
| 172 | with open(self.log_file) as f: |
| 173 | return iperf3_result_to_json(self, f.read()) |
| 174 | else: |
| 175 | return iperf3_result_to_json(self, self.process.get_stdout()) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 176 | |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 177 | def print_results(self, client_was_udp): |
| 178 | if client_was_udp: |
| 179 | print_result_node_udp(self.get_results(), 'server') |
| 180 | else: |
| 181 | print_result_node_tcp(self.get_results(), 'server') |
| 182 | |
Andre Puschmann | 55b455c | 2020-06-17 15:36:30 +0200 | [diff] [blame] | 183 | def get_received_mbps(self, client_was_udp): |
| 184 | return get_received_mbps(self.get_results(), client_was_udp) |
| 185 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 186 | def addr(self): |
| 187 | return self.ip_address.get('addr') |
| 188 | |
| 189 | def port(self): |
| 190 | return self._port |
| 191 | |
Pau Espin Pedrol | 0df6317 | 2018-11-14 16:39:30 +0100 | [diff] [blame] | 192 | def __str__(self): |
| 193 | return "%s:%u" %(self.addr(), self.port()) |
| 194 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 195 | def running(self): |
| 196 | return not self.process.terminated() |
| 197 | |
| 198 | def create_client(self): |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 199 | return IPerf3Client(self.testenv, self) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 200 | |
| 201 | class IPerf3Client(log.Origin): |
| 202 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 203 | REMOTE_DIR = '/tmp' |
| 204 | LOGFILE = 'iperf3_cli.json' |
| 205 | |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 206 | PROTO_TCP = "tcp" |
| 207 | PROTO_UDP = "udp" |
| 208 | |
Pau Espin Pedrol | f4ab97f | 2020-05-25 13:54:30 +0200 | [diff] [blame] | 209 | DIR_UL = "ul" |
| 210 | DIR_DL = "dl" |
| 211 | DIR_BI = "bi" |
| 212 | |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 213 | @classmethod |
| 214 | def validate_protocol(cls, val): |
| 215 | return val in (cls.PROTO_TCP, cls.PROTO_UDP) |
| 216 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 217 | def __init__(self, testenv, iperf3srv): |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 218 | super().__init__(log.C_RUN, 'iperf3-cli_%s' % iperf3srv.addr()) |
| 219 | self.run_dir = None |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 220 | self.process = None |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 221 | self._run_node = None |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 222 | self.server = iperf3srv |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 223 | self.testenv = testenv |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 224 | self._proto = None |
Andre Puschmann | 219ec75 | 2020-06-16 16:06:30 +0200 | [diff] [blame] | 225 | self._time_sec = None |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 226 | self.log_file = None |
| 227 | self.rem_host = None |
| 228 | self.remote_log_file = None |
| 229 | self.log_copied = False |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 230 | self.logfile_supported = False # some older versions of iperf doesn't support --logfile arg |
Nils Fürste | a8263f4 | 2020-11-23 14:45:15 +0100 | [diff] [blame] | 231 | self.is_android_ue = False |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 232 | |
| 233 | def runs_locally(self): |
| 234 | locally = not self._run_node or self._run_node.is_local() |
| 235 | return locally |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 236 | |
Pau Espin Pedrol | 5680255 | 2020-06-15 18:07:24 +0200 | [diff] [blame] | 237 | def prepare_test_proc(self, dir=None, netns=None, time_sec=None, proto=None, bitrate=0, tos=None): |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 238 | values = config.get_defaults('iperf3cli') |
| 239 | config.overlay(values, self.testenv.suite().config().get('iperf3cli', {})) |
Pau Espin Pedrol | f4ab97f | 2020-05-25 13:54:30 +0200 | [diff] [blame] | 240 | |
| 241 | if dir is None: |
| 242 | dir = self.DIR_UL |
| 243 | |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 244 | if time_sec is None: |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 245 | time_sec_str = values.get('time', time_sec) |
| 246 | |
| 247 | # Convert duration to seconds |
| 248 | if isinstance(time_sec_str, str) and time_sec_str.endswith('h'): |
| 249 | time_sec = int(time_sec_str[:-1]) * 3600 |
| 250 | elif isinstance(time_sec_str, str) and time_sec_str.endswith('m'): |
| 251 | time_sec = int(time_sec_str[:-1]) * 60 |
| 252 | else: |
| 253 | time_sec = int(time_sec_str) |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 254 | assert(time_sec) |
Andre Puschmann | 219ec75 | 2020-06-16 16:06:30 +0200 | [diff] [blame] | 255 | self._time_sec = time_sec |
Andre Puschmann | 2dcc431 | 2020-03-28 15:34:00 +0100 | [diff] [blame] | 256 | |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 257 | if proto is None: |
| 258 | proto = values.get('protocol', IPerf3Client.PROTO_TCP) |
| 259 | self._proto = proto |
| 260 | |
| 261 | self.log('Preparing iperf3-client connecting to %s:%d (proto=%s,time=%ds)' % (self.server.addr(), self.server.port(), self._proto, time_sec)) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 262 | self.log_copied = False |
Pau Espin Pedrol | 2a2d846 | 2020-05-11 10:56:52 +0200 | [diff] [blame] | 263 | self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name())) |
Pau Espin Pedrol | 6b9a50e | 2020-07-13 19:07:20 +0200 | [diff] [blame] | 264 | self.log_file = self.run_dir.new_child(IPerf3Client.LOGFILE) |
Pau Espin Pedrol | 229f116 | 2020-06-15 17:52:33 +0200 | [diff] [blame] | 265 | |
| 266 | popen_args = ('iperf3', '-c', self.server.addr(), |
| 267 | '-p', str(self.server.port()), '-J', |
| 268 | '-t', str(time_sec)) |
| 269 | if dir == IPerf3Client.DIR_DL: |
| 270 | popen_args += ('-R',) |
| 271 | elif dir == IPerf3Client.DIR_BI: |
| 272 | popen_args += ('--bidir',) |
| 273 | if proto == IPerf3Client.PROTO_UDP: |
| 274 | popen_args += ('-u', '-b', str(bitrate)) |
AlaiaL | e9d7f5f | 2021-05-10 16:10:14 +0200 | [diff] [blame] | 275 | # Add the buffer length. |
| 276 | if values.get('packet_length'): |
| 277 | packet_length = str(values.get('packet_length')) |
| 278 | popen_args += ('-l', packet_length) |
Pau Espin Pedrol | 5680255 | 2020-06-15 18:07:24 +0200 | [diff] [blame] | 279 | if tos is not None: |
| 280 | popen_args += ('-S', str(tos)) |
| 281 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 282 | if self.runs_locally(): |
Pau Espin Pedrol | 229f116 | 2020-06-15 17:52:33 +0200 | [diff] [blame] | 283 | proc = self.prepare_test_proc_locally(netns, popen_args) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 284 | else: |
Pau Espin Pedrol | 229f116 | 2020-06-15 17:52:33 +0200 | [diff] [blame] | 285 | proc = self.prepare_test_proc_remotely(netns, popen_args) |
Andre Puschmann | 053ee5f | 2020-07-15 10:54:46 +0200 | [diff] [blame] | 286 | proc.set_default_wait_timeout(time_sec + 120) # leave extra time for remote run, ctrl conn establishment, buffer draining, etc. |
Pau Espin Pedrol | a9bc93d | 2020-06-12 15:34:28 +0200 | [diff] [blame] | 287 | return proc |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 288 | |
Pau Espin Pedrol | 229f116 | 2020-06-15 17:52:33 +0200 | [diff] [blame] | 289 | def prepare_test_proc_remotely(self, netns, popen_args): |
Nils Fürste | a8263f4 | 2020-11-23 14:45:15 +0100 | [diff] [blame] | 290 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr(), None, |
| 291 | self._run_node.ssh_port()) |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 292 | |
| 293 | remote_prefix_dir = util.Dir(IPerf3Client.REMOTE_DIR) |
| 294 | remote_run_dir = util.Dir(remote_prefix_dir.child('cli-' + str(self))) |
| 295 | self.remote_log_file = remote_run_dir.child(IPerf3Client.LOGFILE) |
| 296 | |
| 297 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 298 | |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 299 | if self.logfile_supported: |
| 300 | popen_args += ('--logfile', self.remote_log_file,) |
Pau Espin Pedrol | 905e503 | 2020-03-02 15:35:33 +0100 | [diff] [blame] | 301 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 302 | if netns: |
| 303 | self.process = self.rem_host.RemoteNetNSProcess(self.name(), netns, popen_args, env={}) |
| 304 | else: |
| 305 | self.process = self.rem_host.RemoteProcess(self.name(), popen_args, env={}) |
| 306 | return self.process |
| 307 | |
Pau Espin Pedrol | 229f116 | 2020-06-15 17:52:33 +0200 | [diff] [blame] | 308 | def prepare_test_proc_locally(self, netns, popen_args): |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 309 | pcap_recorder.PcapRecorder(self.testenv, self.run_dir.new_dir('pcap'), None, |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 310 | 'host %s and port not 22' % self.server.addr(), netns) |
| 311 | |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 312 | if self.logfile_supported: |
| 313 | popen_args += ('--logfile', os.path.abspath(self.log_file),) |
Pau Espin Pedrol | 905e503 | 2020-03-02 15:35:33 +0100 | [diff] [blame] | 314 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 315 | if netns: |
| 316 | self.process = process.NetNSProcess(self.name(), self.run_dir, netns, popen_args, env={}) |
Nils Fürste | a8263f4 | 2020-11-23 14:45:15 +0100 | [diff] [blame] | 317 | elif self._run_node.adb_serial_id(): |
| 318 | self.process = process.AdbProcess(self.name(), self.run_dir, self._run_node.adb_serial_id(), popen_args, env={}) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 319 | else: |
| 320 | 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] | 321 | return self.process |
| 322 | |
| 323 | def run_test_sync(self, netns=None): |
| 324 | self.prepare_test_proc(netns) |
Pau Espin Pedrol | 79df739 | 2018-11-12 18:15:30 +0100 | [diff] [blame] | 325 | self.process.launch_sync() |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 326 | return self.get_results() |
| 327 | |
| 328 | def get_results(self): |
Pau Espin Pedrol | fdd8e3a | 2020-04-14 11:30:24 +0200 | [diff] [blame] | 329 | if self.logfile_supported: |
| 330 | if not self.runs_locally() and not self.log_copied: |
| 331 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 332 | self.log_copied = True |
| 333 | with open(self.log_file) as f: |
| 334 | return iperf3_result_to_json(self, f.read()) |
| 335 | else: |
| 336 | return iperf3_result_to_json(self, self.process.get_stdout()) |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 337 | |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 338 | def print_results(self): |
| 339 | if self.proto() == self.PROTO_UDP: |
| 340 | print_result_node_udp(self.get_results(), 'client') |
| 341 | else: |
| 342 | print_result_node_tcp(self.get_results(), 'client') |
| 343 | |
Andre Puschmann | 55b455c | 2020-06-17 15:36:30 +0200 | [diff] [blame] | 344 | def get_received_mbps(self): |
| 345 | if self.proto() == self.PROTO_UDP: |
| 346 | return get_received_mbps(self.get_results(), isUdp=True) |
| 347 | else: |
| 348 | return get_received_mbps(self.get_results(), isUdp=False) |
| 349 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 350 | def set_run_node(self, run_node): |
| 351 | self._run_node = run_node |
| 352 | |
Pau Espin Pedrol | 3a0dea6 | 2020-05-21 14:54:46 +0200 | [diff] [blame] | 353 | def proto(self): |
| 354 | return self._proto |
| 355 | |
Andre Puschmann | 219ec75 | 2020-06-16 16:06:30 +0200 | [diff] [blame] | 356 | def time_sec(self): |
| 357 | return self._time_sec |
| 358 | |
Pau Espin Pedrol | c852ad8 | 2020-02-11 17:43:58 +0100 | [diff] [blame] | 359 | def __str__(self): |
| 360 | # FIXME: somehow differentiate between several clients connected to same server? |
| 361 | return "%s:%u" %(self.server.addr(), self.server.port()) |
| 362 | |
Pau Espin Pedrol | 8a72586 | 2018-10-26 15:54:28 +0200 | [diff] [blame] | 363 | # vim: expandtab tabstop=4 shiftwidth=4 |