Merge lp:~allenap/launchpad/sensible-test-ids-for-doctests into lp:launchpad

[Gavin Panella]

[r=jml][bug=682771][no-qa] To avoid conflicts, LayeredDocFileSuite now patches test cases to use the filename with path as test ID.

From a new comment in LayeredDocFileSuite:

  DocFileTest insists on using the basename of the file as the test
  ID. This causes conflicts when two doctests have the same filename,
  so we patch the id() method on the test cases.

This branch does not fix the related bug - it does not modify the test
runner - but it does alleviate the symptoms. Something like this is
needed before the linked bug can be fixed in any case.

[Jonathan Lange (jml)]

This is awesome. In addition to making parallelizing tests that little bit more effective, you can tweak it just a little to normalize the path that is the docstring id(). That would make "./bin/test -cvvt doc/branch.txt" actually work!

            test.id = lambda: os.path.normpath(repr(test))

Works for me, but you could do something fancier, I guess.

review: Approve

=== modified file 'lib/canonical/launchpad/testing/systemdocs.py'
--- lib/canonical/launchpad/testing/systemdocs.py	2011-02-17 16:38:15 +0000
+++ lib/canonical/launchpad/testing/systemdocs.py	2011-04-02 21:29:36 +0000
@@ -15,6 +15,7 @@
     ]
 
 import doctest
+from functools import partial
 import logging
 import os
 import pdb
@@ -136,6 +137,13 @@
     suite = doctest.DocFileSuite(*args, **kw)
     if layer is not None:
         suite.layer = layer
+
+    # DocFileTest insists on using the basename of the file as the test
+    # ID. This causes conflicts when two doctests have the same filename, so
+    # we patch the id() method on the test cases.
+    for test in suite:
+        test.id = partial(os.path.normpath, test._dt_test.filename)
+
     return suite
 
 

=== modified file 'lib/canonical/launchpad/testing/tests/test_pages.py'
--- lib/canonical/launchpad/testing/tests/test_pages.py	2010-10-14 19:49:00 +0000
+++ lib/canonical/launchpad/testing/tests/test_pages.py	2011-04-02 21:29:36 +0000
@@ -45,7 +45,7 @@
         bar_test, story = iter_suite_tests(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	2010-08-20 20:31:18 +0000
+++ lib/canonical/launchpad/testing/tests/test_systemdocs.py	2011-04-02 21:29:36 +0000
@@ -61,9 +61,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):
@@ -127,7 +127,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'