Update T-rex to v2.29
[csit.git] / resources / libraries / python / TrafficGenerator.py
index a98fb0d..1680438 100644 (file)
@@ -34,25 +34,40 @@ class TGDropRateSearchImpl(DropRateSearch):
 
     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 Exception('TG subtype not defined')
-        elif tg_instance._node['subtype'] == NodeSubTypeTG.TREX:
+        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, False)
+                                                   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
 
-            # TODO: getters for tg_instance
             logger.trace("comparing: {} < {} {}".format(loss,
                                                         loss_acceptance,
                                                         loss_acceptance_type))
@@ -63,6 +78,16 @@ class TGDropRateSearchImpl(DropRateSearch):
         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()
+
 
 class TrafficGenerator(object):
     """Traffic Generator."""
@@ -74,15 +99,25 @@ class TrafficGenerator(object):
         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 = 0
+        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.
 
-        :return: Number of lost packets.
+        :returns: Number of lost packets.
         :rtype: str
         """
         return self._loss
@@ -90,7 +125,7 @@ class TrafficGenerator(object):
     def get_sent(self):
         """Return number of sent packets.
 
-        :return: Number of sent packets.
+        :returns: Number of sent packets.
         :rtype: str
         """
         return self._sent
@@ -98,16 +133,24 @@ class TrafficGenerator(object):
     def get_received(self):
         """Return number of received packets.
 
-        :return: Number of received packets.
+        :returns: Number of received packets.
         :rtype: str
         """
         return self._received
 
-    #pylint: disable=too-many-arguments, too-many-locals
+    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):
+                                     test_type,
+                                     tg_if1_dst_mac=None, tg_if2_dst_mac=None):
         """TG initialization.
 
         :param tg_node: Traffic generator node.
@@ -117,7 +160,9 @@ class TrafficGenerator(object):
         :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.
-        :test_type: 'L2' or 'L3' - src/dst MAC address.
+        :param test_type: 'L2' or 'L3' - src/dst MAC address.
+        :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
@@ -126,27 +171,30 @@ class TrafficGenerator(object):
         :type tg_if2_adj_node: dict
         :type tg_if2_adj_if: str
         :type test_type: str
