Merge lp:~ralsina/ubuntuone-control-panel/even_more_unique_than_the_other_snowflake into lp:ubuntuone-control-panel

[Roberto Alsina]

Make control panel a unique instance app on windows.

Make control panel a unique instance app on windows.

Since on windows the control panel has a tray icon, the second time control panel is instantiated, it should activate that instance instead of launching.

To test (on windows only), if you don't have the whole windows setup:

Get this zip: http://ubuntuone.com/5nigS7qTQkJvP032vaTByK

It contains trunk + this branch, compiled into exes, you can just run things by entering the dist folder.

Start ubuntuone-control-panel-qt. On another terminal, do it again. You should only have one control panel running.

If you start the first one with --minimized, then the second one should make
it show its window.

[Diego Sarmentero (diegosarmentero)]

Missing docstrings

review: Needs Fixing

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Manuel de la Peña (mandel)]

Besides the fact that there are some:
+# Authors: Roberto Alsina <email address hidden>
and we are suppose to remove those, all the rest seems perfectly ok.

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

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

running build
Compiled data/qt/loadingoverlay.ui into ubuntuone/controlpanel/gui/qt/ui/loadingoverlay_ui.py
Compiled data/qt/preferences.ui into ubuntuone/controlpanel/gui/qt/ui/preferences_ui.py
Compiled data/qt/signin.ui into ubuntuone/controlpanel/gui/qt/ui/signin_ui.py
compiled data/qt/images.qrc into ubuntuone/controlpanel/gui/qt/ui/images_rc.py
Compiled data/qt/folders.ui into ubuntuone/controlpanel/gui/qt/ui/folders_ui.py
Compiled data/qt/devices.ui into ubuntuone/controlpanel/gui/qt/ui/devices_ui.py
Compiled data/qt/filesyncstatus.ui into ubuntuone/controlpanel/gui/qt/ui/filesyncstatus_ui.py
Compiled data/qt/device.ui into ubuntuone/controlpanel/gui/qt/ui/device_ui.py
Compiled data/qt/mainwindow.ui into ubuntuone/controlpanel/gui/qt/ui/mainwindow_ui.py
Compiled data/qt/device_remote.ui into ubuntuone/controlpanel/gui/qt/ui/device_remote_ui.py
Compiled data/qt/controlpanel.ui into ubuntuone/controlpanel/gui/qt/ui/controlpanel_ui.py
Compiled data/qt/account.ui into ubuntuone/controlpanel/gui/qt/ui/account_ui.py
running build_py
creating build
creating build/lib.linux-i686-2.7
creating build/lib.linux-i686-2.7/ubuntuone
copying ubuntuone/__init__.py -> build/lib.linux-i686-2.7/ubuntuone
creating build/lib.linux-i686-2.7/ubuntuone/controlpanel
copying ubuntuone/controlpanel/login_client.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel
copying ubuntuone/controlpanel/__init__.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel
copying ubuntuone/controlpanel/logger.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel
copying ubuntuone/controlpanel/dbus_service.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel
copying ubuntuone/controlpanel/replication_client.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel
copying ubuntuone/controlpanel/cache.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel
copying ubuntuone/controlpanel/backend.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel
creating build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui
copying ubuntuone/controlpanel/gui/__init__.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui
creating build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/gtk
copying ubuntuone/controlpanel/gui/gtk/package_manager.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/gtk
copying ubuntuone/controlpanel/gui/gtk/__init__.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/gtk
copying ubuntuone/controlpanel/gui/gtk/gui.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/gtk
copying ubuntuone/controlpanel/gui/gtk/widgets.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/gtk
creating build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/qt
copying ubuntuone/controlpanel/gui/qt/device.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/qt
copying ubuntuone/controlpanel/gui/qt/filesyncstatus.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/qt
copying ubuntuone/controlpanel/gui/qt/loadingoverlay.py -> build/lib.linux-i686-2.7/ubuntuone/controlpanel/gui/qt
copying ubun...

[lp:~ralsina/ubuntuone-control-panel/even_more_unique_than_the_other_snowflake]

253. By Roberto Alsina on 2012-01-04

lint

=== modified file 'ubuntuone/controlpanel/gui/qt/main/__init__.py'
--- ubuntuone/controlpanel/gui/qt/main/__init__.py	2011-11-14 11:46:39 +0000
+++ ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-01-04 11:47:24 +0000
@@ -18,13 +18,11 @@
 
 import sys
 
