X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FL2Util.py;h=4832ffac1c1e9bd09626d75033c20a8e2bdd7f9b;hp=c0a764fa2dc537eb426d94ded162b757984fd136;hb=7c3e0cc41f55327d6eeb04fe757c6e80064ab28a;hpb=799c246c1783b534df0ce7731c9078463be33bdd diff --git a/resources/libraries/python/L2Util.py b/resources/libraries/python/L2Util.py index c0a764fa2d..4832ffac1c 100644 --- a/resources/libraries/python/L2Util.py +++ b/resources/libraries/python/L2Util.py @@ -14,12 +14,14 @@ """L2 Utilities Library.""" from robot.api.deco import keyword + from resources.libraries.python.topology import Topology from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal +from resources.libraries.python.ssh import exec_cmd_no_error class L2Util(object): - """Utilities for l2 configuration""" + """Utilities for l2 configuration.""" @staticmethod def vpp_add_l2fib_entry(node, mac, interface, bd_id): @@ -27,14 +29,17 @@ class L2Util(object): :param node: Node to add L2FIB entry on. :param mac: Destination mac address. - :param interface: Interface name. + :param interface: Interface name or sw_if_index. :param bd_id: Bridge domain id. :type node: dict :type mac: str - :type interface: str + :type interface: str or int :type bd_id: int """ - sw_if_index = Topology.get_interface_sw_index(node, interface) + if isinstance(interface, basestring): + sw_if_index = Topology.get_interface_sw_index(node, interface) + else: + sw_if_index = interface VatExecutor.cmd_from_template(node, "add_l2_fib_entry.vat", mac=mac, bd=bd_id, interface=sw_if_index) @@ -48,13 +53,13 @@ class L2Util(object): forward {forward} learn {learn} arp-term {arp_term}" VAT command on the node. - :param node: node where we wish to crate the l2 bridge domain - :param bd_id: bridge domain index number - :param flood: enable flooding - :param uu_flood: enable uu_flood - :param forward: enable forwarding - :param learn: enable mac address learning to fib - :param arp_term: enable arp_termination + :param node: Node where we wish to crate the l2 bridge domain. + :param bd_id: Bridge domain index number. + :param flood: Enable flooding. + :param uu_flood: Enable uu_flood. + :param forward: Enable forwarding. + :param learn: Enable mac address learning to fib. + :param arp_term: Enable arp_termination. :type node: dict :type bd_id: int :type flood: bool @@ -74,10 +79,10 @@ class L2Util(object): Get SW IF ID and add it to the bridge domain. - :param node: node where we want to execute the command that does this - :param interface: interface name - :param bd_id: bridge domain index number to add Interface name to - :param shg: split horizon group + :param node: Node where we want to execute the command that does this. + :param interface: Interface name. + :param bd_id: Bridge domain index number to add Interface name to. + :param shg: Split horizon group. :type node: dict :type interface: str :type bd_id: int @@ -93,10 +98,10 @@ class L2Util(object): Execute the "sw_interface_set_l2_bridge sw_if_index {sw_if_index} bd_id {bd_id} shg {shg} enable" VAT command on the given node. - :param node: node where we want to execute the command that does this - :param sw_if_index: interface index - :param bd_id: bridge domain index number to add SW IF ID to - :param shg: split horizon group + :param node: Node where we want to execute the command that does this. + :param sw_if_index: Interface index. + :param bd_id: Bridge domain index number to add SW IF ID to. + :param shg: Split horizon group. :type node: dict :type sw_if_index: int :type bd_id: int @@ -113,18 +118,20 @@ class L2Util(object): def create_bridge_domain_vat_dict(node, link_names, bd_id): """Create dictionary that can be used in l2 bridge domain template. - :param node: node data dictionary - :param link_names: list of names of links the bridge domain should be - connecting - :param bd_id: bridge domain index number - :type node: dict - :type link_names: list - :return: dictionary used to generate l2 bridge domain VAT configuration - from template file The resulting dictionary looks like this: 'interface1': interface name of first interface 'interface2': interface name of second interface 'bd_id': bridge domain index + + :param node: Node data dictionary. + :param link_names: List of names of links the bridge domain should be + connecting. + :param bd_id: Bridge domain index number. + :type node: dict + :type link_names: list + :return: Dictionary used to generate l2 bridge domain VAT configuration + from template file. + :rtype: dict """ bd_dict = Topology().get_interfaces_by_link_names(node, link_names) bd_dict['bd_id'] = bd_id @@ -158,15 +165,24 @@ class L2Util(object): def vpp_setup_bidirectional_cross_connect(node, interface1, interface2): """Create bidirectional cross-connect between 2 interfaces on vpp node. - :param node: Node to add bidirectional cross-connect - :param interface1: first interface - :param interface2: second interface + :param node: Node to add bidirectional cross-connect. + :param interface1: First interface name or sw_if_index. + :param interface2: Second interface name or sw_if_index. :type node: dict - :type interface1: str - :type interface2: str + :type interface1: str or int + :type interface2: str or int """ - sw_iface1 = Topology().get_interface_sw_index(node, interface1) - sw_iface2 = Topology().get_interface_sw_index(node, interface2) + + if isinstance(interface1, basestring): + sw_iface1 = Topology().get_interface_sw_index(node, interface1) + else: + sw_iface1 = interface1 + + if isinstance(interface2, basestring): + sw_iface2 = Topology().get_interface_sw_index(node, interface2) + else: + sw_iface2 = interface2 + with VatTerminal(node) as vat: vat.vat_terminal_exec_cmd_from_template('l2_xconnect.vat', interface1=sw_iface1, @@ -174,3 +190,207 @@ class L2Util(object): vat.vat_terminal_exec_cmd_from_template('l2_xconnect.vat', interface1=sw_iface2, interface2=sw_iface1) + + @staticmethod + def linux_add_bridge(node, br_name, if_1, if_2): + """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. + :type node: dict + :type br_name: str + :type if_1: str + :type if_2: str + + """ + cmd = 'brctl addbr {0}'.format(br_name) + exec_cmd_no_error(node, cmd, sudo=True) + cmd = 'brctl addif {0} {1}'.format(br_name, if_1) + 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) + cmd = 'ip link set dev {0} up'.format(br_name) + exec_cmd_no_error(node, cmd, sudo=True) + + @staticmethod + def setup_network_namespace(node, namespace_name, interface_name, + ip_address, prefix): + """Setup namespace on given node and attach interface and IP to + this namespace. Applicable also on TG node. + + :param node: Node to set namespace on. + :param namespace_name: Namespace name. + :param interface_name: Interface name. + :param ip_address: IP address of namespace's interface. + :param prefix: IP address prefix length. + :type node: dict + :type namespace_name: str + :type vhost_if: str + :type ip_address: str + :type prefix: int + + """ + cmd = ('ip netns add {0}'.format(namespace_name)) + exec_cmd_no_error(node, cmd, sudo=True) + + cmd = ('ip link set dev {0} up netns {1}'.format(interface_name, + namespace_name)) + exec_cmd_no_error(node, cmd, sudo=True) + + cmd = ('ip netns exec {0} ip addr add {1}/{2} dev {3}'.format( + namespace_name, ip_address, prefix, interface_name)) + exec_cmd_no_error(node, cmd, sudo=True) + + @staticmethod + def linux_del_bridge(node, br_name): + """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 + down before it can be deleted! + """ + cmd = 'brctl delbr {0}'.format(br_name) + exec_cmd_no_error(node, cmd, sudo=True) + + @staticmethod + def vpp_get_bridge_domain_data(node, bd_id=None): + """Get all bridge domain data from a VPP node. If a domain ID number is + provided, return only data for the matching bridge domain. + + :param node: VPP node to get bridge domain data from. + :param bd_id: Numeric ID of a specific bridge domain. + :type node: dict + :type bd_id: int + :return: List of dictionaries containing data for each bridge domain, or + a single dictionary for the specified bridge domain. + :rtype: list or dict + """ + with VatTerminal(node) as vat: + response = vat.vat_terminal_exec_cmd_from_template("l2_bd_dump.vat") + + data = response[0] + + if bd_id is not None: + for bridge_domain in data: + if bridge_domain["bd_id"] == bd_id: + + 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 {}