Merge lp:~ralsina/ubuntuone-control-panel/you-have-two-options into lp:ubuntuone-control-panel

[Roberto Alsina]

Adds a --with-icon option to control panel.

Adds a --with-icon option to control panel.

To test IRL:

* Run bin/ubuntuone-control-panel-qt --with-icon [you should get a icon and a u1cp window]
* Run bin/ubuntuone-control-panel-qt --minimized [you should get a icon and no u1cp window]
* Run bin/ubuntuone-control-panel-qt [you should get a u1cp window and no icon]

If you want to:

* Run bin/ubuntuone-control-panel-qt --minimized --with-icon [you should get a icon and no u1cp window]

[Diego Sarmentero (diegosarmentero)]

Tests missing!

review: Needs Fixing

[lp:~ralsina/ubuntuone-control-panel/you-have-two-options]

229. By Roberto Alsina on 2011-09-14

Made it testable, added tests

230. By Roberto Alsina on 2011-09-14

oops

231. By Roberto Alsina on 2011-09-14

added missing docstring

232. By Roberto Alsina on 2011-09-14

docstring fixes

233. By Roberto Alsina on 2011-09-14

unused import

[Roberto Alsina (ralsina)]

> Tests missing!

Tests added!

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Natalia Bidart (nataliabidart)]

* Like we talked in IRC, the start() method should be moved to ubuntuone/controlpanel/gui/qt/gui.py, this way we avoid having to "hide" the MainWindow import.

* Also, this set of imports:

+from ubuntuone.controlpanel.tests import TestCase
+from ubuntuone.controlpanel.gui.qt.tests import NO_OP
+import ubuntuone.controlpanel.gui.qt as qt
+from ubuntuone.controlpanel.gui.qt import gui

should be alphabetically sorted and properly grouped in blocks.

* Always yield on super() calls to setUp/tearDown.

Looks good!

review: Needs Fixing

[lp:~ralsina/ubuntuone-control-panel/you-have-two-options]

234. By Roberto Alsina on 2011-09-15

fixes

235. By Roberto Alsina on 2011-09-15

fixes suggested by nessita

236. By Roberto Alsina on 2011-09-15

fixes

[Natalia Bidart (nataliabidart)]

I'm getting:

ubuntuone/controlpanel/gui/qt/main/linux.py:
    30: [E0611] No name 'start' in module 'ubuntuone.controlpanel.gui.qt'
    53: [W0621, main] Redefining name 'start' from outer scope (line 30)
    30: [W0611] Unused import start

review: Needs Fixing

[lp:~ralsina/ubuntuone-control-panel/you-have-two-options]

237. By Roberto Alsina on 2011-09-15

fixed linux main

[Natalia Bidart (nataliabidart)]

Looks great! works as expected.

review: Approve

=== modified file 'bin/ubuntuone-control-panel-qt'
--- bin/ubuntuone-control-panel-qt	2011-09-01 19:15:39 +0000
+++ bin/ubuntuone-control-panel-qt	2011-09-15 17:13:52 +0000
@@ -47,12 +47,17 @@
                       "alerting the user to its presence.")
     result.add_option("--minimized", dest="minimized", action="store_true",
                       default=False, help="Start Ubuntu One "
-                      "in the notification area.")
+                      "only in the notification area, with no visible window. "
+                      "Implies --with-icon")
+    result.add_option("--with-icon", dest="with_icon", action="store_true",
+                      default=False, help="Start Ubuntu One "
+                      "with an icon in the notification area.")
     return result
 
 
 if __name__ == "__main__":
     parser = parser_options()
     (options, args) = parser.parse_args(sys.argv)
-    main.main(switch_to=options.switch_to, 
-        alert=options.alert, minimized=options.minimized)
+    main.main(switch_to=options.switch_to,
+        alert=options.alert, minimized=options.minimized, 
+        with_icon=options.with_icon)

