• Home
• org.jspringbot
• robotframework
• 2.7.7.0.TEST
• source code
• test_logger.py

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

robotframework-2.7.7.utest.output.test_logger.py Maven / Gradle / Ivy

import unittest

from robot.utils.asserts import assert_equals, assert_true, assert_false

from robot.output.logger import Logger, CommandLineMonitor


class MessageMock:

    def __init__(self, timestamp, level, message):
        self.timestamp = timestamp
        self.level = level
        self.message = message

class LoggerMock:

    def __init__(self, *expected):
        self.expected = list(expected)

    def message(self, msg):
        exp_msg, exp_level = self.expected.pop(0)
        assert_equals(msg.level, exp_level)
        assert_equals(msg.message, exp_msg)
        self.msg = msg

    def copy(self):
        return LoggerMock(*self.expected)

class LoggerMock2(LoggerMock):

    def output_file(self, name, path):
        self.output_file = (name, path)

    def close(self):
        self.closed = True


class TestLogger(unittest.TestCase):

    def setUp(self):
        self.logger = Logger()
        self.logger.disable_automatic_console_logger()

    def test_write_to_one_logger(self):
        logger = LoggerMock(('Hello, world!', 'INFO'))
        self.logger.register_logger(logger)
        self.logger.write('Hello, world!', 'INFO')
        assert_true(logger.msg.timestamp.startswith('20'))

    def test_write_to_one_logger_with_trace_level(self):
        logger = LoggerMock(('expected message', 'TRACE'))
        self.logger.register_logger(logger)
        self.logger.write('expected message', 'TRACE')
        assert_true(hasattr(logger, 'msg'))

    def test_write_to_multiple_loggers(self):
        logger = LoggerMock(('Hello, world!', 'INFO'))
        logger2 = logger.copy()
        logger3 = logger.copy()
        self.logger.register_logger(logger, logger2, logger3)
        self.logger.message(MessageMock('', 'INFO', 'Hello, world!'))
        assert_true(logger.msg is logger2.msg)
        assert_true(logger.msg is logger.msg)

    def test_write_multiple_messages(self):
        msgs = [('0', 'ERROR'), ('1', 'WARN'), ('2', 'INFO'), ('3', 'DEBUG'), ('4', 'TRACE')]
        logger = LoggerMock(*msgs)
        self.logger.register_logger(logger)
        for msg, level in msgs:
            self.logger.write(msg, level)
            assert_equals(logger.msg.message, msg)
            assert_equals(logger.msg.level, level)

    def test_all_methods(self):
        logger = LoggerMock2(('Hello, world!', 'INFO'))
        self.logger.register_logger(logger)
        self.logger.output_file('name', 'path')
        self.logger.close()
        assert_equals(logger.output_file, ('name', 'path'))
        assert_true(logger.closed)

    def test_registered_logger_does_not_need_all_methods(self):
        logger = LoggerMock(('Hello, world!', 'INFO'))
        self.logger.register_logger(logger)
        self.logger.output_file('name', 'path')
        self.logger.close()

    def test_close_removes_registered_loggers(self):
        logger = LoggerMock(('Hello, world!', 'INFO'))
        logger2 = LoggerMock2(('Hello, world!', 'INFO'))
        self.logger.register_logger(logger, logger2)
        self.logger.close()
        assert_equals(self.logger._loggers.all_loggers(), [])

    def test_registering_file_logger_with_none_path_does_nothing(self):
        self.logger.register_file_logger('None')
        assert_equals(self.logger._loggers.all_loggers(), [])

    def test_cached_messages_are_given_to_registered_writers(self):
        self.logger.write('This is a cached message', 'INFO')
        self.logger.write('Another cached message', 'TRACE')
        logger = LoggerMock(('This is a cached message', 'INFO'),
                            ('Another cached message', 'TRACE'))
        self.logger.register_logger(logger)
        assert_equals(logger.msg.message, 'Another cached message')

    def test_message_cache_can_be_turned_off(self):
        self.logger.disable_message_cache()
        self.logger.write('This message is not cached', 'INFO')
        logger = LoggerMock(('', ''))
        self.logger.register_logger(logger)
        assert_false(hasattr(logger, 'msg'))

    def test_start_and_end_suite_test_and_keyword(self):
        class MyLogger:
            def start_suite(self, suite): self.started_suite = suite
            def end_suite(self, suite): self.ended_suite = suite
            def start_test(self, test): self.started_test = test
            def end_test(self, test): self.ended_test = test
            def start_keyword(self, keyword): self.started_keyword = keyword
            def end_keyword(self, keyword): self.ended_keyword = keyword
        logger = MyLogger()
        self.logger.register_logger(logger)
        for name in 'suite', 'test', 'keyword':
            for stend in 'start', 'end':
                getattr(self.logger, stend + '_' + name)(name)
                assert_equals(getattr(logger, stend + 'ed_' + name), name)

    def test_console_logger_is_automatically_registered(self):
        logger = Logger()
        assert_true(logger._loggers.all_loggers()[0].start_suite.im_class is CommandLineMonitor)

    def test_loggercollection_is_iterable(self):
        logger = Logger()
        for log in logger._loggers:
            assert_true(log)

    def test_logger_is_iterable(self):
        logger = Logger()
        for log in logger:
            assert_true(log)
        assert_equals(list(logger), list(logger._loggers))

    def test_automatic_console_logger_can_be_disabled(self):
        logger = Logger()
        logger.disable_automatic_console_logger()
        assert_equals(logger._loggers.all_loggers(), [])

    def test_automatic_console_logger_can_be_disabled_after_registering_logger(self):
        logger = Logger()
        mock = LoggerMock()
        logger.register_logger(mock)
        logger.disable_automatic_console_logger()
        self._number_of_registered_loggers_should_be(1, logger)
        assert_true(logger._loggers.all_loggers()[0].message.im_class is LoggerMock)

    def test_disabling_automatic_logger_multiple_times_has_no_effect(self):
        logger = Logger()
        logger.disable_automatic_console_logger()
        self._number_of_registered_loggers_should_be(0, logger)
        logger.disable_automatic_console_logger()
        logger.disable_automatic_console_logger()
        self._number_of_registered_loggers_should_be(0, logger)
        logger.register_logger(LoggerMock())
        logger.disable_automatic_console_logger()
        self._number_of_registered_loggers_should_be(1, logger)

    def test_registering_console_logger_disables_automatic_console_logger(self):
        logger = Logger()
        logger.register_console_logger(width=42)
        self._number_of_registered_loggers_should_be(1, logger)
        assert_equals(logger._loggers.all_loggers()[0].start_suite.im_self._writer._width, 42)

    def test_unregister_logger(self):
        logger1, logger2, logger3 = LoggerMock(), LoggerMock(), LoggerMock()
        self.logger.register_logger(logger1, logger2, logger3)
        self.logger.unregister_logger(logger2)
        self._number_of_registered_loggers_should_be(2)
        self.logger.unregister_logger(logger3, logger1)
        self._number_of_registered_loggers_should_be(0)

    def test_unregistering_non_registered_logger_is_ok(self):
        logger1, logger2 = LoggerMock(), LoggerMock()
        self.logger.register_logger(logger1)
        self.logger.unregister_logger(logger2)
        self.logger.unregister_logger(None)

    def test_registering_context_changing_logger(self):
        self.logger.register_context_changing_logger(LoggerMock())
        self._number_of_registered_loggers_should_be(1)

    def test_messages_to_context_chagning_loggers(self):
        log = LoggerMock(('msg', 'INFO'))
        self.logger.register_context_changing_logger(log)
        self.logger.write('msg', 'INFO')
        assert_true(log.msg is not None)

    def test_start_methods_are_called_first_for_context_changing_loggers(self):
        class FirstLogger:
            def start_suite(self, suite): self.suite = suite
            def start_test(self, test): self.test = test
            def start_keyword(self, kw): self.kw = kw
        class SecondLogger:
            def __init__(self, logger): self._reference = logger
            def start_suite(self, suite): assert_equals(suite, self._reference.suite)
            def start_test(self, test): assert_equals(test, self._reference.test)
            def start_keyword(self, kw): assert_equals(kw, self._reference.kw)
        log1 = FirstLogger()
        log2 = SecondLogger(log1)
        self.logger.register_logger(log2)
        self.logger.register_context_changing_logger(log1)
        self.logger.start_suite('Suite')
        self.logger.start_test('Test')
        self.logger.start_keyword('Keyword')

    def test_end_methods_are_called_last_for_context_changing_loggers(self):
        class FirstLogger:
            def end_suite(self, suite): self.suite = suite
            def end_test(self, test): self.test = test
            def end_keyword(self, kw): self.kw = kw
        class SecondLogger:
            def __init__(self, logger): self._reference = logger
            def end_suite(self, suite): self.suite = suite; assert_equals(suite, self._reference.suite)
            def end_test(self, test): assert_equals(test, self._reference.test)
            def end_keyword(self, kw): assert_equals(kw, self._reference.kw)
        log1 = FirstLogger()
        log2 = SecondLogger(log1)
        self.logger.register_logger(log1)
        self.logger.register_context_changing_logger(log2)
        self.logger.end_suite('Suite')
        self.logger.end_test('Test')
        self.logger.end_keyword('Keyword')
        assert_true(log2.suite is not None)

    def _number_of_registered_loggers_should_be(self, number, logger=None):
        logger = logger or self.logger
        assert_equals(len(logger._loggers.all_loggers()), number)


if __name__ == "__main__":
    unittest.main()