Merge lp:~canonical-platform-qa/ubuntu-ui-toolkit/textfield-use-osk into lp:ubuntu-ui-toolkit

[Richard Huddie]

Use the OSK in text fields to enter text.

Use the OSK in text fields to enter text.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1198
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/2209/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3081/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-vivid-amd64-ci/33/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-vivid-armhf-ci/33/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3079/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/2209/rebuild

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/ubuntu-ui-toolkit/textfield-use-osk]

1199. By Richard Huddie on 2015-06-04

Disable osk input helpers and validate text rather than displayText.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1199
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/2210/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3085/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-vivid-amd64-ci/34/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-vivid-armhf-ci/34/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3083/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/2210/rebuild

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/ubuntu-ui-toolkit/textfield-use-osk]

1200. By Leo Arias on 2015-06-04

Merged with staging.

1201. By Leo Arias on 2015-06-04

Reverted the po changes.

1202. By Leo Arias on 2015-06-04

Reverted the po changes.

1203. By Richard Huddie on 2015-06-05

Delay import in _go_to_end() until it is needed.

1204. By Richard Huddie on 2015-06-05

Use activeFocus instead of focus property.

1205. By Richard Huddie on 2015-06-08

Fix flake8 by using ToolkitException.

1206. By Richard Huddie on 2015-06-08

Docstring fix.

1207. By Richard Huddie on 2015-06-11

Fix test_textinput tests to use correct textfield.write() method rather than directly calling keyboard.type().

1208. By Richard Huddie on 2015-06-11

Only run test which uses shift+left key combination on desktop.

1209. By Richard Huddie on 2015-06-12

Merge with staging branch.

1210. By Richard Huddie on 2015-06-12

Fix for textarea and test_textinput failing tests.

1211. By Richard Huddie on 2015-06-17

Fixes for failing tests. Also wait 5 seconds after re-launching maliit-server to allow it to be ready.

1212. By Richard Huddie on 2015-06-17

Merge from staging branch.

1213. By Richard Huddie on 2015-06-18

Fix review comments. Also don't enforce en language, re-enable test_clear_with_clear_button as prediction is now set off.

1214. By Richard Huddie on 2015-06-18

Merge from staging branch.

1215. By Richard Huddie on 2015-06-19

Set the osk language to en.

Unmerged revisions

=== modified file 'debian/control'
--- debian/control	2015-05-20 15:36:55 +0000
+++ debian/control	2015-06-04 11:35:43 +0000
@@ -147,6 +147,7 @@
          python3-autopilot (>= 1.4),
          python3-autopilot-trace,
          qttestability-autopilot,
+         ubuntu-keyboard-autopilot,
          ubuntu-ui-toolkit-examples (>= ${source:Version}),
          upstart,
          qtdeclarative5-ubuntu-ui-toolkit-plugin (>= ${source:Version}) | qtdeclarative5-ubuntu-ui-toolkit-plugin-gles,

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py	2015-04-14 21:02:06 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py	2015-06-04 11:35:43 +0000
@@ -17,7 +17,9 @@
 """Common helpers for Ubuntu UI Toolkit Autopilot custom proxy objects."""
 
 import logging
+import subprocess
 from distutils import version
+from gi.repository import Gio
 
 import autopilot
 from autopilot import (
@@ -27,9 +29,10 @@
 )
 from autopilot.introspection import dbus
 
-
 logger = logging.getLogger(__name__)
 
+MALIIT = 'maliit-server'
+
 
 class ToolkitException(Exception):
     """Exception raised when there is an error with the custom proxy object."""
@@ -51,8 +54,135 @@
 
 def get_keyboard():
     """Return the keyboard device."""
