Merge lp:~sbaldassin/autopilot/fix_1671155 into lp:autopilot

[Santiago Baldassin]

Restoring backends order

Restoring the backends order so that existing applications running autopilot test cases in u7 can still work
Fixes: https://bugs.launchpad.net/ubuntu/+source/webbrowser-app/+bug/1671155

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

PASSED: Continuous integration, rev:593
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/168/
Executed test runs:
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/549
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/549/artifact/work/output/*zip*/output.zip
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/546
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/546/artifact/work/output/*zip*/output.zip
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2083/console

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

review: Approve (continuous-integration)

[Heber Parrucci (heber013)]

Code LGTM

review: Approve

[Richard Huddie (rhuddie)]

Confirm the fix is working. But what I have found is that when trying to create a keyboard on unity8, there is about 10 second delay in creating it whilst there is a check to try and get proxy object for maliit process for OSK. If OSK is below UInput in list this doesn't happen. But the OSK would then only be selected if specifically selected by preferred_backend parameter. Perhaps best fix would be to remove the timeout for getting the maliit proxy object so it would fail immediately?

You can reproduce this by doing following on unity8 with this fix installed:
$ python3
>>> from autopilot.input import Keyboard
>>> k = Keyboard().create()

review: Needs Information

[Santiago Baldassin (sbaldassin)]

Good catch Richard. I haven't been able to reproduce it though. I've added more logging to autopilot and this is what I get

>>> from autopilot.input import Keyboard
>>>
>>>
>>> k = Keyboard().create()
11:41:56.823493: Creating X11
11:41:56.914873: Creating OSK
11:41:56.988823: Creating UInput

The risk that I see is the same I've been pointing out when we decided to change the list order, there are people out there using autopilot and if we changed the default list order, we might impact them.

If someone, either ust, the web browser app or anyone else wants to avoid any failed attempt, they can use the preferred_backend option as you pointed out. In our case...

>>> k = Keyboard().create(preferred_backend='UInput')
11:44:14.934115: Creating UInput

[Richard Huddie (rhuddie)]

That is strange, you're on unity8? This is the output I get with similar logging, which shows the big gap between OSK and UInput:

>>> from autopilot.input import Keyboard
>>> k = Keyboard().create()
12:15:45.329685 Creating X11
12:15:45.331326 Creating OSK
12:15:56.319388 Creating UInput
>>> type(k)
<class 'autopilot.input._uinput.Keyboard'>

[lp:~sbaldassin/autopilot/fix_1671155]

594. By Santiago Baldassin on 2017-03-09

Adding unit tests

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

FAILED: Continuous integration, rev:594
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/169/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/555/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/552/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2097/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:594
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/170/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/556/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/553/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2098/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:594
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/171/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/557/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/554/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2099/console

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

review: Needs Fixing (continuous-integration)

[lp:~sbaldassin/autopilot/fix_1671155]

595. By Santiago Baldassin on 2017-03-09

Fixing flake8

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

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

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

review: Needs Fixing (continuous-integration)

[lp:~sbaldassin/autopilot/fix_1671155]

596. By Santiago Baldassin on 2017-03-09

Using unittest.mock.patch

[Richard Huddie (rhuddie)]

The 10 sec delay when creating the keyboard is triggered if you have the ubuntu-keyboard-autopilot helpers installed. If this is the case it will try to get the proxy object for maliit process, which has a 10 sec retry period. With ubuntu-keyboard-autopilot removed it doesn't attempt to create osk, in which case there is no delay.

So we would either need to move osk to bottom of list, in which case you would only get it if you asked for it with preferred_backend parameter, or to remove the timeout period on getting the maliit proxy object to make it fail with no delay.

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

FAILED: Continuous integration, rev:596
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/173/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/559/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/556/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2101/console

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

review: Needs Fixing (continuous-integration)

[lp:~sbaldassin/autopilot/fix_1671155]

597. By Santiago Baldassin on 2017-03-09

Fixing flake8 errors

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

PASSED: Continuous integration, rev:597
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/174/
Executed test runs:
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/560
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/560/artifact/work/output/*zip*/output.zip
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/557
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/557/artifact/work/output/*zip*/output.zip
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2102/console

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

review: Approve (continuous-integration)

[lp:~sbaldassin/autopilot/fix_1671155]

598. By Santiago Baldassin on 2017-03-10

Adding workaround to avoid delays

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

PASSED: Continuous integration, rev:598
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/175/
Executed test runs:
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/562
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/562/artifact/work/output/*zip*/output.zip
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/559
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/559/artifact/work/output/*zip*/output.zip
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2123/console

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

review: Approve (continuous-integration)

[Richard Huddie (rhuddie)]

Comment below.

review: Needs Fixing

[lp:~sbaldassin/autopilot/fix_1671155]

599. By Santiago Baldassin on 2017-03-10

