Merge lp:~canonical-platform-qa/ubuntu-keyboard/fix-1467449-autopilot-key-names into lp:ubuntu-keyboard

[Richard Huddie]

Add additional aliases for the action keys of the OSK used by the autopilot helpers.

Add additional aliases for the action keys of the OSK used by the autopilot helpers. This is to improve compatibility with the simulated keyboard.

New autopilot tests are added to test the key mappings and an existing un-reliable test has been updated to make it reliable and give a clean Jenkins run.

    Are there any related MPs required for this MP to build/function as expected? Please list.
        No.

    Is your branch in sync with latest trunk (e.g. bzr pull lp:trunk -> no changes)
        Yes.
    Did you perform an exploratory manual test run of your code change and any related functionality on device or emulator?
        Yes, new autopilot tests added.

    Did you successfully run all tests found in your component's Test Plan (https://wiki.ubuntu.com/Process/Merges/TestPlan/<package-name>) on device or emulator?
        Yes, all autopilot tests running and passing on device and jenkins.
    If you changed the UI, was the change specified/approved by design?
        No UI changes. Only autopilot changes.
    If you changed UI labels, did you update the pot file?
        No UI changes. Only autopilot changes.
    If you changed the packaging (debian), did you add a core-dev as a reviewer to this MP?
        No packaging changes.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:383
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/603/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3264
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/104
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/104
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/104/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/104
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2726
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3262
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3262/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21353

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

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Can you add a test for the new button mappings please, probably something in UbuntuKeyboardTypingTests.

review: Needs Fixing

[lp:~canonical-platform-qa/ubuntu-keyboard/fix-1467449-autopilot-key-names]

384. By Richard Huddie on 2015-06-24

Add new tests for key mappings. Also change TextField to TextArea to allow Return characters to be entered.

[Richard Huddie (rhuddie)]

I've added some new tests which test the custom key mappings. This also required me to change the TextField to a multi-line TextArea, so that Return characters could be entered.

[lp:~canonical-platform-qa/ubuntu-keyboard/fix-1467449-autopilot-key-names]

385. By Richard Huddie on 2015-06-24

Make the TextArea autosize, so the default is a single line.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:384
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/604/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3294
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/105
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/105
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/105/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/105
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2751
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3292
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3292/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21435

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:385
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/605/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3296
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/106
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/106
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/106/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/106
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2752
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3294
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3294/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21436

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:385
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/606/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3297/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/107
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/107
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/107/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/107
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2754/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3295
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3295/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21443

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:385
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/607/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3298
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/108
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/108
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/108/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/108
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2755
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3296
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3296/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21445

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

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/ubuntu-keyboard/fix-1467449-autopilot-key-names]

386. By Richard Huddie on 2015-06-24

Fix for unreliable ubuntu_keyboard.tests.test_keyboard.UbuntuKeyboardLanguageMenu.test_tapping

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:386
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/608/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3301
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/109
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/109
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/109/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/109
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2758
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3299
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3299/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21454

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

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looking good, good fix. Thanks for sorting out the tests.

review: Approve

[Sergio Cazzolato (sergio-j-cazzolato)]

Some questions inline

review: Needs Information

[lp:~canonical-platform-qa/ubuntu-keyboard/fix-1467449-autopilot-key-names]

387. By Richard Huddie on 2015-06-26

Fix review comments. Wait for plugin path to change after changing language rather than using sleep.

[Richard Huddie (rhuddie)]

Thanks Sergio, I've made updates to remove the sleeps, it will now wait for the keyboard plugin path to update instead.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:387
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/609/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3321
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/110
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/110
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/110/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/110
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2777
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3319
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3319/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21505

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

review: Approve (continuous-integration)

[Sergio Cazzolato (sergio-j-cazzolato)]

Minor comment

review: Needs Information

[Richard Huddie (rhuddie)]

Replied to comment inline.

[Sergio Cazzolato (sergio-j-cazzolato)]

review: Approve

[Michael Sheldon (michael-sheldon)]

Did you perform an exploratory manual test run of the code change and any related functionality on device or emulator?

 * Yes (ran autopilot tests on mako)

Did CI run pass? If not, please explain why.

 * Yes

Have you checked that submitter has accurately filled out the submitter checklist and has taken no shortcut?

 * Yes

review: Approve

