avocado.core.runners.utils package

Submodules

avocado.core.runners.utils.messages module

class avocado.core.runners.utils.messages.FileMessage

Bases: GenericRunningMessage

Creates file message with all necessary information.

classmethod get(msg, path)

Creates running message with all necessary information.

Parameters:

msg (str) – log of running message

Returns:

running message

Return type:

dict

message_type = 'file'
class avocado.core.runners.utils.messages.FinishedMessage

Bases: GenericMessage

classmethod get(result, fail_reason=None, returncode=None)

Creates finished message with all necessary information.

Parameters:

  • result (values for the statuses defined in :class: avocado.core.teststatus.STATUSES) – test result

  • fail_reason (str) – parameter for brief specification, of the failed result.

  • returncode – exit status of runner

Returns:

finished message

Return type:

dict

message_status = 'finished'
class avocado.core.runners.utils.messages.GenericMessage

Bases: object

classmethod get(**kwargs)

Creates message base on it’s type with all necessary information.

Returns:

message dict which can be send to avocado server

Return type:

dict

message_status = None
class avocado.core.runners.utils.messages.GenericRunningMessage

Bases: GenericMessage

classmethod get(msg, **kwargs)

Creates running message with all necessary information.

Parameters:

msg (str) – log of running message

Returns:

running message

Return type:

dict

message_status = 'running'
message_type = None
class avocado.core.runners.utils.messages.LogMessage

Bases: GenericRunningMessage

message_type = 'log'
class avocado.core.runners.utils.messages.OutputMessage

Bases: GenericRunningMessage

Creates output message with all necessary information.

message_type = 'output'
class avocado.core.runners.utils.messages.RunnerLogHandler(queue, message_type)

Bases: Handler

Runner logger which will put every log to the runner queue

Parameters:
emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

class avocado.core.runners.utils.messages.RunningMessage

Bases: GenericMessage

Creates running message without any additional info.

message_status = 'running'
class avocado.core.runners.utils.messages.StartedMessage

Bases: GenericMessage

message_status = 'started'
class avocado.core.runners.utils.messages.StderrMessage

Bases: GenericRunningMessage

Creates stderr message with all necessary information.

message_type = 'stderr'
class avocado.core.runners.utils.messages.StdoutMessage

Bases: GenericRunningMessage

Creates stdout message with all necessary information.

message_type = 'stdout'
class avocado.core.runners.utils.messages.StreamToQueue(queue, message_type)

Bases: object

Runner Stream which will transfer data to the runner queue

Parameters:
flush()
write(buf)
class avocado.core.runners.utils.messages.WhiteboardMessage

Bases: GenericRunningMessage

Creates whiteboard message with all necessary information.

message_type = 'whiteboard'
avocado.core.runners.utils.messages.start_logging(config, queue)

Helper method for connecting the avocado logging with avocado messages.

It will add the logHandlers to the :class: avocado.core.output loggers, which will convert the logs to the avocado messages and sent them to processing queue.

Parameters:

Module contents