Merge lp:~vila/bzr/1303879-py27-issues into lp:bzr

[Vincent Ladeuil]

Fix python-2.7.6 test failures.

python 2.7.6 introduced a minor incompatible change in the email module. Some tests were relying on as_string() to get a representation of the email message. A final new line is now appended there...

A bug has also been fixed in python 2.7.6 ntpath.py module and some of our tests runs on all platforms and needed to be fixed.

None of those changes affect bzr itself, only its tests.

This has been tested on trusty and saucy to make sure the tests pass for all python versions.

[Andrew Starr-Bochicchio (andrewsomething)]

Thanks for running this down. It looks good to me. I ran the test suite on Debian sid for good measure as it had been failing there as well. All tests were successful.

review: Approve

[Vincent Ladeuil (vila)]

> Thanks for running this down. It looks good to me.

> I ran the test suite on
> Debian sid for good measure

Thanks !

> as it had been failing there as well.

2.7.6 there too according to rmadison, so expected.

> All tests
> were successful.

Great.

[Vincent Ladeuil (vila)]

sent to pqm by email

=== modified file 'bzrlib/email_message.py'
--- bzrlib/email_message.py	2011-12-19 13:23:58 +0000
+++ bzrlib/email_message.py	2014-04-09 08:25:34 +0000
@@ -149,7 +149,7 @@
 
     @staticmethod
     def send(config, from_address, to_address, subject, body, attachment=None,
-            attachment_filename=None, attachment_mime_subtype='plain'):
+             attachment_filename=None, attachment_mime_subtype='plain'):
         """Create an email message and send it with SMTPConnection.
 
         :param config: config object to pass to SMTPConnection constructor.

=== modified file 'bzrlib/tests/test_email_message.py'
--- bzrlib/tests/test_email_message.py	2011-12-16 19:18:39 +0000
+++ bzrlib/tests/test_email_message.py	2014-04-09 08:25:34 +0000
@@ -14,13 +14,14 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
+import sys
 from email.Header import decode_header
 
 from bzrlib import __version__ as _bzrlib_version
 from bzrlib.email_message import EmailMessage
 from bzrlib.errors import BzrBadParameterNotUnicode
 from bzrlib.smtp_connection import SMTPConnection
-from bzrlib.tests import TestCase
+from bzrlib import tests
 
 EMPTY_MESSAGE = '''\
 From: [e-mail]
@@ -65,9 +66,22 @@
 body
 ''' %  { 'version': _bzrlib_version, 'boundary': BOUNDARY }
 
-SIMPLE_MULTIPART_MESSAGE = _MULTIPART_HEAD + '--%s--' % BOUNDARY
-
-COMPLEX_MULTIPART_MESSAGE = _MULTIPART_HEAD + '''\
+
+def final_newline_or_not(msg):
+    if sys.version_info >= (2, 7, 6):
+        # Some internals of python's email module changed in an (minor)
+        # incompatible way: a final newline is appended in 2.7.6...
+       msg += '\n'
+    return msg
+
+
+def simple_multipart_message():
+    msg = _MULTIPART_HEAD + '--%s--' % BOUNDARY
+    return final_newline_or_not(msg)
+
+
+def complex_multipart_message(typ):
+    msg = _MULTIPART_HEAD + '''\
 --%(boundary)s
 MIME-Version: 1.0
 Content-Type: text/%%s; charset="us-ascii"; name="lines.txt"
@@ -81,9 +95,11 @@
 e
 
 --%(boundary)s--''' %  { 'boundary': BOUNDARY }
-
-
-class TestEmailMessage(TestCase):
+    msg = final_newline_or_not(msg)
+    return msg % (typ,)
+
+
+class TestEmailMessage(tests.TestCase):
 
     def test_empty_message(self):
         msg = EmailMessage('[e-mail]', '[e-mail]', 'subject')
@@ -100,15 +116,18 @@
             msg = EmailMessage('[e-mail]', '[e-mail]', 'subject', body)
             self.assertEqualDiff(expected, msg.as_string())
 
-    def test_multipart_message(self):
+    def test_multipart_message_simple(self):
         msg = EmailMessage('[e-mail]', '[e-mail]', 'subject')
         msg.add_inline_attachment('body')
-        self.assertEqualDiff(SIMPLE_MULTIPART_MESSAGE, msg.as_string(BOUNDARY))
-
+        self.assertEqualDiff(simple_multipart_message(),
+                             msg.as_string(BOUNDARY))
+
+
+    def test_multipart_message_complex(self):
         msg = EmailMessage('[e-mail]', '[e-mail]', 'subject', 'body')
         msg.add_inline_attachment(u'a\nb\nc\nd\ne\n', 'lines.txt', 'x-subtype')
-        self.assertEqualDiff(COMPLEX_MULTIPART_MESSAGE % 'x-subtype',
-                msg.as_string(BOUNDARY))
+        self.assertEqualDiff(complex_multipart_message('x-subtype'),
+                             msg.as_string(BOUNDARY))
 
     def test_headers_accept_unicode_and_utf8(self):
         for user in [ u'Pepe P\xe9rez <[e-mail]>',
@@ -148,40 +167,6 @@
         self.assertEqual('[e-mail]', msg['To'])
         self.assertEqual('[e-mail]', msg['Cc'])
 
-    def test_send(self):
-        class FakeConfig:
-            def get(self, option):
-                return None
-
-        messages = []
-
-        def send_as_append(_self, msg):
-            messages.append(msg.as_string(BOUNDARY))
-
-        old_send_email = SMTPConnection.send_email
-        try:
-            SMTPConnection.send_email = send_as_append
-
-            EmailMessage.send(FakeConfig(), '[e-mail]', '[e-mail]',
-                    'subject', 'body', u'a\nb\nc\nd\ne\n', 'lines.txt')
-            self.assertEqualDiff(COMPLEX_MULTIPART_MESSAGE % 'plain',
-                    messages[0])
-            messages[:] = []
-
-            EmailMessage.send(FakeConfig(), '[e-mail]', '[e-mail]',
-                    'subject', 'body', u'a\nb\nc\nd\ne\n', 'lines.txt',
-                    'x-patch')
-            self.assertEqualDiff(COMPLEX_MULTIPART_MESSAGE % 'x-patch',
-                    messages[0])
-            messages[:] = []
-
-            EmailMessage.send(FakeConfig(), '[e-mail]', '[e-mail]',
-                    'subject', 'body')
-            self.assertEqualDiff(SIMPLE_MESSAGE_ASCII , messages[0])
-            messages[:] = []
-        finally:
-            SMTPConnection.send_email = old_send_email
-
     def test_address_to_encoded_header(self):
         def decode(s):
             """Convert a RFC2047-encoded string to a unicode string."""
@@ -224,3 +209,46 @@
         }
         for string_, pair in pairs.items():
             self.assertEqual(pair, EmailMessage.string_with_encoding(string_))
+
+
+class TestSend(tests.TestCase):
+
+    def setUp(self):
+        super(TestSend, self).setUp()
+        self.messages = []
+
+        def send_as_append(_self, msg):
+            self.messages.append(msg.as_string(BOUNDARY))
+
+        self.overrideAttr(SMTPConnection, 'send_email', send_as_append)
+
+
+
+    def send_email(self, attachment=None, attachment_filename=None,
+                   attachment_mime_subtype='plain'):
+        class FakeConfig:
+            def get(self, option):
+                return None
+
+        EmailMessage.send(FakeConfig(), '[e-mail]', '[e-mail]',
+                          'subject', 'body',
+                          attachment=attachment,
+                          attachment_filename=attachment_filename,
+                          attachment_mime_subtype=attachment_mime_subtype)
+
+    def assertMessage(self, expected):
+        self.assertLength(1, self.messages)
+        self.assertEqualDiff(expected, self.messages[0])
+
+    def test_send_plain(self):
+        self.send_email(u'a\nb\nc\nd\ne\n', 'lines.txt')
+        self.assertMessage(complex_multipart_message('plain'))
+
+    def test_send_patch(self):
+        self.send_email(u'a\nb\nc\nd\ne\n', 'lines.txt', 'x-patch')
+        self.assertMessage(complex_multipart_message('x-patch'))
+
+    def test_send_simple(self):
+          self.send_email()
+          self.assertMessage(SIMPLE_MESSAGE_ASCII)
+

=== modified file 'bzrlib/tests/test_osutils.py'
--- bzrlib/tests/test_osutils.py	2013-06-24 12:03:12 +0000
+++ bzrlib/tests/test_osutils.py	2014-04-09 08:25:34 +0000
@@ -943,9 +943,15 @@
                          osutils._win32_pathjoin('path/to', 'C:/foo'))
         self.assertEqual('path/to/foo',
                          osutils._win32_pathjoin('path/to/', 'foo'))
-        self.assertEqual('/foo',
+
+    def test_pathjoin_late_bugfix(self):
+        if sys.version_info < (2, 7, 6):
+            expected = '/foo'
+        else:
+            expected = 'C:/foo'
+        self.assertEqual(expected,
                          osutils._win32_pathjoin('C:/path/to/', '/foo'))
-        self.assertEqual('/foo',
+        self.assertEqual(expected,
                          osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
 
     def test_normpath(self):

=== modified file 'doc/en/release-notes/bzr-2.7.txt'
--- doc/en/release-notes/bzr-2.7.txt	2014-04-02 16:15:32 +0000
+++ doc/en/release-notes/bzr-2.7.txt	2014-04-09 08:25:34 +0000
@@ -63,6 +63,12 @@
    suite.  This can include new facilities for writing tests, fixes to 
    spurious test failures and changes to the way things should be tested.
 
+* Handle (minor) incompatible change in python 2.7.6 leading to test
+  failures. Only tests are affected. (Vincent Ladeuil, #1303879)
+
+* Take python 2.7.6 late (better than never) bugfix in ntpath.py into
+  account. Only tests are affected (Vincent Ladeuil, #1303879).
+
 * Remove wrong assumption about how TCP server and client interact when run
   inside the same process. (Vincent Ladeuil, #1269886).