Minor change

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

PASSED: Continuous integration, rev:599
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/176/
Executed test runs:
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/563
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/563/artifact/work/output/*zip*/output.zip
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/560
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/560/artifact/work/output/*zip*/output.zip
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2124/console

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

review: Approve (continuous-integration)

[Richard Huddie (rhuddie)]

Minor fix needed

review: Needs Fixing

[lp:~sbaldassin/autopilot/fix_1671155]

600. By Santiago Baldassin on 2017-03-13

Minor fix

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

PASSED: Continuous integration, rev:600
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/177/
Executed test runs:
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/565
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/565/artifact/work/output/*zip*/output.zip
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/562
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/562/artifact/work/output/*zip*/output.zip
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2129/console

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

review: Approve (continuous-integration)

[Richard Huddie (rhuddie)]

Looks good.

review: Approve

=== modified file 'autopilot/display/__init__.py'
--- autopilot/display/__init__.py	2016-11-22 13:12:14 +0000
+++ autopilot/display/__init__.py	2017-03-13 14:06:25 +0000
@@ -107,8 +107,8 @@
             return Display()
 
         backends = OrderedDict()
+        backends['X11'] = get_x11_display
         backends['UPA'] = get_upa_display
-        backends['X11'] = get_x11_display
         return _pick_backend(backends, preferred_backend)
 
     class BlacklistedDriverError(RuntimeError):

=== modified file 'autopilot/input/__init__.py'
--- autopilot/input/__init__.py	2016-11-22 12:42:52 +0000
+++ autopilot/input/__init__.py	2017-03-13 14:06:25 +0000
@@ -57,6 +57,9 @@
 
 from collections import OrderedDict
 from contextlib import contextmanager
+
+import psutil
+
 from autopilot.input._common import get_center_point
 from autopilot.utilities import _pick_backend, CleanupRegistered
 
@@ -119,16 +122,21 @@
 
         def get_osk_kb():
             try:
-                from autopilot.input._osk import Keyboard
-                return Keyboard()
+                maliit = [p for p in
+                          psutil.process_iter() if p.name() == 'maliit-server']
+                if maliit:
+                    from autopilot.input._osk import Keyboard
+                    return Keyboard()
+                else:
+                    raise RuntimeError('maliit-server is not running')
             except ImportError as e:
                 e.args += ("Unable to import the OSK backend",)
                 raise
 
         backends = OrderedDict()
+        backends['X11'] = get_x11_kb
+        backends['OSK'] = get_osk_kb
         backends['UInput'] = get_uinput_kb
-        backends['OSK'] = get_osk_kb
-        backends['X11'] = get_x11_kb
         return _pick_backend(backends, preferred_backend)
 
     @contextmanager

=== added file 'autopilot/tests/unit/test_display.py'
--- autopilot/tests/unit/test_display.py	1970-01-01 00:00:00 +0000
+++ autopilot/tests/unit/test_display.py	2017-03-13 14:06:25 +0000
@@ -0,0 +1,33 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Autopilot Functional Test Tool
+# Copyright (C) 2016 Canonical
+#
+# 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/>.
+#
+import unittest
+from unittest.mock import patch
+from autopilot.display import Display
+
+
+class DisplayTestCase(unittest.TestCase):
+
+    @patch('autopilot.display._pick_backend')
+    def test_input_backends_default_order(self, pick_backend):
+        d = Display()
+        d.create()
+
+        backends = list(pick_backend.call_args[0][0].items())
+        self.assertTrue(backends[0][0] == 'X11')
+        self.assertTrue(backends[1][0] == 'UPA')

=== modified file 'autopilot/tests/unit/test_input.py'
--- autopilot/tests/unit/test_input.py	2016-06-24 11:13:25 +0000
+++ autopilot/tests/unit/test_input.py	2017-03-13 14:06:25 +0000
@@ -18,6 +18,7 @@
 #
 
 import logging
+import unittest
 
 import testscenarios
 from evdev import ecodes, uinput
@@ -30,7 +31,7 @@
     tests,
     utilities
 )
-from autopilot.input import _uinput, get_center_point
+from autopilot.input import _uinput, get_center_point, Keyboard
 
 
 class Empty(object):
@@ -1101,3 +1102,16 @@
         self.assert_power_button_press_release_emitted_write_and_sync(
             device._device.mock_calls
         )
+
+
+class KeyboardTestCase(unittest.TestCase):
+
+    @patch('autopilot.input._pick_backend')
+    def test_input_backends_default_order(self, pick_backend):
+        k = Keyboard()
+        k.create()
+
+        backends = list(pick_backend.call_args[0][0].items())
+        self.assertTrue(backends[0][0] == 'X11')
+        self.assertTrue(backends[1][0] == 'OSK')
+        self.assertTrue(backends[2][0] == 'UInput')