PAPI: Add MACAddress object wrapper for vl_api_mac_address_t
[vpp.git] / test / vpp_interface.py
index ee4a9ef..719f77b 100644 (file)
@@ -1,7 +1,11 @@
-from abc import abstractmethod, ABCMeta
+import binascii
 import socket
+from abc import abstractmethod, ABCMeta
+
+from six import moves
 
-from util import Host
+from util import Host, mk_ll_addr
+from vpp_papi import mac_pton, mac_ntop
 
 
 class VppInterface(object):
@@ -23,6 +27,22 @@ class VppInterface(object):
         """MAC-address of the VPP interface."""
         return self._local_mac
 
+    @property
+    def local_addr(self):
+        return self._local_addr
+
+    @property
+    def remote_addr(self):
+        return self._remote_addr
+
+    @property
+    def local_addr_n(self):
+        return self._local_addr_n
+
+    @property
+    def remote_addr_n(self):
+        return self._remote_addr_n
+
     @property
     def local_ip4(self):
         """Local IPv4 address on VPP interface (string)."""
@@ -63,6 +83,28 @@ class VppInterface(object):
         """IPv6 address of remote peer - raw, suitable as API parameter"""
         return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
 
+    @property
+    def local_ip6_ll(self):
+        """Local IPv6 link-local address on VPP interface (string)."""
+        return self._local_ip6_ll
+
+    @property
+    def local_ip6n_ll(self):
+        """Local IPv6 link-local address - raw, suitable as API parameter."""
+        return self._local_ip6n_ll
+
+    @property
+    def remote_ip6_ll(self):
+        """Link-local IPv6 address of remote peer
+        "connected" to this interface."""
+        return self._remote_ip6_ll
+
+    @property
+    def remote_ip6n_ll(self):
+        """Link-local IPv6 address of remote peer
+        - raw, suitable as API parameter"""
+        return self._remote_ip6n_ll
+
     @property
     def name(self):
         """Name of the interface."""
@@ -132,7 +174,8 @@ class VppInterface(object):
             mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
             ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
             ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
-            host = Host(mac, ip4, ip6)
+            ip6_ll = mk_ll_addr(mac)
+            host = Host(mac, ip4, ip6, ip6_ll)
             self._remote_hosts.append(host)
             self._hosts_by_mac[mac] = host
             self._hosts_by_ip4[ip4] = host
@@ -147,10 +190,25 @@ class VppInterface(object):
         self._hosts_by_ip4 = {}
         self._hosts_by_ip6 = {}
 
+    def set_mac(self, mac):
+        self._local_mac = str(mac)
+        self._local_ip6_ll = mk_ll_addr(self._local_mac)
+        self.test.vapi.sw_interface_set_mac_address(
+            self.sw_if_index, mac.packed)
+
+    def set_sw_if_index(self, sw_if_index):
+        self._sw_if_index = sw_if_index
+
         self.generate_remote_hosts()
 
         self._local_ip4 = "172.16.%u.1" % self.sw_if_index
         self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
+        self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
+        self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
+                                                   self._local_ip4_subnet)
+        self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
+        self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
+                                                  self._local_ip4_bcast)
         self.local_ip4_prefix_len = 24
         self.has_ip4_config = False
         self.ip4_table_id = 0
@@ -161,20 +219,34 @@ class VppInterface(object):
         self.has_ip6_config = False
         self.ip6_table_id = 0
 
+        self._local_addr = {socket.AF_INET: self.local_ip4,
+                            socket.AF_INET6: self.local_ip6}
+        self._local_addr_n = {socket.AF_INET: self.local_ip4n,
+                              socket.AF_INET6: self.local_ip6n}
+        self._remote_addr = {socket.AF_INET: self.remote_ip4,
+                             socket.AF_INET6: self.remote_ip6}
+        self._remote_addr_n = {socket.AF_INET: self.remote_ip4n,
+                               socket.AF_INET6: self.remote_ip6n}
+
         r = self.test.vapi.sw_interface_dump()
         for intf in r:
             if intf.sw_if_index == self.sw_if_index:
-                self._name = intf.interface_name.split(b'\0', 1)[0]
-                self._local_mac = \
-                    ':'.join(intf.l2_address.encode('hex')[i:i + 2]
-                             for i in range(0, 12, 2))
+                self._name = intf.interface_name.split(b'\0',
+                                                       1)[0].decode('utf8')
+                self._local_mac = mac_ntop(intf.l2_address)
                 self._dump = intf
                 break
         else:
             raise Exception(
                 "Could not find interface with sw_if_index %d "
                 "in interface dump %s" %
-                (self.sw_if_index, repr(r)))
+                (self.sw_if_index, moves.reprlib.repr(r)))
+        self._local_ip6_ll = mk_ll_addr(self.local_mac)
+        self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
+                                               self.local_ip6_ll)
+        self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
+        self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
+                                                self.remote_ip6_ll)
 
     def config_ip4(self):
         """Configure IPv4 address on the VPP interface."""
@@ -195,16 +267,16 @@ class VppInterface(object):
             self.has_ip4_config = False
         self.has_ip4_config = False
 
