X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FIPUtil.py;h=0a573d72fb64e256b5cf4654647dd140cf2cd6ca;hp=b78450a9f8c110aebb11fc0e347de73f59a17c29;hb=HEAD;hpb=56c1c013bd0d632256efa4cb6b0224bf9c608afa diff --git a/resources/libraries/python/IPUtil.py b/resources/libraries/python/IPUtil.py index b78450a9f8..933fa34211 100644 --- a/resources/libraries/python/IPUtil.py +++ b/resources/libraries/python/IPUtil.py @@ -1,4 +1,5 @@ -# Copyright (c) 2019 Cisco and/or its affiliates. +# Copyright (c) 2023 Cisco and/or its affiliates. +# Copyright (c) 2023 PANTHEON.tech s.r.o. # 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: @@ -15,17 +16,18 @@ import re -from socket import AF_INET, AF_INET6, inet_pton - from enum import IntEnum -from ipaddress import ip_address -from ipaddress import IPv4Network, IPv6Network + +from ipaddress import ip_address, ip_network from resources.libraries.python.Constants import Constants +from resources.libraries.python.IncrementUtil import ObjIncrement from resources.libraries.python.InterfaceUtil import InterfaceUtil -from resources.libraries.python.PapiExecutor import PapiExecutor +from resources.libraries.python.IPAddress import IPAddress +from resources.libraries.python.PapiExecutor import PapiSocketExecutor from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd from resources.libraries.python.topology import Topology +from resources.libraries.python.Namespaces import Namespaces # from vpp/src/vnet/vnet/mpls/mpls_types.h @@ -33,12 +35,6 @@ MPLS_IETF_MAX_LABEL = 0xfffff MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1 -class AddressFamily(IntEnum): - """IP address family.""" - ADDRESS_IP4 = 0 - ADDRESS_IP6 = 1 - - class FibPathType(IntEnum): """FIB path types.""" FIB_PATH_TYPE_NORMAL = 0 @@ -70,7 +66,98 @@ class FibPathNhProto(IntEnum): FIB_PATH_NH_PROTO_BIER = 4 -class IPUtil(object): +class IpDscp(IntEnum): + """DSCP code points.""" + IP_API_DSCP_CS0 = 0 + IP_API_DSCP_CS1 = 8 + IP_API_DSCP_AF11 = 10 + IP_API_DSCP_AF12 = 12 + IP_API_DSCP_AF13 = 14 + IP_API_DSCP_CS2 = 16 + IP_API_DSCP_AF21 = 18 + IP_API_DSCP_AF22 = 20 + IP_API_DSCP_AF23 = 22 + IP_API_DSCP_CS3 = 24 + IP_API_DSCP_AF31 = 26 + IP_API_DSCP_AF32 = 28 + IP_API_DSCP_AF33 = 30 + IP_API_DSCP_CS4 = 32 + IP_API_DSCP_AF41 = 34 + IP_API_DSCP_AF42 = 36 + IP_API_DSCP_AF43 = 38 + IP_API_DSCP_CS5 = 40 + IP_API_DSCP_EF = 46 + IP_API_DSCP_CS6 = 48 + IP_API_DSCP_CS7 = 50 + + +class NetworkIncrement(ObjIncrement): + """ + An iterator object which accepts an IPv4Network or IPv6Network and + returns a new network, its address part incremented by the increment + number of network sizes, each time it is iterated or when inc_fmt is called. + The increment may be positive, negative or 0 + (in which case the network is always the same). + + Both initial and subsequent IP address can have host bits set, + check the initial value before creating instance if needed. + String formatting is configurable via constructor argument. + """ + def __init__(self, initial_value, increment=1, format=u"dash"): + """ + :param initial_value: The initial network. Can have host bits set. + :param increment: The current network will be incremented by this + amount of network sizes in each iteration/var_str call. + :param format: Type of formatting to use, "dash" or "slash" or "addr". + :type initial_value: Union[ipaddress.IPv4Network, ipaddress.IPv6Network] + :type increment: int + :type format: str + """ + super().__init__(initial_value, increment) + self._prefix_len = self._value.prefixlen + host_len = self._value.max_prefixlen - self._prefix_len + self._net_increment = self._increment * (1 << host_len) + self._format = str(format).lower() + + def _incr(self): + """ + Increment the network, e.g.: + '30.0.0.0/24' incremented by 1 (the next network) is '30.0.1.0/24'. + '30.0.0.0/24' incremented by 2 is '30.0.2.0/24'. + """ + self._value = ip_network( + f"{self._value.network_address + self._net_increment}" + f"/{self._prefix_len}", strict=False + ) + + def _str_fmt(self): + """ + The string representation of the network depends on format. + + Dash format is ' - ', + useful for 'ipsec policy add spd' CLI. + + Slash format is '/', + useful for other CLI. + + Addr format is '', useful for PAPI. + + :returns: Current value converted to string according to format. + :rtype: str + :raises RuntimeError: If the format is not supported. + """ + if self._format == u"dash": + return f"{self._value.network_address} - " \ + f"{self._value.broadcast_address}" + elif self._format == u"slash": + return f"{self._value.network_address}/{self._prefix_len}" + elif self._format == u"addr": + return f"{self._value.network_address}" + + raise RuntimeError(f"Unsupported format {self._format}") + + +class IPUtil: """Common IP utilities""" @staticmethod @@ -83,7 +170,7 @@ class IPUtil(object): :returns: Integer representation of IP address. :rtype: int """ - return int(ip_address(unicode(ip_str))) + return int(ip_address(ip_str)) @staticmethod def int_to_ip(ip_int): @@ -114,34 +201,66 @@ class IPUtil(object): """ sw_if_index = InterfaceUtil.get_interface_index(node, interface) - data = list() - if sw_if_index: - is_ipv6 = 1 if ip_version == 'ipv6' else 0 - - cmd = 'ip_address_dump' - cmd_reply = 'ip_address_details' - args = dict(sw_if_index=sw_if_index, - is_ipv6=is_ipv6) - err_msg = 'Failed to get L2FIB dump on host {host}'.format( - host=node['host']) - - with PapiExecutor(node) as papi_exec: - papi_resp = papi_exec.add(cmd, **args).get_dump(err_msg) - - for item in papi_resp.reply[0]['api_reply']: - item[cmd_reply]['ip'] = item[cmd_reply]['prefix'].split('/')[0] - item[cmd_reply]['prefix_length'] = int( - item[cmd_reply]['prefix'].split('/')[1]) - item[cmd_reply]['is_ipv6'] = is_ipv6 - item[cmd_reply]['netmask'] = \ - str(IPv6Network(unicode('::/{pl}'.format( - pl=item[cmd_reply]['prefix_length']))).netmask) \ - if is_ipv6 \ - else str(IPv4Network(unicode('0.0.0.0/{pl}'.format( - pl=item[cmd_reply]['prefix_length']))).netmask) - data.append(item[cmd_reply]) - - return data + if not sw_if_index: + return list() + + cmd = u"ip_address_dump" + args = dict( + sw_if_index=sw_if_index, + is_ipv6=bool(ip_version == u"ipv6") + ) + err_msg = f"Failed to get L2FIB dump on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + details = papi_exec.add(cmd, **args).get_details(err_msg) + + return details + + @staticmethod + def vpp_get_ip_tables(node): + """Get dump of all IP FIB tables on a VPP node. + + :param node: VPP node. + :type node: dict + """ + PapiSocketExecutor.run_cli_cmd(node, u"show ip fib") + PapiSocketExecutor.run_cli_cmd(node, u"show ip fib summary") + PapiSocketExecutor.run_cli_cmd(node, u"show ip6 fib") + PapiSocketExecutor.run_cli_cmd(node, u"show ip6 fib summary") + + @staticmethod + def vpp_get_ip_table_summary(node): + """Get IPv4 FIB table summary on a VPP node. + + :param node: VPP node. + :type node: dict + """ + PapiSocketExecutor.run_cli_cmd(node, u"show ip fib summary") + + @staticmethod + def vpp_get_ip_table(node): + """Get IPv4 FIB table on a VPP node. + + :param node: VPP node. + :type node: dict + """ + PapiSocketExecutor.run_cli_cmd(node, u"show ip fib") + + @staticmethod + def vpp_get_ip_tables_prefix(node, address): + """Get dump of all IP FIB tables on a VPP node. + + :param node: VPP node. + :param address: IP address. + :type node: dict + :type address: str + """ + addr = ip_address(address) + ip_ver = u"ip6" if addr.version == 6 else u"ip" + + PapiSocketExecutor.run_cli_cmd( + node, f"show {ip_ver} fib {addr}/{addr.max_prefixlen}" + ) @staticmethod def get_interface_vrf_table(node, interface, ip_version='ipv4'): @@ -158,19 +277,17 @@ class IPUtil(object): """ sw_if_index = InterfaceUtil.get_interface_index(node, interface) - is_ipv6 = 1 if ip_version == 'ipv6' else 0 - - cmd = 'sw_interface_get_table' - args = dict(sw_if_index=sw_if_index, - is_ipv6=is_ipv6) - err_msg = 'Failed to get VRF id assigned to interface {ifc}'.format( - ifc=interface) + cmd = u"sw_interface_get_table" + args = dict( + sw_if_index=sw_if_index, + is_ipv6=bool(ip_version == u"ipv6") + ) + err_msg = f"Failed to get VRF id assigned to interface {interface}" - with PapiExecutor(node) as papi_exec: - papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg). \ - verify_reply(err_msg=err_msg) + with PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add(cmd, **args).get_reply(err_msg) - return papi_resp['vrf_id'] + return reply[u"vrf_id"] @staticmethod def vpp_ip_source_check_setup(node, if_name): @@ -181,16 +298,15 @@ class IPUtil(object): :type node: dict :type if_name: str """ - cmd = 'ip_source_check_interface_add_del' + cmd = u"ip_source_check_interface_add_del" args = dict( sw_if_index=InterfaceUtil.get_interface_index(node, if_name), is_add=1, - loose=0) - err_msg = 'Failed to enable source check on interface {ifc}'.format( - ifc=if_name) - with PapiExecutor(node) as papi_exec: - papi_exec.add(cmd, **args).get_replies(err_msg). \ - verify_reply(err_msg=err_msg) + loose=0 + ) + err_msg = f"Failed to enable source check on interface {if_name}" + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def vpp_ip_probe(node, interface, addr): @@ -203,17 +319,15 @@ class IPUtil(object): :type interface: str :type addr: str """ - cmd = 'ip_probe_neighbor' - cmd_reply = 'proxy_arp_intfc_enable_disable_reply' + cmd = u"ip_probe_neighbor" args = dict( sw_if_index=InterfaceUtil.get_interface_index(node, interface), - dst=str(addr)) - err_msg = 'VPP ip probe {dev} {ip} failed on {h}'.format( - dev=interface, ip=addr, h=node['host']) + dst=str(addr) + ) + err_msg = f"VPP ip probe {interface} {addr} failed on {node[u'host']}" - with PapiExecutor(node) as papi_exec: - papi_exec.add(cmd, **args).get_replies(err_msg). \ - verify_reply(cmd_reply=cmd_reply, err_msg=err_msg) + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def ip_addresses_should_be_equal(ip1, ip2): @@ -224,43 +338,41 @@ class IPUtil(object): :type ip1: str :type ip2: str """ - addr1 = ip_address(unicode(ip1)) - addr2 = ip_address(unicode(ip2)) + addr1 = ip_address(ip1) + addr2 = ip_address(ip2) if addr1 != addr2: - raise AssertionError('IP addresses are not equal: {0} != {1}'. - format(ip1, ip2)) + raise AssertionError(f"IP addresses are not equal: {ip1} != {ip2}") @staticmethod def setup_network_namespace(node, namespace_name, interface_name, - ip_addr, prefix): + ip_addr_list, prefix_length): """Setup namespace on given node and attach interface and IP to this namespace. Applicable also on TG node. :param node: VPP node. :param namespace_name: Namespace name. :param interface_name: Interface name. - :param ip_addr: IP address of namespace's interface. - :param prefix: IP address prefix length. + :param ip_addr_list: List of IP addresses of namespace's interface. + :param prefix_length: IP address prefix length. :type node: dict :type namespace_name: str :type interface_name: str - :type ip_addr: str - :type prefix: int + :type ip_addr_list: list + :type prefix_length: int """ - cmd = ('ip netns add {0}'.format(namespace_name)) - exec_cmd_no_error(node, cmd, sudo=True) + Namespaces.create_namespace(node, namespace_name) - cmd = ('ip link set dev {0} up netns {1}'.format(interface_name, - namespace_name)) + cmd = f"ip netns exec {namespace_name} ip link set {interface_name} up" exec_cmd_no_error(node, cmd, sudo=True) - cmd = ('ip netns exec {0} ip addr add {1}/{2} dev {3}'.format( - namespace_name, ip_addr, prefix, interface_name)) - exec_cmd_no_error(node, cmd, sudo=True) + for ip_addr in ip_addr_list: + cmd = f"ip netns exec {namespace_name} ip addr add " \ + f"{ip_addr}/{prefix_length} dev {interface_name}" + exec_cmd_no_error(node, cmd, sudo=True) @staticmethod - def linux_enable_forwarding(node, ip_ver='ipv4'): + def linux_enable_forwarding(node, ip_ver=u"ipv4"): """Enable forwarding on a Linux node, e.g. VM. :param node: VPP node. @@ -268,7 +380,7 @@ class IPUtil(object): :type node: dict :type ip_ver: str """ - cmd = 'sysctl -w net.{0}.ip_forward=1'.format(ip_ver) + cmd = f"sysctl -w net.{ip_ver}.ip_forward=1" exec_cmd_no_error(node, cmd, sudo=True) @staticmethod @@ -283,15 +395,16 @@ class IPUtil(object): :rtype: str :raises RuntimeError: If cannot get the information about interfaces. """ - regex_intf_info = r"pci@" \ - r"([0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}.[0-9a-f])\s*" \ - r"([a-zA-Z0-9]*)\s*network" + regex_intf_info = \ + r"pci@([0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}.[0-9a-f])\s" \ + r"*([a-zA-Z0-9]*)\s*network" - cmd = "lshw -class network -businfo" + cmd = u"lshw -class network -businfo" ret_code, stdout, stderr = exec_cmd(node, cmd, timeout=30, sudo=True) if ret_code != 0: - raise RuntimeError('Could not get information about interfaces:\n' - '{err}'.format(err=stderr)) + raise RuntimeError( + f"Could not get information about interfaces:\n{stderr}" + ) for line in stdout.splitlines()[2:]: try: @@ -302,21 +415,27 @@ class IPUtil(object): return None @staticmethod - def set_linux_interface_up(node, interface): + def set_linux_interface_up( + node, interface, namespace=None): """Set the specified interface up. - :param node: VPP/TG node. :param interface: Interface in namespace. + :param namespace: Execute command in namespace. Optional :type node: dict :type interface: str + :type namespace: str :raises RuntimeError: If the interface could not be set up. """ - cmd = "ip link set {0} up".format(interface) + if namespace is not None: + cmd = f"ip netns exec {namespace} ip link set dev {interface} up" + else: + cmd = f"ip link set dev {interface} up" exec_cmd_no_error(node, cmd, timeout=30, sudo=True) + @staticmethod - def set_linux_interface_ip(node, interface, ip_addr, prefix, - namespace=None): + def set_linux_interface_ip( + node, interface, ip_addr, prefix, namespace=None): """Set IP address to interface in linux. :param node: VPP/TG node. @@ -332,14 +451,69 @@ class IPUtil(object): :raises RuntimeError: IP could not be set. """ if namespace is not None: - cmd = 'ip netns exec {ns} ip addr add {ip}/{p} dev {dev}'.format( - ns=namespace, ip=ip_addr, p=prefix, dev=interface) + cmd = f"ip netns exec {namespace} ip addr add {ip_addr}/{prefix}" \ + f" dev {interface}" + else: + cmd = f"ip addr add {ip_addr}/{prefix} dev {interface}" + + exec_cmd_no_error(node, cmd, timeout=5, sudo=True) + + @staticmethod + def delete_linux_interface_ip( + node, interface, ip_addr, prefix_length, namespace=None): + """Delete IP address from interface in linux. + + :param node: VPP/TG node. + :param interface: Interface in namespace. + :param ip_addr: IP to be deleted from interface. + :param prefix_length: IP prefix length. + :param namespace: Execute command in namespace. Optional + :type node: dict + :type interface: str + :type ip_addr: str + :type prefix_length: int + :type namespace: str + :raises RuntimeError: IP could not be deleted. + """ + if namespace is not None: + cmd = f"ip netns exec {namespace} ip addr del " \ + f"{ip_addr}/{prefix_length} dev {interface}" else: - cmd = 'ip addr add {ip}/{p} dev {dev}'.format( - ip=ip_addr, p=prefix, dev=interface) + cmd = f"ip addr del {ip_addr}/{prefix_length} dev {interface}" exec_cmd_no_error(node, cmd, timeout=5, sudo=True) + @staticmethod + def linux_interface_has_ip( + node, interface, ip_addr, prefix_length, namespace=None): + """Return True if interface in linux has IP address. + + :param node: VPP/TG node. + :param interface: Interface in namespace. + :param ip_addr: IP to be queried on interface. + :param prefix_length: IP prefix length. + :param namespace: Execute command in namespace. Optional + :type node: dict + :type interface: str + :type ip_addr: str + :type prefix_length: int + :type namespace: str + :rtype: boolean + :raises RuntimeError: Request fails. + """ + ip_addr_with_prefix = f"{ip_addr}/{prefix_length}" + if namespace is not None: + cmd = f"ip netns exec {namespace} ip addr show dev {interface}" + else: + cmd = f"ip addr show dev {interface}" + + cmd += u" | grep 'inet ' | awk -e '{print $2}'" + cmd += f" | grep '{ip_addr_with_prefix}'" + _, stdout, _ = exec_cmd(node, cmd, timeout=5, sudo=True) + + has_ip = stdout.rstrip() + return bool(has_ip == ip_addr_with_prefix) + @staticmethod def add_linux_route(node, ip_addr, prefix, gateway, namespace=None): """Add linux route in namespace. @@ -356,15 +530,16 @@ class IPUtil(object): :type namespace: str """ if namespace is not None: - cmd = 'ip netns exec {} ip route add {}/{} via {}'.format( - namespace, ip_addr, prefix, gateway) + cmd = f"ip netns exec {namespace} ip route add {ip_addr}/{prefix}" \ + f" via {gateway}" else: - cmd = 'ip route add {}/{} via {}'.format(ip_addr, prefix, gateway) + cmd = f"ip route add {ip_addr}/{prefix} via {gateway}" + exec_cmd_no_error(node, cmd, sudo=True) @staticmethod - def vpp_interface_set_ip_address(node, interface, address, - prefix_length=None): + def vpp_interface_set_ip_address( + node, interface, address, prefix_length=None): """Set IP address to VPP interface. :param node: VPP node. @@ -376,23 +551,41 @@ class IPUtil(object): :type address: str :type prefix_length: int """ - ip_addr = ip_address(unicode(address)) + ip_addr = ip_address(address) - cmd = 'sw_interface_add_del_address' + cmd = u"sw_interface_add_del_address" args = dict( sw_if_index=InterfaceUtil.get_interface_index(node, interface), - is_add=1, - is_ipv6=1 if ip_addr.version == 6 else 0, - del_all=0, - address_length=int(prefix_length) if prefix_length else 128 - if ip_addr.version == 6 else 32, - address=inet_pton( - AF_INET6 if ip_addr.version == 6 else AF_INET, str(ip_addr))) - err_msg = 'Failed to add IP address on interface {ifc}'.format( - ifc=interface) - with PapiExecutor(node) as papi_exec: - papi_exec.add(cmd, **args).get_replies(err_msg). \ - verify_reply(err_msg=err_msg) + is_add=True, + del_all=False, + prefix=IPUtil.create_prefix_object( + ip_addr, + prefix_length if prefix_length else 128 + if ip_addr.version == 6 else 32 + ) + ) + err_msg = f"Failed to add IP address on interface {interface}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) + + @staticmethod + def vpp_interface_set_ip_addresses(node, interface, ip_addr_list, + prefix_length=None): + """Set IP addresses to VPP interface. + + :param node: VPP node. + :param interface: Interface name. + :param ip_addr_list: IP addresses. + :param prefix_length: Prefix length. + :type node: dict + :type interface: str + :type ip_addr_list: list + :type prefix_length: int + """ + for ip_addr in ip_addr_list: + IPUtil.vpp_interface_set_ip_address(node, interface, ip_addr, + prefix_length) @staticmethod def vpp_add_ip_neighbor(node, iface_key, ip_addr, mac_address): @@ -407,26 +600,45 @@ class IPUtil(object): :type ip_addr: str :type mac_address: str """ - dst_ip = ip_address(unicode(ip_addr)) + dst_ip = ip_address(ip_addr) neighbor = dict( sw_if_index=Topology.get_interface_sw_index(node, iface_key), flags=0, mac_address=str(mac_address), - ip_address=str(dst_ip)) - cmd = 'ip_neighbor_add_del' + ip_address=str(dst_ip) + ) + cmd = u"ip_neighbor_add_del" args = dict( - is_add=1, - neighbor=neighbor) - err_msg = 'Failed to add IP neighbor on interface {ifc}'.format( - ifc=iface_key) - with PapiExecutor(node) as papi_exec: - papi_exec.add(cmd, **args).get_replies(err_msg). \ - verify_reply(err_msg=err_msg) + is_add=True, + neighbor=neighbor + ) + err_msg = f"Failed to add IP neighbor on interface {iface_key}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) + + @staticmethod + def create_prefix_object(ip_addr, addr_len): + """Create prefix object. + + :param ip_addr: IPv4 or IPv6 address. + :param addr_len: Length of IP address. + :type ip_addr: IPv4Address or IPv6Address + :type addr_len: int + :returns: Prefix object. + :rtype: dict + """ + addr = IPAddress.create_ip_address_object(ip_addr) + + return dict( + len=int(addr_len), + address=addr + ) @staticmethod - def vpp_route_add(node, network, prefix_len, **kwargs): - """Add route to the VPP node. + def compose_vpp_route_structure(node, network, prefix_len, **kwargs): + """Create route object for ip_route_add_del api call. :param node: VPP node. :param network: Route destination network address. @@ -438,87 +650,112 @@ class IPUtil(object): vrf: VRF table ID. (int) count: number of IP addresses to add starting from network IP (int) local: The route is local with same prefix (increment is 1). - If None, then is not used. (bool) + If None, then is not used. (bool) lookup_vrf: VRF table ID for lookup. (int) - multipath: Enable multipath routing. (bool) weight: Weight value for unequal cost multipath routing. (int) + (Multipath value enters at higher level.) :type node: dict :type network: str :type prefix_len: int :type kwargs: dict + :returns: route parameter basic structure + :rtype: dict """ - interface = kwargs.get('interface', '') - gateway = kwargs.get('gateway', '') + interface = kwargs.get(u"interface", u"") + gateway = kwargs.get(u"gateway", u"") - net_addr = ip_address(unicode(network)) + net_addr = ip_address(network) - def union_addr(ip_addr): - """Creates union IP address. - - :param ip_addr: IPv4 or IPv6 address. - :type ip_addr: IPv4Address or IPv6Address - :returns: Union IP address. - :rtype: dict - """ - return dict(ip6=inet_pton(AF_INET6, str(ip_addr))) \ - if ip_addr.version == 6 \ - else dict(ip4=inet_pton(AF_INET, str(ip_addr))) - - addr = dict( - af=getattr( - AddressFamily, 'ADDRESS_IP6' if net_addr.version == 6 - else 'ADDRESS_IP4').value) - prefix = dict(address_length=int(prefix_len)) + prefix = IPUtil.create_prefix_object(net_addr, prefix_len) paths = list() n_hop = dict( - address=union_addr(ip_address(unicode(gateway))) if gateway else 0, + address=IPAddress.union_addr(ip_address(gateway)) if gateway else 0, via_label=MPLS_LABEL_INVALID, - obj_id=Constants.BITWISE_NON_ZERO) + obj_id=Constants.BITWISE_NON_ZERO + ) path = dict( sw_if_index=InterfaceUtil.get_interface_index(node, interface) if interface else Constants.BITWISE_NON_ZERO, - table_id=int(kwargs.get('lookup_vrf', 0)), + table_id=int(kwargs.get(u"lookup_vrf", 0)), rpf_id=Constants.BITWISE_NON_ZERO, - weight=int(kwargs.get('weight', 1)), + weight=int(kwargs.get(u"weight", 1)), preference=1, type=getattr( - FibPathType, 'FIB_PATH_TYPE_LOCAL' - if kwargs.get('local', False) - else 'FIB_PATH_TYPE_NORMAL').value, - flags=getattr(FibPathFlags, 'FIB_PATH_FLAG_NONE').value, + FibPathType, u"FIB_PATH_TYPE_LOCAL" + if kwargs.get(u"local", False) + else u"FIB_PATH_TYPE_NORMAL" + ).value, + flags=getattr(FibPathFlags, u"FIB_PATH_FLAG_NONE").value, proto=getattr( - FibPathNhProto, 'FIB_PATH_NH_PROTO_IP6' + FibPathNhProto, u"FIB_PATH_NH_PROTO_IP6" if net_addr.version == 6 - else 'FIB_PATH_NH_PROTO_IP4').value, + else u"FIB_PATH_NH_PROTO_IP4" + ).value, nh=n_hop, n_labels=0, - label_stack=list(0 for _ in range(16))) + label_stack=list(0 for _ in range(16)) + ) paths.append(path) route = dict( - table_id=int(kwargs.get('vrf', 0)), + table_id=int(kwargs.get(u"vrf", 0)), + prefix=prefix, n_paths=len(paths), - paths=paths) - cmd = 'ip_route_add_del' + paths=paths + ) + return route + + @staticmethod + def vpp_route_add(node, network, prefix_len, strict=True, **kwargs): + """Add route to the VPP node. Prefer multipath behavior. + + :param node: VPP node. + :param network: Route destination network address. + :param prefix_len: Route destination network prefix length. + :param strict: If true, fail if address has host bits set. + :param kwargs: Optional key-value arguments: + + gateway: Route gateway address. (str) + interface: Route interface. (str) + vrf: VRF table ID. (int) + count: number of IP addresses to add starting from network IP (int) + local: The route is local with same prefix (increment is 1 network) + If None, then is not used. (bool) + lookup_vrf: VRF table ID for lookup. (int) + multipath: Enable multipath routing. (bool) Default: True. + weight: Weight value for unequal cost multipath routing. (int) + + :type node: dict + :type network: str + :type prefix_len: int + :type strict: bool + :type kwargs: dict + :raises RuntimeError: If the argument combination is not supported. + """ + count = kwargs.get(u"count", 1) + + cmd = u"ip_route_add_del" args = dict( - is_add=1, - is_multipath=int(kwargs.get('multipath', False))) - - err_msg = 'Failed to add route(s) on host {host}'.format( - host=node['host']) - with PapiExecutor(node) as papi_exec: - for i in xrange(kwargs.get('count', 1)): - addr['un'] = union_addr(net_addr + i) - prefix['address'] = addr - route['prefix'] = prefix - history = False if 1 < i < kwargs.get('count', 1) else True - papi_exec.add(cmd, history=history, route=route, **args) - if i > 0 and i % Constants.PAPI_MAX_API_BULK == 0: - papi_exec.get_replies(err_msg).verify_replies( - err_msg=err_msg) - papi_exec.get_replies(err_msg).verify_replies(err_msg=err_msg) + is_add=True, + is_multipath=kwargs.get(u"multipath", True), + route=None + ) + err_msg = f"Failed to add route(s) on host {node[u'host']}" + + netiter = NetworkIncrement( + ip_network(f"{network}/{prefix_len}", strict=strict), + format=u"addr" + ) + with PapiSocketExecutor(node, is_async=True) as papi_exec: + for i in range(count): + args[u"route"] = IPUtil.compose_vpp_route_structure( + node, netiter.inc_fmt(), prefix_len, **kwargs + ) + history = bool(not 0 < i < count - 1) + papi_exec.add(cmd, history=history, **args) + papi_exec.get_replies(err_msg) @staticmethod def flush_ip_addresses(node, interface): @@ -529,15 +766,16 @@ class IPUtil(object): :type node: dict :type interface: str """ - cmd = 'sw_interface_add_del_address' + cmd = u"sw_interface_add_del_address" args = dict( sw_if_index=InterfaceUtil.get_interface_index(node, interface), - del_all=1) - err_msg = 'Failed to flush IP address on interface {ifc}'.format( - ifc=interface) - with PapiExecutor(node) as papi_exec: - papi_exec.add(cmd, **args).get_replies(err_msg). \ - verify_reply(err_msg=err_msg) + is_add=False, + del_all=True + ) + err_msg = f"Failed to flush IP address on interface {interface}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def add_fib_table(node, table_id, ipv6=False): @@ -550,15 +788,16 @@ class IPUtil(object): :type table_id: int :type ipv6: bool """ - cmd = 'ip_table_add_del' + cmd = u"ip_table_add_del" table = dict( table_id=int(table_id), - is_ip6=int(ipv6)) + is_ip6=ipv6 + ) args = dict( table=table, - is_add=1) - err_msg = 'Failed to add FIB table on host {host}'.format( - host=node['host']) - with PapiExecutor(node) as papi_exec: - papi_exec.add(cmd, **args).get_replies(err_msg). \ - verify_reply(err_msg=err_msg) + is_add=True + ) + err_msg = f"Failed to add FIB table on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg)