GBP Endpoint Updates

- common types on the API
- endpoints keyed in various ways for DP lookup
- conparison functions for VPP IP address types

Change-Id: If7ec0bbc5cea71fd0983fe78987d147ec1bd7ec8
Signed-off-by: Neale Ranns <neale.ranns@cisco.com>

test/vpp_ip.py

@@ -4,6 +4,7 @@
 """
 
 from ipaddress import ip_address
+from socket import AF_INET, AF_INET6
 
 
 class IpAddressFamily:
@@ -11,34 +12,25 @@ class IpAddressFamily:
     ADDRESS_IP6 = 1
 
 
+class DpoProto:
+    DPO_PROTO_IP4 = 0
+    DPO_PROTO_IP6 = 1
+    DPO_PROTO_MPLS = 2
+    DPO_PROTO_ETHERNET = 3
+    DPO_PROTO_BIER = 4
+    DPO_PROTO_NSH = 5
+
+
 INVALID_INDEX = 0xffffffff
 
 
-def compare_ip_address(api_address, py_address):
-    if 4 is py_address.version:
-        if py_address.packed == api_address.ip4.address:
-            return True
-    else:
-        if py_address.packed == api_address.ip6.address:
-            return True
-    return False
-
-
 class VppIpAddressUnion():
     def __init__(self, addr):
         self.addr = addr
         self.ip_addr = ip_address(unicode(self.addr))
 
-    @property
-    def version(self):
-        return self.ip_addr.version
-
-    @property
-    def address(self):
-        return self.addr
-
     def encode(self):
-        if self.ip_addr.version is 6:
+        if self.version is 6:
             return {
                 'ip6': {
                     'address': self.ip_addr.packed
@@ -51,6 +43,41 @@ class VppIpAddressUnion():
                 },
             }
 
+    @property
+    def version(self):
+        return self.ip_addr.version
+
+    @property
+    def address(self):
+        return self.addr
+
+    @property
+    def length(self):
+        if self.version is 6:
+            return 128
+        else:
+            return 32
+
+    @property
+    def bytes(self):
+        return self.ip_addr.packed
+
+    def __eq__(self, other):
+        if isinstance(other, self.__class__):
+            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
+            else:
+                return self.ip_addr.packed == other.ip6.address
+        else:
+            raise Exception("Comparing VppIpAddresUnions:%s"
+                            " with unknown type: %s" %
+                            (self, other))
+
+        return False
+
 
 class VppIpAddress():
     def __init__(self, addr):
@@ -68,10 +95,62 @@ class VppIpAddress():
                 'un': self.addr.encode()
             }
 
+    def __eq__(self, other):
+        if isinstance(other, self.__class__):
+            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 \
+                    other.un == self.addr
+            else:
+                return other.af == IpAddressFamily.ADDRESS_IP6 and \
+                    other.un == self.addr
+        else:
+            raise Exception("Comparing VppIpAddress:%s with unknown type: %s" %
+                            (self, other))
+        return False
+
+    def __ne__(self, other):
+        return not (self == other)
+
+    def __str__(self):
+        return self.address
+
+    @property
+    def bytes(self):
+        return self.addr.bytes
+
     @property
     def address(self):
         return self.addr.address
 
+    @property
+    def length(self):
+        return self.addr.length
+
+    @property
+    def version(self):
+        return self.addr.version
+
+    @property
+    def is_ip6(self):
+        return (self.version == 6)
+
+    @property
+    def af(self):
+        if self.version == 6:
+            return AF_INET6
+        else:
+            return AF_INET
+
+    @property
+    def dpo_proto(self):
+        if self.version is 6:
+            return DpoProto.DPO_PROTO_IP6
+        else:
+            return DpoProto.DPO_PROTO_IP4
+
 
 class VppIpPrefix():
     def __init__(self, addr, len):
@@ -91,6 +170,25 @@ class VppIpPrefix():
     def address(self):
         return self.addr.address
 
+    @property
+    def length(self):
+        return self.len
+
+    def __str__(self):
+        return "%s/%d" % (self.address, self.length)
+
+    def __eq__(self, other):
+        if isinstance(other, self.__class__):
+            return (self.len == other.len and self.addr == other.addr)
+        elif hasattr(other, "address") and hasattr(other, "address_length"):
+            # vl_api_prefix_t
+            return self.len == other.address_length and \
+                self.addr == other.address
+        else:
+            raise Exception("Comparing VppIpPrefix:%s with unknown type: %s" %
+                            (self, other))
+        return False
+
 
 class VppIpMPrefix():
     def __init__(self, saddr, gaddr, len):