Merge lp:~nataliabidart/ubuntuone-control-panel/share-backend into lp:ubuntuone-control-panel

[Natalia Bidart]

- Share the same backend instance among all widgets (LP: #834766).
- No more edge when hitting the REST api.

Run the controlpanel with:

nessita@dali:~/canonical/u1/controlpanel/share-backend$ ./setup.py clean build; DEBUG=True PYTHONPATH=. ./bin/ubuntuone-control-panel-qt > a.out 2>&1

and confirm that the log line:

2011-09-02 15:00:52,491 - ubuntuone.controlpanel.backend - INFO - ControlBackend: instance started.

appears only once, no matter how many devices you have, no matter how many times you visit a tab.

[lp:~nataliabidart/ubuntuone-control-panel/share-backend]

215. By Natalia Bidart on 2011-09-02

Typos.

[Roberto Alsina (ralsina)]

+1 good job!

review: Approve

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

=== modified file 'ubuntuone/controlpanel/__init__.py'
--- ubuntuone/controlpanel/__init__.py	2011-08-26 17:16:16 +0000
+++ ubuntuone/controlpanel/__init__.py	2011-09-02 18:12:25 +0000
@@ -29,6 +29,5 @@
 DBUS_PREFERENCES_PATH = "/preferences"
 DBUS_PREFERENCES_IFACE = "com.ubuntuone.controlpanel.Preferences"
 
-# XXX: use edge only when testing new stuff
-WEBSERVICE_BASE_URL = u"https://edge.one.ubuntu.com/api/"
+WEBSERVICE_BASE_URL = u"https://one.ubuntu.com/api/"
 TRANSLATION_DOMAIN = 'ubuntuone-control-panel'

=== modified file 'ubuntuone/controlpanel/backend.py'
--- ubuntuone/controlpanel/backend.py	2011-08-31 16:20:08 +0000
+++ ubuntuone/controlpanel/backend.py	2011-09-02 18:12:25 +0000
@@ -138,6 +138,8 @@
         self.sd_client = sd_client.SyncDaemonClient()
         self.wc = web_client_factory(self.get_credentials)
 
+        logger.info('ControlBackend: instance started.')
+
     def _process_file_sync_status(self, status):
         """Process raw file sync status into custom format.
 

=== added file 'ubuntuone/controlpanel/cache.py'
--- ubuntuone/controlpanel/cache.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/cache.py	2011-09-02 18:12:25 +0000
@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+# Authors: Natalia B Bidart <[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/>.
+
+"""The base object that holds a backend instance."""
+
+from ubuntuone.controlpanel import backend
+
+
+class Cache(object):
+    """The base object that caches stuff."""
+
+    logger = None
+    _shared_objects = {}
+
+    def __init__(self, *args, **kwargs):
+        """Initialize the object using 'backend' as backend."""
+        super(Cache, self).__init__()
+        if self.logger is not None:
+            self.logger.debug('%s: started.', self.__class__.__name__)
+
+    @property
+    def backend(self):
+        """A cached ControlBackend instance."""
+        if not self._shared_objects:
+            self._shared_objects['backend'] = backend.ControlBackend()
+        return self._shared_objects['backend']
+
+    def clear(self):
+        """Clear all cached objects."""
+        self._shared_objects = {}

=== modified file 'ubuntuone/controlpanel/gui/gtk/tests/__init__.py'
--- ubuntuone/controlpanel/gui/gtk/tests/__init__.py	2011-08-18 15:50:38 +0000
+++ ubuntuone/controlpanel/gui/gtk/tests/__init__.py	2011-09-02 18:12:25 +0000
@@ -109,8 +109,8 @@
     ]
 
 
-class FakeControlPanelBackend(FakedDBusBackend):
-    """Fake a Control Panel Service, act as a dbus.Interface."""
+class FakedGUIBackend(FakedDBusBackend):
+    """Fake a Control Panel GUI Service, act as a dbus.Interface."""
 
     bus_name = gui.DBUS_BUS_NAME_GUI
     object_path = gui.DBUS_PATH_GUI
@@ -135,7 +135,7 @@
             return FakedControlPanelBackend(obj, dbus_interface,
                                             *args, **kwargs)
         if dbus_interface == gui.DBUS_IFACE_GUI:
-            return FakeControlPanelBackend(
+            return FakedGUIBackend(
                 obj, dbus_interface, *args, **kwargs)
 
 

=== modified file 'ubuntuone/controlpanel/gui/qt/addfolder.py'
--- ubuntuone/controlpanel/gui/qt/addfolder.py	2011-08-27 01:05:52 +0000
+++ ubuntuone/controlpanel/gui/qt/addfolder.py	2011-09-02 18:12:25 +0000
@@ -25,11 +25,9 @@
 from PyQt4 import QtGui, QtCore
 from twisted.internet import defer
 
-from ubuntuone.controlpanel import backend
+from ubuntuone.controlpanel import cache
 from ubuntuone.controlpanel.logger import setup_logging
-from ubuntuone.controlpanel.gui import (
-    FOLDER_INVALID_PATH,
-)
+from ubuntuone.controlpanel.gui import FOLDER_INVALID_PATH
 
 
 logger = setup_logging('qt.addfolder')
@@ -37,9 +35,11 @@
 CLOSE = QtGui.QMessageBox.Close
 
 
-class AddFolderButton(QtGui.QPushButton):
+class AddFolderButton(cache.Cache, QtGui.QPushButton):
     """The AddFolderButton widget"""
 
+    logger = logger
+
     folderCreated = QtCore.pyqtSignal(unicode)
     folderCreationCanceled = QtCore.pyqtSignal()
 
@@ -47,9 +47,7 @@
         """Initialize the UI of the widget."""
         super(AddFolderButton, self).__init__(*args, **kwargs)
         self.cloud_folders = []
-        self.backend = backend.ControlBackend()
         self.clicked.connect(self.on_clicked)
-        logger.debug('%s: started.', self.__class__.__name__)
 
     @QtCore.pyqtSlot()
     @defer.inlineCallbacks

=== modified file 'ubuntuone/controlpanel/gui/qt/device.py'
--- ubuntuone/controlpanel/gui/qt/device.py	2011-08-19 15:35:38 +0000
+++ ubuntuone/controlpanel/gui/qt/device.py	2011-09-02 18:12:25 +0000
@@ -25,6 +25,7 @@
     DEVICE_TYPE_COMPUTER,
     DEVICE_TYPE_PHONE,
 )
+from ubuntuone.controlpanel import cache
 from ubuntuone.controlpanel.gui import DEVICE_CONFIRM_REMOVE
 from ubuntuone.controlpanel.gui.qt import icon_from_name, pixmap_from_name
 from ubuntuone.controlpanel.gui.qt.ui import device_ui
@@ -49,19 +50,18 @@
     return icon_name
 
 
-class DeviceWidget(QtGui.QWidget):
+class DeviceWidget(cache.Cache, QtGui.QWidget):
     """The widget for each device in the control panel."""
 
     removed = QtCore.pyqtSignal()
     removeCanceled = QtCore.pyqtSignal()
 
-    def __init__(self, backend, device_id, **kwargs):
+    def __init__(self, device_id, *args, **kwargs):
         """Initialize the UI of the widget."""
-        QtGui.QWidget.__init__(self, **kwargs)
+        super(DeviceWidget, self).__init__(*args, **kwargs)
         self.ui = device_ui.Ui_Form()
         self.ui.setupUi(self)
         self.id = device_id
-        self.backend = backend
 
     def update_device_info(self, device_info):
         """Update the device info."""

=== modified file 'ubuntuone/controlpanel/gui/qt/devices.py'
--- ubuntuone/controlpanel/gui/qt/devices.py	2011-08-31 17:18:56 +0000
+++ ubuntuone/controlpanel/gui/qt/devices.py	2011-09-02 18:12:25 +0000
@@ -90,8 +90,7 @@
 
     def update_local_device(self, device_info):
         """Update the info for the local device."""
-        device_widget = device.DeviceWidget(backend=self.backend,
-                                            device_id=device_info['device_id'])
+        device_widget = device.DeviceWidget(device_id=device_info['device_id'])
         device_widget.update_device_info(device_info)
         device_widget.removed.connect(self.on_local_device_removed)
 

=== modified file 'ubuntuone/controlpanel/gui/qt/filesyncstatus.py'
--- ubuntuone/controlpanel/gui/qt/filesyncstatus.py	2011-08-31 17:18:56 +0000
+++ ubuntuone/controlpanel/gui/qt/filesyncstatus.py	2011-09-02 18:12:25 +0000
@@ -21,7 +21,7 @@
 from PyQt4 import QtGui, QtCore
 from twisted.internet import defer
 
-from ubuntuone.controlpanel import backend
+from ubuntuone.controlpanel import backend, cache
 from ubuntuone.controlpanel.logger import setup_logging, log_call
 from ubuntuone.controlpanel.gui import (
     ERROR_COLOR,
@@ -108,19 +108,16 @@
     return icon_name
 
 
-class FileSyncStatus(QtGui.QWidget):
+class FileSyncStatus(cache.Cache, QtGui.QWidget):
     """The FileSyncStatus widget"""
 
-    def __init__(self, parent=None):
+    def __init__(self, *args, **kwargs):
         """Initialize the UI of the widget."""
-        QtGui.QWidget.__init__(self, parent)
+        super(FileSyncStatus, self).__init__(*args, **kwargs)
         self.ui = filesyncstatus_ui.Ui_Form()
         self.ui.setupUi(self)
 
         self._backend_method = None
-        self.backend = backend.ControlBackend()
-
-        logger.debug('%s: started.', self.__class__.__name__)
 
     # Invalid name "showEvent"
     # pylint: disable=C0103

=== modified file 'ubuntuone/controlpanel/gui/qt/gotoweb.py'
--- ubuntuone/controlpanel/gui/qt/gotoweb.py	2011-08-31 18:33:43 +0000
+++ ubuntuone/controlpanel/gui/qt/gotoweb.py	2011-09-02 18:12:25 +0000
@@ -22,11 +22,11 @@
 
 from twisted.internet import defer
 
-from ubuntuone.controlpanel import backend
+from ubuntuone.controlpanel import cache
 from ubuntuone.controlpanel.gui import qt, sign_url, UBUNTUONE_LINK
 
 
-class GoToWebButton(QtGui.QPushButton):
+class GoToWebButton(cache.Cache, QtGui.QPushButton):
     """The GoToWebButton widget"""
 
     def __init__(self, *args, **kwargs):
@@ -38,8 +38,6 @@
         self.clicked.connect(self.on_clicked)
         self.setCursor(QtGui.QCursor(QtCore.Qt.PointingHandCursor))
 
-        self.backend = backend.ControlBackend()
-
     @defer.inlineCallbacks
     @QtCore.pyqtSlot()
     def on_clicked(self):

=== modified file 'ubuntuone/controlpanel/gui/qt/gui.py'
--- ubuntuone/controlpanel/gui/qt/gui.py	2011-08-31 17:18:56 +0000
+++ ubuntuone/controlpanel/gui/qt/gui.py	2011-09-02 18:12:25 +0000
@@ -33,7 +33,7 @@
 
     def __init__(self, close_callback=None):
         """Initialize this instance with the UI layout."""
-        QtGui.QMainWindow.__init__(self)
+        super(MainWindow, self).__init__()
         self.ui = mainwindow_ui.Ui_MainWindow()
         self.ui.setupUi(self)
         self.close_callback = close_callback

=== modified file 'ubuntuone/controlpanel/gui/qt/loadingoverlay.py'
--- ubuntuone/controlpanel/gui/qt/loadingoverlay.py	2011-08-31 17:18:56 +0000
+++ ubuntuone/controlpanel/gui/qt/loadingoverlay.py	2011-09-02 18:12:25 +0000
@@ -36,7 +36,7 @@
     """
 
     def __init__(self, parent=None):
-        QtGui.QFrame.__init__(self, parent)
+        super(LoadingOverlay, self).__init__(parent=parent)
         self.ui = loadingoverlay_ui.Ui_Form()
         self.ui.setupUi(self)
 

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/__init__.py'
--- ubuntuone/controlpanel/gui/qt/tests/__init__.py	2011-09-01 17:11:16 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/__init__.py	2011-09-02 18:12:25 +0000
@@ -25,7 +25,7 @@
 from PyQt4 import QtCore
 from ubuntuone.devtools.handlers import MementoHandler
 
-from ubuntuone.controlpanel import backend
+from ubuntuone.controlpanel import backend, cache
 from ubuntuone.controlpanel.tests import TestCase, EXPECTED_ACCOUNT_INFO, TOKEN
 from ubuntuone.controlpanel.gui import qt, UBUNTUONE_FROM_OAUTH
 from ubuntuone.controlpanel.gui.tests import FakedObject, USER_HOME
@@ -80,21 +80,6 @@
     return folder
 
 
-def skip_if_abstract_class(test):
-    """Decorator to skip a test if is an abstract class."""
-
-    def inner(instance):
-        """Skip a test if is an abstract class."""
-        abstract = instance.class_ui is None
-        result = None
-        if not abstract:
-            result = test(instance)
-
-        return result
-
-    return inner
-
-
 class FakeUi(FakedObject):
     """A fake Ui object."""
 
@@ -179,18 +164,21 @@
     class_ui = None
     kwargs = {}
 
-    @skip_if_abstract_class
     def setUp(self):
+        cache.Cache._shared_objects = {}
         super(BaseTestCase, self).setUp()
         self.patch(backend, 'ControlBackend', FakedControlPanelBackend)
-        # self.class_ui is not callable
-        # pylint: disable=E1102
-        self.ui = self.class_ui(**self.kwargs)
-        self.addCleanup(self.ui.destroy)
-
-        if hasattr(self.ui, 'backend'):
-            # clean backend calls
-            self.ui.backend._called.clear()
+
+        self.ui = None
+        if self.class_ui is not None:
+            # self.class_ui is not callable
+            # pylint: disable=E1102
+            self.ui = self.class_ui(**self.kwargs)
+            # pylint: enable=E1102
+            self.addCleanup(self.ui.destroy)
+
+        if getattr(self.ui, 'backend', None) is not None:
+            self.addCleanup(self.ui.backend._called.clear)
 
         if getattr(self.ui, 'logger', None) is not None:
             self.memento = MementoHandler()
@@ -248,3 +236,8 @@
             expected_setup_ui = expected_setup_ui(self.ui)
         self.assertEqual(self.ui.ui._called,
                          {'setupUi': ((expected_setup_ui,), {})})
+
+    def test_backend_is_correct(self):
+        """The backend instance is correct."""
+        if getattr(self.ui, 'backend', None) is not None:
+            self.assertIsInstance(self.ui.backend, FakedControlPanelBackend)

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2011-09-01 17:11:16 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2011-09-02 18:12:25 +0000
@@ -41,6 +41,7 @@
     @defer.inlineCallbacks
     def setUp(self):
         yield super(ControlPanelTestCase, self).setUp()
+        self.patch(self.ui.ui.folders_tab, 'process_info', lambda info: None)
         self.ui.backend.next_result = SAMPLE_ACCOUNT_INFO
 
     @defer.inlineCallbacks

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_device.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_device.py	2011-07-21 13:21:00 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_device.py	2011-09-02 18:12:25 +0000
@@ -24,7 +24,6 @@
 from ubuntuone.controlpanel.gui.qt.tests import (
     BaseTestCase,
     FakedConfirmDialog,
-    FakedControlPanelBackend,
     SAMPLE_COMPUTER_INFO,
     SAMPLE_PHONE_INFO,
 )
@@ -40,18 +39,13 @@
     innerclass_ui = gui.device_ui
     innerclass_name = "Ui_Form"
     class_ui = gui.DeviceWidget
-    backend = FakedControlPanelBackend()
     device_id = 'zaraza'
-    kwargs = {'backend': backend, 'device_id': device_id}
+    kwargs = {'device_id': device_id}
 
     def test_has_id(self):
         """The device as an id, None by default."""
         self.assertEqual(self.ui.id, self.device_id)
 
-    def test_has_backend(self):
-        """The device as a backend, None by default."""
-        self.assertIs(self.ui.backend, self.backend)
-
     def test_update_device_info(self):
         """The widget is updated with the info."""
         info = SAMPLE_COMPUTER_INFO

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_gotoweb.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_gotoweb.py	2011-08-31 18:33:43 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_gotoweb.py	2011-09-02 18:12:25 +0000
@@ -51,10 +51,6 @@
         self.assertEqual(self.ui.cursor().shape(),
                          gui.QtCore.Qt.PointingHandCursor)
 
-    def test_backend(self):
-        """Backend is created."""
-        self.assertIsInstance(self.ui.backend, gui.backend.ControlBackend)
-
     def test_open_uri_when_clicked(self):
         """When clicking the button, the uri is opened."""
         self.patch(qt, 'uri_hook', self._set_called)

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_ubuntuonebin.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_ubuntuonebin.py	2011-08-31 18:33:43 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_ubuntuonebin.py	2011-09-02 18:12:25 +0000
@@ -32,11 +32,6 @@
 
     class_ui = gui.UbuntuOneBin
 
-    def test_backend(self):
-        """Backend is created."""
-        self.assertIsInstance(self.ui.backend,
-                              gui.backend.ControlBackend)
-
     def test_is_not_processing_after_creation(self):
         """After creation, is not processing."""
         self.assertFalse(self.ui.is_processing)

=== modified file 'ubuntuone/controlpanel/gui/qt/ubuntuonebin.py'
--- ubuntuone/controlpanel/gui/qt/ubuntuonebin.py	2011-08-31 17:18:56 +0000
+++ ubuntuone/controlpanel/gui/qt/ubuntuonebin.py	2011-09-02 18:12:25 +0000
@@ -20,19 +20,18 @@
 
 from PyQt4 import QtGui
 
-from ubuntuone.controlpanel import backend
+from ubuntuone.controlpanel import cache
 from ubuntuone.controlpanel.gui.qt.loadingoverlay import LoadingOverlay
 
 
-class UbuntuOneBin(QtGui.QWidget):
+class UbuntuOneBin(cache.Cache, QtGui.QWidget):
     """The base widget for the Control Panel's tabs."""
 
     ui_class = None
-    logger = None
 
-    def __init__(self, parent=None):
+    def __init__(self, *args, **kwargs):
         """Initialize the UI of the widget."""
-        QtGui.QWidget.__init__(self, parent)
+        super(UbuntuOneBin, self).__init__(*args, **kwargs)
         self.ui = None
         if self.ui_class is not None:
             # self.ui_class is not callable
@@ -46,12 +45,8 @@
         self._is_processing = None
         self.is_processing = False
 
-        self.backend = backend.ControlBackend()
         self._setup()
 
-        if self.logger is not None:
-            self.logger.debug('%s: started.', self.__class__.__name__)
-
     def _get_is_processing(self):
         """Get the value of is_processing."""
         return self._is_processing

=== added file 'ubuntuone/controlpanel/tests/test_cache.py'
--- ubuntuone/controlpanel/tests/test_cache.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/tests/test_cache.py	2011-09-02 18:12:25 +0000
@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+
+# Authors: Natalia B. Bidart <[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 control panel cache."""
+
+from ubuntuone.controlpanel import backend, cache
+from ubuntuone.controlpanel.tests import TestCase
+
+
+class FakedBackend(object):
+    """A faked backend."""
+
+
+class CacheTestCase(TestCase):
+    """Test suite for the Cache object."""
+
+    def setUp(self):
+        super(CacheTestCase, self).setUp()
+        self.patch(backend, 'ControlBackend', object)
+        self.obj = cache.Cache()
+        self.addCleanup(self.obj.clear)
+
+    def test_backend(self):
+        """The backend instance is successfully created."""
+        self.assertIsInstance(self.obj.backend, cache.backend.ControlBackend)
+
+    def test_backend_is_cached(self):
+        """The backend instance is cached."""
+        obj2 = cache.Cache()
+        self.assertTrue(self.obj.backend is obj2.backend)
+
+    def test_clear(self):
+        """The cached stuff are cleared."""
+        old_backend = self.obj.backend
+        self.obj.clear()
+        self.assertFalse(self.obj.backend is old_backend)