CSIT-778: Add mac-ip binding acl l2bd perf test
[csit.git] / resources / libraries / python / L2Util.py
index e082459..6b8bc04 100644 (file)
@@ -13,6 +13,8 @@
 
 """L2 Utilities Library."""
 
+from textwrap import wrap
+
 from robot.api.deco import keyword
 
 from resources.libraries.python.topology import Topology
@@ -21,7 +23,31 @@ from resources.libraries.python.ssh import exec_cmd_no_error
 
 
 class L2Util(object):
-    """Utilities for l2 configuration"""
+    """Utilities for l2 configuration."""
+
+    @staticmethod
+    def mac_to_int(mac_str):
+        """Convert MAC address from string format (e.g. 01:02:03:04:05:06) to
+        integer representation (1108152157446).
+
+        :param mac_str: MAC address in string representation.
+        :type mac_str: str
+        :returns: Integer representation of MAC address.
+        :rtype: int
+        """
+        return int(mac_str.replace(':', ''), 16)
+
+    @staticmethod
+    def int_to_mac(mac_int):
+        """Convert MAC address from integer representation (e.g. 1108152157446)
+        to string format (01:02:03:04:05:06).
+
+        :param mac_int: MAC address in integer representation.
+        :type mac_int: str
+        :returns: String representation of MAC address.
+        :rtype: int
+        """
+        return ':'.join(wrap("{:012x}".format(mac_int), width=2))
 
     @staticmethod
     def vpp_add_l2fib_entry(node, mac, interface, bd_id):
@@ -192,17 +218,20 @@ class L2Util(object):
                                                     interface2=sw_iface1)
 
     @staticmethod
-    def linux_add_bridge(node, br_name, if_1, if_2):
+    def linux_add_bridge(node, br_name, if_1, if_2, set_up=True):
         """Bridge two interfaces on linux node.
 
         :param node: Node to add bridge on.
         :param br_name: Bridge name.
         :param if_1: First interface to be added to the bridge.
         :param if_2: Second interface to be added to the bridge.
+        :param set_up: Change bridge interface state to up after create bridge.
+        Optional. Default: True.
         :type node: dict
         :type br_name: str
         :type if_1: str
         :type if_2: str
+        :type set_up: bool
         """
         cmd = 'brctl addbr {0}'.format(br_name)
         exec_cmd_no_error(node, cmd, sudo=True)
@@ -210,16 +239,27 @@ class L2Util(object):
         exec_cmd_no_error(node, cmd, sudo=True)
         cmd = 'brctl addif {0} {1}'.format(br_name, if_2)
         exec_cmd_no_error(node, cmd, sudo=True)
+        if set_up:
+            cmd = 'ip link set dev {0} up'.format(br_name)
+            exec_cmd_no_error(node, cmd, sudo=True)
 
     @staticmethod
-    def linux_del_bridge(node, br_name):
+    def linux_del_bridge(node, br_name, set_down=True):
         """Delete bridge from linux node.
 
         :param node: Node to delete bridge from.
         :param br_name: Bridge name.
-        .. note:: The network interface corresponding to the bridge must be
+        :param set_down: Change bridge interface state to down before delbr
+        command. Optional. Default: True.
+        :type node: str
+        :type br_name: str
+        :type set_down: bool
+        ..note:: The network interface corresponding to the bridge must be
         down before it can be deleted!
         """
+        if set_down:
+            cmd = 'ip link set dev {0} down'.format(br_name)
+            exec_cmd_no_error(node, cmd, sudo=True)
         cmd = 'brctl delbr {0}'.format(br_name)
         exec_cmd_no_error(node, cmd, sudo=True)
 
@@ -248,3 +288,117 @@ class L2Util(object):
                     return bridge_domain
 
         return data