=== modified file 'tests/autopilot/ubuntu_keyboard/emulators/keyboard.py'
--- tests/autopilot/ubuntu_keyboard/emulators/keyboard.py	2015-06-02 10:22:09 +0000
+++ tests/autopilot/ubuntu_keyboard/emulators/keyboard.py	2015-06-26 09:09:40 +0000
@@ -52,6 +52,10 @@
         '?123': 'symbols',
         ' ': 'space',
         '\n': 'return',
+        'Enter': 'return',
+        'Backspace': 'backspace',
+        'Space': 'space',
+        'Shift': 'shift',
     }
 
     __maliit = None
@@ -227,15 +231,20 @@
             or self._stored_active_keypad_name != self._current_keypad_name
         ):
             self._stored_active_keypad_name = self._current_keypad_name
-            loader = self.maliit.select_single(
-                "QQuickLoader",
-                objectName='characterKeyPadLoader'
-            )
             logger.debug("Keypad lookup")
-            self._active_keypad = loader.select_single(KeyPad)
+            self._active_keypad = self._keypad_loader.select_single(KeyPad)
         return self._active_keypad
 
     @property
+    def _keypad_loader(self):
+        return self.maliit.select_single(
+            "QQuickLoader", objectName='characterKeyPadLoader')
+
+    @property
+    def _plugin_source(self):
+        return self._keypad_loader.source
+
+    @property
     def _current_keypad_name(self):
         return self._keyboard_container.state
 

=== modified file 'tests/autopilot/ubuntu_keyboard/tests/test_keyboard.py'
--- tests/autopilot/ubuntu_keyboard/tests/test_keyboard.py	2015-05-29 12:23:52 +0000
+++ tests/autopilot/ubuntu_keyboard/tests/test_keyboard.py	2015-06-26 09:09:40 +0000
@@ -75,7 +75,7 @@
 
     def launch_test_input_area(self, label="", input_hints=None):
         self.app = self._launch_simple_input(label, input_hints)
-        text_area = self.app.select_single("QQuickTextInput")
+        text_area = self.app.select_single("TextArea")
 
         return text_area
 
@@ -155,11 +155,12 @@
                 }
             }
 
-            TextField {
+            TextArea {
                 id: input;
                 objectName: "input"
                 anchors.centerIn: parent
                 inputMethodHints: %(input_method)s
+                autoSize: true
             }
         }
 
@@ -174,7 +175,7 @@
         keyboard = Keyboard()
         self.addCleanup(keyboard.dismiss)
         app = self._launch_simple_input(input_hints=['Qt.ImhNoPredictiveText'])
-        text_rectangle = app.select_single("QQuickTextInput")
+        text_rectangle = app.select_single("TextArea")
 
         self.pointer.click_object(text_rectangle)
 
@@ -227,6 +228,133 @@
         self.assertThat(text_area.text, Eventually(Equals(self.input)))
 
 
