test/vpp_interface.py

   1 from abc import abstractmethod, ABCMeta
   2 import socket
   3
   4 from util import Host, mk_ll_addr, mactobinary
   5
   6
   7 class VppInterface(object):
   8     """Generic VPP interface."""
   9     __metaclass__ = ABCMeta
  10
  11     @property
  12     def sw_if_index(self):
  13         """Interface index assigned by VPP."""
  14         return self._sw_if_index
  15
  16     @property
  17     def remote_mac(self):
  18         """MAC-address of the remote interface "connected" to this interface"""
  19         return self._remote_hosts[0].mac
  20
  21     @property
  22     def local_mac(self):
  23         """MAC-address of the VPP interface."""
  24         return self._local_mac
  25
  26     @property
  27     def local_addr(self):
  28         return self._local_addr
  29
  30     @property
  31     def remote_addr(self):
  32         return self._remote_addr
  33
  34     @property
  35     def local_addr_n(self):
  36         return self._local_addr_n
  37
  38     @property
  39     def remote_addr_n(self):
  40         return self._remote_addr_n
  41
  42     @property
  43     def local_ip4(self):
  44         """Local IPv4 address on VPP interface (string)."""
  45         return self._local_ip4
  46
  47     @property
  48     def local_ip4n(self):
  49         """Local IPv4 address - raw, suitable as API parameter."""
  50         return socket.inet_pton(socket.AF_INET, self._local_ip4)
  51
  52     @property
  53     def remote_ip4(self):
  54         """IPv4 address of remote peer "connected" to this interface."""
  55         return self._remote_hosts[0].ip4
  56
  57     @property
  58     def remote_ip4n(self):
  59         """IPv4 address of remote peer - raw, suitable as API parameter."""
  60         return socket.inet_pton(socket.AF_INET, self.remote_ip4)
  61
  62     @property
  63     def local_ip6(self):
  64         """Local IPv6 address on VPP interface (string)."""
  65         return self._local_ip6
  66
  67     @property
  68     def local_ip6n(self):
  69         """Local IPv6 address - raw, suitable as API parameter."""
  70         return socket.inet_pton(socket.AF_INET6, self.local_ip6)
  71
  72     @property
  73     def remote_ip6(self):
  74         """IPv6 address of remote peer "connected" to this interface."""
  75         return self._remote_hosts[0].ip6
  76
  77     @property
  78     def remote_ip6n(self):
  79         """IPv6 address of remote peer - raw, suitable as API parameter"""
  80         return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
  81
  82     @property
  83     def local_ip6_ll(self):
  84         """Local IPv6 link-local address on VPP interface (string)."""
  85         return self._local_ip6_ll
  86
  87     @property
  88     def local_ip6n_ll(self):
  89         """Local IPv6 link-local address - raw, suitable as API parameter."""
  90         return self._local_ip6n_ll
  91
  92     @property
  93     def remote_ip6_ll(self):
  94         """Link-local IPv6 address of remote peer
  95         "connected" to this interface."""
  96         return self._remote_ip6_ll
  97
  98     @property
  99     def remote_ip6n_ll(self):
 100         """Link-local IPv6 address of remote peer
 101         - raw, suitable as API parameter"""
 102         return self._remote_ip6n_ll
 103
 104     @property
 105     def name(self):
 106         """Name of the interface."""
 107         return self._name
 108
 109     @property
 110     def dump(self):
 111         """RAW result of sw_interface_dump for this interface."""
 112         return self._dump
 113
 114     @property
 115     def test(self):
 116         """Test case creating this interface."""
 117         return self._test
 118
 119     @property
 120     def remote_hosts(self):
 121         """Remote hosts list"""
 122         return self._remote_hosts
 123
 124     @remote_hosts.setter
 125     def remote_hosts(self, value):
 126         """
 127         :param list value: List of remote hosts.
 128         """
 129         self._remote_hosts = value
 130         self._hosts_by_mac = {}
 131         self._hosts_by_ip4 = {}
 132         self._hosts_by_ip6 = {}
 133         for host in self._remote_hosts:
 134             self._hosts_by_mac[host.mac] = host
 135             self._hosts_by_ip4[host.ip4] = host
 136             self._hosts_by_ip6[host.ip6] = host
 137
 138     def host_by_mac(self, mac):
 139         """
 140         :param mac: MAC address to find host by.
 141         :return: Host object assigned to interface.
 142         """
 143         return self._hosts_by_mac[mac]
 144
 145     def host_by_ip4(self, ip):
 146         """
 147         :param ip: IPv4 address to find host by.
 148         :return: Host object assigned to interface.
 149         """
 150         return self._hosts_by_ip4[ip]
 151
 152     def host_by_ip6(self, ip):
 153         """
 154         :param ip: IPv6 address to find host by.
 155         :return: Host object assigned to interface.
 156         """
 157         return self._hosts_by_ip6[ip]
 158
 159     def generate_remote_hosts(self, count=1):
 160         """Generate and add remote hosts for the interface.
 161
 162         :param int count: Number of generated remote hosts.
 163         """
 164         self._remote_hosts = []
 165         self._hosts_by_mac = {}
 166         self._hosts_by_ip4 = {}
 167         self._hosts_by_ip6 = {}
 168         for i in range(
 169                 2, count + 2):  # 0: network address, 1: local vpp address
 170             mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
 171             ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
 172             ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
 173             ip6_ll = mk_ll_addr(mac)
 174             host = Host(mac, ip4, ip6, ip6_ll)
 175             self._remote_hosts.append(host)
 176             self._hosts_by_mac[mac] = host
 177             self._hosts_by_ip4[ip4] = host
 178             self._hosts_by_ip6[ip6] = host
 179
 180     @abstractmethod
 181     def __init__(self, test):
 182         self._test = test
 183
 184         self._remote_hosts = []
 185         self._hosts_by_mac = {}
 186         self._hosts_by_ip4 = {}
 187         self._hosts_by_ip6 = {}
 188
 189     def set_mac(self, mac):
 190         self._local_mac = mac
 191         self._local_ip6_ll = mk_ll_addr(mac)
 192         self.test.vapi.sw_interface_set_mac_address(
 193             self.sw_if_index,
 194             mactobinary(self._local_mac))
 195
 196     def set_sw_if_index(self, sw_if_index):
 197         self._sw_if_index = sw_if_index
 198
 199         self.generate_remote_hosts()
 200
 201         self._local_ip4 = "172.16.%u.1" % self.sw_if_index
 202         self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
 203         self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
 204         self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
 205                                                    self._local_ip4_subnet)
 206         self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
 207         self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
 208                                                   self._local_ip4_bcast)
 209         self.local_ip4_prefix_len = 24
 210         self.has_ip4_config = False
 211         self.ip4_table_id = 0
 212
 213         self._local_ip6 = "fd01:%x::1" % self.sw_if_index
 214         self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
 215         self.local_ip6_prefix_len = 64
 216         self.has_ip6_config = False
 217         self.ip6_table_id = 0
 218
 219         self._local_addr = {socket.AF_INET: self.local_ip4,
 220                             socket.AF_INET6: self.local_ip6}
 221         self._local_addr_n = {socket.AF_INET: self.local_ip4n,
 222                               socket.AF_INET6: self.local_ip6n}
 223         self._remote_addr = {socket.AF_INET: self.remote_ip4,
 224                              socket.AF_INET6: self.remote_ip6}
 225         self._remote_addr_n = {socket.AF_INET: self.remote_ip4n,
 226                                socket.AF_INET6: self.remote_ip6n}
 227
 228         r = self.test.vapi.sw_interface_dump()
 229         for intf in r:
 230             if intf.sw_if_index == self.sw_if_index:
 231                 self._name = intf.interface_name.split(b'\0', 1)[0]
 232                 self._local_mac = \
 233                     ':'.join(intf.l2_address.encode('hex')[i:i + 2]
 234                              for i in range(0, 12, 2))
 235                 self._dump = intf
 236                 break
 237         else:
 238             raise Exception(
 239                 "Could not find interface with sw_if_index %d "
 240                 "in interface dump %s" %
 241                 (self.sw_if_index, repr(r)))
 242         self._local_ip6_ll = mk_ll_addr(self.local_mac)
 243         self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
 244                                                self.local_ip6_ll)
 245         self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
 246         self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
 247                                                 self.remote_ip6_ll)
 248
 249     def config_ip4(self):
 250         """Configure IPv4 address on the VPP interface."""
 251         self.test.vapi.sw_interface_add_del_address(
 252             self.sw_if_index, self.local_ip4n, self.local_ip4_prefix_len)
 253         self.has_ip4_config = True
 254
 255     def unconfig_ip4(self):
 256         """Remove IPv4 address on the VPP interface."""
 257         try:
 258             if self.has_ip4_config:
 259                 self.test.vapi.sw_interface_add_del_address(
 260                     self.sw_if_index,
 261                     self.local_ip4n,
 262                     self.local_ip4_prefix_len,
 263                     is_add=0)
 264         except AttributeError:
 265             self.has_ip4_config = False
 266         self.has_ip4_config = False
 267
 268     def configure_ipv4_neighbors(self):
 269         """For every remote host assign neighbor's MAC to IPv4 addresses.
 270
 271         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
 272         """
 273         for host in self._remote_hosts:
 274             macn = host.mac.replace(":", "").decode('hex')
 275             ipn = host.ip4n
 276             self.test.vapi.ip_neighbor_add_del(
 277                 self.sw_if_index, macn, ipn)
 278
 279     def config_ip6(self):
 280         """Configure IPv6 address on the VPP interface."""
 281         self.test.vapi.sw_interface_add_del_address(
 282             self.sw_if_index, self._local_ip6n, self.local_ip6_prefix_len,
 283             is_ipv6=1)
 284         self.has_ip6_config = True
 285
 286     def unconfig_ip6(self):
 287         """Remove IPv6 address on the VPP interface."""
 288         try:
 289             if self.has_ip6_config:
 290                 self.test.vapi.sw_interface_add_del_address(
 291                     self.sw_if_index,
 292                     self.local_ip6n,
 293                     self.local_ip6_prefix_len,
 294                     is_ipv6=1, is_add=0)
 295         except AttributeError:
 296             self.has_ip6_config = False
 297         self.has_ip6_config = False
 298
 299     def configure_ipv6_neighbors(self):
 300         """For every remote host assign neighbor's MAC to IPv6 addresses.
 301
 302         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
 303         """
 304         for host in self._remote_hosts:
 305             macn = host.mac.replace(":", "").decode('hex')
 306             ipn = host.ip6n
 307             self.test.vapi.ip_neighbor_add_del(
 308                 self.sw_if_index, macn, ipn, is_ipv6=1)
 309
 310     def unconfig(self):
 311         """Unconfigure IPv6 and IPv4 address on the VPP interface."""
 312         self.unconfig_ip4()
 313         self.unconfig_ip6()
 314
 315     def set_table_ip4(self, table_id):
 316         """Set the interface in a IPv4 Table.
 317
 318         .. note:: Must be called before configuring IP4 addresses.
 319         """
 320         self.ip4_table_id = table_id
 321         self.test.vapi.sw_interface_set_table(
 322             self.sw_if_index, 0, self.ip4_table_id)
 323
 324     def set_table_ip6(self, table_id):
 325         """Set the interface in a IPv6 Table.
 326
 327         .. note:: Must be called before configuring IP6 addresses.
 328         """
 329         self.ip6_table_id = table_id
 330         self.test.vapi.sw_interface_set_table(
 331             self.sw_if_index, 1, self.ip6_table_id)
 332
 333     def disable_ipv6_ra(self):
 334         """Configure IPv6 RA suppress on the VPP interface."""
 335         self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
 336
 337     def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
 338         """Configure IPv6 RA suppress on the VPP interface."""
 339         self.test.vapi.ip6_sw_interface_ra_config(self.sw_if_index,
 340                                                   no,
 341                                                   suppress,
 342                                                   send_unicast)
 343
 344     def ip6_ra_prefix(self, address, address_length, is_no=0,
 345                       off_link=0, no_autoconfig=0, use_default=0):
 346         """Configure IPv6 RA suppress on the VPP interface."""
 347         self.test.vapi.ip6_sw_interface_ra_prefix(self.sw_if_index,
 348                                                   address,
 349                                                   address_length,
 350                                                   is_no=is_no,
 351                                                   off_link=off_link,
 352                                                   no_autoconfig=no_autoconfig,
 353                                                   use_default=use_default)
 354
 355     def admin_up(self):
 356         """Put interface ADMIN-UP."""
 357         self.test.vapi.sw_interface_set_flags(self.sw_if_index,
 358                                               admin_up_down=1)
 359
 360     def admin_down(self):
 361         """Put interface ADMIN-down."""
 362         self.test.vapi.sw_interface_set_flags(self.sw_if_index,
 363                                               admin_up_down=0)
 364
 365     def ip6_enable(self):
 366         """IPv6 Enable interface"""
 367         self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
 368                                                        enable=1)
 369
 370     def ip6_disable(self):
 371         """Put interface ADMIN-DOWN."""
 372         self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
 373                                                        enable=0)
 374
 375     def add_sub_if(self, sub_if):
 376         """Register a sub-interface with this interface.
 377
 378         :param sub_if: sub-interface
 379         """
 380         if not hasattr(self, 'sub_if'):
 381             self.sub_if = sub_if
 382         else:
 383             if isinstance(self.sub_if, list):
 384                 self.sub_if.append(sub_if)
 385             else:
 386                 self.sub_if = sub_if
 387
 388     def enable_mpls(self):
 389         """Enable MPLS on the VPP interface."""
 390         self.test.vapi.sw_interface_enable_disable_mpls(
 391             self.sw_if_index)
 392
 393     def disable_mpls(self):
 394         """Enable MPLS on the VPP interface."""
 395         self.test.vapi.sw_interface_enable_disable_mpls(
 396             self.sw_if_index, 0)
 397
 398     def is_ip4_entry_in_fib_dump(self, dump):
 399         for i in dump:
 400             if i.address == self.local_ip4n and \
 401                i.address_length == self.local_ip4_prefix_len and \
 402                i.table_id == self.ip4_table_id:
 403                 return True
 404         return False
 405
 406     def set_unnumbered(self, ip_sw_if_index):
 407         """ Set the interface to unnumbered via ip_sw_if_index """
 408         self.test.vapi.sw_interface_set_unnumbered(
 409             self.sw_if_index,
 410             ip_sw_if_index)
 411
 412     def unset_unnumbered(self, ip_sw_if_index):
 413         """ Unset the interface to unnumbered via ip_sw_if_index """
 414         self.test.vapi.sw_interface_set_unnumbered(
 415             self.sw_if_index,
 416             ip_sw_if_index,
 417             is_add=0)
 418
 419     def set_proxy_arp(self, enable=1):
 420         """ Set the interface to enable/disable Proxy ARP """
 421         self.test.vapi.proxy_arp_intfc_enable_disable(
 422             self.sw_if_index,
 423             enable)
 424
 425     def query_vpp_config(self):
 426         dump = self.test.vapi.sw_interface_dump()
 427         return self.is_interface_config_in_dump(dump)
 428
 429     def get_interface_config_from_dump(self, dump):
 430         for i in dump:
 431             if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
 432                i.sw_if_index == self.sw_if_index:
 433                 return i
 434         else:
 435             return None
 436
 437     def is_interface_config_in_dump(self, dump):
 438         return self.get_interface_config_from_dump(dump) is not None
 439
 440     def assert_interface_state(self, admin_up_down, link_up_down,
 441                                expect_event=False):
 442         if expect_event:
 443             event = self.test.vapi.wait_for_event(timeout=1,
 444                                                   name='sw_interface_event')
 445             self.test.assert_equal(event.sw_if_index, self.sw_if_index,
 446                                    "sw_if_index")
 447             self.test.assert_equal(event.admin_up_down, admin_up_down,
 448                                    "admin state")
 449             self.test.assert_equal(event.link_up_down, link_up_down,
 450                                    "link state")
 451         dump = self.test.vapi.sw_interface_dump()
 452         if_state = self.get_interface_config_from_dump(dump)
 453         self.test.assert_equal(if_state.admin_up_down, admin_up_down,
 454                                "admin state")
 455         self.test.assert_equal(if_state.link_up_down, link_up_down,
 456                                "link state")