Merge lp:~ralsina/ubuntuone-windows-installer/show_spinner into lp:ubuntuone-windows-installer

[Roberto Alsina]

Make all server-related actions show the overlay, and remove it when showing a page.

Make all server-related actions show the overlay, and remove it when showing a page.

To test IRL, start the wizard from this branch, and try to login, register a new acoount, reset password, etc. Whenever there is a lengthy operation, you should see the overlay being shown, and it should
disappear when the new page appears.

set PYTHONPATH=..\ubuntuone-client;..\ubuntuone-control-panel;..\ubuntu-sso-client;.
python bin\ubuntuone-installer-qt

[Natalia Bidart (nataliabidart)]

Code looks good. Overlay shows up when trying to register, but it will not go away if there is any error in the form.

review: Needs Fixing

[Natalia Bidart (nataliabidart)]

* There are 2 spaces here:

+ from ubuntu_sso.qt import controllers

* This docstring is not pep8 compliant:

+ """A custom forgotten password controller.
+
+ This controller hides the overlay as needed."""

should be:

+ """A custom forgotten password controller.
+
+ This controller hides the overlay as needed.
+ """

* Why are you passing new "extra" parameters called message_box?

review: Needs Fixing

[Roberto Alsina (ralsina)]

The "extra" parameter is so that when the controller calls message_box.critical() instead of just displaying a QtGui.QMessageBox, it calls MainWindow.critical(), which hides the overlay, then shws the message box.

That way, I can ensure that the overlay is hidden when there is a popup and next() is not called.

Pushed the style fixes.

[Natalia Bidart (nataliabidart)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

Attempt to merge into lp:ubuntuone-windows-installer failed due to conflicts:

text conflict in data/qt/setup_account.ui
text conflict in ubuntuone_installer/gui/qt/gui.py
text conflict in ubuntuone_installer/gui/qt/tests/test_gui.py

[lp:~ralsina/ubuntuone-windows-installer/show_spinner]

33. By Roberto Alsina on 2011-07-22

solve merge conflicts

34. By Roberto Alsina on 2011-07-22

use unix EOLs

=== modified file 'data/qt/setup_account.ui'
--- data/qt/setup_account.ui	2011-07-15 23:12:44 +0000
+++ data/qt/setup_account.ui	2011-07-22 19:09:31 +0000
@@ -234,7 +234,7 @@
      <item>
       <widget class="QPushButton" name="terms_button">
        <property name="text">
-        <string>Shw terms</string>
+        <string>Show terms</string>
        </property>
       </widget>
      </item>

=== added file 'ubuntuone_installer/gui/qt/forgotten.py'
--- ubuntuone_installer/gui/qt/forgotten.py	1970-01-01 00:00:00 +0000
+++ ubuntuone_installer/gui/qt/forgotten.py	2011-07-22 19:09:31 +0000
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+# Authors: Roberto Alsina <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# 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.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Custom forgotten password controller."""
+
+from ubuntu_sso.qt import controllers
+
+
+class ForgottenPasswordController(controllers.ForgottenPasswordController):
+    """A custom forgotten password controller.
+
+    This controller hides the overlay as needed.
+    """
+
+    def on_password_reset_error(self, app_name, error):
+        """Hide the overlay, then do as the default controller does."""
+        self.view.wizard().overlay.hide()
+        super(ForgottenPasswordController,
+            self).on_password_reset_error(app_name, error)

=== modified file 'ubuntuone_installer/gui/qt/gui.py'
--- ubuntuone_installer/gui/qt/gui.py	2011-07-22 16:32:35 +0000
+++ ubuntuone_installer/gui/qt/gui.py	2011-07-22 19:09:31 +0000
@@ -46,13 +46,14 @@
     CurrentUserController,
     EmailVerificationController,
     ErrorController,
-    ForgottenPasswordController,
     ResetPasswordController,
     SetUpAccountController,
     SuccessController,
     TosController,
 )
 
