Merge lp:~macslow/unity/unity.fix-870284 into lp:unity

[Mirco Müller]

Using UBus to inform the Dash about the initiation of the scale-plugin (spread), thus it always closes correctly.

[Tim Penhey (thumper)]

Hi Mirco,

Now the glorious question, how about a test?

This should be easy enough to write an auto-pilot test for. Everyone needs to start somewhere :)

review: Needs Fixing

[Marco Trevisan (Treviño) (3v1n0)]

Also, since you're on it, please add also the symmetric UBUS_SCALE_TERMINATED signal, as it could be useful.

[Mirco Müller (macslow)]

Ok.

[lp:~macslow/unity/unity.fix-870284]

1978. By Mirco Müller on 2012-02-28

Added autopilot-test and extended required infrastructure for catching any regressions regarding LP: #870284

1979. By Mirco Müller on 2012-02-28

Still trying to make the autopilot-test work... this is so much fun

1980. By Mirco Müller on 2012-02-28

Re-merged with trunk... solved merge-conflicts... grrrrr... hope nothing breaks

1981. By Mirco Müller on 2012-02-28

More fixing after re-merge with trunk

1982. By Mirco Müller on 2012-02-28

Further trying to get the autopilot test to work

[Mirco Müller (macslow)]

I've pushed the branch to lp:~unity-team/unity/unity.fix-870284 and there are a couple of updates to it.

Unmerged revisions

1982. By Mirco Müller on 2012-02-28

Further trying to get the autopilot test to work

1981. By Mirco Müller on 2012-02-28

More fixing after re-merge with trunk

1980. By Mirco Müller on 2012-02-28

Re-merged with trunk... solved merge-conflicts... grrrrr... hope nothing breaks

1979. By Mirco Müller on 2012-02-28

Still trying to make the autopilot-test work... this is so much fun

1978. By Mirco Müller on 2012-02-28

Added autopilot-test and extended required infrastructure for catching any regressions regarding LP: #870284

1977. By Mirco Müller on 2012-02-17

Inform the Dash via ubus that the scale-plugin was activated and close itself

=== modified file 'plugins/unityshell/src/DashController.cpp'
--- plugins/unityshell/src/DashController.cpp	2012-02-21 02:46:18 +0000
+++ plugins/unityshell/src/DashController.cpp	2012-02-28 23:27:18 +0000
@@ -42,6 +42,7 @@
   , window_(0)
   , visible_(false)
   , need_show_(false)
+  , spread_active_(false)
   , timeline_id_(0)
   , last_opacity_(0.0f)
   , start_time_(0)
@@ -129,6 +130,10 @@
       HideDash(true);
     }
   });
+  ubus_manager_.RegisterInterest(UBUS_SCALE_INITIATED,
+                                 sigc::mem_fun(this, &Controller::OnScaleInitiated));
+  ubus_manager_.RegisterInterest(UBUS_SCALE_TERMINATED,
+                                 sigc::mem_fun(this, &Controller::OnScaleTerminated));
 }
 
 void Controller::EnsureDash()
@@ -343,6 +348,22 @@
   ShowDash();
 }
 
+void Controller::OnScaleInitiated(GVariant* variant)
+{
+  HideDash(true);
+
+  // needed so the spread is testable via autopilot, also a means to protect
+  // against regressions for 870284
+  spread_active_ = true;
+}
+
+void Controller::OnScaleTerminated(GVariant* variant)
+{
+  // needed so the spread is testable via autopilot, also a means to protect
+  // against regressions for 870284
+  spread_active_ = false;
+}
+
 gboolean Controller::CheckShortcutActivation(const char* key_string)
 {
   EnsureDash();
@@ -370,6 +391,7 @@
 void Controller::AddProperties(GVariantBuilder* builder)
 {
   g_variant_builder_add (builder, "{sv}", "visible", g_variant_new_boolean (visible_) );
+  g_variant_builder_add (builder, "{sv}", "spread_active", g_variant_new_boolean (spread_active_) );
 }
 
 

=== modified file 'plugins/unityshell/src/DashController.h'
--- plugins/unityshell/src/DashController.h	2012-02-15 10:54:48 +0000
+++ plugins/unityshell/src/DashController.h	2012-02-28 23:27:18 +0000
@@ -74,6 +74,8 @@
   void OnExternalShowDash(GVariant* variant);
   void OnExternalHideDash(GVariant* variant);
   void OnActivateRequest(GVariant* variant);
+  void OnScaleInitiated(GVariant* variant);
+  void OnScaleTerminated(GVariant* variant);
 
   void ShowDash();
   void HideDash(bool restore_focus = true);
@@ -90,6 +92,7 @@
   nux::BaseWindow* window_;
   bool visible_;
   bool need_show_;
+  bool spread_active_;
 
   guint timeline_id_;
   float last_opacity_;

=== modified file 'plugins/unityshell/src/PluginAdapter.cpp'
--- plugins/unityshell/src/PluginAdapter.cpp	2012-02-22 09:55:54 +0000
+++ plugins/unityshell/src/PluginAdapter.cpp	2012-02-28 23:27:18 +0000
@@ -20,6 +20,8 @@
 #include <glib.h>
 #include <sstream>
 #include "PluginAdapter.h"
+#include "ubus-server.h"
+#include "UBusMessages.h"
 
 #include <NuxCore/Logger.h>
 
@@ -354,6 +356,10 @@
   argument[0].value().set(m);
 
   m_ScaleActionList.InitiateAll(argument, state);
+
+  ubus_server_send_message(ubus_server_get_default(),
+                           UBUS_SCALE_INITIATED,
+                           nullptr);
 }
 
 void
