Merge lp:~nataliabidart/ubuntuone-control-panel/wait-for-it into lp:ubuntuone-control-panel

[Natalia Bidart]

- Make use of the new feature from syncdaemon where 'refresh_volumes'
  returns a deferred that gets fired when the server info is ready
  (LP: #851810).

[lp:~nataliabidart/ubuntuone-control-panel/wait-for-it]

303. By Natalia Bidart on 2012-03-29

Merged trunk in.

[Roberto Alsina (ralsina)]

+1

review: Approve

[lp:~nataliabidart/ubuntuone-control-panel/wait-for-it]

304. By Natalia Bidart on 2012-03-29

- No longer need to skip the status changed handler setting.

[Brian Curtin (brian.curtin)]

Approved. Tests pass on Windows

review: Approve

=== modified file 'ubuntuone/controlpanel/backend.py'
--- ubuntuone/controlpanel/backend.py	2012-03-28 12:06:28 +0000
+++ ubuntuone/controlpanel/backend.py	2012-03-29 18:32:21 +0000
@@ -599,7 +599,7 @@
 
     @log_call(logger.debug)
     @inlineCallbacks
-    def volumes_info(self, with_storage_info=True):
+    def volumes_info(self, with_storage_info=True, refresh=False):
         """Get the volumes info."""
         self._volumes = {}
 
@@ -612,6 +612,9 @@
             else:
                 free_bytes = account['quota_total'] - account['quota_used']
 
+        if refresh:
+            yield self.sd_client.refresh_volumes()
+
         root_dir = yield self.sd_client.get_root_dir()
         shares_dir = yield self.sd_client.get_shares_dir()
         shares_dir_link = yield self.sd_client.get_shares_dir_link()

=== removed file 'ubuntuone/controlpanel/dbustests/test_sd_client/test_linux.py'
--- ubuntuone/controlpanel/dbustests/test_sd_client/test_linux.py	2011-10-24 21:48:27 +0000
+++ ubuntuone/controlpanel/dbustests/test_sd_client/test_linux.py	1970-01-01 00:00:00 +0000
@@ -1,94 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Authors: Alejandro J. Cura <[e-mail]>
-# Authors: Natalia B. Bidart <[e-mail]>
-#
-# Copyright 2010 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 DBus service when accessing SyncDaemon."""
-
-import dbus
-
-from twisted.internet import defer
-
-from ubuntuone.platform.linux import dbus_interface as sd_dbus_iface
-
-from ubuntuone.controlpanel import sd_client
-from ubuntuone.controlpanel.dbustests import DBusClientTestCase
-
-
-SD_DBUS_IFACE_NAME = sd_dbus_iface.DBUS_IFACE_NAME
-SD_DBUS_IFACE_STATUS_NAME = sd_dbus_iface.DBUS_IFACE_STATUS_NAME
-
-# pylint, you have to go to decorator's school
-# pylint: disable=C0322
-
-# Access to a protected member of a client class
-# pylint: disable=W0212
-
-
-class StatusMockDBusSyncDaemon(dbus.service.Object):
-    """A mock object that mimicks syncdaemon regarding the Status iface."""
-
-    state_dict = {
-        'name': 'TEST',
-        'description': 'Some test state, nothing else.',
-        'is_error': '',
-        'is_connected': 'True',
-        'is_online': '',
-        'queues': 'GORGEOUS',
-        'connection': '',
-    }
-
-    def _get_current_state(self):
-        """Get the current status of the system."""
-        return self.state_dict
-
-    @dbus.service.method(SD_DBUS_IFACE_STATUS_NAME,
-                         in_signature='', out_signature='a{ss}')
-    def current_status(self):
-        """Return the current faked status of the system."""
-        return self._get_current_state()
-
-    # pylint: disable=C0103
-    # Invalid name "StatusChanged"
-
-    @dbus.service.signal(SD_DBUS_IFACE_STATUS_NAME)
-    def StatusChanged(self, status):
-        """Fire a signal to notify that the status of the system changed."""
-
-    def emit_status_changed(self, state=None):
-        """Emit StatusChanged."""
-        self.StatusChanged(self._get_current_state())
-
-
-class StatusTestCase(DBusClientTestCase):
-    """Test for the status dbus client methods."""
-
-    @defer.inlineCallbacks
-    def setUp(self):
-        yield super(StatusTestCase, self).setUp()
-        self.register_mockserver(SD_DBUS_IFACE_NAME,
-                                 "/status", StatusMockDBusSyncDaemon)
-
-    def test_set_status_changed_handler(self):
-        """A proper callback can be connected to StatusChanged signal."""
-        client = sd_client.SyncDaemonClient()
-        _, sig = client.set_status_changed_handler(self._set_called)
-
-        self.assertEqual(sig._handler, self._set_called)
-        self.assertEqual(sig._member, 'StatusChanged')
-        self.assertEqual(sig._path, '/status')
-        self.assertEqual(sig._interface, SD_DBUS_IFACE_STATUS_NAME)

=== modified file 'ubuntuone/controlpanel/gui/qt/folders.py'
--- ubuntuone/controlpanel/gui/qt/folders.py	2012-03-29 14:52:59 +0000
+++ ubuntuone/controlpanel/gui/qt/folders.py	2012-03-29 18:32:21 +0000
@@ -153,7 +153,8 @@
     def load(self):
         """Load specific tab info."""
         self.is_processing = True
-        info = yield self.backend.volumes_info(with_storage_info=False)
+        info = yield self.backend.volumes_info(with_storage_info=False,
+                                               refresh=self.remote_folders)
         self.process_info(info)
 
     @handle_errors(logger=logger)

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_folders.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2012-03-29 15:25:48 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2012-03-29 18:32:21 +0000
@@ -187,7 +187,8 @@
 
     def test_info_is_requested_on_load(self):
         """The volumes info is requested to the backend."""
-        self.assert_backend_called('volumes_info', with_storage_info=False)
+        self.assert_backend_called('volumes_info', with_storage_info=False,
+                                   refresh=self.ui.remote_folders)
 
     def test_process_info(self):
         """The volumes info is processed when ready."""

=== modified file 'ubuntuone/controlpanel/sd_client/__init__.py'
--- ubuntuone/controlpanel/sd_client/__init__.py	2012-01-18 14:06:35 +0000
+++ ubuntuone/controlpanel/sd_client/__init__.py	2012-03-29 18:32:21 +0000
@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Authors: Natalia B Bidart <[e-mail]>
 #
-# Copyright 2011 Canonical Ltd.
+# 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
@@ -18,7 +16,6 @@
 
 """The syncdaemon client."""
 
-import sys
 import warnings
 
 # pylint: disable=E0611
@@ -35,7 +32,6 @@
 
     def __init__(self):
         """Get a proxy for the SyncDaemonTool."""
-        self.status_changed_handler = None
         self.proxy = tools.SyncDaemonTool()
 
     def get_throttling_limits(self):
@@ -200,11 +196,8 @@
 
     def set_status_changed_handler(self, handler):
         """Set the status handler function."""
-        self.status_changed_handler = handler
-        if sys.platform.startswith("linux"):
-            # pylint: disable=W0404
-            from ubuntuone.controlpanel.sd_client import linux
-            result = linux.set_status_changed_handler(handler)
-        else:
-            result = self.proxy.set_status_changed_handler(handler)
-        return result
+        return self.proxy.connect_signal('StatusChanged', handler)
+
+    def refresh_volumes(self):
+        """Refresh the volumes information from syncdaemon."""
+        return self.proxy.refresh_volumes()

=== removed file 'ubuntuone/controlpanel/sd_client/linux.py'
--- ubuntuone/controlpanel/sd_client/linux.py	2011-06-29 17:59:07 +0000
+++ ubuntuone/controlpanel/sd_client/linux.py	1970-01-01 00:00:00 +0000
@@ -1,46 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Authors: Alejandro J. Cura <[e-mail]>
-# Authors: Natalia B. Bidart <[e-mail]>
-#
-# Copyright 2010 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/>.
-
-"""Client to use other DBus services."""
-
-import dbus.service
-
-from ubuntuone.controlpanel.logger import setup_logging
-
-
-logger = setup_logging('sd_client')
-
-
-def get_syncdaemon_proxy(object_path, dbus_interface):
-    """Get a DBus proxy for syncdaemon at 'object_path':'dbus_interface'."""
-    logger.debug('get_syncdaemon_proxy: object_path %r, dbus_interface %r',
-                 object_path, dbus_interface)
-    bus = dbus.SessionBus()
-    obj = bus.get_object(bus_name='com.ubuntuone.SyncDaemon',
-                         object_path=object_path,
-                         follow_name_owner_changes=True)
-    proxy = dbus.Interface(object=obj, dbus_interface=dbus_interface)
-    return proxy
-
-
-def set_status_changed_handler(handler):
-    """Connect 'handler' with syncdaemon's StatusChanged signal."""
-    proxy = get_syncdaemon_proxy('/status', 'com.ubuntuone.SyncDaemon.Status')
-    sig = proxy.connect_to_signal('StatusChanged', handler)
-    return proxy, sig

=== modified file 'ubuntuone/controlpanel/tests/test_backend.py'
--- ubuntuone/controlpanel/tests/test_backend.py	2012-03-28 17:09:58 +0000
+++ ubuntuone/controlpanel/tests/test_backend.py	2012-03-29 18:32:21 +0000
@@ -169,6 +169,7 @@
         self.actions = []
         self.shares = []
         self.folders = []
+        self.volumes_refreshed = False
 
     def get_throttling_limits(self):
         """Return the sample speed limits."""
@@ -319,6 +320,11 @@
         """Grab list of shared (shares from the user to others)."""
         return SAMPLE_SHARED
 
+    def refresh_volumes(self):
+        """Refresh the volume list."""
+        self.volumes_refreshed = True
+        return defer.succeed(None)
+
 
 class MockReplicationClient(CallRecorder):
     """A mock replication_client module."""
@@ -860,10 +866,19 @@
             u'display_name': display_name,
         }
 