+from ubuntuone.controlpanel.gui.qt.loadingoverlay import LoadingOverlay
+
 from ubuntuone.credentials import (
     APP_NAME,
     DESCRIPTION,
@@ -73,6 +74,7 @@
 # pylint: enable=W0611
 
 from ubuntuone_installer.gui.qt.are_you_sure import AreYouSure
+from ubuntuone_installer.gui.qt.forgotten import ForgottenPasswordController
 from ubuntuone_installer.gui.qt.local_folders import LocalFoldersPage
 from ubuntuone_installer.gui.qt.sync_now_or_later import SyncNowOrLaterPage
 from ubuntuone_installer.gui.qt.setup_account import SetupAccountPage
@@ -302,6 +304,8 @@
         self.close_callback = close_callback
 
         self.setSideWidget(SideWidget())
+        self.overlay = LoadingOverlay(self)
+        self.overlay.hide()
 
         self.setOption(self.NoBackButtonOnStartPage, True)
 
@@ -318,38 +322,56 @@
             ui=choose_sign_in_ui.Ui_ChooseSignInPage(),
             controller=self.sign_in_controller,
             parent=self)
-        self.setup_controller = SetUpAccountController()
+
+        self.setup_controller = SetUpAccountController(message_box=self)
         self.setup_account = SetupAccountPage(
             setup_account_ui.Ui_SetUpAccountPage(),
             self.setup_controller,
             parent=self)
+        self.setup_account.ui.set_up_button.clicked.connect(
+            self.overlay.show)
+
         title_page = TITLE_STYLE % _("Ubuntu One Terms of Service")
         self.tos = TosPage(Ui_TosPage(),
             TosController(tos_url=TC_URL,
                 title=title_page),
             parent=self)
+
         self.email_verification = EmailVerificationPage(
                                                 Ui_EmailVerificationPage(),
                                                 EmailVerificationController())
+        self.email_verification.next_button.clicked.connect(
+            self.overlay.show)
+
         title_page = TITLE_STYLE % SIGN_IN
         self.current_user_controller = CurrentUserController(
-            title=title_page, subtitle=SIGN_IN_SUBTITLE)
+            title=title_page, subtitle=SIGN_IN_SUBTITLE,
+            message_box=self)
         self.current_user = CurrentUserSignInPage(Ui_CurrentUserSignInPage(),
                                                   self.current_user_controller,
                                                   parent=self)
+        self.current_user.ui.sign_in_button.clicked.connect(
+            self.overlay.show)
+
         self.success_controller = SuccessController()
         self.success = SuccessPage(Ui_SuccessPage(), self.success_controller,
                                    parent=self)
         self.error_controller = ErrorController()
         self.error = ErrorPage(Ui_ErrorPage(), self.error_controller)
+
         self.forgotten_pwd_controller = ForgottenPasswordController()
         self.forgotten = ForgottenPasswordPage(Ui_ForgottenPasswordPage(),
                                                self.forgotten_pwd_controller,
                                                parent=self)
+        self.forgotten.ui.send_button.clicked.connect(
+            self.overlay.show)
+
         self.reset_password_controller = ResetPasswordController()
         self.reset_password = ResetPasswordPage(Ui_ResetPasswordPage(),
                                                 self.reset_password_controller,
                                                 parent=self)
+        self.reset_password.ui.reset_password_button.clicked.connect(
+            self.overlay.show)
 
         self.SIGNIN_PAGE = self.addPage(self.sign_in_page)
         self.setup_account_page_id = self.addPage(self.setup_account)
@@ -376,6 +398,15 @@
     # Invalid name "closeEvent"
     # pylint: disable=C0103
 
+    def critical(self, *args, **kwargs):
+        """Wrapper for QMessageBox.critical that hides the overlay."""
+        self.overlay.hide()
+        QtGui.QMessageBox.critical(*args, **kwargs)
+
+    def next(self):
+        self.overlay.hide()
+        super(MainWindow, self).next()
+
     def nextId(self):
         """Selects which page to display next."""
         if self._next_id is not None:

=== modified file 'ubuntuone_installer/gui/qt/tests/test_gui.py'
--- ubuntuone_installer/gui/qt/tests/test_gui.py	2011-07-22 16:32:35 +0000
+++ ubuntuone_installer/gui/qt/tests/test_gui.py	2011-07-22 19:09:31 +0000
@@ -36,6 +36,7 @@
 from ubuntuone_installer.gui.qt import gui
 from ubuntuone_installer.gui.qt.tests import BaseTestCase
 from ubuntuone_installer.gui.qt import embedded_sso
