test/vpp_interface.py

   1 import binascii
   2 import socket
   3 from abc import abstractmethod, ABCMeta
   4
   5 from six import moves
   6
   7 from util import Host, mk_ll_addr
   8 from vpp_papi import mac_ntop
   9
  10
  11 class VppInterface(object):
  12     """Generic VPP interface."""
  13     __metaclass__ = ABCMeta
  14
  15     @property
  16     def sw_if_index(self):
  17         """Interface index assigned by VPP."""
  18         return self._sw_if_index
  19
  20     @property
  21     def remote_mac(self):
  22         """MAC-address of the remote interface "connected" to this interface"""
  23         return self._remote_hosts[0].mac
  24
  25     @property
  26     def local_mac(self):
  27         """MAC-address of the VPP interface."""
  28         return self._local_mac
  29
  30     @property
  31     def local_addr(self):
  32         return self._local_addr
  33
  34     @property
  35     def remote_addr(self):
  36         return self._remote_addr
  37
  38     @property
  39     def local_addr_n(self):
  40         return self._local_addr_n
  41
  42     @property
  43     def remote_addr_n(self):
  44         return self._remote_addr_n
  45
  46     @property
  47     def local_ip4(self):
  48         """Local IPv4 address on VPP interface (string)."""
  49         return self._local_ip4
  50
  51     @property
  52     def local_ip4n(self):
  53         """Local IPv4 address - raw, suitable as API parameter."""
  54         return socket.inet_pton(socket.AF_INET, self._local_ip4)
  55
  56     @property
  57     def remote_ip4(self):
  58         """IPv4 address of remote peer "connected" to this interface."""
  59         return self._remote_hosts[0].ip4
  60
  61     @property
  62     def remote_ip4n(self):
  63         """IPv4 address of remote peer - raw, suitable as API parameter."""
  64         return socket.inet_pton(socket.AF_INET, self.remote_ip4)
  65
  66     @property
  67     def local_ip6(self):
  68         """Local IPv6 address on VPP interface (string)."""
  69         return self._local_ip6
  70
  71     @property
  72     def local_ip6n(self):
  73         """Local IPv6 address - raw, suitable as API parameter."""
  74         return socket.inet_pton(socket.AF_INET6, self.local_ip6)
  75
  76     @property
  77     def remote_ip6(self):
  78         """IPv6 address of remote peer "connected" to this interface."""
  79         return self._remote_hosts[0].ip6
  80
  81     @property
  82     def remote_ip6n(self):
  83         """IPv6 address of remote peer - raw, suitable as API parameter"""
  84         return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
  85
  86     @property
  87     def local_ip6_ll(self):
  88         """Local IPv6 link-local address on VPP interface (string)."""
  89         return self._local_ip6_ll
  90
  91     @property
  92     def local_ip6n_ll(self):
  93         """Local IPv6 link-local address - raw, suitable as API parameter."""
  94         return self._local_ip6n_ll
  95
  96     @property
  97     def remote_ip6_ll(self):
  98         """Link-local IPv6 address of remote peer
  99         "connected" to this interface."""
 100         return self._remote_ip6_ll
 101
 102     @property
 103     def remote_ip6n_ll(self):
 104         """Link-local IPv6 address of remote peer
 105         - raw, suitable as API parameter"""
 106         return self._remote_ip6n_ll
 107
 108     @property
 109     def name(self):
 110         """Name of the interface."""
 111         return self._name
 112
 113     @property
 114     def dump(self):
 115         """RAW result of sw_interface_dump for this interface."""
 116         return self._dump
 117
 118     @property
 119     def test(self):
 120         """Test case creating this interface."""
 121         return self._test
 122
 123     @property
 124     def remote_hosts(self):
 125         """Remote hosts list"""
 126         return self._remote_hosts
 127
 128     @remote_hosts.setter
 129     def remote_hosts(self, value):
 130         """
 131         :param list value: List of remote hosts.
 132         """
 133         self._remote_hosts = value
 134         self._hosts_by_mac = {}
 135         self._hosts_by_ip4 = {}
 136         self._hosts_by_ip6 = {}
 137         for host in self._remote_hosts:
 138             self._hosts_by_mac[host.mac] = host
 139             self._hosts_by_ip4[host.ip4] = host
 140             self._hosts_by_ip6[host.ip6] = host
 141
 142     def host_by_mac(self, mac):
 143         """
 144         :param mac: MAC address to find host by.
 145         :return: Host object assigned to interface.
 146         """
 147         return self._hosts_by_mac[mac]
 148
 149     def host_by_ip4(self, ip):
 150         """
 151         :param ip: IPv4 address to find host by.
 152         :return: Host object assigned to interface.
 153         """
 154         return self._hosts_by_ip4[ip]
 155
 156     def host_by_ip6(self, ip):
 157         """
 158         :param ip: IPv6 address to find host by.
 159         :return: Host object assigned to interface.
 160         """
 161         return self._hosts_by_ip6[ip]
 162
 163     def generate_remote_hosts(self, count=1):
 164         """Generate and add remote hosts for the interface.
 165
 166         :param int count: Number of generated remote hosts.
 167         """
 168         self._remote_hosts = []
 169         self._hosts_by_mac = {}
 170         self._hosts_by_ip4 = {}
 171         self._hosts_by_ip6 = {}
 172         for i in range(
 173                 2, count + 2):  # 0: network address, 1: local vpp address
 174             mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
 175             ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
 176             ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
 177             ip6_ll = mk_ll_addr(mac)
 178             host = Host(mac, ip4, ip6, ip6_ll)
 179             self._remote_hosts.append(host)
 180             self._hosts_by_mac[mac] = host
 181             self._hosts_by_ip4[ip4] = host
 182             self._hosts_by_ip6[ip6] = host
 183
 184     @abstractmethod
 185     def __init__(self, test):
 186         self._test = test
 187
 188         self._remote_hosts = []
 189         self._hosts_by_mac = {}
 190         self._hosts_by_ip4 = {}
 191         self._hosts_by_ip6 = {}
 192
 193     def set_mac(self, mac):
 194         self._local_mac = str(mac)
 195         self._local_ip6_ll = mk_ll_addr(self._local_mac)
 196         self.test.vapi.sw_interface_set_mac_address(
 197             self.sw_if_index, mac.packed)
 198
 199     def set_sw_if_index(self, sw_if_index):
 200         self._sw_if_index = sw_if_index
 201
 202         self.generate_remote_hosts()
 203
 204         self._local_ip4 = "172.16.%u.1" % self.sw_if_index
 205         self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
 206         self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
 207         self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
 208                                                    self._local_ip4_subnet)
 209         self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
 210         self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
 211                                                   self._local_ip4_bcast)
 212         self.local_ip4_prefix_len = 24
 213         self.has_ip4_config = False
 214         self.ip4_table_id = 0
 215
 216         self._local_ip6 = "fd01:%x::1" % self.sw_if_index
 217         self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
 218         self.local_ip6_prefix_len = 64
 219         self.has_ip6_config = False
 220         self.ip6_table_id = 0
 221
 222         self._local_addr = {socket.AF_INET: self.local_ip4,
 223                             socket.AF_INET6: self.local_ip6}
 224         self._local_addr_n = {socket.AF_INET: self.local_ip4n,
 225                               socket.AF_INET6: self.local_ip6n}
 226         self._remote_addr = {socket.AF_INET: self.remote_ip4,
 227                              socket.AF_INET6: self.remote_ip6}
 228         self._remote_addr_n = {socket.AF_INET: self.remote_ip4n,
 229                                socket.AF_INET6: self.remote_ip6n}
 230
 231         r = self.test.vapi.sw_interface_dump()
 232         for intf in r:
 233             if intf.sw_if_index == self.sw_if_index:
 234                 self._name = intf.interface_name.split(b'\0',
 235                                                        1)[0].decode('utf8')
 236                 self._local_mac = mac_ntop(intf.l2_address)
 237                 self._dump = intf
 238                 break
 239         else:
 240             raise Exception(
 241                 "Could not find interface with sw_if_index %d "
 242                 "in interface dump %s" %
 243                 (self.sw_if_index, moves.reprlib.repr(r)))
 244         self._local_ip6_ll = mk_ll_addr(self.local_mac)
 245         self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
 246                                                self.local_ip6_ll)
 247         self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
 248         self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
 249                                                 self.remote_ip6_ll)
 250
 251     def config_ip4(self):
 252         """Configure IPv4 address on the VPP interface."""
 253         self.test.vapi.sw_interface_add_del_address(
 254             self.sw_if_index, self.local_ip4n, self.local_ip4_prefix_len)
 255         self.has_ip4_config = True
 256
 257     def unconfig_ip4(self):
 258         """Remove IPv4 address on the VPP interface."""
 259         try:
 260             if self.has_ip4_config:
 261                 self.test.vapi.sw_interface_add_del_address(
 262                     self.sw_if_index,
 263                     self.local_ip4n,
 264                     self.local_ip4_prefix_len,
 265                     is_add=0)
 266         except AttributeError:
 267             self.has_ip4_config = False
 268         self.has_ip4_config = False
 269
 270     def configure_ipv4_neighbors(self):
 271         """For every remote host assign neighbor's MAC to IPv4 addresses.
 272
 273         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
 274         """
 275         for host in self._remote_hosts:
 276             self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
 277                                                host.mac,
 278                                                host.ip4)
 279
 280     def config_ip6(self):
 281         """Configure IPv6 address on the VPP interface."""
 282         self.test.vapi.sw_interface_add_del_address(
 283             self.sw_if_index, self._local_ip6n, self.local_ip6_prefix_len,
 284             is_ipv6=1)
 285         self.has_ip6_config = True
 286
 287     def unconfig_ip6(self):
 288         """Remove IPv6 address on the VPP interface."""
 289         try:
 290             if self.has_ip6_config:
 291                 self.test.vapi.sw_interface_add_del_address(
 292                     self.sw_if_index,
 293                     self.local_ip6n,
 294                     self.local_ip6_prefix_len,
 295                     is_ipv6=1, is_add=0)
 296         except AttributeError:
 297             self.has_ip6_config = False
 298         self.has_ip6_config = False
 299
 300     def configure_ipv6_neighbors(self):
 301         """For every remote host assign neighbor's MAC to IPv6 addresses.
 302
 303         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
 304         """
 305         for host in self._remote_hosts:
 306             self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
 307                                                host.mac,
 308                                                host.ip6)
 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")
 457
 458     def __str__(self):
 459         return self.name