Merge lp:~brandontschaefer/unity/ap-hud-fixes-cjk-ibus into lp:unity

[Brandon Schaefer]

* Adds CJK autopilot test for the Hud

This adds CJK test for the Hud.

[Brandon Schaefer (brandontschaefer)]

This adds CJK test for the Hud.

[Thomi Richards (thomir)]

In diff line 8:

Please just grab the controller instances, and do the assert and assignment from the list, like so:

controllers = DashController.get_all_instances()
assert(len(controllers) == 1)
self.controller = controllers[0]

...you'll notice my assert is more explicit than yours as well. This pattern should be repeated for the Hud class.

I'm not sure where the EmbeddedIcon class ended up, but it should go in icons.py, and it should derive from SimpleLauncherIcon.

In the Hud class, the call to 'super(Hud, self).__init__()' should happen first, before anything else.

Apart from this, the tests look good. I have a feeling we can simplify these tests a lot, especially with the use of some more test scenarios, but I'm happy to merge the code with the fixes mentioned above.

review: Needs Fixing

[lp:~brandontschaefer/unity/ap-hud-fixes-cjk-ibus]

2195. By Brandon Schaefer on 2012-03-30

* Fixed ap problems!

2196. By Brandon Schaefer on 2012-03-30

* Merged with trunk, and fixed an ap error I commited

[Brandon Schaefer (brandontschaefer)]

Ran 42 tests in 158.498s
OK

All Hud ap test pass.

[Thomi Richards (thomir)]

review: Approve

=== modified file 'tests/autopilot/autopilot/emulators/unity/dash.py'
--- tests/autopilot/autopilot/emulators/unity/dash.py	2012-03-20 01:06:00 +0000
+++ tests/autopilot/autopilot/emulators/unity/dash.py	2012-03-30 20:12:24 +0000
@@ -29,10 +29,12 @@
     """
 
     def __init__(self):
-        self.controller = DashController.get_all_instances()[0]
+        super(Dash, self).__init__()
 
+        controllers = DashController.get_all_instances()
+        assert(len(controllers) == 1)
+        self.controller = controllers[0]
         self._keyboard = Keyboard()
-        super(Dash, self).__init__()
 
     @property
     def view(self):

=== modified file 'tests/autopilot/autopilot/emulators/unity/hud.py'
--- tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-30 04:00:05 +0000
+++ tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-30 20:12:24 +0000
@@ -10,71 +10,81 @@
 from autopilot.keybindings import KeybindingsHelper
 from autopilot.emulators.unity import UnityIntrospectionObject
 from autopilot.emulators.unity.dash import SearchBar
-
-
-class HudView(UnityIntrospectionObject):
-    """Proxy object for the hud view child of the controller."""
-  
-    @property
-    def searchbar(self):
-        """Get the search bar attached to this hud view."""
-        return self.get_children_by_type(SearchBar)[0]
-
-    @property
-    def geometry(self):
-        return (self.x, self.y, self.width, self.height)
-
-class EmbeddedIcon(UnityIntrospectionObject):
-    """Proxy object for the hud embedded icon child of the view."""
-
-    @property
-    def geometry(self):
-        return (self.x, self.y, self.width, self.height)
-
-class HudController(UnityIntrospectionObject, KeybindingsHelper):
-    """Proxy object for the Unity Hud Controller."""
+from autopilot.emulators.unity.icons import EmbeddedIcon
+
+class Hud(KeybindingsHelper):
+    """An emulator class that makes it easier to iteract with unity hud."""
+    
+    def __init__(self):
+        super (Hud, self).__init__()
+        
+        controllers = HudController.get_all_instances()  
+        assert(len(controllers) == 1)
+        self.controller = controllers[0]
 
     def ensure_hidden(self):
         """Hides the hud if it's not already hidden."""
-        if self.is_visible():
+        if self.visible:
             self.toggle_reveal()
 
     def ensure_visible(self):
         """Shows the hud if it's not already showing."""
-        if not self.is_visible():
+        if not self.visible:
             self.toggle_reveal()
 
