Merge lp:~ralsina/ubuntuone-control-panel/installer-option into lp:ubuntuone-control-panel

[Roberto Alsina]

- Made the license page from the wizard be shown (only when called with --installer) (LP: #933697).

- Added the license page to the wizard (only when called with --installer) (LP: #933697).

To test IRL:

* remove credentials
* If you start u1cp, you will get the "sign in/sign up" page
* Start u1cp again with the --installer option, and you should get a license page, for which the "next" page is "signin / signup"

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Natalia Bidart (nataliabidart)]

* I wonder why you added a new method start_from_license instead of redefining setStartId in the QWizard. Any reason not to do that?

* I think that the test_first_page should not be removed, it may need some tweaks so it remains as:

    def test_first_page(self):
        """The first page is the correct one."""
        expected = self.ui.pages[self.ui.signin_page]
        self.assertEqual(self.ui.startId(), expected)

* Can you please fix the indentation of test_start_from_license so the whole 79-columns width are used? Something like (the following may need tweaking if we move to setStartId):

    def test_start_from_license(self):
        """Test the start_from_license method."""
        # Before, we start on sign_in
        assert self.ui.startId() == self.ui.pages[self.ui.signin_page]

        # After calling start_from_license, we start on license_page
        self.ui.start_from_license()
        self.assertEqual(self.ui.startId(), self.ui.pages[self.ui.license_page])

* Why did you need to change the page_id of the buttons dict in UbuntuOneWizardCloudToComputerTestCase, UbuntuOneWizardComputerToCloudTestCase and UbuntuOneWizardSettingsTestCase?

* Why the test_buttons_behavior is skipped for UbuntuOneWizardLicensePage? I see the comment you added but that does not explain to me why you need to redefine/skip it instead of making it pass. Also, why does the NextButton need to be a CommitButton?

* If we're leaving the license 'next' button to be a commit button, we don't need to store the string text of the Next button, so that can be safely removed.

review: Needs Fixing

[Roberto Alsina (ralsina)]

> * I wonder why you added a new method start_from_license instead of redefining
> setStartId in the QWizard. Any reason not to do that?

Moed start_from_license into the controlpanel as suggested.

>
> * I think that the test_first_page should not be removed, it may need some
> tweaks so it remains as:
>
> def test_first_page(self):
> """The first page is the correct one."""
> expected = self.ui.pages[self.ui.signin_page]
> self.assertEqual(self.ui.startId(), expected)

That was already covered by the new test_start_from_license test (had that exact assert).
Readded this test now since start_from_license moved, and moved the test for start_from_license
to control panel tests.

> * Can you please fix the indentation of test_start_from_license so the whole
> 79-columns width are used? Something like (the following may need tweaking if
> we move to setStartId):
>
> def test_start_from_license(self):
> """Test the start_from_license method."""
> # Before, we start on sign_in
> assert self.ui.startId() == self.ui.pages[self.ui.signin_page]
>
> # After calling start_from_license, we start on license_page
> self.ui.start_from_license()
> self.assertEqual(self.ui.startId(),
> self.ui.pages[self.ui.license_page])

Ermmmm I like the way I wrote it? It's wider now anyway because the names are longer.

>
> * Why did you need to change the page_id of the buttons dict in
> UbuntuOneWizardCloudToComputerTestCase, UbuntuOneWizardComputerToCloudTestCase
> and UbuntuOneWizardSettingsTestCase?

Because they didn't work. Those are page IDs, and since now the license page is
added as first page, all those tests failed because they IDs moved.

> * Why the test_buttons_behavior is skipped for UbuntuOneWizardLicensePage? I
> see the comment you added but that does not explain to me why you need to
> redefine/skip it instead of making it pass. Also, why does the NextButton need
> to be a CommitButton?

It has to be a CommitButton so the user can't go back to the license page.
The CommitButton doesn't trigger the same signals as NextButton, and can't find
anywhere in the docs what we may expect there. I changed the test slightly so that
we can check the text of the buttons even if they don't trigger anything by
passing None as signal name.

> * If we're leaving the license 'next' button to be a commit button, we don't
> need to store the string text of the Next button, so that can be safely
> removed.

Can't remove it, causes errors later on. Moved it so it doesn't appear to be part
of the license_page setup.

[Natalia Bidart (nataliabidart)]

> > * If we're leaving the license 'next' button to be a commit button, we don't
> > need to store the string text of the Next button, so that can be safely
> > removed.
>
> Can't remove it, causes errors later on. Moved it so it doesn't appear to be
> part
> of the license_page setup.

The line:

self.next_button_text = self.button(self.NextButton).text()

was added by me so we could restore the text in the NextButton in another page, since before we were cutomizing the text in the NextButton for the license page.

As how this branch is, the NextButton text is never changed, so there is no need to keep that hack in place. You can indeed remove it, but you have to removed from all the methods that is being used on (I tried this myself).

Thanks!

review: Needs Fixing

[Roberto Alsina (ralsina)]

> As how this branch is, the NextButton text is never changed, so there is no
> need to keep that hack in place. You can indeed remove it, but you have to
> removed from all the methods that is being used on (I tried this myself).

Ok, removing it everywhere in revno 308

[Natalia Bidart (nataliabidart)]

Looks great! Also works as expected.

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~ralsina/ubuntuone-control-panel/installer-option into lp:ubuntuone-control-panel failed. Below is the output from the failed tests.

*** Running test suite for ubuntuone/controlpanel ***
ubuntuone.controlpanel.utils.tests.test_utils
  ExceptionHandlingTestCase
    test_exception_to_error_dict ... [OK]
    test_failure_to_error_dict ... [OK]
  GetDataFileTestCase
    test_get_data_file ... [OK]
  GetProjectDirTestCase
    test_get_project_dir_none_exists ... [OK]
    test_get_project_dir_relative ... [OK]
  GetProjectDirWithConstantsTestCase
    test_get_project_dir ... [OK]
    test_get_project_dir_none_exists ... [OK]
    test_get_project_dir_relative ... [OK]
ubuntuone.controlpanel.tests
  TestCase
    runTest ... [OK]
ubuntuone.controlpanel.utils.tests.test_linux
  AutoupdaterTestCase
    test_are_updates_present ... [OK]
    test_perform_update ... [OK]
  DefaultFoldersTestCase
    test_default_folders_bad_encoding ... [OK]
    test_default_folders_empty_file ... [OK]
    test_default_folders_non_ascii ... [OK]
    test_default_folders_not_file ... [OK]
    test_default_folders_only_comments ... [OK]
    test_default_folders_parsed ... [OK]
    test_default_folders_syntax_error ... [OK]
ubuntuone.controlpanel.tests
  TestCase
    runTest ... [OK]
ubuntuone.controlpanel.tests.test_replication_client
  ReplicationsTestCase
    test_exclude ... [OK]
    test_exclude_name_in_exclusions ... [OK]
    test_exclude_name_not_in_replications ... [OK]
    test_get_exclusions ... [OK]
    test_get_replications ... [OK]
    test_no_pairing_record ... [OK]
    test_replicate ... [OK]
    test_replicate_name_not_in_exclusions ... [OK]
    test_replicate_name_not_in_replications ... [OK]
ubuntuone.controlpanel.tests
  TestCase
    runTest ... [OK]
ubuntuone.controlpanel.tests.test_sd_client
  AutoconnectTestCase
    test_disable ... [OK]
    test_disable_throws_an_error ... [...

=== modified file 'ubuntuone/controlpanel/gui/qt/controlpanel.py'
--- ubuntuone/controlpanel/gui/qt/controlpanel.py	2012-03-19 20:55:52 +0000
+++ ubuntuone/controlpanel/gui/qt/controlpanel.py	2012-03-22 12:49:18 +0000
@@ -170,3 +170,11 @@
     def on_wizard_finished(self, status):
         """Move to controlpanel if wizard ended successfully."""
         self.on_credentials_found()
+
+    @log_call(logger.info)
+    def start_from_license(self):
+        """Use the license page as first page."""
+        # license
+        self.ui.wizard.setStartId(self.ui.wizard.pages[
+            self.ui.wizard.license_page])
+        self.ui.wizard.restart()

=== modified file 'ubuntuone/controlpanel/gui/qt/gui.py'
--- ubuntuone/controlpanel/gui/qt/gui.py	2012-03-06 21:33:23 +0000
+++ ubuntuone/controlpanel/gui/qt/gui.py	2012-03-22 12:49:18 +0000
@@ -35,7 +35,7 @@
 class MainWindow(QtGui.QMainWindow):
     """The Main Window of the Control Panel."""
 
-    def __init__(self, close_callback=None):
+    def __init__(self, close_callback=None, installer=False):
         """Initialize this instance with the UI layout."""
         super(MainWindow, self).__init__()
         self.ui = mainwindow_ui.Ui_MainWindow()
@@ -46,6 +46,9 @@
             triggered=self.close)
         self.quit_action.setShortcuts(["Ctrl+q", "Ctrl+w"])
         self.addAction(self.quit_action)
+        self.installer = installer
+        if installer:
+            self.ui.control_panel.start_from_license()
         if USE_LIBUNITY:
             self.entry = Unity.LauncherEntry.get_for_desktop_id(U1_DOTDESKTOP)
         else:
@@ -84,14 +87,15 @@
     # pylint: enable=C0103
 
 
-def start(close_callback, minimized=False, with_icon=False):
+def start(close_callback, minimized=False, with_icon=False, installer=False):
     """Show the UI elements."""
     # pylint: disable=W0404, F0401
     if not minimized:
         if with_icon or minimized:
-            window = MainWindow()
+            window = MainWindow(installer=installer)
         else:
-            window = MainWindow(close_callback=close_callback)
+            window = MainWindow(close_callback=close_callback,
+                installer=installer)
         app = QtGui.QApplication.instance()
         style = QtGui.QStyle.alignedRect(
                     QtCore.Qt.LeftToRight, QtCore.Qt.AlignCenter,

=== modified file 'ubuntuone/controlpanel/gui/qt/main/__init__.py'
--- ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-03-16 21:09:40 +0000
+++ ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-03-22 12:49:18 +0000
@@ -55,6 +55,9 @@
                         default=False,
                         help="Start Ubuntu One "
                              "with an icon in the notification area.")
+    result.add_argument("--installer", dest="installer", action="store_true",
+                        default=False,
+                        help="Show the license agreement page first.")
     return result
 
 
@@ -82,6 +85,7 @@
     switch_to = args.switch_to
     minimized = args.minimized
     with_icon = args.with_icon
+    installer = args.installer
     source.main(app)
 
     data = []
@@ -92,7 +96,8 @@
 
     # Unused variable 'window', 'icon', pylint: disable=W0612
     icon, window = start(lambda: source.main_quit(app),
-                         minimized=minimized, with_icon=with_icon)
+                         minimized=minimized, with_icon=with_icon,
+                         installer=installer)
     window.switch_to(switch_to)
     # pylint: enable=W0612
     if icon:

