Merge lp:~3v1n0/unity/hud-lock-out-monitors-tests into lp:unity

[Marco Trevisan (Treviño)]

Added tests for multimonitor in HUD and to check the lock-out

[Gord Allott (gordallott)]

+1, seems good here

review: Approve

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

44 + def is_rect_on_monitor(self, monitor_number, x, y, w, h):
45 + (m_x, m_y, m_w, m_h) = self.get_monitor_geometry(monitor_number)
46 + return (x >= m_x and x + w <= m_x + m_w and y >= m_y and y + h <= m_y + m_h)
47 +

Instead of passing x,y,w & h as separate parameters, just pass 'rect', and make sure it's a tuple in the function:
def is_rect_on_monitor(self, monitor_number, rect):
    """Returns True if `rect` is _entirely_ on the specified monitor, with no overlap"""
    if type(rect) is not tuple:
        raise TypeError("rect must be a tuple.")

...if you want you can also check that monitor_number is a valid integer, and that the tuple values are all ints.

This:

59 + def get_geometry(self):
60 + return (self.x, self.y, self.width, self.height)
61 +

should be a property, like this:

58 + @property
59 + def geometry(self):
60 + return (self.x, self.y, self.width, self.height)
61 +

this:

84 + screen_geometry = ScreenGeometry()
85 + num_monitors = screen_geometry.get_num_monitors()
86 +
87 + if num_monitors == 1:
88 + scenarios = [
89 + ('Single Monitor, Launcher never hide', {'hud_monitor': 0, 'launcher_hide_mode': 0}),
90 + ('Single Monitor, Launcher autohide', {'hud_monitor': 0, 'launcher_hide_mode': 1}),
91 + ]
92 + else:
93 + scenarios = []
94 + for i in range(num_monitors):
95 + scenarios.append(('Monitor %d, Launcher never hide' % (i), {'hud_monitor': i, 'launcher_hide_mode': 0}))
96 + scenarios.append(('Monitor %d, Launcher autohide' % (i), {'hud_monitor': i, 'launcher_hide_mode': 1}))

is kind of ugly. A better way to do it is how we do it in the launcher tests - use a function to generate the scenarios.

The first two changes I mentioned mean that you can rewrite this:

112 + (x, y, w, h) = self.hud.get_geometry()
113 + self.assertTrue(self.screen_geometry.is_rect_on_monitor(self.hud_monitor, x, y, w, h))

like this:

self.assertTrue(self.screen_geometry.is_rect_on_monitor(self.hud_monitor, self.hud.geometry)

The new test:

131 + def test_hud_dont_change_launcher_status(self):

...needs a docstring.

Finally, please use matchers for everything except simple true/false tests, so this:

139 + self.assertEqual(launcher_shows_pre, launcher_shows_post)

becomes:

self.assertThat(launcher_shows_pre, Equals(launcher_shows_post))

Cheers,

review: Needs Fixing

=== modified file 'manual-tests/Hud.txt'
--- manual-tests/Hud.txt	2012-03-21 14:44:41 +0000
+++ manual-tests/Hud.txt	2012-03-25 18:15:22 +0000
@@ -64,10 +64,7 @@
 #. Tap Alt
 
 Outcome
-  The Launcher should stick be locked out.
-  The Launcher icons should be desaturated.
-  The top most Launcher icon should be an icon related the the focused window
-  The BFB should not be present
+  The top most Launcher icon should be an icon related to the focused window
 
 
 Hud Sending Undo

=== modified file 'plugins/unityshell/src/BamfLauncherIcon.cpp'
--- plugins/unityshell/src/BamfLauncherIcon.cpp	2012-03-22 15:14:49 +0000
+++ plugins/unityshell/src/BamfLauncherIcon.cpp	2012-03-25 18:15:22 +0000
@@ -473,7 +473,8 @@
   g_list_free(children);
 
   variant::BuilderWrapper(builder)
-    .add("desktop-file", DesktopFile())
+    .add("desktop_file", DesktopFile())
+    .add("desktop_id", glib::String(g_path_get_basename(DesktopFile().c_str())).Str())
     .add("xids", g_variant_new_array(G_VARIANT_TYPE_UINT32, xids, i))
     .add("sticky", IsSticky());
 }