-    def configure_ipv4_neighbors(self, vrf_id=0):
+    def configure_ipv4_neighbors(self):
         """For every remote host assign neighbor's MAC to IPv4 addresses.
 
         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
         """
         for host in self._remote_hosts:
-            macn = host.mac.replace(":", "").decode('hex')
+            macn = mac_pton(host.mac)
             ipn = host.ip4n
             self.test.vapi.ip_neighbor_add_del(
-                self.sw_if_index, macn, ipn, vrf_id)
+                self.sw_if_index, macn, ipn)
 
     def config_ip6(self):
         """Configure IPv6 address on the VPP interface."""
@@ -227,11 +299,15 @@ class VppInterface(object):
         self.has_ip6_config = False
 
     def configure_ipv6_neighbors(self):
-        """For every remote host assign neighbor's MAC to IPv6 address."""
+        """For every remote host assign neighbor's MAC to IPv6 addresses.
+
+        :param vrf_id: The FIB table / VRF ID. (Default value = 0)
+        """
         for host in self._remote_hosts:
-            macn = host.mac.replace(":", "").decode('hex')
+            macn = mac_pton(host.mac)
+            ipn = host.ip6n
             self.test.vapi.ip_neighbor_add_del(
-                self.sw_if_index, macn, host.ip6n, is_ipv6=1)
+                self.sw_if_index, macn, ipn, is_ipv6=1)
 
     def unconfig(self):
         """Unconfigure IPv6 and IPv4 address on the VPP interface."""
@@ -260,12 +336,24 @@ class VppInterface(object):
         """Configure IPv6 RA suppress on the VPP interface."""
         self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
 
-    def ip6_ra_config(self, suppress=0, send_unicast=0):
+    def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
         """Configure IPv6 RA suppress on the VPP interface."""
         self.test.vapi.ip6_sw_interface_ra_config(self.sw_if_index,
+                                                  no,
                                                   suppress,
                                                   send_unicast)
 
+    def ip6_ra_prefix(self, address, address_length, is_no=0,
+                      off_link=0, no_autoconfig=0, use_default=0):
+        """Configure IPv6 RA suppress on the VPP interface."""
+        self.test.vapi.ip6_sw_interface_ra_prefix(self.sw_if_index,
+                                                  address,
+                                                  address_length,
+                                                  is_no=is_no,
+                                                  off_link=off_link,
+                                                  no_autoconfig=no_autoconfig,
+                                                  use_default=use_default)
+
     def admin_up(self):
         """Put interface ADMIN-UP."""
         self.test.vapi.sw_interface_set_flags(self.sw_if_index,
@@ -304,6 +392,11 @@ class VppInterface(object):
         self.test.vapi.sw_interface_enable_disable_mpls(
             self.sw_if_index)
 
+    def disable_mpls(self):
+        """Enable MPLS on the VPP interface."""
+        self.test.vapi.sw_interface_enable_disable_mpls(
+            self.sw_if_index, 0)
+
     def is_ip4_entry_in_fib_dump(self, dump):
         for i in dump:
             if i.address == self.local_ip4n and \
@@ -311,3 +404,58 @@ class VppInterface(object):
                i.table_id == self.ip4_table_id:
                 return True
         return False
+
+    def set_unnumbered(self, ip_sw_if_index):
+        """ Set the interface to unnumbered via ip_sw_if_index """
+        self.test.vapi.sw_interface_set_unnumbered(
+            self.sw_if_index,
+            ip_sw_if_index)
+
+    def unset_unnumbered(self, ip_sw_if_index):
+        """ Unset the interface to unnumbered via ip_sw_if_index """
+        self.test.vapi.sw_interface_set_unnumbered(
+            self.sw_if_index,
+            ip_sw_if_index,
+            is_add=0)
+
+    def set_proxy_arp(self, enable=1):
+        """ Set the interface to enable/disable Proxy ARP """
+        self.test.vapi.proxy_arp_intfc_enable_disable(
+            self.sw_if_index,
+            enable)
+
+    def query_vpp_config(self):
+        dump = self.test.vapi.sw_interface_dump()
+        return self.is_interface_config_in_dump(dump)
+
+    def get_interface_config_from_dump(self, dump):
+        for i in dump:
+            if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
+               i.sw_if_index == self.sw_if_index:
+                return i
+        else:
+            return None
+
+    def is_interface_config_in_dump(self, dump):
+        return self.get_interface_config_from_dump(dump) is not None
+
+    def assert_interface_state(self, admin_up_down, link_up_down,
+                               expect_event=False):
+        if expect_event:
+            event = self.test.vapi.wait_for_event(timeout=1,
+                                                  name='sw_interface_event')
+            self.test.assert_equal(event.sw_if_index, self.sw_if_index,
+                                   "sw_if_index")
+            self.test.assert_equal(event.admin_up_down, admin_up_down,
+                                   "admin state")
+            self.test.assert_equal(event.link_up_down, link_up_down,
+                                   "link state")
+        dump = self.test.vapi.sw_interface_dump()
+        if_state = self.get_interface_config_from_dump(dump)
+        self.test.assert_equal(if_state.admin_up_down, admin_up_down,
+                               "admin state")
+        self.test.assert_equal(if_state.link_up_down, link_up_down,
+                               "link state")
+
+    def __str__(self):
+        return self.name