Update T-rex version to v2.02
[csit.git] / resources / libraries / python / TrafficGenerator.py
index fb9ae4d..267f5d2 100644 (file)
 """Performance testing traffic generator library."""
 
 from robot.api import logger
 """Performance testing traffic generator library."""
 
 from robot.api import logger
+from robot.libraries.BuiltIn import BuiltIn
 
 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.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):
+
+        # 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 Exception('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, False)
+            loss = tg_instance.get_loss()
+            sent = tg_instance.get_sent()
+            if self.loss_acceptance_type_is_percentage():
+                loss = (float(loss) / float(sent)) * 100
+
+            # TODO: getters for tg_instance
+            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")
 
 
-__all__ = ['TrafficGenerator']
 
 class TrafficGenerator(object):
 
 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):
     ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
 
     def __init__(self):
@@ -32,24 +74,51 @@ class TrafficGenerator(object):
         self._loss = None
         self._sent = None
         self._received = None
         self._loss = None
         self._sent = None
         self._received = None
-        #T-REX interface order mapping
+        self._node = None
+        # T-REX interface order mapping
         self._ifaces_reordered = 0
 
         self._ifaces_reordered = 0
 
+    def get_loss(self):
+        """Return number of lost packets.
+
+        :return: Number of lost packets.
+        :rtype: str
+        """
+        return self._loss
+
+    def get_sent(self):
+        """Return number of sent packets.
+
+        :return: Number of sent packets.
+        :rtype: str
+        """
+        return self._sent
+
+    def get_received(self):
+        """Return number of received packets.
+
+        :return: Number of received packets.
+        :rtype: str
+        """
+        return self._received
+
+    #pylint: disable=too-many-arguments, too-many-locals
     def initialize_traffic_generator(self, tg_node, tg_if1, tg_if2,
                                      dut1_node, dut1_if1, dut1_if2,
                                      dut2_node, dut2_if1, dut2_if2,
                                      test_type):
     def initialize_traffic_generator(self, tg_node, tg_if1, tg_if2,
                                      dut1_node, dut1_if1, dut1_if2,
                                      dut2_node, dut2_if1, dut2_if2,
                                      test_type):
-        """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 dut1_node: DUT1 node
-        :param dut1_if1: DUT1 - name of first interface
-        :param dut1_if2: DUT1 - name of second interface
-        :param dut2_node: DUT2 node
-        :param dut2_if1: DUT2 - name of first interface
-        :param dut2_if2: DUT2 - name of second interface
-        :test_type: 'L2' or 'L3' - src/dst MAC address
+        """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 dut1_node: DUT1 node.
+        :param dut1_if1: DUT1 - name of first interface.
+        :param dut1_if2: DUT1 - name of second interface.
+        :param dut2_node: DUT2 node.
+        :param dut2_if1: DUT2 - name of first interface.
+        :param dut2_if2: DUT2 - name of second interface.
+        :test_type: 'L2' or 'L3' - src/dst MAC address.
         :type tg_node: dict
         :type tg_if1: str
         :type tg_if2: str
         :type tg_node: dict
         :type tg_if1: str
         :type tg_if2: str
@@ -63,12 +132,14 @@ class TrafficGenerator(object):
         :return: nothing
         """
 
         :return: nothing
         """
 
-        trex_path = "/opt/trex-core-1.91"
+        trex_path = "/opt/trex-core-2.02"
 
         topo = Topology()
 
         if tg_node['type'] != NodeType.TG:
             raise Exception('Node type is not a TG')
 
         topo = Topology()
 
         if tg_node['type'] != NodeType.TG:
             raise Exception('Node type is not a TG')
+        self._node = tg_node
+
         if tg_node['subtype'] == NodeSubTypeTG.TREX:
             ssh = SSH()
             ssh.connect(tg_node)
         if tg_node['subtype'] == NodeSubTypeTG.TREX:
             ssh = SSH()
             ssh.connect(tg_node)
@@ -103,6 +174,7 @@ class TrafficGenerator(object):
                 "- port_limit      : 2\n"
                 "  version         : 2\n"
                 "  interfaces      : [\"{}\",\"{}\"]\n"
                 "- port_limit      : 2\n"
                 "  version         : 2\n"
                 "  interfaces      : [\"{}\",\"{}\"]\n"
+                "  port_bandwidth_gb : 10\n"
                 "  port_info       :\n"
                 "          - dest_mac        :   [{}]\n"
                 "            src_mac         :   [{}]\n"
                 "  port_info       :\n"
                 "          - dest_mac        :   [{}]\n"
                 "            src_mac         :   [{}]\n"
@@ -125,9 +197,12 @@ class TrafficGenerator(object):
                 logger.error('trex-cfg failed: {0}'.format(stdout + stderr))
                 raise RuntimeError('trex-cfg failed')
 
                 logger.error('trex-cfg failed: {0}'.format(stdout + stderr))
                 raise RuntimeError('trex-cfg failed')
 
