Merge lp:~nataliabidart/ubuntuone-client/851810-notify-on-volumes into lp:ubuntuone-client

[Natalia Bidart]

- Emit a notification when volumes are ready after a server rescan, allowing clients to follow and update their information accordingly (LP: #851810).

[lp:~nataliabidart/ubuntuone-client/851810-notify-on-volumes]

1223. By Natalia Bidart on 2012-03-28

- Attaching bug #851810.

[Roberto Alsina (ralsina)]

+1

review: Approve

[Brian Curtin (brian.curtin)]

This looks familiar :)

Approved. Tests pass on Windows.

review: Approve

=== modified file 'tests/platform/test_external_interface.py'
--- tests/platform/test_external_interface.py	2012-02-03 14:29:52 +0000
+++ tests/platform/test_external_interface.py	2012-03-28 21:44:19 +0000
@@ -31,6 +31,7 @@
 
 STR = 'something'
 STR_STR_DICT = {'foo': 'bar'}
+STR_LST_DICT = [STR_STR_DICT]
 
 
 class StatusTests(StatusTestCase):
@@ -146,6 +147,7 @@
     signal_mapping = [
         ('RootMismatch', (STR, STR)),
         ('QuotaExceeded', (STR_STR_DICT,)),
+        ('VolumesChanged', (STR_LST_DICT,)),
     ]
 
     @defer.inlineCallbacks

=== modified file 'tests/platform/test_tools.py'
--- tests/platform/test_tools.py	2012-01-17 20:00:44 +0000
+++ tests/platform/test_tools.py	2012-03-28 21:44:19 +0000
@@ -898,11 +898,29 @@
     @defer.inlineCallbacks
     def test_refresh_volumes(self):
         """Test for refresh_volumes method."""
-        d = defer.Deferred()
-        self.patch(self.main.action_q, 'list_volumes',
-                   lambda: d.callback(True))
-        yield self.tool.refresh_volumes()
-        yield d
+        udf = self._create_udf()
+        yield self.main.vm.add_udf(udf)
+
+        share = self._create_share()
+        yield self.main.vm.add_share(share)
+
+        volumes = list(self.main.vm.get_volumes(all_volumes=True))
+
+        def volumes_changed():
+            """Fake volumes_changed."""
+            self.main.event_q.push('VM_VOLUMES_CHANGED', volumes=volumes)
+
+        self.patch(self.main.vm, 'refresh_volumes', volumes_changed)
+        result = yield self.tool.refresh_volumes()
+
+        str_volumes = []
+        for volume in volumes:
+            if isinstance(volume, volume_manager.UDF):
+                str_vol = interaction_interfaces.get_udf_dict(volume)
+            else:
+                str_vol = interaction_interfaces.get_share_dict(volume)
+            str_volumes.append(str_vol)
+        self.assertEqual(result, str_volumes)
 
     @defer.inlineCallbacks
     def test_rescan_from_scratch(self):

=== modified file 'tests/syncdaemon/test_interaction_interfaces.py'
--- tests/syncdaemon/test_interaction_interfaces.py	2012-03-01 19:08:12 +0000
+++ tests/syncdaemon/test_interaction_interfaces.py	2012-03-28 21:44:19 +0000
@@ -1750,6 +1750,24 @@
         self.assertEqual(error, error_msg)
 
     @defer.inlineCallbacks
+    def test_handle_VM_VOLUMES_CHANGED(self):
+        """Test the handle_VM_VOLUMES_CHANGED method."""
+        share = self._create_share(accepted=True)
+        udf = self._create_udf()
+        volumes = [share, udf, self.main.vm.root]
+        d = defer.Deferred()
+        self.patch(self.sd_obj.interface.sync_daemon, 'VolumesChanged',
+                   d.callback)
+
+        self.main.event_q.push('VM_VOLUMES_CHANGED', volumes=volumes)
+
+        info = yield d
+
+        str_volumes = sorted((get_share_dict(share), get_udf_dict(udf),
+                              get_share_dict(self.main.vm.root)))
+        self.assertEqual(str_volumes, sorted(info))
+
+    @defer.inlineCallbacks
     def test_handle_VM_VOLUME_DELETED_folder(self):
         """Test the handle_VM_VOLUME_DELETED method for a folder."""
         udf = self._create_udf()

=== modified file 'tests/syncdaemon/test_vm.py'
--- tests/syncdaemon/test_vm.py	2012-02-09 23:32:10 +0000
+++ tests/syncdaemon/test_vm.py	2012-03-28 21:44:19 +0000
@@ -1893,6 +1893,27 @@
         """Test handle_AQ_LIST_VOLUMES event with an inactive udf."""
         yield self._test_handle_AQ_LIST_VOLUMES_udf(False)
 
