Merge lp:~canonical-isd-hackers/canonical-identity-provider/minor-change-to-email into lp:canonical-identity-provider/release

[Łukasz Czyżykowski]

Changed the email which is sent to the user to validate email address.

Added two new tests to make sure that modified Token.sendEmailValidationToken works as expected. The behaviour of the api is checked by existing doctests (api-workflow.txt).

[David Owen (dsowen)]

Nice refactor in the tests.

review: Approve

=== modified file 'identityprovider/models/authtoken.py'
--- identityprovider/models/authtoken.py	2010-07-19 17:34:01 +0000
+++ identityprovider/models/authtoken.py	2010-08-23 12:47:40 +0000
@@ -103,13 +103,13 @@
         self._send_email(u"%s Email Validator" % current_brand.name, subject,
                          message)
 
-    def sendEmailValidationToken(self):
+    def sendEmailValidationToken(self, template='email-validation-token.txt'):
         replacements = {
             'token': self.token,
             'toaddress': self.email,
         }
-        message = render_to_string('%s/email/email-validation-token.txt' %
-            current_brand.template_dir, replacements)
+        template_path = '%s/email/%s' % (current_brand.template_dir, template)
+        message = render_to_string(template_path, replacements)
         subject = u"%s: %s" % (current_brand.name,
                                _("Validate your email address"))
         self._send_email(u"%s Email Validator" % current_brand.name, subject,

=== added file 'identityprovider/templates/ubuntu/email/api-email-validation-token.txt'
--- identityprovider/templates/ubuntu/email/api-email-validation-token.txt	1970-01-01 00:00:00 +0000
+++ identityprovider/templates/ubuntu/email/api-email-validation-token.txt	2010-08-23 12:47:40 +0000
@@ -0,0 +1,15 @@
+{% load i18n %}
+{% blocktrans %}Hello
+
+As a final step of the Ubuntu Single Sign On (SSO) account creation process, please validate the email address {{ toaddress }}. Ubuntu SSO enables convenient access to a variety of Ubuntu-related services like Ubuntu One with the same username and password.
+
+Copy and paste the confirmation code below into the desktop application.
+
+    {{ token }}
+
+If you don't know what this is about, then someone has probably entered your email address by mistake. Sorry about that. You don't need to do anything further. Just delete this message.
+
+Thank you,
+
+The Ubuntu Single Sign On team
+https://login.ubuntu.com/{% endblocktrans %}

=== modified file 'identityprovider/tests/test_models_authtoken.py'
--- identityprovider/tests/test_models_authtoken.py	2010-05-20 14:07:52 +0000
+++ identityprovider/tests/test_models_authtoken.py	2010-08-23 12:47:40 +0000
@@ -6,11 +6,25 @@
 
 from identityprovider.tests.utils import BasicAccountTestCase
 from identityprovider.models.account import Account
+from identityprovider.models import authtoken
 from identityprovider.models.authtoken import (AuthToken, AuthTokenFactory,
     send_validation_email_request, create_unique_token_for_table, valid_email)
 from identityprovider.models.const import EmailStatus, LoginTokenType
 
 
+class MockRenderToString(object):
+
+    def __init__(self, return_value=None):
+        self.template = None
+        self.context = None
+        self.return_value = None
+
+    def __call__(self, template, context):
+        self.template = template
+        self.context = context
+        return self.return_value
+
+
 class AuthTokenTestCase(BasicAccountTestCase):
     def setUp(self):
         def mock_send_email(self, from_name, subject, message):
@@ -28,9 +42,7 @@
         super(AuthTokenTestCase, self).tearDown()
 
     def test_sendEmailValidationRequest(self):
-        account = Account.objects.get_by_email('[e-mail]')
-        token = AuthTokenFactory().new_api_email_validation_token(
-            account, '[e-mail]')
+        token = self._get_new_email_validation_token()
 
         self.assertFalse(hasattr(token, 'message'))
         token.sendEmailValidationRequest()
@@ -38,18 +50,50 @@
         self.assertTrue(settings.SUPPORT_FORM_URL in token.message)
 
     def test_sendEmailValidationToken(self):
-        account = Account.objects.get_by_email('[e-mail]')
-        token = AuthTokenFactory().new_api_email_validation_token(
-            account, '[e-mail]')
+        token = self._get_new_email_validation_token()
         self.assertFalse(hasattr(token, 'message'))
         token.sendEmailValidationToken()
         self.assertTrue(hasattr(token, 'message'))
         self.assertTrue(token.token in token.message)
 
+    def test_sendEmailValidationToken_uses_provided_template(self):
+        token = self._get_new_email_validation_token()
+        mock_rts, rts = self._setup_mock_rendert_to_string()
+
+        token.sendEmailValidationToken('new-template.txt')
+
+        self.assertTrue(mock_rts.template.endswith('new-template.txt'))
+
+        self._teardown_mock_render_to_string(rts)
+
+    def _teardown_mock_render_to_string(self, rts):
+        authtoken.render_to_string = rts
+
+    def _setup_mock_rendert_to_string(self):
+        rts = authtoken.render_to_string
+        mock_rts = MockRenderToString()
+        authtoken.render_to_string = mock_rts
+        return mock_rts, rts
+
+    def _get_new_email_validation_token(self):
+        account = Account.objects.get_by_email('[e-mail]')
+        token = AuthTokenFactory().new_api_email_validation_token(
+            account, '[e-mail]')
+        return token
+
+    def test_sendEmailValidationToken_default_template(self):
+        token = self._get_new_email_validation_token()
+        mock_rts, rts = self._setup_mock_rendert_to_string()
+
+        token.sendEmailValidationToken()
+
+        self.assertTrue(mock_rts.template.endswith(
+            'email-validation-token.txt'))
+
+        self._teardown_mock_render_to_string(rts)
+
     def test_sendNewUserEmail(self):
-        account = Account.objects.get_by_email('[e-mail]')
-        token = AuthTokenFactory().new_api_email_validation_token(
-            account, '[e-mail]')
+        token = self._get_new_email_validation_token()
 
         self.assertFalse(hasattr(token, 'message'))
         token.sendNewUserEmail()

=== modified file 'identityprovider/webservice/models.py'
--- identityprovider/webservice/models.py	2010-08-16 11:55:02 +0000
+++ identityprovider/webservice/models.py	2010-08-23 12:47:40 +0000
@@ -223,32 +223,31 @@
                           for (k, v) in form.errors.items())
             result = {'status': 'error', 'errors': errors}
             return result