+from ubuntuone_installer.gui.qt import forgotten
 from ubuntuone_installer.gui.qt import local_folders
 from ubuntuone_installer.gui.qt import setup_account
 from ubuntuone_installer.gui.qt.ui import (
@@ -80,6 +81,25 @@
         return self.result  # Means reject
 
 
+class FakeOverlay(object):
+
+    """A fake delay overlay."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize."""
+        self.show_counter = 0
+        self.hide_counter = 0
+        self.args = (args, kwargs)
+
+    def show(self):
+        """Fake show."""
+        self.show_counter += 1
+
+    def hide(self):
+        """Fake hide."""
+        self.hide_counter += 1
+
+
 class MainWindowTestCase(BaseTestCase):
     """Test the qt main window."""
 
@@ -97,8 +117,66 @@
         self.patch(gui, "ForgottenPasswordController", FakeController)
         self.patch(gui, "ResetPasswordController", FakeController)
         self.patch(gui, "AreYouSure", FakeAreYouSure)
+        self.patch(gui, "LoadingOverlay", FakeOverlay)
         super(MainWindowTestCase, self).setUp()
 
+    def test_critical(self):
+        """Show a critical popup, but first hide the overlay."""
+        self.assertEqual(self.ui.overlay.hide_counter, 1)
+        self.patch(gui.QtGui.QMessageBox, "critical", self._set_called)
+        self.ui.critical("WORRY!")
+        self.assertEqual(self.ui.overlay.hide_counter, 2)
+        self.assertEqual(self._called, (('WORRY!',), {}))
+
+    def test_forgotten_password_controller_error(self):
+        """When there is an error, it should hide the overlay."""
+        self.assertEqual(self.ui.overlay.hide_counter, 1)
+        controller = forgotten.ForgottenPasswordController()
+        controller.view = self.ui.forgotten
+        controller.on_password_reset_error("app_name",
+            {'errtype': 'ResetPasswordTokenError'})
+        self.assertEqual(self.ui.overlay.hide_counter, 2)
+
+    def test_overlay_connection_setup_account(self):
+        """Make sure we don't lose connections to the overlay."""
+        self.assertEqual(self.ui.overlay.show_counter, 0)
+        # This test is different from the ones below.
+        # For some reason, click() doesn't trigger the connected
+        # slot, but clicked.emit() does. The reason is unknown.
+        self.ui.setup_account.ui.set_up_button.clicked.emit(False)
+        self.assertEqual(self.ui.overlay.show_counter, 1)
+
+    def test_overlay_connection_email_verification(self):
+        """Make sure we don't lose connections to the overlay."""
+        self.assertEqual(self.ui.overlay.show_counter, 0)
+        self.ui.email_verification.next_button.click()
+        self.assertEqual(self.ui.overlay.show_counter, 1)
+
+    def test_overlay_connection_current_user(self):
+        """Make sure we don't lose connections to the overlay."""
+        self.assertEqual(self.ui.overlay.show_counter, 0)
+        self.ui.current_user.ui.sign_in_button.click()
+        self.assertEqual(self.ui.overlay.show_counter, 1)
+
+    def test_overlay_connection_forgotten_password(self):
+        """Make sure we don't lose connections to the overlay."""
+        self.assertEqual(self.ui.overlay.show_counter, 0)
+        self.ui.forgotten.ui.send_button.click()
+        self.assertEqual(self.ui.overlay.show_counter, 1)
+
+    def test_overlay_connection_reset_password(self):
+        """Make sure we don't lose connections to the overlay."""
+        self.assertEqual(self.ui.overlay.show_counter, 0)
+        self.ui.reset_password.ui.reset_password_button.click()
+        self.assertEqual(self.ui.overlay.show_counter, 1)
+
+    def test_next_hides_overlay(self):
+        """Make sure next() hides the overlay."""
+        self.ui.next()
+        # This is 2 because we hide it once on __init__()
+        # and then again on next()
+        self.assertEqual(self.ui.overlay.hide_counter, 2)
+
     def test_done_calls_custom_close_callback(self):
         """When closing the window, close_callback is called."""
         gui.AreYouSure.result = 0
@@ -192,7 +270,8 @@
     def test_current_user_controller_parameters(self):
         """Compare controller parameters with expected values."""
         self.assertEqual(self.ui.current_user_controller.args,
-        ((), {'title': gui.TITLE_STYLE % gui.SIGN_IN,
+        ((), {'message_box': self.ui,
+              'title': gui.TITLE_STYLE % gui.SIGN_IN,
               'subtitle': gui.SIGN_IN_SUBTITLE}))
 
     def test_stage_progression_1(self):