← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_registry.py

[merge] fix \t in commit messages

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_registry.py
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
"""Tests for the Registry classes"""
18
 
 
19
 
import os
20
 
import sys
21
 
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    registry,
25
 
    osutils,
26
 
    )
27
 
from bzrlib.tests import TestCase, TestCaseInTempDir
28
 
 
29
 
 
30
 
class TestRegistry(TestCase):
31
 
 
32
 
    def register_stuff(self, a_registry):
33
 
        a_registry.register('one', 1)
34
 
        a_registry.register('two', 2)
35
 
        a_registry.register('four', 4)
36
 
        a_registry.register('five', 5)
37
 
 
38
 
    def test_registry(self):
39
 
        a_registry = registry.Registry()
40
 
        self.register_stuff(a_registry)
41
 
 
42
 
        self.failUnless(a_registry.default_key is None)
43
 
 
44
 
        # test get() (self.default_key is None)
45
 
        self.assertRaises(KeyError, a_registry.get)
46
 
        self.assertRaises(KeyError, a_registry.get, None)
47
 
        self.assertEqual(2, a_registry.get('two'))
48
 
        self.assertRaises(KeyError, a_registry.get, 'three')
49
 
 
50
 
        # test _set_default_key
51
 
        a_registry.default_key = 'five'
52
 
        self.failUnless(a_registry.default_key == 'five')
53
 
        self.assertEqual(5, a_registry.get())
54
 
        self.assertEqual(5, a_registry.get(None))
55
 
        # If they ask for a specific entry, they should get KeyError
56
 
        # not the default value. They can always pass None if they prefer
57
 
        self.assertRaises(KeyError, a_registry.get, 'six')
58
 
        self.assertRaises(KeyError, a_registry._set_default_key, 'six')
59
 
 
60
 
        # test keys()
61
 
        self.assertEqual(['five', 'four', 'one', 'two'], a_registry.keys())
62
 
 
63
 
    def test_registry_funcs(self):
64
 
        a_registry = registry.Registry()
65
 
        self.register_stuff(a_registry)
66
 
 
67
 
        self.failUnless('one' in a_registry)
68
 
        a_registry.remove('one')
69
 
        self.failIf('one' in a_registry)
70
 
        self.assertRaises(KeyError, a_registry.get, 'one')
71
 
 
72
 
        a_registry.register('one', 'one')
73
 
 
74
 
        self.assertEqual(['five', 'four', 'one', 'two'],
75
 
                         sorted(a_registry.keys()))
76
 
        self.assertEqual([('five', 5), ('four', 4),
77
 
                          ('one', 'one'), ('two', 2)],
78
 
                         sorted(a_registry.iteritems()))
79
 
 
80
 
    def test_register_override(self):
81
 
        a_registry = registry.Registry()
82
 
        a_registry.register('one', 'one')
83
 
        self.assertRaises(KeyError, a_registry.register, 'one', 'two')
84
 
        self.assertRaises(KeyError, a_registry.register, 'one', 'two',
85
 
                                    override_existing=False)
86
 
 
87
 
        a_registry.register('one', 'two', override_existing=True)
88
 
        self.assertEqual('two', a_registry.get('one'))
89
 
 
90
 
        self.assertRaises(KeyError, a_registry.register_lazy,
91
 
                          'one', 'three', 'four')
92
 
 
93
 
        a_registry.register_lazy('one', 'module', 'member',
94
 
                                 override_existing=True)
95
 
 
96
 
    def test_registry_help(self):
97
 
        a_registry = registry.Registry()
98
 
        a_registry.register('one', 1, help='help text for one')
99
 
        # We should not have to import the module to return the help
100
 
        # information
101
 
        a_registry.register_lazy('two', 'nonexistent_module', 'member',
102
 
                                 help='help text for two')
103
 
 
104
 
        # We should be able to handle a callable to get information
105
 
        help_calls = []
106
 
        def generic_help(reg, key):
107
 
            help_calls.append(key)
108
 
            return 'generic help for %s' % (key,)
109
 
        a_registry.register('three', 3, help=generic_help)
110
 
        a_registry.register_lazy('four', 'nonexistent_module', 'member2',
111
 
                                 help=generic_help)
112
 
        a_registry.register('five', 5)
113
 
 
114
 
        def help_from_object(reg, key):
115
 
            obj = reg.get(key)
116
 
            return obj.help()
117
 
 
118
 
        class SimpleObj(object):
119
 
            def help(self):
120
 
                return 'this is my help'
121
 
        a_registry.register('six', SimpleObj(), help=help_from_object)
122
 
 
123
 
        self.assertEqual('help text for one', a_registry.get_help('one'))
124
 
        self.assertEqual('help text for two', a_registry.get_help('two'))
125
 
        self.assertEqual('generic help for three',
126
 
                         a_registry.get_help('three'))
127
 
        self.assertEqual(['three'], help_calls)
128
 
        self.assertEqual('generic help for four',
129
 
                         a_registry.get_help('four'))
130
 
        self.assertEqual(['three', 'four'], help_calls)
131
 
        self.assertEqual(None, a_registry.get_help('five'))
132
 
        self.assertEqual('this is my help', a_registry.get_help('six'))
133
 
 
134
 
        self.assertRaises(KeyError, a_registry.get_help, None)
135
 
        self.assertRaises(KeyError, a_registry.get_help, 'seven')
136
 
 
137
 
        a_registry.default_key = 'one'
138
 
        self.assertEqual('help text for one', a_registry.get_help(None))
139
 
        self.assertRaises(KeyError, a_registry.get_help, 'seven')
