VOM: mroutes
[vpp.git] / test / vpp_ip.py
index e44e6b5..fe985fb 100644 (file)
@@ -2,14 +2,13 @@
   IP Types
 
 """
+import logging
 
 from ipaddress import ip_address
 from socket import AF_INET, AF_INET6
+from vpp_papi import VppEnum
 
-
-class IpAddressFamily:
-    ADDRESS_IP4 = 0
-    ADDRESS_IP6 = 1
+_log = logging.getLogger(__name__)
 
 
 class DpoProto:
@@ -30,18 +29,10 @@ class VppIpAddressUnion():
         self.ip_addr = ip_address(unicode(self.addr))
 
     def encode(self):
-        if self.version is 6:
-            return {
-                'ip6': {
-                    'address': self.ip_addr.packed
-                },
-            }
+        if self.version == 6:
+            return {'ip6': self.ip_addr.packed}
         else:
-            return {
-                'ip4': {
-                    'address': self.ip_addr.packed
-                },
-            }
+            return {'ip4': self.ip_addr.packed}
 
     @property
     def version(self):
@@ -53,10 +44,7 @@ class VppIpAddressUnion():
 
     @property
     def length(self):
-        if self.version is 6:
-            return 128
-        else:
-            return 32
+        return self.ip_addr.max_prefixlen
 
     @property
     def bytes(self):
@@ -67,16 +55,15 @@ class VppIpAddressUnion():
             return self.ip_addr == other.ip_addr
         elif hasattr(other, "ip4") and hasattr(other, "ip6"):
             # vl_api_address_union_t
-            if 4 is self.version:
-                return self.ip_addr.packed == other.ip4.address
+            if 4 == self.version:
+                return self.ip_addr.packed == other.ip4
             else:
-                return self.ip_addr.packed == other.ip6.address
+                return self.ip_addr.packed == other.ip6
         else:
-            raise Exception("Comparing VppIpAddresUnions:%s"
-                            " with unknown type: %s" %
-                            (self, other))
-
-        return False
+            _log.error("Comparing VppIpAddressUnions:%s"
+                       " with incomparable type: %s",
+                       self, other)
+            return NotImplemented
 
 
 class VppIpAddress():
@@ -84,14 +71,14 @@ class VppIpAddress():
         self.addr = VppIpAddressUnion(addr)
 
     def encode(self):
-        if self.addr.version is 6:
+        if self.addr.version == 6:
             return {
-                'af': IpAddressFamily.ADDRESS_IP6,
+                'af': VppEnum.vl_api_address_family_t.ADDRESS_IP6,
                 'un': self.addr.encode()
             }
         else:
             return {
-                'af': IpAddressFamily.ADDRESS_IP4,
+                'af': VppEnum.vl_api_address_family_t.ADDRESS_IP4,
                 'un': self.addr.encode()
             }
 
@@ -100,16 +87,21 @@ class VppIpAddress():
             return self.addr == other.addr
         elif hasattr(other, "af") and hasattr(other, "un"):
             # a vp_api_address_t
-            if 4 is self.version:
-                return other.af == IpAddressFamily.ADDRESS_IP4 and \
+            if 4 == self.version:
+                return other.af == \
+                    VppEnum.vl_api_address_family_t.ADDRESS_IP4 and \
                     other.un == self.addr
             else:
-                return other.af == IpAddressFamily.ADDRESS_IP6 and \
+                return other.af == \
+                    VppEnum.vl_api_address_family_t.ADDRESS_IP6 and \
                     other.un == self.addr
         else:
-            raise Exception("Comparing VppIpAddress:%s with unknown type: %s" %
-                            (self, other))
-        return False
+            _log.error(
+                "Comparing VppIpAddress:<%s> %s with incomparable "
+                "type: <%s> %s",
+                self.__class__.__name__, self,
+                other.__class__.__name__, other)
+            return NotImplemented
 
     def __ne__(self, other):
         return not (self == other)
@@ -146,7 +138,7 @@ class VppIpAddress():
 
     @property
     def dpo_proto(self):
-        if self.version is 6:
+        if self.version == 6:
             return DpoProto.DPO_PROTO_IP6
         else:
             return DpoProto.DPO_PROTO_IP4
@@ -157,11 +149,6 @@ class VppIpPrefix():
         self.addr = VppIpAddress(addr)
         self.len = len
 
-    def __eq__(self, other):
-        if self.addr == other.addr and self.len == other.len:
-            return True
-        return False
-
     def encode(self):
         return {'address': self.addr.encode(),
                 'address_length': self.len}
@@ -170,10 +157,18 @@ class VppIpPrefix():
     def address(self):
         return self.addr.address
 
+    @property
+    def bytes(self):
+        return self.addr.bytes
+
     @property
     def length(self):
         return self.len
 
+    @property
+    def is_ip6(self):
+        return self.addr.is_ip6
+
     def __str__(self):
         return "%s/%d" % (self.address, self.length)
 
@@ -183,11 +178,12 @@ class VppIpPrefix():
         elif hasattr(other, "address") and hasattr(other, "address_length"):
             # vl_api_prefix_t
             return self.len == other.address_length and \
-                self.addr == other.address
+                   self.addr == other.address
         else:
-            raise Exception("Comparing VppIpPrefix:%s with unknown type: %s" %
-                            (self, other))
-        return False
+            _log.error(
+                "Comparing VppIpPrefix:%s with incomparable type: %s" %
+                (self, other))
+            return NotImplemented
 
 
 class VppIpMPrefix():
@@ -197,37 +193,23 @@ class VppIpMPrefix():
         self.len = len
         self.ip_saddr = ip_address(unicode(self.saddr))
         self.ip_gaddr = ip_address(unicode(self.gaddr))
+        if self.ip_saddr.version != self.ip_gaddr.version:
+            raise ValueError('Source and group addresses must be of the '
+                             'same address family.')
 
     def encode(self):
-
-        if 6 is self.ip_saddr.version:
+        if 6 == self.ip_saddr.version:
             prefix = {
-                'af': IpAddressFamily.ADDRESS_IP6,
-                'grp_address': {
-                    'ip6': {
-                        'address': self.ip_gaddr.packed
-                    },
-                },
-                'src_address': {
-                    'ip6': {
-                        'address': self.ip_saddr.packed
-                    },
-                },
+                'af': VppEnum.vl_api_address_family_t.ADDRESS_IP6,
+                'grp_address': {'ip6': self.ip_gaddr.packed},
+                'src_address': {'ip6': self.ip_saddr.packed},
                 'grp_address_length': self.len,
             }
         else:
             prefix = {
-                'af': IpAddressFamily.ADDRESS_IP4,
-                'grp_address': {
-                    'ip4': {
-                        'address': self.ip_gaddr.packed
-                    },
-                },
-                'src_address': {
-                    'ip4': {
-                        'address': self.ip_saddr.packed
-                    },
-                },
+                'af': VppEnum.vl_api_address_family_t.ADDRESS_IP4,
+                'grp_address': {'ip4': self.ip_gaddr.packed},
+                'src_address': {'ip4': self.ip_saddr.packed},
                 'grp_address_length': self.len,
             }
         return prefix