Merge lp:~nataliabidart/ubuntuone-control-panel/cmt-wtf into lp:ubuntuone-control-panel

[Natalia Bidart]

- Login client is now platform independent (LP: #798687).

To test IRL, and since we're replacing the backend that handles credentials, you should run both the new backend and the GTK UI:

$ DEBUG=True PYTHONPATH=. ./bin/ubuntuone-control-panel-backend
$ DEBUG=True PYTHONPATH=. ./bin/ubuntuone-control-panel-gtk

First test would be confirm that all your account and plan data is retrieved (this means that new credentials backend was able to retrieve correct credentials). Then you can remove the current device, and re-authenticate from the overview screen.

[Eric Casteleijn (thisfred)]

Code looks good, account info was gotten successfully, removing and adding device worked. When I close the control panel, the backend gives this, which is probably not new:

2011-06-17 13:02:03,285 - ubuntuone.controlpanel.backend - INFO - shutdown: args (<ubuntuone.controlpanel.backend.ControlBackend object at 0x26eb990>,), kwargs {}.
Fatal Python error: PyEval_RestoreThread: NULL tstate
Aborted

review: Approve

[Alejandro J. Cura (alecu)]

Looks great, works as advertised.

review: Approve

=== modified file 'setup.py'
--- setup.py	2011-05-25 13:59:47 +0000
+++ setup.py	2011-06-17 16:05:59 +0000
@@ -230,7 +230,7 @@
     packages=[
         'ubuntuone', 'ubuntuone.controlpanel', 'ubuntuone.controlpanel.gui',
         'ubuntuone.controlpanel.gui.gtk', 'ubuntuone.controlpanel.gui.qt',
-        'ubuntuone.controlpanel.login_client', 'ubuntuone.controlpanel.sd_client',
+        'ubuntuone.controlpanel.sd_client',
         'ubuntuone.controlpanel.web_client',
     ],
     extra_path='ubuntuone-control-panel',

=== modified file 'ubuntuone/controlpanel/gui/qt/main/linux.py'
--- ubuntuone/controlpanel/gui/qt/main/linux.py	2011-06-16 18:18:23 +0000
+++ ubuntuone/controlpanel/gui/qt/main/linux.py	2011-06-17 16:05:59 +0000
@@ -56,6 +56,7 @@
         """A custom SDTool."""
 
         settings = {
+            'file_sync_enabled': True,
             'autoconnect': True,
             'show_all_notifications': True,
             'share_autosubscribe': False,

=== removed directory 'ubuntuone/controlpanel/integrationtests/test_login_client'
=== removed file 'ubuntuone/controlpanel/integrationtests/test_login_client/__init__.py'
--- ubuntuone/controlpanel/integrationtests/test_login_client/__init__.py	2011-05-26 22:08:32 +0000
+++ ubuntuone/controlpanel/integrationtests/test_login_client/__init__.py	1970-01-01 00:00:00 +0000
@@ -1,19 +0,0 @@
-# -*- 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 login client test suite."""

=== removed file 'ubuntuone/controlpanel/integrationtests/test_login_client/test_linux.py'
--- ubuntuone/controlpanel/integrationtests/test_login_client/test_linux.py	2011-05-26 22:08:32 +0000
+++ ubuntuone/controlpanel/integrationtests/test_login_client/test_linux.py	1970-01-01 00:00:00 +0000
@@ -1,207 +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 Single Sign On."""
-
-# pylint: disable=C0103
-# DBus signals have CamelCased names
-
-import dbus
-
-from ubuntu_sso import (DBUS_BUS_NAME,
-    DBUS_CREDENTIALS_PATH, DBUS_CREDENTIALS_IFACE)
-from twisted.internet.defer import inlineCallbacks
-
-from ubuntuone.controlpanel import login_client
-from ubuntuone.controlpanel.integrationtests import (MockDBusNoMethods,
-    DBusClientTestCase)
-
-
-SAMPLE_CREDS = {
-    "token": "ABCDEF12345678",
-    "access_token": "DEADCAFE2010",
-}
-OTHER_CREDS = {"token": "other!"}
-SAMPLE_ERROR = {"error message": "test", "detailed_error": "error details"}
-
-# pylint: disable=C0322
-# pylint, you have to go to decorator's school
-
-
-class MockDBusSSOService(dbus.service.Object):
-    """A mock object that mimicks ussoc."""
-
-    found = True
-    wrong_app = None
-    error = None
-
-    @dbus.service.method(dbus_interface=DBUS_CREDENTIALS_IFACE,
-                         in_signature='sa{ss}', out_signature='')
-    def find_credentials(self, app_name, args):
-        """Get creds from the keyring, login/register if needed."""
-        if self.wrong_app is None and self.error is None:
-            if self.found:
-                self.CredentialsFound(app_name, SAMPLE_CREDS)
-            else:
-                self.CredentialsNotFound(app_name)
-        elif self.wrong_app is not None and self.error is None:
-            self.CredentialsFound(self.wrong_app, OTHER_CREDS)
-        elif self.wrong_app is None and self.error is not None:
-            self.CredentialsError(app_name, self.error)
-        else:
-            self.CredentialsError(self.wrong_app, self.error)
-
-        self.CredentialsFound(app_name, SAMPLE_CREDS)
-
-    @dbus.service.method(dbus_interface=DBUS_CREDENTIALS_IFACE,
-                         in_signature='sa{ss}', out_signature='')
-    def clear_credentials(self, app_name, args):
-        """Clear the credentials for an application."""
-        self.found = False
-
-        if self.wrong_app is None and self.error is None:
-            self.CredentialsCleared(app_name)
-        elif self.wrong_app is not None and self.error is None:
-            self.CredentialsCleared(self.wrong_app)
-        elif self.wrong_app is None and self.error is not None:
-            self.CredentialsError(app_name, self.error)
-        else:
-            self.CredentialsError(self.wrong_app, self.error)
-
-        self.CredentialsCleared(app_name)
-
-    @dbus.service.signal(DBUS_CREDENTIALS_IFACE, signature='sa{ss}')
-    def CredentialsFound(self, app_name, credentials):
-        """Signal thrown when the credentials are found."""
-
-    @dbus.service.signal(DBUS_CREDENTIALS_IFACE, signature='s')
-    def CredentialsNotFound(self, app_name):
-        """Signal thrown when the credentials are not found."""
-
-    @dbus.service.signal(DBUS_CREDENTIALS_IFACE, signature='s')
-    def CredentialsCleared(self, app_name):
-        """Signal thrown when the credentials were cleared."""
-
-    @dbus.service.signal(DBUS_CREDENTIALS_IFACE, signature='s')
-    def CredentialsStored(self, app_name):
-        """Signal thrown when the credentials were cleared."""
-
-    @dbus.service.signal(DBUS_CREDENTIALS_IFACE, signature='sa{ss}')
-    def CredentialsError(self, app_name, error_dict):
-        """Signal thrown when there is a problem getting the credentials."""
-
-
-class SSOClientTestCase(DBusClientTestCase):
-    """Test for the SSO dbus client."""
-
-    def setUp(self):
-        super(SSOClientTestCase, self).setUp()
-        self.register_mockserver(DBUS_BUS_NAME, DBUS_CREDENTIALS_PATH,
-                                 MockDBusSSOService)
-        MockDBusSSOService.wrong_app = None
-        MockDBusSSOService.error = None
-        MockDBusSSOService.found = True
-
-    # get_credentials
-
-    @inlineCallbacks
-    def test_get_credentials_ok(self):
-        """Test the success case for get_credentials."""
-        creds = yield login_client.get_credentials()
-        self.assertEqual(creds, SAMPLE_CREDS)
-
-    @inlineCallbacks
-    def test_get_credentials_not_found(self):
-        """Credentials were not found."""
-        yield login_client.clear_credentials()  # not found will be sent
-        yield self.assertFailure(login_client.get_credentials(),
-                                 login_client.CredentialsError)
-
-    @inlineCallbacks
-    def test_get_credentials_other(self):
-        """Creds for other apps are ignored."""
-        MockDBusSSOService.wrong_app = 'other app!'
-        creds = yield login_client.get_credentials()
-        self.assertEqual(creds, SAMPLE_CREDS)
-
-    @inlineCallbacks
-    def test_get_credentials_error(self):
-        """Test what happens when the creds can't be retrieved."""
-        MockDBusSSOService.error = SAMPLE_ERROR
-        yield self.assertFailure(login_client.get_credentials(),
-                                 login_client.CredentialsError)
-
-    @inlineCallbacks
-    def test_get_credentials_other_error(self):
-        """Other creds err before ours are retrieved."""
-        MockDBusSSOService.wrong_app = 'other app!'
-        MockDBusSSOService.error = SAMPLE_ERROR
-        creds = yield login_client.get_credentials()
-        self.assertEqual(creds, SAMPLE_CREDS)
-
-    # clear_credentials
-
-    @inlineCallbacks
-    def test_clear_credentials_ok(self):
-        """Test the success case for clear_credentials."""
-        result = yield login_client.clear_credentials()
-        self.assertEqual(result, login_client.APP_NAME)
-
-    @inlineCallbacks
-    def test_clear_credentials_other(self):
-        """Creds for other apps are ignored."""
-        MockDBusSSOService.wrong_app = 'other app!'
-        result = yield login_client.clear_credentials()
-        self.assertEqual(result, login_client.APP_NAME)
-
-    @inlineCallbacks
-    def test_clear_credentials_error(self):
-        """Test what happens when the creds can't be retrieved."""
-        MockDBusSSOService.error = SAMPLE_ERROR
-        yield self.assertFailure(login_client.clear_credentials(),
-                                 login_client.CredentialsError)
-
-    @inlineCallbacks
-    def test_clear_credentials_other_error(self):
-        """Other creds err before ours are retrieved."""
-        MockDBusSSOService.wrong_app = 'other app!'
-        MockDBusSSOService.error = SAMPLE_ERROR
-        result = yield login_client.clear_credentials()
-        self.assertEqual(result, login_client.APP_NAME)
-
-
-class NoMethodsSSOClientTestCase(DBusClientTestCase):
-    """Test for the SSO dbus client when the service provides no methods."""
-
-    def setUp(self):
-        super(NoMethodsSSOClientTestCase, self).setUp()
-        self.register_mockserver(DBUS_BUS_NAME, DBUS_CREDENTIALS_PATH,
-                                 MockDBusNoMethods)
-
-    @inlineCallbacks
-    def test_get_credentials_dbus_error(self):
-        """Test what happens when there's a DBus error."""
-        yield self.assertFailure(login_client.get_credentials(),
-                                 dbus.DBusException)
-
-    @inlineCallbacks
-    def test_clear_credentials_dbus_error(self):
-        """Test what happens when there's a DBus error."""
-        yield self.assertFailure(login_client.clear_credentials(),
-                                 dbus.DBusException)

=== removed directory 'ubuntuone/controlpanel/login_client'
=== added file 'ubuntuone/controlpanel/login_client.py'
--- ubuntuone/controlpanel/login_client.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/login_client.py	2011-06-17 16:05:59 +0000
@@ -0,0 +1,40 @@
+# -*- 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/>.
+
+"""Client to access Ubuntu One credentials."""
+
+
+def get_sso_proxy():
+    """Return a login client."""
+    # No name 'credentials' in module 'ubuntuone.platform'
+    # Reimport 'credentials' (imported line 22)
+    # pylint: disable=E0611,W0404
+    from ubuntuone.platform import credentials
+    return credentials.CredentialsManagementTool()
+
+
+def get_credentials():
+    """Get the credentials for Ubuntu One."""
+    proxy = get_sso_proxy()
+    return proxy.find_credentials()
+
+
+def clear_credentials():
+    """Clear the credentials for Ubuntu One."""
+    proxy = get_sso_proxy()
+    return proxy.clear_credentials()

=== removed file 'ubuntuone/controlpanel/login_client/__init__.py'
--- ubuntuone/controlpanel/login_client/__init__.py	2011-05-18 19:12:57 +0000
+++ ubuntuone/controlpanel/login_client/__init__.py	1970-01-01 00:00:00 +0000
@@ -1,27 +0,0 @@
-# -*- 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 login client."""
-
-import sys
-
-# pylint: disable=W0401, W0614
-
-
-if sys.platform == "linux2":
-    from ubuntuone.controlpanel.login_client.linux import *

=== removed file 'ubuntuone/controlpanel/login_client/linux.py'
--- ubuntuone/controlpanel/login_client/linux.py	2011-05-18 19:12:57 +0000
+++ ubuntuone/controlpanel/login_client/linux.py	1970-01-01 00:00:00 +0000
@@ -1,127 +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
-import ubuntu_sso
-
-from twisted.internet import defer
-
-from ubuntuone.clientdefs import APP_NAME
-from ubuntuone.controlpanel.logger import setup_logging
-
-
-logger = setup_logging('login_client')
-
-
-class CredentialsError(Exception):
-    """No credentials could be retrieved."""
-
-
-def no_op(*a):
-    """Do nothing"""
-
-
-def get_sso_proxy():
-    """Get a DBus proxy for credentials management."""
-    bus = dbus.SessionBus()
-    obj = bus.get_object(bus_name=ubuntu_sso.DBUS_BUS_NAME,
-                         object_path=ubuntu_sso.DBUS_CREDENTIALS_PATH,
-                         follow_name_owner_changes=True)
-    proxy = dbus.Interface(object=obj,
-                           dbus_interface=ubuntu_sso.DBUS_CREDENTIALS_IFACE)
-    return proxy
-
-
-def get_credentials():
-    """Get the credentials from the ubuntu-sso-client."""
-    d = defer.Deferred()
-    proxy = get_sso_proxy()
-
-    def found_credentials(app_name, creds):
-        """Credentials have been found."""
-        if app_name == APP_NAME:
-            logger.info('credentials were found! (%r).', APP_NAME)
-            d.callback(creds)
-
-    def credentials_error(app_name, error_dict=None):
-        """No credentials could be retrieved."""
-        if app_name == APP_NAME:
-            if error_dict is None:
-                error_dict = {'error_message': 'Credentials were not found.',
-                              'detailed_error': ''}
-
-            logger.error('credentials error (%r, %r).', app_name, error_dict)
-            error = CredentialsError(app_name, error_dict)
-            d.errback(error)
-
-    foundsig = proxy.connect_to_signal("CredentialsFound", found_credentials)
-    notfoundsig = proxy.connect_to_signal("CredentialsNotFound",
-                                          credentials_error)
-    errorsig = proxy.connect_to_signal("CredentialsError", credentials_error)
-    logger.debug('calling get_credentials.')
-    proxy.find_credentials(APP_NAME, {'': ''},
-                           reply_handler=no_op, error_handler=d.errback)
-
-    def cleanup_signals(result):
-        """Remove signals after use."""
-        foundsig.remove()
-        notfoundsig.remove()
-        errorsig.remove()
-        return result
-
-    d.addBoth(cleanup_signals)
-    return d
-
-
-def clear_credentials():
-    """Clear the credentials using the ubuntu-sso-client."""
-    d = defer.Deferred()
-    proxy = get_sso_proxy()
-
-    def credentials_cleared(app_name):
-        """Credentials have been cleared."""
-        logger.debug('credentials were cleared for app_name %r.', app_name)
-        if app_name == APP_NAME:
-            logger.info('credentials were cleared! (%r).', APP_NAME)
-            d.callback(app_name)
-
-    def credentials_error(app_name, error_dict=None):
-        """No credentials could be retrieved."""
-        if app_name == APP_NAME:
-            logger.error('credentials error (%r, %r).', app_name, error_dict)
-            error = CredentialsError(app_name, error_dict)
-            d.errback(error)
-
-    clearedsig = proxy.connect_to_signal("CredentialsCleared",
-                                         credentials_cleared)
-    errorsig = proxy.connect_to_signal("CredentialsError", credentials_error)
-    logger.warning('calling clear_credentials.')
-    proxy.clear_credentials(APP_NAME, {'': ''},
-                            reply_handler=no_op, error_handler=d.errback)
-
-    def cleanup_signals(result):
-        """Remove signals after use."""
-        clearedsig.remove()
-        errorsig.remove()
-        return result
-
-    d.addBoth(cleanup_signals)
-    return d

=== added file 'ubuntuone/controlpanel/tests/test_login_client.py'
--- ubuntuone/controlpanel/tests/test_login_client.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/tests/test_login_client.py	2011-06-17 16:05:59 +0000
@@ -0,0 +1,100 @@
+# -*- 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 service when accessing the login client."""
+
+from twisted.internet import defer
+# No name 'credentials' in module 'ubuntuone.platform'
+# pylint: disable=E0611
+from ubuntuone.platform import credentials
+# pylint: enable=E0611
+
+from ubuntuone.controlpanel import login_client
+from ubuntuone.controlpanel.tests import TestCase, TOKEN
+
+
+class CustomError(Exception):
+    """Custom error for tests."""
+
+
+class FakedCredentialsManagementTool(object):
+    """Fake the CredentialsManagementTool."""
+
+    credentials = None
+
+    @defer.inlineCallbacks
+    def find_credentials(self):
+        """Find credentials for Ubuntu One."""
+        yield
+        defer.returnValue(FakedCredentialsManagementTool.credentials)
+
+    @defer.inlineCallbacks
+    def clear_credentials(self):
+        """Clear credentials for Ubuntu One."""
+        FakedCredentialsManagementTool.credentials = None
+        yield
+
+
+class BaseTestCase(TestCase):
+    """Base TestCase for the login client methods."""
+
+    def setUp(self):
+        super(BaseTestCase, self).setUp()
+        self.patch(credentials, 'CredentialsManagementTool',
+                   FakedCredentialsManagementTool)
+        FakedCredentialsManagementTool.credentials = TOKEN
+
+    def fake_fail(self, *a):
+        """Fake a failure."""
+        return defer.fail(CustomError(a))
+
+
+class FindCredentialsTestCase(BaseTestCase):
+    """Test for the find_credentials method."""
+
+    @defer.inlineCallbacks
+    def test_find_credentials(self):
+        """The credentials are properly retrieved."""
+        actual = yield login_client.get_credentials()
+        self.assertEqual(actual, TOKEN)
+
+    @defer.inlineCallbacks
+    def test_find_credentials_throws_an_error(self):
+        """If find_credentials fails, the error is propagated."""
+        self.patch(FakedCredentialsManagementTool, 'find_credentials',
+                   self.fake_fail)
+        yield self.assertFailure(login_client.get_credentials(),
+                                 CustomError)
+
+
+class ClearCredentialsTestCase(BaseTestCase):
+    """Test for the clear_credentials method."""
+
+    @defer.inlineCallbacks
+    def test_clear_credentials(self):
+        """The credentials are properly retrieved."""
+        yield login_client.clear_credentials()
+        self.assertEqual(None, FakedCredentialsManagementTool.credentials)
+
+    @defer.inlineCallbacks
+    def test_clear_credentials_throws_an_error(self):
+        """If clear_credentials fails, the error is propagated."""
+        self.patch(FakedCredentialsManagementTool, 'clear_credentials',
+                   self.fake_fail)
+        yield self.assertFailure(login_client.clear_credentials(),
+                                 CustomError)