140
 
 
141
 
        self.assertEqual([('five', None),
142
 
                          ('four', 'generic help for four'),
143
 
                          ('one', 'help text for one'),
144
 
                          ('six', 'this is my help'),
145
 
                          ('three', 'generic help for three'),
146
 
                          ('two', 'help text for two'),
147
 
                         ], sorted((key, a_registry.get_help(key))
148
 
                                    for key in a_registry.keys()))
149
 
 
150
 
        # We don't know what order it was called in, but we should get
151
 
        # 2 more calls to three and four
152
 
        self.assertEqual(['four', 'four', 'three', 'three'],
153
 
                         sorted(help_calls))
154
 
 
155
 
    def test_registry_info(self):
156
 
        a_registry = registry.Registry()
157
 
        a_registry.register('one', 1, info='string info')
158
 
        # We should not have to import the module to return the info
159
 
        a_registry.register_lazy('two', 'nonexistent_module', 'member',
160
 
                                 info=2)
161
 
 
162
 
        # We should be able to handle a callable to get information
163
 
        a_registry.register('three', 3, info=['a', 'list'])
164
 
        obj = object()
165
 
        a_registry.register_lazy('four', 'nonexistent_module', 'member2',
166
 
                                 info=obj)
167
 
        a_registry.register('five', 5)
168
 
 
169
 
        self.assertEqual('string info', a_registry.get_info('one'))
170
 
        self.assertEqual(2, a_registry.get_info('two'))
171
 
        self.assertEqual(['a', 'list'], a_registry.get_info('three'))
172
 
        self.assertIs(obj, a_registry.get_info('four'))
173
 
        self.assertIs(None, a_registry.get_info('five'))
174
 
 
175
 
        self.assertRaises(KeyError, a_registry.get_info, None)
176
 
        self.assertRaises(KeyError, a_registry.get_info, 'six')
177
 
 
178
 
        a_registry.default_key = 'one'
179
 
        self.assertEqual('string info', a_registry.get_info(None))
180
 
        self.assertRaises(KeyError, a_registry.get_info, 'six')
181
 
 
182
 
        self.assertEqual([('five', None),
183
 
                          ('four', obj),
184
 
                          ('one', 'string info'),
185
 
                          ('three', ['a', 'list']),
186
 
                          ('two', 2),
187
 
                         ], sorted((key, a_registry.get_info(key))
188
 
                                    for key in a_registry.keys()))
189
 
 
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 TestRegistryWithDirs(TestCaseInTempDir):
206
 
    """Registry tests that require temporary dirs"""
207
 
 
208
 
    def create_plugin_file(self, contents):
209
 
        """Create a file to be used as a plugin.
210
 
 
211
 
        This is created in a temporary directory, so that we
212
 
        are sure that it doesn't start in the plugin path.
213
 
        """
214
 
        os.mkdir('tmp')
215
 
        plugin_name = 'bzr_plugin_a_%s' % (osutils.rand_chars(4),)
216
 
        open('tmp/'+plugin_name+'.py', 'wb').write(contents)
217
 
        return plugin_name
218
 
 
219
 
    def create_simple_plugin(self):
220
 
        return self.create_plugin_file(
221
 
            'object1 = "foo"\n'
222
 
            '\n\n'
223
 
            'def function(a,b,c):\n'
224
 
            '    return a,b,c\n'
225
 
            '\n\n'
226
 
            'class MyClass(object):\n'
227
 
            '    def __init__(self, a):\n'
228
 
            '      self.a = a\n'
229
 
            '\n\n'
230
 
        )
231
 
 
232
 
    def test_lazy_import_registry(self):
233
 
        plugin_name = self.create_simple_plugin()
234
 
        a_registry = registry.Registry()
235
 
        a_registry.register_lazy('obj', plugin_name, 'object1')
236
 
        a_registry.register_lazy('function', plugin_name, 'function')
237
 
        a_registry.register_lazy('klass', plugin_name, 'MyClass')
238
 
        a_registry.register_lazy('module', plugin_name, None)
239
 
 
240
 
        self.assertEqual(['function', 'klass', 'module', 'obj'],
241
 
                         sorted(a_registry.keys()))
242
 
        # The plugin should not be loaded until we grab the first object
243
 
        self.failIf(plugin_name in sys.modules)
244
 
 
245
 
        # By default the plugin won't be in the search path
246
 
        self.assertRaises(ImportError, a_registry.get, 'obj')
247
 
 
248
 
        plugin_path = os.getcwd() + '/tmp'
249
 
        sys.path.append(plugin_path)
250
 
        try:
251
 
            obj = a_registry.get('obj')
252
 
            self.assertEqual('foo', obj)
253
 
            self.failUnless(plugin_name in sys.modules)
254
 
 
255
 
            # Now grab another object
256
 
            func = a_registry.get('function')
257
 
            self.assertEqual(plugin_name, func.__module__)
258
 
            self.assertEqual('function', func.__name__)
259
 
            self.assertEqual((1, [], '3'), func(1, [], '3'))
260
 
 
261
 
            # And finally a class
262
 
            klass = a_registry.get('klass')
263
 
            self.assertEqual(plugin_name, klass.__module__)
264
 
            self.assertEqual('MyClass', klass.__name__)
265
 
 
266
 
            inst = klass(1)
267
 
            self.assertIsInstance(inst, klass)
268
 
            self.assertEqual(1, inst.a)
269
 
 
270
 
            module = a_registry.get('module')
271
 
            self.assertIs(obj, module.object1)
272
 
            self.assertIs(func, module.function)
273
 
            self.assertIs(klass, module.MyClass)
274
 
        finally:
275
 
            sys.path.remove(plugin_path)
276