-        :return: nothing
+        :type tg_if1_dst_mac: str
+        :type tg_if2_dst_mac: str
+        :returns: nothing
+        :raises: RuntimeError in case of issue during initialization.
         """
 
         topo = Topology()
 
         if tg_node['type'] != NodeType.TG:
-            raise Exception('Node type is not a TG')
+            raise RuntimeError('Node type is not a TG')
         self._node = tg_node
 
         if tg_node['subtype'] == NodeSubTypeTG.TREX:
-            trex_path = "/opt/trex-core-2.03"
+            trex_path = "/opt/trex-core-2.29"
 
             ssh = SSH()
             ssh.connect(tg_node)
 
             (ret, stdout, stderr) = ssh.exec_command(
-                "sudo sh -c '{}/resources/tools/t-rex/"
-                "t-rex-installer.sh'".format(Constants.REMOTE_FW_DIR),
+                "sudo -E sh -c '{}/resources/tools/trex/"
+                "trex_installer.sh'".format(Constants.REMOTE_FW_DIR),
                 timeout=1800)
             if int(ret) != 0:
-                logger.error('trex installation failed: {0}'.format(
+                logger.error('TRex installation failed: {0}'.format(
                     stdout + stderr))
                 raise RuntimeError('Installation of TG failed')
 
@@ -164,13 +212,17 @@ class TrafficGenerator(object):
                 if2_adj_mac = topo.get_interface_mac(tg_if2_adj_node,
                                                      tg_if2_adj_if)
             else:
-                raise Exception("test_type unknown")
+                raise ValueError("test_type unknown")
+
+            if tg_if1_dst_mac is not None and tg_if2_dst_mac is not None:
+                if1_adj_mac = tg_if1_dst_mac
+                if2_adj_mac = tg_if2_dst_mac
 
             if min(if1_pci, if2_pci) != if1_pci:
                 if1_mac, if2_mac = if2_mac, if1_mac
                 if1_pci, if2_pci = if2_pci, if1_pci
                 if1_adj_mac, if2_adj_mac = if2_adj_mac, if1_adj_mac
-                self._ifaces_reordered = 1
+                self._ifaces_reordered = True
 
             if1_mac_hex = "0x"+if1_mac.replace(":", ",0x")
             if2_mac_hex = "0x"+if2_mac.replace(":", ",0x")
@@ -182,7 +234,6 @@ class TrafficGenerator(object):
                 "- port_limit      : 2\n"
                 "  version         : 2\n"
                 "  interfaces      : [\"{}\",\"{}\"]\n"
-                "  port_bandwidth_gb : 10\n"
                 "  port_info       :\n"
                 "          - dest_mac        :   [{}]\n"
                 "            src_mac         :   [{}]\n"
@@ -197,17 +248,19 @@ class TrafficGenerator(object):
                 .format(stdout + stderr))
                 raise RuntimeError('trex config generation error')
 
-            (ret, stdout, stderr) = ssh.exec_command(
-                "sh -c 'cd {0}/scripts/ && sudo ./trex-cfg'".format(trex_path))
-            if int(ret) != 0:
-                logger.error('trex-cfg failed: {0}'.format(stdout + stderr))
-                raise RuntimeError('trex-cfg failed')
-
             max_startup_retries = 3
             while max_startup_retries > 0:
                 # kill T-rex only if it is already running
                 (ret, _, _) = ssh.exec_command(
-                    "sh -c 'pgrep t-rex && sudo pkill t-rex'")
+                    "sh -c 'pgrep t-rex && sudo pkill t-rex && sleep 3'")
+
+                # configure T-rex
+                (ret, stdout, stderr) = ssh.exec_command(
+                    "sh -c 'cd {0}/scripts/ && sudo ./trex-cfg'"\
+                    .format(trex_path))
+                if int(ret) != 0:
+                    logger.error('trex-cfg failed: {0}'.format(stdout + stderr))
+                    raise RuntimeError('trex-cfg failed')
 
                 # start T-rex
                 (ret, _, _) = ssh.exec_command(
@@ -220,7 +273,8 @@ class TrafficGenerator(object):
 
                 # get T-rex server info
                 (ret, _, _) = ssh.exec_command(
-                    "sh -c '{0}/resources/tools/t-rex/t-rex-server-info.py'"\
+                    "sh -c 'sleep 3; "
+                    "{0}/resources/tools/trex/trex_server_info.py'"\
                     .format(Constants.REMOTE_FW_DIR),
                     timeout=120)
                 if int(ret) == 0:
@@ -229,25 +283,26 @@ class TrafficGenerator(object):
                 # try again
                 max_startup_retries -= 1
             # after max retries T-rex is still not responding to API
-            # critical error occured
+            # critical error occurred
             raise RuntimeError('t-rex-64 startup failed')
 
-
     @staticmethod
     def teardown_traffic_generator(node):
         """TG teardown.
 
         :param node: Traffic generator node.
         :type node: dict
-        :return: nothing
+        :returns: nothing
+        :raises: RuntimeError if T-rex 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'")
+                "sh -c 'sudo pkill t-rex && sleep 3'")
             if int(ret) != 0:
                 logger.error('pkill t-rex failed: {0}'.format(stdout + stderr))
                 raise RuntimeError('pkill t-rex failed')
@@ -258,23 +313,22 @@ class TrafficGenerator(object):
 
         :param node: T-REX generator node.
         :type node: dict
-        :return: Nothing
+        :returns: Nothing
+        :raises: RuntimeError if stop traffic script fails.
         """
         ssh = SSH()
         ssh.connect(node)
 
-        (ret, stdout, stderr) = ssh.exec_command(
-            "sh -c '{}/resources/tools/t-rex/"
-            "t-rex-stateless-stop.py'".format(Constants.REMOTE_FW_DIR))
-        logger.trace(ret)
-        logger.trace(stdout)
-        logger.trace(stderr)
+        (ret, _, _) = ssh.exec_command(
+            "sh -c '{}/resources/tools/trex/"
+            "trex_stateless_stop.py'".format(Constants.REMOTE_FW_DIR))
 
         if int(ret) != 0:
             raise RuntimeError('T-rex stateless runtime error')
 
     def trex_stl_start_remote_exec(self, duration, rate, framesize,
-                                   traffic_type, async_call, warmup_time=5):
+                                   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.
@@ -282,75 +336,43 @@ class TrafficGenerator(object):
         :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: int
+        :type framesize: str
         :type traffic_type: str
         :type async_call: bool
+        :type latency: bool
         :type warmup_time: int
-        :return: Nothing
+        :returns: Nothing
+        :raises: RuntimeError in case of TG driver issue.
         """
         ssh = SSH()
         ssh.connect(self._node)
 