=== modified file 'ubuntuone/controlpanel/gui/qt/main/tests/test_main.py'
--- ubuntuone/controlpanel/gui/qt/main/tests/test_main.py	2012-03-16 21:14:20 +0000
+++ ubuntuone/controlpanel/gui/qt/main/tests/test_main.py	2012-03-22 12:49:18 +0000
@@ -132,19 +132,19 @@
         """Ensure the binary name is not given to argparse."""
         main.main(["foo", "bar", sys.argv[0], "--minimized"])
         self.assertEqual(self.start.args[1],
-            {'minimized': True, 'with_icon': False})
+            {'minimized': True, 'with_icon': False, 'installer': False})
 
     def test_minimized_option(self):
         """Ensure the --minimized option is parsed and passed correctly."""
         main.main([sys.argv[0], "--minimized"])
         self.assertEqual(self.start.args[1],
-            {'minimized': True, 'with_icon': False})
+            {'minimized': True, 'with_icon': False, 'installer': False})
 
     def test_with_icon_option(self):
         """Ensure the --minimized option is parsed and passed correctly."""
         main.main([sys.argv[0], "--with-icon"])
         self.assertEqual(self.start.args[1],
-            {'minimized': False, 'with_icon': True})
+            {'minimized': False, 'with_icon': True, 'installer': False})
 
     def test_all_styles_load(self):
         """Ensure the platform style is loaded."""