=== modified file 'ubuntuone/controlpanel/gui/qt/gui.py'
--- ubuntuone/controlpanel/gui/qt/gui.py	2011-09-02 17:59:39 +0000
+++ ubuntuone/controlpanel/gui/qt/gui.py	2011-09-15 17:13:52 +0000
@@ -21,13 +21,10 @@
 
 from PyQt4 import QtGui
 
-from ubuntuone.controlpanel.logger import setup_logging
+from ubuntuone.controlpanel.gui.qt.systray import TrayIcon
 from ubuntuone.controlpanel.gui.qt.ui import mainwindow_ui
 
 
-logger = setup_logging('qt.gui')
-
-
 class MainWindow(QtGui.QMainWindow):
     """The Main Window of the Control Panel."""
 
@@ -53,3 +50,22 @@
         event.accept()
 
     # pylint: enable=C0103
+
+
+def start(stop, minimized=False, with_icon=False):
+    """Show the UI elements."""
+    # pylint: disable=W0404, F0401
+    if not minimized:
+        if with_icon or minimized:
+            window = MainWindow()
+        else:
+            window = MainWindow(close_callback=stop)
+        window.show()
+    else:
+        window = None
+    if with_icon or minimized:
+        QtGui.QApplication.instance().setQuitOnLastWindowClosed(False)
+        icon = TrayIcon(window=window)
+    else:
+        icon = None
+    return icon, window

=== modified file 'ubuntuone/controlpanel/gui/qt/main/linux.py'
--- ubuntuone/controlpanel/gui/qt/main/linux.py	2011-09-01 19:31:36 +0000
+++ ubuntuone/controlpanel/gui/qt/main/linux.py	2011-09-15 17:13:52 +0000
@@ -27,10 +27,9 @@
 # pylint: disable=W0611
 from ubuntuone.controlpanel.gui.qt.ui import images_rc
 # pylint: enable=W0611
-from ubuntuone.controlpanel.gui.qt.systray import TrayIcon
-
-
-def main(switch_to='', alert=False, minimized=False):
+
+
+def main(switch_to='', alert=False, minimized=False, with_icon=False):
     """Start the Qt reactor and open the main window."""
 
     # The DBus main loop MUST be initialized before importing the reactor
@@ -50,15 +49,9 @@
     from qtreactor import qt4reactor
     qt4reactor.install()
     from twisted.internet import reactor
-
-    # pylint believes that reactor has no run nor stop methods. Silence it.
-    if minimized:
-        app.setQuitOnLastWindowClosed(False)
-        icon = TrayIcon()
-    else:
-        from ubuntuone.controlpanel.gui.qt.gui import MainWindow
-        window = MainWindow(close_callback=reactor.stop)
-        window.show()
+    from ubuntuone.controlpanel.gui.qt.gui import start
 
     # pylint: disable=E1101
+    icon, window = start(reactor.stop,
+        minimized=minimized, with_icon=with_icon)
     reactor.run()

=== modified file 'ubuntuone/controlpanel/gui/qt/main/windows.py'
--- ubuntuone/controlpanel/gui/qt/main/windows.py	2011-09-08 13:11:33 +0000
+++ ubuntuone/controlpanel/gui/qt/main/windows.py	2011-09-15 17:13:52 +0000
@@ -25,10 +25,9 @@
 # pylint: disable=W0611
 from ubuntuone.controlpanel.gui.qt.ui import images_rc
 # pylint: enable=W0611
-from ubuntuone.controlpanel.gui.qt.systray import TrayIcon
-
-
-def main(switch_to='', alert=False, minimized=False):
+
+
+def main(switch_to='', alert=False, minimized=False, with_icon=False):
     """Start the Qt reactor and open the main window."""
 
     # The following cannot be imported outside this function
@@ -36,6 +35,8 @@
     # pylint: disable=F0401, W0404
     import qtreactor.qt4reactor
     qtreactor.qt4reactor.install()
+    from twisted.internet import reactor
+    from ubuntuone.controlpanel.gui.qt.gui import start
 
     # The main loop MUST be initialized before importing the reactor
     # pylint: disable=W0612
