Merge lp:~diegosarmentero/ubuntuone-control-panel/menu-status-actions into lp:ubuntuone-control-panel

[Diego Sarmentero]

- Adding status actions to the system tray menu (LP: #1034542).

For u1lint you should set the PYTHONPATH including this branch: lp:~diegosarmentero/ubuntuone-client/ipcmenu

[Manuel de la Peña (mandel)]

Please fix the following:

103 + self._backend_method = getattr(self.backend, data['backend_method'])

You should pass None to the getattr method to make sure you do not get an attr error. like:

103 + self._backend_method = getattr(self.backend, data['backend_method'], None)

review: Needs Fixing

[Diego Sarmentero (diegosarmentero)]

> Please fix the following:
>
> 103 + self._backend_method = getattr(self.backend, data['backend_method'])
>
> You should pass None to the getattr method to make sure you do not get an attr
> error. like:
>
> 103 + self._backend_method = getattr(self.backend, data['backend_method'],
> None)

fixed

[Manuel de la Peña (mandel)]

I'm getting the following lint error:

== Python Lint Notices ==

ubuntuone/controlpanel/sd_client/__init__.py:
    211: [E1101, SyncDaemonClient.sync_menu] Instance of 'SyncDaemonTool' has no 'sync_menu' member

review: Needs Fixing

[Manuel de la Peña (mandel)]

Looks good after the fixes.

review: Approve

[Roberto Alsina (ralsina)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The prerequisite https://code.launchpad.net/~diegosarmentero/ubuntuone-control-panel/refactor-sync-status has not yet been merged into https://code.launchpad.net/~ubuntuone-control-tower/ubuntuone-control-panel/trunk.

=== modified file 'ubuntuone/controlpanel/gui/qt/systray.py'
--- ubuntuone/controlpanel/gui/qt/systray.py	2012-05-14 20:16:02 +0000
+++ ubuntuone/controlpanel/gui/qt/systray.py	2012-08-13 12:10:30 +0000
@@ -19,13 +19,24 @@
 from twisted.internet.defer import inlineCallbacks
 from ubuntuone.platform.tools import SyncDaemonTool
 
+from ubuntuone.controlpanel import backend, cache
+from ubuntuone.controlpanel.logger import setup_logging
 from ubuntuone.controlpanel.gui import (
-    RESTORE_LABEL,
+    LOADING,
+    OPEN_UBUNTU_ONE,
+    PLEASE_WAIT,
     QUIT_LABEL,
 )
-
-
-class TrayIcon(QtGui.QSystemTrayIcon):
+from ubuntuone.controlpanel.gui.qt import (
+    FILE_SYNC_STATUS,
+    icon_from_name,
+)
+
+
+logger = setup_logging('qt.systray')
+
+
+class TrayIcon(QtGui.QSystemTrayIcon, cache.Cache):
 
     """System notification icon."""
 
@@ -34,23 +45,72 @@
         self.setIcon(QtGui.QIcon(":/icon.png"))
         self.setVisible(True)
         self.window = window
-        self.activated.connect(self.on_activated)
+        self._backend_method = None
+
+        # Items
         self.context_menu = QtGui.QMenu()
-        self.restore = QtGui.QAction(RESTORE_LABEL, self,
-            triggered=self.restore_window)
-        self.quit = QtGui.QAction(QUIT_LABEL, self,
-            triggered=self.stop)
-        self.context_menu.addAction(self.restore)
-        self.context_menu.addSeparator()
-        self.context_menu.addAction(self.quit)
+
+        self.status = self.context_menu.addAction(LOADING)
+        self.status.setEnabled(False)
+        self.status_action = self.context_menu.addAction(PLEASE_WAIT)
+        self.refresh_status()
+        self.context_menu.addSeparator()
+
+        self.open_u1 = self.context_menu.addAction(OPEN_UBUNTU_ONE)
+        self.context_menu.addSeparator()
+
+        self.quit = self.context_menu.addAction(QUIT_LABEL)
+
         self.setContextMenu(self.context_menu)
 
+        # Connect Signals
+        self.status_action.triggered.connect(self.change_status)
+        self.open_u1.triggered.connect(self.restore_window)
+        self.quit.triggered.connect(self.stop)
+
         self.close_callback = close_callback
 
-    def on_activated(self, reason):
-        """The user activated the icon."""
-        if reason == self.Trigger:  # Left-click
-            self.restore_window()
+    @inlineCallbacks
+    def refresh_status(self):
+        """Update Ubuntu One status."""
+        info = yield self.backend.file_sync_status()
+        self._process_status(info)
+        self.backend.status_changed_handler = self._process_status
+
+    def _process_status(self, status):
+        """Match status with signals."""
+        if status is None:
+            return
+        try:
+            status_key = status[backend.STATUS_KEY]
+            data = FILE_SYNC_STATUS[status_key]
+        except (KeyError, TypeError):
+            logger.exception(
+                '_process_status: received unknown status dict %r', status)
+            return
+
+        self.status_action.setEnabled(True)
+        icon_name = data.get('icon')
+        icon = QtGui.QIcon()
+        if icon_name is not None:
+            icon = icon_from_name(icon_name)
+        text = data.get('msg')
+        self.status.setIcon(icon)
+        self.status.setText(text)
+
+        action = data.get('action')
+        self._backend_method = getattr(self.backend,
+            data['backend_method'], None)
+        self.status_action.setText(action)
+
+    def change_status(self):
+        """Change the Syncing status of syncdaemon."""
+        if self._backend_method is not None:
+            self.status_action.setEnabled(False)
+            self._backend_method()
+        else:
+            logger.error('on_sync_status_button_clicked: backend method is '
+                         'None!')
 
     def restore_window(self):
         """Show the main window."""

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_systray.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_systray.py	2012-06-22 14:42:29 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_systray.py	2012-08-13 12:10:30 +0000
@@ -21,11 +21,15 @@
 from PyQt4 import QtGui
 from twisted.internet.defer import inlineCallbacks
 
+from ubuntuone.controlpanel.gui import qt
 from ubuntuone.controlpanel.gui.qt import systray
-from ubuntuone.controlpanel.tests import TestCase
+from ubuntuone.controlpanel.gui.qt.tests import BaseTestCase
 import ubuntuone.controlpanel.gui.qt.gui
 
 
+backend = systray.backend  # pylint: disable=C0103
+
+
 class FakeSDTool(object):
 
     """Fake SyncDaemonTool."""
@@ -46,10 +50,138 @@
         super(FakeMainWindow, self).__init__()
 
 
-class SystrayTestCase(TestCase):
+class SystrayTestCase(BaseTestCase):
 
     """Test the notification area icon."""
 
+    class_ui = systray.TrayIcon
+
+    # pylint: disable=W0212
+
+    def assert_status_correct(self, status_bd, status_ui, action,
+                              callback=None):
+        """The shown status is correct.
+
+        * The ui's label shows 'status_ui'.
+        * If action is not None, the ui's button shows that 'action' as label
+        and when clicking it, 'callback' gets executed.
+        * If action is None, the ui's button should be hidden.
+        * If a tooltip is given, then it exists with correct text.
+
+        """
+        expected_text = status_ui
+
+        status = {backend.STATUS_KEY: status_bd}
+        self.ui._process_status(status)
+
+        actual_text = unicode(self.ui.status.text())
+        self.assertEqual(expected_text, actual_text)
+
+        self.assertFalse(self.ui.status.isEnabled())
+        self.assertEqual(unicode(self.ui.status_action.text()), action)
+
+        self.ui.status_action.trigger()
+        self.assertFalse(self.ui.status_action.isEnabled())
+        self.assert_backend_called(callback)
+
+    def test_process_info_invalid_status(self):
+        """File sync status invalid, ignore event."""
+        status = {backend.STATUS_KEY: backend.FILE_SYNC_STARTING,
+                  backend.MSG_KEY: qt.FILE_SYNC_STARTING,
+                  'icon': backend.FILE_SYNC_STARTING}
+        self.ui._process_status(status)
+        self.ui._process_status(3)
+
+        actual_text = unicode(self.ui.status.text())
+        self.assertEqual(qt.FILE_SYNC_STARTING, actual_text)
+
+    def test_process_info_changed(self):
+        """Backend's file sync status changed callback is connected."""
+        self.ui.refresh_status()
+        self.assertEqual(self.ui.backend.status_changed_handler,
+                         self.ui._process_status)
+
+    # pylint: enable=W0212
+
+    def test_process_info_disabled(self):
+        """File sync status disabled update the label."""
+        self.ui.refresh_status()
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_DISABLED,
+                                   status_ui=qt.FILE_SYNC_DISABLED,
+                                   action=qt.FILE_SYNC_ENABLE,
+                                   callback='enable_files')
+
+    def test_process_info_disconnected(self):
+        """File sync status disconnected update the label."""
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_DISCONNECTED,
+                                   status_ui=qt.FILE_SYNC_DISCONNECTED,
+                                   action=qt.FILE_SYNC_CONNECT,
+                                   callback='connect_files')
+
+    def test_process_info_error(self):
+        """File sync status error update the label."""
+        msg = qt.WARNING_MARKUP % qt.FILE_SYNC_ERROR
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_ERROR,
+                                   status_ui=msg,
+                                   action=qt.FILE_SYNC_RESTART,
+                                   callback='restart_files')
+
+    def test_process_info_idle(self):
+        """File sync status idle update the label."""
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_IDLE,
+                                   status_ui=qt.FILE_SYNC_IDLE,
+                                   action=qt.FILE_SYNC_DISCONNECT,
+                                   callback='disconnect_files')
+
+    def test_process_info_starting(self):
+        """File sync status starting update the label."""
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_STARTING,
+                                   status_ui=qt.FILE_SYNC_STARTING,
+                                   action=qt.FILE_SYNC_STOP,
+                                   callback='stop_files')
+
+    def test_process_info_stopped(self):
+        """File sync status stopped update the label."""
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_STOPPED,
+                                   status_ui=qt.FILE_SYNC_STOPPED,
+                                   action=qt.FILE_SYNC_START,
+                                   callback='start_files')
+
+    def test_process_info_syncing(self):
+        """File sync status syncing update the label."""
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_SYNCING,
+                                   status_ui=qt.FILE_SYNC_SYNCING,
+                                   action=qt.FILE_SYNC_DISCONNECT,
+                                   callback='disconnect_files')
+
+    def test_process_info_unknown(self):
+        """File sync status unknown update the label."""
+        msg = qt.WARNING_MARKUP % qt.FILE_SYNC_ERROR
+        self.assert_status_correct(status_bd=backend.FILE_SYNC_UNKNOWN,
+                                   status_ui=msg,
+                                   action=qt.FILE_SYNC_RESTART,
+                                   callback='restart_files')
+
+    def test_backend(self):
+        """Backend is created."""
+        self.assertIsInstance(self.ui.backend,
+                              backend.ControlBackend)
+
+    def test_refresh_status_requested(self):
+        """test refresh_status was requested on initialized."""
+        data = {}
+
+        def callback(status):
+            """Fake _process_status callback."""
+            data['called'] = True
+            data['status'] = status
+
+        self.patch(self.ui, "_process_status", callback)
+        self.ui.refresh_status()
+        self.assert_backend_called('file_sync_status')
+        self.assertTrue(data['called'])
+        self.assertEqual(data['status'], [])
+
     def test_quit(self):
         """Test the quit option in the menu."""
         # Not done on setup, because if I patch stop