@@ -160,6 +160,12 @@
         main.main([sys.argv[0], "--switch-to", "folders"])
         self.assertEqual(self.start.window.tabname, "folders")
 
+    def test_installer_option(self):
+        """Ensure the --installer option is parsed and passed correctly."""
+        main.main([sys.argv[0], "--installer"])
+        self.assertEqual(self.start.args[1],
+            {'minimized': False, 'with_icon': False, 'installer': True})
+
     def test_translator(self):
         """Ensure the Qt translator is loaded."""
         main.main([sys.argv[0]])

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2012-03-19 15:50:31 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2012-03-22 12:49:18 +0000
@@ -186,6 +186,16 @@
         remote = self.ui.ui.folders_tab.remote_folders
         self.assertFalse(remote)
 
+    def test_start_from_license(self):
+        """Ensure we change the starting page correctly."""
+        # Before, we start on sign_in
+        self.assertEqual(self.ui.ui.wizard.startId(),
+            self.ui.ui.wizard.pages[self.ui.ui.wizard.signin_page])
+        # After, we start on license_page
+        self.ui.start_from_license()
+        self.assertEqual(self.ui.ui.wizard.startId(),
+            self.ui.ui.wizard.pages[self.ui.ui.wizard.license_page])
+
 
 class ExternalLinkButtonsTestCase(ControlPanelTestCase):
     """The link in the go-to-web buttons are correct."""

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_start.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_start.py	2012-02-17 14:42:57 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_start.py	2012-03-22 12:49:18 +0000
@@ -78,7 +78,7 @@
         gui.start(close_callback=self.close_cb,
                   with_icon=True, minimized=False)
         kwargs = {'close_callback': self.close_cb, 'window': self.main_window}