+        self.patch(self.be.sd_client, 'shares', SAMPLE_SHARES)
+        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
+
     @inlineCallbacks
-    def expected_volumes(self, sample_shares, sample_folders,
+    def expected_volumes(self, sample_shares=None, sample_folders=None,
                          with_storage_info=True):
         """Get shares and group by sharing user, get folders and free space."""
+        if sample_shares is None:
+            sample_shares = self.be.sd_client.shares
+
+        if sample_folders is None:
+            sample_folders = self.be.sd_client.folders
+
         free_bytes = self.be.FREE_BYTES_NOT_AVAILABLE
         if with_storage_info:
             try:
@@ -926,11 +941,19 @@
     @inlineCallbacks
     def test_volumes_info(self):
         """The volumes_info method exercises its callback."""
-        self.patch(self.be.sd_client, 'shares', SAMPLE_SHARES)
-        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
-
-        expected = yield self.expected_volumes(SAMPLE_SHARES, SAMPLE_FOLDERS)
+        expected = yield self.expected_volumes()
         result = yield self.be.volumes_info()
+
+        self.assertEqual(result, expected)
+        self.assertFalse(self.be.sd_client.volumes_refreshed)
+
+    @inlineCallbacks
+    def test_volumes_info_can_refresh_volumes(self):
+        """The volumes_info can be refreshed."""
+        expected = yield self.expected_volumes()
+        result = yield self.be.volumes_info(refresh=True)
+
+        self.assertTrue(self.be.sd_client.volumes_refreshed)
         self.assertEqual(result, expected)
 
     @inlineCallbacks
@@ -943,7 +966,6 @@
             path = path[len(USER_HOME) + 1:]
             item[u'path'] = os.path.join(root_path, path)
         self.patch(self.be.sd_client, 'shares', SAMPLE_SHARES)
-        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
 
         yield self.be.volumes_info()
         for item in SAMPLE_FOLDERS:
@@ -956,11 +978,7 @@
     @inlineCallbacks
     def test_volumes_info_without_storage_info(self):
         """The volumes_info method exercises its callback."""
-        self.patch(self.be.sd_client, 'shares', SAMPLE_SHARES)
-        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
-
-        expected = yield self.expected_volumes(SAMPLE_SHARES, SAMPLE_FOLDERS,
-                                               with_storage_info=False)
+        expected = yield self.expected_volumes(with_storage_info=False)
         result = yield self.be.volumes_info(with_storage_info=False)
         self.assertEqual(result, expected)
 
@@ -971,11 +989,8 @@
     @inlineCallbacks
     def test_volumes_are_cached(self):
         """The volume list is cached."""
-        self.patch(self.be.sd_client, 'shares', SAMPLE_SHARES)
-        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
-
         expected = {}
-        info = yield self.expected_volumes(SAMPLE_SHARES, SAMPLE_FOLDERS)
+        info = yield self.expected_volumes()
         for _, _, data in info:
             for volume in data:
                 sid = volume['volume_id']
@@ -1024,10 +1039,8 @@
         ]
 
         self.patch(self.be.sd_client, 'shares', read_only_shares)
