Merge lp:~ricardokirkner/u1-test-utils/ssoclient into lp:u1-test-utils

[Ricardo Kirkner]

get a users' openid value when creating an account

Added ssoclient as a new dependency so that the SSO api can be consumed
easily. The current driver for this change is being able to get the openid for
an account.

get a users' openid value when creating an account

Added ssoclient as a new dependency so that the SSO api can be consumed
easily. The current driver for this change is being able to get the openid for
an account.

[lp:~ricardokirkner/u1-test-utils/ssoclient]

31. By Ricardo Kirkner on 2013-02-14

switched to absolute import

32. By Ricardo Kirkner on 2013-02-14

make openid attribute in User constructor optional

33. By Ricardo Kirkner on 2013-02-14

use proper error response for an invalid login attempt

[Leo Arias (elopio)]

<elopio> pindonga: on line 56 +from . import client
<elopio> isn't it better to use the full path?
<pindonga> elopio: ok, can change that
<elopio> pindonga: but that's really a question.
<elopio> I got from vila and nessita that it's better, so I try to do it everywhere. I'm not sure why.
<pindonga> it's really the same, I belive
<pindonga> believe
<pindonga> elopio: ack
<pindonga> it is slighlty better, as it's more explicit
<pindonga> but only marginally
<pindonga> imo
<elopio> pindonga: ok. For consitency, I think it would be better to change it.
<elopio> pindonga: andl ine 62 + def __init__(self, full_name, email, password, openid):
<vila> I'm +0 on relative imports, nessita had an argument against them I can't recall right now
<pindonga> elopio: what about that line?
<elopio> to make it compatible with the other projects, openid=None is required.
<pindonga> elopio: ok, fine with me... just made it so, bc I didn't see any other usage of the User molde
<pindonga> model
<pindonga> pushed both changes
<elopio> pindonga: thanks.
<elopio> pindonga: the one I had in mind is here: https://bazaar.launchpad.net/~ubuntuone-pqm-team/ubuntuone-servers/trunk-2a/view/head:/servers/u1servers/web/testing/acceptance/__init__.py
<elopio> pindonga: also I have a question about the client.get_account_openid. What does it return when the user doesn't exist?
<pindonga> elopio: it should return None
<pindonga> bc the response json doc doesn't have a consumer_key value in ther
<pindonga> there is a test for that
<pindonga> I set the response to {'error': {}}
<pindonga> which is to mimick an error response from the login call
<elopio> a right, you have a test for that.
<pindonga> elopio: although I will change that to be the proper response
<elopio> pindonga: +1.
<pindonga> it's not error, but something else
<pindonga> that doesn't include consumer_key :)
<elopio> pindonga: sounds good.
<elopio> pindonga: I'll approve it.
<pindonga> elopio: pushed last revno
<elopio> pindonga: I like it. Thanks.

review: Approve

=== modified file 'requirements.txt'
--- requirements.txt	2013-02-04 15:36:26 +0000
+++ requirements.txt	2013-02-14 15:05:22 +0000
@@ -6,3 +6,4 @@
 sst
 Twisted
 bzr+ssh://bazaar.launchpad.net/~bloodearnest/localmail/trunk
+bzr+http://bazaar.launchpad.net/~canonical-isd-hackers/canonical-identity-provider/ssoclient@1

=== added file 'u1testutils/sst/sso/client.py'
--- u1testutils/sst/sso/client.py	1970-01-01 00:00:00 +0000
+++ u1testutils/sst/sso/client.py	2013-02-14 15:05:22 +0000
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2012, 2013 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser 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 Lesser 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/>.
+
+from sst import actions
+
+from ssoclient.v2 import V2ApiClient
+
+
+def get_api_client():
+    base_url = actions.get_base_url().rstrip('/')
+    client = V2ApiClient(base_url + '/api/v2')
+    return client
+
+
+def get_account_openid(email, password, token_name):
+    client = get_api_client()
+    response = client.login(email=email, password=password,
+                            token_name=token_name)
+    data = response.json()
+    openid = data.get('consumer_key')
+    return openid

=== modified file 'u1testutils/sst/sso/data.py'
--- u1testutils/sst/sso/data.py	2013-01-16 15:16:50 +0000
+++ u1testutils/sst/sso/data.py	2013-02-14 15:05:22 +0000
@@ -18,13 +18,16 @@
 
 from django.conf import settings
 
+from u1testutils.sst.sso import client
+
 
 class User(object):
 
