Merge lp:~gordallott/unity/fix-hud-lose-last-application-focus into lp:unity

[Gord Allott]

fixes issue with hud not returning focus correctly, hack was bad.

UNBLOCK

[Gord Allott (gordallott)]

no tests

review: Needs Fixing

[Gord Allott (gordallott)]

now has ap test

review: Approve

[Mirco Müller (macslow)]

I cannot replicate the test-case Seb described in the bug-entry.

Running...

  unity/tools/autopilot run autopilot.tests.HudTests.test_restore_focus

... aborts with:
------------------------------------------------------------------

  Tests running...
  No handlers could be found for logger "autopilot.emulators.X11"
  ======================================================================
  FAIL: autopilot.tests.test_hud.HudTests.test_restore_focus
  ----------------------------------------------------------------------
  test-log: {{{
  17:31:45.413 DEBUG autopilot/emulators/unity/__init__.py:49 - Querying unity for state piece: '//HudController'
  17:31:48.092 DEBUG autopilot/emulators/unity/__init__.py:142 - Refreshing state for <autopilot.emulators.unity.hud.HudController object at 0x8beb5ac>
  17:31:48.092 DEBUG autopilot/emulators/unity/__init__.py:61 - Getting state for object HudController with id 17
  17:31:48.092 DEBUG autopilot/emulators/unity/__init__.py:49 - Querying unity for state piece: '//HudController[id=17]'
  }}}

  Traceback (most recent call last):
    File "autopilot/tests/test_hud.py", line 152, in test_restore_focus
      self.assertEqual(b.application_is_focused('Calculator'), True)
  MismatchError: False != True

  Ran 1 test in 2.767s
  FAILED (failures=1)
------------------------------------------------------------------

Running the command...

  python -m testtools.run autopilot.tests.test_hud.HudTests.test_restore_focus

... aborts with:
------------------------------------------------------------------
Xlib.protocol.request.QueryExtension
Traceback (most recent call last):
  File "./tools/autopilot", line 145, in <module>
    main()
  File "./tools/autopilot", line 139, in main
    run_tests(args)
  File "./tools/autopilot", line 106, in run_tests
    test_suite = loader.loadTestsFromNames(args.test)
  File "/usr/lib/python2.7/unittest/loader.py", line 128, in loadTestsFromNames
    suites = [self.loadTestsFromName(name, module) for name in names]
  File "/usr/lib/python2.7/unittest/loader.py", line 100, in loadTestsFromName
    parent, obj = obj, getattr(obj, part)
AttributeError: 'module' object has no attribute 'HudTests'
------------------------------------------------------------------

review: Needs Fixing

[Mirco Müller (macslow)]

Yay, also the test works (and passes) now... sweet! Approved.

review: Approve

[Unity Merger (unity-merger)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Gord Allott (gordallott)]

review: Approve

=== modified file 'plugins/unityshell/src/HudController.cpp'
--- plugins/unityshell/src/HudController.cpp	2012-03-02 01:59:42 +0000
+++ plugins/unityshell/src/HudController.cpp	2012-03-05 12:14:19 +0000
@@ -351,10 +351,13 @@
         //THIS IS BAD - VERY VERY BAD
         LOG_DEBUG(logger) << "Last attempt, forcing window focus";
         Controller* self = static_cast<Controller*>(data);
-        nux::GetWindowCompositor().SetKeyFocusArea(self->view_->default_focus());
+        if (self->visible_)
+        {
+          nux::GetWindowCompositor().SetKeyFocusArea(self->view_->default_focus());
 
-        self->window_->PushToFront();
-        self->window_->SetInputFocus();
+          self->window_->PushToFront();
+          self->window_->SetInputFocus();
+        }
         return FALSE;
       }, self);
     }

=== modified file 'tests/autopilot/autopilot/emulators/bamf.py'
--- tests/autopilot/autopilot/emulators/bamf.py	2012-02-28 08:52:10 +0000
+++ tests/autopilot/autopilot/emulators/bamf.py	2012-03-05 12:14:19 +0000
@@ -11,6 +11,7 @@
 import dbus.glib
 import gio
 import gobject
+import os
 from Xlib import display, X, protocol
 
 from autopilot.emulators.dbus_handler import session_bus
