Merge lp:~elopio/ubuntu-ui-toolkit/fix1248570-autopilot_check into lp:ubuntu-ui-toolkit

[Leo Arias]

Add a check for the autopilot version on the emulator init.

[lp:~elopio/ubuntu-ui-toolkit/fix1248570-autopilot_check]

825. By Leo Arias on 2013-11-06

Fixed typo. Added autospec to prevent it in the future.

[Cris Dywan (kalikiana)]

Nice!

It does still run through if the check fails resulting in 92 failures, which seems a little wasteful, but as it seems non-trivial to stop early let's leave it as-is. It's a clear failure unlike before which is what's important.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:825
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1170/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/532
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/520
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/118
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/118
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/118/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/491
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/532
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/532/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/520
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/520/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/2988
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/3170
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/1154
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/1153

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/ubuntu-ui-toolkit-ci/1170/rebuild

review: Approve (continuous-integration)

[Cris Dywan (kalikiana)]

See bug 1248634 for a feature request for autopilot to stop early.

=== modified file 'tests/autopilot/ubuntuuitoolkit/emulators.py'
--- tests/autopilot/ubuntuuitoolkit/emulators.py	2013-11-06 04:17:28 +0000
+++ tests/autopilot/ubuntuuitoolkit/emulators.py	2013-11-06 16:45:32 +0000
@@ -15,7 +15,9 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+from distutils import version
 
+import autopilot
 from autopilot import input, platform
 from autopilot.introspection import dbus
 
@@ -42,10 +44,24 @@
     return input.Pointer(device=input_device_class.create())
 
 
+def check_autopilot_version():
+    """Check that the Autopilot installed version matches the one required.
+
+    :raise ToolkitEmulatorException: If the installed Autopilot version does't
+        match the required by the emulators.
+
+    """
+    installed_version = version.LooseVersion(autopilot.version)
+    if installed_version < version.LooseVersion('1.4'):
+        raise ToolkitEmulatorException(
+            'The emulators need Autopilot 1.4 or higher.')
+
+
 class UbuntuUIToolkitEmulatorBase(dbus.CustomEmulatorBase):
     """A base class for all the Ubuntu UI Toolkit emulators."""
 
     def __init__(self, *args):
+        check_autopilot_version()
         super(UbuntuUIToolkitEmulatorBase, self).__init__(*args)
         self.pointing_device = get_pointing_device()
         # TODO it would be nice to have access to the screen keyboard if we are

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/test_emulators.py'
--- tests/autopilot/ubuntuuitoolkit/tests/test_emulators.py	2013-11-06 04:17:28 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/test_emulators.py	2013-11-06 16:45:32 +0000
@@ -18,12 +18,30 @@
 import time
 import unittest
 
+import autopilot
 from autopilot import input, platform
 from testtools.matchers import GreaterThan, LessThan
 
 from ubuntuuitoolkit import emulators, tests
 
 
+class CheckAutopilotVersionTestCase(unittest.TestCase):
+
+    def test_lower_version_should_raise_exception(self):
+        with mock.patch.object(autopilot, 'version', '1.3'):
+            self.assertRaises(
+                emulators.ToolkitEmulatorException,
+                emulators.check_autopilot_version)
+
+    def test_required_version_should_succeed(self):
+        with mock.patch.object(autopilot, 'version', '1.4'):
+            emulators.check_autopilot_version()
+
+    def test_higher_version_should_succeed(self):
+        with mock.patch.object(autopilot, 'version', '1.5'):
+            emulators.check_autopilot_version()
+
+
 class UbuntuUIToolkitEmulatorBaseTestCase(tests.QMLStringAppTestCase):
 
     def test_pointing_device(self):
@@ -37,6 +55,14 @@
     def test_pointing_device_in_phablet(self):
         self.assertIsInstance(self.app.pointing_device._device, input.Touch)
 
+    def test_emulators_should_check_version_on_init(self):
+        check_name = 'ubuntuuitoolkit.emulators.check_autopilot_version'
+        with mock.patch(check_name, autospec=True) as mock_check:
+            # Instantiate any emulator.
+            self.main_view
+
+        mock_check.assert_called_once_with()
+
 
 class MainViewTestCase(tests.QMLStringAppTestCase):