Merge lp:~nataliabidart/ubuntuone-control-panel/improve-volume-retrieval into lp:ubuntuone-control-panel

[Natalia Bidart]

- Backend provides a richer list of volumes, including the root info (LP: #705444).

The backend provides a richer volumes list info as per the new doc:

volumes_info
This is called by the gui to find out the volumes info for the current logged in user. The signals returned are:

       * VolumesInfoReady with a list of volume information. Each volume is represented by a tuple with 3 fields: the volume owner (empty string for current user), the amount of free bytes in the volume, and a list of "volumes_dict". Each "volumes_dict" has (at least) the following values (depending on the type, there might be extra parameters):
          o "volume_id" (unicode representation of an uuid)
          o “path” (unicode)
          o "suggested_path" (unicode)
          o "subscribed" (boolean, same convention as before)
          o "type" (unicode, either ROOT, UDF or SHARE)
    * VolumesInfoError with the error

[Roberto Alsina (ralsina)]

+1 but I only looked at the code.

[Roberto Alsina (ralsina)]

And I forgot to approve in the previous comment ;-)

review: Approve

[Alejandro J. Cura (alecu)]

Code looks good, all tests pass.

review: Approve

=== modified file 'ubuntuone/controlpanel/backend.py'
--- ubuntuone/controlpanel/backend.py	2011-01-18 21:24:31 +0000
+++ ubuntuone/controlpanel/backend.py	2011-01-20 17:38:08 +0000
@@ -327,7 +327,16 @@
     @inlineCallbacks
     def volumes_info(self):
         """Get the volumes info."""
-        result = yield dbus_client.get_folders()
+        account = yield self.account_info()
+        root_dir = yield dbus_client.get_root_dir()
+        folders = yield dbus_client.get_folders()
+
+        free_bytes = int(account['quota_total']) - int(account['quota_used'])
+        root_volume = {u'volume_id': u'', u'path': root_dir,
+                       u'subscribed': 'True', u'type': u'ROOT'}
+
+        result = [(u'', unicode(free_bytes), [root_volume] + folders)]
+
         # later, we may request shares info as well
         returnValue(result)
 
 
=== modified file 'ubuntuone/controlpanel/dbus_client.py'
--- ubuntuone/controlpanel/dbus_client.py	2011-01-18 13:42:12 +0000
+++ ubuntuone/controlpanel/dbus_client.py	2011-01-20 17:38:08 +0000
@@ -213,6 +213,14 @@
     return d
 
 
+def get_root_dir():
+    """Retrieve the root information from syncdaemon."""
+    d = defer.Deferred()
+    proxy = get_syncdaemon_proxy("/", sd_dbus_iface.DBUS_IFACE_SYNC_NAME)
+    proxy.get_rootdir(reply_handler=d.callback, error_handler=d.errback)
+    return d
+
+
 def get_folders():
     """Retrieve the folders information from syncdaemon."""
     d = defer.Deferred()
 
=== modified file 'ubuntuone/controlpanel/dbus_service.py'
--- ubuntuone/controlpanel/dbus_service.py	2011-01-18 20:35:47 +0000
+++ ubuntuone/controlpanel/dbus_service.py	2011-01-20 17:38:08 +0000
@@ -19,6 +19,8 @@
 
 """Export the control backend thru DBus."""
 
+from functools import wraps
+
 import dbus.service
 import gobject
 
@@ -93,6 +95,18 @@
     return inner
 
 
+def debug(f):
+    """Debug the call to 'f'."""
+
+    @wraps(f)
+    def inner(self, *args, **kwargs):
+        """Fake the call to 'f'."""
+        print '\n===', self, f, args, kwargs
+        return f(self, *args, **kwargs)
+
+    return inner
+
+
 class ControlPanelBackend(dbus.service.Object):
     """Export the Control Panel backend thru DBus."""
 
@@ -413,7 +427,7 @@
         d.addErrback(transform_failure(self.VolumesInfoError))
 
     @log_call(logger.debug)
-    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="aa{ss}")
+    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a(ssaa{ss})")
     def VolumesInfoReady(self, info):
         """The info for the volumes is available right now."""
 
 
=== modified file 'ubuntuone/controlpanel/integrationtests/test_dbus_client_sd.py'
--- ubuntuone/controlpanel/integrationtests/test_dbus_client_sd.py	2011-01-18 13:42:12 +0000
+++ ubuntuone/controlpanel/integrationtests/test_dbus_client_sd.py	2011-01-20 17:38:08 +0000
@@ -543,3 +543,31 @@
         yield dbus_client.stop_file_sync()
 
         self.assertEqual(self._called, ((), {}))
