1
# Copyright (C) 2006 Canonical Ltd
1
# Copyright (C) 2006, 2008-2012, 2016 Canonical Ltd
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
39
41
a_registry = registry.Registry()
40
42
self.register_stuff(a_registry)
42
self.failUnless(a_registry.default_key is None)
44
self.assertTrue(a_registry.default_key is None)
44
46
# test get() (self.default_key is None)
45
47
self.assertRaises(KeyError, a_registry.get)
50
52
# test _set_default_key
51
53
a_registry.default_key = 'five'
52
self.failUnless(a_registry.default_key == 'five')
54
self.assertTrue(a_registry.default_key == 'five')
53
55
self.assertEqual(5, a_registry.get())
54
56
self.assertEqual(5, a_registry.get(None))
55
57
# If they ask for a specific entry, they should get KeyError
64
66
a_registry = registry.Registry()
65
67
self.register_stuff(a_registry)
67
self.failUnless('one' in a_registry)
69
self.assertTrue('one' in a_registry)
68
70
a_registry.remove('one')
69
self.failIf('one' in a_registry)
71
self.assertFalse('one' in a_registry)
70
72
self.assertRaises(KeyError, a_registry.get, 'one')
72
74
a_registry.register('one', 'one')
82
84
a_registry.register('one', 'one')
83
85
self.assertRaises(KeyError, a_registry.register, 'one', 'two')
84
86
self.assertRaises(KeyError, a_registry.register, 'one', 'two',
85
override_existing=False)
87
override_existing=False)
87
89
a_registry.register('one', 'two', override_existing=True)
88
90
self.assertEqual('two', a_registry.get('one'))
144
147
('six', 'this is my help'),
145
148
('three', 'generic help for three'),
146
149
('two', 'help text for two'),
147
], sorted((key, a_registry.get_help(key))
150
], sorted((key, a_registry.get_help(key))
148
151
for key in a_registry.keys()))
150
153
# We don't know what order it was called in, but we should get
184
187
('one', 'string info'),
185
188
('three', ['a', 'list']),
187
], sorted((key, a_registry.get_info(key))
190
], sorted((key, a_registry.get_info(key))
188
191
for key in a_registry.keys()))
190
193
def test_get_prefix(self):
201
204
self.assertEqual('//baz/qux', suffix)
202
205
self.assertIs(sftp_object, found_object)
207
def test_registry_alias(self):
208
a_registry = registry.Registry()
209
a_registry.register('one', 1, info='string info')
210
a_registry.register_alias('two', 'one')
211
a_registry.register_alias('three', 'one', info='own info')
212
self.assertEqual(a_registry.get('one'), a_registry.get('two'))
213
self.assertEqual(a_registry.get_help('one'),
214
a_registry.get_help('two'))
215
self.assertEqual(a_registry.get_info('one'),
216
a_registry.get_info('two'))
217
self.assertEqual('own info', a_registry.get_info('three'))
218
self.assertEqual({'two': 'one', 'three': 'one'}, a_registry.aliases())
220
{'one': ['three', 'two']},
221
{k: sorted(v) for (k, v) in viewitems(a_registry.alias_map())})
223
def test_registry_alias_exists(self):
224
a_registry = registry.Registry()
225
a_registry.register('one', 1, info='string info')
226
a_registry.register('two', 2)
227
self.assertRaises(KeyError, a_registry.register_alias, 'one', 'one')
229
def test_registry_alias_targetmissing(self):
230
a_registry = registry.Registry()
231
self.assertRaises(KeyError, a_registry.register_alias, 'one', 'two')
205
234
class TestRegistryIter(tests.TestCase):
206
235
"""Test registry iteration behaviors.
215
244
# We create a registry with "official" objects and "hidden"
216
245
# objects. The later represent the side effects that led to bug #277048
218
self.registry = registry.Registry()
247
_registry = registry.Registry()
220
249
def register_more():
221
self.registry.register('hidden', None)
250
_registry.register('hidden', None)
252
# Avoid closing over self by binding local variable
253
self.registry = _registry
223
254
self.registry.register('passive', None)
224
255
self.registry.register('active', register_more)
225
256
self.registry.register('passive-too', None)
229
260
def get_obj(inner_self):
230
261
# Surprise ! Getting a registered object (think lazy loaded
231
262
# module) register yet another object !
232
self.registry.register('more hidden', None)
263
_registry.register('more hidden', None)
233
264
return inner_self._obj
235
266
self.registry.register('hacky', None)
272
303
plugin_name = 'bzr_plugin_a_%s' % (osutils.rand_chars(4),)
273
open('tmp/'+plugin_name+'.py', 'wb').write(contents)
304
with open('tmp/' + plugin_name + '.py', 'wb') as f:
274
306
return plugin_name
276
308
def create_simple_plugin(self):
277
309
return self.create_plugin_file(
280
'def function(a,b,c):\n'
283
'class MyClass(object):\n'
284
' def __init__(self, a):\n'
312
b'def function(a,b,c):\n'
315
b'class MyClass(object):\n'
316
b' def __init__(self, a):\n'
321
def test_lazy_import_registry_foo(self):
322
a_registry = registry.Registry()
323
a_registry.register_lazy('foo', 'breezy.branch', 'Branch')
324
a_registry.register_lazy('bar', 'breezy.branch', 'Branch.hooks')
325
self.assertEqual(branch.Branch, a_registry.get('foo'))
326
self.assertEqual(branch.Branch.hooks, a_registry.get('bar'))
289
328
def test_lazy_import_registry(self):
290
329
plugin_name = self.create_simple_plugin()
291
330
a_registry = registry.Registry()
297
336
self.assertEqual(['function', 'klass', 'module', 'obj'],
298
337
sorted(a_registry.keys()))
299
338
# The plugin should not be loaded until we grab the first object
300
self.failIf(plugin_name in sys.modules)
339
self.assertFalse(plugin_name in sys.modules)
302
341
# By default the plugin won't be in the search path
303
342
self.assertRaises(ImportError, a_registry.get, 'obj')
305
plugin_path = os.getcwd() + '/tmp'
344
plugin_path = self.test_dir + '/tmp'
306
345
sys.path.append(plugin_path)
308
347
obj = a_registry.get('obj')
309
348
self.assertEqual('foo', obj)
310
self.failUnless(plugin_name in sys.modules)
349
self.assertTrue(plugin_name in sys.modules)
312
351
# Now grab another object
313
352
func = a_registry.get('function')
332
371
sys.path.remove(plugin_path)
373
def test_lazy_import_get_module(self):
374
a_registry = registry.Registry()
375
a_registry.register_lazy('obj', "breezy.tests.test_registry",
377
self.assertEqual("breezy.tests.test_registry",
378
a_registry._get_module("obj"))
380
def test_normal_get_module(self):
381
class AThing(object):
383
a_registry = registry.Registry()
384
a_registry.register("obj", AThing())
385
self.assertEqual("breezy.tests.test_registry",
386
a_registry._get_module("obj"))