@@ -361,6 +367,10 @@
 {
   CompOption::Vector argument(0);
   m_ScaleActionList.TerminateAll(argument);
+
+  ubus_server_send_message(ubus_server_get_default(),
+                           UBUS_SCALE_TERMINATED,
+                           nullptr);
 }
 
 bool

=== modified file 'plugins/unityshell/src/UBusMessages.h'
--- plugins/unityshell/src/UBusMessages.h	2012-02-07 07:42:12 +0000
+++ plugins/unityshell/src/UBusMessages.h	2012-02-28 23:27:18 +0000
@@ -84,4 +84,8 @@
 #define UBUS_SWITCHER_SHOWN             "SWITCHER_SHOWN"
 #define UBUS_SWITCHER_SELECTION_CHANGED "SWITCHER_SELECTION_CHANGED"
 
+// Signal used to securely tell the Dash "Scale" has been triggered
+#define UBUS_SCALE_INITIATED "SCALE_INITIATED"
+#define UBUS_SCALE_TERMINATED "SCALE_TERMINATED"
+ 
 #endif // UBUS_MESSAGES_H

=== added file 'tests/autopilot/autopilot/emulators/unity/spread.py'
--- tests/autopilot/autopilot/emulators/unity/spread.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/autopilot/emulators/unity/spread.py	2012-02-28 23:27:18 +0000
@@ -0,0 +1,77 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2012 Canonical
+# Author: Mirco "MacSlow" Müller <[e-mail]>
+#
+# 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
+# by the Free Software Foundation.
+#
+
+import os
+from compizconfig import Setting, Plugin
+from time import sleep
+
+from autopilot.globals import global_context
+from autopilot.emulators.unity import get_state_by_path
+from autopilot.emulators.X11 import Keyboard
+
+import logging
+logger = logging.getLogger(__name__)
+
+
+class Spread(object):
+    """
+    An emulator class that makes it easier to interact with the spread of unity.
+    """
+
+    def __init__(self):
+        self.plugin = Plugin(global_context, "unityshell")
+        self.setting = Setting(self.plugin, "show_launcher")
+        self._keyboard = Keyboard()
+        super(Spread, self).__init__()
+
+    def toggle_active(self):
+        """
+        Activates the spread if it is currently inactive, deactivates it otherwise.
+        """
+        logger.debug("Toggling spread with Super-W key-combo.")
+        self._keyboard.press_and_release("Super+w")
+        sleep(1)
+
+    def ensure_active(self):
+        """
+        Ensures the dash is active.
+        """
+        if not self.get_is_active():
+            self.toggle_active()
+
+    def ensure_inactive(self):
+        """
+        Ensures the spread is not active.
+        """
+        if self.get_is_active():
+            self.toggle_reveal()
+
+    def get_is_active(self):
+        """
+        Is the spread active?
+        """
+        return bool(get_state_by_path("/Unity/DashController")[0]["spread_active"])
+
+	def open_some_apps(self):
+		"""
+		Open some application windows (non-blocking).
+		"""
+		#os.spawnlp(os.P_NOWAIT, "gnome-terminal")
+		os.spawnlp(os.P_NOWAIT, "gedit")
+		os.spawnlp(os.P_NOWAIT, "gnome-calculator")
+		os.spawnlp(os.P_NOWAIT, "gnome-control-center")
+
+	def close_some_apps(self):
+		"""
+		Close those application windows (blocking).
+		"""
+		#os.spawnlp(os.P_WAIT, "killall -15 gnome-terminal")
+		os.spawnlp(os.P_WAIT, "killall -15 gedit")
+		os.spawnlp(os.P_WAIT, "killall -15 gnome-calculator")
+		os.spawnlp(os.P_WAIT, "killall -15 gnome-control-center")

=== modified file 'tests/autopilot/autopilot/tests/test_dash.py'
--- tests/autopilot/autopilot/tests/test_dash.py	2012-02-27 03:56:46 +0000
+++ tests/autopilot/autopilot/tests/test_dash.py	2012-02-28 23:27:18 +0000
@@ -10,6 +10,7 @@
 from time import sleep
 
 from autopilot.emulators.unity.dash import Dash
+from autopilot.emulators.unity.spread import Spread
 from autopilot.emulators.X11 import Keyboard, Mouse
 from autopilot.tests import AutopilotTestCase
 from autopilot.glibrunner import GlibRunner
@@ -395,3 +396,21 @@
         searchbar = self.dash.get_searchbar()
         self.assertEqual("hello world", searchbar.search_string)
 
+
+    def test_spread(self):
+        """ This test makes sure, that an active window-spread is
+        automatically terminated as soon as the dash is opened.
+        """
+        kb = Keyboard()
+		self.spread = Spread()
+        self.dash.ensure_hidden()
+        self.spread.open_some_apps()
+        self.spread.ensure_inactive()
+        self.spread.ensure_active()
+        self.dash.toggle_reveal()
+        self.assertTrue(self.dash.get_is_visible())
+        self.assertFalse(self.spread.get_is_active())
+        self.spread.close_some_apps()
+        self.dash.toggle_reveal()
+        self.assertFalse(self.dash.get_is_visible())
+

=== modified file 'tests/autopilot/setup.py' (properties changed: -x to +x)