+
+
+class MockDBusSyncDaemon(dbus.service.Object):
+    """A mock object that mimicks syncdaemon."""
+
+    ROOT_DIR = u'/yadda/yoda/Test me'
+
+    @dbus.service.method(sd_dbus_iface.DBUS_IFACE_SYNC_NAME,
+                         in_signature='', out_signature='s')
+    def get_rootdir(self):
+        """Return the root dir/mount point."""
+        return self.ROOT_DIR
+
+
+class BasicTestCase(DBusClientTestCase):
+    """Test for the basic dbus client methods."""
+
+    def setUp(self):
+        super(BasicTestCase, self).setUp()
+        self.register_mockserver(sd_dbus_iface.DBUS_IFACE_NAME,
+                                 "/", MockDBusSyncDaemon)
+
+    @inlineCallbacks
+    def test_get_root_dir(self):
+        """Retrieve current syncdaemon root dir."""
+        root = yield dbus_client.get_root_dir()
+
+        self.assertEqual(MockDBusSyncDaemon.ROOT_DIR, root)
 
=== modified file 'ubuntuone/controlpanel/integrationtests/test_dbus_service.py'
--- ubuntuone/controlpanel/integrationtests/test_dbus_service.py	2011-01-18 20:35:47 +0000
+++ ubuntuone/controlpanel/integrationtests/test_dbus_service.py	2011-01-20 17:38:08 +0000
@@ -27,7 +27,8 @@
 
 from ubuntuone.controlpanel import dbus_service
 from ubuntuone.controlpanel import (DBUS_BUS_NAME, DBUS_PREFERENCES_PATH,
-                                    DBUS_PREFERENCES_IFACE)
+    DBUS_PREFERENCES_IFACE)
+from ubuntuone.controlpanel.tests import SAMPLE_FOLDERS
 from ubuntuone.controlpanel.integrationtests import TestCase
 
 
