import re
-from socket import AF_INET, AF_INET6, inet_ntop, inet_pton
-
-from ipaddress import ip_address
-from ipaddress import IPv4Network, IPv6Network, IPv4Address, IPv6Address
-from ipaddress import AddressValueError, NetmaskValueError
+from enum import IntEnum
+from ipaddress import ip_address, IPv4Network, IPv6Network
from resources.libraries.python.Constants import Constants
from resources.libraries.python.InterfaceUtil import InterfaceUtil
from resources.libraries.python.PapiExecutor import PapiExecutor
from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
-from resources.libraries.python.topology import NodeType, Topology
+from resources.libraries.python.topology import Topology
+from resources.libraries.python.VatExecutor import VatTerminal
+
+
+# from vpp/src/vnet/vnet/mpls/mpls_types.h
+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
+ FIB_PATH_TYPE_LOCAL = 1
+ FIB_PATH_TYPE_DROP = 2
+ FIB_PATH_TYPE_UDP_ENCAP = 3
+ FIB_PATH_TYPE_BIER_IMP = 4
+ FIB_PATH_TYPE_ICMP_UNREACH = 5
+ FIB_PATH_TYPE_ICMP_PROHIBIT = 6
+ FIB_PATH_TYPE_SOURCE_LOOKUP = 7
+ FIB_PATH_TYPE_DVR = 8
+ FIB_PATH_TYPE_INTERFACE_RX = 9
+ FIB_PATH_TYPE_CLASSIFY = 10
+
+
+class FibPathFlags(IntEnum):
+ """FIB path flags."""
+ FIB_PATH_FLAG_NONE = 0
+ FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1
+ FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
+
+
+class FibPathNhProto(IntEnum):
+ """FIB path next-hop protocol."""
+ FIB_PATH_NH_PROTO_IP4 = 0
+ FIB_PATH_NH_PROTO_IP6 = 1
+ FIB_PATH_NH_PROTO_MPLS = 2
+ FIB_PATH_NH_PROTO_ETHERNET = 3
+ FIB_PATH_NH_PROTO_BIER = 4
class IPUtil(object):
Note: A single interface may have multiple IP addresses assigned.
:rtype: list
"""
- try:
- sw_if_index = Topology.convert_interface_reference(
- node, interface, 'sw_if_index')
- except RuntimeError:
- if isinstance(interface, basestring):
- sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
- else:
- raise
+ sw_if_index = InterfaceUtil.get_interface_index(node, interface)
- is_ipv6 = 1 if ip_version == 'ipv6' else 0
+ 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'])
+ cmd = 'ip_address_dump'
+ 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)
+ with PapiExecutor(node) as papi_exec:
+ details = papi_exec.add(cmd, **args).get_details(err_msg)
+
+ for item in details:
+ item['ip'] = item['prefix'].split('/')[0]
+ item['prefix_length'] = int(item['prefix'].split('/')[1])
+ item['is_ipv6'] = is_ipv6
+ item['netmask'] = \
+ str(IPv6Network(unicode('::/{pl}'.format(
+ pl=item['prefix_length']))).netmask) \
+ if is_ipv6 \
+ else str(IPv4Network(unicode('0.0.0.0/{pl}'.format(
+ pl=item['prefix_length']))).netmask)
+
+ return details
- data = list()
- for item in papi_resp.reply[0]['api_reply']:
- item[cmd_reply]['ip'] = inet_ntop(AF_INET6, item[cmd_reply]['ip']) \
- if is_ipv6 else inet_ntop(AF_INET, item[cmd_reply]['ip'][0:4])
- 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])
+ @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
+ """
+
+ PapiExecutor.run_cli_cmd(node, 'show ip fib')
+ PapiExecutor.run_cli_cmd(node, 'show ip fib summary')
+ PapiExecutor.run_cli_cmd(node, 'show ip6 fib')
+ PapiExecutor.run_cli_cmd(node, 'show ip6 fib summary')
+
+ @staticmethod
+ def vpp_get_ip_tables_prefix(node, address):
+ """Get dump of all IP FIB tables on a VPP node.
+
+ :param node: VPP node.
+ :type node: dict
+ """
+ addr = ip_address(unicode(address))
- return data
+ PapiExecutor.run_cli_cmd(
+ node, 'show {ip_ver} fib {addr}/{addr_len}'.format(
+ ip_ver='ip6' if addr.version == 6 else 'ip',
+ addr=addr,
+ addr_len=addr.max_prefixlen))
@staticmethod
def get_interface_vrf_table(node, interface, ip_version='ipv4'):
:returns: vrf ID of the specified interface.
:rtype: int
"""
- if isinstance(interface, basestring):
- sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
- else:
- sw_if_index = interface
+ sw_if_index = InterfaceUtil.get_interface_index(node, interface)
is_ipv6 = 1 if ip_version == 'ipv6' else 0
ifc=interface)
with PapiExecutor(node) as papi_exec:
- papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg). \
- verify_reply(err_msg=err_msg)
+ reply = papi_exec.add(cmd, **args).get_reply(err_msg)
- return papi_resp['vrf_id']
+ return reply['vrf_id']
@staticmethod
def vpp_ip_source_check_setup(node, if_name):
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)
+ papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def vpp_ip_probe(node, interface, addr):
:type addr: str
"""
cmd = 'ip_probe_neighbor'
- cmd_reply = 'proxy_arp_intfc_enable_disable_reply'
args = dict(
sw_if_index=InterfaceUtil.get_interface_index(node, interface),
dst=str(addr))
dev=interface, ip=addr, h=node['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)
+ papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def ip_addresses_should_be_equal(ip1, ip2):
:type address: str
:type prefix_length: int
"""
- try:
- ip_addr = IPv6Address(unicode(address))
- af_inet = AF_INET6
- is_ipv6 = 1
- except (AddressValueError, NetmaskValueError):
- ip_addr = IPv4Address(unicode(address))
- af_inet = AF_INET
- is_ipv6 = 0
+ ip_addr = ip_address(unicode(address))
cmd = 'sw_interface_add_del_address'
args = dict(
sw_if_index=InterfaceUtil.get_interface_index(node, interface),
is_add=1,
- is_ipv6=is_ipv6,
+ is_ipv6=1 if ip_addr.version == 6 else 0,
del_all=0,
address_length=int(prefix_length) if prefix_length else 128
- if is_ipv6 else 32,
- address=inet_pton(af_inet, str(ip_addr)))
+ if ip_addr.version == 6 else 32,
+ address=ip_addr.packed)
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)
+ papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def vpp_add_ip_neighbor(node, iface_key, ip_addr, mac_address):
:type ip_addr: str
:type mac_address: str
"""
- try:
- dst_ip = IPv6Address(unicode(ip_addr))
- except (AddressValueError, NetmaskValueError):
- dst_ip = IPv4Address(unicode(ip_addr))
+ dst_ip = ip_address(unicode(ip_addr))
neighbor = dict(
- sw_if_index=Topology.get_interface_sw_index(
- node, iface_key),
+ sw_if_index=Topology.get_interface_sw_index(node, iface_key),
flags=0,
mac_address=str(mac_address),
ip_address=str(dst_ip))
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)
+ papi_exec.add(cmd, **args).get_reply(err_msg)
+
+ @staticmethod
+ 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=ip_addr.packed) if ip_addr.version == 6 \
+ else dict(ip4=ip_addr.packed)
+
+ @staticmethod
+ 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.
+ :param prefix_len: Route destination network prefix length.
+ :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).
+ 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)
+
+ :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', '')
+
+ net_addr = ip_address(unicode(network))
+
+ addr = dict(
+ af=getattr(
+ AddressFamily, 'ADDRESS_IP6' if net_addr.version == 6
+ else 'ADDRESS_IP4').value,
+ un=None)
+ prefix = dict(
+ len=int(prefix_len),
+ address=addr)
+
+ paths = list()
+ n_hop = dict(
+ address=IPUtil.union_addr(ip_address(unicode(gateway))) if gateway
+ else 0,
+ via_label=MPLS_LABEL_INVALID,
+ 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)),
+ rpf_id=Constants.BITWISE_NON_ZERO,
+ weight=int(kwargs.get('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,
+ proto=getattr(
+ FibPathNhProto, 'FIB_PATH_NH_PROTO_IP6'
+ if net_addr.version == 6
+ else 'FIB_PATH_NH_PROTO_IP4').value,
+ nh=n_hop,
+ n_labels=0,
+ label_stack=list(0 for _ in range(16)))
+ paths.append(path)
+
+ route = dict(
+ table_id=int(kwargs.get('vrf', 0)),
+ prefix=prefix,
+ n_paths=len(paths),
+ paths=paths)
+
+ return route
@staticmethod
def vpp_route_add(node, network, prefix_len, **kwargs):
:type prefix_len: int
:type kwargs: dict
"""
- interface = kwargs.get('interface', None)
- gateway = kwargs.get('gateway', None)
-
- try:
- net_addr = IPv6Address(unicode(network))
- af_inet = AF_INET6
- is_ipv6 = 1
- except (AddressValueError, NetmaskValueError):
- net_addr = IPv4Address(unicode(network))
- af_inet = AF_INET
- is_ipv6 = 0
-
- if gateway:
- try:
- gt_addr = IPv6Address(unicode(gateway))
- af_inet_gt = AF_INET6
- except (AddressValueError, NetmaskValueError):
- gt_addr = IPv4Address(unicode(gateway))
- af_inet_gt = AF_INET
-
- cmd = 'ip_add_del_route'
+ count = kwargs.get("count", 1)
+
+ if count > 100:
+ gateway = kwargs.get("gateway", '')
+ interface = kwargs.get("interface", '')
+ vrf = kwargs.get("vrf", None)
+ multipath = kwargs.get("multipath", False)
+
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ 'vpp_route_add.vat',
+ network=network,
+ prefix_length=prefix_len,
+ via='via {}'.format(gateway) if gateway else '',
+ sw_if_index='sw_if_index {}'.format(
+ InterfaceUtil.get_interface_index(node, interface))
+ if interface else '',
+ vrf='vrf {}'.format(vrf) if vrf else '',
+ count='count {}'.format(count) if count else '',
+ multipath='multipath' if multipath else '')
+ return
+
+ net_addr = ip_address(unicode(network))
+ cmd = 'ip_route_add_del'
+ route = IPUtil.compose_vpp_route_structure(
+ node, network, prefix_len, **kwargs)
args = dict(
- next_hop_sw_if_index=InterfaceUtil.get_interface_index(
- node, interface) if interface else Constants.BITWISE_NON_ZERO,
- table_id=int(kwargs.get('vrf', 0)),
is_add=1,
- is_ipv6=is_ipv6,
- is_local=int(kwargs.get('local', False)),
is_multipath=int(kwargs.get('multipath', False)),
- next_hop_weight=int(kwargs.get('weight', 1)),
- next_hop_proto=1 if is_ipv6 else 0,
- dst_address_length=int(prefix_len),
- next_hop_address=inet_pton(af_inet_gt, str(gt_addr)) if gateway
- else 0,
- next_hop_table_id=int(kwargs.get('lookup_vrf', 0)))
+ route=route)
+
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)):
- papi_exec.add(cmd, dst_address=inet_pton(
- af_inet, str(net_addr+i)), **args)
- papi_exec.get_replies(err_msg).verify_replies(err_msg=err_msg)
-
- @staticmethod
- def vpp_nodes_set_ipv4_addresses(nodes, nodes_addr):
- """Set IPv4 addresses on all VPP nodes in topology.
-
- :param nodes: Nodes of the test topology.
- :param nodes_addr: Available nodes IPv4 addresses.
- :type nodes: dict
- :type nodes_addr: dict
- :returns: Affected interfaces as list of (node, interface) tuples.
- :rtype: list
- """
- interfaces = []
- for net in nodes_addr.values():
- for port in net['ports'].values():
- host = port.get('node')
- if host is None:
- continue
- topo = Topology()
- node = topo.get_node_by_hostname(nodes, host)
- if node is None:
- continue
- if node['type'] != NodeType.DUT:
- continue
- iface_key = topo.get_interface_by_name(node, port['if'])
- IPUtil.vpp_interface_set_ip_address(
- node, iface_key, port['addr'], net['prefix'])
- interfaces.append((node, port['if']))
-
- return interfaces
+ args['route']['prefix']['address']['un'] = \
+ IPUtil.union_addr(net_addr + i)
+ history = False if 1 < i < kwargs.get('count', 1) else True
+ papi_exec.add(cmd, history=history, **args)
+ if i > 0 and i % Constants.PAPI_MAX_API_BULK == 0:
+ papi_exec.get_replies(err_msg)
+ papi_exec.get_replies(err_msg)
@staticmethod
def flush_ip_addresses(node, interface):
- """Flush all IPv4addresses from specified interface.
+ """Flush all IP addresses from specified interface.
:param node: VPP node.
:param interface: Interface name.
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)
+ papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def add_fib_table(node, table_id, ipv6=False):
:type ipv6: bool
"""
cmd = 'ip_table_add_del'
- args = dict(
+ table = dict(
table_id=int(table_id),
- is_ipv6=int(ipv6),
+ is_ip6=int(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)
+ papi_exec.add(cmd, **args).get_reply(err_msg)
Code Review / csit.git / blobdiff