Merge lp:~allenap/launchpad/id-for-yui-test-cases into lp:launchpad

[Gavin Panella]

[r=jml][no-qa] Implement YUIUnitTestCase.id() so that YUI tests have a distinctive identifier.

This branch fixes the following:

{{{
$ bin/test --layer WindmillLayer -t yuitest --list-tests
Listing lp.app.windmill.testing.AppWindmillLayer tests:
  lp.app.windmill.tests.test_yuitests.AppYUIUnitTestCase.runTest
  lp.app.windmill.tests.test_yuitests.AppYUIUnitTestCase.runTest
Listing lp.bugs.windmill.testing.BugsWindmillLayer tests:
  lp.bugs.windmill.tests.test_yuitests.BugsYUIUnitTestCase.runTest
  lp.bugs.windmill.tests.test_yuitests.BugsYUIUnitTestCase.runTest
Listing lp.code.windmill.testing.CodeWindmillLayer tests:
  lp.code.windmill.tests.test_yuitests.CodeYUIUnitTestCase.runTest
Listing lp.registry.windmill.testing.RegistryWindmillLayer tests:
  lp.registry.windmill.tests.test_yuitests.RegistryYUIUnitTestCase.runTest
  lp.registry.windmill.tests.test_yuitests.RegistryYUIUnitTestCase.runTest
  lp.registry.windmill.tests.test_yuitests.RegistryYUIUnitTestCase.runTest
Listing lp.soyuz.windmill.testing.SoyuzWindmillLayer tests:
  lp.soyuz.windmill.tests.test_yuitests.SoyuzYUIUnitTestCase.runTest
  lp.soyuz.windmill.tests.test_yuitests.SoyuzYUIUnitTestCase.runTest
}}}

to look more like:

{{{
$ bin/test --layer WindmillLayer -t javascript/tests --list-tests
Listing lp.app.windmill.testing.AppWindmillLayer tests:
  lp/app/javascript/tests/test_lp_collapsibles.html
  lp/app/javascript/tests/test_lp_client.html
Listing lp.bugs.windmill.testing.BugsWindmillLayer tests:
  lp/bugs/javascript/tests/test_me_too.html
  lp/bugs/javascript/tests/test_subscriber.html
Listing lp.code.windmill.testing.CodeWindmillLayer tests:
  lp/code/javascript/tests/test_productseries-setbranch.html
Listing lp.registry.windmill.testing.RegistryWindmillLayer tests:
  lp/registry/javascript/tests/test_milestone_table.html
  lp/registry/javascript/tests/test_timeline.html
Listing lp.soyuz.windmill.testing.SoyuzWindmillLayer tests:
  lp/soyuz/javascript/tests/test_archivesubscribers_index.html
  lp/soyuz/javascript/tests/test_lp_dynamic_dom_updater.html
}}}

[Jonathan Lange (jml)]

<jml> allenap: Looks basically sane to me. Two things come to mind.
<jml> allenap: first is that you should add a test for this.
<jml> allenap: second is that the ideal id() allows you to load the test based on the id. I don't know enough about how JS tests are run to know if that's the case here. It seems likely though.
<allenap> jml: Fair. This whole class is untested so I was hoping to sneak this one through too.
<jml> allenap: self.assertEqual(test.test_path, test.id())
<jml> allenap: there you go, I've written the test for you :P
<allenap> jml: Cheers :)
<jml> also, in random spam news, I may be entitled to receive £3750 for the accident I had. (I didn't have an accident)
<jml> allenap: looks like a very useful change to make

I would have made the ID for like foo.bar.baz than foo/bar/baz.html, but I think that's actually not necessary, and maybe not even universally preferable. The general principles are uniqueness and being able to load the test based on the id.

Thanks Gavin.

review: Approve

=== modified file 'lib/lp/testing/__init__.py'
--- lib/lp/testing/__init__.py	2011-03-21 09:15:49 +0000
+++ lib/lp/testing/__init__.py	2011-03-21 16:08:30 +0000
@@ -840,9 +840,21 @@
 
     _yui_results = None
 
+    def __init__(self):
+        """Create a new test case without a choice of test method name.
+
+        Preventing the choice of test method ensures that we can safely
+        provide a test ID based on the file path.
+        """
+        super(YUIUnitTestCase, self).__init__("checkResults")
+
     def initialize(self, test_path):
         self.test_path = test_path
 
+    def id(self):
+        """Return an ID for this test based on the file path."""
+        return self.test_path
+
     def setUp(self):
         super(YUIUnitTestCase, self).setUp()
         #This goes here to prevent circular import issues
@@ -874,7 +886,12 @@
             self._yui_results[test_name] = dict(
                 result=result, message=message)
 
-    def runTest(self):
+    def checkResults(self):
+        """Check the results.
+
+        The tests are run during `setUp()`, but failures need to be reported
+        from here.
+        """
         if self._yui_results is None or len(self._yui_results) == 0:
             self.fail("Test harness or js failed.")
         for test_name in self._yui_results:

=== modified file 'lib/lp/testing/tests/test_testing.py'
--- lib/lp/testing/tests/test_testing.py	2010-10-26 15:47:24 +0000
+++ lib/lp/testing/tests/test_testing.py	2011-03-21 16:08:30 +0000
@@ -5,14 +5,13 @@
 
 __metaclass__ = type
 
-import unittest
-
 from canonical.testing.layers import DatabaseFunctionalLayer
 from lp.services.features import getFeatureFlag
 from lp.testing import (
     feature_flags,
     set_feature_flag,
     TestCase,
+    YUIUnitTestCase,
     )
 
 
@@ -37,5 +36,9 @@
         self.assertIs(None, getFeatureFlag('name'))
 
 
-def test_suite():
-    return unittest.TestLoader().loadTestsFromName(__name__)
+class TestYUIUnitTestCase(TestCase):
+
+    def test_id(self):
+        test = YUIUnitTestCase()
+        test.initialize("foo/bar/baz.html")
+        self.assertEqual(test.test_path, test.id())