@@ -49,16 +50,7 @@
     stylesheet = QtCore.QLatin1String(qss_file.readAll())
     app.setStyleSheet(stylesheet)
 
-    # pylint: disable=W0404, F0401
-    from twisted.internet import reactor
-
-    if minimized:
-        app.setQuitOnLastWindowClosed(False)
-        icon = TrayIcon()
-    else:
-        from ubuntuone.controlpanel.gui.qt.gui import MainWindow
-        window = MainWindow(close_callback=reactor.stop)
-        window.show()
-
+    icon, window = start(reactor.stop,
+        minimized=minimized, with_icon=with_icon)
     # pylint: disable=E1101
     reactor.run()

=== modified file 'ubuntuone/controlpanel/gui/qt/systray.py'
--- ubuntuone/controlpanel/gui/qt/systray.py	2011-09-07 13:55:49 +0000
+++ ubuntuone/controlpanel/gui/qt/systray.py	2011-09-15 17:13:52 +0000
@@ -24,11 +24,11 @@
 
     """System notification icon."""
 
-    def __init__(self):
+    def __init__(self, window=None):
         super(TrayIcon, self).__init__(None)
         self.setIcon(QtGui.QIcon(":/u1icon.png"))
         self.setVisible(True)
-        self.window = None
+        self.window = window
         self.activated.connect(self.on_activated)
         self.context_menu = QtGui.QMenu()
         self.restore = QtGui.QAction("Restore", self,

=== added file 'ubuntuone/controlpanel/gui/qt/tests/test_start.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_start.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_start.py	2011-09-15 17:13:52 +0000
@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+
+# Author: 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/>.
+
+"""Tests for the start function."""
+
+from twisted.internet import defer
+
+from ubuntuone.controlpanel.gui.qt import gui
+from ubuntuone.controlpanel.gui.qt.tests import NO_OP
+from ubuntuone.controlpanel.tests import TestCase
+
+
+class FakeThing(object):
+
+    """A fake thing."""
+
+    def __init__(self):
+        self.args = []
+        self.shown = False
+
+    def __call__(self, *args, **kwargs):
+        self.args.append((args, kwargs))
+        return self
+
+    def show(self):
+        """Show."""
+        self.shown = True
+
+
+class FakeReactor(object):
+    """A fake reactor."""
+
+    def run(self):
+        """Start."""
+
+    def stop(self):
+        """Stop."""
+
+
+class StartTestCase(TestCase):
+    """Test the qt control panel."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        yield super(StartTestCase, self).setUp()
+        self.main_window = FakeThing()
+        self.tray_icon = FakeThing()
+        self.patch(gui, "MainWindow", self.main_window)
+        self.patch(gui, "TrayIcon", self.tray_icon)
+
+    def test_minimized(self):
+        """Test behaviour with minimized=True."""
+        gui.start(NO_OP, minimized=True, with_icon=True)
+        self.assertEqual(self.tray_icon.args, [((), {'window': None})])
+        self.assertEqual(self.main_window.args, [])
+
+    def test_with_icon(self):
+        """Test behaviour with with_icon=True."""
+        gui.start(NO_OP, with_icon=True, minimized=False)
+        self.assertEqual(self.main_window.args, [((), {})])
+        self.assertEqual(self.tray_icon.args, [((),
+            {'window': self.main_window})])
+
+    def test_both_false(self):
+        """Test behaviour when with_icon and minimized are False."""
+        gui.start(NO_OP, with_icon=False, minimized=False)
+        # Should be called
+        self.assertNotEqual(self.main_window.args, [])
+        # Should not be called
+        self.assertEqual(self.tray_icon.args, [])
+
+    def test_both_true(self):
+        """Test behaviour when with_icon and minimized are True."""
+        gui.start(NO_OP, with_icon=True, minimized=True)
+        self.assertEqual(self.tray_icon.args, [((), {'window': None})])
+        self.assertEqual(self.main_window.args, [])