Merge lp:~vila/bzr/783472-wt-scenarios into lp:bzr

[Vincent Ladeuil]

Add an helper for per_workingtree scenarios that plugins can reuse

I used to use wt_scenarios in per_workingtree in one of my plugins.

This disappeared recently (the helper wasn't particularly well documented to be honest) and I didn't realize that until recently.

This mp re-introduce the helper.

As mentioned in the bug, this another valid use case to reuse tests and it would be nice to keep it in mind for our other parameterized tests (I don't intend to fix that pro-actively though).

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 05/16/2011 03:42 PM, Vincent Ladeuil wrote:
> Vincent Ladeuil has proposed merging lp:~vila/bzr/783472-wt-scenarios into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
> Related bugs:
> Bug #783472 in Bazaar: "per_working_tree should provide reusable scenarios"
> https://bugs.launchpad.net/bzr/+bug/783472
>
> For more details, see:
> https://code.launchpad.net/~vila/bzr/783472-wt-scenarios/+merge/61117
>
> I used to use wt_scenarios in per_workingtree in one of my plugins.
>
> This disappeared recently (the helper wasn't particularly well documented to be honest) and I didn't realize that until recently.
>
> This mp re-introduce the helper.
>
> As mentioned in the bug, this another valid use case to reuse tests and it would be nice to keep it in mind for our other parameterized tests (I don't intend to fix that pro-actively though).

I'm fine re-introducing this. But if you actually depend on it
externally, it sounds like something that needs a test case so that we
don't delete it without letting people know.

John
=:->

 review:needsfixing

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk3RMCIACgkQJdeBCYSNAAOapACfTfwK7UE4Qbk2cjJ3ccUOMBWh
PqgAoJi46jYJ5MjYSOkPz09PD7ADng75
=UcnS
-----END PGP SIGNATURE-----

[Vincent Ladeuil (vila)]

sent to pqm by email

=== modified file 'bzrlib/tests/per_workingtree/__init__.py'
--- bzrlib/tests/per_workingtree/__init__.py	2011-05-04 11:15:37 +0000
+++ bzrlib/tests/per_workingtree/__init__.py	2011-05-16 15:31:01 +0000
@@ -50,6 +50,22 @@
         }
 
 
+def wt_scenarios():
+    """Returns the scenarios for all registered working trees.
+
+    This can used by plugins that want to define tests against these working
+    trees.
+    """
+    scenarios = make_scenarios(
+        tests.default_transport,
+        # None here will cause a readonly decorator to be created
+        # by the TestCaseWithTransport.get_readonly_transport method.
+        None,
+        workingtree.format_registry._get_all()
+        )
+    return scenarios
+
+
 class TestCaseWithWorkingTree(per_controldir.TestCaseWithControlDir):
 
     def make_branch_and_tree(self, relpath, format=None):
@@ -114,15 +130,16 @@
         'bzrlib.tests.per_workingtree.test_' + name for
         name in test_names]
 
-    scenarios = make_scenarios(
-        tests.default_transport,
-        # None here will cause a readonly decorator to be created
-        # by the TestCaseWithTransport.get_readonly_transport method.
-        None,
-        workingtree.format_registry._get_all()
-        )
+    scenarios = wt_scenarios()
 
     # add the tests for the sub modules
     return tests.multiply_tests(
         loader.loadTestsFromModuleNames(test_workingtree_implementations),
         scenarios, standard_tests)
+
+
+class TestWtScenarios(tests.TestCase):
+
+    def test_protect_wt_scenarios(self):
+        # Just make sure we don't accidentally delete the helper again
+        scenarios = wt_scenarios()

=== modified file 'doc/en/release-notes/bzr-2.4.txt'
--- doc/en/release-notes/bzr-2.4.txt	2011-05-16 11:17:40 +0000
+++ doc/en/release-notes/bzr-2.4.txt	2011-05-16 15:31:01 +0000
@@ -119,6 +119,9 @@
    suite.  This can include new facilities for writing tests, fixes to 
    spurious test failures and changes to the way things should be tested.
 
+* Make it easier for plugins to reuse the per_workingtree scenarios by
+  restoring the wt_scenarios helper that was accidentally deleted.
+  (Vincent Ladeuil, #783472)
 
 bzr 2.4b2
 #########