Reorder logging helpers and handlers.

2 files changed, 246 insertions, 0 deletions

diff --git a/src/leap/bitmask/logs/tests/test_leap_log_handler.py b/src/leap/bitmask/logs/tests/test_leap_log_handler.py
new file mode 100644
index 00000000..20b09aef
--- /dev/null
+++ b/src/leap/bitmask/logs/tests/test_leap_log_handler.py
@@ -0,0 +1,120 @@
+# -*- coding: utf-8 -*-
+# test_leap_log_handler.py
+# Copyright (C) 2013 LEAP
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+tests for leap_log_handler
+"""
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+import logging
+
+from leap.bitmask.logs.leap_log_handler import LeapLogHandler
+from leap.bitmask.util.pyside_tests_helper import BasicPySlotCase
+from leap.common.testing.basetest import BaseLeapTest
+
+from mock import Mock
+
+
+class LeapLogHandlerTest(BaseLeapTest, BasicPySlotCase):
+    """
+    LeapLogHandlerTest's tests.
+    """
+    def _callback(self, *args):
+        """
+        Simple callback to track if a signal was emitted.
+        """
+        self.called = True
+        self.emitted_msg = args[0][LeapLogHandler.MESSAGE_KEY]
+
+    def setUp(self):
+        BasicPySlotCase.setUp(self)
+
+        # Create the logger
+        level = logging.DEBUG
+        self.logger = logging.getLogger(name='test')
+        self.logger.setLevel(level)
+
+        # Create the handler
+        self.leap_handler = LeapLogHandler()
+        self.leap_handler.setLevel(level)
+        self.logger.addHandler(self.leap_handler)
+
+    def tearDown(self):
+        BasicPySlotCase.tearDown(self)
+        try:
+            self.leap_handler.new_log.disconnect()
+        except Exception:
+            pass
+
+    def test_history_starts_empty(self):
+        self.assertEqual(self.leap_handler.log_history, [])
+
+    def test_one_log_captured(self):
+        self.logger.debug('test')
+        self.assertEqual(len(self.leap_handler.log_history), 1)
+
+    def test_history_records_order(self):
+        self.logger.debug('test 01')
+        self.logger.debug('test 02')
+        self.logger.debug('test 03')
+
+        logs = []
+        for message in self.leap_handler.log_history:
+            logs.append(message[LeapLogHandler.RECORD_KEY].msg)
+
+        self.assertIn('test 01', logs)
+        self.assertIn('test 02', logs)
+        self.assertIn('test 03', logs)
+
+    def test_history_messages_order(self):
+        self.logger.debug('test 01')
+        self.logger.debug('test 02')
+        self.logger.debug('test 03')
+
+        logs = []
+        for message in self.leap_handler.log_history:
+            logs.append(message[LeapLogHandler.MESSAGE_KEY])
+
+        self.assertIn('test 01', logs[0])
+        self.assertIn('test 02', logs[1])
+        self.assertIn('test 03', logs[2])
+
+    def test_emits_signal(self):
+        log_format = '%(name)s - %(levelname)s - %(message)s'
+        formatter = logging.Formatter(log_format)
+        get_format = Mock(return_value=formatter)
+        self.leap_handler._handler._get_format = get_format
+
+        self.leap_handler.new_log.connect(self._callback)
+        self.logger.debug('test')
+
+        expected_log_msg = "test - DEBUG - test"
+
+        # signal emitted
+        self.assertTrue(self.called)
+
+        # emitted message
+        self.assertEqual(self.emitted_msg, expected_log_msg)
+
+        # Mock called
+        self.assertTrue(get_format.called)
+
+
+if __name__ == "__main__":
+    unittest.main()
diff --git a/src/leap/bitmask/logs/tests/test_streamtologger.py b/src/leap/bitmask/logs/tests/test_streamtologger.py
new file mode 100644
index 00000000..9bbadde8
--- /dev/null
+++ b/src/leap/bitmask/logs/tests/test_streamtologger.py
@@ -0,0 +1,126 @@
+# -*- coding: utf-8 -*-
+# test_streamtologger.py
+# Copyright (C) 2013 LEAP
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+tests for streamtologger
+"""
+
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+import logging
+import sys
+
+from leap.bitmask.logs.streamtologger import StreamToLogger
+from leap.common.testing.basetest import BaseLeapTest
+
+
+class SimpleLogHandler(logging.Handler):
+    """
+    The simplest log handler that allows to check if the log was
+    delivered to the handler correctly.
+    """
+    def __init__(self):
+        logging.Handler.__init__(self)
+        self._last_log = ""
+        self._last_log_level = ""
+
+    def emit(self, record):
+        self._last_log = record.getMessage()
+        self._last_log_level = record.levelno
+
+    def get_last_log(self):
+        """
+        Returns the last logged message by this handler.
+
+        :return: the last logged message.
+        :rtype: str
+        """
+        return self._last_log
+
+    def get_last_log_level(self):
+        """
+        Returns the level of the last logged message by this handler.
+
+        :return: the last logged level.
+        :rtype: str
+        """
+        return self._last_log_level
+
+
+class StreamToLoggerTest(BaseLeapTest):
+    """
+    StreamToLogger's tests.
+
+    NOTE: we may need to find a way to test the use case that an exception
+    is raised. I couldn't catch the output of an exception because the
+    test failed if some exception is raised.
+    """
+    def setUp(self):
+        # Create the logger
+        level = logging.DEBUG
+        self.logger = logging.getLogger(name='test')
+        self.logger.setLevel(level)
+
+        # Simple log handler
+        self.handler = SimpleLogHandler()
+        self.logger.addHandler(self.handler)
+
+        # Preserve original values
+        self._sys_stdout = sys.stdout
+        self._sys_stderr = sys.stderr
+
+        # Create the handler
+        sys.stdout = StreamToLogger(self.logger, logging.DEBUG)
+        sys.stderr = StreamToLogger(self.logger, logging.ERROR)
+
+    def tearDown(self):
+        # Restore original values
+        sys.stdout = self._sys_stdout
+        sys.stderr = self._sys_stderr
+
+    def test_logger_starts_empty(self):
+        self.assertEqual(self.handler.get_last_log(), '')
+
+    def test_standard_output(self):
+        message = 'Test string'
+        print message
+
+        log = self.handler.get_last_log()
+        log_level = self.handler.get_last_log_level()
+
+        self.assertEqual(log, message)
+        self.assertEqual(log_level, logging.DEBUG)
+
+    def test_standard_error(self):
+        message = 'Test string'
+        sys.stderr.write(message)
+
+        log_level = self.handler.get_last_log_level()
+        log = self.handler.get_last_log()
+
+        self.assertEqual(log, message)
+        self.assertEqual(log_level, logging.ERROR)
+
+    def test_twisted_log(self):
+        from twisted.python import log
+        log.startLogging(sys.stdout)
+
+
+if __name__ == "__main__":
+    unittest.main(verbosity=2)