avocado.core.runners.utils package¶
Submodules¶
avocado.core.runners.utils.messages module¶
-
class
avocado.core.runners.utils.messages.
FileMessage
¶ Bases:
avocado.core.runners.utils.messages.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'¶
-
classmethod
-
class
avocado.core.runners.utils.messages.
FinishedMessage
¶ Bases:
avocado.core.runners.utils.messages.GenericMessage
-
classmethod
get
(result, fail_reason=None, returncode=None)¶ Creates finished message with all necessary information.
Parameters: result – test result - :type result values for the statuses defined in
class: avocado.core.teststatus.STATUSES
Parameters: - fail_reason (str) – parameter for brief specification, of the failed result.
- returncode – exit status of runner
Returns: finished message
Return type:
-
message_status
= 'finished'¶
-
classmethod
-
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¶
-
classmethod
-
class
avocado.core.runners.utils.messages.
GenericRunningMessage
¶ Bases:
avocado.core.runners.utils.messages.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¶
-
classmethod
-
class
avocado.core.runners.utils.messages.
LogMessage
¶ Bases:
avocado.core.runners.utils.messages.GenericRunningMessage
-
message_type
= 'log'¶
-
-
class
avocado.core.runners.utils.messages.
OutputMessage
¶ Bases:
avocado.core.runners.utils.messages.GenericRunningMessage
Creates output message with all necessary information.
-
message_type
= 'output'¶
-
-
class
avocado.core.runners.utils.messages.
RunnerLogHandler
(queue, message_type, kwargs=None)¶ Bases:
logging.Handler
Runner logger which will put every log to the runner queue
Parameters: - queue (multiprocessing.SimpleQueue) – queue for the runner messages
- message_type (string) – type of the log
-
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:
avocado.core.runners.utils.messages.GenericMessage
Creates running message without any additional info.
-
message_status
= 'running'¶
-
-
class
avocado.core.runners.utils.messages.
StartedMessage
¶ Bases:
avocado.core.runners.utils.messages.GenericMessage
-
message_status
= 'started'¶
-
-
class
avocado.core.runners.utils.messages.
StderrMessage
¶ Bases:
avocado.core.runners.utils.messages.GenericRunningMessage
Creates stderr message with all necessary information.
-
message_type
= 'stderr'¶
-
-
class
avocado.core.runners.utils.messages.
StdoutMessage
¶ Bases:
avocado.core.runners.utils.messages.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: - queue (multiprocessing.SimpleQueue) – queue for the runner messages
- message_type (string) – type of the log
-
flush
()¶
-
write
(buf)¶
-
class
avocado.core.runners.utils.messages.
WhiteboardMessage
¶ Bases:
avocado.core.runners.utils.messages.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: - config (dict) – avocado configuration
- queue (multiprocessing.SimpleQueue) – queue for the runner messages