Merge lp:~jml/subunit/use-traceback-content into lp:~subunit/subunit/trunk

[Jonathan Lange]

This addresses bug 929063 by making subunit call TracebackContent rather than _exc_info_to_unicode.

The tests fail for me, but they fail with trunk too. I suspect subunit is out of step with recent testtools formatting changes. This branch doesn't introduce any new failures that I can tell.

Perhaps it's best to land this branch after the testtools side of the fix, https://code.launchpad.net/~jml/testtools/exc-info-929063, lands, so that subunit can be said to rely on a minimum released version of testtools rather than testtools trunk rNNN.

[lp:~jml/subunit/use-traceback-content]

158. By Jonathan Lange on 2012-02-09

Don't make so many assumptions about how testtools formats details.

159. By Jonathan Lange on 2012-02-09

Code that works for 0.9.11 and against testtools trunk

[Jonathan Lange (jml)]

The most recent changes (r159) make subunit's Python tests pass with testtools 0.9.11 (the documented minimum version) and with testtools trunk. Actually, it doesn't quite make them work with 0.9.11 because the TracebackContent fix in __init__.py requires 0.9.12 minimum to work.

Let me know if you want me to make that work in 0.9.11 and with trunk. Personally I think we could just make the next release of subunit say minimum testtools 0.9.13 (not yet released) and ditch the compatibility workarounds.

4 shell tests still fail due to test_function_output.sh not expecting time output.

[Robert Collins (lifeless)]

This looks broadly fine.

I think the next testtools release should be compatible with the current released subunit, and vice-verca; deeper compat when possible is great - avoiding tight locks is nice - but not required.

Will +1 it when it doesn't conflict, because I can't quite tell whats up at the bottom

[lp:~jml/subunit/use-traceback-content]

160. By Jonathan Lange on 2012-02-16

Merge trunk

161. By Jonathan Lange on 2012-02-16

Make sure the tests pass with 0.9.11 as well as 0.9.12 & 13

162. By Jonathan Lange on 2012-02-16

Clean up a flake

[Jonathan Lange (jml)]

This version should work with 0.9.11, 0.9.12, 0.9.13 and trunk.

[Jelmer Vernooij (jelmer)]

Looks good, and great to have compatibility with existing testtools releases.

review: Approve

=== modified file 'python/subunit/__init__.py'
--- python/subunit/__init__.py	2012-02-10 11:26:44 +0000
+++ python/subunit/__init__.py	2012-02-16 10:46:21 +0000
@@ -123,6 +123,7 @@
 import unittest
 
 from testtools import content, content_type, ExtendedToOriginalDecorator
+from testtools.content import TracebackContent
 from testtools.compat import _b, _u, BytesIO, StringIO
 try:
     from testtools.testresult.real import _StringException
@@ -682,10 +683,9 @@
                 raise ValueError
         if error is not None:
             self._stream.write(self._start_simple)
-            # XXX: this needs to be made much stricter, along the lines of
-            # Martin[gz]'s work in testtools. Perhaps subunit can use that?
-            for line in self._exc_info_to_unicode(error, test).splitlines():
-                self._stream.write(("%s\n" % line).encode('utf8'))
+            tb_content = TracebackContent(error, test)
+            for bytes in tb_content.iter_bytes():
+                self._stream.write(bytes)
         elif details is not None:
             self._write_details(details)
         else:

=== modified file 'python/subunit/tests/test_test_protocol.py'
--- python/subunit/tests/test_test_protocol.py	2012-01-11 05:42:53 +0000
+++ python/subunit/tests/test_test_protocol.py	2012-02-16 10:46:21 +0000
@@ -18,9 +18,9 @@
 import unittest
 import os
 
-from testtools import skipIf, TestCase
-from testtools.compat import _b, _u, BytesIO, StringIO
-from testtools.content import Content, TracebackContent
+from testtools import skipIf, TestCase, TestResult
+from testtools.compat import _b, _u, BytesIO
+from testtools.content import Content, TracebackContent, text_content
 from testtools.content_type import ContentType
 try:
     from testtools.testresult.doubles import (
@@ -40,6 +40,10 @@
 import subunit.iso8601 as iso8601
 
 
+def details_to_str(details):
+    return TestResult()._err_details_to_string(None, details=details)
+
+
 class TestTestImports(unittest.TestCase):
 
     def test_imports(self):
@@ -87,11 +91,12 @@
     def test_story(self):
         client = unittest.TestResult()
         protocol = subunit.TestProtocolServer(client)
+        traceback = "foo.c:53:ERROR invalid state\n"
         pipe = BytesIO(_b("test old mcdonald\n"
                         "success old mcdonald\n"
                         "test bing crosby\n"
                         "failure bing crosby [\n"
-                        "foo.c:53:ERROR invalid state\n"
+                        +  traceback +
                         "]\n"
                         "test an error\n"
                         "error an error\n"))
@@ -102,9 +107,8 @@
                          [(an_error, _remote_exception_str + '\n')])
         self.assertEqual(
             client.failures,
-            [(bing, _remote_exception_str + 
-                ": foo.c:53:ERROR invalid state\n"
-                "\n")])
+            [(bing, _remote_exception_str + ": "
+              + details_to_str({'traceback': text_content(traceback)}) + "\n")])
         self.assertEqual(client.testsRun, 3)
 
     def test_non_test_characters_forwarded_immediately(self):
@@ -559,9 +563,7 @@
                 value = details
             else:
                 if error_message is not None:
-                    if not len(error_message.strip()):
-                        error_message = _u("Empty attachments:\n  traceback\n")
-                    value = subunit.RemoteError(_u(error_message))
+                    value = subunit.RemoteError(details_to_str(details))
                 else:
                     value = subunit.RemoteError()
             self.assertEqual([