DropRateSearch library
[csit.git] / resources / libraries / python / TrafficGenerator.py
index 24bec0a..c3af086 100644 (file)
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
 # 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.api import logger
+from robot.libraries.BuiltIn import BuiltIn
+from robot.api.deco import keyword
 
 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']
+__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_stateless_remote_exec method
+        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_stateless_remote_exec(self.get_duration(), unit_rate,
+                                                   frame_size, traffic_type)
+
+            #TODO:getters for tg_instance and loss_acceptance_type
+            logger.trace("comparing: {} < {} ".format(tg_instance._loss, loss_acceptance))
+            if float(tg_instance._loss) > float(loss_acceptance):
+                return False
+            else:
+                return True
+        else:
+            raise NotImplementedError("TG subtype not supported")
 
 class TrafficGenerator(object):
     """Traffic Generator"""
 
 
 class TrafficGenerator(object):
     """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._received = None
     def __init__(self):
         self._result = None
         self._loss = None
         self._sent = None
         self._received = None
+        self._node = None
+        #T-REX interface order mapping
+        self._ifaces_reordered = 0
 
 
-    @staticmethod
-    def initialize_traffic_generator(node, interface1, interface2):
+    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
         """TG initialization
-        :param node: Traffic generator node
-        :param interface1: PCI address of first interface
-        :param interface2: PCI address of second interface
-        :type node: dict
-        :type interface1: str
-        :type interface2: str
+        :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 dut1_node: dict
+        :type dut1_if1: str
+        :type dut1_if2: str
+        :type dut2_node: dict
+        :type dut2_if1: str
+        :type dut2_if2: str
+        :type test_type: str
         :return: nothing
         """
 
         :return: nothing
         """
 
-        if node['type'] != NodeType.TG:
+        trex_path = "/opt/trex-core-1.91"
+
+        topo = Topology()
+
+        if tg_node['type'] != NodeType.TG:
             raise Exception('Node type is not a TG')
             raise Exception('Node type is not a TG')
-        if node['subtype'] == NodeSubTypeTG.TREX:
+        self._node = tg_node
+
+        if tg_node['subtype'] == NodeSubTypeTG.TREX:
             ssh = SSH()
             ssh = SSH()