-from PyQt4 import QtGui
-
 # Module used to include the resources into this file
 # Unused import images_rc, pylint: disable=W0611
 from ubuntuone.controlpanel.gui.qt.ui import images_rc
 # pylint: enable=W0611
-
+from ubuntuone.controlpanel.gui.qt.uniqueapp import UniqueApplication
 
 # Invalid name "source", pylint: disable=C0103
 if sys.platform == 'win32':
@@ -42,7 +40,7 @@
     # because u1trial already provides a reactor.
 
     # The main loop MUST be initialized before importing the reactor
-    app = QtGui.QApplication(sys.argv)
+    app = UniqueApplication(sys.argv, "ubuntuone-control-panel")
     source.main(app)
 
     # Reimport 'qt4reactor', 'reactor', 'start', pylint: disable=W0404, F0401
@@ -59,6 +57,8 @@
     icon, window = start(reactor.stop,
                          minimized=minimized, with_icon=with_icon)
     # pylint: enable=W0612
+    if icon:
+        app.new_instance.connect(icon.restore_window)
 
     reactor.run()
     # pylint: enable=E1101

=== added directory 'ubuntuone/controlpanel/gui/qt/uniqueapp'
=== added file 'ubuntuone/controlpanel/gui/qt/uniqueapp/__init__.py'
--- ubuntuone/controlpanel/gui/qt/uniqueapp/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/uniqueapp/__init__.py	2012-01-04 11:47:24 +0000
@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+#
+# 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/>.
+
+"""A QApplication that starts a single instance."""
+
+#pylint: disable=W0404
+import sys
+
+if sys.platform == "win32":
+    import windows as platform
+else:
+    import linux as platform
+
+#pylint: disable=C0103
+UniqueApplication = platform.UniqueApplication

=== added file 'ubuntuone/controlpanel/gui/qt/uniqueapp/linux.py'
--- ubuntuone/controlpanel/gui/qt/uniqueapp/linux.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/uniqueapp/linux.py	2012-01-04 11:47:24 +0000
@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+#
+# 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/>.
+
+"""A QApplication that starts a single instance."""
+
+from PyQt4 import QtGui, QtCore
+
+
+class UniqueApplication(QtGui.QApplication):
+
+    """A dummy UniqueApplication class."""
+
+    new_instance = QtCore.pyqtSignal()
+
+    def __init__(self, argv, key):
+        super(UniqueApplication, self).__init__(argv)

