API: Cleanup APIs interface.api
[vpp.git] / test / vpp_interface.py
index c7918fc..4c4e413 100644 (file)
@@ -1,12 +1,18 @@
-from abc import abstractmethod, ABCMeta
+import binascii
 import socket
+import abc
 
-from util import Host, mk_ll_addr, mactobinary
+import six
+from six import moves
 
+from util import Host, mk_ll_addr
+from vpp_papi import mac_ntop, VppEnum
+from vpp_ip import VppIpAddress, VppIpPrefix
 
+
+@six.add_metaclass(abc.ABCMeta)
 class VppInterface(object):
     """Generic VPP interface."""
-    __metaclass__ = ABCMeta
 
     @property
     def sw_if_index(self):
@@ -32,22 +38,25 @@ class VppInterface(object):
         return self._remote_addr
 
     @property
-    def local_addr_n(self):
-        return self._local_addr_n
+    def local_ip4(self):
+        """Local IPv4 address on VPP interface (string)."""
+        return self._local_ip4.address
 
     @property
-    def remote_addr_n(self):
-        return self._remote_addr_n
+    def local_ip4_prefix_len(self):
+        """Local IPv4 prefix length """
+        return self._local_ip4.len
 
     @property
-    def local_ip4(self):
-        """Local IPv4 address on VPP interface (string)."""
+    def local_ip4_prefix(self):
+        """Local IPv4 prefix """
         return self._local_ip4
 
     @property
     def local_ip4n(self):
+        """DEPRECATED """
         """Local IPv4 address - raw, suitable as API parameter."""
-        return socket.inet_pton(socket.AF_INET, self._local_ip4)
+        return socket.inet_pton(socket.AF_INET, self._local_ip4.address)
 
     @property
     def remote_ip4(self):
@@ -56,18 +65,30 @@ class VppInterface(object):
 
     @property
     def remote_ip4n(self):
-        """IPv4 address of remote peer - raw, suitable as API parameter."""
-        return socket.inet_pton(socket.AF_INET, self.remote_ip4)
+        """DEPRECATED """
+        """Local IPv6 address - raw, suitable as API parameter."""
+        return socket.inet_pton(socket.AF_INET, self._remote_hosts[0].ip4)
 
     @property
     def local_ip6(self):
         """Local IPv6 address on VPP interface (string)."""
+        return self._local_ip6.address
+
+    @property
+    def local_ip6_prefix_len(self):
+        """Local IPv6 prefix length """
+        return self._local_ip6.len
+
+    @property
+    def local_ip6_prefix(self):
+        """Local IPv6 prefix """
         return self._local_ip6
 
     @property
     def local_ip6n(self):
+        """DEPRECATED """
         """Local IPv6 address - raw, suitable as API parameter."""
-        return socket.inet_pton(socket.AF_INET6, self.local_ip6)
+        return socket.inet_pton(socket.AF_INET6, self._local_ip6.address)
 
     @property
     def remote_ip6(self):
@@ -76,18 +97,20 @@ class VppInterface(object):
 
     @property
     def remote_ip6n(self):
-        """IPv6 address of remote peer - raw, suitable as API parameter"""
-        return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
+        """DEPRECATED """
+        """Local IPv6 address - raw, suitable as API parameter."""
+        return socket.inet_pton(socket.AF_INET6, self._remote_hosts[0].ip6)
 
     @property
     def local_ip6_ll(self):
         """Local IPv6 link-local address on VPP interface (string)."""
-        return self._local_ip6_ll
+        return self._local_ip6_ll.address
 
     @property
     def local_ip6n_ll(self):
-        """Local IPv6 link-local address - raw, suitable as API parameter."""
-        return self._local_ip6n_ll
+        """DEPRECATED """
+        """Local IPv6 link-local address on VPP interface (string)."""
+        return socket.inet_pton(socket.AF_INET6, self._local_ip6_ll.address)
 
     @property
     def remote_ip6_ll(self):
@@ -97,9 +120,9 @@ class VppInterface(object):
 
     @property
     def remote_ip6n_ll(self):
-        """Link-local IPv6 address of remote peer
-        - raw, suitable as API parameter"""
-        return self._remote_ip6n_ll
+        """DEPRECATED """
+        """Local IPv6 link-local address on VPP interface (string)."""
+        return socket.inet_pton(socket.AF_INET6, self._remote_ip6_ll)
 
     @property
     def name(self):
@@ -177,7 +200,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
 
@@ -187,69 +210,51 @@ class VppInterface(object):
         self._hosts_by_ip6 = {}
 
     def set_mac(self, mac):
-        self._local_mac = mac
-        self._local_ip6_ll = mk_ll_addr(mac)
+        self._local_mac = str(mac)
+        self._local_ip6_ll = VppIpAddress(mk_ll_addr(self._local_mac))
         self.test.vapi.sw_interface_set_mac_address(
-            self.sw_if_index,
-            mactobinary(self._local_mac))
+            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 = VppIpPrefix("172.16.%u.1" % self.sw_if_index, 24)
         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
 