+
+    @staticmethod
+    def l2_vlan_tag_rewrite(node, interface, tag_rewrite_method,
+                            push_dot1q=True, tag1_id=None, tag2_id=None):
+        """Rewrite tags in ethernet frame.
+
+        :param node: Node to rewrite tags.
+        :param interface: Interface on which rewrite tags.
+        :param tag_rewrite_method: Method of tag rewrite.
+        :param push_dot1q: Optional parameter to disable to push dot1q tag
+         instead of dot1ad.
+        :param tag1_id: Optional tag1 ID for VLAN.
+        :param tag2_id: Optional tag2 ID for VLAN.
+        :type node: dict
+        :type interface: str or int
+        :type tag_rewrite_method: str
+        :type push_dot1q: bool
+        :type tag1_id: int
+        :type tag2_id: int
+        """
+        push_dot1q = 'push_dot1q 0' if not push_dot1q else ''
+
+        tag1_id = 'tag1 {0}'.format(tag1_id) if tag1_id else ''
+        tag2_id = 'tag2 {0}'.format(tag2_id) if tag2_id else ''
+
+        if isinstance(interface, basestring):
+            iface_key = Topology.get_interface_by_name(node, interface)
+            sw_if_index = Topology.get_interface_sw_index(node, iface_key)
+        else:
+            sw_if_index = interface
+
+        with VatTerminal(node) as vat:
+            vat.vat_terminal_exec_cmd_from_template("l2_vlan_tag_rewrite.vat",
+                                                    sw_if_index=sw_if_index,
+                                                    tag_rewrite_method=
+                                                    tag_rewrite_method,
+                                                    push_dot1q=push_dot1q,
+                                                    tag1_optional=tag1_id,
+                                                    tag2_optional=tag2_id)
+
+    @staticmethod
+    def delete_bridge_domain_vat(node, bd_id):
+        """Delete the specified bridge domain from the node.
+
+        :param node: VPP node to delete a bridge domain from.
+        :param bd_id: Bridge domain ID.
+        :type node: dict
+        :type bd_id: int
+        """
+
+        with VatTerminal(node) as vat:
+            vat.vat_terminal_exec_cmd_from_template(
+                "l2_bridge_domain_delete.vat", bd_id=bd_id)
+
+    @staticmethod
+    def delete_l2_fib_entry(node, bd_id, mac):
+        """Delete the specified L2 FIB entry.
+
+        :param node: VPP node.
+        :param bd_id: Bridge domain ID.
+        :param mac: MAC address used as the key in L2 FIB entry.
+        :type node: dict
+        :type bd_id: int
+        :type mac: str
+        """
+
+        with VatTerminal(node) as vat:
+            vat.vat_terminal_exec_cmd_from_template("l2_fib_entry_delete.vat",
+                                                    mac=mac,
+                                                    bd_id=bd_id)
+
+    @staticmethod
+    def get_l2_fib_table_vat(node, bd_index):
+        """Retrieves the L2 FIB table using VAT.
+
+        :param node: VPP node.
+        :param bd_index: Index of the bridge domain.
+        :type node: dict
+        :type bd_index: int
+        :return: L2 FIB table.
+        :rtype: list
+        """
+
+        bd_data = L2Util.vpp_get_bridge_domain_data(node)
+        bd_id = bd_data[bd_index-1]["bd_id"]
+
+        try:
+            with VatTerminal(node) as vat:
+                table = vat.vat_terminal_exec_cmd_from_template(
+                    "l2_fib_table_dump.vat", bd_id=bd_id)
+
+            return table[0]
+        except ValueError:
+            return []
+
+    @staticmethod
+    def get_l2_fib_entry_vat(node, bd_index, mac):
+        """Retrieves the L2 FIB entry specified by MAC address using VAT.
+
+        :param node: VPP node.
+        :param bd_index: Index of the bridge domain.
+        :param mac: MAC address used as the key in L2 FIB data structure.
+        :type node: dict
+        :type bd_index: int
+        :type mac: str
+        :return: L2 FIB entry
+        :rtype: dict
+        """
+
+        table = L2Util.get_l2_fib_table_vat(node, bd_index)
+        for entry in table:
+            if entry["mac"] == mac:
+                return entry
+        return {}