-    def is_visible(self):
-        return self.visible
-
     def toggle_reveal(self, tap_delay=0.1):
         """Tap the 'Alt' key to toggle the hud visibility."""
         self.keybinding("hud/reveal", tap_delay)
 
     def get_embedded_icon(self):
         """Returns the HUD view embedded icon or None if is not shown."""
-        view = self._get_view()
+        view = self.view
         if (not view):
-            return None
+          return None
 
         icons = view.get_children_by_type(EmbeddedIcon)
         return icons[0] if icons else None
 
-    def _get_view(self):
-        views = self.get_children_by_type(HudView)
-        return views[0] if views else None
-
-    @property
-    def searchbar(self):
-        """Returns the searchbar attached to the hud."""
-        return self._get_view().searchbar;
-
+    @property
+    def view(self):
+        """Returns the HudView."""
+        return self.controller.get_hud_view()
+    
+    @property
+    def visible(self):
+        """Is the Hud visible?"""
+        return self.controller.visible
+
+    @property
+    def searchbar(self):
+        """Returns the searchbar attached to the hud."""
+        return self.controller.get_hud_view().searchbar
+
+    @property
+    def search_string(self):
+        """Returns the searchbars' search string."""
+        return self.searchbar.search_string
+
+    @property
+    def is_locked_launcher(self):
+        return self.controller.locked_to_launcher
+
+    @property
+    def monitor(self):
+        return self.controller.hud_monitor
+
+    @property
+    def searchbar(self):
+        """Returns the searchbar attached to the hud."""
+        return self.controller.get_hud_view().searchbar;
+
+    @property
     def geometry(self):
-        return (self.x, self.y, self.width, self.height)
+        return (self.controller.x, self.controller.y, self.controller.width, self.controller.height)
 
     @property
     def selected_button(self):
-        view = self._get_view()
+        view = self.controller.get_hud_view()
         if view:
             return view.selected_button
         else:
@@ -82,20 +92,27 @@
 
     @property
     def num_buttons(self):
-        view = self._get_view()
+        view = self.controller.get_hud_view()
         if view:
             return view.num_buttons
         else:
             return 0
 
-    @property
-    def is_locked_to_launcher(self):
-        return bool(self.locked_to_launcher)
-
-    @property
-    def monitor(self):
-        return int(self.hud_monitor)
-
-    @property
-    def has_embedded_icon(self):
-        return (self.get_embedded_icon() != None)
+class HudView(UnityIntrospectionObject):
+    """Proxy object for the hud view child of the controller."""
+  
+    @property
+    def searchbar(self):
+        """Get the search bar attached to this hud view."""
+        return self.get_children_by_type(SearchBar)[0]
+
+    @property
+    def geometry(self):
+        return (self.x, self.y, self.width, self.height)
+
+class HudController(UnityIntrospectionObject):
+    """Proxy object for the Unity Hud Controller."""
+
+    def get_hud_view(self):
+        views = self.get_children_by_type(HudView)
+        return views[0] if views else None

=== modified file 'tests/autopilot/autopilot/emulators/unity/icons.py'
--- tests/autopilot/autopilot/emulators/unity/icons.py	2012-03-29 20:25:35 +0000
+++ tests/autopilot/autopilot/emulators/unity/icons.py	2012-03-30 20:12:24 +0000
@@ -71,3 +71,10 @@
 
 class SoftwareCenterLauncherIcon(BamfLauncherIcon):
     """Represents a launcher icon of a Software Center app."""
+
+class EmbeddedIcon(SimpleLauncherIcon):
+    """Proxy object for the hud embedded icon child of the view."""
+
+    @property
+    def geometry(self):
+        return (self.x, self.y, self.width, self.height)

=== modified file 'tests/autopilot/autopilot/tests/__init__.py'
--- tests/autopilot/autopilot/tests/__init__.py	2012-03-29 14:31:40 +0000
+++ tests/autopilot/autopilot/tests/__init__.py	2012-03-30 20:12:24 +0000
@@ -22,6 +22,7 @@
     reset_logging,
     )
 from autopilot.emulators.unity.dash import Dash