-        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
 
-        expected = yield self.expected_volumes(read_only_shares,
-                                               SAMPLE_FOLDERS)
+        expected = yield self.expected_volumes()
         result = yield self.be.volumes_info()
         self.assertEqual(result, expected)
 
@@ -1035,10 +1048,8 @@
     def test_volumes_info_no_quota_for_root(self):
         """The volumes_info returns info even if quota call fails."""
         self.be.wc.failure = 500
-        self.patch(self.be.sd_client, 'shares', SAMPLE_SHARES)
-        self.patch(self.be.sd_client, 'folders', SAMPLE_FOLDERS)
 
-        expected = yield self.expected_volumes(SAMPLE_SHARES, SAMPLE_FOLDERS)
+        expected = yield self.expected_volumes()
         result = yield self.be.volumes_info()
 
         self.assertEqual(len(result), len(expected))
@@ -1126,6 +1137,8 @@
     @inlineCallbacks
     def test_create_folder(self):
         """New folders can be created."""
+        self.patch(self.be.sd_client, 'folders', [])
+
         folder_path = os.path.join(USER_HOME, 'Test Me')
         yield self.be.create_folder(folder_path=folder_path)
 

=== modified file 'ubuntuone/controlpanel/tests/test_sd_client.py'
--- ubuntuone/controlpanel/tests/test_sd_client.py	2012-03-19 17:16:43 +0000
+++ ubuntuone/controlpanel/tests/test_sd_client.py	2012-03-29 18:32:21 +0000
@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Authors: Alejandro J. Cura <[e-mail]>
-# Authors: Natalia B. Bidart <[e-mail]>
 #
