Merge lp:~elopio/u1-test-utils/refactor_api into lp:u1-test-utils

[Leo Arias]

Renamed the api helpers and refactored the SSO one to receive a server url.

When running SSO tests against staging or production, the django open_id server variable is set to local.
This refactor makes the SSO API helper look more like the pay one, and allows to pass an arbitrary server on its constructors.

Here I also renamed the helpers from client to api, as suggested by Ricardo.

[Leo Arias (elopio)]

----------------------------------------------------------------------
Ran 61 tests in 150.203s

OK
Totals: ran(61), skipped(0), errors(0), failures(0)

[Ricardo Kirkner (ricardokirkner)]

LGTM

review: Approve

=== modified file 'u1testutils/pay/__init__.py'
--- u1testutils/pay/__init__.py	2013-03-27 18:36:28 +0000
+++ u1testutils/pay/__init__.py	2013-05-10 01:35:30 +0000
@@ -20,4 +20,4 @@
 
 import data
 import environment
-from client import APIClient
+from api import APIClient

=== renamed file 'u1testutils/pay/client.py' => 'u1testutils/pay/api.py'
--- u1testutils/pay/client.py	2013-05-09 18:26:20 +0000
+++ u1testutils/pay/api.py	2013-05-10 01:35:30 +0000
@@ -22,9 +22,8 @@
 class APIClient(object):
     """API client helper for payment tests.
 
-    It extends the PaymentServiceAPI to take the credentials from the Django
-    configuration file and to make it easier for the tests to call the API
-    methods.
+    It takes the credentials from the Django configuration file to make it
+    easier for the tests to call the API methods.
 
     """
 

=== modified file 'u1testutils/pay/selftests/unit/test_pay_api_client.py'
--- u1testutils/pay/selftests/unit/test_pay_api_client.py	2013-05-09 18:26:20 +0000
+++ u1testutils/pay/selftests/unit/test_pay_api_client.py	2013-05-10 01:35:30 +0000
@@ -18,7 +18,7 @@
 import payclient
 
 import u1testutils.django
-from u1testutils.pay import client
+from u1testutils.pay import api
 from u1testutils.pay import data as pay_data
 from u1testutils.sso import data as sso_data
 
@@ -26,33 +26,33 @@
 class APIClientTestCase(unittest.TestCase):
 
     def test_get_api_client(self):
-        api_client = client.APIClient()
+        api_client = api.APIClient()
         self.assertTrue(
             isinstance(api_client.client, payclient.PaymentServiceAPI))
 
     def test_get_api_client_with_default_url(self):
-        api_client = client.APIClient()
+        api_client = api.APIClient()
         self.assertEquals(
             api_client.client._service_root, 'http://localhost:8000/api/2.0/')
 
     def test_get_api_client_with_settings_url(self):
         with u1testutils.django.patch_settings(
                 PAY_SERVER_URL='http://settings.pay.local:8000'):
-            api_client = client.APIClient()
+            api_client = api.APIClient()
         self.assertEquals(
             api_client.client._service_root,
             'http://settings.pay.local:8000/api/2.0/')
 
     def test_get_api_client_with_argument_url(self):
         pay_server_url = 'http://argument.pay.local:8000'
-        api_client = client.APIClient(pay_server_url)
+        api_client = api.APIClient(pay_server_url)
         self.assertEquals(
             api_client.client._service_root,
             'http://argument.pay.local:8000/api/2.0/')
 
     def test_get_api_client_with_argument_url_and_trailing_slash(self):
         pay_server_url = 'http://argument.pay.local:8000/'
-        api_client = client.APIClient(pay_server_url)
+        api_client = api.APIClient(pay_server_url)
         self.assertEquals(
             api_client.client._service_root,
             'http://argument.pay.local:8000/api/2.0/')
@@ -69,7 +69,7 @@
     def test_new_credit_card_added(self):
         shop_id = 'TEST'
         make_unattended_default = True
