X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2Fhoneycomb%2FHcAPIKwInterfaces.py;h=1e0883db2784de2d5f1ad694f7465e5f3333f643;hp=3f9e9d16a578a10116d69e07caa28725f1b4b05d;hb=1813672eb9f6988046bc65167235ae37b088298c;hpb=95bf11e637855dc91e490f526406fa7538a21ac6 diff --git a/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py b/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py index 3f9e9d16a5..1e0883db27 100644 --- a/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py +++ b/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py @@ -16,7 +16,9 @@ The keywords make possible to put and get configuration data and to get operational data. """ +from robot.api import logger +from resources.libraries.python.topology import Topology from resources.libraries.python.HTTPRequest import HTTPCodes from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError from resources.libraries.python.honeycomb.HoneycombUtil \ @@ -25,7 +27,6 @@ from resources.libraries.python.honeycomb.HoneycombUtil \ import HoneycombUtil as HcUtil -# pylint: disable=too-many-public-methods class InterfaceKeywords(object): """Keywords for Interface manipulation. @@ -34,7 +35,8 @@ class InterfaceKeywords(object): """ INTF_PARAMS = ("name", "description", "type", "enabled", - "link-up-down-trap-enable") + "link-up-down-trap-enable", "v3po:l2", "v3po:vxlan-gpe", + "vpp-vlan:sub-interfaces") IPV4_PARAMS = ("enabled", "forwarding", "mtu") IPV6_PARAMS = ("enabled", "forwarding", "mtu", "dup-addr-detect-transmits") IPV6_AUTOCONF_PARAMS = ("create-global-addresses", @@ -48,6 +50,22 @@ class InterfaceKeywords(object): "bridged-virtual-interface") TAP_PARAMS = ("tap-name", "mac", "device-instance") VHOST_USER_PARAMS = ("socket", "role") + SUB_IF_PARAMS = ("identifier", + "vlan-type", + "enabled") + SUB_IF_MATCH = ("default", + "untagged", + "vlan-tagged", + "vlan-tagged-exact-match") + BD_PARAMS = ("bridge-domain", + "split-horizon-group", + "bridged-virtual-interface") + VXLAN_GPE_PARAMS = ("local", + "remote", + "vni", + "next-protocol", + "encap-vrf-id", + "decap-vrf-id") def __init__(self): pass @@ -65,7 +83,7 @@ class InterfaceKeywords(object): :type interface: str :type data: dict :type data_representation: DataRepresentation - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the status code in response on PUT is not 200 = OK. @@ -74,7 +92,7 @@ class InterfaceKeywords(object): status_code, resp = HcUtil.\ put_honeycomb_data(node, "config_vpp_interfaces", data, data_representation=data_representation) - if status_code != HTTPCodes.OK: + if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED): raise HoneycombError( "The configuration of interface '{0}' was not successful. " "Status code: {1}.".format(interface, status_code)) @@ -86,7 +104,7 @@ class InterfaceKeywords(object): :param node: Honeycomb node. :type node: dict - :return: Configuration data about all interfaces from Honeycomb. + :returns: Configuration data about all interfaces from Honeycomb. :rtype: list :raises HoneycombError: If it is not possible to get configuration data. """ @@ -111,7 +129,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Configuration data about the given interface from Honeycomb. + :returns: Configuration data about the given interface from Honeycomb. :rtype: dict """ @@ -127,7 +145,7 @@ class InterfaceKeywords(object): :param node: Honeycomb node. :type node: dict - :return: Operational data about all interfaces from Honeycomb. + :returns: Operational data about all interfaces from Honeycomb. :rtype: list :raises HoneycombError: If it is not possible to get operational data. """ @@ -144,6 +162,33 @@ class InterfaceKeywords(object): except (KeyError, TypeError): return [] + @staticmethod + def get_disabled_interfaces_oper_data(node): + """Get operational data about all disabled interfaces from Honeycomb. + + :param node: Honeycomb node. + :type node: dict + :returns: Operational data about disabled interfaces. + :rtype: list + :raises HoneycombError: If it is not possible to get operational data. + """ + + status_code, resp = HcUtil. \ + get_honeycomb_data(node, "oper_disabled_interfaces") + if status_code == HTTPCodes.NOT_FOUND: + raise HoneycombError( + "No disabled interfaces present on node." + ) + if status_code != HTTPCodes.OK: + raise HoneycombError( + "Not possible to get operational information about the " + "interfaces. Status code: {0}.".format(status_code)) + try: + return resp["disabled-interfaces"]["disabled-interface-index"] + + except (KeyError, TypeError): + return [] + @staticmethod def get_interface_oper_data(node, interface): """Get operational data about the given interface from Honeycomb. @@ -152,7 +197,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Operational data about the given interface from Honeycomb. + :returns: Operational data about the given interface from Honeycomb. :rtype: dict """ @@ -178,7 +223,7 @@ class InterfaceKeywords(object): :type interface: str :type path: tuple :type new_value: str, dict or list - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If it is not possible to get or set the data. """ @@ -204,13 +249,13 @@ class InterfaceKeywords(object): depending on the parameter "state". :param node: Honeycomb node. - :param interface: The name of interface. + :param interface: Interface name, key, link name or sw_if_index. :param state: The requested state, only "up" and "down" are valid values. :type node: dict :type interface: str :type state: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises KeyError: If the argument "state" is nor "up" or "down". :raises HoneycombError: If the interface is not present on the node. @@ -219,9 +264,29 @@ class InterfaceKeywords(object): intf_state = {"up": "true", "down": "false"} - path = ("interfaces", ("interface", "name", str(interface)), "enabled") - return InterfaceKeywords._set_interface_properties( - node, interface, path, intf_state[state.lower()]) + interface = Topology.convert_interface_reference( + node, interface, "name") + + intf = interface.replace("/", "%2F") + path = "/interface/{0}".format(intf) + + status_code, resp = HcUtil.\ + get_honeycomb_data(node, "config_vpp_interfaces", path) + if status_code != HTTPCodes.OK: + raise HoneycombError( + "Not possible to get configuration information about the " + "interfaces. Status code: {0}.".format(status_code)) + + resp["interface"][0]["enabled"] = intf_state[state.lower()] + + status_code, resp = HcUtil. \ + put_honeycomb_data(node, "config_vpp_interfaces", resp, path, + data_representation=DataRepresentation.JSON) + if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED): + raise HoneycombError( + "The configuration of interface '{0}' was not successful. " + "Status code: {1}.".format(interface, status_code)) + return resp @staticmethod def set_interface_up(node, interface): @@ -231,7 +296,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Content of response + :returns: Content of response :rtype: bytearray """ @@ -245,7 +310,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -257,7 +322,7 @@ class InterfaceKeywords(object): """Add a new bridge domain to an interface and set its parameters. :param node: Honeycomb node. - :param interface: The name of interface. + :param interface: Interface name, key, link name or sw_if_index. :param bd_name: Bridge domain name. :param split_horizon_group: Split-horizon group name. :param bvi: The bridged virtual interface. @@ -266,11 +331,14 @@ class InterfaceKeywords(object): :type bd_name: str :type split_horizon_group: str :type bvi: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the interface is not present on the node. """ + interface = Topology.convert_interface_reference( + node, interface, "name") + v3po_l2 = {"bridge-domain": str(bd_name)} if split_horizon_group: v3po_l2["split-horizon-group"] = str(split_horizon_group) @@ -282,6 +350,59 @@ class InterfaceKeywords(object): return InterfaceKeywords._set_interface_properties( node, interface, path, v3po_l2) + @staticmethod + def remove_bridge_domain_from_interface(node, interface): + """Remove bridge domain assignment from interface. + + :param node: Honeycomb node. + :param interface: Interface name, key, link name or sw_if_index. + :type node: dict + :type interface: str or int + + :raises HoneycombError: If the operation fails. + """ + + interface = Topology.convert_interface_reference( + node, interface, "name") + + intf = interface.replace("/", "%2F") + + path = "/interface/{0}/v3po:l2".format(intf) + + status_code, response = HcUtil.delete_honeycomb_data( + node, "config_vpp_interfaces", path) + + if status_code != HTTPCodes.OK: + if '"error-tag":"data-missing"' in response: + logger.debug("Data does not exist in path.") + else: + raise HoneycombError( + "Could not remove bridge domain assignment from interface " + "'{0}'. Status code: {1}.".format(interface, status_code)) + + @staticmethod + def get_bd_oper_data_from_interface(node, interface): + """Returns operational data about bridge domain settings in the + interface. + + :param node: Honeycomb node. + :param interface: The name of interface. + :type node: dict + :type interface: str + :returns: Operational data about bridge domain settings in the + interface. + :rtype: dict + """ + + if_data = InterfaceKeywords.get_interface_oper_data(node, interface) + + if if_data: + try: + return if_data["v3po:l2"] + except KeyError: + return {} + return {} + @staticmethod def configure_interface_base(node, interface, param, value): """Configure the base parameters of interface. @@ -295,7 +416,7 @@ class InterfaceKeywords(object): :type interface: str :type param: str :type value: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -309,7 +430,7 @@ class InterfaceKeywords(object): @staticmethod def configure_interface_ipv4(node, interface, param, value): - """Configure IPv4 parameters of interface + """Configure IPv4 parameters of interface. :param node: Honeycomb node. :param interface: The name of interface. @@ -320,11 +441,14 @@ class InterfaceKeywords(object): :type interface: str :type param: str :type value: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ + interface = Topology.convert_interface_reference( + node, interface, "name") + if param not in InterfaceKeywords.IPV4_PARAMS: raise HoneycombError("The parameter {0} is invalid.".format(param)) @@ -347,10 +471,14 @@ class InterfaceKeywords(object): :type interface: str :type ip_addr: str :type network: str or int - :return: Content of response. + :returns: Content of response. :rtype: bytearray + :raises HoneycombError: If the provided netmask or prefix is not valid. """ + interface = Topology.convert_interface_reference( + node, interface, "name") + path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4") if isinstance(network, basestring): address = {"address": [{"ip": ip_addr, "netmask": network}, ]} @@ -374,10 +502,14 @@ class InterfaceKeywords(object): :type interface: str :type ip_addr: str :type network: str or int - :return: Content of response. + :returns: Content of response. :rtype: bytearray + :raises HoneycombError: If the provided netmask or prefix is not valid. """ + interface = Topology.convert_interface_reference( + node, interface, "name") + path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4", "address") if isinstance(network, basestring): @@ -398,7 +530,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -407,30 +539,6 @@ class InterfaceKeywords(object): return InterfaceKeywords._set_interface_properties( node, interface, path, None) - @staticmethod - def add_first_ipv4_neighbor(node, interface, ip_addr, link_layer_address): - """Add the first IPv4 neighbour. - - If there are any other neighbours configured, they will be removed. - - :param node: Honeycomb node. - :param interface: The name of interface. - :param ip_addr: IPv4 address of neighbour to be set. - :param link_layer_address: Link layer address. - :type node: dict - :type interface: str - :type ip_addr: str - :type link_layer_address: str - :return: Content of response. - :rtype: bytearray - """ - - path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4") - neighbor = {"neighbor": [{"ip": ip_addr, - "link-layer-address": link_layer_address}, ]} - return InterfaceKeywords._set_interface_properties( - node, interface, path, neighbor) - @staticmethod def add_ipv4_neighbor(node, interface, ip_addr, link_layer_address): """Add the IPv4 neighbour. @@ -443,7 +551,7 @@ class InterfaceKeywords(object): :type interface: str :type ip_addr: str :type link_layer_address: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -461,7 +569,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -483,7 +591,7 @@ class InterfaceKeywords(object): :type interface: str :type param: str :type value: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -514,7 +622,7 @@ class InterfaceKeywords(object): :type interface: str :type ip_addr: str :type prefix_len: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -535,7 +643,7 @@ class InterfaceKeywords(object): :type interface: str :type ip_addr: str :type prefix_len: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -553,7 +661,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -562,30 +670,6 @@ class InterfaceKeywords(object): return InterfaceKeywords._set_interface_properties( node, interface, path, None) - @staticmethod - def add_first_ipv6_neighbor(node, interface, ip_addr, link_layer_address): - """Add the first IPv6 neighbour. - - If there are any other neighbours configured, they will be removed. - - :param node: Honeycomb node. - :param interface: The name of interface. - :param ip_addr: IPv6 address of neighbour to be set. - :param link_layer_address: Link layer address. - :type node: dict - :type interface: str - :type ip_addr: str - :type link_layer_address: str - :return: Content of response. - :rtype: bytearray - """ - - path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv6") - neighbor = {"neighbor": [{"ip": ip_addr, - "link-layer-address": link_layer_address}, ]} - return InterfaceKeywords._set_interface_properties( - node, interface, path, neighbor) - @staticmethod def add_ipv6_neighbor(node, interface, ip_addr, link_layer_address): """Add the IPv6 neighbour. @@ -598,7 +682,7 @@ class InterfaceKeywords(object): :type interface: str :type ip_addr: str :type link_layer_address: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -616,7 +700,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray """ @@ -638,7 +722,7 @@ class InterfaceKeywords(object): :type interface: str :type param: str :type value: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -663,7 +747,7 @@ class InterfaceKeywords(object): :type interface: str :type param: str :type value: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -687,7 +771,7 @@ class InterfaceKeywords(object): :type node: dict :type interface: str :type kwargs: dict - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -716,7 +800,7 @@ class InterfaceKeywords(object): :param interface: The name of interface. :type node: dict :type interface: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If it is not possible to get information about interfaces or it is not possible to delete the interface. @@ -758,7 +842,7 @@ class InterfaceKeywords(object): :type node: dict :type interface: str :type kwargs: dict - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -787,7 +871,7 @@ class InterfaceKeywords(object): :type interface: str :type param: str :type value: str - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -810,7 +894,7 @@ class InterfaceKeywords(object): :type node: dict :type interface: str :type kwargs: dict - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -849,7 +933,7 @@ class InterfaceKeywords(object): :type node: dict :type interface: str :type kwargs: dict - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -883,7 +967,7 @@ class InterfaceKeywords(object): :type node: dict :type interface: str :type kwargs: dict - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -911,7 +995,7 @@ class InterfaceKeywords(object): :type node: dict :type interface: str :type kwargs: dict - :return: Content of response. + :returns: Content of response. :rtype: bytearray :raises HoneycombError: If the parameter is not valid. """ @@ -931,3 +1015,643 @@ class InterfaceKeywords(object): new_vhost_structure = [new_vhost, ] return InterfaceKeywords._set_interface_properties( node, interface, path, new_vhost_structure) + + @staticmethod + def create_sub_interface(node, super_interface, match, tags=None, **kwargs): + """Create a new sub-interface. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param match: Match type. The valid values are defined in + InterfaceKeywords.SUB_IF_MATCH. + :param tags: List of tags. + :param kwargs: Parameters and their values. The accepted parameters are + defined in InterfaceKeywords.SUB_IF_PARAMS. + :type node: dict + :type super_interface: str + :type match: str + :type tags: list + :type kwargs: dict + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If the parameter is not valid. + :raises KeyError: If the parameter 'match' is invalid. + """ + + match_type = { + "default": + {"default": {}}, + "untagged": + {"untagged": {}}, + "vlan-tagged": + {"vlan-tagged": {"match-exact-tags": "false"}}, + "vlan-tagged-exact-match": + {"vlan-tagged": {"match-exact-tags": "true"}} + } + + new_sub_interface = { + "tags": { + "tag": [] + }, + } + + for param, value in kwargs.items(): + if param in InterfaceKeywords.SUB_IF_PARAMS: + new_sub_interface[param] = value + else: + raise HoneycombError("The parameter {0} is invalid.". + format(param)) + try: + new_sub_interface["match"] = match_type[match] + except KeyError: + raise HoneycombError("The value '{0}' of parameter 'match' is " + "invalid.".format(match)) + + if tags: + new_sub_interface["tags"]["tag"].extend(tags) + + path = ("interfaces", + ("interface", "name", super_interface), + "vpp-vlan:sub-interfaces", + "sub-interface") + new_sub_interface_structure = [new_sub_interface, ] + return InterfaceKeywords._set_interface_properties( + node, super_interface, path, new_sub_interface_structure) + + @staticmethod + def get_sub_interface_oper_data(node, super_interface, identifier): + """Retrieves sub-interface operational data using Honeycomb API. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :type node: dict + :type super_interface: str + :type identifier: int + :returns: Sub-interface operational data. + :rtype: dict + :raises HoneycombError: If there is no sub-interface with the given ID. + """ + + if_data = InterfaceKeywords.get_interface_oper_data(node, + super_interface) + for sub_if in if_data["vpp-vlan:sub-interfaces"]["sub-interface"]: + if str(sub_if["identifier"]) == str(identifier): + return sub_if + + raise HoneycombError("The interface {0} does not have sub-interface " + "with ID {1}".format(super_interface, identifier)) + + @staticmethod + def remove_all_sub_interfaces(node, super_interface): + """Remove all sub-interfaces from the given interface. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :type node: dict + :type super_interface: str + :returns: Content of response. + :rtype: bytearray + """ + + path = ("interfaces", + ("interface", "name", super_interface), + "vpp-vlan:sub-interfaces") + + return InterfaceKeywords._set_interface_properties( + node, super_interface, path, {}) + + @staticmethod + def set_sub_interface_state(node, super_interface, identifier, state): + """Set the administrative state of sub-interface. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :param state: Required sub-interface state - up or down. + :type node: dict + :type super_interface: str + :type identifier: int + :type state: str + :returns: Content of response. + :rtype: bytearray + """ + + intf_state = {"up": "true", + "down": "false"} + + path = ("interfaces", + ("interface", "name", super_interface), + "vpp-vlan:sub-interfaces", + ("sub-interface", "identifier", identifier), + "enabled") + + return InterfaceKeywords._set_interface_properties( + node, super_interface, path, intf_state[state]) + + @staticmethod + def add_bridge_domain_to_sub_interface(node, super_interface, identifier, + config): + """Add a sub-interface to a bridge domain and set its parameters. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :param config: Bridge domain configuration. + :type node: dict + :type super_interface: str + :type identifier: int + :type config: dict + :returns: Content of response. + :rtype: bytearray + """ + + path = ("interfaces", + ("interface", "name", super_interface), + "vpp-vlan:sub-interfaces", + ("sub-interface", "identifier", int(identifier)), + "l2") + + return InterfaceKeywords._set_interface_properties( + node, super_interface, path, config) + + @staticmethod + def get_bd_data_from_sub_interface(node, super_interface, identifier): + """Get the operational data about the bridge domain from sub-interface. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :type node: dict + :type super_interface: str + :type identifier: int + :returns: Operational data about the bridge domain. + :rtype: dict + :raises HoneycombError: If there is no sub-interface with the given ID. + """ + + try: + bd_data = InterfaceKeywords.get_sub_interface_oper_data( + node, super_interface, identifier)["l2"] + return bd_data + except KeyError: + raise HoneycombError("The operational data does not contain " + "information about a bridge domain.") + + @staticmethod + def configure_tag_rewrite(node, super_interface, identifier, config): + """Add / change / disable vlan tag rewrite on a sub-interface. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :param config: Rewrite tag configuration. + :type node: dict + :type super_interface: str + :type identifier: int + :type config: dict + :returns: Content of response. + :rtype: bytearray + """ + + path = ("interfaces", + ("interface", "name", super_interface), + "vpp-vlan:sub-interfaces", + ("sub-interface", "identifier", int(identifier)), + "l2", + "rewrite") + + return InterfaceKeywords._set_interface_properties( + node, super_interface, path, config) + + @staticmethod + def get_tag_rewrite_oper_data(node, super_interface, identifier): + """Get the operational data about tag rewrite. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :type node: dict + :type super_interface: str + :type identifier: int + :returns: Operational data about tag rewrite. + :rtype: dict + :raises HoneycombError: If there is no sub-interface with the given ID. + """ + + try: + tag_rewrite = InterfaceKeywords.get_sub_interface_oper_data( + node, super_interface, identifier)["l2"]["rewrite"] + return tag_rewrite + except KeyError: + raise HoneycombError("The operational data does not contain " + "information about the tag-rewrite.") + + @staticmethod + def add_ipv4_address_to_sub_interface(node, super_interface, identifier, + ip_addr, network): + """Add an ipv4 address to the specified sub-interface, with the provided + netmask or network prefix length. Any existing ipv4 addresses on the + sub-interface will be replaced. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :param ip_addr: IPv4 address to be set. + :param network: Network mask or network prefix length. + :type node: dict + :type super_interface: str + :type identifier: int + :type ip_addr: str + :type network: str or int + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If the provided netmask or prefix is not valid. + """ + + path = ("interfaces", + ("interface", "name", super_interface), + "vpp-vlan:sub-interfaces", + ("sub-interface", "identifier", int(identifier)), + "ipv4") + + if isinstance(network, basestring): + address = {"address": [{"ip": ip_addr, "netmask": network}, ]} + + elif isinstance(network, int) and 0 < network < 33: + address = {"address": [{"ip": ip_addr, "prefix-length": network}, ]} + + else: + raise HoneycombError("{0} is not a valid netmask or prefix length." + .format(network)) + + return InterfaceKeywords._set_interface_properties( + node, super_interface, path, address) + + @staticmethod + def remove_all_ipv4_addresses_from_sub_interface(node, super_interface, + identifier): + """Remove all ipv4 addresses from the specified sub-interface. + + :param node: Honeycomb node. + :param super_interface: Super interface. + :param identifier: The ID of sub-interface. + :type node: dict + :type super_interface: str + :type identifier: int + :returns: Content of response. + :rtype: bytearray + """ + + path = ("interfaces", + ("interface", "name", super_interface), + "vpp-vlan:sub-interfaces", + ("sub-interface", "identifier", int(identifier)), + "ipv4", "address") + + return InterfaceKeywords._set_interface_properties( + node, super_interface, path, None) + + @staticmethod + def compare_data_structures(data, ref, _path=''): + """Checks if data obtained from UUT is as expected. If it is not, + proceeds down the list/dictionary tree and finds the point of mismatch. + + :param data: Data to be checked. + :param ref: Referential data used for comparison. + :param _path: Used in recursive calls, stores the path taken down + the JSON tree. + :type data: dict + :type ref: dict + :type _path: str + + :raises HoneycombError: If the data structures do not match in some way, + or if they are not in deserialized JSON format. + """ + + if data == ref: + return True + + elif isinstance(data, dict) and isinstance(ref, dict): + for key in ref: + if key not in data: + raise HoneycombError( + "Key {key} is not present in path {path}. Keys in path:" + "{data_keys}".format( + key=key, + path=_path, + data_keys=data.keys())) + + if data[key] != ref[key]: + if isinstance(data[key], list) \ + or isinstance(data[key], dict): + InterfaceKeywords.compare_data_structures( + data[key], ref[key], + _path + '[{0}]'.format(key)) + else: + raise HoneycombError( + "Data mismatch, key {key} in path {path} has value" + " {data}, but should be {ref}".format( + key=key, + path=_path, + data=data[key], + ref=ref[key])) + + elif isinstance(data, list) and isinstance(ref, list): + for item in ref: + if item not in data: + if isinstance(item, dict): + InterfaceKeywords.compare_data_structures( + data[0], item, + _path + '[{0}]'.format(ref.index(item))) + else: + raise HoneycombError( + "Data mismatch, list item {index} in path {path}" + " has value {data}, but should be {ref}".format( + index=ref.index(item), + path=_path, + data=data[0], + ref=item)) + + else: + raise HoneycombError( + "Unexpected data type {data_type}, reference type is" + " {ref_type}. Must be list or dictionary.".format( + data_type=type(data), + ref_type=type(ref))) + + @staticmethod + def compare_interface_lists(list1, list2): + """Compare provided lists of interfaces by name. + + :param list1: List of interfaces. + :param list2: List of interfaces. + :type list1: list + :type list2: list + :raises HoneycombError: If an interface exists in only one of the lists. + """ + + ignore = ["vx_tunnel0", "vxlan_gpe_tunnel0"] + # these have no equivalent in config data and no effect on VPP + + names1 = [x['name'] for x in list1] + names2 = [x['name'] for x in list2] + + for name in names1: + if name not in names2 and name not in ignore: + raise HoneycombError("Interface {0} not present in list {1}" + .format(name, list2)) + for name in names2: + if name not in names1 and name not in ignore: + raise HoneycombError("Interface {0} not present in list {1}" + .format(name, list1)) + + @staticmethod + def create_vxlan_gpe_interface(node, interface, **kwargs): + """Create a new VxLAN GPE interface. + + :param node: Honeycomb node. + :param interface: The name of interface to be created. + :param kwargs: Parameters and their values. The accepted parameters are + defined in InterfaceKeywords.VXLAN_GPE_PARAMS. + :type node: dict + :type interface: str + :type kwargs: dict + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If a parameter in kwargs is not valid. + """ + + new_vxlan_gpe = { + "name": interface, + "type": "v3po:vxlan-gpe-tunnel", + "v3po:vxlan-gpe": {} + } + for param, value in kwargs.items(): + if param in InterfaceKeywords.INTF_PARAMS: + new_vxlan_gpe[param] = value + elif param in InterfaceKeywords.VXLAN_GPE_PARAMS: + new_vxlan_gpe["v3po:vxlan-gpe"][param] = value + else: + raise HoneycombError("The parameter {0} is invalid.". + format(param)) + path = ("interfaces", "interface") + vxlan_gpe_structure = [new_vxlan_gpe, ] + return InterfaceKeywords._set_interface_properties( + node, interface, path, vxlan_gpe_structure) + + @staticmethod + def enable_acl_on_interface(node, interface, table_name): + """Enable ACL on the given interface. + + :param node: Honeycomb node. + :param interface: The interface where the ACL will be enabled. + :param table_name: Name of the classify table. + :type node: dict + :type interface: str + :type table_name: str + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If the configuration of interface is not + successful. + """ + + interface = interface.replace("/", "%2F") + + data = { + "v3po:acl": { + "ingress": { + "ip4-acl": { + "classify-table": table_name + }, + "l2-acl": { + "classify-table": table_name + } + } + } + } + + path = "/interface/" + interface + "/v3po:acl" + status_code, resp = HcUtil.\ + put_honeycomb_data(node, "config_vpp_interfaces", data, path, + data_representation=DataRepresentation.JSON) + if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED): + raise HoneycombError( + "The configuration of interface '{0}' was not successful. " + "Status code: {1}.".format(interface, status_code)) + return resp + + @staticmethod + def disable_acl_on_interface(node, interface): + """Disable ACL on the given interface. + + :param node: Honeycomb node. + :param interface: The interface where the ACL will be disabled. + :type node: dict + :type interface: str + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If the configuration of interface is not + successful. + """ + + interface = interface.replace("/", "%2F") + + path = "/interface/" + interface + "/v3po:acl" + + status_code, resp = HcUtil.\ + delete_honeycomb_data(node, "config_vpp_interfaces", path) + + if status_code != HTTPCodes.OK: + raise HoneycombError( + "The configuration of interface '{0}' was not successful. " + "Status code: {1}.".format(interface, status_code)) + return resp + + @staticmethod + def create_pbb_sub_interface(node, intf, params): + """Creates a PBB sub-interface on the given interface and sets its + parameters. + + :param node: Honeycomb node. + :param intf: The interface where PBB sub-interface will be configured. + :param params: Configuration parameters of the sub-interface to be + created. + :type node: dict + :type intf: str + :type params: dict + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If the configuration of sub-interface is not + successful. + """ + + interface = intf.replace("/", "%2F") + path = "/interface/{0}/pbb-rewrite/".format(interface) + status_code, resp = HcUtil. \ + put_honeycomb_data(node, "config_vpp_interfaces", params, path, + data_representation=DataRepresentation.JSON) + if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED): + raise HoneycombError( + "The configuration of PBB sub-interface '{0}' was not " + "successful. Status code: {1}.".format(intf, status_code)) + return resp + + @staticmethod + def delete_pbb_sub_interface(node, intf): + """Deletes the given PBB sub-interface. + + :param node: Honeycomb node. + :param intf: The interface where PBB sub-interface will be deleted. + :type node: dict + :type intf: str + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If the removal of sub-interface is not + successful. + """ + + interface = intf.replace("/", "%2F") + path = "/interface/{0}/pbb-rewrite".format(interface) + + status_code, resp = HcUtil. \ + delete_honeycomb_data(node, "config_vpp_interfaces", path) + if status_code != HTTPCodes.OK: + raise HoneycombError( + "The removal of pbb sub-interface '{0}' was not successful. " + "Status code: {1}.".format(intf, status_code)) + return resp + + @staticmethod + def get_pbb_sub_interface_oper_data(node, intf, sub_if_id): + """Retrieves PBB sub-interface operational data from Honeycomb. + + :param node: Honeycomb node. + :param intf: The interface where PBB sub-interface is located. + :param sub_if_id: ID of the PBB sub-interface. + :type node: dict + :type intf: str + :type sub_if_id: str or int + :returns: PBB sub-interface operational data. + :rtype: dict + :raises HoneycombError: If the removal of sub-interface is not + successful. + """ + + raise NotImplementedError + + @staticmethod + def check_disabled_interface(node, interface): + """Retrieves list of disabled interface indices from Honeycomb, + and matches with the provided interface by index. + + :param node: Honeycomb node. + :param interface: Index number of an interface on the node. + :type node: dict + :type interface: int + :returns: True if the interface exists in disabled interfaces. + :rtype: bool + :raises HoneycombError: If the interface is not present + in retrieved list of disabled interfaces. + """ + data = InterfaceKeywords.get_disabled_interfaces_oper_data(node) + # decrement by one = conversion from HC if-index to VPP sw_if_index + interface -= 1 + + for item in data: + if item["index"] == interface: + return True + raise HoneycombError("Interface index {0} not present in list" + " of disabled interfaces.".format(interface)) + + @staticmethod + def configure_interface_span(node, dst_interface, *src_interfaces): + """Configure SPAN port mirroring on the specified interfaces. If no + source interface is provided, SPAN will be disabled. + + :param node: Honeycomb node. + :param dst_interface: Interface to mirror packets to. + :param src_interfaces: List of interfaces to mirror packets from. + :type node: dict + :type dst_interface: str + :type src_interfaces: list of str + :returns: Content of response. + :rtype: bytearray + :raises HoneycombError: If SPAN could not be configured. + """ + + interface = dst_interface.replace("/", "%2F") + path = "/interface/" + interface + "/span" + + if not src_interfaces: + status_code, _ = HcUtil.delete_honeycomb_data( + node, "config_vpp_interfaces", path) + + data = { + "span": { + "mirrored-interfaces": { + "mirrored-interface": src_interfaces + } + } + } + + status_code, _ = HcUtil.put_honeycomb_data( + node, "config_vpp_interfaces", data, path) + + if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED): + raise HoneycombError( + "Configuring SPAN failed. Status code:{0}".format(status_code)) + + @staticmethod + def add_interface_local0_to_topology(node): + """Use Topology methods to add interface "local0" to working topology, + if not already present. + + :param node: DUT node. + :type node: dict + """ + + if Topology.get_interface_by_sw_index(node, 0) is None: + local0_key = Topology.add_new_port(node, "localzero") + Topology.update_interface_sw_if_index(node, local0_key, 0) + Topology.update_interface_name(node, local0_key, "local0")