Merge lp:~mikemc/ubuntuone-control-panel/catch-quit into lp:ubuntuone-control-panel

[Mike McCracken]

- On darwin, create menu item to intercept cmd-Q events. (LP: #1049973)

- On darwin, create menu item to intercept cmd-Q events. (LP: #1049973)

We add a menu to the main menubar with a "Quit" item, which Qt moves into the application menu. If we don't do this, Qt will create a default "Quit" item that only calls QApplication::quit().

[Roberto Alsina (ralsina)]

review: Approve

[Alejandro J. Cura (alecu)]

Looks very good.

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

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

*** Running DBus test suite ***
ubuntuone.controlpanel.dbustests.test_dbus_service
  BaseTestCase
    runTest ... [OK]
  DBusServiceMainTestCase
    test_dbus_service_cant_register ... Control panel backend already running.
                                   [OK]
    test_dbus_service_main ... [OK]
  DBusServiceTestCase
    test_cant_register_twice ... [SKIPPED]
    test_dbus_busname_created ... [OK]
    test_error_handler_default ... [OK]
    test_error_handler_with_exception ... [OK]
    test_error_handler_with_failure ... [OK]
    test_error_handler_with_non_string_dict ... [OK]
    test_error_handler_with_string_dict ... [OK]
    test_register_service ... [OK]
  FileSyncTestCase
    test_file_sync_status_changed ... [OK]
    test_file_sync_status_disabled ... [OK]
    test_file_sync_status_disconnected ... [OK]
    test_file_sync_status_error ... [OK]
    test_file_sync_status_idle ... [OK]
    test_file_sync_status_starting ... [OK]
    test_file_sync_status_stopped ... [OK]
    test_file_sync_status_syncing ... [OK]
    test_file_sync_status_unknown ... [OK]
    test_status_changed_handler ... [OK]
    test_status_changed_handler_after_status_requested ... [OK]
    test_status_changed_handler_after_status_requested_twice ... [OK]
  OperationsAuthErrorTestCase
    test_account_info_returned ... [OK]
    test_change_device_settings ... [OK]
    test_change_replication_settings ... [OK]
    test_change_volume_settings ... [OK]
    test_connect_files ... [OK]
    test_devices_info_returned ... [OK]
    test_disable_files ... [OK]
    test_disconnect_files ... [OK]
    test_enable_files ... [OK]
    test_remove_device ... [OK]
    test_replications_info ... [OK]
    test_restart_files ... [OK]
    test_start_...

[Ubuntu One Auto Pilot (otto-pilot)]

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

*** Running DBus test suite ***
ubuntuone.controlpanel.dbustests.test_dbus_service
  BaseTestCase
    runTest ... [OK]
  DBusServiceMainTestCase
    test_dbus_service_cant_register ... Control panel backend already running.
                                   [OK]
    test_dbus_service_main ... [OK]
  DBusServiceTestCase
    test_cant_register_twice ... [SKIPPED]
    test_dbus_busname_created ... [OK]
    test_error_handler_default ... [OK]
    test_error_handler_with_exception ... [OK]
    test_error_handler_with_failure ... [OK]
    test_error_handler_with_non_string_dict ... [OK]
    test_error_handler_with_string_dict ... [OK]
    test_register_service ... [OK]
  FileSyncTestCase
    test_file_sync_status_changed ... [OK]
    test_file_sync_status_disabled ... [OK]
    test_file_sync_status_disconnected ... [OK]
    test_file_sync_status_error ... [OK]
    test_file_sync_status_idle ... [OK]
    test_file_sync_status_starting ... [OK]
    test_file_sync_status_stopped ... [OK]
    test_file_sync_status_syncing ... [OK]
    test_file_sync_status_unknown ... [OK]
    test_status_changed_handler ... [OK]
    test_status_changed_handler_after_status_requested ... [OK]
    test_status_changed_handler_after_status_requested_twice ... [OK]
  OperationsAuthErrorTestCase
    test_account_info_returned ... [OK]
    test_change_device_settings ... [OK]
    test_change_replication_settings ... [OK]
    test_change_volume_settings ... [OK]
    test_connect_files ... [OK]
    test_devices_info_returned ... [OK]
    test_disable_files ... [OK]
    test_disconnect_files ... [OK]
    test_enable_files ... [OK]
    test_remove_device ... [OK]
    test_replications_info ... [OK]
    test_restart_files ... [OK]
    test_start_...

[lp:~mikemc/ubuntuone-control-panel/catch-quit]

365. By Mike McCracken on 2012-10-04

pep8 whitespace fix

=== modified file 'ubuntuone/controlpanel/gui/qt/main/__init__.py'
--- ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-08-30 18:34:13 +0000
+++ ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-10-04 20:49:21 +0000
@@ -36,6 +36,12 @@
 else:
     from ubuntuone.controlpanel.gui.qt.main import dbus_main
     source = dbus_main
+
+if sys.platform == 'darwin':
+    from ubuntuone.controlpanel.gui.qt.main.darwin import (
+        install_platform_event_handlers)
+else:
+    install_platform_event_handlers = lambda app: None
 # pylint: enable=C0103
 
 from ubuntuone.controlpanel.utils import install_config_and_daemons
@@ -127,6 +133,12 @@
 
     install_config_and_daemons()
 
+    # Unused variable 'menubar', pylint: disable=W0612
+    # need to keep a reference to the menu or our handler will be
+    # removed
+    menubar = install_platform_event_handlers(app)
+    # pylint: enable=W0612
+
     # Unused variable 'window', 'icon', pylint: disable=W0612
     icon, window = start(lambda: source.main_quit(app),
                          minimized=minimized, with_icon=with_icon,

=== added file 'ubuntuone/controlpanel/gui/qt/main/darwin.py'
--- ubuntuone/controlpanel/gui/qt/main/darwin.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/main/darwin.py	2012-10-04 20:49:21 +0000
@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 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/>.
+
+"""Darwin-specific GUI event handling code."""
+
+from PyQt4 import QtGui
+from twisted.internet.defer import inlineCallbacks
+
+from ubuntuone.platform.tools import SyncDaemonTool
+
+from ubuntuone.controlpanel.gui.qt.main import twisted_main
+
+
+@inlineCallbacks
+def handle_cmd_q(app, event):
+    """Handle the quit event on darwin."""
+    # pylint: disable=W0702
+    try:
+        st = SyncDaemonTool()
+        yield st.quit()
+    except:
+        pass
+    twisted_main.main_quit(app)
+    app.aboutToQuit.emit()
+
+
+def install_platform_event_handlers(app):
+    """Add code to catch cmd-Q."""
+    # on darwin, a menu item with 'quit' in its title is moved to
+    # the application menu and given the cmd-Q shortcut by Qt. If
+    # we don't provide one, Qt will give us one that just calls
+    # QApplication::quit(), which doesn't quit syncdaemon and
+    # causes problems with the qtreactor.
+
+    # QMenuBar with no parent gives us an app-wide menu bar.
+    # Note that Qt does not make this a singleton, though, so we have
+    # to keep it around.
+    menubar = QtGui.QMenuBar(None)
+
+    quit_action = QtGui.QAction("quit", menubar,
+                                triggered=lambda x:
+                                handle_cmd_q(app, x))
+    quit_action.setObjectName("darwin-cmd-q")
+    menu = menubar.addMenu("This string is not used.")
+    menu.addAction(quit_action)
+
+    return menubar

=== added file 'ubuntuone/controlpanel/gui/qt/main/tests/test_darwin.py'
--- ubuntuone/controlpanel/gui/qt/main/tests/test_darwin.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/qt/main/tests/test_darwin.py	2012-10-04 20:49:21 +0000
@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 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 darwin-specific parts of control panel's Qt main."""
+
+from PyQt4 import QtGui
+
+from twisted.internet.defer import (inlineCallbacks, succeed)
+
+from ubuntuone.controlpanel.gui.qt import main
+from ubuntuone.controlpanel.tests import TestCase
+from ubuntuone.controlpanel.gui.tests import FakeSignal
+
+
+class FakeApplication(object):
+    """Fake Application with quit signal."""
+    def __init__(self):
+        """Set up fake signal."""
+        # pylint: disable=C0103
+        self.aboutToQuit = FakeSignal()
+        self.aboutToQuit.connect(self.record_call)
+        self.signal_called = None
+
+    def record_call(self, *args):
+        """record call"""
+        self.signal_called = args
+
+
+class FakeSDTool(object):
+    """Fake tool."""
+    called = False
+
+    def quit(self):
+        """Quit successfully."""
+        FakeSDTool.called = True
+        return succeed(None)
+
+
+class FakeSDToolRaising(object):
+    """Fake tool that raises."""
+    shouldRaise = False
+    called = False
+
+    def quit(self):
+        """Raise."""
+        self.called = True
+        raise Exception("exception")
+
+
+class QuitTestCase(TestCase):
+    """Test quit event handling."""
+
+    @inlineCallbacks
+    def setUp(self):
+        """Set up common fakes."""
+        yield super(QuitTestCase, self).setUp()
+        self.fake_app = FakeApplication()
+        self.patch(main.darwin.twisted_main, 'main_quit',
+                   self._set_called)
+
+    @inlineCallbacks
+    def test_cmd_q_func_quits_sd(self):
+        """Test that we call syncdaemontool.quit """
+        self.patch(main.darwin, 'SyncDaemonTool', FakeSDTool)
+
+        yield main.darwin.handle_cmd_q(self.fake_app, None)
+        self.assertEqual(FakeSDTool.called, True)
+
+    @inlineCallbacks
+    def test_cmd_q_func_ignores_exception(self):
+        """Test that we keep going when SDT raises."""
+        self.patch(main.darwin, 'SyncDaemonTool', FakeSDToolRaising)
+
+        yield main.darwin.handle_cmd_q(self.fake_app, None)
+        self.assertEqual(self._called, ((self.fake_app,), {}))
+
+        self.assertEqual(self.fake_app.signal_called, ())
+
+
+class InstallEventHandlersTestCase(TestCase):
+    """Test creating Qt menu items."""
+
+    def test_install_handlers_creates_action(self):
+        """Test menu items created"""
+        self.patch(main.darwin, 'handle_cmd_q',
+                   self._set_called)
+        app = QtGui.QApplication.instance()
+        menubar = main.darwin.install_platform_event_handlers(app)
+        quit_action = menubar.findChild(QtGui.QAction, "darwin-cmd-q")
+        quit_action.trigger()
+        self.assertEqual(self._called, ((app, False), {}))

=== modified file 'ubuntuone/controlpanel/gui/qt/main/tests/test_main.py'
--- ubuntuone/controlpanel/gui/qt/main/tests/test_main.py	2012-08-30 18:34:13 +0000
+++ ubuntuone/controlpanel/gui/qt/main/tests/test_main.py	2012-10-04 20:49:21 +0000
@@ -136,6 +136,8 @@
         self.patch(main, "start", self.start)
         self.patch(main.source, "main_start", lambda app: None)
         self.patch(QtCore, "QTranslator", lambda: self.translator)
+        self.patch(main, 'install_platform_event_handlers',
+                   lambda app: None)
 
         self.qt4reactor_installed = False
 
@@ -305,3 +307,11 @@
 
         main.main([sys.argv[0]], install_reactor_darwin=False)
         self.assertEqual(self._called, ((), {}))
+
+    def test_install_event_handlers(self):
+        """Test that install_platform_event_handlers is called."""
+        self.patch(main, 'install_platform_event_handlers',
+                   self._set_called)
+
+        main.main([sys.argv[0]], install_reactor_darwin=False)
+        self.assertEqual(self._called, ((self.app,), {}))