← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_registry.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-04 12:10:51 UTC
  • mfrom: (5819.1.4 777007-developer-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20110504121051-aovlsmqiivjmc4fc
(jelmer) Small fixes to developer documentation. (Jonathan Riddell)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_registry.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2008-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the Registry classes"""
18
18
 
20
20
import sys
21
21
 
22
22
from bzrlib import (
23
 
    errors,
 
23
    branch,
 
24
    osutils,
24
25
    registry,
25
 
    osutils,
 
26
    tests,
26
27
    )
27
 
from bzrlib.tests import TestCase, TestCaseInTempDir
28
 
 
29
 
 
30
 
class TestRegistry(TestCase):
 
28
 
 
29
 
 
30
class TestRegistry(tests.TestCase):
31
31
 
32
32
    def register_stuff(self, a_registry):
33
33
        a_registry.register('one', 1)
39
39
        a_registry = registry.Registry()
40
40
        self.register_stuff(a_registry)
41
41
 
42
 
        self.failUnless(a_registry.default_key is None)
 
42
        self.assertTrue(a_registry.default_key is None)
43
43
 
44
 
        # test get() (self.default_key == None)
 
44
        # test get() (self.default_key is None)
45
45
        self.assertRaises(KeyError, a_registry.get)
46
46
        self.assertRaises(KeyError, a_registry.get, None)
47
47
        self.assertEqual(2, a_registry.get('two'))
49
49
 
50
50
        # test _set_default_key
51
51
        a_registry.default_key = 'five'
52
 
        self.failUnless(a_registry.default_key == 'five')
 
52
        self.assertTrue(a_registry.default_key == 'five')
53
53
        self.assertEqual(5, a_registry.get())
54
54
        self.assertEqual(5, a_registry.get(None))
55
55
        # If they ask for a specific entry, they should get KeyError
64
64
        a_registry = registry.Registry()
65
65
        self.register_stuff(a_registry)
66
66
 
67
 
        self.failUnless('one' in a_registry)
 
67
        self.assertTrue('one' in a_registry)
68
68
        a_registry.remove('one')
69
 
        self.failIf('one' in a_registry)
 
69
        self.assertFalse('one' in a_registry)
70
70
        self.assertRaises(KeyError, a_registry.get, 'one')
71
71
 
72
72
        a_registry.register('one', 'one')
187
187
                         ], sorted((key, a_registry.get_info(key))
188
188
                                    for key in a_registry.keys()))
189
189
 
190
 
 
191
 
class TestRegistryWithDirs(TestCaseInTempDir):
 
190
    def test_get_prefix(self):
 
191
        my_registry = registry.Registry()
 
192
        http_object = object()
 
193
        sftp_object = object()
 
194
        my_registry.register('http:', http_object)
 
195
        my_registry.register('sftp:', sftp_object)
 
196
        found_object, suffix = my_registry.get_prefix('http://foo/bar')
 
197
        self.assertEqual('//foo/bar', suffix)
 
198
        self.assertIs(http_object, found_object)
 
199
        self.assertIsNot(sftp_object, found_object)
 
200
        found_object, suffix = my_registry.get_prefix('sftp://baz/qux')
 
201
        self.assertEqual('//baz/qux', suffix)
 
202
        self.assertIs(sftp_object, found_object)
 
203
 
 
204
 
 
205
class TestRegistryIter(tests.TestCase):
 
206
    """Test registry iteration behaviors.
 
207
 
 
208
    There are dark corner cases here when the registered objects trigger
 
209
    addition in the iterated registry.
 
210
    """
 
211
 
 
212
    def setUp(self):
 
213
        super(TestRegistryIter, self).setUp()
 
214
 
 
215
        # We create a registry with "official" objects and "hidden"
 
216
        # objects. The later represent the side effects that led to bug #277048
 
217
        # and #430510
 
218
        self.registry =  registry.Registry()
 
219
 
 
220
        def register_more():
 
221
            self.registry.register('hidden', None)
 
222
 
 
223
        self.registry.register('passive', None)
 
224
        self.registry.register('active', register_more)
 
225
        self.registry.register('passive-too', None)
 
226
 
 
227
        class InvasiveGetter(registry._ObjectGetter):
 
228
 
 
229
            def get_obj(inner_self):
 
230
                # Surprise ! Getting a registered object (think lazy loaded
 
231
                # module) register yet another object !
 
232
                self.registry.register('more hidden', None)
 
233
                return inner_self._obj
 
234
 
 
235
        self.registry.register('hacky', None)
 
236
        # We peek under the covers because the alternative is to use lazy
 
237
        # registration and create a module that can reference our test registry
 
238
        # it's too much work for such a corner case -- vila 090916
 
239
        self.registry._dict['hacky'] = InvasiveGetter(None)
 
240
 
 
241
    def _iter_them(self, iter_func_name):
 
242
        iter_func = getattr(self.registry, iter_func_name, None)
 
243
        self.assertIsNot(None, iter_func)
 
244
        count = 0
 
245
        for name, func in iter_func():
 
246
            count += 1
 
247
            self.assertFalse(name in ('hidden', 'more hidden'))
 
248
            if func is not None:
 
249
                # Using an object register another one as a side effect
 
250
                func()
 
251
        self.assertEqual(4, count)
 
252
 
 
253
    def test_iteritems(self):
 
254
        # the dict is modified during the iteration
 
255
        self.assertRaises(RuntimeError, self._iter_them, 'iteritems')
 
256
 
 
257
    def test_items(self):
 
258
        # we should be able to iterate even if one item modify the dict
 
259
        self._iter_them('items')
 
260
 
 
261
 
 
262
class TestRegistryWithDirs(tests.TestCaseInTempDir):
192
263
    """Registry tests that require temporary dirs"""
193
264
 
194
265
    def create_plugin_file(self, contents):
215
286
            '\n\n'
216
287
        )
217
288
 
 
289
    def test_lazy_import_registry_foo(self):
 
290
        a_registry = registry.Registry()
 
291
        a_registry.register_lazy('foo', 'bzrlib.branch', 'Branch')
 
292
        a_registry.register_lazy('bar', 'bzrlib.branch', 'Branch.hooks')
 
293
        self.assertEqual(branch.Branch, a_registry.get('foo'))
 
294
        self.assertEqual(branch.Branch.hooks, a_registry.get('bar'))
 
295
 
218
296
    def test_lazy_import_registry(self):
219
297
        plugin_name = self.create_simple_plugin()
220
298
        a_registry = registry.Registry()
226
304
        self.assertEqual(['function', 'klass', 'module', 'obj'],
227
305
                         sorted(a_registry.keys()))
228
306
        # The plugin should not be loaded until we grab the first object
229
 
        self.failIf(plugin_name in sys.modules)
 
307
        self.assertFalse(plugin_name in sys.modules)
230
308
 
231
309
        # By default the plugin won't be in the search path
232
310
        self.assertRaises(ImportError, a_registry.get, 'obj')
236
314
        try:
237
315
            obj = a_registry.get('obj')
238
316
            self.assertEqual('foo', obj)
239
 
            self.failUnless(plugin_name in sys.modules)
 
317
            self.assertTrue(plugin_name in sys.modules)
240
318
 
241
319
            # Now grab another object
242
320
            func = a_registry.get('function')
260
338
        finally:
261
339
            sys.path.remove(plugin_path)
262
340
 
 
341
    def test_lazy_import_get_module(self):
 
342
        a_registry = registry.Registry()
 
343
        a_registry.register_lazy('obj', "bzrlib.tests.test_registry",
 
344
            'object1')
 
345
        self.assertEquals("bzrlib.tests.test_registry",
 
346
            a_registry._get_module("obj"))
 
347
 
 
348
    def test_normal_get_module(self):
 
349
        class AThing(object):
 
350
            """Something"""
 
351
        a_registry = registry.Registry()
 
352
        a_registry.register("obj", AThing())
 
353
        self.assertEquals("bzrlib.tests.test_registry",
 
354
            a_registry._get_module("obj"))