-        self.assertEqual(self.main_window.args, [((), {})])
+        self.assertEqual(self.main_window.args, [((), {'installer': False})])
         self.assertEqual(self.tray_icon.args, [((), kwargs)])
 
     def test_both_false(self):

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_wizard.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_wizard.py	2012-03-20 15:14:24 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_wizard.py	2012-03-22 12:49:18 +0000
@@ -153,11 +153,9 @@
 
     class_ui = gui.UbuntuOneWizard
     confirm_response = gui.QtGui.QDialog.Accepted
-    show_license = False
 
     @defer.inlineCallbacks
     def setUp(self):
-        self.patch(self.class_ui, 'show_license', self.show_license)
         yield super(UbuntuOneWizardTestCase, self).setUp()
         self.patch(self.ui.confirm_dialog, 'exec_',
                    lambda: self.confirm_response)
@@ -186,11 +184,7 @@
 
     def test_first_page(self):
         """The first page is the correct one."""
-        if self.show_license:
-            expected = self.ui.pages[self.ui.license_page]
-        else:
-            expected = self.ui.pages[self.ui.signin_page]
-
+        expected = self.ui.pages[self.ui.signin_page]
         self.assertEqual(self.ui.startId(), expected)
 
     def test_done_accepted(self):
@@ -202,12 +196,6 @@
         self.assertEqual(self._called, ((gui.QtGui.QDialog.Accepted,), {}))
 
 
-class LicensedUbuntuOneWizardTestCase(UbuntuOneWizardTestCase):
-    """Test the LicensedUbuntuOneWizard."""
-
-    show_license = True
-
-
 class UbuntuOneWizardSignInTestCase(UbuntuOneWizardTestCase):
     """Test the SignInPage wizard page."""
 
@@ -267,12 +255,13 @@
             if text is not None:
                 self.assertEqual(unicode(button.text()), text)
 
-            getattr(self.ui, signal).connect(self._set_called)
-            button.click()
+            if signal:
+                getattr(self.ui, signal).connect(self._set_called)
+                button.click()
 
-            self.assertEqual(self._called, (signal_args, {}),
-                             msg % (name, signal, signal_args))
-            self._called = False
+                self.assertEqual(self._called, (signal_args, {}),
+                                msg % (name, signal, signal_args))
+                self._called = False
 
     def test_done_rejected(self):
         """When the wizard was cancelled and user confirmed, finish."""
@@ -300,7 +289,7 @@
 class UbuntuOneWizardCloudToComputerTestCase(UbuntuOneWizardSignInTestCase):
     """Test the CloudToComputerPage wizard page."""
 
-    buttons = {'NextButton': (None, 'currentIdChanged', (3,))}
+    buttons = {'NextButton': (None, 'currentIdChanged', (4,))}
     page_name = 'cloud_folders'
     stage_name = 'folders'
 
