Merge lp:~canonical-platform-qa/autopilot/fix-bug-1414781 into lp:autopilot

[Sergio Cazzolato]

autopilot.tests.unit.LogHandlerTestCase replaced by fixtures.FakeLogger

Bux #1414781 fixed

[Leo Arias (elopio)]

Thanks Sergio. I left some comments in line.

[Leo Arias (elopio)]

review: Needs Fixing

[lp:~canonical-platform-qa/autopilot/fix-bug-1414781]

558. By Sergio Cazzolato on 2015-05-21

removing statements from with scope

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:557
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1072/
Executed test runs:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/1072/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:557
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1073/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/4/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/3/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/4/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/1073/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:558
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1077/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/8/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/7/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/8/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/1077/rebuild

review: Needs Fixing (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

PASSED: Continuous integration, rev:558
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/9/
Executed test runs:
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/9/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/9/rebuild

review: Approve (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:558
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/122/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/359/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/357/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1835/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/122/rebuild

review: Needs Fixing (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:558
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/131/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/391/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/389/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1879/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/131/rebuild

review: Needs Fixing (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:558
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/140/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/419/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/419/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1916/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/140/rebuild

review: Needs Fixing (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:558
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/149/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/444/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/444/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1945/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/149/rebuild

review: Needs Fixing (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:558
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/158/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/458/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/458/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1963/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/158/rebuild

review: Needs Fixing (continuous-integration)

Unmerged revisions

558. By Sergio Cazzolato on 2015-05-21

removing statements from with scope

557. By Sergio Cazzolato on 2015-05-15

LogHandlerTestCase removed, now using the FakeLogger as was suggested in the bug

=== modified file 'autopilot/tests/__init__.py'
--- autopilot/tests/__init__.py	2014-10-21 14:05:06 +0000
+++ autopilot/tests/__init__.py	2015-05-21 21:20:45 +0000
@@ -17,60 +17,4 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-import logging
-
-import testtools
-
-
-class LogHandlerTestCase(testtools.TestCase):
-
-    """A mixin that adds a memento loghandler for testing logging."""
-
-    class MementoHandler(logging.Handler):
-
-        """A handler class which stores logging records in a list."""
-
-        def __init__(self, *args, **kwargs):
-            """Create the instance, and add a records attribute."""
-            super().__init__(*args, **kwargs)
-            self.records = []
-
-        def emit(self, record):
-            """Just add the record to self.records."""
-            self.records.append(record)
-
-        def check(self, level, msg, check_traceback=False):
-            """Check that something is logged."""
-            result = False
-            for rec in self.records:
-                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."""
-        super().setUp()
-        self.memento_handler = self.MementoHandler()
-        self.root_logger = logging.getLogger()
-        self.root_logger.addHandler(self.memento_handler)
-
-    def tearDown(self):
-        """Remove the memento handler from the root logger."""
-        self.root_logger.removeHandler(self.memento_handler)
-        super().tearDown()
-
-    def assertLogLevelContains(self, level, message, check_traceback=False):
-        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)))
+

=== modified file 'autopilot/tests/functional/test_input_stack.py'
--- autopilot/tests/functional/test_input_stack.py	2015-05-08 04:32:51 +0000
+++ autopilot/tests/functional/test_input_stack.py	2015-05-21 21:20:45 +0000
@@ -17,7 +17,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-
+from fixtures import FakeLogger
 import json
 import logging
 import os
@@ -27,7 +27,8 @@
     IsInstance,
     Equals,
     raises,
-    GreaterThan
+    GreaterThan,
+    Contains
 )
 from testscenarios import TestWithScenarios
 from textwrap import dedent
@@ -366,7 +367,7 @@
             'window-mocker', window_spec_file, app_type='qt')
 
 
-class MouseTestCase(AutopilotTestCase, tests.LogHandlerTestCase):
+class MouseTestCase(AutopilotTestCase):
 
     @skipIf(platform.model() != "Desktop", "Only suitable on Desktop (Mouse)")
     def test_move_to_nonint_point(self):
@@ -396,13 +397,13 @@
 
     @skipIf(platform.model() != "Desktop", "Only suitable on Desktop (Mouse)")
     def test_mouse_move_must_log_final_position_at_debug_level(self):
-        self.root_logger.setLevel(logging.DEBUG)
+        log_format = "%(levelname)s:%(message)s"
         mouse = Mouse.create()
-        mouse.move(10, 10)
-        self.assertLogLevelContains(
-            'DEBUG',
-            "The mouse is now at position 10,10."
-        )
+
+        with FakeLogger(level=logging.DEBUG, format=log_format) as logger:
+            mouse.move(10, 10)
+
+        self.assertThat(logger.output, Contains("DEBUG:The mouse is now at position 10,10."))
 
 
 @skipIf(platform.model() != "Desktop", "Only suitable on Desktop (WinMocker)")

=== modified file 'autopilot/tests/unit/test_input.py'
--- autopilot/tests/unit/test_input.py	2015-03-22 06:20:40 +0000
+++ autopilot/tests/unit/test_input.py	2015-05-21 21:20:45 +0000
@@ -22,6 +22,7 @@
 import testscenarios
 from evdev import ecodes, uinput
 from unittest.mock import ANY, call, Mock, patch
+from fixtures import FakeLogger
 from testtools import TestCase
 from testtools.matchers import Contains, raises
 
@@ -425,7 +426,7 @@
         self.assert_expected_ev_abs('given_res_x', 'given_res_y', ev_abs)
 
 
-class UInputTouchDeviceTestCase(tests.LogHandlerTestCase):
+class UInputTouchDeviceTestCase(TestCase):
     """Test the integration with evdev.UInput for the touch device."""
 
     def setUp(self):
@@ -583,19 +584,16 @@
             touch, slot=first_slot, x=14, y=14)
 
     def test_finger_move_must_log_position_at_debug_level(self):
-        self.root_logger.setLevel(logging.DEBUG)
-        touch = self.get_touch_with_mocked_backend()
-        touch.finger_down(0, 0)
-
-        touch.finger_move(10, 10)
-        self.assertLogLevelContains(
-            'DEBUG',
-            "Moving pointing 'finger' to position 10,10."
-        )
-        self.assertLogLevelContains(
-            'DEBUG',
-            "The pointing 'finger' is now at position 10,10."
-        )
+
+        log_format = "%(levelname)s:%(message)s"
+
+        with FakeLogger(level=logging.DEBUG, format=log_format) as logger:
+            touch = self.get_touch_with_mocked_backend()
+            touch.finger_down(0, 0)
+            touch.finger_move(10, 10)
+
+            self.assertThat(logger.output, Contains("DEBUG:Moving pointing 'finger' to position 10,10."))
+            self.assertThat(logger.output, Contains("DEBUG:The pointing 'finger' is now at position 10,10."))
 
     def test_finger_up_without_finger_pressed_must_raise_error(self):
         touch = self.get_touch_with_mocked_backend()

=== modified file 'autopilot/tests/unit/test_logging.py'
--- autopilot/tests/unit/test_logging.py	2014-10-06 17:04:21 +0000
+++ autopilot/tests/unit/test_logging.py	2015-05-21 21:20:45 +0000
@@ -19,14 +19,14 @@
 
 import logging
 
+from fixtures import FakeLogger
+from testtools import TestCase
+from testtools.matchers import Contains
 from unittest.mock import Mock
-import testtools
 
-from autopilot import tests
 from autopilot.logging import log_action
 from autopilot._logging import TestCaseLoggingFixture
 
-
 class ObjectWithLogDecorator(object):
 
     @log_action(logging.info)
@@ -47,47 +47,48 @@
         pass
 
 
-class LoggingTestCase(tests.LogHandlerTestCase):
+class LoggingTestCase(TestCase):
 
     def setUp(self):
         super(LoggingTestCase, self).setUp()
-        self.root_logger.setLevel(logging.INFO)
         self.logged_object = ObjectWithLogDecorator()
+        self.log_format = "%(levelname)s:%(message)s"
 
     def test_logged_action_without_docstring(self):
-        self.logged_object.do_something_without_docstring(
-            'arg1', 'arg2', arg3='arg3', arg4='arg4')
-        self.assertLogLevelContains(
-            'INFO',
-            "ObjectWithLogDecorator: do_something_without_docstring. "
-            "Arguments ('arg1', 'arg2'). "
-            "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}.")
+        with FakeLogger(level=logging.INFO, format=self.log_format) as logger:
+            self.logged_object.do_something_without_docstring('arg1', 'arg2', arg3='arg3', arg4='arg4')
+
+        self.assertThat(logger.output, Contains("INFO:"
+                                                "ObjectWithLogDecorator: do_something_without_docstring. "
+                                                "Arguments ('arg1', 'arg2'). "
+                                                 "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}."))
 
     def test_logged_action_with_docstring(self):
-        self.logged_object.do_something_with_docstring(
-            'arg1', 'arg2', arg3='arg3', arg4='arg4')
-        self.assertLogLevelContains(
-            'INFO',
-            "ObjectWithLogDecorator: Do something with docstring. "
-            "Arguments ('arg1', 'arg2'). "
-            "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}.")
+        with FakeLogger(level=logging.INFO, format=self.log_format) as logger:
+            self.logged_object.do_something_with_docstring('arg1', 'arg2', arg3='arg3', arg4='arg4')
+
+        self.assertThat(logger.output, Contains("INFO:"
+                                                "ObjectWithLogDecorator: Do something with docstring. "
+                                                "Arguments ('arg1', 'arg2'). "
+                                                "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}."))
 
     def test_logged_action_with_multiline_docstring(self):
-        self.logged_object.do_something_with_multiline_docstring(
-            'arg1', 'arg2', arg3='arg3', arg4='arg4')
-        self.assertLogLevelContains(
-            'INFO',
-            "ObjectWithLogDecorator: "
-            "Do something with a multiline docstring. "
-            "Arguments ('arg1', 'arg2'). "
-            "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}.")
-
-
-class TestCaseLoggingFixtureTests(testtools.TestCase):
+        with FakeLogger(level=logging.INFO, format=self.log_format) as logger:
+            self.logged_object.do_something_with_multiline_docstring('arg1', 'arg2', arg3='arg3', arg4='arg4')
+
+        self.assertThat(logger.output, Contains("INFO:"
+                                                "ObjectWithLogDecorator: "
+                                                "Do something with a multiline docstring. "
+                                                "Arguments ('arg1', 'arg2'). "
+                                                "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}."))
+
+
+class TestCaseLoggingFixtureTests(TestCase):
 
     def test_test_log_is_added(self):
         token = self.getUniqueString()
         add_detail_fn = Mock()
+
         fixture = TestCaseLoggingFixture("Test.id", add_detail_fn)
         fixture.setUp()
         logging.getLogger(__name__).info(token)