-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
# See the License for the specific language governing permissions and
# limitations under the License.
-"""Traffic generator library."""
+"""Performance testing traffic generator library."""
from robot.api import logger
+from robot.libraries.BuiltIn import BuiltIn
+from resources.libraries.python.constants import Constants
from resources.libraries.python.ssh import SSH
from resources.libraries.python.topology import NodeType
from resources.libraries.python.topology import NodeSubTypeTG
from resources.libraries.python.topology import Topology
+from resources.libraries.python.DropRateSearch import DropRateSearch
+
+__all__ = ['TrafficGenerator', 'TGDropRateSearchImpl']
+
+
+class TGDropRateSearchImpl(DropRateSearch):
+ """Drop Rate Search implementation."""
+
+ def __init__(self):
+ super(TGDropRateSearchImpl, self).__init__()
+
+ def measure_loss(self, rate, frame_size, loss_acceptance,
+ loss_acceptance_type, traffic_type):
+ """Runs the traffic and evaluate the measured results.
+
+ :param rate: Offered traffic load.
+ :param frame_size: Size of frame.
+ :param loss_acceptance: Permitted drop ratio or frames count.
+ :param loss_acceptance_type: Type of permitted loss.
+ :param traffic_type: Traffic profile ([2,3]-node-L[2,3], ...).
+ :type rate: int
+ :type frame_size: str
+ :type loss_acceptance: float
+ :type loss_acceptance_type: LossAcceptanceType
+ :type traffic_type: str
+ :returns: Drop threshold exceeded? (True/False)
+ :rtype: bool
+ :raises: NotImplementedError if TG is not supported.
+ :raises: RuntimeError if TG is not specified.
+ """
+ # we need instance of TrafficGenerator instantiated by Robot Framework
+ # to be able to use trex_stl-*()
+ tg_instance = BuiltIn().get_library_instance(
+ 'resources.libraries.python.TrafficGenerator')
+
+ if tg_instance.node['subtype'] is None:
+ raise RuntimeError('TG subtype not defined')
+ elif tg_instance.node['subtype'] == NodeSubTypeTG.TREX:
+ unit_rate = str(rate) + self.get_rate_type_str()
+ tg_instance.trex_stl_start_remote_exec(self.get_duration(),
+ unit_rate, frame_size,
+ traffic_type)
+ loss = tg_instance.get_loss()
+ sent = tg_instance.get_sent()
+ if self.loss_acceptance_type_is_percentage():
+ loss = (float(loss) / float(sent)) * 100
+
+ logger.trace("comparing: {} < {} {}".format(loss,
+ loss_acceptance,
+ loss_acceptance_type))
+ if float(loss) > float(loss_acceptance):
+ return False
+ else:
+ return True
+ else:
+ raise NotImplementedError("TG subtype not supported")
+
+ def get_latency(self):
+ """Returns min/avg/max latency.
+
+ :returns: Latency stats.
+ :rtype: list
+ """
+ tg_instance = BuiltIn().get_library_instance(
+ 'resources.libraries.python.TrafficGenerator')
+ return tg_instance.get_latency_int()
-__all__ = ['TrafficGenerator']
class TrafficGenerator(object):
- """Traffic Generator"""
+ """Traffic Generator."""
+
+ # use one instance of TrafficGenerator for all tests in test suite
+ ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
def __init__(self):
self._result = None
self._loss = None
self._sent = None
+ self._latency = None
self._received = None
+ self._node = None
+ # T-REX interface order mapping
+ self._ifaces_reordered = False
+
+ @property
+ def node(self):
+ """Getter.
+
+ :returns: Traffic generator node.
+ :rtype: dict
+ """
+ return self._node
+
+ def get_loss(self):
+ """Return number of lost packets.
+
+ :returns: Number of lost packets.
+ :rtype: str
+ """
+ return self._loss
+
+ def get_sent(self):
+ """Return number of sent packets.
+
+ :returns: Number of sent packets.
+ :rtype: str
+ """
+ return self._sent
+
+ def get_received(self):
+ """Return number of received packets.
+
+ :returns: Number of received packets.
+ :rtype: str
+ """
+ return self._received
+
+ def get_latency_int(self):
+ """Return rounded min/avg/max latency.
+
+ :returns: Latency stats.
+ :rtype: list
+ """
+ return self._latency
+
+ def initialize_traffic_generator(self, tg_node, tg_if1, tg_if2,
+ tg_if1_adj_node, tg_if1_adj_if,
+ tg_if2_adj_node, tg_if2_adj_if,
+ test_type,
+ tg_if1_dst_mac=None, tg_if2_dst_mac=None):
+ """TG initialization.
+
+ :param tg_node: Traffic generator node.
+ :param tg_if1: TG - name of first interface.
+ :param tg_if2: TG - name of second interface.
+ :param tg_if1_adj_node: TG if1 adjecent node.
+ :param tg_if1_adj_if: TG if1 adjecent interface.
+ :param tg_if2_adj_node: TG if2 adjecent node.
+ :param tg_if2_adj_if: TG if2 adjecent interface.
+ :param test_type: 'L2', 'L3' or 'L7' - OSI Layer testing type.
+ :param tg_if1_dst_mac: Interface 1 destination MAC address.
+ :param tg_if2_dst_mac: Interface 2 destination MAC address.
+ :type tg_node: dict
+ :type tg_if1: str
+ :type tg_if2: str
+ :type tg_if1_adj_node: dict
+ :type tg_if1_adj_if: str
+ :type tg_if2_adj_node: dict
+ :type tg_if2_adj_if: str
+ :type test_type: str
+ :type tg_if1_dst_mac: str
+ :type tg_if2_dst_mac: str
+ :returns: nothing
+ :raises: RuntimeError in case of issue during initialization.
+ """
+ if tg_node['type'] != NodeType.TG:
+ raise RuntimeError('Node type is not a TG')
+ self._node = tg_node
+
+ if tg_node['subtype'] == NodeSubTypeTG.TREX:
+ ssh = SSH()
+ ssh.connect(tg_node)
+
+ (ret, _, _) = ssh.exec_command(
+ "sudo -E sh -c '{0}/resources/tools/trex/"
+ "trex_installer.sh {1}'".format(Constants.REMOTE_FW_DIR,
+ Constants.TREX_INSTALL_VERSION),
+ timeout=1800)
+ if int(ret) != 0:
+ raise RuntimeError('TRex installation failed.')
+
+ if1_pci = Topology().get_interface_pci_addr(tg_node, tg_if1)
+ if2_pci = Topology().get_interface_pci_addr(tg_node, tg_if2)
+ if1_addr = Topology().get_interface_mac(tg_node, tg_if1)
+ if2_addr = Topology().get_interface_mac(tg_node, tg_if2)
+
+ if test_type == 'L2':
+ if1_adj_addr = if2_addr
+ if2_adj_addr = if1_addr
+ elif test_type == 'L3':
+ if1_adj_addr = Topology().get_interface_mac(tg_if1_adj_node,
+ tg_if1_adj_if)
+ if2_adj_addr = Topology().get_interface_mac(tg_if2_adj_node,
+ tg_if2_adj_if)
+ elif test_type == 'L7':
+ if1_addr = Topology().get_interface_ip4(tg_node, tg_if1)
+ if2_addr = Topology().get_interface_ip4(tg_node, tg_if2)
+ if1_adj_addr = Topology().get_interface_ip4(tg_if1_adj_node,
+ tg_if1_adj_if)
+ if2_adj_addr = Topology().get_interface_ip4(tg_if2_adj_node,
+ tg_if2_adj_if)
+ else:
+ raise ValueError("Unknown Test Type")
+
+ # in case of switched environment we can override MAC addresses
+ if tg_if1_dst_mac is not None and tg_if2_dst_mac is not None:
+ if1_adj_addr = tg_if1_dst_mac
+ if2_adj_addr = tg_if2_dst_mac
+
+ if min(if1_pci, if2_pci) != if1_pci:
+ if1_pci, if2_pci = if2_pci, if1_pci
+ if1_addr, if2_addr = if2_addr, if1_addr
+ if1_adj_addr, if2_adj_addr = if2_adj_addr, if1_adj_addr
+ self._ifaces_reordered = True
+
+ if test_type == 'L2' or test_type == 'L3':
+ (ret, _, _) = ssh.exec_command(
+ "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
+ "- port_limit: 2\n"
+ " version: 2\n"
+ " interfaces: [\"{0}\",\"{1}\"]\n"
+ " port_info:\n"
+ " - dest_mac: [{2}]\n"
+ " src_mac: [{3}]\n"
+ " - dest_mac: [{4}]\n"
+ " src_mac: [{5}]\n"
+ "EOF'"\
+ .format(if1_pci, if2_pci,
+ "0x"+if1_adj_addr.replace(":", ",0x"),
+ "0x"+if1_addr.replace(":", ",0x"),
+ "0x"+if2_adj_addr.replace(":", ",0x"),
+ "0x"+if2_addr.replace(":", ",0x")))
+ elif test_type == 'L7':
+ (ret, _, _) = ssh.exec_command(
+ "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
+ "- port_limit: 2\n"
+ " version: 2\n"
+ " interfaces: [\"{0}\",\"{1}\"]\n"
+ " port_info:\n"
+ " - ip: [{2}]\n"
+ " default_gw: [{3}]\n"
+ " - ip: [{4}]\n"
+ " default_gw: [{5}]\n"
+ "EOF'"\
+ .format(if1_pci, if2_pci,
+ if1_addr, if1_adj_addr,
+ if2_addr, if2_adj_addr))
+ else:
+ raise ValueError("Unknown Test Type")
+ if int(ret) != 0:
+ raise RuntimeError('TRex config generation error')
+
+ for _ in range(0, 3):
+ # kill TRex only if it is already running
+ ssh.exec_command(
+ "sh -c 'pgrep t-rex && sudo pkill t-rex && sleep 3'")
+
+ # configure TRex
+ (ret, _, _) = ssh.exec_command(
+ "sh -c 'cd {0}/scripts/ && sudo ./trex-cfg'"\
+ .format(Constants.TREX_INSTALL_DIR))
+ if int(ret) != 0:
+ raise RuntimeError('trex-cfg failed')
+
+ # start TRex
+ if test_type == 'L2' or test_type == 'L3':
+ (ret, _, _) = ssh.exec_command(
+ "sh -c 'cd {0}/scripts/ && "
+ "sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /tmp/trex.log "
+ "2>&1 &' > /dev/null"\
+ .format(Constants.TREX_INSTALL_DIR))
+ elif test_type == 'L7':
+ (ret, _, _) = ssh.exec_command(
+ "sh -c 'cd {0}/scripts/ && "
+ "sudo nohup ./t-rex-64 --astf -i -c 7 --iom 0 > "
+ "/tmp/trex.log 2>&1 &' > /dev/null"\
+ .format(Constants.TREX_INSTALL_DIR))
+ else:
+ raise ValueError("Unknown Test Type")
+ if int(ret) != 0:
+ ssh.exec_command("sh -c 'cat /tmp/trex.log'")
+ raise RuntimeError('t-rex-64 startup failed')
+
+ # get TRex server info
+ (ret, _, _) = ssh.exec_command(
+ "sh -c 'sleep 3; "
+ "{0}/resources/tools/trex/trex_server_info.py'"\
+ .format(Constants.REMOTE_FW_DIR),
+ timeout=120)
+ if int(ret) == 0:
+ # If we get info TRex is running
+ return
+ # after max retries TRex is still not responding to API
+ # critical error occurred
+ raise RuntimeError('t-rex-64 startup failed')
@staticmethod
- def initialize_traffic_generator(node, interface1, interface2):
- """TG initialization
- :param node: Traffic generator node
- :param interface1: PCI address of first interface
- :param interface2: PCI address of second interface
+ def is_trex_running(node):
+ """Check if TRex is running using pidof.
+
+ :param node: Traffic generator node.
:type node: dict
- :type interface1: str
- :type interface2: str
- :return: nothing
+ :returns: True if TRex is running otherwise False.
+ :rtype: bool
+ :raises: RuntimeError if node type is not a TG.
"""
-
if node['type'] != NodeType.TG:
- raise Exception('Node type is not a TG')
- if node['subtype'] == NodeSubTypeTG.TREX:
- ssh = SSH()
- ssh.connect(node)
+ raise RuntimeError('Node type is not a TG')
- (ret, stdout, stderr) = ssh.exec_command(
- "sh -c 'cd /opt/trex-core-1.88/scripts/ && "
- "--bind=igb_uio {0} {1}".format(interface1, interface2))
- (ret, stdout, stderr) = ssh.exec_command(
- "sh -c 'cd /opt/trex-core-1.88/scripts/ && "
- "sudo nohup ./t-rex-64 -i -c 4 --iom 0 > /dev/null 2>&1 &'")
+ ssh = SSH()
+ ssh.connect(node)
+ ret, _, _ = ssh.exec_command_sudo("pidof t-rex")
+ return bool(int(ret) == 0)
@staticmethod
def teardown_traffic_generator(node):
- """TG teardown
- :param node: Traffic generator node
+ """TG teardown.
+
+ :param node: Traffic generator node.
:type node: dict
- :return: nothing
+ :returns: nothing
+ :raises: RuntimeError if TRex teardown failed.
+ :raises: RuntimeError if node type is not a TG.
"""
-
if node['type'] != NodeType.TG:
- raise Exception('Node type is not a TG')
+ raise RuntimeError('Node type is not a TG')
if node['subtype'] == NodeSubTypeTG.TREX:
ssh = SSH()
ssh.connect(node)
- (ret, stdout, stderr) = ssh.exec_command(
- "sh -c 'sudo pkill t-rex'")
-
- def send_traffic_on(self, nodes_info, duration, rate,
- framesize, traffic_type):
- """Send traffic from all configured interfaces on TG
- :param nodes_info: Dictionary containing information on all nodes
- in topology.
- :param duration: Duration of test traffic generation in seconds
- :param rate: Percentage of linerate
- :param framesize: Frame size (L2) in Bytes
- :param traffic_type: Traffic profile
- :type nodes_info: dict
- :type duration: str
+ (ret, _, _) = ssh.exec_command(
+ "sh -c 'sudo pkill t-rex && sleep 3'")
+ if int(ret) != 0:
+ raise RuntimeError('pkill t-rex failed')
+
+ @staticmethod
+ def trex_stl_stop_remote_exec(node):
+ """Execute script on remote node over ssh to stop running traffic.
+
+ :param node: TRex generator node.
+ :type node: dict
+ :returns: Nothing
+ :raises: RuntimeError if stop traffic script fails.
+ """
+ ssh = SSH()
+ ssh.connect(node)
+
+ (ret, _, _) = ssh.exec_command(
+ "sh -c '{}/resources/tools/trex/"
+ "trex_stateless_stop.py'".format(Constants.REMOTE_FW_DIR))
+
+ if int(ret) != 0:
+ raise RuntimeError('TRex stateless runtime error')
+
+ def trex_stl_start_remote_exec(self, duration, rate, framesize,
+ traffic_type, async_call=False,
+ latency=True, warmup_time=5):
+ """Execute script on remote node over ssh to start traffic.
+
+ :param duration: Time expresed in seconds for how long to send traffic.
+ :param rate: Traffic rate expressed with units (pps, %)
+ :param framesize: L2 frame size to send (without padding and IPG).
+ :param traffic_type: Traffic profile.
+ :param async_call: If enabled then don't wait for all incomming trafic.
+ :param latency: With latency measurement.
+ :param warmup_time: Warmup time period.
+ :type duration: int
:type rate: str
:type framesize: str
:type traffic_type: str
- :return: TG output
- :rtype: str
+ :type async_call: bool
+ :type latency: bool
+ :type warmup_time: int
+ :returns: Nothing
+ :raises: RuntimeError in case of TG driver issue.
"""
+ ssh = SSH()
+ ssh.connect(self._node)
- node = nodes_info["TG"]
+ _async = "--async" if async_call else ""
+ _latency = "--latency" if latency else ""
+ _p0, _p1 = (2, 1) if self._ifaces_reordered else (1, 2)
- if node['type'] != NodeType.TG:
- raise Exception('Node type is not a TG')
+ profile_path = ("{0}/resources/traffic_profiles/trex/"
+ "{1}.py".format(Constants.REMOTE_FW_DIR,
+ traffic_type))
+ (ret, stdout, _) = ssh.exec_command(
+ "sh -c "
+ "'{0}/resources/tools/trex/trex_stateless_profile.py "
+ "--profile {1} "
+ "--duration {2} "
+ "--frame_size {3} "
+ "--rate {4} "
+ "--warmup_time {5} "
+ "--port_0 {6} "
+ "--port_1 {7} "
+ "{8} " # --async
+ "{9}'". # --latency
+ format(Constants.REMOTE_FW_DIR, profile_path, duration, framesize,
+ rate, warmup_time, _p0 - 1, _p1 - 1, _async, _latency),
+ timeout=int(duration) + 60)
- if node['subtype'] is None:
- raise Exception('TG subtype not defined')
+ if int(ret) != 0:
+ raise RuntimeError('TRex stateless runtime error')
+ elif async_call:
+ #no result
+ self._received = None
+ self._sent = None
+ self._loss = None
+ self._latency = None
+ else:
+ # last line from console output
+ line = stdout.splitlines()[-1]
- ssh = SSH()
- ssh.connect(node)
+ self._result = line
+ logger.info('TrafficGen result: {0}'.format(self._result))
- tg_port3_src_mac = Topology.get_interface_mac_by_port_key(node, "port3")
- _, adj_int = Topology.\
- get_adjacent_node_and_interface_by_key(nodes_info, node, "port3")
- tg_port3_dst_mac = adj_int['mac_address']
+ self._received = self._result.split(', ')[1].split('=')[1]
+ self._sent = self._result.split(', ')[2].split('=')[1]
+ self._loss = self._result.split(', ')[3].split('=')[1]
- tg_port5_src_mac = Topology.get_interface_mac_by_port_key(node, "port5")
- _, adj_int = Topology.\
- get_adjacent_node_and_interface_by_key(nodes_info, node, "port5")
- tg_port5_dst_mac = adj_int['mac_address']
+ self._latency = []
+ self._latency.append(self._result.split(', ')[4].split('=')[1])
+ self._latency.append(self._result.split(', ')[5].split('=')[1])
+ def stop_traffic_on_tg(self):
+ """Stop all traffic on TG.
- if node['subtype'] == NodeSubTypeTG.TREX:
- if traffic_type in ["3-node-xconnect", "3-node-bridge"]:
- (ret, stdout, stderr) = ssh.exec_command(
- "sh -c '/tmp/openvpp-testing/resources/tools/t-rex-stateless.py "
- "-d {0} -r {1}% -s {2} "
- "--p1_src_mac 52:00:00:00:00:01 "
- "--p1_dst_mac 52:00:00:00:00:02 "
- "--p1_src_start_ip 10.10.10.1 "
- "--p1_src_end_ip 10.10.10.254 "
- "--p1_dst_start_ip 20.20.20.1 "
- "--p1_dst_end_ip 20.20.20.254 "
- "--p2_src_mac 52:00:00:00:00:02 "
- "--p2_dst_mac 52:00:00:00:00:01 "
- "--p2_src_start_ip 20.20.20.1 "
- "--p2_src_end_ip 20.20.20.254 "
- "--p2_dst_start_ip 10.10.10.1 "
- "--p2_dst_end_ip 10.10.10.254'".\
- format(duration, rate, framesize), timeout=int(duration)+60)
- elif traffic_type in ["3-node-IPv4"]:
- (ret, stdout, stderr) = ssh.exec_command(
- "sh -c '/tmp/openvpp-testing/resources/tools/t-rex-stateless.py "
- "-d {0} -r {1}% -s {2} "
- "--p1_src_mac {3} "
- "--p1_dst_mac {4} "
- "--p1_src_start_ip 10.10.10.2 "
- "--p1_src_end_ip 10.10.10.254 "
- "--p1_dst_start_ip 20.20.20.2 "
- "--p1_dst_end_ip 20.20.20.2 "
- "--p2_src_mac {5} "
- "--p2_dst_mac {6} "
- "--p2_src_start_ip 20.20.20.2 "
- "--p2_src_end_ip 20.20.20.254 "
- "--p2_dst_start_ip 10.10.10.2 "
- "--p2_dst_end_ip 10.10.10.2'".\
- format(duration, rate, framesize,\
- tg_port3_src_mac, tg_port3_dst_mac,\
- tg_port5_src_mac, tg_port5_dst_mac),\
- timeout=int(duration)+60)
- else:
- raise NotImplementedError('Unsupported traffic type')
+ :returns: Nothing
+ :raises: RuntimeError if TG is not set.
+ """
+ if self._node is None:
+ raise RuntimeError("TG is not set")
+ if self._node['subtype'] == NodeSubTypeTG.TREX:
+ self.trex_stl_stop_remote_exec(self._node)
- else:
- raise NotImplementedError("TG subtype not supported")
+ def send_traffic_on_tg(self, duration, rate, framesize,
+ traffic_type, warmup_time=5, async_call=False,
+ latency=True):
+ """Send traffic from all configured interfaces on TG.
- logger.trace(ret)
- logger.trace(stdout)
- logger.trace(stderr)
+ :param duration: Duration of test traffic generation in seconds.
+ :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...).
+ :param framesize: Frame size (L2) in Bytes.
+ :param traffic_type: Traffic profile.
+ :param warmup_time: Warmup phase in seconds.
+ :param async_call: Async mode.
+ :param latency: With latency measurement.
+ :type duration: str
+ :type rate: str
+ :type framesize: str
+ :type traffic_type: str
+ :type warmup_time: int
+ :type async_call: bool
+ :type latency: bool
+ :returns: TG output.
+ :rtype: str
+ :raises: RuntimeError if TG is not set.
+ :raises: RuntimeError if node is not TG or subtype is not specified.
+ :raises: NotImplementedError if TG is not supported.
+ """
- for line in stdout.splitlines():
- pass
+ node = self._node
+ if node is None:
+ raise RuntimeError("TG is not set")
- self._result = line
- logger.info('TrafficGen result: {0}'.format(self._result))
+ if node['type'] != NodeType.TG:
+ raise RuntimeError('Node type is not a TG')
- self._loss = self._result.split(', ')[3].split('=')[1]
+ if node['subtype'] is None:
+ raise RuntimeError('TG subtype not defined')
+ elif node['subtype'] == NodeSubTypeTG.TREX:
+ self.trex_stl_start_remote_exec(int(duration), rate, framesize,
+ traffic_type, async_call, latency,
+ warmup_time=warmup_time)
+ else:
+ raise NotImplementedError("TG subtype not supported")
return self._result
- def no_traffic_loss_occured(self):
- """Fail is loss occured in traffic run
- :return: nothing
- """
+ def no_traffic_loss_occurred(self):
+ """Fail if loss occurred in traffic run.
+ :returns: nothing
+ :raises: Exception if loss occured.
+ """
if self._loss is None:
raise Exception('The traffic generation has not been issued')
if self._loss != '0':
- raise Exception('Traffic loss occured: {0}'.format(self._loss))
+ raise Exception('Traffic loss occurred: {0}'.format(self._loss))
+
+ def partial_traffic_loss_accepted(self, loss_acceptance,
+ loss_acceptance_type):
+ """Fail if loss is higher then accepted in traffic run.
+
+ :param loss_acceptance: Permitted drop ratio or frames count.
+ :param loss_acceptance_type: Type of permitted loss.
+ :type loss_acceptance: float
+ :type loss_acceptance_type: LossAcceptanceType
+ :returns: nothing
+ :raises: Exception if loss is above acceptance criteria.
+ """
+ if self._loss is None:
+ raise Exception('The traffic generation has not been issued')
+
+ if loss_acceptance_type == 'percentage':
+ loss = (float(self._loss) / float(self._sent)) * 100
+ elif loss_acceptance_type == 'frames':
+ loss = float(self._loss)
+ else:
+ raise Exception('Loss acceptance type not supported')
+
+ if loss > float(loss_acceptance):
+ raise Exception("Traffic loss {} above loss acceptance: {}".format(
+ loss, loss_acceptance))