testsuite.event_notifications

Attributes

logger

Exceptions

InvalidNotifyCommand

Common base class for all non-exit exceptions.

Classes

TestNotification	Notification for a given test.
TestQueueNotification	Notification to signal that a test was queued.
TestStartNotification	Notification to signal that the execution of a test has just started.
TestResultNotification	Notification to signal the addition of a new test result.
TestEndNotification	Notification to signal that the execution of a test has just ended.
EventNotifier	Abstraction to send notifications.

Module Contents

testsuite.event_notifications.logger

class testsuite.event_notifications.TestNotification

Notification for a given test.

test_name: str

Name of the test that this notification refers to.

abstractmethod to_args() → list[str]

class testsuite.event_notifications.TestQueueNotification

Bases: TestNotification

Notification to signal that a test was queued.

to_args() → list[str]

class testsuite.event_notifications.TestStartNotification

Bases: TestNotification

Notification to signal that the execution of a test has just started.

to_args() → list[str]

class testsuite.event_notifications.TestResultNotification

Bases: TestNotification

Notification to signal the addition of a new test result.

result: e3.testsuite.result.TestResultSummary

Summary for the added test result.

yaml_result_filename: str

Absolute filename for the YAML file that stores the test result.

This YAML file must be loaded through the TestResult.load static method.

to_args() → list[str]

class testsuite.event_notifications.TestEndNotification

Bases: TestNotification

Notification to signal that the execution of a test has just ended.

to_args() → list[str]

exception testsuite.event_notifications.InvalidNotifyCommand

Bases: Exception

Common base class for all non-exit exceptions.

class testsuite.event_notifications.EventNotifier(testsuite: e3.testsuite.TestsuiteCore, notify_cmd: str | None)

Abstraction to send notifications.

python_cmd_re

notify_callback: Callable[[TestNotification], None] | None = None

notify_cmd: list[str] | None = None

_parse_notify_cmd(testsuite: e3.testsuite.TestsuiteCore, cmd: str | None) → None

Decode the given notify command.

notify(notification: TestNotification) → None

Send a given notification.

notify_test_queue(test_name: str) → None

notify_test_start(test_name: str) → None

notify_test_result(test_name: str, result: e3.testsuite.result.TestResultSummary, yaml_result_filename: str) → None

notify_test_end(test_name: str) → None