-        self._local_ip6 = "fd01:%x::1" % self.sw_if_index
-        self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
-        self.local_ip6_prefix_len = 64
+        self._local_ip6 = VppIpPrefix("fd01:%x::1" % self.sw_if_index, 64)
         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 = bytes(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._local_ip6_ll = mk_ll_addr(self.local_mac)
-        self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
-                                               self.local_ip6_ll)
+                (self.sw_if_index, moves.reprlib.repr(r)))
+        self._local_ip6_ll = VppIpAddress(mk_ll_addr(self.local_mac))
         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."""
         self.test.vapi.sw_interface_add_del_address(
-            self.sw_if_index, self.local_ip4n, self.local_ip4_prefix_len)
+            sw_if_index=self.sw_if_index, prefix=self._local_ip4.encode())
         self.has_ip4_config = True
 
     def unconfig_ip4(self):
@@ -257,10 +262,8 @@ class VppInterface(object):
         try:
             if self.has_ip4_config:
                 self.test.vapi.sw_interface_add_del_address(
-                    self.sw_if_index,
-                    self.local_ip4n,
-                    self.local_ip4_prefix_len,
-                    is_add=0)
+                    sw_if_index=self.sw_if_index,
+                    prefix=self._local_ip4.encode(), is_add=0)
         except AttributeError:
             self.has_ip4_config = False
         self.has_ip4_config = False
@@ -271,16 +274,14 @@ 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."""
         self.test.vapi.sw_interface_add_del_address(
-            self.sw_if_index, self._local_ip6n, self.local_ip6_prefix_len,
-            is_ipv6=1)
+            sw_if_index=self.sw_if_index, prefix=self._local_ip6.encode())
         self.has_ip6_config = True
 
     def unconfig_ip6(self):
@@ -288,10 +289,8 @@ class VppInterface(object):
         try:
             if self.has_ip6_config:
                 self.test.vapi.sw_interface_add_del_address(
-                    self.sw_if_index,
-                    self.local_ip6n,
-                    self.local_ip6_prefix_len,
-                    is_ipv6=1, is_add=0)
+                    sw_if_index=self.sw_if_index,
+                    prefix=self._local_ip6.encode(), is_add=0)
         except AttributeError:
             self.has_ip6_config = False
         self.has_ip6_config = False
@@ -302,10 +301,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."""
@@ -332,44 +330,57 @@ 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)
 
+    # TODO: This should accept ipaddress object.
     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(
+            sw_if_index=self.sw_if_index,
+            prefix={'address': address,
+                    'address_length': address_length},
+            use_default=use_default,
+            off_link=off_link, no_autoconfig=no_autoconfig,
+            is_no=is_no)
 
     def admin_up(self):
         """Put interface ADMIN-UP."""
-        self.test.vapi.sw_interface_set_flags(self.sw_if_index,
-                                              admin_up_down=1)
+        self.test.vapi.sw_interface_set_flags(
+            self.sw_if_index,
+            flags=VppEnum.vl_api_if_status_flags_t.IF_STATUS_API_FLAG_ADMIN_UP)
 
     def admin_down(self):
         """Put interface ADMIN-down."""
         self.test.vapi.sw_interface_set_flags(self.sw_if_index,
-                                              admin_up_down=0)
+                                              flags=0)
+
+    def link_up(self):
+        """Put interface link-state-UP."""
+        self.test.vapi.cli("test interface link-state %s up" % self.name)
+
+    def link_down(self):
+        """Put interface link-state-down."""
+        self.test.vapi.cli("test interface link-state %s down" % self.name)
 
     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):
@@ -387,34 +398,29 @@ class VppInterface(object):
 
     def enable_mpls(self):
         """Enable MPLS on the VPP interface."""
-        self.test.vapi.sw_interface_enable_disable_mpls(
-            self.sw_if_index)
+        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.sw_if_index, 0)
+        self.test.vapi.sw_interface_set_mpls_enable(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 \
-               i.address_length == self.local_ip4_prefix_len and \
-               i.table_id == self.ip4_table_id:
+                    i.address_length == self.local_ip4_prefix_len and \
+                    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)
+        self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
+                                                   self.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)
+        self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
+                                                   self.sw_if_index, is_add=0)
 
     def set_proxy_arp(self, enable=1):
         """ Set the interface to enable/disable Proxy ARP """
@@ -429,7 +435,7 @@ class VppInterface(object):
     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:
+                    i.sw_if_index == self.sw_if_index:
                 return i
         else:
             return None
@@ -444,13 +450,16 @@ class VppInterface(object):
                                                   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,
+            self.test.assert_equal((event.flags & 1), admin_up_down,
                                    "admin state")
-            self.test.assert_equal(event.link_up_down, link_up_down,
+            self.test.assert_equal((event.flags & 2), 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,
+        self.test.assert_equal((if_state.flags & 1), admin_up_down,
                                "admin state")
-        self.test.assert_equal(if_state.link_up_down, link_up_down,
+        self.test.assert_equal((if_state.flags & 2), link_up_down,
                                "link state")
+
+    def __str__(self):
+        return self.name