@@ -73,6 +74,15 @@
         """
         return [a for a in self.get_running_applications() if a.name == app_title]
 
+    def get_running_applications_by_desktop_file(self, desktop_file):
+        """Return a list of applications that have the desktop file 'desktop_file'`.
+
+        This method may return an empty list, if no applications
+        are found with the specified desktop file.
+
+        """
+        return [a for a in self.get_running_applications() if a.desktop_file == desktop_file]
+    
     def get_open_windows(self, user_visible_only=True):
         """Get a list of currently open windows.
 
@@ -104,8 +114,33 @@
             return app_name in [a.name for a in self.get_running_applications()]
         except dbus.DBusException:
             return False
-
-    def wait_until_application_is_running(self, app_name, timeout):
+    
+    def application_is_running_desktop_file(self, desktop_file):
+        """Detect if an application with a given .desktop file is currently running.
+
+        'desktop_file' is the .desktop file of the application you are looking for.
+        """
+        try:
+            return desktop_file in [a.desktop_file for a in self.get_running_applications()]
+        except dbus.DBusException:
+            return False
+    
+    def application_is_focused(self, desktop_file):
+        """Detect if an application with given name is currently focused.
+
+        'desktop_file' is the desktop_file of the application you are looking for.
+        """
+        try:
+            found_focused = False
+            for app in self.get_running_applications_by_desktop_file(desktop_file):
+                if app.is_active:
+                    found_focused = True
+
+            return found_focused
+        except dbus.DBusException:
+            return False
+
+    def wait_until_application_is_running(self, app_name, timeout, is_desktop_file=False):
         """Wait until a given application is running.
 
         'app_name' is the name of the application.
@@ -120,7 +155,13 @@
         found_app = [True]
 
         # maybe the app is running already?
-        if not self.application_is_running(app_name):
+        is_running = False
+        if (is_desktop_file):
+            is_running = self.application_is_running_desktop_file(app_name)
+        else:
+            is_running = self.application_is_running(app_name)
+
+        if not is_running:
             wait_forever = timeout < 0
             gobject_loop = gobject.MainLoop()
 
@@ -128,9 +169,10 @@
             def on_view_added(bamf_path, name):
                 if bamf_path.split('/')[-1].startswith('application'):
                     app = BamfApplication(bamf_path)
-                    if app.name == app_name:
+                    if ((is_desktop_file and app_name == app.desktop_file)
+                        or (not is_desktop_file and app.name == app_name)):
                         gobject_loop.quit()
-
+                        
             # ...and one for when the user-defined timeout has been reached:
             def on_timeout_reached():
                 gobject_loop.quit()
@@ -158,7 +200,7 @@
         proc = gio.unix.DesktopAppInfo(desktop_file)
         proc.launch()
         if wait:
-            self.wait_until_application_is_running(proc.get_name(), -1)
+            self.wait_until_application_is_running(desktop_file, -1, True)
         return proc
 
 
@@ -174,11 +216,17 @@
         try:
             self._app_proxy = session_bus.get_object(_BAMF_BUS_NAME, bamf_app_path)
             self._view_iface = dbus.Interface(self._app_proxy, 'org.ayatana.bamf.view')
+            self._app_iface = dbus.Interface(self._app_proxy, 'org.ayatana.bamf.application')
         except dbus.DBusException, e:
             e.message += 'bamf_app_path=%r' % (bamf_app_path)
             raise
 
     @property
+    def desktop_file(self):
+        """Get the application desktop file"""
+        return os.path.split(self._app_iface.DesktopFile())[1]
+
+    @property
     def name(self):
         """Get the application name."""
         return self._view_iface.Name()

=== modified file 'tests/autopilot/autopilot/tests/test_hud.py'
--- tests/autopilot/autopilot/tests/test_hud.py	2012-03-04 23:36:23 +0000
+++ tests/autopilot/autopilot/tests/test_hud.py	2012-03-05 12:14:19 +0000
@@ -10,6 +10,7 @@
 
 from testtools.matchers import Equals, LessThan
 
+from autopilot.emulators.bamf import Bamf
 from autopilot.emulators.unity.hud import HudController
 from autopilot.tests import AutopilotTestCase
 
@@ -135,3 +136,22 @@
         num_active = self.get_num_active_launcher_icons()
         self.assertLessEqual(num_active, 1, "More than one launcher icon active after test has run!")
 
+    def test_restore_focus(self):
+        """Ensures that once the hud is dismissed, the same application 
+        that was focused before hud invocation is refocused
+        """
+        b = Bamf();
+        app_desktop_file = 'gcalctool.desktop'
+        b.launch_application(app_desktop_file)
+
+        # first ensure that the application has started and is focused
+        self.assertEqual(b.application_is_focused(app_desktop_file), True)
+
+        self.hud.toggle_reveal()
+        sleep(1)
+        self.hud.toggle_reveal()
+        sleep(1)
+
+        # again ensure that the application we started is focused
+        self.assertEqual(b.application_is_focused(app_desktop_file), True)
+