d9b0c6fbf7
Drop pycodestyle for code style checking in favor of black. Black is much faster, stable PEP8 compliant code style checker offering also automatic formatting. It aims to be very stable and produce smallest diffs. It's used by many small and big projects. Running checkstyle with black takes a few seconds with a terse output. Thus, test-checkstyle-diff is no longer necessary. Expand scope of checkstyle to all python files in the repo, replacing test-checkstyle with checkstyle-python. Also, fixstyle-python is now available for automatic style formatting. Note: python virtualenv has been consolidated in test/Makefile, test/requirements*.txt which will eventually be moved to a central location. This is required to simply the automated generation of docker executor images in the CI. Type: improvement Change-Id: I022a326603485f58585e879ac0f697fceefbc9c8 Signed-off-by: Klement Sekera <klement.sekera@gmail.com> Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
108 lines
3.5 KiB
Python
108 lines
3.5 KiB
Python
""" 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))
|
|
)
|