Robot's listener v3 implementation

listener.py

""" Robot's listener v3 implementation
    For more information see:
    http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-version-3
"""

ROBOT_LISTENER_API_VERSION = 3


def start_suite(suite, result):
    """ Called when a test suite starts.
    """
    pass


def end_suite(suite, result):
    """ Called when a test suite ends.
    """
    pass


def start_test(case, result):
    """ Called when a test case starts.
    """
    pass


def end_test(case, result):
    """ Called when a test case ends.
    """
    pass


def log_message(message):
    """ Called when an executed keyword writes a log message.
        :param message: message is a object representing the logged message.
    """
    pass


def message(message):
    """ Called when the framework itself writes a syslog message.
        :param message: message is same object as with log_message.
    """
    pass


def output_file(path):
    """ Called when writing to an output file is ready.
        :param path: path is an absolute path to the file.
    """
    pass


def log_file(path):
    """ Called when writing to a log file is ready.
        :param path: path is an absolute path to the file.
    """
    pass


def report_file(path):
    """ Called when writing to a report file is ready.
        :param path: path is an absolute path to the file.
    """
    pass


def xunit_file(path):
    """ Called when writing to an xunit file is ready.
        :param path: path is an absolute path to the file.
    """
    pass


def debug_file(path):
    """ Called when writing to a debug file is ready.
        :param path: path is an absolute path to the file.
    """
    pass


def close():
    """ Called when the whole test execution ends.
    """
    pass