X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FL2Util.py;h=5903d03549a6cd8c8c7773f0fa9c971701ec5937;hp=065c97cb97347cfa7959e5b74564b8014cf0700a;hb=c478afc5aec0161cc66e837c1ab919542b68ebbc;hpb=3936756adb84508ef7ada2cc9016eb449fba2024 diff --git a/resources/libraries/python/L2Util.py b/resources/libraries/python/L2Util.py index 065c97cb97..5903d03549 100644 --- a/resources/libraries/python/L2Util.py +++ b/resources/libraries/python/L2Util.py @@ -11,103 +11,127 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""L2 bridge domain utilities Library.""" +"""L2 Utilities Library.""" from robot.api.deco import keyword + from resources.libraries.python.topology import Topology -from resources.libraries.python.VatExecutor import VatExecutor +from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal +from resources.libraries.python.ssh import exec_cmd_no_error class L2Util(object): - """Utilities for l2 bridge domain configuration""" - - def __init__(self): - pass + """Utilities for l2 configuration""" @staticmethod def vpp_add_l2fib_entry(node, mac, interface, bd_id): - """ Creates a static L2FIB entry on a vpp node. + """ Create a static L2FIB entry on a vpp node. :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) @staticmethod - @keyword('Setup l2 bridge domain with id "${bd_id}" flooding "${flood}" ' - 'forwarding "${forward}" learning "${learn}" and arp termination ' - '"${arp_term}" on vpp node "${node}"') - def setup_vpp_l2_bridge_domain(node, bd_id, flood, forward, learn, - arp_term): - """Create a l2 bridge domain on the chosen vpp node - - Executes "bridge_domain_add_del bd_id {bd_id} flood {flood} uu-flood 1 + def create_l2_bd(node, bd_id, flood=1, uu_flood=1, forward=1, learn=1, + arp_term=0): + """Create a l2 bridge domain on the chosen VPP node + + Execute "bridge_domain_add_del bd_id {bd_id} flood {flood} uu-flood 1 forward {forward} learn {learn} arp-term {arp_term}" VAT command on the node. - For the moment acts as a placeholder - :param node: node where we wish to crate the l2 bridge domain - :param bd_id: bridge domain id - :param flood: enable flooding - :param forward: enable forwarding - :param learn: enable mac address learning to fib - :param arp_term: enable arp_termination - :type node: str - :type bd_id: str + + :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 + :type uu_flood: bool :type forward: bool :type learn: bool :type arp_term:bool - :return: """ - pass - - @keyword('Add interface "${interface}" to l2 bridge domain with index ' - '"${bd_id}" and shg "${shg}" on vpp node "${node}"') - def add_interface_to_l2_bd(self, node, interface, bd_id, shg): - """Adds interface to l2 bridge domain. - - Executes the "sw_interface_set_l2_bridge {interface1} bd_id {bd_id} - shg {shg} enable" VAT command on the given node. - For the moment acts as a placeholder - :param node: node where we want to execute the command that does this. - :param interface: - :param bd_id: - :param shg: + VatExecutor.cmd_from_template(node, "l2_bd_create.vat", + bd_id=bd_id, flood=flood, + uu_flood=uu_flood, forward=forward, + learn=learn, arp_term=arp_term) + + @staticmethod + def add_interface_to_l2_bd(node, interface, bd_id, shg=0): + """Add a interface to the l2 bridge domain. + + 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. :type node: dict :type interface: str - :type bd_id: str - :type shg: str + :type bd_id: int + :type shg: int + """ + sw_if_index = Topology.get_interface_sw_index(node, interface) + L2Util.add_sw_if_index_to_l2_bd(node, sw_if_index, bd_id, shg) + + @staticmethod + def add_sw_if_index_to_l2_bd(node, sw_if_index, bd_id, shg=0): + """Add interface with sw_if_index to l2 bridge domain. + + 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. + :type node: dict + :type sw_if_index: int + :type bd_id: int + :type shg: int :return: """ - pass + VatExecutor.cmd_from_template(node, "l2_bd_add_sw_if_index.vat", + bd_id=bd_id, sw_if_index=sw_if_index, + shg=shg) @staticmethod @keyword('Create dict used in bridge domain template file for node ' '"${node}" with links "${link_names}" and bd_id "${bd_id}"') def create_bridge_domain_vat_dict(node, link_names, bd_id): - """Creates dictionary that can be used in l2 bridge domain template. + """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 domian index + '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 @@ -120,12 +144,12 @@ class L2Util(object): :param node: Node to add L2BD on. :param bd_id: Bridge domain ID. :param port_1: First interface name added to L2BD. - :param port_2: Second interface name addded to L2BD. + :param port_2: Second interface name added to L2BD. :param learn: Enable/disable MAC learn. :type node: dict :type bd_id: int - :type interface1: str - :type interface2: str + :type port_1: str + :type port_2: str :type learn: bool """ sw_if_index1 = Topology.get_interface_sw_index(node, port_1) @@ -136,3 +160,114 @@ class L2Util(object): sw_if_id2=sw_if_index2, bd_id=bd_id, learn=int(learn)) + + @staticmethod + 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 name or sw_if_index. + :param interface2: Second interface name or sw_if_index. + :type node: dict + :type interface1: str or int + :type interface2: str or int + """ + + 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, + interface2=sw_iface2) + 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) + + @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_tag_rewrite(node, interface, tag_rewrite_method): + """Rewrite tags in frame. + + :param node: Node to rewrite tags. + :param interface: Interface on which rewrite tags. + :param tag_rewrite_method: Method of tag rewrite. + :type node: dict + :type interface: str or int + :type tag_rewrite_method : str + """ + + if isinstance(interface, basestring): + sw_if_index = Topology.get_interface_sw_index(node, interface) + else: + sw_if_index = interface + + with VatTerminal(node) as vat: + vat.vat_terminal_exec_cmd_from_template("l2_tag_rewrite.vat", + sw_if_index=sw_if_index, + tag_rewrite_method= + tag_rewrite_method)