=== added directory 'ubuntuone/controlpanel/gui/qt/uniqueapp/tests'
=== added file 'ubuntuone/controlpanel/gui/qt/uniqueapp/tests/__init__.py'
--- ubuntuone/controlpanel/gui/qt/uniqueapp/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/uniqueapp/tests/__init__.py	2012-01-04 11:47:24 +0000
@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011-2012 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 UniqueApplication class."""

=== added file 'ubuntuone/controlpanel/gui/qt/uniqueapp/tests/test_windows.py'
--- ubuntuone/controlpanel/gui/qt/uniqueapp/tests/test_windows.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/uniqueapp/tests/test_windows.py	2012-01-04 11:47:24 +0000
@@ -0,0 +1,135 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011-2012 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 UniqueApplication class."""
+
+from PyQt4 import QtCore
+from twisted.internet.defer import inlineCallbacks
+
+from ubuntuone.controlpanel.gui.qt.uniqueapp import windows as uniqueapp
+from ubuntuone.controlpanel.tests import TestCase
+
+
+#pylint: disable=C0103
+class FakeLocalSocket(object):
+    """A fake QLocalSocket."""
+
+    def __init__(self):
+        self.connect_calls = []
+        self.connect_timeouts = []
+        self.connect_succeeds = True
+
+    def connectToServer(self, *args, **kwargs):
+        """Fake connectToServer."""
+        self.connect_calls.append((args, kwargs))
+
+    def waitForConnected(self, timeout):
+        """Fake waitForConnected."""
+        self.connect_timeouts.append(timeout)
+        return self.connect_succeeds
+
+
+class FakeSignal(object):
+
+    """A fake PyQt signal."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize."""
+        self.target = None
+
+    def connect(self, target):
+        """Fake connect."""
+        self.target = target
+
+    def disconnect(self, *args):
+        """Fake disconnect."""
+        self.target = None
+
+    def emit(self, *args):
+        """Fake emit."""
+        if self.target:
+            self.target(*args)
+
+
+class FakeLocalServer(object):
+
+    """A fake QLocalServer."""
+
+    def __init__(self):
+        self.newConnection = FakeSignal()
+        self.listen_args = []
+
+    def listen(self, *args, **kwargs):
+        """Fake listen."""
+        self.listen_args.append((args, kwargs))
+
+
+class FakeApplication(object):
+    """A fake QApplication."""
+
+
+class UniqueAppTestCase(TestCase):
+    """Test the UniqueAppplication class."""
+
+    @inlineCallbacks
+    def setUp(self):
+        yield super(UniqueAppTestCase, self).setUp()
+        self.local_socket = FakeLocalSocket()
+        self.patch(uniqueapp.QtNetwork, "QLocalSocket",
+            lambda: self.local_socket)
+        self.local_server = FakeLocalServer()
+        self.patch(uniqueapp.QtNetwork, "QLocalServer",
+            lambda parent: self.local_server)
+        self.patch(uniqueapp.sys, "exit", self._set_called)
+        self.fake_quit = FakeSignal()
+        self.patch(uniqueapp.UniqueApplication, "aboutToQuit", self.fake_quit)
+        self.patch(uniqueapp.QtGui, "QApplication", FakeApplication)
+
+    def test_client_socket(self):
+        """Check that the client socket is used correctly."""
+        self.local_socket.connect_succeeds = True
+        uniqueapp.UniqueApplication([], "key")
+        self.assertEqual(self.local_socket.connect_calls,
+        [(("key", QtCore.QIODevice.WriteOnly), {})])
+        self.assertEqual(self.local_socket.connect_timeouts,
+        [500])
+        # The connection succeeds, so it should stop
+        self.assertEqual(self._called, ((), {}))
+
+    def test_server_socket(self):
+        """Check that the server socket is used correctly."""
+        self.local_socket.connect_succeeds = False
+        uniqueapp.UniqueApplication([], "key")
+        self.assertEqual(self.local_socket.connect_calls,
+        [(("key", QtCore.QIODevice.WriteOnly), {})])
+        self.assertEqual(self.local_socket.connect_timeouts,
+        [500])
+
+        # Should not exit
+        self.assertEqual(self._called, False)
+
+    def test_signal_connection(self):
+        """Check that new_instance is correctly connected."""
+        app = uniqueapp.UniqueApplication([], "key")
+        # Yes, this is ugly. I can't find any other meaningful
+        # way to compare them though.
+        self.assertEqual(str(app.server.newConnection.target.__self__),
+            str(app.new_instance))
+
+    def test_cleanup(self):
+        """Check that cleanup is called with the right key."""
+        app = uniqueapp.UniqueApplication([], "key")
+        self.assertEqual(self.fake_quit.target, app.cleanup)

=== added file 'ubuntuone/controlpanel/gui/qt/uniqueapp/windows.py'
--- ubuntuone/controlpanel/gui/qt/uniqueapp/windows.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/uniqueapp/windows.py	2012-01-04 11:47:24 +0000
@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+#
+# 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/>.
+
+"""A QApplication that starts a single instance."""
+
+import sys
+
+from PyQt4 import QtNetwork, QtGui, QtCore
+
+
+class UniqueApplication(QtGui.QApplication):
+
+    """A QApplication that can only be started once.
+
+    Also, the new instance notifies the old one to show
+    its window.
+    """
+
+    new_instance = QtCore.pyqtSignal()
+
+    def __init__(self, argv, key):
+        super(UniqueApplication, self).__init__(argv)
+        self.key = key
+        self.server = QtNetwork.QLocalServer(self)
+        self.server.newConnection.connect(self.new_instance.emit)
+        self.aboutToQuit.connect(self.cleanup)
+        # Try to connect to existing app
+        socket = QtNetwork.QLocalSocket()
+        socket.connectToServer(key, QtCore.QIODevice.WriteOnly)
+        if socket.waitForConnected(500):
+            # Connected, exit
+            sys.exit()
+
+        # Not connected, start server
+        self.ready = self.server.listen(key)
+
+    def cleanup(self):
+        """Remove the socket when we die."""
+        self.server.removeServer(self.key)