-# Copyright 2010 Canonical Ltd.
+# Copyright 2010-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
@@ -24,11 +21,7 @@
 
 from twisted.internet import defer
 from twisted.internet.defer import inlineCallbacks, returnValue
-from ubuntuone.devtools.testcases import skipIfNotOS
-# No name 'tools' in module 'ubuntuone.platform'
-# pylint: disable=E0611
 from ubuntuone.platform import tools
-# pylint: enable=E0611
 from ubuntuone.syncdaemon.interaction_interfaces import bool_str
 
 from ubuntuone.controlpanel import sd_client
@@ -183,14 +176,12 @@
     @inlineCallbacks
     def subscribe_folder(self, folder_id):
         """Subscribe to a user defined folder given its id."""
-        yield self._set_folder_attr(folder_id,
-                                                   u'subscribed', True)
+        yield self._set_folder_attr(folder_id, u'subscribed', True)
 
     @inlineCallbacks
     def unsubscribe_folder(self, folder_id):
         """Unsubscribe from a user defined folder given its id."""
-        yield self._set_folder_attr(folder_id,
-                                                   u'subscribed', False)
+        yield self._set_folder_attr(folder_id, u'subscribed', False)
 
     @inlineCallbacks
     def get_folders(self):
@@ -315,9 +306,9 @@
         """Return the shares link directory."""
         return self.shares_dir_link
 
-    def set_status_changed_handler(self, handler):
+    def connect_signal(self, signal_name, handler):
         """Set the handler for the status changed signal."""
-        self.called['status_changed_handler'] = handler
+        self.called[signal_name] = handler
 
 
 class BaseTestCase(TestCase):
@@ -694,14 +685,12 @@
 
         self.assertEqual(self.sd.proxy.called['quit'], None)
 
-    @skipIfNotOS('win32', 'The tested function is only defined on windows')
     @inlineCallbacks
     def test_set_status_changed_handler(self):
         """Connect a handler to the status changed signal."""
         sample_handler = object()
         yield self.sd.set_status_changed_handler(sample_handler)
-        self.assertEqual(sample_handler,
-                   self.sd.proxy.called['status_changed_handler'])
+        self.assertEqual(sample_handler, self.sd.proxy.called['StatusChanged'])
 
 
 class BasicTestCase(BaseTestCase):