-    # TODO return the OSK if we are on the phone. --elopio - 2014-01-13
-    return input.Keyboard.create()
+    if is_process_running(MALIIT):
+        configure_osk_settings()
+        restart_maliit_with_testability()
+        return input.Keyboard.create('OSK')
+    else:
+        return input.Keyboard.create()
+
+
+def restart_maliit_with_testability():
+    """Restart maliit-server with testability enabled."""
+    if is_process_running(MALIIT):
+        pid = get_process_pid(MALIIT)
+        if _is_testability_enabled_for_process(pid):
+            return
+        _stop_process(MALIIT)
+    _start_process(MALIIT, 'QT_LOAD_TESTABILITY=1')
+
+
+def configure_osk_settings():
+    """Configure OSK ready for testing by turning off all helpers."""
+    gsettings = Gio.Settings.new("com.canonical.keyboard.maliit")
+    gsettings.set_string("active-language", "en")
+    gsettings.set_boolean("auto-capitalization", False)
+    gsettings.set_boolean("auto-completion", False)
+    gsettings.set_boolean("predictive-text", False)
+    gsettings.set_boolean("spell-checking", False)
+    gsettings.set_boolean("double-space-full-stop", False)
+
+
+def _is_testability_enabled_for_process(pid):
+    """Return True if testability is enabled for specified process."""
+    proc_env = '/proc/{pid}/environ'.format(pid=pid)
+    command = ['cat', proc_env]
+    try:
+        output = subprocess.check_output(
+            command,
+            stderr=subprocess.STDOUT,
+            universal_newlines=True,
+        )
+    except subprocess.CalledProcessError as e:
+        e.args += ('Failed to get environment for pid {}: {}.'.format(
+            pid, e.output),)
+        raise
+    return output.find('QT_LOAD_TESTABILITY=1') >= 0
+
+
+def _stop_process(proc_name):
+    """Stop process with name proc_name."""
+    logger.info('Stoping process {}.'.format(proc_name))
+    command = ['/sbin/initctl', 'stop', proc_name]
+    try:
+        output = subprocess.check_output(
+            command,
+            stderr=subprocess.STDOUT,
+            universal_newlines=True,
+        )
+        logger.info(output)
+    except subprocess.CalledProcessError as e:
+        e.args += ('Failed to stop {}: {}.'.format(proc_name, e.output),)
+        raise
+
+
+def _start_process(proc_name, *args):
+    """Start a process.
+
+    :param proc_name: The name of the process.
+    :param args: The arguments to be used when starting the job.
+    :return: The process id of the started job.
+    :raises CalledProcessError: if the job failed to start.
+
+    """
+    logger.info('Starting job {} with arguments {}.'.format(proc_name, args))
+    command = ['/sbin/initctl', 'start', proc_name] + list(args)
+    try:
+        output = subprocess.check_output(
+            command,
+            stderr=subprocess.STDOUT,
+            universal_newlines=True,
+        )
+        logger.info(output)
+        pid = get_process_pid(proc_name)
+    except subprocess.CalledProcessError as e:
+        e.args += ('Failed to start {}: {}.'.format(proc_name, e.output),)
+        raise
+    else:
+        return pid
+
+
+def get_process_pid(proc_name):
+    """Return the process id of a running job.
+
+    :param str name: The name of the job.
+    :raises JobError: if the job is not running.
+
+    """
+    status = get_process_status(proc_name)
+    if "start/" not in status:
+        raise JobError('{} is not in the running state.'.format(proc_name))
+    return int(status.split()[-1])
+
+
+def get_process_status(name):
+    """
+    Return the status of a process.
+
+    :param str name: The name of the process.
+    :raises JobError: if it's not possible to get the status of the job.
+
+    """
+    try:
+        return subprocess.check_output([
+            '/sbin/initctl',
+            'status',
+            name
+        ], universal_newlines=True)
+    except subprocess.CalledProcessError as error:
+        raise JobError(
+            "Unable to get {}'s status: {}".format(name, error)
+        )
+
+
+def is_process_running(name):
+    """Return True if the process is running. Otherwise, False.
+
+    :param str name: The name of the process.
+    :raises JobError: if it's not possible to get the status of the process.
+
+    """
+    return 'start/' in get_process_status(name)
 
 
 def check_autopilot_version():

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_textfield.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_textfield.py	2015-04-14 21:02:06 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_textfield.py	2015-06-04 11:35:43 +0000
@@ -16,17 +16,13 @@
 
 import logging
 
