Merge lp:~sil2100/unity/autopilot_ibus_improve into lp:unity

[Łukasz Zemczak]

Improve IBus autopilot tests.
With these improvements, asian characters do not need to be hardcoded in the tests anymore. Now, the 'expected' values are taken directly from IBus before each test. We're doing it by using a separate input context and storing it for comparison. Using the existing input context was buggy, so this seemed like the best way to go otherwise.
To do this, I had to work-around the new IBus bindings from GIR, since create_input_context() - which was needed, was not introspectable.

- Problem:

IBus tests are failing frequently. The reason is that we have hard-coded result values for IBus testing, where the results are not always the same - depending on search history and the ibus version. We also cannot easily clear the history.

- Fix:

My proposed fix is: let's poll (query) IBus with the input string, fetch the resulting string, and then start the standard IBus test and check the search entry text against it. We don't want to test IBus accuracy in our integration tests. We want to test if IBus integration works - if when IBus is enabled, that the input fields will have characters coming from IBus. That's why, we just compare if what we get on the search field is what IBus should return.

We do this by creating a new (separate) input context, feed it with the same input and fetch the resulting, committed strings as results. Best way of course would be to simply hook up to the existing input context of nux and the dash and just 'listen in' - this would be the *perfect* solution. Sadly, that didn't seem to be possible, as hooking up on the existing input context's signals did not work. Too bad...

So, this solution seems sufficient. It has some backsides, but in overall it should *finally* fix IBus tests.

Also, well, there are some hacks here too. The problem was - I could not use the old IBus bindings because of the glib version mismatching. The new bindings from GIR, well, those didn't allow introspection of create_input_context method in IBus.Bus(). So, to workaround that, I had to directly do all the things that normally create_input_context() would do. But it works!

- Tests:

N/A

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

First, when running the tests, I get:

/tmp/autopilot_ibus_improve/tests/autopilot/unity/tests/test_ibus.py:48: PyGIDeprecationWarning: MainLoop is deprecated; use GLib.MainLoop instead
  self._glibloop = GObject.MainLoop()

(autopilot:15226): IBUS-WARNING **: org.freedesktop.IBus.InputContext.GetEngine: GDBus.Error:org.freedesktop.IBus.Error.NoEngine: Input context does not have engine.
/tmp/autopilot_ibus_improve/tests/autopilot/unity/tests/test_ibus.py:79: PyGIDeprecationWarning: timeout_add_seconds is deprecated; use GLib.timeout_add_seconds instead
  GObject.timeout_add_seconds(10, lambda *args: self._glibloop.quit())

So we should fix that. Seconf, they enter an endless loop where they constantly print:

