ControllerBase

class mtf.network_port.controllers_base.ControllerBase

Base class for controllers that need to be cleaned up. It is designed to support managing the automatic cleanup of controller instances. • All controllers that need to be cleaned up should

inherit from this base class.

• The controllers that are added in the list of controllers will be automatically cleaned up when

the cleanup_controllers() method is called. • The list of controllers will not be cleaned throughout the entire test series or other scenarios where cleanup is needed. • Any new controller class should inherit from the ControllerBase class to ensure automatic cleanup. • Any new controller class that inherit from the ControllerBase should not override __new__() method to be sure that any new instance is added to the controllers list.

Attributes:

_controller_base_instances (list): A list to keep track of controllers instances that should be cleaned up.

static __new__(cls, *args, **kwargs)

Initializes a new instance of the ControllerBase.

The instance will be automatically added to the list of controllers to be cleaned up later. It guarantees that all the controller instances are followed up and cleaned up when the associate method ‘controllers_cleanup(cls)’ is called.

Note:

Do not override this method in subclasses to maintain this functionality.

Args:

*args: Suitable arguments passed to the constructor of the ControllerBase class. **kwargs: keywords passed to the constructor of the ControllerBase class.

Returns:

instance(ControllerBase): The new instance of the class that has been created.

classmethod controllers_cleanup()

Cleans up all controller instances.

It Calls the clean_up() method for each instance, since it iterates through the list of controllers to realize any needed cleanup which can fail so an error will be raised. Then, the remaining instances will continue processing.

Returns:

bool: True indicating that all the controllers are successfully cleaned up, otherwise False when an error occurred during the operation of the cleanup.

clean_up() → bool

Clean up all controller instances. This method should be overridden to precise the specific cleanup logic. If an instance does not override it, a default message will appear to inform that there are no cleanup logic is implemented.

Return:

bool: True when the cleanup was successful, otherwise False if cleanup failed. By default, it returns True, yet this method should be overridden to present the actual cleanup status.