+from autopilot.emulators.unity.hud import Hud
 from autopilot.emulators.unity.launcher import LauncherController
 from autopilot.emulators.unity.switcher import Switcher
 from autopilot.emulators.unity.workspace import WorkspaceManager
@@ -227,6 +228,7 @@
         self.keyboard = Keyboard()
         self.mouse = Mouse()
         self.dash = Dash()
+        self.hud = Hud()
         self.switcher = Switcher()
         self.workspace = WorkspaceManager()
         self.screen_geo = ScreenGeometry()

=== modified file 'tests/autopilot/autopilot/tests/test_hud.py'
--- tests/autopilot/autopilot/tests/test_hud.py	2012-03-30 17:41:41 +0000
+++ tests/autopilot/autopilot/tests/test_hud.py	2012-03-30 20:12:24 +0000
@@ -11,7 +11,6 @@
 from time import sleep
 
 from autopilot.emulators.X11 import ScreenGeometry
-from autopilot.emulators.unity.hud import HudController
 from autopilot.emulators.unity.icons import HudLauncherIcon
 from autopilot.tests import AutopilotTestCase, multiply_scenarios
 from os import remove
@@ -34,17 +33,11 @@
         super(HudTestsBase, self).setUp()
 
         sleep(0.25)
-        self.hud = self.get_hud_controller()
 
     def tearDown(self):
         self.hud.ensure_hidden()
         super(HudTestsBase, self).tearDown()
 
-    def get_hud_controller(self):
-        controllers = HudController.get_all_instances()
-        self.assertEqual(1, len(controllers))
-        return controllers[0]
-
     def get_hud_launcher_icon(self):
         icons = HudLauncherIcon.get_all_instances()
         self.assertEqual(1, len(icons))
@@ -399,17 +392,18 @@
         self.reveal_hud()
         sleep(.25)
 
-        self.assertThat(self.hud.is_locked_to_launcher, Equals(self.hud_locked))
+        self.assertThat(self.hud.is_locked_launcher, Equals(self.hud_locked))
 
     def test_hud_icon_is_shown(self):
         """Tests that the correct HUD icon is shown"""
         self.reveal_hud()
+        self.hud.visible
         sleep(.5)
 
         hud_launcher_icon = self.get_hud_launcher_icon()
         hud_embedded_icon = self.hud.get_embedded_icon()
 
-        if self.hud.is_locked_to_launcher:
+        if self.hud.is_locked_launcher:
             self.assertTrue(hud_launcher_icon.is_visible_on_monitor(self.hud_monitor))
             self.assertTrue(hud_launcher_icon.active)
             self.assertThat(hud_launcher_icon.monitor, Equals(self.hud_monitor))
@@ -431,7 +425,7 @@
         self.reveal_hud()
         sleep(.5)
 
-        if self.hud.is_locked_to_launcher:
+        if self.hud.is_locked_launcher:
             hud_launcher_icon = self.get_hud_launcher_icon()
             self.assertThat(hud_launcher_icon.icon_name, Equals(calc.icon))
         else:

=== modified file 'tests/autopilot/autopilot/tests/test_ibus.py'
--- tests/autopilot/autopilot/tests/test_ibus.py	2012-03-22 22:34:01 +0000
+++ tests/autopilot/autopilot/tests/test_ibus.py	2012-03-30 20:12:24 +0000
@@ -12,8 +12,6 @@
     set_active_engines,
     get_available_input_engines,
     )
-from autopilot.emulators.unity.dash import Dash
-from autopilot.emulators.X11 import Keyboard
 from autopilot.tests import AutopilotTestCase, multiply_scenarios
 
 from time import sleep
@@ -23,8 +21,6 @@
 
     def setUp(self):
         super(IBusTests, self).setUp()
-        self.kb = Keyboard()
-        self.dash = Dash()
         self._old_engines = None
 
     def tearDown(self):
@@ -41,11 +37,11 @@
 
     def activate_ibus(self):
         # it would be nice to be able to tell if it's currently active or not.
