Merge lp:~bjornt/launchpad/manuel into lp:launchpad

[Björn Tillenius]

Unmerged revisions

10162. By Björn Tillenius on 2010-02-10

Merge RF.

10161. By Björn Tillenius on 2010-02-10

Merge RF.

10160. By Björn Tillenius on 2010-01-14

Revert changes to test.

10159. By Björn Tillenius on 2010-01-14

Provide more debug output in test.

10158. By Björn Tillenius on 2010-01-14

Possible fix for possible test failure.

10157. By Björn Tillenius on 2010-01-14

Merge RF.

10156. By Björn Tillenius on 2010-01-13

We don't need to monkeypatch to use our TestClass class.

10155. By Björn Tillenius on 2010-01-13

Use r85 of manuel branch.

10154. By Björn Tillenius on 2010-01-13

Use a fixed version of Manuel.

10153. By Björn Tillenius on 2010-01-13

Fix librarianformatter_noca.txt.

=== modified file 'lib/canonical/launchpad/testing/systemdocs.py'
--- lib/canonical/launchpad/testing/systemdocs.py	2009-10-15 11:47:32 +0000
+++ lib/canonical/launchpad/testing/systemdocs.py	2010-02-11 09:45:36 +0000
@@ -19,11 +19,14 @@
 import pprint
 import sys
 
+import manuel.doctest
+import manuel.testing
 import transaction
 from zope.component import getUtility
 from zope.testing import doctest
 from zope.testing.loggingsupport import Handler
 
+
 from canonical.chunkydiff import elided_source
 from canonical.config import config
 from canonical.database.sqlbase import flush_database_updates
@@ -52,17 +55,20 @@
         return path
 
 
-class FilePrefixStrippingDocTestParser(doctest.DocTestParser):
-    """A DocTestParser that strips a prefix from doctests."""
-    def get_doctest(self, string, globs, name, filename, lineno,
-                    optionflags=0):
-        filename = strip_prefix(filename)
-        return doctest.DocTestParser.get_doctest(
-            self, string, globs, name, filename, lineno,
-            optionflags=optionflags)
-
-
-default_parser = FilePrefixStrippingDocTestParser()
+class FilePrefixStrippingTestCase(manuel.testing.TestCase):
+
+    def setUp(self):
+        self.globs['__file__'] = self.regions.location
+        super(FilePrefixStrippingTestCase, self).setUp()
+
+    def shortDescription(self):
+        short_desc = super(
+            FilePrefixStrippingTestCase, self).shortDescription()
+        if short_desc.startswith('/'):
+            short_desc = strip_prefix(short_desc)
+        return short_desc
+
+    __str__ = __repr__ = id = shortDescription
 
 
 class StdoutHandler(Handler):
@@ -78,7 +84,20 @@
             record.levelname, record.name, self.format(record))
 
 
-def LayeredDocFileSuite(*args, **kw):
+def get_manuel_instance(optionflags=None, checker=None,
+                        extra_manuel_plugins=None):
+    """Set up a Manuel instance used for all doctests and return it."""
+    manuel_instance = manuel.doctest.Manuel(
+        optionflags=optionflags,
+        checker=checker)
+    if extra_manuel_plugins is None:
+        extra_manuel_plugins = []
+    for manuel_plugin in extra_manuel_plugins:
+        manuel_instance += manuel_plugin
+    return manuel_instance
+
+
+def LayeredDocFileSuite(*paths, **kw):
     """Create a DocFileSuite, optionally applying a layer to it.
 
     In addition to the standard DocFileSuite arguments, the following
@@ -89,12 +108,13 @@
     :param stdout_logging_level: The logging level for the above.
     :param layer: A Zope test runner layer to apply to the tests (by
       default no layer is applied).
+    :param extra_manuel_plugins: A list of extra Manuel plugins to use,
+      in addition to manuel.doctest.Manuel.
     """
     kw.setdefault('optionflags', default_optionflags)
-    kw.setdefault('parser', default_parser)
 
     # Make sure that paths are resolved relative to our caller
-    kw['package'] = doctest._normalize_module(kw.get('package'))
+    package = doctest._normalize_module(kw.pop('package', None))
 
     # Set stdout_logging keyword argument to True to make
     # logging output be sent to stdout, forcing doctests to deal with it.
@@ -123,7 +143,26 @@
         kw['tearDown'] = tearDown
 
     layer = kw.pop('layer', None)
-    suite = doctest.DocFileSuite(*args, **kw)
+    normalized_paths = []
+    for path in paths:
+        if not path.startswith('/'):
+            path = os.path.join(os.path.dirname(package.__file__), path)
+        normalized_paths.append(path)
+    kw['TestCase'] = FilePrefixStrippingTestCase
+    # Make manuel use zope's doctest, which has a fixed _SpoofOut.write
+    # that encodes the input using utf-8. Without this, tests that write
+    # non-ascii output fail.
+    manuel.doctest.doctest = doctest
+    doctest_optionflags = kw.pop('optionflags', None)
+    suite = manuel.testing.TestSuite(
+        get_manuel_instance(
+            optionflags=doctest_optionflags,
+            checker=kw.pop('checker', None),
+            extra_manuel_plugins=kw.pop('extra_manuel_plugins', None)),
+        *normalized_paths, **kw)
+    # Store the doctest flags on the suite, so that tests can make sure
+    # which option flags were used.
+    suite.doctest_optionflags = doctest_optionflags
     if layer is not None:
         suite.layer = layer
     return suite