=== modified file 'plugins/unityshell/src/HudController.cpp'
--- plugins/unityshell/src/HudController.cpp	2012-03-21 15:30:49 +0000
+++ plugins/unityshell/src/HudController.cpp	2012-03-25 18:15:22 +0000
@@ -40,6 +40,8 @@
 
 Controller::Controller()
   : launcher_width(65)
+  , launcher_locked_out(false)
+  , multiple_launchers(true)
   , hud_service_("com.canonical.hud", "/com/canonical/hud")
   , window_(nullptr)
   , visible_(false)
@@ -47,12 +49,11 @@
   , timeline_id_(0)
   , last_opacity_(0.0f)
   , start_time_(0)
-  , launcher_is_locked_out_(false)
   , view_(nullptr)
   , monitor_index_(0)
 {
   LOG_DEBUG(logger) << "hud startup";
-  SetupRelayoutCallbacks();
+  UScreen::GetDefault()->changed.connect([&] (int, std::vector<nux::Geometry>&) { Relayout(); });
 
   ubus.RegisterInterest(UBUS_HUD_CLOSE_REQUEST, sigc::mem_fun(this, &Controller::OnExternalHideHud));
 
@@ -65,13 +66,13 @@
     gint32 overlay_monitor = 0;
     g_variant_get(data, UBUS_OVERLAY_FORMAT_STRING, &overlay_identity, &can_maximise, &overlay_monitor);
 
-    if (g_strcmp0(overlay_identity, "hud"))
+    if (overlay_identity.Str() != "hud")
     {
       HideHud(true);
     }
   });
 
-  launcher_width.changed.connect([this] (int new_width) { Relayout(); });
+  launcher_width.changed.connect([&] (int new_width) { Relayout(); });
 
   PluginAdapter::Default()->compiz_screen_ungrabbed.connect(sigc::mem_fun(this, &Controller::OnScreenUngrabbed));
 
@@ -120,14 +121,24 @@
   AddChild(view_);
 }
 
-void Controller::SetupRelayoutCallbacks()
-{
-  GdkScreen* screen = gdk_screen_get_default();
-
-  sig_manager_.Add(new glib::Signal<void, GdkScreen*>(screen,
-    "monitors-changed", sigc::mem_fun(this, &Controller::Relayout)));
-  sig_manager_.Add(new glib::Signal<void, GdkScreen*>(screen,
-    "size-changed", sigc::mem_fun(this, &Controller::Relayout)));
+int Controller::GetTargetMonitor()
+{
+  return UScreen::GetDefault()->GetMonitorWithMouse();
+}
+
+bool Controller::IsLockedToLauncher(int monitor)
+{
+  if (launcher_locked_out)
+  {
+    int primary_monitor = UScreen::GetDefault()->GetPrimaryMonitor();
+
+    if (multiple_launchers || (!multiple_launchers && primary_monitor == monitor))
+    {
+      return true;
+    }
+  }
+
+  return false;
 }
 
 void Controller::EnsureHud()
@@ -158,26 +169,27 @@
 
 nux::Geometry Controller::GetIdealWindowGeometry()
 {
-  UScreen *uscreen = UScreen::GetDefault();
-  int primary_monitor = uscreen->GetMonitorWithMouse();
-  auto monitor_geo = uscreen->GetMonitorGeometry(primary_monitor);
+  int target_monitor = GetTargetMonitor();
+  auto monitor_geo = UScreen::GetDefault()->GetMonitorGeometry(target_monitor);
 
-  // We want to cover as much of the screen as possible to grab any mouse events outside
+  // We want to cover as much of the screen as possible to grab any mouse events outside447
   // of our window
   panel::Style &panel_style = panel::Style::Instance();
   nux::Geometry geo(monitor_geo.x,
-                       monitor_geo.y + panel_style.panel_height,
-                       monitor_geo.width,
-                       monitor_geo.height - panel_style.panel_height);
-  if (launcher_is_locked_out_)
+                    monitor_geo.y + panel_style.panel_height,
+                    monitor_geo.width,
+                    monitor_geo.height - panel_style.panel_height);
+
+  if (IsLockedToLauncher(target_monitor))
   {
     geo.x += launcher_width;
     geo.width -= launcher_width;
   }
+
   return geo;
 }
 
