Merge lp:~brandontschaefer/unity/ap-panel-test-fix into lp:unity

[Brandon Schaefer]

Make test_panel.py use the OverlayWindowButtons when dealing with the dash window buttons. Fixes: test_window_buttons_maximization_buttons_works_for_dash, also splits that test into these: test_window_buttons_maximize_or_restore_dash, test_window_buttons_active_inactive_states, test_window_buttons_state_switch_on_click.

Splits this test:
- test_window_buttons_maximization_buttons_works_for_dash

Into these 3:
- test_window_buttons_maximize_or_restore_dash
- test_window_buttons_active_inactive_states
- test_window_buttons_state_switch_on_click

While fixing the real problem of the panel window buttons being used vs the Overlay window buttons that should be used.

[Andrea Azzarone (azzar1)]

review: Approve

[Brandon Schaefer (brandontschaefer)]

Err, did I not merge this?

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

[Sebastien Bacher (seb128)]

Seems like that commit created issues, at least one of the test is failing to pass on today's runs:

http://10.97.0.1:8080/job/ps-generic-autopilot-release-testing/label=autopilot-ati/18/testReport/unity.tests.test_panel/PanelWindowButtonsTests/test_window_buttons_active_inactive_states_Single_Monitor_/

"Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/unity/tests/test_panel.py", line 541, in test_window_buttons_active_inactive_states
    unmaximize = self.unity.dash.view.window_buttons.unmaximize
  File "/usr/lib/python2.7/dist-packages/unity/emulators/dash.py", line 191, in window_buttons
    return self.__get_window_buttons().window_buttons()
  File "/usr/lib/python2.7/dist-packages/unity/emulators/dash.py", line 164, in __get_window_buttons
    assert(len(buttons) == 1)
AssertionError"

seems like
"buttons = self.get_children_by_type(OverlayWindowButtons)"