+            (ret, _, _) = ssh.exec_command(
+                "sh -c 'pgrep t-rex && sudo pkill t-rex'")
+
             (ret, _, _) = ssh.exec_command(
                 "sh -c 'cd {0}/scripts/ && "
             (ret, _, _) = ssh.exec_command(
                 "sh -c 'cd {0}/scripts/ && "
-                "sudo nohup ./t-rex-64 -i -c 4 --iom 0 > /dev/null 2>&1 &'"
+                "sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &'"
                 "> /dev/null"\
                 .format(trex_path))
             if int(ret) != 0:
                 "> /dev/null"\
                 .format(trex_path))
             if int(ret) != 0:
@@ -135,12 +210,12 @@ class TrafficGenerator(object):
 
     @staticmethod
     def teardown_traffic_generator(node):
 
     @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
         """
         :type node: dict
         :return: nothing
         """
-
         if node['type'] != NodeType.TG:
             raise Exception('Node type is not a TG')
         if node['subtype'] == NodeSubTypeTG.TREX:
         if node['type'] != NodeType.TG:
             raise Exception('Node type is not a TG')
         if node['subtype'] == NodeSubTypeTG.TREX:
@@ -152,95 +227,194 @@ class TrafficGenerator(object):
                 logger.error('pkill t-rex failed: {0}'.format(stdout + stderr))
                 raise RuntimeError('pkill t-rex failed')
 
                 logger.error('pkill t-rex failed: {0}'.format(stdout + stderr))
                 raise RuntimeError('pkill t-rex failed')
 
-    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: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...)
-        :param framesize: Frame size (L2) in Bytes
-        :param traffic_type: Traffic profile
-        :type nodes_info: dict
-        :type duration: str
-        :type rate: str
-        :type framesize: str
-        :type traffic_type: str
-        :return: TG output
-        :rtype: str
+    @staticmethod
+    def trex_stl_stop_remote_exec(node):
+        """Execute script on remote node over ssh to stop running traffic.
+
+        :param node: T-REX generator node.
+        :type node: dict
+        :return: Nothing
         """
         """
+        ssh = SSH()
+        ssh.connect(node)
 
 
-        node = nodes_info["TG"]
+        (ret, stdout, stderr) = ssh.exec_command(
+            "sh -c '/tmp/openvpp-testing/resources/tools/t-rex/"
+            "t-rex-stateless-stop.py'")
+        logger.trace(ret)
+        logger.trace(stdout)
+        logger.trace(stderr)
 
 
-        if node['type'] != NodeType.TG:
-            raise Exception('Node type is not a TG')
+        if int(ret) != 0:
+            raise RuntimeError('T-rex stateless runtime error')
 
 
-        if node['subtype'] is None:
-            raise Exception('TG subtype not defined')
+    def trex_stl_start_remote_exec(self, duration, rate, framesize,
+                                   traffic_type, async_call, 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 warmup_time: Warmup time period.
+        :type duration: int
+        :type rate: str
+        :type framesize: int
+        :type traffic_type: str
+        :type async_call: bool
+        :type warmup_time: int
+        :return: Nothing
+        """
         ssh = SSH()
         ssh = SSH()