-        api_client = client.APIClient()
+        api_client = api.APIClient()
         with mock.patch('payclient.PaymentServiceAPI.new_credit_card') \
                 as mock_api_call:
             api_client.add_new_credit_card(

=== renamed file 'u1testutils/sso/client.py' => 'u1testutils/sso/api.py'
--- u1testutils/sso/client.py	2013-04-22 20:01:40 +0000
+++ u1testutils/sso/api.py	2013-05-10 01:35:30 +0000
@@ -17,31 +17,36 @@
 from u1testutils.sso import environment
 
 
-def get_api_client():
-    base_url = environment.get_sso_base_url()
-    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
-
-
-def create_new_account(user, captcha_id=None, captcha_solution=None):
-    client = get_api_client()
-    data = dict(
-        email=user.email,
-        password=user.password,
-        displayname=user.full_name
-    )
-    if captcha_id is not None:
-        data['captcha_id'] = captcha_id
-    if captcha_solution is not None:
-        data['captcha_solution'] = captcha_solution
-    response = client.register(data)
-    return response.status_code == 201
+class APIClient(object):
+    """API client helper for identity tests."""
+
+    def __init__(self, sso_server_url=None):
+        sso_server_url = self._get_sso_server_url(sso_server_url)
+        self.client = V2ApiClient(sso_server_url + '/api/v2')
+
+    def _get_sso_server_url(self, sso_server_url=None):
+        if sso_server_url is None:
+            sso_server_url = environment.get_sso_base_url()
+        else:
+            sso_server_url = sso_server_url.rstrip('/')
+        return sso_server_url
+
+    def get_account_openid(self, email, password, token_name):
+        response = self.client.login(
+            email=email, password=password, token_name=token_name)
+        data = response.json()
+        openid = data.get('consumer_key')
+        return openid
+
+    def create_new_account(self, user, captcha_id=None, captcha_solution=None):
+        data = dict(
+            email=user.email,
+            password=user.password,
+            displayname=user.full_name
+        )
+        if captcha_id is not None:
+            data['captcha_id'] = captcha_id
+        if captcha_solution is not None:
+            data['captcha_solution'] = captcha_solution
+        response = self.client.register(data)
+        return response.status_code == 201

=== modified file 'u1testutils/sso/data.py'
--- u1testutils/sso/data.py	2013-05-03 15:55:59 +0000
+++ u1testutils/sso/data.py	2013-05-10 01:35:30 +0000
@@ -16,7 +16,7 @@
 
 from django.conf import settings
 
-from u1testutils.sso import client
+from u1testutils.sso import api
 
 
 class User(object):
@@ -34,9 +34,10 @@
     def openid(self):
         if self._openid is None:
             token_name = "token-%s" % self.email
-            self._openid = client.get_account_openid(email=self.email,
-                                                     password=self.password,
-                                                     token_name=token_name)
+            api_client = api.APIClient()
+            self._openid = api_client.get_account_openid(
+                email=self.email, password=self.password,
+                token_name=token_name)
         return self._openid
 
     @classmethod

=== modified file 'u1testutils/sso/selftests/unit/test_data.py'
--- u1testutils/sso/selftests/unit/test_data.py	2013-05-03 16:17:38 +0000
+++ u1testutils/sso/selftests/unit/test_data.py	2013-05-10 01:35:30 +0000
@@ -19,7 +19,7 @@
 from mock import patch
 
 import u1testutils.django
-from u1testutils.sso import data
+from u1testutils.sso import api, data
 
 
 class DataTestCase(unittest.TestCase):
@@ -63,15 +63,15 @@
         self.assertIsNone(self.user._openid)
 
     def test_openid_for_valid_account(self):
-        with patch('u1testutils.sso.data.client') as mock_client:
-            mock_client.get_account_openid.return_value = 'foo1234'
+        with patch.object(api.APIClient, 'get_account_openid') as mock_open_id:
+            mock_open_id.return_value = 'foo1234'
 
             self.assertEqual(self.user.openid, 'foo1234')
             self.assertEqual(self.user._openid, 'foo1234')
 
     def test_openid_for_invalid_account(self):
-        with patch('u1testutils.sso.data.client') as mock_client:
-            mock_client.get_account_openid.return_value = None
+        with patch.object(api.APIClient, 'get_account_openid') as mock_open_id:
+            mock_open_id.return_value = None
 
             self.assertEqual(self.user.openid, None)
             self.assertIsNone(self.user._openid, None)

=== renamed file 'u1testutils/sso/selftests/unit/test_client.py' => 'u1testutils/sso/selftests/unit/test_sso_api_client.py'
--- u1testutils/sso/selftests/unit/test_client.py	2013-04-22 20:01:02 +0000
+++ u1testutils/sso/selftests/unit/test_sso_api_client.py	2013-05-10 01:35:30 +0000
@@ -16,23 +16,21 @@
 
 from mock import Mock, patch
 
-from u1testutils.sso import client, data
+from u1testutils.sso import api, data
 from ssoclient.v2 import V2ApiClient
 
 
 class ClientTestCase(unittest.TestCase):
 
-    base_namespace = 'u1testutils.sso.client'
+    base_namespace = 'u1testutils.sso.api'
 
     def test_get_api_client(self):
-        mock_get_base_url = Mock(return_value='http://localhost:8000')
-        with patch(self.base_namespace + '.environment.get_sso_base_url',
-                   mock_get_base_url):
-            api_client = client.get_api_client()
+        api_client = api.APIClient('http://localhost:8000')
 
-        self.assertTrue(isinstance(api_client, V2ApiClient))
-        self.assertEqual(api_client.session.endpoint,
-                         'http://localhost:8000/api/v2/')
+        self.assertTrue(isinstance(api_client.client, V2ApiClient))
+        self.assertEqual(
+            api_client.client.session.endpoint,
+            'http://localhost:8000/api/v2/')
 
     def test_get_account_openid(self):
         mock_login = Mock()
@@ -45,8 +43,9 @@
         }
 
         with patch(self.base_namespace + '.V2ApiClient.login', mock_login):