=== modified file 'lib/canonical/launchpad/testing/tests/test_pages.py'
--- lib/canonical/launchpad/testing/tests/test_pages.py	2009-06-25 05:30:52 +0000
+++ lib/canonical/launchpad/testing/tests/test_pages.py	2010-02-11 09:45:36 +0000
@@ -42,7 +42,7 @@
         [bar_test, story] = list(suite)
 
         # The unnumbered file appears as an independent test.
-        self.assertEqual(os.path.basename(bar_test.id()), 'xx-bar_txt')
+        self.assertEqual(os.path.basename(bar_test.id()), 'xx-bar.txt')
 
         # The two numbered tests become a story, which appears as a
         # single test case rather than a test suite.

=== modified file 'lib/canonical/launchpad/testing/tests/test_systemdocs.py'
--- lib/canonical/launchpad/testing/tests/test_systemdocs.py	2009-06-25 05:30:52 +0000
+++ lib/canonical/launchpad/testing/tests/test_systemdocs.py	2010-02-11 09:45:36 +0000
@@ -60,9 +60,9 @@
 
         [foo_test, bar_test] = list(suite)
         self.assertTrue(isinstance(foo_test, unittest.TestCase))
-        self.assertEqual(os.path.basename(foo_test.id()), 'foo_txt')
+        self.assertEqual(os.path.basename(foo_test.id()), 'foo.txt')
         self.assertTrue(isinstance(bar_test, unittest.TestCase))
-        self.assertEqual(os.path.basename(bar_test.id()), 'bar_txt')
+        self.assertEqual(os.path.basename(bar_test.id()), 'bar.txt')
         self.runSuite(suite, num_tests=2)
 
     def test_set_layer(self):
@@ -107,13 +107,11 @@
         self.makeTestFile('foo.txt')
         base = os.path.basename(self.tempdir)
         suite = LayeredDocFileSuite(os.path.join(base, 'foo.txt'))
-        [foo_test] = list(suite)
-        self.assertEqual(foo_test._dt_optionflags, default_optionflags)
+        self.assertEqual(suite.doctest_optionflags, default_optionflags)
         # If the optionflags argument is passed, it takes precedence:
         suite = LayeredDocFileSuite(
             os.path.join(base, 'foo.txt'), optionflags=doctest.ELLIPSIS)
-        [foo_test] = list(suite)
-        self.assertEqual(foo_test._dt_optionflags, doctest.ELLIPSIS)
+        self.assertEqual(suite.doctest_optionflags, doctest.ELLIPSIS)
 
     def test_strip_prefix(self):
         """The Launchpad tree root is stripped from test names."""
@@ -126,7 +124,7 @@
         [foo_test] = list(suite)
         # The test ID and string representation have the prefix
         # stripped off.
-        self.assertEqual(foo_test.id(), 'foo_txt')
+        self.assertEqual(foo_test.id(), 'foo.txt')
         self.assertEqual(str(foo_test), 'foo.txt')
         # Tests outside of the Launchpad tree root are left as is:
         config.root = '/nonexistent'

=== modified file 'lib/lp/bugs/browser/tests/buglinktarget-views.txt'
--- lib/lp/bugs/browser/tests/buglinktarget-views.txt	2009-11-07 23:51:59 +0000
+++ lib/lp/bugs/browser/tests/buglinktarget-views.txt	2010-02-11 09:45:36 +0000
@@ -142,7 +142,7 @@
 The notification contains the escaped bug title.
 
     >>> for notification in request.response.notifications:
-    ...     print notification.message.encode('utf8')
+    ...     print notification.message
     Added link to bug #2:
     ...<script>window.alert("Hello!")</script>....
 

=== modified file 'setup.py'
--- setup.py	2010-01-20 22:09:26 +0000
+++ setup.py	2010-02-11 09:45:36 +0000
@@ -42,6 +42,7 @@
         'lazr.testing',
         'lazr.uri',
         'lazr-js',
+        'manuel',
         'mechanize',
         'mercurial',
         'mocker',

=== modified file 'versions.cfg'
--- versions.cfg	2010-02-04 00:29:49 +0000
+++ versions.cfg	2010-02-11 09:45:36 +0000
@@ -35,6 +35,11 @@
 lazr.testing = 0.1.1
 lazr.uri = 1.0.2
 lazr-js = 0.9.2
+# r85 of lp:~bjornt/manuel/launchpad. It includes our patches to allow
+# custom TestCase classes to be used, and not having it break when
+# testing empty documents. Both patches have been submitted upstream,
+# and should be in the next release.
+manuel = 1.0.4-lp-r85
 martian = 0.11
 mechanize = 0.1.11
 mercurial = 1.3.1