Merge lp:~canonical-platform-qa/autopilot/add_osk_show_workaround into lp:autopilot

[Christopher Lee]

Add fixture that forces a gsetting for unity8 so that OSK is shown even when a UInput keyboard is present.

Add fixture that forces a gsetting for unity8 so that OSK is shown even when a UInput keyboard is present.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:569
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1115/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/45/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/44/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/45/console

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

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/autopilot/add_osk_show_workaround]

570. By Christopher Lee on 2015-07-16

Fix patch/mock import

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:570
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1116/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/46/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/45/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/46/console

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

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/autopilot/add_osk_show_workaround]

571. By Christopher Lee on 2015-07-16

Add build-dep for building in CI etc.

572. By Christopher Lee on 2015-07-16

Be explicit in gsettings path

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:572
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1117/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/47
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/47/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/46
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/46/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/47
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/47/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3437
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2863
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3434
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3434/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21897

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

review: Approve (continuous-integration)

=== modified file 'autopilot/_fixtures.py'
--- autopilot/_fixtures.py	2014-07-09 03:09:29 +0000
+++ autopilot/_fixtures.py	2015-07-16 03:26:52 +0000
@@ -18,6 +18,11 @@
 #
 
 from fixtures import Fixture
+import logging
+import subprocess
+
+
+logger = logging.getLogger(__name__)
 
 
 class FixtureWithDirectAddDetail(Fixture):
