Merge lp:~free.ekanayaka/python-zope-fixtures/utility-fixture into lp:python-zope-fixtures

[Free Ekanayaka]

This branch:

- Renames zope_fixtures.zoperegistry.ZopeRegistryFixture to zope_fixtures.components.ComponentsFixture, to make it more clear that the APIs of interest are the ones provided by zope.components, and because the Zope prefix seems now redundant.

- Adds a new UtilityFixture, which is merely a convenience around ComponentsFixture for overriding a single utility, reducing boilerplate code for this common use case.

[Robert Collins (lifeless)]

This needs some docs in README; I'll add that as I merge.

[Robert Collins (lifeless)]

Oh, and __all__ updated.

[Robert Collins (lifeless)]

Oh, and as you're stacking on a fixture, useFixture is handy :)

    def setUp(self):
        super(UtilityFixture, self).setUp()
        components = self.useFixture(ComponentsFixture())
        components.registry.registerUtility(*self.args, **self.kwargs)

=== modified file 'lib/zope_fixtures/__init__.py'
--- lib/zope_fixtures/__init__.py	2011-11-22 12:31:11 +0000
+++ lib/zope_fixtures/__init__.py	2011-11-23 09:17:39 +0000
@@ -34,10 +34,11 @@
 __version__ = (0, 0, 1, 'beta', 0)
 
 __all__ = [
-    'ZopeRegistryFixture',
+    'ComponentsFixture',
+    'UtilityFixture',
     ]
 
-from zope_fixtures.zoperegistry import ZopeRegistryFixture
+from zope_fixtures.components import ComponentsFixture, UtilityFixture
 
 
 def test_suite():

=== renamed file 'lib/zope_fixtures/zoperegistry.py' => 'lib/zope_fixtures/components.py'
--- lib/zope_fixtures/zoperegistry.py	2011-11-22 12:31:11 +0000
+++ lib/zope_fixtures/components.py	2011-11-23 09:17:39 +0000
@@ -14,7 +14,7 @@
 # limitations under that license.
 
 __all__ = [
-    'ZopeRegistryFixture'
+    'ComponentsFixture'
     ]
 
 from fixtures import Fixture
@@ -24,7 +24,7 @@
 getSiteManager = try_import("zope.component.getSiteManager")
 
 
-class ZopeRegistryFixture(Fixture):
+class ComponentsFixture(Fixture):
     """Overlay the global Zope registry so that tests don't change it.
 
     :ivar registry: An alternate Zope registry that can be used to override
@@ -37,15 +37,34 @@
         class TestSomething(TestCase):
 
             def test_registry(self):
-                self.useFixture(ZopeRegistryFixture())
+                self.useFixture(ComponentsFixture())
                 getSiteManager().registerUtility(...)
                 # more code here
     """
 
     def setUp(self):
-        super(ZopeRegistryFixture, self).setUp()
+        super(ComponentsFixture, self).setUp()
         self.registry = Components(bases=(getSiteManager(),))
         getSiteManager.sethook(lambda context=None: self.registry)
         self.addCleanup(getSiteManager.reset)
 
 
+class UtilityFixture(Fixture):
+    """Convenience around ComponentsFixture to override a single utility."""
+
+    def __init__(self, *args, **kwargs):
+        """Create an UtilityFixture.
+
+        The args and kwargs parameters are the same supported by
+        registerUtility and will be passed to it.
+        """
+        super(UtilityFixture, self).__init__()
+        self.args = args
+        self.kwargs = kwargs
+
+    def setUp(self):
+        super(UtilityFixture, self).setUp()
+        components = ComponentsFixture()
+        components.setUp()
+        components.registry.registerUtility(*self.args, **self.kwargs)
+        self.addCleanup(components.cleanUp)

=== renamed file 'lib/zope_fixtures/tests/test_zoperegistry.py' => 'lib/zope_fixtures/tests/test_components.py'
--- lib/zope_fixtures/tests/test_zoperegistry.py	2011-11-22 12:31:11 +0000
+++ lib/zope_fixtures/tests/test_components.py	2011-11-23 09:17:39 +0000
@@ -18,7 +18,7 @@
 from zope.interface import Interface, implements
 from zope.component import provideUtility, queryUtility, getSiteManager
 
-from zope_fixtures import ZopeRegistryFixture
+from zope_fixtures import ComponentsFixture, UtilityFixture
 
 
 class ITestUtility(Interface):
@@ -29,25 +29,25 @@
     implements(ITestUtility)
 
 
-class TestZopeRegistry(testtools.TestCase):
+class TestComponentsFixture(testtools.TestCase):
 
     def test_overlays_site_manager(self):
         # A custom site manager is installed.
-        fixture = ZopeRegistryFixture()
+        fixture = ComponentsFixture()
         original_registry = getSiteManager()
         self.useFixture(fixture)
         self.assertIs(fixture.registry, getSiteManager())
         self.assertIn(original_registry, fixture.registry.__bases__)
 
     def test_restores_site_manager(self):
-        fixture = ZopeRegistryFixture()
+        fixture = ComponentsFixture()
         original_registry = getSiteManager()
         with fixture:
             self.assertIs(fixture.registry, getSiteManager())
         self.assertIs(original_registry, getSiteManager())
 
     def test_provide_utility_against_fixture_registry(self):
-        fixture = ZopeRegistryFixture()
+        fixture = ComponentsFixture()
         original_registry = getSiteManager()
         self.useFixture(fixture)
         utility = TestUtility()
@@ -57,11 +57,34 @@
         self.assertIs(None, original_registry.queryUtility(ITestUtility))
 
     def test_restores_original_registry(self):
-        fixture = ZopeRegistryFixture()
+        fixture = ComponentsFixture()
+        original_registry = getSiteManager()
         original_utility = TestUtility()
         provideUtility(original_utility)
+        self.addCleanup(original_registry.unregisterUtility, original_utility)
         with fixture:
             overridden_utility = TestUtility()
             fixture.registry.registerUtility(overridden_utility)
             self.assertIs(overridden_utility, queryUtility(ITestUtility))
         self.assertIs(original_utility, queryUtility(ITestUtility))
+
+
+class TestUtilityFixture(testtools.TestCase):
+
+    def test_provide_utility(self):
+        utility = TestUtility()
+        fixture = UtilityFixture(utility)
+        self.useFixture(fixture)
+        self.assertIs(utility, queryUtility(ITestUtility))
+
+    def test_restore_utility(self):
+        utility = TestUtility()
+        with UtilityFixture(utility):
+            self.assertIs(utility, queryUtility(ITestUtility))
+        self.assertIs(None, queryUtility(ITestUtility))
+
+    def test_arguments_passthrough(self):
+        utility = TestUtility()
+        fixture = UtilityFixture(utility, name="foo")
+        self.useFixture(fixture)
+        self.assertIs(utility, queryUtility(ITestUtility, name="foo"))