Merge lp:~ralsina/ubuntu-sso-client/login-user-password into lp:ubuntu-sso-client

[Roberto Alsina]

Add a login_user_password method to the Credential and CredentialManagement classes so it's possible to
login using that.

Add a login_user_password method to the Credential and CredentialManagement classes so it's possible to
login using that.

[Natalia Bidart (nataliabidart)]

Looks good!

review: Approve

[Alejandro J. Cura (alecu)]

Tested IRL ok and code looks great!

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~ralsina/ubuntu-sso-client/login-user-password into lp:ubuntu-sso-client failed. Below is the output from the failed tests.

Running test suite for ubuntu_sso
Xlib: extension "RANDR" missing on display ":99".
ubuntu_sso.utils.tests.test_ui
  GetPasswordStrengTestCase
    test_eight_chars_and_num ... [OK]
    test_eight_chars_low_and_cap ... [OK]
    test_eight_chars_low_canp_num ... [OK]
    test_eight_chars_password ... [OK]
    test_eiqgh_chars_and_special ... [OK]
    test_eleven_chars_and_num ... [OK]
    test_eleven_chars_low_cap ... [OK]
    test_eleven_num_low_cap ... [OK]
    test_eleven_num_special ... [OK]
    test_long_password ... [OK]
    test_small_password ... [OK]
    test_too_small_password ... [OK]
  IsCorrectEmailAddress
    test_is_correct_email_false ... [OK]
    test_is_correct_email_true ... [OK]
  IsMinRequiredPasswordTestCase
    test_correct_password ... [OK]
    test_no_enough_chars ... [OK]
    test_no_number ... [OK]
    test_no_uppercase ... [OK]
ubuntu_sso.utils.tests.test_txsecrets
  AltItemTestCase
    test_create_item_four_fields_per_secret ... [OK]
    test_get_value_four_fields_per_secret ... [OK]
  BaseTestCase
    runTest ... [OK]
  CollectionTestCase
    test_create_item ... ERROR:dbus.connection:Unable to set arguments ({'org.freedesktop.Secret.Collection.Label': dbus.String(u'sample_keyring', variant_level=1)}, '') according to signature u'a{sv}': <type 'exceptions.TypeError'>: Fewer items found in D-Bus signature than in Python arguments
                                                  [OK]
    test_create_item_prompt ... ERROR:dbus.connection:Unable to set arguments ({'org.freedesktop.Secret.Collection.Label': dbus.String(u'sample_keyring', variant_level=1)}, '') according to signature u'a{sv}': <type 'exceptions.TypeError'>: Fewer items found in D-Bus signature than in Python arguments
                                           [OK]
    test_create_item_prompt_dismissed ... ERROR:dbus.connection:Unable to set arguments ({'org.freedesktop.Secret.Collection.Label': dbus.String(u'sample_keyring', variant_level=1)}, '') according to signature u'a{sv}': <type 'exceptions.TypeError'>: Fewer items found in D-Bus signature than in Python arguments
                                 [OK]
    test_create_item_throw...

[lp:~ralsina/ubuntu-sso-client/login-user-password]

783. By Roberto Alsina on 2011-07-29

Oops

784. By Roberto Alsina on 2011-07-29

Oops

785. By Roberto Alsina on 2011-07-29

remove test that can't work on linux

786. By Roberto Alsina on 2011-07-29

style fix:

=== modified file 'ubuntu_sso/credentials.py'
--- ubuntu_sso/credentials.py	2011-01-02 03:34:23 +0000
+++ ubuntu_sso/credentials.py	2011-07-29 14:29:55 +0000
@@ -50,7 +50,6 @@
 from ubuntu_sso.keyring import Keyring
 from ubuntu_sso.logger import setup_logging
 
-
 logger = setup_logging('ubuntu_sso.credentials')
 
 
@@ -184,6 +183,7 @@
         self._error_cb = error_cb
         self.denial_cb = denial_cb
         self.gui = None  # will hold the GUI instance
+        self.login_root = None  # Will hold SSOLoginRoot instance
 
     @handle_failures(msg='Problem while retrieving credentials')
     @inlineCallbacks
@@ -263,15 +263,39 @@
         self.gui.registration_success_callback = self._login_success_cb
         self.gui.user_cancellation_callback = self._auth_denial_cb
 
