test framework: Fix wrapper functions to match API message names.
[vpp.git] / test / vpp_interface.py
index e14a31e..b6f3a91 100644 (file)
@@ -1,12 +1,17 @@
-from abc import abstractmethod, ABCMeta
+import binascii
 import socket
+import abc
+
+import six
+from six import moves
 
 from util import Host, mk_ll_addr
+from vpp_papi import mac_ntop
 
 
+@six.add_metaclass(abc.ABCMeta)
 class VppInterface(object):
     """Generic VPP interface."""
-    __metaclass__ = ABCMeta
 
     @property
     def sw_if_index(self):
@@ -23,6 +28,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)."""
@@ -65,7 +86,7 @@ class VppInterface(object):
 
     @property
     def local_ip6_ll(self):
-        """Local IPv6 linnk-local address on VPP interface (string)."""
+        """Local IPv6 link-local address on VPP interface (string)."""
         return self._local_ip6_ll
 
     @property
@@ -161,7 +182,7 @@ class VppInterface(object):
             self._hosts_by_ip4[ip4] = host
             self._hosts_by_ip6[ip6] = host
 
-    @abstractmethod
+    @abc.abstractmethod
     def __init__(self, test):
         self._test = test
 
@@ -170,6 +191,12 @@ 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
 
@@ -193,20 +220,28 @@ 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)
@@ -239,10 +274,9 @@ class VppInterface(object):
         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
         """
         for host in self._remote_hosts:
-            macn = host.mac.replace(":", "").decode('hex')
-            ipn = host.ip4n
-            self.test.vapi.ip_neighbor_add_del(
-                self.sw_if_index, macn, ipn)
+            self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
+                                               host.mac,
+                                               host.ip4)
 
     def config_ip6(self):
         """Configure IPv6 address on the VPP interface."""
@@ -270,10 +304,9 @@ class VppInterface(object):
         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
         """
         for host in self._remote_hosts:
-            macn = host.mac.replace(":", "").decode('hex')
-            ipn = host.ip6n
-            self.test.vapi.ip_neighbor_add_del(
-                self.sw_if_index, macn, ipn, is_ipv6=1)
+            self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
+                                               host.mac,
+                                               host.ip6)
 
     def unconfig(self):
         """Unconfigure IPv6 and IPv4 address on the VPP interface."""
@@ -300,25 +333,29 @@ class VppInterface(object):
 
     def disable_ipv6_ra(self):
         """Configure IPv6 RA suppress on the VPP interface."""
-        self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
+        self.test.vapi.sw_interface_ip6nd_ra_config(
+            sw_if_index=self.sw_if_index,
+            suppress=1)
 
     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)
+        self.test.vapi.sw_interface_ip6nd_ra_config(
+            sw_if_index=self.sw_if_index,
+            is_no=no,
+            suppress=suppress,
+            send_unicast=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)
+        self.test.vapi.sw_interface_ip6nd_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."""
@@ -332,12 +369,12 @@ class VppInterface(object):
 
     def ip6_enable(self):
         """IPv6 Enable interface"""
-        self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
+        self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
                                                        enable=1)
 
     def ip6_disable(self):
         """Put interface ADMIN-DOWN."""
-        self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
+        self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
                                                        enable=0)
 
     def add_sub_if(self, sub_if):
@@ -355,12 +392,12 @@ class VppInterface(object):
 
     def enable_mpls(self):
         """Enable MPLS on the VPP interface."""
-        self.test.vapi.sw_interface_enable_disable_mpls(
+        self.test.vapi.sw_interface_set_mpls_enable(
             self.sw_if_index)
 
     def disable_mpls(self):
         """Enable MPLS on the VPP interface."""
-        self.test.vapi.sw_interface_enable_disable_mpls(
+        self.test.vapi.sw_interface_set_mpls_enable(
             self.sw_if_index, 0)
 
     def is_ip4_entry_in_fib_dump(self, dump):
@@ -394,10 +431,34 @@ class VppInterface(object):
         dump = self.test.vapi.sw_interface_dump()
         return self.is_interface_config_in_dump(dump)
 
-    def is_interface_config_in_dump(self, 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 True
+                return i
         else:
-            return False
+            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