Merge lp:~bjornt/launchpad/compare-email-headers into lp:launchpad

[Björn Tillenius]

Add TestCase.assertEmailHeadersEqual() for comparing e-mail headers.

In case of long headers, the headers are unfolded before being compared.
Also change some tests to use the new method, so that they can cope with
factory.getUniqueString() being changed to return longer strings.

[Graham Binns (gmb)]

review: Approve (code)

=== modified file 'lib/lp/code/mail/tests/test_branchmergeproposal.py'
--- lib/lp/code/mail/tests/test_branchmergeproposal.py	2010-04-06 23:47:36 +0000
+++ lib/lp/code/mail/tests/test_branchmergeproposal.py	2010-05-18 14:28:36 +0000
@@ -519,7 +519,7 @@
         candidate = removeSecurityProxy(candidate)
         expected_email = '%s <%s>' % (
             candidate.displayname, candidate.preferredemail.email)
-        self.assertEqual(expected_email, mails[0]['To'])
+        self.assertEmailHeadersEqual(expected_email, mails[0]['To'])
 
 
 def test_suite():

=== modified file 'lib/lp/codehosting/scanner/tests/test_email.py'
--- lib/lp/codehosting/scanner/tests/test_email.py	2010-04-23 07:54:02 +0000
+++ lib/lp/codehosting/scanner/tests/test_email.py	2010-05-18 14:28:36 +0000
@@ -61,7 +61,7 @@
         message = email.message_from_string(initial_email[2])
         email_body = message.get_payload()
         self.assertTextIn(expected, email_body)
-        self.assertEqual(
+        self.assertEmailHeadersEqual(
             '[Branch %s] 0 revisions' % self.db_branch.unique_name,
             message['Subject'])
 
@@ -76,7 +76,7 @@
         message = email.message_from_string(initial_email[2])
         email_body = message.get_payload()
         self.assertTextIn(expected, email_body)
-        self.assertEqual(
+        self.assertEmailHeadersEqual(
             '[Branch %s] 1 revision' % self.db_branch.unique_name,
             message['Subject'])
 
@@ -94,7 +94,7 @@
         message = email.message_from_string(uncommit_email[2])
         email_body = message.get_payload()
         self.assertTextIn(expected, email_body)
-        self.assertEqual(
+        self.assertEmailHeadersEqual(
             '[Branch %s] 1 revision removed' % self.db_branch.unique_name,
             message['Subject'])
 
@@ -122,10 +122,13 @@
         subject = (
             'Subject: [Branch %s] Test branch' % self.db_branch.unique_name)
         self.assertTextIn(expected, uncommit_email_body)
-        recommit_email_body = recommit_email[2]
+
+        recommit_email_msg = email.message_from_string(recommit_email[2])
+        recommit_email_body = recommit_email_msg.get_payload()[0].get_payload(
+            decode=True)
+        subject =  '[Branch %s] Rev 1: second' % self.db_branch.unique_name
+        self.assertEmailHeadersEqual(subject, recommit_email_msg['Subject'])
         body_bits = [
-            'Subject: [Branch %s] Rev 1: second'
-            % self.db_branch.unique_name,
             'revno: 1',
             'committer: %s' % author,
             'branch nick: %s'  % self.bzr_branch.nick,

=== modified file 'lib/lp/testing/__init__.py'
--- lib/lp/testing/__init__.py	2010-05-06 13:39:11 +0000
+++ lib/lp/testing/__init__.py	2010-05-18 14:28:36 +0000
@@ -413,6 +413,19 @@
         os.chdir(tempdir)
         self.addCleanup(os.chdir, cwd)
 
+    def _unfoldEmailHeader(self, header):
+        """Unfold a multiline e-mail header."""
+        header = ''.join(header.splitlines())
+        return header.replace('\t', ' ')
+
+    def assertEmailHeadersEqual(self, expected, observed):
+        """Assert that two e-mail headers are equal.
+
+        The headers are unfolded before being compared.
+        """
+        return self.assertEqual(
+            self._unfoldEmailHeader(expected),
+            self._unfoldEmailHeader(observed))
 
 class TestCaseWithFactory(TestCase):