@@ -74,29 +206,19 @@
             "MainWindow", FakeMainWindow)
         tray = systray.TrayIcon()
         self.assertEqual(tray.window, None)
-        tray.restore.trigger()
+        tray.open_u1.trigger()
         self.assertIsInstance(tray.window, FakeMainWindow)
         self.assertTrue(tray.window.isVisible())
         self.assertEqual(tray.window.args, ((),
             {'close_callback': tray.delete_window}))
 
-    def test_activate(self):
-        """Test the icon activation."""
-        tray = systray.TrayIcon()
-        window = FakeMainWindow()
-        tray.window = window
-        self.assertFalse(tray.window.isVisible())
-        tray.activated.emit(tray.Trigger)
-        self.assertEqual(tray.window, window)
-        self.assertTrue(tray.window.isVisible())
-
     def test_restore_window(self):
         """Test the restore window option in the menu, with a window."""
         tray = systray.TrayIcon()
         window = FakeMainWindow()
         tray.window = window
         self.assertFalse(tray.window.isVisible())
-        tray.restore.trigger()
+        tray.open_u1.trigger()
         self.assertEqual(tray.window, window)
         self.assertTrue(tray.window.isVisible())
 
@@ -109,7 +231,7 @@
         # it has a small delay, and it fails.
         self.patch(window, "activateWindow", self._set_called)
         tray.window = window
-        tray.restore.trigger()
+        tray.open_u1.trigger()
         self.assertEqual(self._called, ((), {}))
 
     def test_delete_window(self):
@@ -133,4 +255,7 @@
         self.assertTrue(tray.isVisible())
         self.assertEqual(tray.window, None)
         self.assertIsInstance(tray.context_menu, QtGui.QMenu)
+        self.assertIsInstance(tray.status, QtGui.QAction)
+        self.assertIsInstance(tray.status_action, QtGui.QAction)
+        self.assertIsInstance(tray.open_u1, QtGui.QAction)
         self.assertNotEqual(tray.icon(), None)