test/vpp_interface.py

   1 from abc import abstractmethod, ABCMeta
   2 import socket
   3 from logging import info
   4
   5 from util import Host
   6
   7
   8 class VppInterface(object):
   9     """Generic VPP interface."""
  10     __metaclass__ = ABCMeta
  11
  12     @property
  13     def sw_if_index(self):
  14         """Interface index assigned by VPP."""
  15         return self._sw_if_index
  16
  17     @property
  18     def remote_mac(self):
  19         """MAC-address of the remote interface "connected" to this interface."""
  20         return self._remote_hosts[0].mac
  21
  22     @property
  23     def local_mac(self):
  24         """MAC-address of the VPP interface."""
  25         return self._local_mac
  26
  27     @property
  28     def local_ip4(self):
  29         """Local IPv4 address on VPP interface (string)."""
  30         return self._local_ip4
  31
  32     @property
  33     def local_ip4n(self):
  34         """Local IPv4 address - raw, suitable as API parameter."""
  35         return socket.inet_pton(socket.AF_INET, self._local_ip4)
  36
  37     @property
  38     def remote_ip4(self):
  39         """IPv4 address of remote peer "connected" to this interface."""
  40         return self._remote_hosts[0].ip4
  41
  42     @property
  43     def remote_ip4n(self):
  44         """IPv4 address of remote peer - raw, suitable as API parameter."""
  45         return socket.inet_pton(socket.AF_INET, self.remote_ip4)
  46
  47     @property
  48     def local_ip6(self):
  49         """Local IPv6 address on VPP interface (string)."""
  50         return self._local_ip6
  51
  52     @property
  53     def local_ip6n(self):
  54         """Local IPv6 address - raw, suitable as API parameter."""
  55         return socket.inet_pton(socket.AF_INET6, self.local_ip6)
  56
  57     @property
  58     def remote_ip6(self):
  59         """IPv6 address of remote peer "connected" to this interface."""
  60         return self._remote_hosts[0].ip6
  61
  62     @property
  63     def remote_ip6n(self):
  64         """IPv6 address of remote peer - raw, suitable as API parameter"""
  65         return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
  66
  67     @property
  68     def name(self):
  69         """Name of the interface."""
  70         return self._name
  71
  72     @property
  73     def dump(self):
  74         """RAW result of sw_interface_dump for this interface."""
  75         return self._dump
  76
  77     @property
  78     def test(self):
  79         """Test case creating this interface."""
  80         return self._test
  81
  82     @property
  83     def remote_hosts(self):
  84         """Remote hosts list"""
  85         return self._remote_hosts
  86
  87     @remote_hosts.setter
  88     def remote_hosts(self, value):
  89         """
  90         :param list value: List of remote hosts.
  91         """
  92         self._remote_hosts = value
  93         self._hosts_by_mac = {}
  94         self._hosts_by_ip4 = {}
  95         self._hosts_by_ip6 = {}
  96         for host in self._remote_hosts:
  97             self._hosts_by_mac[host.mac] = host
  98             self._hosts_by_ip4[host.ip4] = host
  99             self._hosts_by_ip6[host.ip6] = host
 100
 101     def host_by_mac(self, mac):
 102         """
 103         :param ip: MAC address to find host by.
 104         :return: Host object assigned to interface.
 105         """
 106         return self._hosts_by_mac[mac]
 107
 108     def host_by_ip4(self, ip):
 109         """
 110         :param ip: IPv4 address to find host by.
 111         :return: Host object assigned to interface.
 112         """
 113         return self._hosts_by_ip4[ip]
 114
 115     def host_by_ip6(self, ip):
 116         """
 117         :param ip: IPv6 address to find host by.
 118         :return: Host object assigned to interface.
 119         """
 120         return self._hosts_by_ip6[ip]
 121
 122     def generate_remote_hosts(self, count=1):
 123         """Generate and add remote hosts for the interface.
 124
 125         :param int count: Number of generated remote hosts.
 126         """
 127         self._remote_hosts = []
 128         self._hosts_by_mac = {}
 129         self._hosts_by_ip4 = {}
 130         self._hosts_by_ip6 = {}
 131         for i in range(2, count+2):  # 0: network address, 1: local vpp address
 132             mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
 133             ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
 134             ip6 = "fd01:%04x::%04x" % (self.sw_if_index, i)
 135             host = Host(mac, ip4, ip6)
 136             self._remote_hosts.append(host)
 137             self._hosts_by_mac[mac] = host
 138             self._hosts_by_ip4[ip4] = host
 139             self._hosts_by_ip6[ip6] = host
 140
 141     def post_init_setup(self):
 142         """Additional setup run after creating an interface object."""
 143
 144         self.generate_remote_hosts()
 145
 146         self._local_ip4 = "172.16.%u.1" % self.sw_if_index
 147         self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
 148
 149         self._local_ip6 = "fd01:%04x::1" % self.sw_if_index
 150         self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
 151
 152         r = self.test.vapi.sw_interface_dump()
 153         for intf in r:
 154             if intf.sw_if_index == self.sw_if_index:
 155                 self._name = intf.interface_name.split(b'\0', 1)[0]
 156                 self._local_mac = ':'.join(intf.l2_address.encode('hex')[i:i + 2]
 157                                            for i in range(0, 12, 2))
 158                 self._dump = intf
 159                 break
 160         else:
 161             raise Exception(
 162                 "Could not find interface with sw_if_index %d "
 163                 "in interface dump %s" %
 164                 (self.sw_if_index, repr(r)))
 165
 166     @abstractmethod
 167     def __init__(self, test, index):
 168         self._test = test
 169         self.post_init_setup()
 170         info("New %s, MAC=%s, remote_ip4=%s, local_ip4=%s" %
 171              (self.__name__, self.remote_mac, self.remote_ip4, self.local_ip4))
 172
 173     def config_ip4(self):
 174         """Configure IPv4 address on the VPP interface."""
 175         addr = self.local_ip4n
 176         addr_len = 24
 177         self.test.vapi.sw_interface_add_del_address(
 178             self.sw_if_index, addr, addr_len)
 179
 180     def configure_ipv4_neighbors(self):
 181         """For every remote host assign neighbor's MAC to IPv4 addresses."""
 182         for host in self._remote_hosts:
 183             macn = host.mac.replace(":", "").decode('hex')
 184             ipn = host.ip4n
 185             self.test.vapi.ip_neighbor_add_del(self.sw_if_index, macn, ipn)
 186
 187     def config_ip6(self):
 188         """Configure IPv6 address on the VPP interface."""
 189         addr = self._local_ip6n
 190         addr_len = 64
 191         self.test.vapi.sw_interface_add_del_address(
 192             self.sw_if_index, addr, addr_len, is_ipv6=1)
 193
 194     def set_table_ip4(self, table_id):
 195         """Set the interface in a IPv4 Table.
 196
 197         .. note:: Must be called before configuring IP4 addresses."""
 198         self.test.vapi.sw_interface_set_table(
 199             self.sw_if_index, 0, table_id)
 200
 201     def set_table_ip6(self, table_id):
 202         """Set the interface in a IPv6 Table.
 203
 204         .. note:: Must be called before configuring IP6 addresses.
 205         """
 206         self.test.vapi.sw_interface_set_table(
 207             self.sw_if_index, 1, table_id)
 208
 209     def disable_ipv6_ra(self):
 210         """Configure IPv6 RA suppress on the VPP interface."""
 211         self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
 212
 213     def admin_up(self):
 214         """Put interface ADMIN-UP."""
 215         self.test.vapi.sw_interface_set_flags(self.sw_if_index, admin_up_down=1)
 216
 217     def add_sub_if(self, sub_if):
 218         """Register a sub-interface with this interface.
 219
 220         :param sub_if: sub-interface
 221         """
 222         if not hasattr(self, 'sub_if'):
 223             self.sub_if = sub_if
 224         else:
 225             if isinstance(self.sub_if, list):
 226                 self.sub_if.append(sub_if)
 227             else:
 228                 self.sub_if = sub_if
 229
 230     def enable_mpls(self):
 231         """Enable MPLS on the VPP interface."""
 232         self.test.vapi.sw_interface_enable_disable_mpls(
 233             self.sw_if_index)