+
         cleaned_data = form.cleaned_data
         requested_email = cleaned_data['email']
         emails = EmailAddress.objects.filter(email__iexact=requested_email)
         if len(emails) > 0:
             return {'status': 'error', 'errors':
                     {'email': 'Email already registered'}}
+
         account = Account.objects.create(
             creation_rationale=AccountCreationRationale.OWNER_CREATED_LAUNCHPAD,
             status=AccountStatus.ACTIVE,
-            displayname=''
-            )
+            displayname='')
+
         account.emailaddress_set.create(
             email=cleaned_data['email'],
-            status=EmailStatus.NEW
-            )
-        password = encrypt_launchpad_password(
-            cleaned_data['password'])
-        password_obj = AccountPassword.objects.create(
-            password=password,
-            account=account,
-            )
-        account.accountpassword
+            status=EmailStatus.NEW)
+
+        AccountPassword.objects.create(
+            password=encrypt_launchpad_password(cleaned_data['password']),
+            account=account)
 
         token = AuthTokenFactory().new_api_email_validation_token(
             account, cleaned_data['email'])
-        token.sendEmailValidationToken()
+
+        token.sendEmailValidationToken('api-email-validation-token.txt')
 
         account_created.send(sender=self,
                              openid_identifier=account.openid_identifier)