-        ssh.connect(node)
+        ssh.connect(self._node)
 
 
-        if node['subtype'] == NodeSubTypeTG.TREX:
+        _p0 = 1
+        _p1 = 2
+        _async = ""
 
 
-            _p0 = 1
-            _p1 = 2
-
-            if self._ifaces_reordered != 0:
-                _p0, _p1 = _p1, _p0
-
-            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/"
-                    "t-rex-stateless.py "
-                    "-d {0} -r {1} -s {2} "
-                    "--p{3}_src_start_ip 10.10.10.1 "
-                    "--p{3}_src_end_ip 10.10.10.254 "
-                    "--p{3}_dst_start_ip 20.20.20.1 "
-                    "--p{4}_src_start_ip 20.20.20.1 "
-                    "--p{4}_src_end_ip 20.20.20.254 "
-                    "--p{4}_dst_start_ip 10.10.10.1'".\
-                    format(duration, rate, framesize, _p0, _p1),\
-                    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/"
-                    "t-rex-stateless.py "
-                    "-d {0} -r {1} -s {2} "
-                    "--p{3}_src_start_ip 10.10.10.2 "
-                    "--p{3}_src_end_ip 10.10.10.254 "
-                    "--p{3}_dst_start_ip 20.20.20.2 "
-                    "--p{4}_src_start_ip 20.20.20.2 "
-                    "--p{4}_src_end_ip 20.20.20.254 "
-                    "--p{4}_dst_start_ip 10.10.10.2'".\
-                    format(duration, rate, framesize, _p0, _p1),\
-                    timeout=int(duration)+60)
-            else:
-                raise NotImplementedError('Unsupported traffic type')
+        if async_call:
+            _async = "--async"
+        if self._ifaces_reordered != 0:
+            _p0, _p1 = _p1, _p0
 
 
+        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/"
+                "t-rex-stateless.py "
+                "--duration={0} -r {1} -s {2} "
+                "--p{3}_src_start_ip 10.10.10.1 "
+                "--p{3}_src_end_ip 10.10.10.254 "
+                "--p{3}_dst_start_ip 20.20.20.1 "
+                "--p{4}_src_start_ip 20.20.20.1 "
+                "--p{4}_src_end_ip 20.20.20.254 "
+                "--p{4}_dst_start_ip 10.10.10.1 "
+                "{5} --warmup_time={6}'".format(duration, rate, framesize, _p0,
+                                                _p1, _async, warmup_time),
+                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/"
+                "t-rex-stateless.py "
+                "--duration={0} -r {1} -s {2} "
+                "--p{3}_src_start_ip 10.10.10.2 "
+                "--p{3}_src_end_ip 10.10.10.254 "
+                "--p{3}_dst_start_ip 20.20.20.2 "
+                "--p{4}_src_start_ip 20.20.20.2 "
+                "--p{4}_src_end_ip 20.20.20.254 "
+                "--p{4}_dst_start_ip 10.10.10.2 "
+                "{5} --warmup_time={6}'".format(duration, rate, framesize, _p0,
+                                                _p1, _async, warmup_time),
+                timeout=int(duration)+60)
+        elif traffic_type in ["3-node-IPv6"]:
+            (ret, stdout, stderr) = ssh.exec_command(
+                "sh -c '/tmp/openvpp-testing/resources/tools/t-rex/"
+                "t-rex-stateless.py "
+                "--duration={0} -r {1} -s {2} -6 "
+                "--p{3}_src_start_ip 2001:1::2 "
+                "--p{3}_src_end_ip 2001:1::FE "
+                "--p{3}_dst_start_ip 2001:2::2 "
+                "--p{4}_src_start_ip 2001:2::2 "
+                "--p{4}_src_end_ip 2001:2::FE "
+                "--p{4}_dst_start_ip 2001:1::2 "
+                "{5} --warmup_time={6}'".format(duration, rate, framesize, _p0,
+                                                _p1, _async, warmup_time),
+                timeout=int(duration)+60)
         else:
         else:
-            raise NotImplementedError("TG subtype not supported")
+            raise NotImplementedError('Unsupported traffic type')
 
         logger.trace(ret)
         logger.trace(stdout)
         logger.trace(stderr)
 
 
         logger.trace(ret)
         logger.trace(stdout)
         logger.trace(stderr)
 
-        for line in stdout.splitlines():
-            pass
+        if int(ret) != 0:
+            raise RuntimeError('T-rex stateless runtime error')
+        elif async_call:
+            #no result
+            self._received = None
+            self._sent = None
+            self._loss = None
+        else:
+            # last line from console output
+            line = stdout.splitlines()[-1]
+
+            self._result = line
+            logger.info('TrafficGen result: {0}'.format(self._result))
 
 
-        self._result = line
-        logger.info('TrafficGen result: {0}'.format(self._result))
+            self._received = self._result.split(', ')[1].split('=')[1]
+            self._sent = self._result.split(', ')[2].split('=')[1]
+            self._loss = self._result.split(', ')[3].split('=')[1]
 
 
-        self._loss = self._result.split(', ')[3].split('=')[1]
+    def stop_traffic_on_tg(self):
+        """Stop all traffic on TG
+
+        :return: Nothing
+        """
+        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)
+
+    def send_traffic_on_tg(self, duration, rate, framesize,
+                           traffic_type, warmup_time=5, async_call=False):
+        """Send traffic from all configured interfaces on TG.
+
+        :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.
+        :type duration: str
+        :type rate: str
+        :type framesize: str
+        :type traffic_type: str
+        :return: TG output.
+        :rtype: str
+        """
+
+        node = self._node
+        if node is None:
+            raise RuntimeError("TG is not set")
+
+        if node['type'] != NodeType.TG:
+            raise Exception('Node type is not a TG')
+
+        if node['subtype'] is None:
+            raise Exception('TG subtype not defined')
+        elif node['subtype'] == NodeSubTypeTG.TREX:
+            self.trex_stl_start_remote_exec(duration, rate, framesize,
+                                            traffic_type, async_call,
+                                            warmup_time=warmup_time)
+        else:
+            raise NotImplementedError("TG subtype not supported")
 
         return self._result
 
 
         return self._result
 
-    def no_traffic_loss_occured(self):
-        """Fail is loss occured in traffic run
+    def no_traffic_loss_occurred(self):
+        """Fail if loss occurred in traffic run.
+
         :return: nothing
         """
         :return: nothing
         """
-
         if self._loss is None:
             raise Exception('The traffic generation has not been issued')
         if self._loss != '0':
         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.
+
+        :return: nothing
+        """
+        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))