returns [] (tested on a local run, it's happening in a consistant way)

[Brandon Schaefer (brandontschaefer)]

O dang, sorry, Ill look into that!

=== modified file 'tests/autopilot/unity/emulators/dash.py'
--- tests/autopilot/unity/emulators/dash.py	2013-02-04 19:54:47 +0000
+++ tests/autopilot/unity/emulators/dash.py	2013-03-28 20:24:29 +0000
@@ -13,6 +13,8 @@
 from autopilot.keybindings import KeybindingsHelper
 from testtools.matchers import GreaterThan
 
+from unity.emulators.panel import WindowButtons
+
 from unity.emulators import UnityIntrospectionObject
 import logging
 import dbus
@@ -148,6 +150,12 @@
 class DashView(UnityIntrospectionObject):
     """The dash view."""
 
+    def __get_window_buttons(self):
+        """Return the overlay window buttons view."""
+        buttons = self.get_children_by_type(OverlayWindowButtons)
+        assert(len(buttons) == 1)
+        return buttons[0]
+
     def get_searchbar(self):
         """Get the search bar attached to this dash view."""
         return self.get_children_by_type(SearchBar)[0]
@@ -170,6 +178,18 @@
             return preview_container
         return None
 
+    @property
+    def window_buttons(self):
+        return self.__get_window_buttons().window_buttons()
+
+
+class OverlayWindowButtons(UnityIntrospectionObject):
+    """The Overlay window buttons class"""
+
+    def window_buttons(self):
+        buttons = self.get_children_by_type(WindowButtons)
+        assert(len(buttons) == 1)
+        return buttons[0]
 
 class SearchBar(UnityIntrospectionObject):
     """The search bar for the dash view."""

=== modified file 'tests/autopilot/unity/tests/test_panel.py'
--- tests/autopilot/unity/tests/test_panel.py	2013-02-26 16:19:15 +0000
+++ tests/autopilot/unity/tests/test_panel.py	2013-03-28 20:24:29 +0000
@@ -516,72 +516,71 @@
         sleep(5)
         self.assertThat(self.unity.dash.visible, Eventually(Equals(True)))
 
-    def test_window_buttons_maximization_buttons_works_for_dash(self):
-        """'Maximize' and 'Restore' buttons (when both enabled) must work as expected."""
-        # Mega-TODO:
-        #
-        # This test is terrible. The docstring is terrible. The test id is terrible.
-        # Someone needs to split this into several smaller tests. However, I'm
-        # not doing that in this branch. Consider this an invitation to split
-        # this test out and make it suck less.
-        #
-        # For your sanity I have annotated it with comments.
-        self.unity.dash.ensure_visible()
-        self.addCleanup(self.panel.window_buttons.close.mouse_click)
-
-        unmaximize = self.panel.window_buttons.unmaximize
-        maximize = self.panel.window_buttons.maximize
-
-        # "netbook" means "dash is maximised"
-        dash_maximised = (self.unity.dash.view.form_factor == "netbook")
-
-        # this if statement will trigger only when we're on very small screens,
-        # where it doesn't make sense to have the dash anything other than
-        # maximised.
-        if dash_maximised and not unmaximize.enabled:
-            unmaximize.mouse_click()
-            # nice long sleep to make sure that any changes have time to process.
-            sleep(5)
-            self.assertThat(self.unity.dash.view.form_factor, Equals("netbook"))
-        else:
-            # we are able to resize the dash.
-            # maximise and unmaximise (restore) buttons are shown in the same place
-            # but only one is shown at once:
-            if maximize.visible:
-                active_button = maximize
-                inactive_button = unmaximize
-            else:
-                active_button = unmaximize
-                inactive_button = maximize
-
-            self.assertThat(active_button.visible, Eventually(Equals(True)))
-            self.assertThat(active_button.sensitive, Eventually(Equals(True)))
-            self.assertThat(active_button.enabled, Eventually(Equals(True)))
-            self.assertThat(inactive_button.visible, Eventually(Equals(False)))
-
-            self.addCleanup(inactive_button.mouse_click)
-            active_button.mouse_click()
-
-            self.assertThat(inactive_button.visible, Eventually(Equals(True)))
-            self.assertThat(inactive_button.sensitive, Eventually(Equals(True)))
-            self.assertThat(inactive_button.enabled, Eventually(Equals(True)))
-            self.assertThat(active_button.visible, Eventually(Equals(False)))
-
-            if dash_maximised:
-                self.assertThat(self.unity.dash.view.form_factor, Eventually(Equals("desktop")))
-            else:
-                self.assertThat(self.unity.dash.view.form_factor, Eventually(Equals("netbook")))
-
-            self.addCleanup(active_button.mouse_click)
-            inactive_button.mouse_click()
-
-            self.assertThat(active_button.visible, Eventually(Equals(True)))
-            self.assertThat(inactive_button.visible, Eventually(Equals(False)))
-
-            if dash_maximised:
-                self.assertThat(self.unity.dash.view.form_factor, Eventually(Equals("netbook")))
-            else:
-                self.assertThat(self.unity.dash.view.form_factor, Eventually(Equals("desktop")))
+    def test_window_buttons_maximize_or_restore_dash(self):
+        """Tests that the Maximize/Restore button works for the dash."""
+
+        self.unity.dash.ensure_visible()
+        self.addCleanup(self.unity.dash.ensure_hidden)
+
+        desired_max = not self.unity.dash.view.dash_maximized
+        if desired_max:
+            self.panel.window_buttons.maximize.mouse_click()
+        else:
+            self.panel.window_buttons.unmaximize.mouse_click()
+
+        self.assertThat(self.unity.dash.view.dash_maximized, Eventually(Equals(desired_max)))
+
+    def test_window_buttons_active_inactive_states(self):
+        """Tests that the maximized/restore buttons are in the correct state when the
+        dash is open. Asserting states: visible, sensitive, enabled.
+        """
+
+        self.unity.dash.ensure_visible()
+        self.addCleanup(self.unity.dash.ensure_hidden)
+
+        unmaximize = self.unity.dash.view.window_buttons.unmaximize
+        maximize = self.unity.dash.view.window_buttons.maximize
+
+        desired_max = not self.unity.dash.view.dash_maximized
+        if desired_max:
+            active   = maximize
+            inactive = unmaximize
+        else:
+            active   = unmaximize
+            inactive = maximize
+
+        self.assertThat(active.visible, Eventually(Equals(True)))
+        self.assertThat(active.sensitive, Eventually(Equals(True)))
+        self.assertThat(active.enabled, Eventually(Equals(True)))
+        self.assertThat(inactive.visible, Eventually(Equals(False)))
+
+    def test_window_buttons_state_switch_on_click(self):
+        """Tests that when clicking the maximize/restore window button it
+        switchs its state from either maximize to restore, or restore to
+        maximize.
+        """
+
+        self.unity.dash.ensure_visible()
+        self.addCleanup(self.unity.dash.ensure_hidden)
+
+        unmaximize = self.unity.dash.view.window_buttons.unmaximize
+        maximize = self.unity.dash.view.window_buttons.maximize
+
+        desired_max = not self.unity.dash.view.dash_maximized
+        if desired_max:
+            active   = maximize
+            inactive = unmaximize
+        else:
+            active   = unmaximize
+            inactive = maximize
+
+        active.mouse_click()
+
+        self.assertThat(inactive.visible, Eventually(Equals(True)))
+        self.assertThat(inactive.sensitive, Eventually(Equals(True)))
+        self.assertThat(inactive.enabled, Eventually(Equals(True)))
+        self.assertThat(active.visible, Eventually(Equals(False)))
+        self.assertThat(self.unity.dash.view.dash_maximized, Eventually(Equals(desired_max)))
 
     def test_minimize_button_disabled_for_non_minimizable_windows(self):
         """Minimize button must be disabled for windows that don't support minimization."""

=== modified file 'unity-shared/OverlayWindowButtons.cpp'
--- unity-shared/OverlayWindowButtons.cpp	2013-02-08 20:23:28 +0000
+++ unity-shared/OverlayWindowButtons.cpp	2013-03-28 20:24:29 +0000
@@ -36,6 +36,7 @@
   : nux::BaseWindow("OverlayWindowButtons")
   , window_buttons_(new WindowButtons())
 {
+  AddChild(window_buttons_.GetPointer());
   UpdateGeometry();
   SetBackgroundColor(nux::color::Transparent);
 }
@@ -86,4 +87,14 @@
   window_buttons_->ProcessDraw(gfx_context, true);
 }
 
+
+// Introspection
+std::string OverlayWindowButtons::GetName() const
+{
+  return "OverlayWindowButtons";
+}
+
+void OverlayWindowButtons::AddProperties(GVariantBuilder* builder)
+{}
+
 } // namespace unity

=== modified file 'unity-shared/OverlayWindowButtons.h'
--- unity-shared/OverlayWindowButtons.h	2013-01-29 00:32:06 +0000
+++ unity-shared/OverlayWindowButtons.h	2013-03-28 20:24:29 +0000
@@ -28,7 +28,7 @@
 namespace unity
 {
 
-class OverlayWindowButtons : public nux::BaseWindow
+class OverlayWindowButtons : public nux::BaseWindow, public debug::Introspectable
 {
   NUX_DECLARE_OBJECT_TYPE(OverlayWindowButtons, nux::BaseWindow);
 public:
@@ -43,6 +43,9 @@
 protected:
   void Draw(nux::GraphicsEngine& gfx_context, bool force_draw);
 
+  std::string GetName() const;
+  void AddProperties(GVariantBuilder* builder);
+  
 private:
   void UpdateGeometry();