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

[Christopher Lee]

Resolves dependencies that not everyone cares about. Using Gio API instead of gsettings binary.

Resolves dependencies that not everyone cares about. Using Gio API instead of gsettings binary.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:569
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1124/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/54
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/54/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/53
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/53/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/54
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/54/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3469
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2887
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3466
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3466/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/22075

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

review: Approve (continuous-integration)

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

570. By Christopher Lee on 2015-07-23

Correct test

571. By Christopher Lee on 2015-07-23

Actually change setting now (needs to be bool, not string). test now passes.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:571
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1125/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/55
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-amd64-ci/55/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/54
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-armhf-ci/54/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/55
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-wily-i386-ci/55/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3471
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2889
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3468
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3468/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/22077

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

review: Approve (continuous-integration)

[Iain Lane (laney)]

OK, thanks!

Two minor comments

  - Recommends probably isn't that useful here since it isn't installed in many circumstances. I'd probably remove it and just ask consumers to install the package if they want this. They probably already have it if they are testing the osk anyway.
  - Do you need to upgrade gir1.2-glib-2.0 to Depends now? This isn't actually *that* important since python3-gi depends on it, but if you rely on something then it's best to have depends explicitly.

review: Approve

=== modified file 'autopilot/_fixtures.py'
--- autopilot/_fixtures.py	2015-07-16 03:26:31 +0000
+++ autopilot/_fixtures.py	2015-07-23 02:56:28 +0000
@@ -19,8 +19,7 @@
 
 from fixtures import Fixture
 import logging
-import subprocess
-
+from gi.repository import Gio
 
 logger = logging.getLogger(__name__)
 
@@ -58,52 +57,64 @@
     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
-            )
-        )
+
+        try:
+            _original_value = get_bool_gsettings_value(
+                self.osk_schema,
+                self.osk_show_key
+            )
+            set_bool_gsettings_value(
+                self.osk_schema,
+                self.osk_show_key,
+                False
+            )
+            self.addCleanup(
+                set_bool_gsettings_value,
+                self.osk_schema,
+                self.osk_show_key,
+                _original_value
+            )
+        except ValueError as e:
+            logger.warning('Failed to set OSK gsetting: {}'.format(e))
+
+
+def get_bool_gsettings_value(schema, key):
+    """Return the boolean value for schema/key combo.
+
+    :raises ValueError: If either ``schema`` or ``key`` are not valid.
+
+    """
+    setting = _gsetting_get_setting(schema, key)
+
+    return setting.get_boolean(key)
+
+
+def set_bool_gsettings_value(schema, key, value):
+    """Set the boolean value ``value`` for schema/key combo.
+
+    :raises ValueError: If either ``schema`` or ``key`` are not valid.
+
+    """
+
+    setting = _gsetting_get_setting(schema, key)
+
+    setting.set_boolean(key, value)
+
+
+def _gsetting_get_setting(schema, key):
+    if schema not in Gio.Settings.list_schemas():
+        raise ValueError('schema {} is not installed.'.format(schema))
+
+    setting = Gio.Settings.new(schema)
+
+    if key not in setting.keys():
+        raise ValueError(
+            'key \'{key}\' is not available for schema \'{schema}\''.format(
+                key=key,
+                schema=schema
+            )
+        )
+
+    return setting

=== modified file 'autopilot/tests/unit/test_fixtures.py'
--- autopilot/tests/unit/test_fixtures.py	2015-07-16 01:52:23 +0000
+++ autopilot/tests/unit/test_fixtures.py	2015-07-23 02:56:28 +0000
@@ -19,11 +19,8 @@
 
 
 from testtools import TestCase
-from testtools.matchers import (
-    Not,
-    Raises,
-)
-from unittest.mock import patch
+from testtools.matchers import raises
+from unittest.mock import patch, Mock
 import autopilot._fixtures as ap_fixtures
 
 
@@ -40,47 +37,51 @@
 
 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_incorrect_schema_raises_exception(self):
+        self.assertThat(
+            lambda: ap_fixtures._gsetting_get_setting('com.foo.', 'baz'),
+            raises(ValueError)
+        )
+
+    def test_incorrect_key_raises_exception(self):
+        self.assertThat(
+            lambda: ap_fixtures._gsetting_get_setting(
+                'org.gnome.system.locale',
+                'baz'
+            ),
+            raises(ValueError)
         )
 
     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'
+        with patch.object(ap_fixtures, '_gsetting_get_setting') as get_setting:
+            setting = Mock()
+            setting.get_boolean.return_value = True
+            get_setting.return_value = setting
+            self.assertEqual(
+                ap_fixtures.get_bool_gsettings_value('foo', 'bar'),
+                True
             )
 
 
 class OSKAlwaysEnabledTests(TestCase):
 
-    def test_sets_stayhidden_to_false(self):
-        with patch.object(ap_fixtures, 'set_gsettings_value') as set_gsetting:
+    @patch.object(ap_fixtures, '_gsetting_get_setting')
+    def test_sets_stayhidden_to_False(self, gs):
+        with patch.object(ap_fixtures, 'set_bool_gsettings_value') as set_gs:
             with ap_fixtures.OSKAlwaysEnabled():
-                set_gsetting.assert_called_once_with(
+                set_gs.assert_called_once_with(
                     'com.canonical.keyboard.maliit',
                     'stay-hidden',
-                    'false'
+                    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 patch.object(ap_fixtures, 'set_bool_gsettings_value') as set_gs:
+            with patch.object(ap_fixtures, 'get_bool_gsettings_value') as get_gs:  # NOQA
+                get_gs.return_value = 'foo'
                 with ap_fixtures.OSKAlwaysEnabled():
                     pass
-                set_gset.assert_called_with(
+                set_gs.assert_called_with(
                     'com.canonical.keyboard.maliit',
                     'stay-hidden',
                     'foo'

=== modified file 'debian/control'
--- debian/control	2015-07-16 03:24:34 +0000
+++ debian/control	2015-07-23 02:56:28 +0000
@@ -11,7 +11,6 @@
                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,
@@ -69,6 +68,7 @@
             python3-evdev,
             python3-xlib (>=0.14+20091101-1ubuntu3),
             recordmydesktop,
+            ubuntu-keyboard-data,
 Breaks: libautopilot-gtk (<< 1.4),
         libautopilot-qt (<< 1.4),
 Description: Utility to write and run integration tests easily (Python 3)