-            openid = client.get_account_openid('email', 'password',
-                                               'token_name')
+            api_client = api.APIClient()
+            openid = api_client.get_account_openid(
+                'email', 'password', 'token_name')
 
         self.assertEqual(openid, 'oid1234')
 
@@ -59,8 +58,9 @@
         }
 
         with patch(self.base_namespace + '.V2ApiClient.login', mock_login):
-            openid = client.get_account_openid('email', 'password',
-                                               'token_name')
+            api_client = api.APIClient()
+            openid = api_client.get_account_openid(
+                'email', 'password', 'token_name')
 
         self.assertIsNone(openid)
 
@@ -70,7 +70,8 @@
         mock_register.return_value.status_code = 201
         client_register = self.base_namespace + '.V2ApiClient.register'
         with patch(client_register, mock_register):
-            created = client.create_new_account(user)
+            api_client = api.APIClient()
+            created = api_client.create_new_account(user)
         self.assertTrue(created)
 
     def test_create_new_account_failed(self):
@@ -79,7 +80,8 @@
         mock_register.return_value.status_code = 400
         client_register = self.base_namespace + '.V2ApiClient.register'
         with patch(client_register, mock_register):
-            created = client.create_new_account(user)
+            api_client = api.APIClient()
+            created = api_client.create_new_account(user)
         self.assertFalse(created)
 
     def test_create_new_account_without_captcha(self):
@@ -91,7 +93,8 @@
         )
         client_register = self.base_namespace + '.V2ApiClient.register'
         with patch(client_register) as mock_register:
-            client.create_new_account(user)
+            api_client = api.APIClient()
+            api_client.create_new_account(user)
         mock_register.assert_called_once_with(expected_data)
 
     def test_create_new_account_with_captcha(self):
@@ -105,5 +108,6 @@
         )
         client_register = self.base_namespace + '.V2ApiClient.register'
         with patch(client_register) as mock_register:
-            client.create_new_account(user, 'Test id', 'Test solution')
+            api_client = api.APIClient()
+            api_client.create_new_account(user, 'Test id', 'Test solution')
         mock_register.assert_called_once_with(expected_data)