Merge remote-tracking branch 'ivan/feature/2982_test_leap_log_handler' into develop

3 files changed, 121 insertions, 3 deletions

diff --git a/src/leap/util/leap_log_handler.py b/src/leap/util/leap_log_handler.py
index e5bc87e1..271096d3 100644
--- a/src/leap/util/leap_log_handler.py
+++ b/src/leap/util/leap_log_handler.py
@@ -44,7 +44,7 @@ class LogHandler(logging.Handler):
         logging.Handler.__init__(self)
         self._qtsignal = qtsignal
 
-    def _set_format(self, logging_level):
+    def _get_format(self, logging_level):
         """
         Sets the log format depending on the parameter.
         It uses html and css to set the colors for the logs.
@@ -70,7 +70,7 @@ class LogHandler(logging.Handler):
         log_format = ' - '.join(format_attrs)
         formatter = logging.Formatter(log_format)
 
-        self.setFormatter(formatter)
+        return formatter
 
     def emit(self, logRecord):
         """
@@ -82,7 +82,7 @@ class LogHandler(logging.Handler):
         :param logRecord: the record emitted by the logging module.
         :type logRecord: logging.LogRecord.
         """
-        self._set_format(logRecord.levelname)
+        self.setFormatter(self._get_format(logRecord.levelname))
         log = self.format(logRecord)
         log_item = {self.RECORD_KEY: logRecord, self.MESSAGE_KEY: log}
         self._log_history.append(log_item)
diff --git a/src/leap/util/tests/__init__.py b/src/leap/util/tests/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/src/leap/util/tests/__init__.py
diff --git a/src/leap/util/tests/test_leap_log_handler.py b/src/leap/util/tests/test_leap_log_handler.py
new file mode 100644
index 00000000..ea509ea8
--- /dev/null
+++ b/src/leap/util/tests/test_leap_log_handler.py
@@ -0,0 +1,118 @@
+# -*- 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
+"""
+
+import unittest
+
+import logging
+
+from leap.util.leap_log_handler import LeapLogHandler
+from leap.common.testing.basetest import BaseLeapTest
+from leap.util.pyside_tests_helper import BasicPySlotCase
+
+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()