+class UbuntuKeyboardKeyMappingTests(UbuntuKeyboardTests):
+
+    scenarios = [
+        (
+            'backspace',
+            dict(
+                starting_text='Start text',
+                input_sequence=['Backspace', '\b', 'backspace'],
+                expected_text=['Start tex', 'Start te', 'Start t']
+            )
+        ),
+        (
+            'space',
+            dict(
+                starting_text='',
+                input_sequence=['Space', ' ', 'space'],
+                expected_text=[' ', '  ', '   ']
+            )
+        ),
+        (
+            'return',
+            dict(
+                starting_text='',
+                input_sequence=['Enter', '\n', 'return'],
+                expected_text=['\n', '\n\n', '\n\n\n']
+            )
+        )
+    ]
+
+    def setUp(self):
+        super().setUp()
+        self._disable_double_space_full_stop()
+
+    def _disable_double_space_full_stop(self):
+        gsettings = Gio.Settings.new("com.canonical.keyboard.maliit")
+        gsettings.set_boolean("double-space-full-stop", False)
+
+    def test_can_type_using_key_mapping(self):
+        text_area = self.launch_test_input_area(
+            input_hints=['Qt.ImhNoPredictiveText'])
+        self.ensure_focus_on_input(text_area)
+        keyboard = Keyboard()
+        self.addCleanup(keyboard.dismiss)
+
+        keyboard.type(self.starting_text)
+        for key, result in zip(self.input_sequence, self.expected_text):
+            keyboard.press_key(key)
+            self.assertThat(text_area.text, Eventually(Equals(result)))
+
+
+class UbuntuKeyboardStateKeyMappingTests(UbuntuKeyboardTests):
+
+    scenarios = [
+        (
+            'Shift',
+            dict(
+                key='Shift',
+                expected_state=KeyPadState.SHIFTED,
+                expected_keypad_name='CHARACTERS'
+            )
+        ),
+        (
+            'SHIFT',
+            dict(
+                key='SHIFT',
+                expected_state=KeyPadState.SHIFTED,
+                expected_keypad_name='CHARACTERS'
+            )
+        ),
+        (
+            'shift',
+            dict(
+                key='shift',
+                expected_state=KeyPadState.SHIFTED,
+                expected_keypad_name='CHARACTERS'
+            )
+        ),
+        (
+            'ABC',
+            dict(
+                key='ABC',
+                expected_state=KeyPadState.NORMAL,
+                expected_keypad_name='SYMBOLS'
+            )
+        ),
+        (
+            '?123',
+            dict(
+                key='?123',
+                expected_state=KeyPadState.NORMAL,
+                expected_keypad_name='SYMBOLS'
+            )
+        ),
+        (
+            'symbols',
+            dict(
+                key='symbols',
+                expected_state=KeyPadState.NORMAL,
+                expected_keypad_name='SYMBOLS'
+            )
+        )
+    ]
+
+    def _assert_keypad_name_and_state(self, keyboard, name, state):
+        self.assertThat(
+            keyboard._current_keypad_name,
+            Eventually(Equals(name))
+        )
+        self.assertThat(
+            keyboard.active_keypad_state,
+            Eventually(Equals(state))
+        )
+
+    def test_can_type_using_state_key_mapping(self):
+        text_area = self.launch_test_input_area(
+            input_hints=['Qt.ImhNoPredictiveText', 'Qt.ImhNoAutoUppercase'])
+        self.ensure_focus_on_input(text_area)
+        keyboard = Keyboard()
+        self.addCleanup(keyboard.dismiss)
+        self._assert_keypad_name_and_state(keyboard,
+                                           'CHARACTERS', KeyPadState.NORMAL)
+        keyboard.press_key(self.key)
+        self._assert_keypad_name_and_state(keyboard,
+                                           self.expected_keypad_name,
+                                           self.expected_state)
+
+
 class UbuntuKeyboardStateChanges(UbuntuKeyboardTests):
 
     def test_keyboard_layout_starts_shifted(self):
@@ -897,31 +1025,47 @@
 
 class UbuntuKeyboardLanguageMenu(UbuntuKeyboardTests):
 
+    def setUp(self):
+        super().setUp()
+        self.gsettings = Gio.Settings.new("com.canonical.keyboard.maliit")
+
+    def _set_keyboard_language(self, language):
+        self.gsettings.set_string("active-language", language)
+
+    def _get_keyboard_language(self):
+        return self.gsettings.get_string("active-language")
+
+    def _get_plugin_path(self, language):
+        path = ("file:///usr/share/maliit/plugins/com/ubuntu/lib/{lang}/"
+                "Keyboard_{lang}.qml")
+        return path.format(lang=language)
+
     def test_tapping(self):
         """Tapping the language menu key should switch to the previously
         used language.
 
         """
-
         text_area = self.launch_test_input_area()
         self.ensure_focus_on_input(text_area)
         keyboard = Keyboard()
         self.addCleanup(keyboard.dismiss)
 
-        gsettings = Gio.Settings.new("com.canonical.keyboard.maliit")
-        self.assertThat(
-            gsettings.get_string("active-language"),
-            Equals('en')
-        )
+        # Make sure the previous language is es and the current language is en
+        self._set_keyboard_language("es")
+        self.assertThat(
+            keyboard._plugin_source,
+            Eventually(Equals(self._get_plugin_path("es"))))
+
+        self._set_keyboard_language("en")
+        self.assertThat(
+            keyboard._plugin_source,
+            Eventually(Equals(self._get_plugin_path("en"))))
 
         keyboard.press_key("language")
 
-        sleep(5)
-
         self.assertThat(
-            gsettings.get_string("active-language"),
-            Equals('es')
-        )
+            keyboard._plugin_source,
+            Eventually(Equals(self._get_plugin_path("es"))))
 
     def test_long_press(self):
         """Holding down the language menu key should switch display the
@@ -934,11 +1078,7 @@
         keyboard = Keyboard()
         self.addCleanup(keyboard.dismiss)
 
-        gsettings = Gio.Settings.new("com.canonical.keyboard.maliit")
-        self.assertThat(
-            gsettings.get_string("active-language"),
-            Equals('en')
-        )
+        self.assertThat(self._get_keyboard_language(), Equals("en"))
 
         keyboard.press_key("language", long_press=True)