1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
""" abstract vpp object and object registry """
import abc
class VppObject(metaclass=abc.ABCMeta):
"""Abstract vpp object"""
@abc.abstractmethod
def add_vpp_config(self) -> None:
"""Add the configuration for this object to vpp."""
pass
@abc.abstractmethod
def query_vpp_config(self) -> bool:
"""Query the vpp configuration.
:return: True if the object is configured"""
pass
@abc.abstractmethod
def remove_vpp_config(self) -> None:
"""Remove the configuration for this object from vpp."""
pass
def object_id(self) -> str:
"""Return a unique string representing this object."""
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:
"""Class which handles automatic configuration cleanup."""
_shared_state = {}
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: VppObject, logger) -> None:
"""Register an object in the registry."""
if obj.object_id() not in self._object_dict:
self._object_registry.append(obj)
self._object_dict[obj.object_id()] = obj
logger.debug("REG: registering %s" % obj)
else:
logger.debug("REG: duplicate add, ignoring (%s)" % obj)
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) -> None:
"""
Remove configuration (if present) from vpp and then remove all objects
from the registry.
"""
if not self._object_registry:
logger.info("REG: No objects registered for auto-cleanup.")
return
logger.info("REG: Removing VPP configuration for registered objects")
# remove the config in reverse order as there might be dependencies
failed = []
for obj in reversed(self._object_registry):
if obj.query_vpp_config():
logger.info("REG: Removing configuration for %s" % obj)
obj.remove_vpp_config()
if obj.query_vpp_config():
failed.append(obj)
else:
logger.info(
"REG: Skipping removal for %s, configuration not present" % obj
)
self.unregister_all(logger)
if failed:
logger.error("REG: Couldn't remove configuration for object(s):")
for obj in failed:
logger.error(repr(obj))
raise Exception(
"Couldn't remove configuration for object(s): %s"
% (", ".join(str(x) for x in failed))
)
|
