ip: Router ID included in flow hash
[vpp.git] / test / vpp_object.py
index 1b0fada..8dd2afa 100644 (file)
@@ -1,49 +1,65 @@
 """ abstract vpp object and object registry """
 
-from abc import ABCMeta, abstractmethod
+import abc
 
-from six import moves
 
-
-class VppObject(object):
+class VppObject(metaclass=abc.ABCMeta):
     """ Abstract vpp object """
-    __metaclass__ = ABCMeta
 
-    @abstractmethod
-    def add_vpp_config(self):
+    @abc.abstractmethod
+    def add_vpp_config(self) -> None:
         """ Add the configuration for this object to vpp. """
         pass
 
-    @abstractmethod
-    def query_vpp_config(self):
+    @abc.abstractmethod
+    def query_vpp_config(self) -> bool:
         """Query the vpp configuration.
 
         :return: True if the object is configured"""
         pass
 
-    @abstractmethod
-    def remove_vpp_config(self):
+    @abc.abstractmethod
+    def remove_vpp_config(self) -> None:
         """ Remove the configuration for this object from vpp. """
         pass
 
-    @abstractmethod
-    def object_id(self):
+    def object_id(self) -> str:
         """ Return a unique string representing this object. """
-        pass
+        return "Undefined. for <%s %s>" % (self.__class__.__name__, id(self))
+
+    def __str__(self) -> str:
+        return self.object_id()
+
+    def __repr__(self) -> str:
+        return '<%s>' % self.object_id()
+
+    def __hash__(self) -> int:
+        return hash(self.object_id())
+
+    def __eq__(self, other) -> bool:
+        if not isinstance(other, self.__class__):
+            return NotImplemented
+        if other.object_id() == self.object_id():
+            return True
+        return False
+
+    # This can be removed when python2 support is dropped.
+    def __ne__(self, other):
+        return not self.__eq__(other)
 
 
-class VppObjectRegistry(object):
+class VppObjectRegistry:
     """ Class which handles automatic configuration cleanup. """
     _shared_state = {}
 
-    def __init__(self):
+    def __init__(self) -> None:
         self.__dict__ = self._shared_state
         if not hasattr(self, "_object_registry"):
             self._object_registry = []
         if not hasattr(self, "_object_dict"):
             self._object_dict = dict()
 
-    def register(self, obj, logger):
+    def register(self, obj: VppObject, logger) -> None:
         """ Register an object in the registry. """
         if obj.object_id() not in self._object_dict:
             self._object_registry.append(obj)
@@ -52,13 +68,13 @@ class VppObjectRegistry(object):
         else:
             logger.debug("REG: duplicate add, ignoring (%s)" % obj)
 
-    def unregister_all(self, logger):
+    def unregister_all(self, logger) -> None:
         """ Remove all object registrations from registry. """
         logger.debug("REG: removing all object registrations")
         self._object_registry = []
         self._object_dict = dict()
 
-    def remove_vpp_config(self, logger):
+    def remove_vpp_config(self, logger) -> None:
         """
         Remove configuration (if present) from vpp and then remove all objects
         from the registry.
@@ -83,6 +99,6 @@ class VppObjectRegistry(object):
         if failed:
             logger.error("REG: Couldn't remove configuration for object(s):")
             for obj in failed:
-                logger.error(moves.reprlib.repr(obj))
+                logger.error(repr(obj))
             raise Exception("Couldn't remove configuration for object(s): %s" %
                             (", ".join(str(x) for x in failed)))