@@ -64,24 +65,7 @@
 ]
 
 SAMPLE_VOLUMES_INFO = [
-    {
-        "volume_id": "volume-0",
-        "path": "/home/user/Documents",
-        "suggested_path": "~/Documents",
-        "subscribed": 'True',
-    },
-    {
-        "volume_id": "volume-1",
-        "path": "/home/user/Music",
-        "suggested_path": "~/Music",
-        "subscribed": '',
-    },
-    {
-        "volume_id": "volume-2",
-        "path": "/home/user/Pictures/Photos",
-        "suggested_path": "~/Pictures/Photos",
-        "subscribed": '',
-    },
+    (u'', u'1253698', SAMPLE_FOLDERS),
 ]
 
 SAMPLE_REPLICATIONS_INFO = [
@@ -524,7 +508,7 @@
 
     def test_change_volume_settings(self):
         """The volume settings are successfully changed."""
-        expected_volume_id = SAMPLE_VOLUMES_INFO[0]['volume_id']
+        expected_volume_id = SAMPLE_FOLDERS[0]['volume_id']
 
         def got_signal(volume_id):
             """The correct volume was changed."""
 
=== modified file 'ubuntuone/controlpanel/tests/__init__.py'
--- ubuntuone/controlpanel/tests/__init__.py	2011-01-06 20:33:15 +0000
+++ ubuntuone/controlpanel/tests/__init__.py	2011-01-20 17:38:08 +0000
@@ -136,40 +136,66 @@
 ]
 
 SAMPLE_FOLDERS = [
-    {u'generation': u'2', u'node_id': u'341da068-81d8-437a-8f75-5bb9d86455ba',
-     u'path': u'/home/tester/Public', u'subscribed': u'True',
+    {u'generation': u'2',
+     u'node_id': u'341da068-81d8-437a-8f75-5bb9d86455ba',
+     u'path': u'/home/tester/Public',
+     u'subscribed': u'True',
      u'suggested_path': u'~/Public',
-     u'type': u'UDF', u'volume_id': u'9ea892f8-15fa-4201-bdbf-8de99fa5f588'},
-    {u'generation': u'', u'node_id': u'11fbc86c-0d7a-49f5-ae83-8402caf66c6a',
-     u'path': u'/home/tester/Documents', u'subscribed': u'',
+     u'type': u'UDF',
+     u'volume_id': u'9ea892f8-15fa-4201-bdbf-8de99fa5f588'},
+
+    {u'generation': u'',
+     u'node_id': u'11fbc86c-0d7a-49f5-ae83-8402caf66c6a',
+     u'path': u'/home/tester/Documents',
+     u'subscribed': u'',
      u'suggested_path': u'~/Documents',
-     u'type': u'UDF', u'volume_id': u'2db262f5-a151-4c19-969c-bb5ced753c61'},
-    {u'generation': u'24', u'node_id': u'9ee0e130-a7c7-4d76-a5e3-5df506221b48',
-     u'path': u'/home/tester/Pictures/Photos', u'subscribed': u'True',
+     u'type': u'UDF',
+     u'volume_id': u'2db262f5-a151-4c19-969c-bb5ced753c61'},
+
+    {u'generation': u'24',
+     u'node_id': u'9ee0e130-a7c7-4d76-a5e3-5df506221b48',
+     u'path': u'/home/tester/Pictures/Photos',
+     u'subscribed': u'True',
      u'suggested_path': u'~/Pictures/Photos',
-     u'type': u'UDF', u'volume_id': u'1deb2874-3d28-46ae-9999-d5f48de9f460'},
+     u'type': u'UDF',
+     u'volume_id': u'1deb2874-3d28-46ae-9999-d5f48de9f460'},
 ]
 
 SAMPLE_SHARES = [
-    {u'accepted': u'True', u'access_level': u'View',
-     u'free_bytes': u'39892622746', u'generation': u'2704',
-     u'name': u're', u'node_id': u'c483f419-ed28-490a-825d-a8c074e2d795',
-     u'other_username': u'otheruser', u'other_visible_name': u'Other User',
+    {u'accepted': u'True',
+     u'access_level': u'View',
+     u'free_bytes': u'39892622746',
+     u'generation': u'2704',
+     u'name': u're',
+     u'node_id': u'c483f419-ed28-490a-825d-a8c074e2d795',
+     u'other_username': u'otheruser',
+     u'other_visible_name': u'Other User',
      u'path': u'/home/tester/.local/share/ubuntuone/shares/re from Other User',
-     u'type': u'Share', u'volume_id': u'4a1b263b-a2b3-4f66-9e66-4cd18050810d'},
-    {u'accepted': u'True', u'access_level': u'Modify',
-     u'free_bytes': u'39892622746', u'generation': u'2704',
-     u'name': u'do', u'node_id': u'84544ea4-aefe-4f91-9bb9-ed7b0a805baf',
-     u'other_username': u'otheruser', u'other_visible_name': u'Other User',
+     u'type': u'Share',
+     u'volume_id': u'4a1b263b-a2b3-4f66-9e66-4cd18050810d'},
+
+    {u'accepted': u'True',
+     u'access_level': u'Modify',
+     u'free_bytes': u'39892622746',
+     u'generation': u'2704',
+     u'name': u'do',
+     u'node_id': u'84544ea4-aefe-4f91-9bb9-ed7b0a805baf',
+     u'other_username': u'otheruser',
+     u'other_visible_name': u'Other User',
      u'path': u'/home/tester/.local/share/ubuntuone/shares/do from Other User',
-     u'type': u'Share', u'volume_id': u'7d130dfe-98b2-4bd5-8708-9eeba9838ac0'},
+     u'type': u'Share',
+     u'volume_id': u'7d130dfe-98b2-4bd5-8708-9eeba9838ac0'},
 ]
 
 SAMPLE_SHARED = [
-    {u'accepted': u'True', u'access_level': u'View',
-     u'free_bytes': u'', u'generation': u'',
-     u'name': u'bar', u'node_id': u'31e47530-9448-4f03-b4dc-4154fdf35225',
-     u'other_username': u'otheruser', u'other_visible_name': u'Other User',
+    {u'accepted': u'True',
+     u'access_level': u'View',
+     u'free_bytes': u'',
+     u'generation': u'',
+     u'name': u'bar',
+     u'node_id': u'31e47530-9448-4f03-b4dc-4154fdf35225',
+     u'other_username': u'otheruser',
+     u'other_visible_name': u'Other User',
      u'path': u'/home/tester/Ubuntu One/bar',
      u'type': u'Shared',
      u'volume_id': u'79584900-517f-4dff-b2f3-20e8c1e79365'},
 
=== modified file 'ubuntuone/controlpanel/tests/test_backend.py'
--- ubuntuone/controlpanel/tests/test_backend.py	2011-01-18 21:24:31 +0000
+++ ubuntuone/controlpanel/tests/test_backend.py	2011-01-20 17:38:08 +0000
@@ -87,6 +87,7 @@
     status_changed_handler = None
     subscribed_folders = []
     actions = []
+    root_dir = u'/home/tester/Something/Pepe Mosquito'
 
     def get_credentials(self):
         """Return the mock credentials."""
@@ -142,6 +143,10 @@
         """Stop the file_sync service."""
         MockDBusClient.actions.append('stop')
 
+    def get_root_dir(self):
+        """Grab the root dir."""
+        return self.root_dir
+
     def get_folders(self):
         """Grab list of folders."""
         return SAMPLE_FOLDERS
@@ -368,9 +373,23 @@
     @inlineCallbacks
     def test_volumes_info(self):
         """The volumes_info method exercises its callback."""
+        # fake quota info and calculate free bytes
+        # pylint: disable=E1101
+        self.be.wc.results[ACCOUNT_API] = SAMPLE_ACCOUNT_NO_CURRENT_PLAN
+        self.be.wc.results[QUOTA_API] = SAMPLE_QUOTA_JSON
+        result = yield self.be.account_info()
+        free_bytes = int(result['quota_total']) - int(result['quota_used'])
+
+        # get root dir info
+        root_dir = MockDBusClient.root_dir
+        root_volume = {u'volume_id': u'', u'path': root_dir,
+                       u'subscribed': 'True', u'type': u'ROOT'}
+
         result = yield self.be.volumes_info()
+
+        expected = [('', unicode(free_bytes), [root_volume] + SAMPLE_FOLDERS)]
         # later, we should unify folders and shares info
-        self.assertEqual(result, SAMPLE_FOLDERS)
+        self.assertEqual(result, expected)
 
     @inlineCallbacks
     def test_subscribe_volume(self):