1 """ abstract vpp object and object registry """
3 from abc import ABCMeta, abstractmethod
6 class VppObject(object):
7 """ Abstract vpp object """
8 __metaclass__ = ABCMeta
11 def add_vpp_config(self):
12 """ Add the configuration for this object to vpp. """
16 def query_vpp_config(self):
17 """Query the vpp configuration.
19 :return: True if the object is configured"""
23 def remove_vpp_config(self):
24 """ Remove the configuration for this object from vpp. """
29 """ Return a unique string representing this object. """
33 class VppObjectRegistry(object):
34 """ Class which handles automatic configuration cleanup. """
38 self.__dict__ = self._shared_state
39 if not hasattr(self, "_object_registry"):
40 self._object_registry = []
41 if not hasattr(self, "_object_dict"):
42 self._object_dict = dict()
44 def register(self, obj, logger):
45 """ Register an object in the registry. """
46 if obj.object_id() not in self._object_dict:
47 self._object_registry.append(obj)
48 self._object_dict[obj.object_id()] = obj
49 logger.debug("REG: registering %s" % obj)
51 logger.debug("REG: duplicate add, ignoring (%s)" % obj)
53 def remove_vpp_config(self, logger):
55 Remove configuration (if present) from vpp and then remove all objects
58 if not self._object_registry:
59 logger.info("REG: No objects registered for auto-cleanup.")
61 logger.info("REG: Removing VPP configuration for registered objects")
62 # remove the config in reverse order as there might be dependencies
63 for obj in reversed(self._object_registry):
64 if obj.query_vpp_config():
65 logger.info("REG: Removing configuration for %s" % obj)
66 obj.remove_vpp_config()
69 "REG: Skipping removal for %s, configuration not present" %
72 for obj in self._object_registry:
73 if obj.query_vpp_config():
75 self._object_registry = []
76 self._object_dict = dict()
78 logger.error("REG: Couldn't remove configuration for object(s):")
80 logger.error(repr(obj))
81 raise Exception("Couldn't remove configuration for object(s): %s" %
82 (", ".join(str(x) for x in failed)))