-void Controller::Relayout(GdkScreen*screen)
+void Controller::Relayout()
 {
   EnsureHud();
   nux::Geometry content_geo = view_->GetGeometry();
@@ -190,7 +202,7 @@
 }
 
 void Controller::OnMouseDownOutsideWindow(int x, int y,
-                                              unsigned long bflags, unsigned long kflags)
+                                          unsigned long bflags, unsigned long kflags)
 {
   LOG_DEBUG(logger) << "OnMouseDownOutsideWindow called";
   HideHud();
@@ -234,16 +246,6 @@
   return visible_;
 }
 
-void Controller::SetLauncherIsLockedOut(bool launcher_is_locked_out)
-{
-  launcher_is_locked_out_ = launcher_is_locked_out;
-  if (launcher_is_locked_out_)
-    view_->SetHideIcon(IconHideState::HIDE);
-  else
-    view_->SetHideIcon(IconHideState::SHOW);
-  Relayout();
-}
-
 void Controller::ShowHud()
 {
   PluginAdapter* adaptor = PluginAdapter::Default();
@@ -259,6 +261,8 @@
     return;
   }
 
+  monitor_index_ = GetTargetMonitor();
+  view_->ShowEmbeddedIcon(!IsLockedToLauncher(monitor_index_));
   view_->AboutToShow();
 
   // we first want to grab the currently active window, luckly we can just ask the jason interface(bamf)
@@ -289,7 +293,6 @@
   // hide the launcher
   GVariant* message_data = g_variant_new("(b)", TRUE);
   ubus.SendMessage(UBUS_LAUNCHER_LOCK_HIDE, message_data);
-  monitor_index_ = UScreen::GetDefault()->GetMonitorWithMouse();
   GVariant* info = g_variant_new(UBUS_OVERLAY_FORMAT_STRING, "hud", FALSE, monitor_index_);
   ubus.SendMessage(UBUS_OVERLAY_SHOWN, info);
 
@@ -410,7 +413,6 @@
   ubus.SendMessage(UBUS_HUD_ICON_CHANGED, g_variant_new_string(query->icon_name.c_str()));
 }
 