@@ -308,7 +297,7 @@
 class UbuntuOneWizardSettingsTestCase(UbuntuOneWizardSignInTestCase):
     """Test the CloudToComputerPage wizard page."""
 
-    buttons = {'BackButton': (None, 'currentIdChanged', (0,))}
+    buttons = {'BackButton': (None, 'currentIdChanged', (1,))}
     page_name = 'settings'
     stage_name = 'folders'
 
@@ -318,7 +307,7 @@
 
     buttons = {
         'FinishButton': (None, 'finished', (gui.QtGui.QDialog.Accepted,)),
-        'BackButton': (None, 'currentIdChanged', (0,)),
+        'BackButton': (None, 'currentIdChanged', (1,)),
     }
     page_name = 'local_folders'
     stage_name = 'sync'
@@ -341,11 +330,10 @@
     """Test the LicensePage wizard page."""
 
     buttons = {
-        'NextButton': (gui.LICENSE_AGREE, 'currentIdChanged', (1,)),
+        'CommitButton': (gui.LICENSE_AGREE, None, ()),
         'CancelButton': (gui.LICENSE_DISAGREE, 'rejected', ()),
     }
     page_name = 'license'
-    show_license = True
     stage_name = 'install'
 
 

=== modified file 'ubuntuone/controlpanel/gui/qt/wizard.py'
--- ubuntuone/controlpanel/gui/qt/wizard.py	2012-03-20 15:11:56 +0000
+++ ubuntuone/controlpanel/gui/qt/wizard.py	2012-03-22 12:49:18 +0000
@@ -167,8 +167,6 @@
 class UbuntuOneWizard(cache.Cache, QtGui.QWizard):
     """The Ubuntu One wizard."""
 
-    show_license = False  # do not change unless you know what you're doing
-
     def __init__(self, *args, **kwargs):
         super(UbuntuOneWizard, self).__init__(*args, **kwargs)
         self.pages = {}
@@ -185,9 +183,8 @@
 
         # license
         self.license_page = LicensePage()
-        self.next_button_text = self.button(self.NextButton).text()
-        if self.show_license:
-            self.addPage(self.license_page)
+        self.license_page.setCommitPage(True)
+        self.addPage(self.license_page)
 
         # sign in
         self.signin_page = SignInPage()
@@ -213,7 +210,7 @@
         self.addPage(self.local_folders_page)
 
         self._next_id = self.pages[self.signin_page]
-        self.next()
+        self.setStartId(self._next_id)
 
     # pylint: disable=C0103
 
@@ -231,12 +228,14 @@
         button_layout = button_to = button = stage = None
 
         if page is self.license_page:
-            button_layout = [self.Stretch, self.CancelButton, self.NextButton]
-            button = self.button(self.NextButton)
+            button_layout = [self.Stretch, self.CancelButton,
+                self.CommitButton]
+            button = self.button(self.CommitButton)
             button_to = self.button(self.CancelButton)
             stage = self.side_widget.install_stage
+            self._next_id = self.pages[self.signin_page]
 
-            self.setButtonText(self.NextButton, LICENSE_AGREE)
+            self.setButtonText(self.CommitButton, LICENSE_AGREE)
             self.setButtonText(self.CancelButton, LICENSE_DISAGREE)
 
         elif page is self.signin_page:
@@ -250,8 +249,6 @@
             self.setTabOrder(self.signin_page.panel.ui.login_button, button)
 
         elif page is self.cloud_folders_page:
-            self.setButtonText(self.NextButton, self.next_button_text)
-
             button_layout = [self.Stretch, self.NextButton]
             button = self.cloud_folders_page.panel.ui.check_settings_button
             button_to = self.button(self.NextButton)
@@ -339,8 +336,7 @@
             if response == QtGui.QDialog.Accepted:
                 logger.warning('UbuntuOneWizard: user canceled setup.')
                 self.rejected.emit()
-        elif (self.show_license and
-              self.currentId() == self.pages[self.license_page]):
+        elif (self.currentId() == self.pages[self.license_page]):
             response = self.confirm_dialog.exec_()
             if response == QtGui.QDialog.Accepted:
                 logger.warning('UbuntuOneWizard: user wants to uninstall.')