+    @defer.inlineCallbacks
+    def test_handle_AQ_LIST_VOLUMES_emits_volumes_changed(self):
+        """When handling a new volume list, VM_VOLUMES_CHANGED is pushed."""
+        share = self._create_share_volume()
+        udf = self._create_udf_volume()
+        root_volume = volumes.RootVolume(uuid.uuid4(), 17, 10)
+        response = [share, udf, root_volume]
+
+        udf_created_d = defer.Deferred()
+        self._listen_for('VM_UDF_CREATED', udf_created_d.callback)
+
+        volumes_changed_d = defer.Deferred()
+        self._listen_for('VM_VOLUMES_CHANGED', volumes_changed_d.callback)
+
+        self.vm.handle_AQ_LIST_VOLUMES(response)
+
+        yield udf_created_d
+        actual = yield volumes_changed_d
+        expected = {'volumes': list(self.vm.get_volumes(all_volumes=True))}
+        self.assertEqual(expected, actual)
+
 
 class VolumeManagerOperationsTests(BaseVolumeManagerTests):
     """Test UDF/Volumes operations."""
@@ -3104,12 +3125,18 @@
                          vol_rescan_d.callback)  # autosubscribe is False
         server_rescan_d = defer.Deferred()
         self._listen_for('SYS_SERVER_RESCAN_DONE', server_rescan_d.callback)
+        volumes_changed_d = defer.Deferred()
+        self._listen_for('VM_VOLUMES_CHANGED', volumes_changed_d.callback)
         yield self.vm.server_rescan()
         yield server_rescan_d
         events = yield vol_rescan_d
+        vols = yield volumes_changed_d
 
         self.assertEqual({'generation': 1, 'volume_id': ''}, events)
 
+        expected = list(self.vm.get_volumes(all_volumes=True))
+        self.assertEqual({'volumes' : expected}, vols)
+
     @defer.inlineCallbacks
     def test_server_rescan_with_share_autosubscribe(self):
         """Test the server_rescan method."""

=== modified file 'ubuntuone/platform/linux/dbus_interface.py'
--- ubuntuone/platform/linux/dbus_interface.py	2012-02-18 16:13:04 +0000
+++ ubuntuone/platform/linux/dbus_interface.py	2012-03-28 21:44:19 +0000
@@ -326,6 +326,10 @@
     def QuotaExceeded(self, volume_dict):
         """QuotaExceeded signal, the user ran out of space."""
 
+    @dbus.service.signal(DBUS_IFACE_SYNC_NAME, signature='aa{ss}')
+    def VolumesChanged(self, volumes):
+        """Volumes list changed."""
+
 
 class FileSystem(DBusExposedObject):
     """An interface to the FileSystem Manager."""

=== modified file 'ubuntuone/platform/tools/__init__.py'
--- ubuntuone/platform/tools/__init__.py	2012-02-03 14:29:52 +0000
+++ ubuntuone/platform/tools/__init__.py	2012-03-28 21:44:19 +0000
@@ -64,7 +64,7 @@
         """Converts a dict returned by the IPC client to a dict of strings."""
         str_dict = {}
         for key in a_dict:
-            str_dict[key] = unicode(a_dict[key])
+            str_dict[unicode(key)] = unicode(a_dict[key])
         return str_dict
 
     def shutdown(self):
@@ -642,10 +642,17 @@
         """Enable/disable udf_autosubscribe."""
         return self.enable_setting('udf_autosubscribe', enabled)
 
+    @defer.inlineCallbacks
     @log_call(logger.debug)
     def refresh_volumes(self):
         """Request the volumes list to the server."""
-        return self.proxy.call_method('folders', 'refresh_volumes')
+        d = self.wait_for_signals('VolumesChanged')
+        self.proxy.call_method('folders', 'refresh_volumes')
+
+        (results,) = yield d
+
+        volumes_info = [self._get_dict(r) for r in results]
+        defer.returnValue(volumes_info)
 
     @log_call(logger.debug)
     def rescan_from_scratch(self, volume_id):

=== modified file 'ubuntuone/platform/tools/windows.py'
--- ubuntuone/platform/tools/windows.py	2011-11-30 14:53:56 +0000
+++ ubuntuone/platform/tools/windows.py	2012-03-28 21:44:19 +0000
@@ -88,6 +88,7 @@
         'ShareUnSubscribed': ('shares', 'on_share_unsubscribed_cb'),
         'ShareUnSubscribeError': ('shares', 'on_share_unsubscribe_error_cb'),
         'StatusChanged': ('status', 'on_status_changed_cb'),