-
 void Controller::OnQueriesFinished(Hud::Queries queries)
 {
   view_->SetQueries(queries);
@@ -438,7 +440,10 @@
 void Controller::AddProperties(GVariantBuilder* builder)
 {
   variant::BuilderWrapper(builder)
-    .add("visible", visible_);
+    .add(window_ ? window_->GetGeometry() : nux::Geometry())
+    .add("visible", visible_)
+    .add("hud_monitor", monitor_index_)
+    .add("locked_to_launcher", IsLockedToLauncher(monitor_index_));
 }
 
 

=== modified file 'plugins/unityshell/src/HudController.h'
--- plugins/unityshell/src/HudController.h	2012-03-21 15:30:49 +0000
+++ plugins/unityshell/src/HudController.h	2012-03-25 18:15:22 +0000
@@ -22,7 +22,6 @@
 #include <memory>
 
 #include <gdk/gdk.h>
-#include <UnityCore/GLibSignal.h>
 #include <UnityCore/Hud.h>
 
 #include <NuxCore/Property.h>
@@ -49,12 +48,13 @@
   nux::BaseWindow* window() const;
 
   nux::Property<int> launcher_width;
+  nux::Property<bool> launcher_locked_out;
+  nux::Property<bool> multiple_launchers;
 
   void ShowHideHud();
   void ShowHud();
   void HideHud(bool restore_focus = true);
   bool IsVisible();
-  void SetLauncherIsLockedOut(bool launcher_is_locked_out);
 
 protected:
   std::string GetName() const;
@@ -64,11 +64,13 @@
   void EnsureHud();
   void SetupWindow();
   void SetupHudView();
-  void SetupRelayoutCallbacks();
   void RegisterUBusInterests();
 
+  int GetTargetMonitor();
+  bool IsLockedToLauncher(int monitor);
+
   nux::Geometry GetIdealWindowGeometry();
-  void Relayout(GdkScreen*screen=NULL);
+  void Relayout();
 
   void OnMouseDownOutsideWindow(int x, int y, unsigned long bflags, unsigned long kflags);
   void OnScreenUngrabbed();
@@ -81,8 +83,6 @@
   void OnQueryActivated(Query::Ptr query);
   void OnQuerySelected(Query::Ptr query);
 
-
-private:
   void StartShowHideTimeline();
   static gboolean OnViewShowHideFrame(Controller* self);
 
@@ -93,7 +93,6 @@
 private:
   UBusManager ubus;
   Hud hud_service_;
-  glib::SignalManager sig_manager_;
   nux::BaseWindow* window_;
   bool visible_;
   bool need_show_;
@@ -101,8 +100,6 @@
   guint timeline_id_;
   float last_opacity_;
   gint64 start_time_;
- 
-  bool launcher_is_locked_out_;
 
   View* view_;
   guint ensure_id_;

=== modified file 'plugins/unityshell/src/HudView.cpp'
--- plugins/unityshell/src/HudView.cpp	2012-03-21 15:07:29 +0000
+++ plugins/unityshell/src/HudView.cpp	2012-03-25 18:15:22 +0000
@@ -64,7 +64,7 @@
   , current_height_(0)
   , timeline_need_more_draw_(false)
   , selected_button_(0)
-  , icon_state_(IconHideState::SHOW)
+  , show_embedded_icon_(true)
   , activated_signal_sent_(false)
 {
   renderer_.SetOwner(this);
@@ -276,16 +276,16 @@
   QueueDraw();
 }
 
-void View::SetHideIcon(IconHideState hide_icon)
+void View::ShowEmbeddedIcon(bool show)
 {
   LOG_DEBUG(logger) << "Hide icon called";
-  if (hide_icon == icon_state_)
+  if (show == show_embedded_icon_)
     return;
 
-  icon_state_ = hide_icon;
+  show_embedded_icon_ = show;
 
-  if (icon_state_ == IconHideState::HIDE)
-    layout_->RemoveChildObject(dynamic_cast<nux::Area*>(icon_layout_.GetPointer()));
+  if (!show)
+    layout_->RemoveChildObject(static_cast<nux::Area*>(icon_layout_.GetPointer()));
   else
     layout_->AddLayout(icon_layout_.GetPointer(), 0, nux::MINOR_POSITION_TOP, nux::MINOR_SIZE_MATCHCONTENT, 100.0f, nux::LayoutPosition::NUX_LAYOUT_BEGIN);
 
@@ -303,7 +303,7 @@
   width = 1024;
   height = 276;
 
-  if (icon_state_ == IconHideState::HIDE)
+  if (!show_embedded_icon_)
   {
     width -= icon_layout_->GetGeometry().width;
   }
@@ -491,8 +491,10 @@
 {
   unsigned num_buttons = buttons_.size();
   variant::BuilderWrapper(builder)
+    .add(GetGeometry())
     .add("selected_button", selected_button_)
-    .add("num_buttons", num_buttons);
+    .add("num_buttons", num_buttons)
+    .add("show_embedded_icon", show_embedded_icon_);
 }
 
 bool View::InspectKeyEvent(unsigned int eventType,

=== modified file 'plugins/unityshell/src/HudView.h'
--- plugins/unityshell/src/HudView.h	2012-03-21 14:44:41 +0000
+++ plugins/unityshell/src/HudView.h	2012-03-25 18:15:22 +0000
@@ -44,12 +44,6 @@
 namespace hud
 {
 
-enum IconHideState
-{
-  HIDE,
-  SHOW
-};
-
 class View : public nux::View, public unity::debug::Introspectable
 {
   NUX_DECLARE_OBJECT_TYPE(HudView, nux::View);
@@ -65,7 +59,7 @@
 
   void SetQueries(Hud::Queries queries);
   void SetIcon(std::string icon_name);
-  void SetHideIcon(IconHideState hide_icon);
+  void ShowEmbeddedIcon(bool show);
 
   void AboutToShow();
   void AboutToHide();
@@ -126,7 +120,7 @@
   int current_height_;
   bool timeline_need_more_draw_;
   int selected_button_;
-  IconHideState icon_state_;
+  bool show_embedded_icon_;
   bool activated_signal_sent_;
 };
 

=== modified file 'plugins/unityshell/src/LauncherIcon.cpp'
--- plugins/unityshell/src/LauncherIcon.cpp	2012-03-21 12:31:11 +0000
+++ plugins/unityshell/src/LauncherIcon.cpp	2012-03-25 18:15:22 +0000
@@ -185,18 +185,20 @@
 LauncherIcon::AddProperties(GVariantBuilder* builder)
 {
   unity::variant::BuilderWrapper(builder)
-  .add("x", _center[0].x)
-  .add("y", _center[0].y)
-  .add("z", _center[0].z)
-  .add("related-windows", (int)Windows().size())
-  .add("icon-type", _icon_type)
-  .add("tooltip-text", tooltip_text())
-  .add("sort-priority", _sort_priority)
-  .add("quirk-active", GetQuirk(QUIRK_ACTIVE))
-  .add("quirk-visible", GetQuirk(QUIRK_VISIBLE))
-  .add("quirk-urgent", GetQuirk(QUIRK_URGENT))
-  .add("quirk-running", GetQuirk(QUIRK_RUNNING))
-  .add("quirk-presented", GetQuirk(QUIRK_PRESENTED));
+  .add("center_x", _center[0].x)
+  .add("center_y", _center[0].y)
+  .add("center_z", _center[0].z)
+  .add("related_windows", static_cast<unsigned int>(Windows().size()))
+  .add("icon_type", _icon_type)
+  .add("tooltip_text", tooltip_text())
+  .add("sort_priority", _sort_priority)
+  .add("active", GetQuirk(QUIRK_ACTIVE))
+  .add("visible", GetQuirk(QUIRK_VISIBLE))
+  .add("urgent", GetQuirk(QUIRK_URGENT))
+  .add("running", GetQuirk(QUIRK_RUNNING))
+  .add("starting", GetQuirk(QUIRK_STARTING))
+  .add("desaturated", GetQuirk(QUIRK_DESAT))
+  .add("presented", GetQuirk(QUIRK_PRESENTED));
 }
 
 void

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-03-22 19:33:10 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-03-25 18:15:22 +0000
@@ -2520,6 +2520,7 @@
     case UnityshellOptions::NumLaunchers:
       launcher_controller_->multiple_launchers = optionGetNumLaunchers() == 0;
       dash_controller_->use_primary = !launcher_controller_->multiple_launchers();
+      hud_controller_->multiple_launchers = launcher_controller_->multiple_launchers();
       break;
     case UnityshellOptions::LauncherCaptureMouse:
       launcher_options->edge_resist = optionGetLauncherCaptureMouse();
@@ -2540,7 +2541,7 @@
     case UnityshellOptions::LauncherHideMode:
     {
       launcher_options->hide_mode = (unity::launcher::LauncherHideMode) optionGetLauncherHideMode();
-      hud_controller_->SetLauncherIsLockedOut(launcher_options->hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
+      hud_controller_->launcher_locked_out = (launcher_options->hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
       break;
     }
     case UnityshellOptions::BacklightMode:
@@ -2775,7 +2776,7 @@
   /* Setup Hud */
   hud_controller_.reset(new hud::Controller());
   auto hide_mode = (unity::launcher::LauncherHideMode) optionGetLauncherHideMode();
-  hud_controller_->SetLauncherIsLockedOut(hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
+  hud_controller_->launcher_locked_out = (hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
   AddChild(hud_controller_.get());
   LOG_INFO(logger) << "initLauncher-hud " << timer.ElapsedSeconds() << "s";
   

=== modified file 'tests/autopilot/autopilot/emulators/X11.py'
--- tests/autopilot/autopilot/emulators/X11.py	2012-03-21 12:31:11 +0000
+++ tests/autopilot/autopilot/emulators/X11.py	2012-03-25 18:15:22 +0000
@@ -339,10 +339,21 @@
         Returns a tuple containing (x,y,width,height).
 
         """
-        if monitor_number >= self.get_num_monitors():
+        if monitor_number < 0 or monitor_number >= self.get_num_monitors():
             raise ValueError('Specified monitor number is out of range.')
         return tuple(self._default_screen.get_monitor_geometry(monitor_number))
 
+    def is_rect_on_monitor(self, monitor_number, rect):
+        """Returns True if `rect` is _entirely_ on the specified monitor, with no overlap"""
+
+        if type(rect) is not tuple or len(rect) != 4:
+            raise TypeError("rect must be a tuple of 4 int elements.")
+
+        (x, y, w, h) = self.get_monitor_geometry(monitor_number)
+
+        (m_x, m_y, m_w, m_h) = self.get_monitor_geometry(monitor_number)
+        return (x >= m_x and x + w <= m_x + m_w and y >= m_y and y + h <= m_y + m_h)
+
     def move_mouse_to_monitor(self, monitor_number):
         """Move the mouse to the center of the specified monitor."""
         geo = self.get_monitor_geometry(monitor_number)

=== modified file 'tests/autopilot/autopilot/emulators/unity/hud.py'
--- tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-04 23:12:19 +0000
+++ tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-25 18:15:22 +0000
@@ -35,11 +35,18 @@
         """Tap the 'Alt' key to toggle the hud visibility."""
         self.keybinding("hud/reveal", tap_delay)
 
+    def get_geometry(self):
+        return (self.x, self.y, self.width, self.height)
+
     def _get_view(self):
         views = self.get_children_by_type(HudView)
         return views[0] if views else None
 
     @property
+    def geometry(self):
+        return (self.x, self.y, self.width, self.height)
+
+    @property
     def selected_button(self):
         view = self._get_view()
         if view:
@@ -54,3 +61,19 @@
             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 show_embedded_icon(self):
+        view = self._get_view()
+        if view:
+            return bool(view.show_embedded_icon)
+        else:
+            return False

=== modified file 'tests/autopilot/autopilot/emulators/unity/icons.py'
--- tests/autopilot/autopilot/emulators/unity/icons.py	2012-03-04 23:12:19 +0000
+++ tests/autopilot/autopilot/emulators/unity/icons.py	2012-03-25 18:15:22 +0000
@@ -19,6 +19,10 @@
 
     """
 
+    @property
+    def center_geometry(self):
+        return (self.center_x, self.center_y, self.center_z)
+
     def get_quicklist(self):
         """Get the quicklist for this launcher icon.
 
@@ -34,6 +38,10 @@
     """Represents the BFB button in the launcher."""
 
 
+class HudLauncherIcon(SimpleLauncherIcon):
+    """Represents the HUD button in the launcher."""
+
+
 class BamfLauncherIcon(SimpleLauncherIcon):
     """Represents a launcher icon with BAMF integration."""
 

=== modified file 'tests/autopilot/autopilot/emulators/unity/launcher.py'
--- tests/autopilot/autopilot/emulators/unity/launcher.py	2012-03-15 20:03:08 +0000
+++ tests/autopilot/autopilot/emulators/unity/launcher.py	2012-03-25 18:15:22 +0000
@@ -196,8 +196,8 @@
         logger.debug("Clicking launcher icon %r on monitor %d with mouse button %d",
             icon, self.monitor, button)
         self.mouse_reveal_launcher()
-        target_x = icon.x + self.x
-        target_y = icon.y + (self.icon_size / 2)
+        target_x = icon.center_x + self.x
+        target_y = icon.center_y
         self._mouse.move(target_x, target_y )
         self._mouse.click(button)
         self.move_mouse_to_right_of_launcher()
@@ -257,7 +257,7 @@
     def get_launcher_icons(self, visible_only=True):
         """Get a list of launcher icons in this launcher."""
         if visible_only:
-            return self.get_children_by_type(SimpleLauncherIcon, quirk_visible=True)
+            return self.get_children_by_type(SimpleLauncherIcon, visible=True)
         else:
             return self.get_children_by_type(SimpleLauncherIcon)
 
@@ -277,7 +277,21 @@
         Returns None if there is no such launcher icon.
         """
         icons = self.get_children_by_type(SimpleLauncherIcon, desktop_file=desktop_file)
-        return icons or None
+        if len(icons):
+            return icons[0]
+
+        return None
+
+    def get_icon_by_desktop_id(self, desktop_id):
+        """Gets a launcher icon with the specified desktop id.
+
+        Returns None if there is no such launcher icon.
+        """
+        icons = self.get_children_by_type(SimpleLauncherIcon, desktop_id=desktop_id)
+        if len(icons):
+            return icons[0]
+
+        return None
 
     def num_launcher_icons(self):
         """Get the number of icons in the launcher model."""

=== modified file 'tests/autopilot/autopilot/tests/test_hud.py'
--- tests/autopilot/autopilot/tests/test_hud.py	2012-03-21 14:44:41 +0000
+++ tests/autopilot/autopilot/tests/test_hud.py	2012-03-25 18:15:22 +0000
@@ -6,23 +6,55 @@
 # under the terms of the GNU General Public License version 3, as published
 # by the Free Software Foundation.
 
-from testtools.matchers import Equals, LessThan
+from testtools.matchers import Equals, LessThan, GreaterThan
 from time import sleep
 
+from autopilot.emulators.X11 import ScreenGeometry
 from autopilot.emulators.unity.hud import HudController
+from autopilot.emulators.unity.icons import BFBLauncherIcon, HudLauncherIcon
 from autopilot.tests import AutopilotTestCase
 from os import remove
 
+def _make_scenarios():
+    screen_geometry = ScreenGeometry()
+    num_monitors = screen_geometry.get_num_monitors()
+
+    scenarios = []
+
+    if num_monitors == 1:
+        scenarios = [
+            ('Single Monitor, Launcher never hide', {'hud_monitor': 0, 'launcher_hide_mode': 0, 'launcher_primary_only': False}),
+            ('Single Monitor, Launcher autohide', {'hud_monitor': 0, 'launcher_hide_mode': 1, 'launcher_primary_only': False}),
+            ]
+    else:
+        for i in range(num_monitors):
+            scenario_setting = {'hud_monitor': i, 'launcher_hide_mode': 0, 'launcher_primary_only': False}
+            scenarios.append(('Monitor %d, Launcher never hide, on all monitors' % (i), scenario_setting))
+
+            scenario_setting = {'hud_monitor': i, 'launcher_hide_mode': 0, 'launcher_primary_only': True}
+            scenarios.append(('Monitor %d, Launcher never hide, only on primary monitor' % (i), scenario_setting))
+
+            scenario_setting = {'hud_monitor': i, 'launcher_hide_mode': 1, 'launcher_primary_only': True}
+            scenarios.append(('Monitor %d, Launcher autohide, on all monitors' % (i), scenario_setting))
+
+            scenario_setting = {'hud_monitor': i, 'launcher_hide_mode': 1, 'launcher_primary_only': True}
+            scenarios.append(('Monitor %d, Launcher autohide, only on primary monitor' % (i), scenario_setting))
+
+    return scenarios
+
 class HudTests(AutopilotTestCase):
 
-    scenarios = [
-        ('Launcher never hide', {'launcher_hide_mode': 0}),
-        ('Launcher autohide', {'launcher_hide_mode': 1}),
-        ]
+    screen_geo = ScreenGeometry()
+    scenarios = _make_scenarios()
 
     def setUp(self):
         super(HudTests, self).setUp()
         self.set_unity_option('launcher_hide_mode', self.launcher_hide_mode)
+        self.set_unity_option('num_launchers', int(self.launcher_primary_only))
+        self.hud_monitor_is_primary = (self.screen_geo.get_primary_monitor() == self.hud_monitor)
+        self.hud_locked = (self.launcher_hide_mode == 0 and (not self.launcher_primary_only or self.hud_monitor_is_primary))
+        self.screen_geo.move_mouse_to_monitor(self.hud_monitor)
+
         sleep(0.5)
         self.hud = self.get_hud_controller()
 
@@ -35,10 +67,15 @@
         self.assertEqual(1, len(controllers))
         return controllers[0]
 
+    def get_hud_launcher_icon(self):
+        icons = HudLauncherIcon.get_all_instances()
+        self.assertEqual(1, len(icons))
+        return icons[0]
+
     def get_num_active_launcher_icons(self):
         num_active = 0
         for icon in self.launcher.model.get_launcher_icons():
-            if icon.quirk_active and icon.quirk_visible:
+            if icon.active and icon.visible:
                 num_active += 1
         return num_active
 
@@ -51,8 +88,32 @@
             sleep(1)
             if self.hud.visible:
                 break
+
         self.assertTrue(self.hud.visible, "HUD did not appear.")
 
+    def test_hud_is_on_right_monitor(self):
+        """Tests if the hud is shown and fits the monitor where it should be"""
+        self.reveal_hud()
+        self.assertThat(self.hud_monitor, Equals(self.hud.monitor))
+        self.assertTrue(self.screen_geo.is_rect_on_monitor(self.hud.monitor, self.hud.geometry))
+
+    def test_hud_geometries(self):
+        """Tests the HUD geometries for the given monitor and status"""
+        self.reveal_hud()
+        monitor_geo = self.screen_geo.get_monitor_geometry(self.hud_monitor)
+        monitor_x = monitor_geo[0]
+        monitor_w = monitor_geo[2]
+        hud_x = self.hud.geometry[0]
+        hud_w = self.hud.geometry[2]
+
+        if self.hud_locked:
+            self.assertThat(hud_x, GreaterThan(monitor_x))
+            self.assertThat(hud_x, LessThan(monitor_x + monitor_w))
+            self.assertThat(hud_w, Equals(monitor_x + monitor_w - hud_x))
+        else:
+            self.assertThat(hud_x, Equals(monitor_x))
+            self.assertThat(hud_w, Equals(monitor_w))
+
     def test_no_initial_values(self):
         self.reveal_hud()
         self.assertThat(self.hud.num_buttons, Equals(0))
@@ -126,6 +187,11 @@
         apps as active.
 
         """
+        launcher = self.launcher.get_launcher_for_monitor(self.hud_monitor)
+
+        if not launcher:
+            self.skipTest("The monitor %d has not a launcher" % self.hud_monitor)
+
         # We need an app to switch to:
         self.start_app('Character Map')
         # We need an application to play with - I'll use the calculator.
@@ -144,8 +210,8 @@
             sleep(0.5)
 
         # click application icons for running apps in the launcher:
-        icon = self.launcher.model.get_icon_by_tooltip_text("Character Map")
-        self.launcher.get_launcher_for_monitor(0).click_launcher_icon(icon)
+        icon = self.launcher.model.get_icon_by_desktop_id("gucharmap.desktop")
+        launcher.click_launcher_icon(icon)
 
         # see how many apps are marked as being active:
         num_active = self.get_num_active_launcher_icons()
@@ -211,3 +277,85 @@
         contents = open("/tmp/autopilot_gedit_undo_test_temp_file.txt").read().strip('\n')
         self.assertEqual("0 ", contents)
 
+    def test_hud_does_not_change_launcher_status(self):
+        """Tests if the HUD reveal keeps the launcher in the status it was"""
+
+        launcher = self.launcher.get_launcher_for_monitor(self.hud_monitor)
+
+        if not launcher:
+            self.skipTest("The monitor %d has not a launcher" % self.hud_monitor)
+
+        launcher_shows_pre = launcher.is_showing()
+        sleep(.25)
+
+        self.reveal_hud()
+        sleep(1)
+
+        launcher_shows_post = launcher.is_showing()
+        self.assertThat(launcher_shows_pre, Equals(launcher_shows_post))
+
+    def test_hud_is_locked_to_launcher(self):
+        """Tests if the HUD is locked to launcher as we expect or not"""
+        self.reveal_hud()
+        sleep(.25)
+
+        self.assertThat(self.hud.is_locked_to_launcher, Equals(self.hud_locked))
+
+    def test_hud_icon_is_shown(self):
+        """Tests that the correct HUD icon is shown"""
+        self.reveal_hud()
+        sleep(.5)
+
+        hud_icon = self.get_hud_launcher_icon()
+
+        # FIXME this should check self.hud.is_locked_to_launcher
+        # but the HUD icon is currently shared between launchers.
+        if self.launcher_hide_mode == 0:
+            self.assertTrue(hud_icon.visible)
+            self.assertFalse(hud_icon.desaturated)
+
+            # FIXME remove this once the issue above has been resolved
+            if self.hud.is_locked_to_launcher:
+                self.assertFalse(self.hud.show_embedded_icon)
+        else:
+            self.assertTrue(self.hud.show_embedded_icon)
+            self.assertFalse(hud_icon.visible)
+
+    def test_hud_launcher_icon_hides_bfb(self):
+        """Tests that the BFB icon is hidden when the HUD launcher icon is shown"""
+        if not self.hud.is_locked_to_launcher:
+            self.skipTest("This test needs a locked launcher")
+
+        hud_icon = self.get_hud_launcher_icon()
+
+        icons = BFBLauncherIcon.get_all_instances()
+        self.assertEqual(1, len(icons))
+        bfb_icon = icons[0]
+
+        self.assertTrue(bfb_icon.visible)
+        self.assertFalse(hud_icon.visible)
+        sleep(.25)
+
+        self.reveal_hud()
+        sleep(.5)
+
+        self.assertTrue(hud_icon.visible)
+        self.assertFalse(bfb_icon.visible)
+
+    def test_hud_desaturates_launcher_icons(self):
+        """Tests that the launcher icons are desaturates when HUD is open"""
+        if not self.hud.is_locked_to_launcher:
+            self.skipTest("This test needs a locked launcher")
+
+        self.reveal_hud()
+        sleep(.5)
+
+        hud_icon = self.get_hud_launcher_icon()
+        desaturated = True
+
+        for icon in self.launcher.model.get_launcher_icons():
+            if (not isinstance(icon, HudLauncherIcon) and not icon.desaturated):
+                desaturated = False
+                break
+
+        self.assertTrue(desaturated)