thread_auxiliary

Thread based Auxiliary Interface

module

thread_auxiliary

synopsis

common thread based auxiliary interface

class pykiso.interfaces.thread_auxiliary.AuxiliaryInterface(name=None, is_proxy_capable=False, is_pausable=False, activate_log=None, auto_start=True)

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.

• is_pausable (bool) – notify if the current auxiliary could be (or not) paused

• 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()

Create an auxiliary instance and ensure the communication to it.

Return type

bool

Returns

message.Message() - Contain received message

delete_instance()

Delete an auxiliary instance and its communication to it.

Return type

bool

Returns

message.Message() - Contain received message

static initialize_loggers(loggers)

Deactivate all external loggers except the specified ones.

Parameters

loggers (Optional[List[str]]) – list of logger names to keep activated

Return type

None

run()

Run function of the auxiliary thread.

Return type

None

start()

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

Return type

None