+    @handle_exceptions(msg='Problem logging with email and password.')
+    def _do_login(self, email, password):
+        """Login using email/password, connect outcome signals."""
+        from ubuntu_sso.main import SSOLoginRoot
+
+        def error(app_name, error):
+            """Call error_cb with the right number of arguments."""
+            self.error_cb(error)
+
+        self.login_root = SSOLoginRoot()
+        self.login_root.login(
+            self.app_name,
+            email,
+            password,
+            self._login_success_cb,
+            error,
+            error,
+            )
+
     @handle_failures(msg='Problem while retrieving credentials')
     @inlineCallbacks
-    def _login_or_register(self, login_only):
+    def _login_or_register(self, login_only, email=None, password=None):
         """Get credentials if found else prompt the GUI."""
+        logger.info("_login_or_register: login_only=%r email=%r.",
+            login_only, email)
         token = yield self.find_credentials()
         if token is not None and len(token) > 0:
             self.success_cb(token)
         elif token == {}:
-            self._show_ui(login_only)
+            if email and password:
+                self._do_login(email, password)
+            else:
+                self._show_ui(login_only)
         else:
             # something went wrong with find_credentials, already handled.
             logger.info('_login_or_register: call to "find_credentials" went '
@@ -313,3 +337,8 @@
     def login(self):
         """Get credentials if found else prompt the GUI to login."""
         return self._login_or_register(login_only=True)
+
+    def login_email_password(self, email, password):
+        """Login using email and password."""
+        return self._login_or_register(login_only=True,
+            email=email, password=password)

=== modified file 'ubuntu_sso/main/__init__.py'
--- ubuntu_sso/main/__init__.py	2011-07-26 13:11:33 +0000
+++ ubuntu_sso/main/__init__.py	2011-07-29 14:29:55 +0000
@@ -399,6 +399,15 @@
         obj = Credentials(app_name, **self._parse_args(args))
         obj.login()
 
+    def login_email_password(self, app_name, args):
+        """Get credentials if found else prompt GUI to login."""
+        self.ref_count += 1
+        email = args.get('email')
+        password = args.get('password')
+        obj = Credentials(app_name, **self._parse_args(args))
+        obj.login_email_password(email, password)
+
+
 # pylint: disable=C0103
 SSOLogin = None
 SSOCredentials = None

=== modified file 'ubuntu_sso/main/linux.py'
--- ubuntu_sso/main/linux.py	2011-07-26 13:45:36 +0000
+++ ubuntu_sso/main/linux.py	2011-07-29 14:29:55 +0000
@@ -462,3 +462,9 @@
     def login(self, app_name, args):
         """Get credentials if found else prompt GUI to login."""
         self.root.login(app_name, args)
+
+    @dbus.service.method(dbus_interface=DBUS_CREDENTIALS_IFACE,
+                         in_signature='sa{ss}', out_signature='')
+    def login_email_password(self, app_name, args):
+        """Get credentials if found, else login."""
+        raise NotImplementedError

=== modified file 'ubuntu_sso/main/tests/test_common.py'
--- ubuntu_sso/main/tests/test_common.py	2011-07-26 13:45:36 +0000
+++ ubuntu_sso/main/tests/test_common.py	2011-07-29 14:29:55 +0000
@@ -189,7 +189,7 @@
         self.cred.clear_token(app_name, result_cb, error_cb)
 
 
-class CredentialsManagementMockedTestCase(MockerTestCase):
+class CredentialsManagementMockedTestCase(MockerTestCase, TestCase):
     """Test that the call are relied correctly."""
 
     def setUp(self):

=== modified file 'ubuntu_sso/main/tests/test_windows.py'
--- ubuntu_sso/main/tests/test_windows.py	2011-07-27 19:47:59 +0000
+++ ubuntu_sso/main/tests/test_windows.py	2011-07-29 14:29:55 +0000
@@ -1331,7 +1331,6 @@
         self.assertEqual(connect_result, ussoc)
         self.assertTrue(mac.port_requested, "The port must be requested.")
         self.assertNotEqual(ussoc.sso_login, None)
-        self.assertNotEqual(ussoc.sso_cred, None)
         self.assertNotEqual(ussoc.cred_management, None)
 
     def test_get_activation_cmdline(self):

=== modified file 'ubuntu_sso/main/windows.py'
--- ubuntu_sso/main/windows.py	2011-07-27 19:47:59 +0000
+++ ubuntu_sso/main/windows.py	2011-07-29 14:29:55 +0000
@@ -17,6 +17,8 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Main implementation on windows."""
 
+import warnings
+
 # pylint: disable=F0401
 from _winreg import HKEY_LOCAL_MACHINE, OpenKey, QueryValueEx
 
@@ -74,9 +76,25 @@
 
 
 def remote_handler(handler):
-    """Execute a callback in a remote object."""
+    """Execute a callback in a remote object.
+
+    If the callback takes arguments, it's assumed that the last
+    one is a twisted Failure, and it has no keyword arguments.
+    """
     if handler:
-        return lambda: handler.callRemote('execute')
+
+        def f(*args):
+            """Process arguments and call remote."""
+            try:
+                args = list(args)
+                if args:
+                    args[-1] = except_to_errdict(args[-1].value)
+                return handler.callRemote('execute', *args)
+            # Yes, I want to catch everything
+            # pylint: disable=W0703
+            except Exception:
+                logger.exception("Remote handler argument processing error:")
+        return f
     return lambda: None
 
 
@@ -102,7 +120,8 @@
     # the calls in twisted will be called with the args in a diff order,
     # in order to follow the linux api, we swap them around with a lambda
     d.addCallback(lambda result, app: result_cb(app, result), app_name)
-    d.addErrback(lambda err, app: error_cb(app, err), app_name)
+    d.addErrback(lambda err, app: error_cb(app,
+        except_to_errdict(err.value)), app_name)
 
 
 class RemoteMeta(type):
@@ -440,6 +459,7 @@
         'register',
         'shutdown',
         'login',
+        'login_email_password',
     ]
 
     def __init__(self, timeout_func, shutdown_func, *args, **kwargs):
@@ -557,6 +577,10 @@
         """Get credentials if found else prompt GUI to login."""
         self.root.login(app_name, args)
 
+    def login_email_password(self, app_name, args):
+        """Get credentials if found, else login."""
+        self.root.login_email_password(app_name, args)
+
 
 class UbuntuSSORoot(object, Root):
     """Root object that exposes the diff referenceable objects."""
@@ -638,10 +662,10 @@
         """Create a new instance."""
         self.cb = cb
 
-    def remote_execute(self):
+    def remote_execute(self, *args, **kwargs):
         """Execute the callback."""
         if self.cb:
-            self.cb()
+            self.cb(*args, **kwargs)
 
 
 def callbacks(callbacks_indexes=None, callbacks_names=None):
@@ -775,7 +799,10 @@
 
 
 class SSOCredentialsClient(RemoteClient, Referenceable):
-    """Client that can perform calls to the remote SSOCredentials object."""
+    """Deprecated client for the remote SSOCredentials object.
+
+    This class is deprecated!
+    """
 
     __metaclass__ = RemoteMeta
 
@@ -788,6 +815,8 @@
 
     def __init__(self, remote_login):
         """Create a client for the cred API."""
+        warnings.warn("SSOCredentialsClient is deprecated.",
+            DeprecationWarning)
         super(SSOCredentialsClient, self).__init__(remote_login)
 
     @signal
@@ -933,6 +962,10 @@
     def login(self, app_name, args):
         """Get credentials if found else prompt GUI to login."""
 
+    @remote
+    def login_email_password(self, app_name, args):
+        """Get credentials if found else login."""
+
 
 class UbuntuSSOClientException(Exception):
     """Raised when there are issues connecting to the process."""
@@ -943,7 +976,6 @@
 
     def __init__(self):
         self.sso_login = None
-        self.sso_cred = None
         self.cred_management = None
         self.factory = None
         self.client = None
@@ -954,8 +986,6 @@
         sso_login = yield root.callRemote('get_sso_login')
         logger.debug('SSOLogin is %s', sso_login)
         self.sso_login = SSOLoginClient(sso_login)
-        sso_cred = yield root.callRemote('get_sso_credentials')
-        self.sso_cred = SSOCredentialsClient(sso_cred)
         cred_management = yield root.callRemote('get_cred_manager')
         self.cred_management = CredentialsManagementClient(cred_management)
         defer.returnValue(self)

=== added file 'ubuntu_sso/qt/tests/login_u_p.py'
--- ubuntu_sso/qt/tests/login_u_p.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/qt/tests/login_u_p.py	2011-07-29 14:29:55 +0000
@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Author: Manuel de la Pena <[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/>.
+"""Script that shows the qt gui."""
+
+# pylint: disable=F0401, E1101
+from twisted.internet import reactor
+from twisted.internet.defer import inlineCallbacks
+from ubuntu_sso.main.windows import UbuntuSSOClient
+
+
+def found(*args):
+    """The credentials were found."""
+    print "creds found", args
+    reactor.stop()
+
+
+def errback(*args):
+    """Unsuccessful login."""
+    print "EB:", args
+
+
+@inlineCallbacks
+def main():
+    """Perform a client request to be logged in."""
+    client = UbuntuSSOClient()
+    client = yield client.connect()
+    yield client.cred_management.register_to_signals()
+    client.cred_management.on_credentials_found_cb = found
+    client.cred_management.on_credentials_error_cb = errback
+    yield client.cred_management.login_email_password('SUPER', dict(
+          app_name='SUPER',
+          email='[e-mail]',
+          password='ABC',
+    ))
+    print "called ok"
+
+
+if __name__ == '__main__':
+    main()
+    reactor.run()

=== modified file 'ubuntu_sso/tests/test_credentials.py'
--- ubuntu_sso/tests/test_credentials.py	2011-03-09 17:04:41 +0000
+++ ubuntu_sso/tests/test_credentials.py	2011-07-29 14:29:55 +0000
@@ -26,8 +26,10 @@
 from twisted.internet.defer import inlineCallbacks
 from twisted.trial.unittest import TestCase, FailTest
 from ubuntuone.devtools.handlers import MementoHandler
+from ubuntuone.devtools.testcase import skipIfOS
 
 from ubuntu_sso import credentials
+import ubuntu_sso.main
 from ubuntu_sso.credentials import (APP_NAME_KEY, HELP_TEXT_KEY, NO_OP,
     PING_URL_KEY, TC_URL_KEY, UI_CLASS_KEY, UI_MODULE_KEY, WINDOW_ID_KEY,
     ERROR_KEY, ERROR_DETAIL_KEY)
@@ -82,6 +84,18 @@
         self.user_cancellation_callback = None
 
 
+class FakedSSOLoginRoot(object):
+    """Fake a SSOLoginRoot."""
+
+    args = []
+    kwargs = {}
+
+    def login(self, *args, **kwargs):
+        """Fake login."""
+        self.args = args
+        self.kwargs = kwargs
+
+
 class BasicTestCase(TestCase):
     """Test case with a helper tracker."""
 
@@ -579,3 +593,46 @@
 
     operation = 'login'
     login_only = True
+
+
+class LoginUserPasswordTestCase(CredentialsTestCase):
+    """Test suite for the login method."""
+
+    operation = 'login_email_password'
+    email = 'email'
+    password = 'password'
+
+    def setUp(self):
+        super(LoginUserPasswordTestCase, self).setUp()
+        self.acc_kwargs = {
+            APP_NAME_KEY: APP_NAME,
+            'email': self.email,
+            'password': self.password,
+            }
+        self.patch(ubuntu_sso.main, 'SSOLoginRoot', FakedSSOLoginRoot)
+
+    @skipIfOS('linux2', 'Not implemented on Linux yet.')
+    @inlineCallbacks
+    def test_with_existent_token(self):
+        """The operation returns the credentials if already in keyring."""
+        self.patch(credentials.Keyring, 'get_credentials',
+                   lambda kr, app: defer.succeed(TOKEN))
+
+        yield getattr(self.obj, self.operation)(self.email, self.password)
+        self.assertEqual(self._called, (('success', APP_NAME, TOKEN), {}))
+
+    @skipIfOS('linux2', 'Not implemented on Linux yet.')
+    @inlineCallbacks
+    def test_without_existent_token(self):
+        """The operation returns the credentials obtained."""
+        self.patch(credentials.Keyring, 'get_credentials',
+                   lambda kr, app: defer.succeed(None))
+
+        yield getattr(self.obj, self.operation)(self.email, self.password)
+        self.assertIsInstance(self.obj.login_root, FakedSSOLoginRoot)
+        #pylint: disable=E1101
+        self.assertEqual(self.obj.login_root.args[:3], (
+            APP_NAME,
+            self.email,
+            self.password,
+        ))