-from autopilot import (
-    logging as autopilot_logging,
-    platform
-)
+from autopilot import logging as autopilot_logging
 
 from ubuntuuitoolkit._custom_proxy_objects import (
     _common,
     _mainview
 )
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -47,18 +43,18 @@
             of the text field. Default is True.
 
         """
-        with self.keyboard.focused_type(self):
-            self.focus.wait_for(True)
-            if clear:
-                self.clear()
-            else:
-                if not self.is_empty():
-                    self.keyboard.press_and_release('End')
-            self.keyboard.type(text)
+        self._ensure_focused()
+        if clear:
+            self.clear()
+        else:
+            if not self.is_empty():
+                self._go_to_end()
+        self.keyboard.type(text)
 
     @autopilot_logging.log_action(logger.info)
     def clear(self):
         """Clear the text field."""
+        self._ensure_focused()
         if not self.is_empty():
             if self.hasClearButton:
                 self._click_clear_button()
@@ -80,16 +76,16 @@
 
     @autopilot_logging.log_action(logger.debug)
     def _clear_with_keys(self):
-        if platform.model() == 'Desktop':
-            self._select_all()
-            self.keyboard.press_and_release('BackSpace')
-        else:
+        if self._is_keyboard_osk():
             # Touch tap currently doesn't have a press_duration parameter, so
             # we can't select all the text.
             # Reported as bug http://pad.lv/1268782 --elopio - 2014-01-13
             self._go_to_end()
-            while self.cursorPosition != 0:
-                self._delete_one_character()
+            while self.text != '':
+                self._delete_one_character_using_osk()
+        else:
+            self._select_all()
+            self.keyboard.press_and_release('BackSpace')
         if not self.is_empty():
             raise _common.ToolkitException('Failed to clear the text field.')
 
@@ -107,17 +103,33 @@
     def _is_all_text_selected(self):
         return self.text == self.selectedText
 
+    def _is_keyboard_osk(self):
+        """Return True if the keyboard instance is the OSK."""
+        from autopilot.input import _osk
+        return isinstance(self.keyboard, _osk.Keyboard)
+
     @autopilot_logging.log_action(logger.debug)
     def _go_to_end(self):
-        # XXX Here we are cheating because the on-screen keyboard doesn't have
-        # an END key. --elopio - 2014-08-20
-        self.keyboard.press_and_release('End')
+        from autopilot import input
+        if self._is_keyboard_osk():
+            # XXX Here we are cheating because the on-screen keyboard doesn't
+            # have an END key. --elopio - 2014-08-20
+            keyboard = input.Keyboard.create()
+            keyboard.press_and_release('End')
+        else:
+            self.keyboard.press_and_release('End')
 
     @autopilot_logging.log_action(logger.debug)
-    def _delete_one_character(self):
+    def _delete_one_character_using_osk(self):
         original_text = self.text
         # We delete with backspace because the on-screen keyboard has
         # that key.
-        self.keyboard.press_and_release('BackSpace')
+        self.keyboard.press_and_release('backspace')
         if len(self.text) != len(original_text) - 1:
             raise _common.ToolkitException('Failed to delete one character.')
+
+    @autopilot_logging.log_action(logger.debug)
+    def _ensure_focused(self):
+        if not self.focus:
+            self.pointing_device.click_object(self)
+            self.focus.wait_for(True)

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_textfield.py'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_textfield.py	2015-04-14 21:02:06 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_textfield.py	2015-06-04 11:35:43 +0000
@@ -17,6 +17,7 @@
 from unittest import mock
 
 from autopilot import platform
+from testtools import skipUnless
 
 import ubuntuuitoolkit
 from ubuntuuitoolkit import tests
@@ -61,6 +62,9 @@
         self.simple_text_field.write('test')
         self.assertEqual(self.simple_text_field.text, 'test')
 
+    @skipUnless(platform.model() == 'Desktop',
+                'Due to launchpad.net/bugs/1461571 this only runs on desktop.')
+    # Once launchpad.net/bugs/1461571 is fixed this will work on touch.
     def test_clear_with_clear_button(self):
         self.simple_text_field.write('test')
         self.simple_text_field.clear()