-            ssh.connect(node)
+            ssh.connect(tg_node)
+
+            if1_pci = topo.get_interface_pci_addr(tg_node, tg_if1)
+            if2_pci = topo.get_interface_pci_addr(tg_node, tg_if2)
+            if1_mac = topo.get_interface_mac(tg_node, tg_if1)
+            if2_mac = topo.get_interface_mac(tg_node, tg_if2)
+
+            if test_type == 'L2':
+                if1_adj_mac = if2_mac
+                if2_adj_mac = if1_mac
+            elif test_type == 'L3':
+                if1_adj_mac = topo.get_interface_mac(dut1_node, dut1_if1)
+                if2_adj_mac = topo.get_interface_mac(dut2_node, dut2_if2)
+            else:
+                raise Exception("test_type unknown")
+
+            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
+
+            if1_mac_hex = "0x"+if1_mac.replace(":", ",0x")
+            if2_mac_hex = "0x"+if2_mac.replace(":", ",0x")
+            if1_adj_mac_hex = "0x"+if1_adj_mac.replace(":", ",0x")
+            if2_adj_mac_hex = "0x"+if2_adj_mac.replace(":", ",0x")
 
             (ret, stdout, stderr) = ssh.exec_command(
 
             (ret, stdout, stderr) = ssh.exec_command(
-                "sh -c 'cd /opt/trex-core-1.88/scripts/ && "
-                "--bind=igb_uio {0} {1}".format(interface1, interface2))
+                "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
+                "- port_limit      : 2\n"
+                "  version         : 2\n"
+                "  interfaces      : [\"{}\",\"{}\"]\n"
+                "  port_bandwidth_gb : 10\n"
+                "  port_info       :\n"
+                "          - dest_mac        :   [{}]\n"
+                "            src_mac         :   [{}]\n"
+                "          - dest_mac        :   [{}]\n"
+                "            src_mac         :   [{}]\n"
+                "EOF'"\
+                .format(if1_pci, if2_pci,
+                        if1_adj_mac_hex, if1_mac_hex,
+                        if2_adj_mac_hex, if2_mac_hex))
+            if int(ret) != 0:
+                logger.error("failed to create t-rex config: {}"\
+                .format(stdout + stderr))
+                raise RuntimeError('trex config generation error')
+
             (ret, stdout, stderr) = ssh.exec_command(
             (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 &'")
+                "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')
+
+            (ret, _, _) = ssh.exec_command(
+                "sh -c 'cd {0}/scripts/ && "
+                "sudo nohup ./t-rex-64 -i -c 4 --iom 0 > /dev/null 2>&1 &'"
+                "> /dev/null"\
+                .format(trex_path))
+            if int(ret) != 0:
+                raise RuntimeError('t-rex-64 startup failed')
 
     @staticmethod
     def teardown_traffic_generator(node):
 
     @staticmethod
     def teardown_traffic_generator(node):
@@ -71,17 +185,80 @@ class TrafficGenerator(object):
             ssh.connect(node)
             (ret, stdout, stderr) = ssh.exec_command(
                 "sh -c 'sudo pkill t-rex'")
             ssh.connect(node)
             (ret, stdout, stderr) = ssh.exec_command(
                 "sh -c 'sudo pkill t-rex'")
+            if int(ret) != 0:
+                logger.error('pkill t-rex failed: {0}'.format(stdout + stderr))
+                raise RuntimeError('pkill t-rex failed')
+
+    def trex_stateless_remote_exec(self, duration, rate, framesize,
+                                   traffic_type):
+        """Execute stateless script on remote node over ssh
+
+        :param node: remote node
+        :param traffic_type: Traffic profile
+        :type node: dict
+        :type traffic_type: str
+        """
+        ssh = SSH()
+        ssh.connect(self._node)
+
+        _p0 = 1
+        _p1 = 2
 
 
-    def send_traffic_on(self, nodes_info, duration, rate,
+        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')
+
+        logger.trace(ret)
+        logger.trace(stdout)
+        logger.trace(stderr)
+
+        #last line from console output
+        line = stdout.splitlines()[-1]
+
+        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]
+
+    def send_traffic_on(self, node, duration, rate,
                         framesize, traffic_type):
         """Send traffic from all configured interfaces on TG
                         framesize, traffic_type):
         """Send traffic from all configured interfaces on TG
-        :param nodes_info: Dictionary containing information on all nodes
-        in topology.
+        :param node: Dictionary containing TG information
         :param duration: Duration of test traffic generation in seconds
         :param duration: Duration of test traffic generation in seconds
-        :param rate: Percentage of linerate
+        :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...)
         :param framesize: Frame size (L2) in Bytes
         :param traffic_type: Traffic profile
         :param framesize: Frame size (L2) in Bytes
         :param traffic_type: Traffic profile
-        :type nodes_info: dict
+        :type node: dict
         :type duration: str
         :type rate: str
         :type framesize: str
         :type duration: str
         :type rate: str
         :type framesize: str
@@ -90,84 +267,17 @@ class TrafficGenerator(object):
         :rtype: str
         """
 
         :rtype: str
         """
 
-        node = nodes_info["TG"]
-
         if node['type'] != NodeType.TG:
             raise Exception('Node type is not a TG')
 
         if node['subtype'] is None:
             raise Exception('TG subtype not defined')
         if node['type'] != NodeType.TG:
             raise Exception('Node type is not a TG')
 
         if node['subtype'] is None:
             raise Exception('TG subtype not defined')
-
-        ssh = SSH()
-        ssh.connect(node)
-
-        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']
-
-        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']
-
-
-        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')
-
+        elif node['subtype'] == NodeSubTypeTG.TREX:
+            self.trex_stateless_remote_exec(duration, rate, framesize,
+                                            traffic_type)
         else:
             raise NotImplementedError("TG subtype not supported")
 
         else:
             raise NotImplementedError("TG subtype not supported")
 
-        logger.trace(ret)
-        logger.trace(stdout)
-        logger.trace(stderr)
-
-        for line in stdout.splitlines():
-            pass
-
-        self._result = line
-        logger.info('TrafficGen result: {0}'.format(self._result))
-
-        self._loss = self._result.split(', ')[3].split('=')[1]
-
         return self._result
 
     def no_traffic_loss_occured(self):
         return self._result
 
     def no_traffic_loss_occured(self):