Merge lp:~nataliabidart/ubuntuone-control-panel/more-logging-and-ids into lp:ubuntuone-control-panel

[Natalia Bidart]

* Added logging to dbus_service and backend.
* Error signals now sent the object id when available (LP: #691292).

Run the tests with:

./run-tests

[Martin Albisetti (beuno)]

review: Approve

[Roman Yepishev (rye)]

Looks ok. Tested by running it and finding nothing broken.

review: Approve (code)

=== modified file 'bin/ubuntuone-control-panel-backend'
--- bin/ubuntuone-control-panel-backend	2010-09-25 06:20:41 +0000
+++ bin/ubuntuone-control-panel-backend	2010-12-16 21:10:31 +0000
@@ -18,6 +18,8 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Execute the DBus backend for the Ubuntu One control panel."""
 
+# Invalid name "ubuntuone-control-panel-backend", pylint: disable=C0103
+
 
 from ubuntuone.controlpanel import dbus_service
 
 
=== modified file 'bin/ubuntuone-control-panel-gtk'
--- bin/ubuntuone-control-panel-gtk	2010-11-10 15:55:33 +0000
+++ bin/ubuntuone-control-panel-gtk	2010-12-16 21:10:31 +0000
@@ -18,7 +18,7 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Execute the graphical interface for the Ubuntu One control panel."""
 
-import gtk
+# Invalid name "ubuntuone-control-panel-gtk", pylint: disable=C0103
 
 import dbus.mainloop.glib
 
@@ -26,6 +26,7 @@
 
 dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
 
+
 if __name__ == "__main__":
-    ui = ubuntuone.controlpanel.gtk.gui.ControlPanelWindow()
-    ui.main()
+    gui = ubuntuone.controlpanel.gtk.gui.ControlPanelWindow()
+    gui.main()
 
=== modified file 'ubuntuone/controlpanel/backend.py'
--- ubuntuone/controlpanel/backend.py	2010-12-13 22:13:05 +0000
+++ ubuntuone/controlpanel/backend.py	2010-12-16 21:10:31 +0000
@@ -124,6 +124,7 @@
         credentials = yield dbus_client.get_credentials()
         returnValue(credentials["token"])
 
+    @log_call(logger.debug)
     @inlineCallbacks
     def account_info(self):
         """Get the user account info."""
@@ -140,6 +141,7 @@
 
         returnValue(result)
 
+    @log_call(logger.debug)
     @inlineCallbacks
     def devices_info(self):
         """Get the user devices info."""
@@ -184,6 +186,7 @@
             return DEVICE_TYPE_PHONE, device_id[5:]
         return "No device", device_id
 
+    @log_call(logger.info)
     @inlineCallbacks
     def change_device_settings(self, device_id, settings):
         """Change the settings for the given device."""
@@ -214,6 +217,7 @@
         # still pending: more work on the settings dict (LP: #673674)
         returnValue(device_id)
 
+    @log_call(logger.warning)
     @inlineCallbacks
     def remove_device(self, device_id):
         """Remove a device's tokens from the sso server."""
@@ -222,7 +226,7 @@
         yield self.wc.call_api(api)
         returnValue(device_id)
 
-    @log_call(logger.info)
+    @log_call(logger.debug)
     @inlineCallbacks
     def file_sync_status(self):
         """Return the status of the file sync service."""
@@ -233,6 +237,7 @@
             status = {}
         returnValue(self._process_file_sync_status(status))
 
+    @log_call(logger.debug)
     @inlineCallbacks
     def volumes_info(self):
         """Get the volumes info."""
@@ -240,6 +245,7 @@
         # later, we may request shares info as well
         returnValue(result)
 
+    @log_call(logger.debug)
     @inlineCallbacks
     def change_volume_settings(self, volume_id, settings):
         """Change settings for 'volume_id'.
@@ -268,11 +274,13 @@
         # is a folder or a share
         yield dbus_client.unsubscribe_folder(volume_id)
 
+    @log_call(logger.debug)
     def query_bookmark_extension(self):
         """True if the bookmark extension has been installed."""
         # still pending (LP: #673672)
         returnValue(False)
 
+    @log_call(logger.debug)
     def install_bookmarks_extension(self):
         """Install the extension to sync bookmarks."""
         # still pending (LP: #673673)
 
=== modified file 'ubuntuone/controlpanel/dbus_service.py'
--- ubuntuone/controlpanel/dbus_service.py	2010-12-13 20:20:51 +0000
+++ ubuntuone/controlpanel/dbus_service.py	2010-12-16 21:10:31 +0000
@@ -80,10 +80,14 @@
     With this call, a Failure is transformed into a string-string dict.
 
     """
-    def inner(error, *a):
+    def inner(error, _=None):
         """Do the Failure transformation."""
         error_dict = error_handler(error)
-        return f(error_dict)
+        if _ is not None:
+            result = f(_, error_dict)
+        else:
+            result = f(error_dict)
+        return result
 
     return inner
 
@@ -102,6 +106,7 @@
 
     # pylint: disable=C0103
 
+    @log_call(logger.debug)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="")
     def account_info(self):
         """Find out the account info for the current logged in user."""
@@ -109,16 +114,19 @@
         d.addCallback(self.AccountInfoReady)
         d.addErrback(transform_failure(self.AccountInfoError))
 
+    @log_call(logger.debug)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
     def AccountInfoReady(self, info):
         """The info for the current user is available right now."""
 
+    @log_call(logger.error)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
     def AccountInfoError(self, error):
         """The info for the current user is currently unavailable."""
 
     #---
 
+    @log_call(logger.debug)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="")
     def devices_info(self):
         """Find out the devices info for the logged in user."""