(autopilot:15226): IBUS-WARNING **: org.freedesktop.IBus.InputContext.GetEngine: GDBus.Error:org.freedesktop.DBus.Error.UnknownMethod: No such interface `org.freedesktop.IBus.InputContext' on object at path /org/freedesktop/IBus/InputContext_58

so I can't actually run the tests to verify that they work as expected.

review: Needs Fixing

[Łukasz Zemczak (sil2100)]

Thanks for checking it out! I will look on what's wrong tomorrow, maybe it has something to do that I'm using quantal for testing - maybe raring has different things going on.

[Łukasz Zemczak (sil2100)]

Actually! I even came up now with a better idea of dealing with this, I'll try it out tomorrow in the morning (I just ran out of my bed because of this idea ;) ). Maybe we'll be able to deal it without having to create a new input context!

[Łukasz Zemczak (sil2100)]

Fixed the GObject thing. Sorry about that!

Ok, so, I looked at the existing code...

Thomi, are you sure you have a clean, working ibus environment? All tests work correctly for me and Francis, both on quantal and raring. I also checked the differences between the ibus in quantal and raring and nothing changed regarding this matter. So I have no idea why you get the errors. Is your ibus installation correct? Are the engines installed?

Anyway, even in the working case one (autopilot:15226): IBUS-WARNING **: org.freedesktop.IBus.InputContext.GetEngine warning will be noticable most of the time. This is because I didn't want to do any time.sleep() waits until the engine is set - and IBus prints a warning when a get_engine() is done with no engine set. We use that to make sure that the engine finally gets set.

Can you re-try on a clean raring or quantal system with ibus installed?

[Łukasz Zemczak (sil2100)]

Ok, so, after the fixes I made now, anthy tests pass properly every time. With hangul, well, it's still broken. I think we'll have to use hard-coded values for hangul still... :( That's because hangul seems to be written in a strange way that I don't get any text (the argument is empty) during update-preedit-text signals. Still asking the IBus guys about it.

[Thomi Richards (thomir-deactivatedaccount)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/443/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/./build=pbuilder,distribution=raring,flavor=amd64/443/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/./build=pbuilder,distribution=raring,flavor=i386/443/console

review: Needs Fixing (continuous-integration)

[Francis Ginther (fginther)]

Build failed due to a launchpad service issue. Re-approving.

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/444/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/./build=pbuilder,distribution=raring,flavor=amd64/444/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/./build=pbuilder,distribution=raring,flavor=i386/444/console

review: Needs Fixing (continuous-integration)

=== modified file 'tests/autopilot/unity/tests/test_ibus.py'
--- tests/autopilot/unity/tests/test_ibus.py	2013-02-04 19:54:47 +0000
+++ tests/autopilot/unity/tests/test_ibus.py	2013-02-22 19:04:23 +0000
@@ -1,6 +1,6 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 # Copyright 2012 Canonical
-# Author: Thomi Richards, Martin Mrazik
+# Authors: Thomi Richards, Martin Mrazik, Łukasz 'sil2100' Zemczak
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -23,6 +23,84 @@
 
 from unity.tests import UnityTestCase
 
+from gi.repository import GLib
+from gi.repository import IBus
+import time
+import dbus
+import threading
+
+
+# See lp:ibus-query
+class IBusQuery:
+    """A simple class allowing string queries to the IBus engine."""
+
+    def __init__(self):
+        self._bus = IBus.Bus()
+        self._dbusconn = dbus.connection.Connection(IBus.get_address())
+
+        # XXX: the new IBus bindings do not export create_input_context for
+        #  introspection. This is troublesome - so, to workaround this problem
+        #  we're directly fetching a new input context manually
+        ibus_obj = self._dbusconn.get_object(IBus.SERVICE_IBUS, IBus.PATH_IBUS)
+        self._test = dbus.Interface(ibus_obj, dbus_interface="org.freedesktop.IBus")
+        path = self._test.CreateInputContext("IBusQuery")
+        self._context = IBus.InputContext.new(path, self._bus.get_connection(), None)
+
+        self._glibloop = GLib.MainLoop()
+
+        self._context.connect("commit-text", self.__commit_text_cb)
+        self._context.connect("update-preedit-text", self.__update_preedit_cb)
+        self._context.connect("disabled", self.__disabled_cb)
+
+        self._context.set_capabilities (9)
+
+    def __commit_text_cb(self, context, text):
+        self.result += text.text
+        self._preedit = ''
+
+    def __update_preedit_cb(self, context, text, cursor_pos, visible):
+        if visible:
+            self._preedit = text.text
+
+    def __disabled_cb(self, a):
+        self.result += self._preedit
+        self._glibloop.quit()
+
+    def __abort(self):
+        self._abort = True
+
+    def poll(self, engine, ibus_input):
+        if len(ibus_input) <= 0:
+            return None
+
+        self.result = ''
+        self._preedit = ''
+        self._context.focus_in()
+        self._context.set_engine(engine)
+
+        # Timeout in case of the engine not being installed
+        self._abort = False
+        timeout = threading.Timer(4.0, self.__abort)
+        timeout.start()
+        while self._context.get_engine() is None:
+            if self._abort is True:
+                print "Error! Could not set the engine correctly."
+                return None
+            continue
+        timeout.cancel()
+
+        for c in ibus_input:
+            self._context.process_key_event(ord(c), 0, 0)
+
+        self._context.set_engine('')
+        self._context.focus_out()
+
+        GLib.timeout_add_seconds(5, lambda *args: self._glibloop.quit())
+        self._glibloop.run()
+
+        return unicode(self.result, "UTF-8")
+
+
 
 class IBusTests(UnityTestCase):
     """Base class for IBus tests."""
@@ -30,6 +108,7 @@
     def setUp(self):
         super(IBusTests, self).setUp()
         self.set_correct_ibus_trigger_keys()
+        self._ibus_query = None
 
     def set_correct_ibus_trigger_keys(self):
         """Set the correct keys to trigger IBus.
@@ -68,6 +147,8 @@
 
         """
         available_engines = get_available_input_engines()
+        if self._ibus_query is None:
+            self._ibus_query = IBusQuery()
         if engine_name in available_engines:
             if get_active_input_engines() != [engine_name]:
                 IBusTests._old_engines = set_active_engines([engine_name])
@@ -98,6 +179,11 @@
 
     def do_ibus_test(self):
         """Do the basic IBus test on self.widget using self.input and self.result."""
+        try:
+            result = self.result
+        except:
+            result = self._ibus_query.poll(self.engine_name, self.input)
+
         widget = getattr(self.unity, self.widget)
         widget.ensure_visible()
         self.addCleanup(widget.ensure_hidden)
@@ -107,7 +193,7 @@
         if commit_key:
             self.keyboard.press_and_release(commit_key)
         self.deactivate_ibus(widget.searchbar)
-        self.assertThat(widget.search_string, Eventually(Equals(self.result)))
+        self.assertThat(widget.search_string, Eventually(Equals(result)))
 
 
 
@@ -119,11 +205,11 @@
     scenarios = multiply_scenarios(
         IBusWidgetScenariodTests.scenarios,
         [
-            ('basic', {'input': 'abc1', 'result': u'\u963f\u5e03\u4ece'}),
-            ('photo', {'input': 'zhaopian ', 'result': u'\u7167\u7247'}),
-            ('internet', {'input': 'hulianwang ', 'result': u'\u4e92\u8054\u7f51'}),
-            ('disk', {'input': 'cipan ', 'result': u'\u78c1\u76d8'}),
-            ('disk_management', {'input': 'cipan guanli ', 'result': u'\u78c1\u76d8\u7ba1\u7406'}),
+            ('basic', {'input': 'abc1'}),
+            ('photo', {'input': 'zhaopian '}),
+            ('internet', {'input': 'hulianwang '}),
+            ('disk', {'input': 'cipan '}),
+            ('disk_management', {'input': 'cipan guanli '}),
         ]
     )
 
@@ -165,9 +251,9 @@
     scenarios = multiply_scenarios(
         IBusWidgetScenariodTests.scenarios,
         [
-            ('system', {'input': 'shisutemu ', 'result': u'\u30b7\u30b9\u30c6\u30e0'}),
-            ('game', {'input': 'ge-mu ', 'result': u'\u30b2\u30fc\u30e0'}),
-            ('user', {'input': 'yu-za- ', 'result': u'\u30e6\u30fc\u30b6\u30fc'}),
+            ('system', {'input': 'shisutemu '}),
+            ('game', {'input': 'ge-mu '}),
+            ('user', {'input': 'yu-za- '}),
         ],
         [
             ('commit_j', {'commit_key': 'Ctrl+j'}),