thread_auxiliary

Thread based Auxiliary Interface

module: thread_auxiliary
synopsis: common thread based auxiliary interface

Warning

AuxiliaryInterface will be deprecated in a few releases!

class pykiso.interfaces.thread_auxiliary.AuxiliaryInterface(name=None, is_proxy_capable=False, activate_log=None, auto_start=True)[source]

Defines the Interface of all thread based auxiliaries.

Auxiliaries get configured by the Test Coordinator, get instantiated by the TestCases and in turn use Connectors.

Auxiliary initialization.

Parameters

name (Optional[str]) – alias of the auxiliary instance
is_proxy_capable (bool) – notify if the current auxiliary could be (or not) associated to a proxy-auxiliary.
activate_log (Optional[List[str]]) – loggers to deactivate
auto_start (bool) – determine if the auxiliayry is automatically started (magic import) or manually (by user)

create_instance()[source]

Create an auxiliary instance and ensure the communication to it.

Return type: bool
Returns: message.Message() - Contain received message
Raises: AuxiliaryCreationError – if instance creation failed

delete_instance()[source]

Delete an auxiliary instance and its communication to it.

Return type: bool
Returns: message.Message() - Contain received message

run()[source]

Run function of the auxiliary thread.

Return type: None

start()[source]

Start the thread and create the auxiliary only if auto_start flag is False.

Return type: None