-    def __init__(self, full_name, email, password):
+    def __init__(self, full_name, email, password, openid=None):
         self.full_name = full_name
         self.email = email
         self.password = password
+        self.openid = openid
 
     def __repr__(self):
         return '%s(%r)' % (self.__class__, self.__dict__)
@@ -49,8 +52,11 @@
             random_user_uuid = str(uuid.uuid1())
             full_name = 'Test user ' + random_user_uuid
             email = settings.EMAIL_ADDRESS_PATTERN % random_user_uuid
+            token_name = 'token-%s' % random_user_uuid
         else:
             full_name = settings.SSO_TEST_ACCOUNT_FULL_NAME
             email = settings.SSO_TEST_ACCOUNT_EMAIL
+            token_name = 'token-%s' % full_name
         password = settings.SSO_TEST_ACCOUNT_PASSWORD
-        return cls(full_name, email, password)
+        openid = client.get_account_openid(email, password, token_name)
+        return cls(full_name, email, password, openid)

=== added file 'u1testutils/sst/sso/selftests/unit/test_client.py'
--- u1testutils/sst/sso/selftests/unit/test_client.py	1970-01-01 00:00:00 +0000
+++ u1testutils/sst/sso/selftests/unit/test_client.py	2013-02-14 15:05:22 +0000
@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2012, 2013 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser 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 Lesser 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/
+
+import unittest
+
+from mock import Mock, patch
+
+from u1testutils.sst.sso import client
+from ssoclient.v2 import V2ApiClient
+
+
+class ClientTestCase(unittest.TestCase):
+
+    base_namespace = 'u1testutils.sst.sso.client'
+
+    def test_get_api_client(self):
+        mock_get_base_url = Mock(return_value='http://localhost:8000')
+        with patch(self.base_namespace + '.actions.get_base_url',
+                   mock_get_base_url):
+            api_client = client.get_api_client()
+
+        self.assertTrue(isinstance(api_client, V2ApiClient))
+        self.assertEqual(api_client.session.endpoint,
+                         'http://localhost:8000/api/v2/')
+
+    def test_get_account_openid(self):
+        mock_login = Mock()
+        mock_login.return_value.json.return_value = {
+            'consumer_key': 'oid1234',
+            'consumer_secret': 'consumer-secret',
+            'token_name': 'foo',
+            'token_key': 'token-key',
+            'token_secret': 'token-secret',
+        }
+
+        with patch(self.base_namespace + '.V2ApiClient.login', mock_login):
+            openid = client.get_account_openid('email', 'password',
+                                               'token_name')
+
+        self.assertEqual(openid, 'oid1234')
+
+    def test_get_account_openid_wrong_credentials(self):
+        mock_login = Mock()
+        mock_login.return_value.json.return_value = {
+            "code": "INVALID_CREDENTIALS",
+            "message": "Your email/password isn't correct.",
+            "extra": {}
+        }
+
+        with patch(self.base_namespace + '.V2ApiClient.login', mock_login):
+            openid = client.get_account_openid('email', 'password',
+                                               'token_name')
+
+        self.assertIsNone(openid)

=== modified file 'u1testutils/sst/sso/selftests/unit/test_data.py'
--- u1testutils/sst/sso/selftests/unit/test_data.py	2013-01-21 03:26:21 +0000
+++ u1testutils/sst/sso/selftests/unit/test_data.py	2013-02-14 15:05:22 +0000
@@ -17,6 +17,7 @@
 import unittest
 
 from django.conf import settings
+from mock import patch
 
 from u1testutils.sst.sso import data
 
@@ -24,8 +25,12 @@
 class DataTestCase(unittest.TestCase):
 
     def test_make_exising_user(self):
-        # The DJANGO_SETTINGS_MODULE is set by the test fab task.
-        user = data.User.make_from_configuration()
+        with patch('u1testutils.sst.sso.data.client') as mock_client:
+            # The DJANGO_SETTINGS_MODULE is set by the test fab task.
+            user = data.User.make_from_configuration()
+
         self.assertEqual(user.full_name, settings.SSO_TEST_ACCOUNT_FULL_NAME)
         self.assertEqual(user.email, settings.SSO_TEST_ACCOUNT_EMAIL)
         self.assertEqual(user.password, settings.SSO_TEST_ACCOUNT_PASSWORD)
+        self.assertEqual(user.openid,
+                         mock_client.get_account_openid.return_value)