+        'VolumesChanged': ('sync_daemon', 'on_volumes_changed_cb'),
     }
 
     # All methods and instance variables that should not be handled by

=== modified file 'ubuntuone/platform/windows/ipc.py'
--- ubuntuone/platform/windows/ipc.py	2012-02-18 16:13:04 +0000
+++ ubuntuone/platform/windows/ipc.py	2012-03-28 21:44:19 +0000
@@ -382,6 +382,7 @@
     signal_mapping = {
         'RootMismatch': 'on_root_mismatch',
         'QuotaExceeded': 'on_quota_exceeded',
+        'VolumesChanged': 'on_volumes_changed',
     }
 
     def connect(self):
@@ -439,6 +440,10 @@
     def QuotaExceeded(self, volume_dict):
         """QuotaExceeded signal, the user ran out of space."""
 
+    @signal
+    def VolumesChanged(self, volumes):
+        """Volumes list has changed."""
+
 
 class FileSystem(IPCExposedObject):
     """An interface to the FileSystem Manager."""

=== modified file 'ubuntuone/platform/windows/ipc_client.py'
--- ubuntuone/platform/windows/ipc_client.py	2012-02-03 14:29:52 +0000
+++ ubuntuone/platform/windows/ipc_client.py	2012-03-28 21:44:19 +0000
@@ -253,7 +253,11 @@
     __metaclass__ = RemoteMeta
 
     # calls that will be accessible remotely
-    signal_handlers = ['on_root_mismatch', 'on_quota_exceeded']
+    signal_handlers = [
+        'on_root_mismatch',
+        'on_quota_exceeded',
+        'on_volumes_changed',
+    ]
 
     @remote
     def connect(self):
@@ -301,6 +305,10 @@
     def on_quota_exceeded(self, volume_dict):
         """Emit QuotaExceeded signal."""
 
+    @signal
+    def on_volumes_changed(self, volumes):
+        """Emit VolumesChanged signal."""
+
 
 class FileSystemClient(RemoteClient):
     """An ipc interface to the FileSystem Manager."""

=== modified file 'ubuntuone/syncdaemon/event_queue.py'
--- ubuntuone/syncdaemon/event_queue.py	2011-10-14 20:02:23 +0000
+++ ubuntuone/syncdaemon/event_queue.py	2012-03-28 21:44:19 +0000
@@ -160,7 +160,7 @@
     'VM_VOLUME_DELETED': ('volume',),
     'VM_VOLUME_DELETE_ERROR': ('volume_id', 'error'),
     'VM_SHARE_CHANGED': ('share_id',),
-
+    'VM_VOLUMES_CHANGED': ('volumes',),
 }
 
 DEFAULT_HANDLER = "handle_default"  # receives (event_name, **kwargs)

=== modified file 'ubuntuone/syncdaemon/interaction_interfaces.py'
--- ubuntuone/syncdaemon/interaction_interfaces.py	2012-03-19 13:20:36 +0000
+++ ubuntuone/syncdaemon/interaction_interfaces.py	2012-03-28 21:44:19 +0000
@@ -1039,6 +1039,17 @@
         self.interface.shares.ShareChanged(get_share_dict(share))
 
     @log_call(logger.debug)
+    def handle_VM_VOLUMES_CHANGED(self, volumes):
+        """Handle VM_VOLUMES_CHANGED event, emit VolumeChanged signal."""
+        str_volumes = []
+        for volume in volumes:
+            if isinstance(volume, UDF):
+                str_volumes.append(get_udf_dict(volume))
+            else:
+                str_volumes.append(get_share_dict(volume))
+        self.interface.sync_daemon.VolumesChanged(str_volumes)
+
+    @log_call(logger.debug)
     def handle_AQ_CHANGE_PUBLIC_ACCESS_OK(self, share_id, node_id,
                                           is_public, public_url):
         """Handle the AQ_CHANGE_PUBLIC_ACCESS_OK event."""

=== modified file 'ubuntuone/syncdaemon/volume_manager.py'
--- ubuntuone/syncdaemon/volume_manager.py	2012-02-09 23:32:10 +0000
+++ ubuntuone/syncdaemon/volume_manager.py	2012-03-28 21:44:19 +0000
@@ -636,6 +636,9 @@
             # update the free_bytes on the volume
             self.update_free_space(volume_id, new_volume.free_bytes)
 
+        volumes = list(self.get_volumes(all_volumes=True))
+        events.append(("VM_VOLUMES_CHANGED", dict(volumes=volumes)))
+
         # push the collected events
         for event in events:
             self.m.event_q.push(event[0], **event[1])