@@ -40,3 +45,65 @@
         """
         super().__init__()
         self.caseAddDetail = caseAddDetail or self.addDetail
+
+
+class OSKAlwaysEnabled(Fixture):
+    """Enable the OSK to be shown regardless of if there is a keyboard (virtual
+    or real) plugged in.
+
+    This is a workaround for bug lp:1474444
+
+    """
+
+    osk_schema = 'com.canonical.keyboard.maliit'
+    osk_show_key = 'stay-hidden'
+
+    def __init__(self):
+        super().__init__()
+        self._original_value = get_gsettings_value(
+            self.osk_schema,
+            self.osk_show_key
+        )
+
+    def setUp(self):
+        super().setUp()
+        set_gsettings_value(self.osk_schema, self.osk_show_key, 'false')
+        self.addCleanup(
+            set_gsettings_value,
+            self.osk_schema,
+            self.osk_show_key,
+            self._original_value
+        )
+
+
+def get_gsettings_value(schema, key):
+    """Return the output of gsettings get as a string or None if the call
+    fails.
+
+    """
+    command = ['/usr/bin/gsettings', 'get', schema, key]
+    try:
+        output = subprocess.check_output(
+            command,
+            stderr=subprocess.PIPE,
+            universal_newlines=True
+        )
+        return output.rstrip('\n')
+    except subprocess.CalledProcessError as e:
+        logger.warning(
+            'Failed to get gsettings value for {schema}/{key}: {error}'.format(
+                schema=schema, key=key, error=e.output
+            )
+        )
+
+
+def set_gsettings_value(schema, key, value):
+    command = ['/usr/bin/gsettings', 'set', schema, key, value]
+    try:
+        subprocess.check_output(command, stderr=subprocess.PIPE)
+    except subprocess.CalledProcessError as e:
+        logger.warning(
+            'Failed to set gsettings value {sch}/{key} to {v}: {error}'.format(
+                sch=schema, key=key, v=value, error=e.output
+            )
+        )

=== modified file 'autopilot/testcase.py'
--- autopilot/testcase.py	2015-07-15 21:18:42 +0000
+++ autopilot/testcase.py	2015-07-16 03:26:52 +0000
@@ -69,6 +69,7 @@
 from autopilot.platform import get_display_server
 from autopilot.process import ProcessManager
 from autopilot.utilities import deprecated, on_test_started
+from autopilot._fixtures import OSKAlwaysEnabled
 from autopilot._timeout import Timeout
 from autopilot._logging import TestCaseLoggingFixture
 from autopilot._video import get_video_recording_fixture
@@ -164,6 +165,11 @@
         self._display = None
         self._kb = Keyboard.create()
 
+        # Instatiate this after keyboard creation to ensure it doesn't get
+        # overwritten
+        # Workaround for bug lp:1474444
+        self.useFixture(OSKAlwaysEnabled())
+
         # Work around for bug lp:1297592.
         _ensure_uinput_device_created()
 

=== modified file 'autopilot/tests/unit/test_fixtures.py'
--- autopilot/tests/unit/test_fixtures.py	2014-07-09 03:04:46 +0000
+++ autopilot/tests/unit/test_fixtures.py	2015-07-16 03:26:52 +0000
@@ -19,16 +19,69 @@
 
 
 from testtools import TestCase
-
-from autopilot._fixtures import FixtureWithDirectAddDetail
+from testtools.matchers import (
+    Not,
+    Raises,
+)
+from unittest.mock import patch
+import autopilot._fixtures as ap_fixtures
 
 
 class FixtureWithDirectAddDetailTests(TestCase):
 
     def test_sets_caseAddDetail_method(self):
-        fixture = FixtureWithDirectAddDetail(self.addDetail)
+        fixture = ap_fixtures.FixtureWithDirectAddDetail(self.addDetail)
         self.assertEqual(fixture.caseAddDetail, self.addDetail)
 
     def test_can_construct_without_arguments(self):
-        fixture = FixtureWithDirectAddDetail()
+        fixture = ap_fixtures.FixtureWithDirectAddDetail()
         self.assertEqual(fixture.caseAddDetail, fixture.addDetail)
+
+
+class GSettingsAccessTests(TestCase):
+
+    def test_incorrect_schema_doesnt_raise_exception(self):
+        self.assertThat(
+            lambda: ap_fixtures.get_gsettings_value('foo', 'bar'),
+            Not(Raises())
+        )
+
+    def test_get_value_returns_expected_value(self):
+        with patch.object(ap_fixtures.subprocess, 'check_output') as check_out:
+            check_out.return_value = 'buzz'
+            self.assertEqual(
+                ap_fixtures.get_gsettings_value('foo', 'bar'),
+                'buzz'
+            )
+
+    def test_get_value_strips_newline(self):
+        with patch.object(ap_fixtures.subprocess, 'check_output') as check_out:
+            check_out.return_value = 'buzz\n'
+            self.assertEqual(
+                ap_fixtures.get_gsettings_value('foo', 'bar'),
+                'buzz'
+            )
+
+
+class OSKAlwaysEnabledTests(TestCase):
+
+    def test_sets_stayhidden_to_false(self):
+        with patch.object(ap_fixtures, 'set_gsettings_value') as set_gsetting:
+            with ap_fixtures.OSKAlwaysEnabled():
+                set_gsetting.assert_called_once_with(
+                    'com.canonical.keyboard.maliit',
+                    'stay-hidden',
+                    'false'
+                )
+
+    def test_resets_value_to_original(self):
+        with patch.object(ap_fixtures, 'set_gsettings_value') as set_gset:
+            with patch.object(ap_fixtures, 'get_gsettings_value') as get_gset:
+                get_gset.return_value = 'foo'
+                with ap_fixtures.OSKAlwaysEnabled():
+                    pass
+                set_gset.assert_called_with(
+                    'com.canonical.keyboard.maliit',
+                    'stay-hidden',
+                    'foo'
+                )

=== modified file 'debian/control'
--- debian/control	2015-03-18 17:24:48 +0000
+++ debian/control	2015-07-16 03:26:52 +0000
@@ -11,6 +11,7 @@
                gir1.2-ibus-1.0,
                gir1.2-ubuntu-app-launch-2 | gir1.2-upstart-app-launch-2,
                graphviz,
+               libglib2.0-bin,
                libjs-jquery,
                libjs-underscore,
                liblttng-ust-dev,