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

[Leo Arias]

Added tests for the mail utilities.

Added tests for the mail utilities.

[lp:~elopio/u1-test-utils/rename_mail]

23. By Leo Arias on 2013-01-21

Added the subject in the verification.

24. By Leo Arias on 2013-01-21

Moved the localmay to class methods and wait for it to start.

[Simon Davy (bloodearnest)]

review: Approve

=== modified file 'fabtasks/development.py'
--- fabtasks/development.py	2013-01-16 15:16:50 +0000
+++ fabtasks/development.py	2013-01-21 16:21:20 +0000
@@ -14,6 +14,7 @@
 # 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 os
 import unittest
 
 
@@ -25,6 +26,8 @@
         'static' and 'unit'. If none are supplied, all the known ones are run.
 
     """
+    os.environ['DJANGO_SETTINGS_MODULE'] = \
+        'u1testutils.selftests.django_project.settings'
     if suites is None:
         suites = ['static', 'unit']
     suite = unittest.TestSuite()
@@ -37,6 +40,7 @@
     if 'static' in suites:
         module_paths.append('u1testutils/selftests/static')
     if 'unit' in suites:
+        module_paths.append('u1testutils/selftests/unit')
         module_paths.append('u1testutils/sst/sso/selftests/unit')
     for mp in module_paths:
         suite.addTest(unittest.TestLoader().discover(mp))

=== modified file 'requirements.txt'
--- requirements.txt	2013-01-16 02:55:27 +0000
+++ requirements.txt	2013-01-21 16:21:20 +0000
@@ -3,3 +3,5 @@
 pep8
 pyflakes
 sst
+Twisted
+bzr+ssh://bazaar.launchpad.net/~bloodearnest/+junk/test-email-server/

=== renamed file 'u1testutils/sst/mail.py' => 'u1testutils/mail.py'
--- u1testutils/sst/mail.py	2012-12-04 19:47:27 +0000
+++ u1testutils/mail.py	2013-01-21 16:21:20 +0000
@@ -1,4 +1,20 @@
-#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright 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 __future__ import absolute_import
 
 import imaplib
 import time

=== added directory 'u1testutils/selftests/django_project'
=== added file 'u1testutils/selftests/django_project/__init__.py'
=== added file 'u1testutils/selftests/django_project/settings.py'
--- u1testutils/selftests/django_project/settings.py	1970-01-01 00:00:00 +0000
+++ u1testutils/selftests/django_project/settings.py	2013-01-21 16:21:20 +0000
@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 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/
+
+IMAP_USERNAME = 'test'
+IMAP_PASSWORD = 'test'
+IMAP_USE_SSL = False
+IMAP_SERVER = 'localhost'
+IMAP_PORT = 2143
+SSO_TEST_ACCOUNT_FULL_NAME = 'Test full name'
+SSO_TEST_ACCOUNT_EMAIL = '[e-mail]'
+SSO_TEST_ACCOUNT_PASSWORD = '7357 ¶@55\^/0rD'

=== added directory 'u1testutils/selftests/unit'
=== added file 'u1testutils/selftests/unit/__init__.py'
=== added file 'u1testutils/selftests/unit/test_mail.py'
--- u1testutils/selftests/unit/test_mail.py	1970-01-01 00:00:00 +0000
+++ u1testutils/selftests/unit/test_mail.py	2013-01-21 16:21:20 +0000
@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 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 socket
+import threading
+import unittest
+
+import localmail
+import localmail.tests.helpers
+from django.conf import settings
+
+from u1testutils import mail
+
+
+class MailTestCase(unittest.TestCase):
+
+    SMTP_PORT = 2025
+
+    @classmethod
+    def setUpClass(class_):
+        class_.localmail_thread = threading.Thread(
+            target=localmail.run, args=(class_.SMTP_PORT, settings.IMAP_PORT))
+        class_.localmail_thread.start()
+        # Try the port to make sure the server started.
+        socket_ = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        socket_.settimeout(10)
+        socket_.connect(('localhost', class_.SMTP_PORT))
+        socket_.close()
+
+    @classmethod
+    def tearDownClass(class_):
+        localmail.shutdown_thread(class_.localmail_thread)
+
+    def test_get_latest_email(self):
+        from_ = '[e-mail]'
+        to = '[e-mail]'
+        subject = 'Test Subject'
+        body = 'Test body'
+        with localmail.tests.helpers.SMTPHelper(port=self.SMTP_PORT) as smtp:
+            smtp.login()
+            smtp.send(from_, to, subject, body)
+        latest_email = mail.get_latest_email_sent_to('[e-mail]')
+        self.assertEquals(latest_email['From'], from_)
+        self.assertEquals(latest_email['To'], to)
+        self.assertEquals(latest_email['Subject'], subject)
+        self.assertEquals(latest_email.get_payload(), body + '\n')

=== added file 'u1testutils/sst/sso/selftests/unit/__init__.py'
=== modified file 'u1testutils/sst/sso/selftests/unit/test_data.py'
--- u1testutils/sst/sso/selftests/unit/test_data.py	2013-01-16 02:55:27 +0000
+++ u1testutils/sst/sso/selftests/unit/test_data.py	2013-01-21 16:21:20 +0000
@@ -16,7 +16,7 @@
 
 import unittest
 
-import mock
+from django.conf import settings
 
 from u1testutils.sst.sso import data
 
@@ -24,17 +24,8 @@
 class DataTestCase(unittest.TestCase):
 
     def test_make_exising_user(self):
-        test_full_name = 'Test full name'
-        test_email = '[e-mail]'
-        test_password = '7357 ¶@55\^/0rD'
-        with mock.patch('u1testutils.sst.sso.data.settings') as mock_settings:
-            type(mock_settings).SSO_TEST_ACCOUNT_FULL_NAME = \
-                mock.PropertyMock(return_value=test_full_name)
-            type(mock_settings).SSO_TEST_ACCOUNT_EMAIL = \
-                mock.PropertyMock(return_value=test_email)
-            type(mock_settings).SSO_TEST_ACCOUNT_PASSWORD = \
-                mock.PropertyMock(return_value=test_password)
-            user = data.User.make_from_configuration()
-            self.assertEqual(user.full_name, test_full_name)
-            self.assertEqual(user.email, test_email)
-            self.assertEqual(user.password, test_password)
+        # 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)

=== added file 'u1testutils/sst/sso/selftests/unit/test_sso_mail.py'
--- u1testutils/sst/sso/selftests/unit/test_sso_mail.py	1970-01-01 00:00:00 +0000
+++ u1testutils/sst/sso/selftests/unit/test_sso_mail.py	2013-01-21 16:21:20 +0000
@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 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 email.parser
+import unittest
+
+import mock
+
+from u1testutils.sst.sso.utils import mail
+
+
+class SSOMailTestCase(unittest.TestCase):
+
+    verification_email = email.parser.Parser().parsestr(
+        'Content-Type: text/plain; charset="utf-8"\n'
+        'MIME-Version: 1.0\n'
+        'Content-Transfer-Encoding: quoted-printable\n'
+        'Subject: Ubuntu Single Sign On: Finish your registration\n'
+        'From: Ubuntu Single Sign On <[e-mail]>\n'
+        'To: [e-mail]\n'
+        '\n'
+        'Hello\n'
+        '\n'
+        'As a final step of the Ubuntu Single Sign On (SSO) account '
+        'creation process=\n'
+        ', please validate the email address [e-mail]. Ubuntu SSO '
+        'enables conv=\n'
+        'enient access to a variety of Ubuntu-related services like Ubuntu '
+        'One with =\n'
+        'the same username and password.\n'
+        '\n'
+        'Here is your confirmation code:\n'
+        '\n'
+        'QM9CSR\n'
+        '\n'
+        'Enter this code into the registration form, or click the following '
+        'link to =\n'
+        'automatically confirm your account:\n'
+        '\n'
+        'https://login.ubuntu.com/confirm-account/QM9CSR/[e-mail]\n'
+        '\n'
+        'If you don\'t know what this is about, then someone has probably '
+        'entered you=\n'
+        'r email address by mistake. Sorry about that.\n'
+        'If you wish to report this email being incorrectly used, please '
+        'click the f=\n'
+        'ollowing link:\n'
+        '\n'
+        'https://login.ubuntu.com/invalidate-email/42FcJG/[e-mail]\n'
+        '\n'
+        'You can also seek further assistance on:\n'
+        '\n'
+        'https://forms.canonical.com/sso-support/\n'
+        '\n'
+        'Thank you,\n'
+        '\n'
+        'The Ubuntu Single Sign On team\n'
+        'https://login.ubuntu.com/\n'
+    )
+
+    def setUp(self):
+        super(SSOMailTestCase, self).setUp()
+        patcher = mock.patch('u1testutils.mail')
+        mock_mail = patcher.start()
+        mock_mail.get_latest_email_sent_to.return_value = \
+            self.verification_email
+        self.addCleanup(patcher.stop)
+
+    def test_get_verification_code(self):
+        verification_code = mail.get_verification_code_for_address(
+            '[e-mail]')
+        self.assertEquals(verification_code, 'QM9CSR')
+
+    def test_get_verification_link(self):
+        verification_link = mail.get_verification_link_for_address(
+            '[e-mail]')
+        self.assertEquals(
+            verification_link,
+            'https://login.ubuntu.com/confirm-account/QM9CSR/[e-mail]')

=== modified file 'u1testutils/sst/sso/utils/mail.py'
--- u1testutils/sst/sso/utils/mail.py	2013-01-17 21:34:26 +0000
+++ u1testutils/sst/sso/utils/mail.py	2013-01-21 16:21:20 +0000
@@ -17,7 +17,7 @@
 import quopri
 import re
 
-from u1testutils.sst import mail
+import u1testutils.mail
 
 
 def _get_verification_data_for_address(email_address):
@@ -28,7 +28,7 @@
     idioms like:
         vcode, ignored = get_verification_for_address(email_address).
     """
-    email_msg = mail.get_latest_email_sent_to(email_address)
+    email_msg = u1testutils.mail.get_latest_email_sent_to(email_address)
     vcode = link = None
     if email_msg:
         # The body is encoded as quoted-printable.  This affects any