-        self.kb.press_and_release('Ctrl+Space')
+        self.keyboard.press_and_release('Ctrl+Space')
 
     def deactivate_ibus(self):
         # it would be nice to be able to tell if it's currently active or not.
-        self.kb.press_and_release('Ctrl+Space')
+        self.keyboard.press_and_release('Ctrl+Space')
 
 
 class IBusTestsPinyin(IBusTests):
@@ -59,19 +55,32 @@
         ('disk_management', {'input': 'cipan guanli ', 'result': u'\u78c1\u76d8\u7ba1\u7406'}),
     ]
 
-    def test_simple_input(self):
+    def test_simple_input_dash(self):
         self.activate_input_engine_or_skip("pinyin")
         self.dash.ensure_visible()
         sleep(0.5)
         self.activate_ibus()
         sleep(0.5)
-        self.kb.type(self.input)
-        dash_search_string = self.dash.get_searchbar().search_string
+        self.keyboard.type(self.input)
+        dash_search_string = self.dash.search_string
         self.deactivate_ibus()
         self.dash.ensure_hidden()
 
         self.assertEqual(self.result, dash_search_string)
 
+    def test_simple_input_hud(self):
+        self.activate_input_engine_or_skip("pinyin")
+        self.hud.ensure_visible()
+        sleep(0.5)
+        self.activate_ibus()
+        sleep(0.5)
+        self.keyboard.type(self.input)
+        hud_search_string = self.hud.search_string
+        self.deactivate_ibus()
+        self.hud.ensure_hidden()
+
+        self.assertEqual(self.result, hud_search_string)
+
 
 class IBusTestsHangul(IBusTests):
     """Tests for the Hangul(Korean) input engine."""
@@ -82,19 +91,32 @@
         ('document', {'input': 'anstj ', 'result': u'\ubb38\uc11c '}),
         ]
 
-    def test_simple_input(self):
+    def test_simple_input_dash(self):
         self.activate_input_engine_or_skip("hangul")
         self.dash.ensure_visible()
         sleep(0.5)
         self.activate_ibus()
         sleep(0.5)
-        self.kb.type(self.input)
-        dash_search_string = self.dash.get_searchbar().search_string
+        self.keyboard.type(self.input)
+        dash_search_string = self.dash.search_string
         self.deactivate_ibus()
         self.dash.ensure_hidden()
 
         self.assertEqual(self.result, dash_search_string)
 
+    def test_simple_input_hud(self):
+        self.activate_input_engine_or_skip("hangul")
+        self.hud.ensure_visible()
+        sleep(0.5)
+        self.activate_ibus()
+        sleep(0.5)
+        self.keyboard.type(self.input)
+        hud_search_string = self.hud.search_string
+        self.deactivate_ibus()
+        self.hud.ensure_hidden()
+
+        self.assertEqual(self.result, hud_search_string)
+
 
 class IBusTestsAnthy(IBusTests):
     """Tests for the Anthy(Japanese) input engine."""
@@ -111,16 +133,30 @@
         ]
         )
 
-    def test_simple_input(self):
+    def test_simple_input_dash(self):
         self.activate_input_engine_or_skip("anthy")
         self.dash.ensure_visible()
         sleep(0.5)
         self.activate_ibus()
         sleep(0.5)
-        self.kb.type(self.input)
-        self.kb.press_and_release(self.commit_key)
-        dash_search_string = self.dash.get_searchbar().search_string
+        self.keyboard.type(self.input)
+        self.keyboard.press_and_release(self.commit_key)
+        dash_search_string = self.dash.search_string
         self.deactivate_ibus()
         self.dash.ensure_hidden()
 
         self.assertEqual(self.result, dash_search_string)
+
+    def test_simple_input_hud(self):
+        self.activate_input_engine_or_skip("anthy")
+        self.hud.ensure_visible()
+        sleep(0.5)
+        self.activate_ibus()
+        sleep(0.5)
+        self.keyboard.type(self.input)
+        self.keyboard.press_and_release(self.commit_key)
+        hud_search_string = self.hud.search_string
+        self.deactivate_ibus()
+        self.hud.ensure_hidden()
+
+        self.assertEqual(self.result, hud_search_string)