@@ -126,46 +134,55 @@
         d.addCallback(self.DevicesInfoReady)
         d.addErrback(transform_failure(self.DevicesInfoError))
 
+    @log_call(logger.debug)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="aa{ss}")
     def DevicesInfoReady(self, info):
         """The info for the devices is available right now."""
 
+    @log_call(logger.error)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
     def DevicesInfoError(self, error):
         """The info for the devices is currently unavailable."""
 
     #---
 
+    @log_call(logger.info)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="sa{ss}")
-    def change_device_settings(self, token, settings):
+    def change_device_settings(self, device_id, settings):
         """Configure a given device."""
-        d = self.backend.change_device_settings(token, settings)
+        d = self.backend.change_device_settings(device_id, settings)
         d.addCallback(self.DeviceSettingsChanged)
-        d.addErrback(transform_failure(self.DeviceSettingsChangeError))
+        d.addErrback(transform_failure(self.DeviceSettingsChangeError),
+                     device_id)
 
+    @log_call(logger.info)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="s")
-    def DeviceSettingsChanged(self, token):
+    def DeviceSettingsChanged(self, device_id):
         """The settings for the device were changed."""
 
-    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
-    def DeviceSettingsChangeError(self, error):
+    @log_call(logger.error)
+    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="sa{ss}")
+    def DeviceSettingsChangeError(self, device_id, error):
         """Problem changing settings for the device."""
 
     #---
 
+    @log_call(logger.warning)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="s")
-    def remove_device(self, token):
+    def remove_device(self, device_id):
         """Remove a given device."""
-        d = self.backend.remove_device(token)
+        d = self.backend.remove_device(device_id)
         d.addCallback(self.DeviceRemoved)
-        d.addErrback(transform_failure(self.DeviceRemovalError))
+        d.addErrback(transform_failure(self.DeviceRemovalError), device_id)
 
+    @log_call(logger.warning)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="s")
-    def DeviceRemoved(self, token):
+    def DeviceRemoved(self, device_id):
         """The removal for the device was completed."""
 
-    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
-    def DeviceRemovalError(self, error):
+    @log_call(logger.error)
+    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="sa{ss}")
+    def DeviceRemovalError(self, device_id, error):
         """Problem removing the device."""
 
     #---
@@ -192,7 +209,7 @@
         else:
             self.FileSyncStatusError(error_handler(status_dict))
 
-    @log_call(logger.info)
+    @log_call(logger.debug)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="")
     def file_sync_status(self):
         """Get the status of the file sync service."""
@@ -232,6 +249,7 @@
 
     #---
 
+    @log_call(logger.debug)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="")
     def volumes_info(self):
         """Find out the volumes info for the logged in user."""
@@ -251,23 +269,28 @@
 
     #---
 
+    @log_call(logger.info)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="sa{ss}")
     def change_volume_settings(self, volume_id, settings):
         """Configure a given volume."""
         d = self.backend.change_volume_settings(volume_id, settings)
         d.addCallback(self.VolumeSettingsChanged)
-        d.addErrback(transform_failure(self.VolumeSettingsChangeError))
+        d.addErrback(transform_failure(self.VolumeSettingsChangeError),
+                     volume_id)
 
+    @log_call(logger.info)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="s")
-    def VolumeSettingsChanged(self, token):
+    def VolumeSettingsChanged(self, volume_id):
         """The settings for the volume were changed."""
 
-    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
-    def VolumeSettingsChangeError(self, error):
+    @log_call(logger.error)
+    @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="sa{ss}")
+    def VolumeSettingsChangeError(self, volume_id, error):
         """Problem changing settings for the volume."""
 
     #---
 
+    @log_call(logger.debug)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="")
     def query_bookmark_extension(self):
         """Check if the extension to sync bookmarks is installed."""
@@ -275,16 +298,19 @@
         d.addCallback(self.QueryBookmarksResult)
         d.addErrback(transform_failure(self.QueryBookmarksError))
 
+    @log_call(logger.debug)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="b")
     def QueryBookmarksResult(self, enabled):
         """The bookmark extension is or is not installed."""
 
+    @log_call(logger.error)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
     def QueryBookmarksError(self, error):
         """Problem getting the status of the extension."""
 
     #---
 
+    @log_call(logger.info)
     @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="")
     def install_bookmarks_extension(self):
         """Install the extension to sync bookmarks."""
@@ -292,10 +318,12 @@
         d.addCallback(lambda _: self.InstallBookmarksSuccess())
         d.addErrback(transform_failure(self.InstallBookmarksError))
 
+    @log_call(logger.info)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="")
     def InstallBookmarksSuccess(self):
         """The extension to sync bookmarks has been installed."""
 
+    @log_call(logger.error)
     @signal(dbus_interface=DBUS_PREFERENCES_IFACE, signature="a{ss}")
     def InstallBookmarksError(self, error):
         """Problem installing the extension to sync bookmarks."""
 
=== modified file 'ubuntuone/controlpanel/integrationtests/test_dbus_service.py'
--- ubuntuone/controlpanel/integrationtests/test_dbus_service.py	2010-12-13 22:13:05 +0000
+++ ubuntuone/controlpanel/integrationtests/test_dbus_service.py	2010-12-16 21:10:31 +0000
@@ -449,8 +449,14 @@
 
         """
 
-        def got_error_signal(error_dict):
+        def got_error_signal(*a):
             """The error signal was received."""
+            if len(a) == 1:
+                error_dict = a[0]
+            else:
+                an_id, error_dict = a
+                self.assertEqual(an_id, args[0])
+
             self.assertEqual(error_dict[dbus_service.ERROR_TYPE],
                              'AssertionError')
             self.deferred.callback("success")