Merge lp:~ricardokirkner/u1-test-utils/assert-log-with-traceback into lp:u1-test-utils

[Ricardo Kirkner]

Allow assertLogLevelContains to also check if the log record contains traceback information.

Allow assertLogLevelContains to also check if the log record contains traceback information.

[lp:~ricardokirkner/u1-test-utils/assert-log-with-traceback]

36. By Ricardo Kirkner on 2013-02-28

renamed has_traceback to check_traceback

37. By Ricardo Kirkner on 2013-02-28

fix per code review

[Leo Arias (elopio)]

<elopio> pindonga: shouldn't this parameter has_traceback=False be called check_traceback ?
<pindonga> I can change that if that name is better
<elopio> pindonga: when I read it, I thought that it was going to fail if has_traceback=False and there was a traceback on the log entry.
<pindonga> k
<elopio> or the contrary. But has_traceback=False only ignores the traceback check. So for me, that would be a better name.
<elopio> for the rest, +1
<elopio> pindonga: oh, and also on line 16, I would find it clearer with an elif.
<pindonga> it's exactly the same, yes? bc of the return
<pindonga> but I can change that if it makes you happier
<pindonga> :)
<pindonga> elopio: revno 37 pushed
<elopio> pindonga: yes, it's exactly the same. But it takes one less second to notice that you will never enter in that code block. That's why I said "I find it clearer", it also means, feel free to ignore me whenever you want :)

review: Approve (code review)

=== modified file 'u1testutils/logging.py'
--- u1testutils/logging.py	2012-12-04 19:56:54 +0000
+++ u1testutils/logging.py	2013-02-28 16:10:28 +0000
@@ -25,11 +25,14 @@
             """Just add the record to self.records."""
             self.records.append(record)
 
-        def check(self, level, msg):
+        def check(self, level, msg, check_traceback=False):
             """Check that something is logged."""
             for rec in self.records:
                 if rec.levelname == level and str(msg) in rec.getMessage():
-                    return True
+                    if not check_traceback:
+                        return True
+                    elif rec.exc_text is not None:
+                        return True
             return False
 
     def setUp(self):
@@ -44,7 +47,8 @@
         self.root_logger.removeHandler(self.memento_handler)
         super(LogHandlerTestCase, self).tearDown()
 
-    def assertLogLevelContains(self, level, message):
+    def assertLogLevelContains(self, level, message, check_traceback=False):
         # XXX michaeln 2010-08-18 Convert this to use testtools matchers
         # for much better failure output.
-        self.assertTrue(self.memento_handler.check(level, message))
+        self.assertTrue(self.memento_handler.check(
+            level, message, check_traceback=check_traceback))

=== added file 'u1testutils/selftests/unit/test_logging.py'
--- u1testutils/selftests/unit/test_logging.py	1970-01-01 00:00:00 +0000
+++ u1testutils/selftests/unit/test_logging.py	2013-02-28 16:10:28 +0000
@@ -0,0 +1,29 @@
+from mock import Mock
+
+from u1testutils.logging import LogHandlerTestCase
+
+
+class LogHandlerTestCaseTestCase(LogHandlerTestCase):
+
+    def test_assertLogLevelContains_check_traceback(self):
+        mock_record = Mock()
+        mock_record.levelname = 'ERROR'
+        mock_record.getMessage.return_value = 'some message'
+        mock_record.exc_text = 'the exception'
+
+        self.memento_handler.emit(mock_record)
+
+        self.assertLogLevelContains('ERROR', 'some message',
+                                    check_traceback=True)
+
+    def test_MementoHandler_check_check_traceback(self):
+        mock_record = Mock()
+        mock_record.levelname = 'ERROR'
+        mock_record.getMessage.return_value = 'some message'
+        mock_record.exc_text = 'the exception'
+
+        self.memento_handler.emit(mock_record)
+
+        result = self.memento_handler.check('ERROR', 'some message',
+                                            check_traceback=True)
+        self.assertTrue(result)