Merge lp:~nataliabidart/u1-test-utils/better-logging-errors into lp:u1-test-utils

[Natalia Bidart]

- Better output when memento handler does not have the expected logging.

[Matias Bordese (matiasb)]

LGTM

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~nataliabidart/u1-test-utils/better-logging-errors into lp:u1-test-utils failed. Below is the output from the failed tests.

Setting up the virtual environment.
[localhost] local: which virtualenv
[localhost] local: /usr/bin/python /usr/bin/virtualenv --version
[localhost] local: /usr/bin/python /usr/bin/virtualenv --distribute --clear .env
Not deleting .env/bin
New python executable in .env/bin/python
Installing distribute.............................................................................................................................................................................................done.
Installing pip...............done.
[localhost] local: . /mnt/tarmac/cache/u1-test-utils/trunk/.env/bin/activate && pip install -U -r requirements.txt
Downloading/unpacking bzr+ssh://bazaar.launchpad.net/~bloodearnest/localmail/trunk@36 (from -r requirements.txt (line 9))
  Checking out bzr+ssh://bazaar.launchpad.net/~bloodearnest/localmail/trunk (to revision 36) to /tmp/pip-wdgYcP-build
  Running setup.py egg_info for package from bzr+ssh://bazaar.launchpad.net/~bloodearnest/localmail/trunk@36

Downloading/unpacking bzr+http://bazaar.launchpad.net/~ubuntuone-hackers/payclient/trunk@4 (from -r requirements.txt (line 10))
  Checking out http://bazaar.launchpad.net/~ubuntuone-hackers/payclient/trunk (to revision 4) to /tmp/pip-buVlPx-build
  Running setup.py egg_info for package from bzr+http://bazaar.launchpad.net/~ubuntuone-hackers/payclient/trunk@4

    warning: no previously-included files matching '*.pyc' found anywhere in distribution
Downloading/unpacking bzr+http://bazaar.launchpad.net/~canonical-isd-qa/selenium-simple-test/trunk@tag:sst-0.2.4 (from -r requirements.txt (line 11))
  Checking out http://bazaar.launchpad.net/~canonical-isd-qa/selenium-simple-test/trunk (to revision tag:sst-0.2.4) to /tmp/pip-PvymRn-build
  Running setup.py egg_info for package from bzr+http://bazaar.launchpad.net/~canonical-isd-qa/selenium-simple-test/trunk@tag:sst-0.2.4

    warning: no files found matching 'testproj.db.original' under directory 'src/testproject'
Downloading/unpacking bzr+http://bazaar.launchpad.net/~canonical-isd-hackers/canonical-identity-provider/ssoclient@3 (from -r requirements.txt (line 12))
  Checking out http://bazaar.launchpad.net/~canonical-isd-hackers/canonical-identity-provider/ssoclient (to revision 3) to /tmp/pip-PbGJce-build
  Running setup.py egg_info for package from bzr+http://bazaar.launchpad.net/~canonical-isd-hackers/canonical-identity-provider/ssoclient@3

Downloading/unpacking beautifulsoup4 (from -r requirements.txt (line 2))
  Running setup.py egg_info for package beautifulsoup4

Downloading/unpacking django==1.4 (from -r requirements.txt (line 3))
  Running setup.py egg_info for package django

Downloading/unpacking mock (from -r requirements.txt (line 4))
  Running setup.py egg_info for package mock

    warning: no files found matching '*.png' under directory 'docs'
    warning: no files found matching '*.css' under directory 'docs'
    warning: no files found matching '*.html' under directory 'docs'
    warning: no files found matching '*.js' under d...

=== modified file 'u1testutils/logging.py'
--- u1testutils/logging.py	2013-02-28 16:01:53 +0000
+++ u1testutils/logging.py	2013-08-12 21:37:16 +0000
@@ -27,13 +27,16 @@
 
         def check(self, level, msg, check_traceback=False):
             """Check that something is logged."""
+            result = False
             for rec in self.records:
-                if rec.levelname == level and str(msg) in rec.getMessage():
-                    if not check_traceback:
-                        return True
-                    elif rec.exc_text is not None:
-                        return True
-            return False
+                if rec.levelname == level:
+                    result = str(msg) in rec.getMessage()
+                    if not result and check_traceback:
+                        result = str(msg) in rec.exc_text
+                    if result:
+                        break
+
+            return result
 
     def setUp(self):
         """Add the memento handler to the root logger."""
@@ -48,7 +51,12 @@
         super(LogHandlerTestCase, self).tearDown()
 
     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, check_traceback=check_traceback))
+        check = self.memento_handler.check(
+            level, message, check_traceback=check_traceback)
+
+        msg = ('Expected logging message/s could not be found:\n%s\n'
+               'Current logging records are:\n%s')
+        expected = '\t%s: %s' % (level, message)
+        records = ['\t%s: %s' % (r.levelname, r.getMessage())
+                   for r in self.memento_handler.records]
+        self.assertTrue(check, msg % (expected, '\n'.join(records)))