-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
"""L2 Utilities Library."""
+from textwrap import wrap
+
from robot.api.deco import keyword
from resources.libraries.python.topology import Topology
class L2Util(object):
"""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):
""" Create a static L2FIB entry on a vpp node.
:type uu_flood: bool
:type forward: bool
:type learn: bool
- :type arp_term:bool
+ :type arp_term: bool
"""
VatExecutor.cmd_from_template(node, "l2_bd_create.vat",
bd_id=bd_id, flood=flood,
:type sw_if_index: int
:type bd_id: int
:type shg: int
- :return:
+ :returns: None
"""
VatExecutor.cmd_from_template(node, "l2_bd_add_sw_if_index.vat",
bd_id=bd_id, sw_if_index=sw_if_index,
:param node: Node data dictionary.
:param link_names: List of names of links the bridge domain should be
- connecting.
+ 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.
+ :returns: 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)
: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.
+ Optional. Default: True.
:type node: dict
:type br_name: str
:type if_1: str
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, set_down=True):
"""Delete bridge from linux node.
+ ..note:: The network interface corresponding to the bridge must be
+ down before it can be deleted!
+
:param node: Node to delete bridge from.
:param br_name: Bridge name.
:param set_down: Change bridge interface state to down before delbr
- command. Optional. Default: True.
+ 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)
: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.
+ :returns: 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:
: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.
+ instead of dot1ad.
:param tag1_id: Optional tag1 ID for VLAN.
:param tag2_id: Optional tag2 ID for VLAN.
:type node: dict
:param bd_index: Index of the bridge domain.
:type node: dict
:type bd_index: int
- :return: L2 FIB table.
+ :returns: L2 FIB table.
:rtype: list
"""
:type node: dict
:type bd_index: int
:type mac: str
- :return: L2 FIB entry
+ :returns: L2 FIB entry
:rtype: dict
"""