1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Performance testing traffic generator library."""
16 from robot.api import logger
17 from robot.libraries.BuiltIn import BuiltIn
19 from resources.libraries.python.constants import Constants
20 from resources.libraries.python.ssh import SSH
21 from resources.libraries.python.topology import NodeType
22 from resources.libraries.python.topology import NodeSubTypeTG
23 from resources.libraries.python.topology import Topology
24 from resources.libraries.python.DropRateSearch import DropRateSearch
26 __all__ = ['TrafficGenerator', 'TGDropRateSearchImpl']
29 class TGDropRateSearchImpl(DropRateSearch):
30 """Drop Rate Search implementation."""
33 super(TGDropRateSearchImpl, self).__init__()
35 def measure_loss(self, rate, frame_size, loss_acceptance,
36 loss_acceptance_type, traffic_type):
37 """Runs the traffic and evaluate the measured results.
39 :param rate: Offered traffic load.
40 :param frame_size: Size of frame.
41 :param loss_acceptance: Permitted drop ratio or frames count.
42 :param loss_acceptance_type: Type of permitted loss.
43 :param traffic_type: Traffic profile ([2,3]-node-L[2,3], ...).
46 :type loss_acceptance: float
47 :type loss_acceptance_type: LossAcceptanceType
48 :type traffic_type: str
49 :returns: Drop threshold exceeded? (True/False)
51 :raises: NotImplementedError if TG is not supported.
52 :raises: RuntimeError if TG is not specified.
54 # we need instance of TrafficGenerator instantiated by Robot Framework
55 # to be able to use trex_stl-*()
56 tg_instance = BuiltIn().get_library_instance(
57 'resources.libraries.python.TrafficGenerator')
59 if tg_instance.node['subtype'] is None:
60 raise RuntimeError('TG subtype not defined')
61 elif tg_instance.node['subtype'] == NodeSubTypeTG.TREX:
62 unit_rate = str(rate) + self.get_rate_type_str()
63 tg_instance.trex_stl_start_remote_exec(self.get_duration(),
64 unit_rate, frame_size,
66 loss = tg_instance.get_loss()
67 sent = tg_instance.get_sent()
68 if self.loss_acceptance_type_is_percentage():
69 loss = (float(loss) / float(sent)) * 100
71 logger.trace("comparing: {} < {} {}".format(loss,
73 loss_acceptance_type))
74 if float(loss) > float(loss_acceptance):
79 raise NotImplementedError("TG subtype not supported")
81 def get_latency(self):
82 """Returns min/avg/max latency.
84 :returns: Latency stats.
87 tg_instance = BuiltIn().get_library_instance(
88 'resources.libraries.python.TrafficGenerator')
89 return tg_instance.get_latency_int()
92 class TrafficGenerator(object):
93 """Traffic Generator."""
95 # use one instance of TrafficGenerator for all tests in test suite
96 ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
103 self._received = None
105 # T-REX interface order mapping
106 self._ifaces_reordered = 0
112 :returns: Traffic generator node.
118 """Return number of lost packets.
120 :returns: Number of lost packets.
126 """Return number of sent packets.
128 :returns: Number of sent packets.
133 def get_received(self):
134 """Return number of received packets.
136 :returns: Number of received packets.
139 return self._received
141 def get_latency_int(self):
142 """Return rounded min/avg/max latency.
144 :returns: Latency stats.
149 def initialize_traffic_generator(self, tg_node, tg_if1, tg_if2,
150 tg_if1_adj_node, tg_if1_adj_if,
151 tg_if2_adj_node, tg_if2_adj_if,
153 tg_if1_dst_mac=None, tg_if2_dst_mac=None):
154 """TG initialization.
156 :param tg_node: Traffic generator node.
157 :param tg_if1: TG - name of first interface.
158 :param tg_if2: TG - name of second interface.
159 :param tg_if1_adj_node: TG if1 adjecent node.
160 :param tg_if1_adj_if: TG if1 adjecent interface.
161 :param tg_if2_adj_node: TG if2 adjecent node.
162 :param tg_if2_adj_if: TG if2 adjecent interface.
163 :param test_type: 'L2' or 'L3' - src/dst MAC address.
164 :param tg_if1_dst_mac: Interface 1 destination MAC address.
165 :param tg_if2_dst_mac: Interface 2 destination MAC address.
169 :type tg_if1_adj_node: dict
170 :type tg_if1_adj_if: str
171 :type tg_if2_adj_node: dict
172 :type tg_if2_adj_if: str
174 :type tg_if1_dst_mac: str
175 :type tg_if2_dst_mac: str
177 :raises: RuntimeError in case of issue during initialization.
182 if tg_node['type'] != NodeType.TG:
183 raise RuntimeError('Node type is not a TG')
186 if tg_node['subtype'] == NodeSubTypeTG.TREX:
187 trex_path = "/opt/trex-core-2.17"
192 (ret, stdout, stderr) = ssh.exec_command(
193 "sudo -E sh -c '{}/resources/tools/t-rex/"
194 "t-rex-installer.sh'".format(Constants.REMOTE_FW_DIR),
197 logger.error('trex installation failed: {0}'.format(
199 raise RuntimeError('Installation of TG failed')
201 if1_pci = topo.get_interface_pci_addr(tg_node, tg_if1)
202 if2_pci = topo.get_interface_pci_addr(tg_node, tg_if2)
203 if1_mac = topo.get_interface_mac(tg_node, tg_if1)
204 if2_mac = topo.get_interface_mac(tg_node, tg_if2)
206 if test_type == 'L2':
207 if1_adj_mac = if2_mac
208 if2_adj_mac = if1_mac
209 elif test_type == 'L3':
210 if1_adj_mac = topo.get_interface_mac(tg_if1_adj_node,
212 if2_adj_mac = topo.get_interface_mac(tg_if2_adj_node,
215 raise ValueError("test_type unknown")
217 if tg_if1_dst_mac is not None and tg_if2_dst_mac is not None:
218 if1_adj_mac = tg_if1_dst_mac
219 if2_adj_mac = tg_if2_dst_mac
221 if min(if1_pci, if2_pci) != if1_pci:
222 if1_mac, if2_mac = if2_mac, if1_mac
223 if1_pci, if2_pci = if2_pci, if1_pci
224 if1_adj_mac, if2_adj_mac = if2_adj_mac, if1_adj_mac
225 self._ifaces_reordered = 1
227 if1_mac_hex = "0x"+if1_mac.replace(":", ",0x")
228 if2_mac_hex = "0x"+if2_mac.replace(":", ",0x")
229 if1_adj_mac_hex = "0x"+if1_adj_mac.replace(":", ",0x")
230 if2_adj_mac_hex = "0x"+if2_adj_mac.replace(":", ",0x")
232 (ret, stdout, stderr) = ssh.exec_command(
233 "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
236 " interfaces : [\"{}\",\"{}\"]\n"
238 " - dest_mac : [{}]\n"
240 " - dest_mac : [{}]\n"
243 .format(if1_pci, if2_pci,
244 if1_adj_mac_hex, if1_mac_hex,
245 if2_adj_mac_hex, if2_mac_hex))
247 logger.error("failed to create t-rex config: {}"\
248 .format(stdout + stderr))
249 raise RuntimeError('trex config generation error')
251 max_startup_retries = 3
252 while max_startup_retries > 0:
253 # kill T-rex only if it is already running
254 (ret, _, _) = ssh.exec_command(
255 "sh -c 'pgrep t-rex && sudo pkill t-rex && sleep 3'")
258 (ret, stdout, stderr) = ssh.exec_command(
259 "sh -c 'cd {0}/scripts/ && sudo ./trex-cfg'"\
262 logger.error('trex-cfg failed: {0}'.format(stdout + stderr))
263 raise RuntimeError('trex-cfg failed')
266 (ret, _, _) = ssh.exec_command(
267 "sh -c 'cd {0}/scripts/ && "
268 "sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &'"
272 raise RuntimeError('t-rex-64 startup failed')
274 # get T-rex server info
275 (ret, _, _) = ssh.exec_command(
276 "sh -c '{0}/resources/tools/t-rex/t-rex-server-info.py'"\
277 .format(Constants.REMOTE_FW_DIR),
280 # If we get info T-rex is running
283 max_startup_retries -= 1
284 # after max retries T-rex is still not responding to API
285 # critical error occured
286 raise RuntimeError('t-rex-64 startup failed')
290 def teardown_traffic_generator(node):
293 :param node: Traffic generator node.
296 :raises: RuntimeError if T-rex teardown failed.
297 :raises: RuntimeError if node type is not a TG.
299 if node['type'] != NodeType.TG:
300 raise RuntimeError('Node type is not a TG')
301 if node['subtype'] == NodeSubTypeTG.TREX:
304 (ret, stdout, stderr) = ssh.exec_command(
305 "sh -c 'sudo pkill t-rex'")
307 logger.error('pkill t-rex failed: {0}'.format(stdout + stderr))
308 raise RuntimeError('pkill t-rex failed')
311 def trex_stl_stop_remote_exec(node):
312 """Execute script on remote node over ssh to stop running traffic.
314 :param node: T-REX generator node.
317 :raises: RuntimeError if stop traffic script fails.
322 (ret, stdout, stderr) = ssh.exec_command(
323 "sh -c '{}/resources/tools/t-rex/"
324 "t-rex-stateless-stop.py'".format(Constants.REMOTE_FW_DIR))
330 raise RuntimeError('T-rex stateless runtime error')
332 def trex_stl_start_remote_exec(self, duration, rate, framesize,
333 traffic_type, async_call=False,
334 latency=True, warmup_time=5):
335 """Execute script on remote node over ssh to start traffic.
337 :param duration: Time expresed in seconds for how long to send traffic.
338 :param rate: Traffic rate expressed with units (pps, %)
339 :param framesize: L2 frame size to send (without padding and IPG).
340 :param traffic_type: Traffic profile.
341 :param async_call: If enabled then don't wait for all incomming trafic.
342 :param latency: With latency measurement.
343 :param warmup_time: Warmup time period.
347 :type traffic_type: str
348 :type async_call: bool
350 :type warmup_time: int
352 :raises: NotImplementedError if traffic type is not supported.
353 :raises: RuntimeError in case of TG driver issue.
356 ssh.connect(self._node)
360 _async = "--async" if async_call else ""
361 _latency = "--latency" if latency else ""
363 if self._ifaces_reordered != 0:
366 if traffic_type in ["3-node-xconnect", "3-node-bridge"]:
367 (ret, stdout, stderr) = ssh.exec_command(
368 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
369 "--duration={1} -r {2} -s {3} "
370 "--p{4}_src_start_ip 10.10.10.1 "
371 "--p{4}_src_end_ip 10.10.10.254 "
372 "--p{4}_dst_start_ip 20.20.20.1 "
373 "--p{5}_src_start_ip 20.20.20.1 "
374 "--p{5}_src_end_ip 20.20.20.254 "
375 "--p{5}_dst_start_ip 10.10.10.1 "
376 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
377 duration, rate, framesize,
378 _p0, _p1, _async, _latency,
380 timeout=int(duration)+60)
381 elif traffic_type in ["3-node-IPv4"]:
382 (ret, stdout, stderr) = ssh.exec_command(
383 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
384 "--duration={1} -r {2} -s {3} "
385 "--p{4}_src_start_ip 10.10.10.2 "
386 "--p{4}_src_end_ip 10.10.10.254 "
387 "--p{4}_dst_start_ip 20.20.20.2 "
388 "--p{5}_src_start_ip 20.20.20.2 "
389 "--p{5}_src_end_ip 20.20.20.254 "
390 "--p{5}_dst_start_ip 10.10.10.2 "
391 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
392 duration, rate, framesize,
393 _p0, _p1, _async, _latency,
395 timeout=int(duration)+60)
396 elif traffic_type in ["3-node-IPv4-dst-10000"]:
397 (ret, stdout, stderr) = ssh.exec_command(
398 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
399 "--duration={1} -r {2} -s {3} "
400 "--p{4}_src_start_ip 10.0.0.1 "
401 "--p{4}_dst_start_ip 20.0.0.0 "
402 "--p{4}_dst_end_ip 20.0.39.15 "
403 "--p{5}_src_start_ip 20.0.0.1 "
404 "--p{5}_dst_start_ip 10.0.0.0 "
405 "--p{5}_dst_end_ip 10.0.39.15 "
406 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
407 duration, rate, framesize,
408 _p0, _p1, _async, _latency,
410 timeout=int(duration)+60)
411 elif traffic_type in ["3-node-IPv4-dst-100000"]:
412 (ret, stdout, stderr) = ssh.exec_command(
413 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
414 "--duration={1} -r {2} -s {3} "
415 "--p{4}_src_start_ip 10.0.0.1 "
416 "--p{4}_dst_start_ip 20.0.0.0 "
417 "--p{4}_dst_end_ip 20.1.134.159 "
418 "--p{5}_src_start_ip 20.0.0.1 "
419 "--p{5}_dst_start_ip 10.0.0.0 "
420 "--p{5}_dst_end_ip 10.1.134.159 "
421 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
422 duration, rate, framesize,
423 _p0, _p1, _async, _latency,
425 timeout=int(duration)+60)
426 elif traffic_type in ["3-node-IPv4-dst-1000000"]:
427 (ret, stdout, stderr) = ssh.exec_command(
428 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
429 "--duration={1} -r {2} -s {3} "
430 "--p{4}_src_start_ip 10.0.0.1 "
431 "--p{4}_dst_start_ip 20.0.0.0 "
432 "--p{4}_dst_end_ip 20.15.66.63 "
433 "--p{5}_src_start_ip 20.0.0.1 "
434 "--p{5}_dst_start_ip 10.0.0.0 "
435 "--p{5}_dst_end_ip 10.15.66.63 "
436 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
437 duration, rate, framesize,
438 _p0, _p1, _async, _latency,
440 timeout=int(duration)+60)
441 elif traffic_type in ["3-node-IPv6"]:
442 (ret, stdout, stderr) = ssh.exec_command(
443 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
444 "--duration={1} -r {2} -s {3} -6 "
445 "--p{4}_src_start_ip 2001:1::2 "
446 "--p{4}_src_end_ip 2001:1::FE "
447 "--p{4}_dst_start_ip 2001:2::2 "
448 "--p{5}_src_start_ip 2001:2::2 "
449 "--p{5}_src_end_ip 2001:2::FE "
450 "--p{5}_dst_start_ip 2001:1::2 "
451 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
452 duration, rate, framesize,
453 _p0, _p1, _async, _latency,
455 timeout=int(duration)+60)
456 elif traffic_type in ["3-node-IPv6-dst-10000"]:
457 (ret, stdout, stderr) = ssh.exec_command(
458 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
459 "--duration={1} -r {2} -s {3} -6 "
460 "--p{4}_src_start_ip 2001:1::1 "
461 "--p{4}_dst_start_ip 2001:2::0 "
462 "--p{4}_dst_end_ip 2001:2::270F "
463 "--p{5}_src_start_ip 2001:2::1 "
464 "--p{5}_dst_start_ip 2001:1::0 "
465 "--p{5}_dst_end_ip 2001:1::270F "
466 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
467 duration, rate, framesize,
468 _p0, _p1, _async, _latency,
470 timeout=int(duration)+60)
471 elif traffic_type in ["3-node-IPv6-dst-100000"]:
472 (ret, stdout, stderr) = ssh.exec_command(
473 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
474 "--duration={1} -r {2} -s {3} -6 "
475 "--p{4}_src_start_ip 2001:1::1 "
476 "--p{4}_dst_start_ip 2001:2::0 "
477 "--p{4}_dst_end_ip 2001:2::1:869F "
478 "--p{5}_src_start_ip 2001:2::1 "
479 "--p{5}_dst_start_ip 2001:1::0 "
480 "--p{5}_dst_end_ip 2001:1::1:869F "
481 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
482 duration, rate, framesize,
483 _p0, _p1, _async, _latency,
485 timeout=int(duration)+60)
486 elif traffic_type in ["3-node-IPv6-dst-1000000"]:
487 (ret, stdout, stderr) = ssh.exec_command(
488 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
489 "--duration={1} -r {2} -s {3} -6 "
490 "--p{4}_src_start_ip 2001:1::1 "
491 "--p{4}_dst_start_ip 2001:2::0 "
492 "--p{4}_dst_end_ip 2001:2::F:423F "
493 "--p{5}_src_start_ip 2001:2::1 "
494 "--p{5}_dst_start_ip 2001:1::0 "
495 "--p{5}_dst_end_ip 2001:1::F:423F "
496 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
497 duration, rate, framesize,
498 _p0, _p1, _async, _latency,
500 timeout=int(duration)+60)
501 elif traffic_type in ["2-node-bridge"]:
502 (ret, stdout, stderr) = ssh.exec_command(
503 "sh -c '{0}/resources/tools/t-rex/t-rex-stateless.py "
504 "--duration={1} -r {2} -s {3} "
505 "--p{4}_src_start_ip 10.10.10.2 "
506 "--p{4}_src_end_ip 10.10.10.254 "
507 "--p{4}_dst_start_ip 20.20.20.2 "
508 "--p{5}_src_start_ip 20.20.20.2 "
509 "--p{5}_src_end_ip 20.20.20.254 "
510 "--p{5}_dst_start_ip 10.10.10.2 "
511 "{6} {7} --warmup_time={8}'".format(Constants.REMOTE_FW_DIR,
512 duration, rate, framesize,
513 _p0, _p1, _async, _latency,
515 timeout = int(duration) + 60)
517 raise NotImplementedError('Unsupported traffic type')
524 raise RuntimeError('T-rex stateless runtime error')
527 self._received = None
532 # last line from console output
533 line = stdout.splitlines()[-1]
536 logger.info('TrafficGen result: {0}'.format(self._result))
538 self._received = self._result.split(', ')[1].split('=')[1]
539 self._sent = self._result.split(', ')[2].split('=')[1]
540 self._loss = self._result.split(', ')[3].split('=')[1]
543 self._latency.append(self._result.split(', ')[4].split('=')[1])
544 self._latency.append(self._result.split(', ')[5].split('=')[1])
546 def stop_traffic_on_tg(self):
547 """Stop all traffic on TG.
550 :raises: RuntimeError if TG is not set.
552 if self._node is None:
553 raise RuntimeError("TG is not set")
554 if self._node['subtype'] == NodeSubTypeTG.TREX:
555 self.trex_stl_stop_remote_exec(self._node)
557 def send_traffic_on_tg(self, duration, rate, framesize,
558 traffic_type, warmup_time=5, async_call=False,
560 """Send traffic from all configured interfaces on TG.
562 :param duration: Duration of test traffic generation in seconds.
563 :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...).
564 :param framesize: Frame size (L2) in Bytes.
565 :param traffic_type: Traffic profile.
566 :param warmup_time: Warmup phase in seconds.
567 :param async_call: Async mode.
568 :param latency: With latency measurement.
572 :type traffic_type: str
573 :type warmup_time: int
574 :type async_call: bool
578 :raises: RuntimeError if TG is not set.
579 :raises: RuntimeError if node is not TG or subtype is not specified.
580 :raises: NotImplementedError if TG is not supported.
585 raise RuntimeError("TG is not set")
587 if node['type'] != NodeType.TG:
588 raise RuntimeError('Node type is not a TG')
590 if node['subtype'] is None:
591 raise RuntimeError('TG subtype not defined')
592 elif node['subtype'] == NodeSubTypeTG.TREX:
593 self.trex_stl_start_remote_exec(duration, rate, framesize,
594 traffic_type, async_call, latency,
595 warmup_time=warmup_time)
597 raise NotImplementedError("TG subtype not supported")
601 def no_traffic_loss_occurred(self):
602 """Fail if loss occurred in traffic run.
605 :raises: Exception if loss occured.
607 if self._loss is None:
608 raise Exception('The traffic generation has not been issued')
609 if self._loss != '0':
610 raise Exception('Traffic loss occurred: {0}'.format(self._loss))
612 def partial_traffic_loss_accepted(self, loss_acceptance,
613 loss_acceptance_type):
614 """Fail if loss is higher then accepted in traffic run.
616 :param loss_acceptance: Permitted drop ratio or frames count.
617 :param loss_acceptance_type: Type of permitted loss.
618 :type loss_acceptance: float
619 :type loss_acceptance_type: LossAcceptanceType
621 :raises: Exception if loss is above acceptance criteria.
623 if self._loss is None:
624 raise Exception('The traffic generation has not been issued')
626 if loss_acceptance_type == 'percentage':
627 loss = (float(self._loss) / float(self._sent)) * 100
628 elif loss_acceptance_type == 'frames':
629 loss = float(self._loss)
631 raise Exception('Loss acceptance type not supported')
633 if loss > float(loss_acceptance):
634 raise Exception("Traffic loss {} above loss acceptance: {}".format(
635 loss, loss_acceptance))