-        _p0 = 1
-        _p1 = 2
-        _async = ""
-
-        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 '{0}/resources/tools/t-rex/t-rex-stateless.py "
-                "--duration={1} -r {2} -s {3} "
-                "--p{4}_src_start_ip 10.10.10.1 "
-                "--p{4}_src_end_ip 10.10.10.254 "
-                "--p{4}_dst_start_ip 20.20.20.1 "
-                "--p{5}_src_start_ip 20.20.20.1 "
-                "--p{5}_src_end_ip 20.20.20.254 "
-                "--p{5}_dst_start_ip 10.10.10.1 "
-                "{6} --warmup_time={7}'".format(Constants.REMOTE_FW_DIR,
-                                                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 '{0}/resources/tools/t-rex/t-rex-stateless.py "
-                "--duration={1} -r {2} -s {3} "
-                "--p{4}_src_start_ip 10.10.10.2 "
-                "--p{4}_src_end_ip 10.10.10.254 "
-                "--p{4}_dst_start_ip 20.20.20.2 "
-                "--p{5}_src_start_ip 20.20.20.2 "
-                "--p{5}_src_end_ip 20.20.20.254 "
-                "--p{5}_dst_start_ip 10.10.10.2 "
-                "{6} --warmup_time={7}'".format(Constants.REMOTE_FW_DIR,
-                                                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 '{0}/resources/tools/t-rex/t-rex-stateless.py "
-                "--duration={1} -r {2} -s {3} -6 "
-                "--p{4}_src_start_ip 2001:1::2 "
-                "--p{4}_src_end_ip 2001:1::FE "
-                "--p{4}_dst_start_ip 2001:2::2 "
-                "--p{5}_src_start_ip 2001:2::2 "
-                "--p{5}_src_end_ip 2001:2::FE "
-                "--p{5}_dst_start_ip 2001:1::2 "
-                "{6} --warmup_time={7}'".format(Constants.REMOTE_FW_DIR,
-                                                duration, rate, framesize, _p0,
-                                                _p1, _async, warmup_time),
-                timeout=int(duration)+60)
-        else:
-            raise NotImplementedError('Unsupported traffic type')
-
-        logger.trace(ret)
-        logger.trace(stdout)
-        logger.trace(stderr)
+        _async = "--async" if async_call else ""
+        _latency = "--latency" if latency else ""
+        _p0, _p1 = (2, 1) if self._ifaces_reordered else (1, 2)
+
+        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 int(ret) != 0:
             raise RuntimeError('T-rex stateless runtime error')
@@ -359,6 +381,7 @@ class TrafficGenerator(object):
             self._received = None
             self._sent = None
             self._loss = None
+            self._latency = None
         else:
             # last line from console output
             line = stdout.splitlines()[-1]
@@ -370,10 +393,15 @@ class TrafficGenerator(object):
             self._sent = self._result.split(', ')[2].split('=')[1]
             self._loss = self._result.split(', ')[3].split('=')[1]
 
+            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
+        """Stop all traffic on TG.
 
-        :return: Nothing
+        :returns: Nothing
+        :raises: RuntimeError if TG is not set.
         """
         if self._node is None:
             raise RuntimeError("TG is not set")
@@ -381,19 +409,29 @@ class TrafficGenerator(object):
             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):
+                           traffic_type, warmup_time=5, async_call=False,
+                           latency=True):
         """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.
+        :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
-        :return: TG output.
+        :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.
         """
 
         node = self._node
@@ -401,13 +439,13 @@ class TrafficGenerator(object):
             raise RuntimeError("TG is not set")
 
         if node['type'] != NodeType.TG:
-            raise Exception('Node type is not a TG')
+            raise RuntimeError('Node type is not a TG')
 
         if node['subtype'] is None:
-            raise Exception('TG subtype not defined')
+            raise RuntimeError('TG subtype not defined')
         elif node['subtype'] == NodeSubTypeTG.TREX:
-            self.trex_stl_start_remote_exec(duration, rate, framesize,
-                                            traffic_type, async_call,
+            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")
@@ -417,7 +455,8 @@ class TrafficGenerator(object):
     def no_traffic_loss_occurred(self):
         """Fail if loss occurred in traffic run.
 
-        :return: nothing
+        :returns: nothing
+        :raises: Exception if loss occured.
         """
         if self._loss is None:
             raise Exception('The traffic generation has not been issued')
@@ -428,7 +467,12 @@ class TrafficGenerator(object):
                                       loss_acceptance_type):
         """Fail if loss is higher then accepted in traffic run.
 
-        :return: nothing
+        :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')