/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_hooks.py

Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_hooks.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2012, 2016 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
16
16
 
17
17
"""Tests for the core Hooks logic."""
18
18
 
19
 
from bzrlib import (
 
19
from .. import (
20
20
    branch,
21
21
    errors,
 
22
    hooks as _mod_hooks,
 
23
    pyutils,
22
24
    tests,
23
25
    )
24
 
from bzrlib.hooks import (
 
26
from ..hooks import (
25
27
    HookPoint,
26
28
    Hooks,
 
29
    UnknownHook,
 
30
    install_lazy_named_hook,
27
31
    known_hooks,
28
32
    known_hooks_key_to_object,
29
 
    known_hooks_key_to_parent_and_attribute,
30
33
    )
31
34
 
32
35
 
 
36
class TestErrors(tests.TestCase):
 
37
 
 
38
    def test_unknown_hook(self):
 
39
        error = UnknownHook("branch", "foo")
 
40
        self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
 
41
                             " of breezy.",
 
42
                             str(error))
 
43
        error = UnknownHook("tree", "bar")
 
44
        self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
 
45
                             " of breezy.",
 
46
                             str(error))
 
47
 
 
48
 
33
49
class TestHooks(tests.TestCase):
34
50
 
35
 
    def test_create_hook_first(self):
36
 
        hooks = Hooks()
37
 
        doc = ("Invoked after changing the tip of a branch object. Called with"
38
 
            "a bzrlib.branch.PostChangeBranchTipParams object")
39
 
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
40
 
        hooks.create_hook(hook)
41
 
        self.assertEqual(hook, hooks['post_tip_change'])
42
 
 
43
 
    def test_create_hook_name_collision_errors(self):
44
 
        hooks = Hooks()
45
 
        doc = ("Invoked after changing the tip of a branch object. Called with"
46
 
            "a bzrlib.branch.PostChangeBranchTipParams object")
47
 
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
48
 
        hook2 = HookPoint("post_tip_change", None, None, None)
49
 
        hooks.create_hook(hook)
50
 
        self.assertRaises(errors.DuplicateKey, hooks.create_hook, hook2)
51
 
        self.assertEqual(hook, hooks['post_tip_change'])
52
 
 
53
51
    def test_docs(self):
54
52
        """docs() should return something reasonable about the Hooks."""
55
53
        class MyHooks(Hooks):
56
54
            pass
57
 
        hooks = MyHooks()
 
55
        hooks = MyHooks("breezy.tests.test_hooks", "some_hooks")
58
56
        hooks['legacy'] = []
59
 
        hook1 = HookPoint('post_tip_change',
60
 
            "Invoked after the tip of a branch changes. Called with "
61
 
            "a ChangeBranchTipParams object.", (1, 4), None)
62
 
        hook2 = HookPoint('pre_tip_change',
63
 
            "Invoked before the tip of a branch changes. Called with "
64
 
            "a ChangeBranchTipParams object. Hooks should raise "
65
 
            "TipChangeRejected to signal that a tip change is not permitted.",
66
 
            (1, 6), None)
67
 
        hooks.create_hook(hook1)
68
 
        hooks.create_hook(hook2)
 
57
        hooks.add_hook('post_tip_change',
 
58
                       "Invoked after the tip of a branch changes. Called with "
 
59
                       "a ChangeBranchTipParams object.", (1, 4))
 
60
        hooks.add_hook('pre_tip_change',
 
61
                       "Invoked before the tip of a branch changes. Called with "
 
62
                       "a ChangeBranchTipParams object. Hooks should raise "
 
63
                       "TipChangeRejected to signal that a tip change is not permitted.",
 
64
                       (1, 6), None)
69
65
        self.assertEqualDiff(
70
66
            "MyHooks\n"
71
67
            "-------\n"
93
89
            "signal that a tip change is not permitted.\n", hooks.docs())
94
90
 
95
91
    def test_install_named_hook_raises_unknown_hook(self):
96
 
        hooks = Hooks()
97
 
        self.assertRaises(errors.UnknownHook, hooks.install_named_hook, 'silly',
 
92
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
93
        self.assertRaises(UnknownHook, hooks.install_named_hook, 'silly',
98
94
                          None, "")
99
95
 
100
96
    def test_install_named_hook_appends_known_hook(self):
101
 
        hooks = Hooks()
 
97
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
102
98
        hooks['set_rh'] = []
103
99
        hooks.install_named_hook('set_rh', None, "demo")
104
100
        self.assertEqual(hooks['set_rh'], [None])
105
101
 
106
102
    def test_install_named_hook_and_retrieve_name(self):
107
 
        hooks = Hooks()
 
103
        hooks = Hooks("breezy.tests.test_hooks", "somehooks")
108
104
        hooks['set_rh'] = []
109
105
        hooks.install_named_hook('set_rh', None, "demo")
110
106
        self.assertEqual("demo", hooks.get_hook_name(None))
111
107
 
 
108
    def test_uninstall_named_hook(self):
 
109
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
110
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
111
        hooks.install_named_hook('set_rh', None, "demo")
 
112
        self.assertEqual(1, len(hooks["set_rh"]))
 
113
        hooks.uninstall_named_hook("set_rh", "demo")
 
114
        self.assertEqual(0, len(hooks["set_rh"]))
 
115
 
 
116
    def test_uninstall_multiple_named_hooks(self):
 
117
        # Multiple callbacks with the same label all get removed
 
118
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
119
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
120
        hooks.install_named_hook('set_rh', 1, "demo")
 
121
        hooks.install_named_hook('set_rh', 2, "demo")
 
122
        hooks.install_named_hook('set_rh', 3, "othername")
 
123
        self.assertEqual(3, len(hooks["set_rh"]))
 
124
        hooks.uninstall_named_hook("set_rh", "demo")
 
125
        self.assertEqual(1, len(hooks["set_rh"]))
 
126
 
 
127
    def test_uninstall_named_hook_unknown_callable(self):
 
128
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
129
        hooks.add_hook('set_rh', "Set revision hsitory", (2, 0))
 
130
        self.assertRaises(KeyError, hooks.uninstall_named_hook, "set_rh",
 
131
                          "demo")
 
132
 
 
133
    def test_uninstall_named_hook_raises_unknown_hook(self):
 
134
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
135
        self.assertRaises(UnknownHook, hooks.uninstall_named_hook, 'silly', "")
 
136
 
 
137
    def test_uninstall_named_hook_old_style(self):
 
138
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
139
        hooks["set_rh"] = []
 
140
        hooks.install_named_hook('set_rh', None, "demo")
 
141
        self.assertRaises(errors.UnsupportedOperation,
 
142
                          hooks.uninstall_named_hook, "set_rh", "demo")
 
143
 
 
144
    hooks = Hooks("breezy.tests.test_hooks", "TestHooks.hooks")
 
145
 
 
146
    def test_install_lazy_named_hook(self):
 
147
        # When the hook points are not yet registered the hook is
 
148
        # added to the _lazy_hooks dictionary in breezy.hooks.
 
149
        self.hooks.add_hook('set_rh', "doc", (0, 15))
 
150
 
 
151
        def set_rh(): return None
 
152
        install_lazy_named_hook('breezy.tests.test_hooks',
 
153
                                'TestHooks.hooks', 'set_rh', set_rh, "demo")
 
154
        set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
 
155
            ('breezy.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
 
156
        self.assertEqual(1, len(set_rh_lazy_hooks))
 
157
        self.assertEqual(set_rh, set_rh_lazy_hooks[0][0].get_obj())
 
158
        self.assertEqual("demo", set_rh_lazy_hooks[0][1])
 
159
        self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
 
160
 
 
161
    def set_rh(): return None
 
162
 
 
163
    def test_install_named_hook_lazy(self):
 
164
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
165
        hooks['set_rh'] = HookPoint("set_rh", "doc", (0, 15), None)
 
166
        hooks.install_named_hook_lazy('set_rh', 'breezy.tests.test_hooks',
 
167
                                      'TestHooks.set_rh', "demo")
 
168
        self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
 
169
 
 
170
    def test_install_named_hook_lazy_old(self):
 
171
        # An exception is raised if a lazy hook is raised for
 
172
        # an old style hook point.
 
173
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
174
        hooks['set_rh'] = []
 
175
        self.assertRaises(errors.UnsupportedOperation,
 
176
                          hooks.install_named_hook_lazy,
 
177
                          'set_rh', 'breezy.tests.test_hooks', 'TestHooks.set_rh',
 
178
                          "demo")
 
179
 
 
180
    def test_valid_lazy_hooks(self):
 
181
        # Make sure that all the registered lazy hooks are referring to existing
 
182
        # hook points which allow lazy registration.
 
183
        for key, callbacks in _mod_hooks._lazy_hooks.items():
 
184
            (module_name, member_name, hook_name) = key
 
185
            obj = pyutils.get_named_object(module_name, member_name)
 
186
            self.assertEqual(obj._module, module_name)
 
187
            self.assertEqual(obj._member_name, member_name)
 
188
            self.assertTrue(hook_name in obj)
 
189
            self.assertIs(callbacks, obj[hook_name]._callbacks)
 
190
 
112
191
 
113
192
class TestHook(tests.TestCase):
114
193
 
115
194
    def test___init__(self):
116
195
        doc = ("Invoked after changing the tip of a branch object. Called with"
117
 
            "a bzrlib.branch.PostChangeBranchTipParams object")
 
196
               "a breezy.branch.PostChangeBranchTipParams object")
118
197
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
119
198
        self.assertEqual(doc, hook.__doc__)
120
199
        self.assertEqual("post_tip_change", hook.name)
124
203
 
125
204
    def test_docs(self):
126
205
        doc = ("Invoked after changing the tip of a branch object. Called with"
127
 
            " a bzrlib.branch.PostChangeBranchTipParams object")
 
206
               " a breezy.branch.PostChangeBranchTipParams object")
128
207
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
129
208
        self.assertEqual("post_tip_change\n"
130
 
            "~~~~~~~~~~~~~~~\n"
131
 
            "\n"
132
 
            "Introduced in: 0.15\n"
133
 
            "\n"
134
 
            "Invoked after changing the tip of a branch object. Called with a\n"
135
 
            "bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
 
209
                         "~~~~~~~~~~~~~~~\n"
 
210
                         "\n"
 
211
                         "Introduced in: 0.15\n"
 
212
                         "\n"
 
213
                         "Invoked after changing the tip of a branch object. Called with a\n"
 
214
                         "breezy.branch.PostChangeBranchTipParams object\n", hook.docs())
136
215
 
137
216
    def test_hook(self):
138
217
        hook = HookPoint("foo", "no docs", None, None)
 
218
 
139
219
        def callback():
140
220
            pass
141
221
        hook.hook(callback, "my callback")
142
222
        self.assertEqual([callback], list(hook))
143
223
 
 
224
    def lazy_callback():
 
225
        pass
 
226
 
 
227
    def test_lazy_hook(self):
 
228
        hook = HookPoint("foo", "no docs", None, None)
 
229
        hook.hook_lazy(
 
230
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
231
            "my callback")
 
232
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
233
 
 
234
    def test_uninstall(self):
 
235
        hook = HookPoint("foo", "no docs", None, None)
 
236
        hook.hook_lazy(
 
237
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
238
            "my callback")
 
239
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
240
        hook.uninstall("my callback")
 
241
        self.assertEqual([], list(hook))
 
242
 
 
243
    def test_uninstall_unknown(self):
 
244
        hook = HookPoint("foo", "no docs", None, None)
 
245
        self.assertRaises(KeyError, hook.uninstall, "my callback")
 
246
 
144
247
    def test___repr(self):
145
248
        # The repr should list all the callbacks, with names.
146
249
        hook = HookPoint("foo", "no docs", None, None)
 
250
 
147
251
        def callback():
148
252
            pass
149
253
        hook.hook(callback, "my callback")
163
267
        # isolation and prevent tests failing spuriously.
164
268
        for key, factory in known_hooks.items():
165
269
            self.assertTrue(callable(factory),
166
 
                "The factory(%r) for %r is not callable" % (factory, key))
 
270
                            "The factory(%r) for %r is not callable" % (factory, key))
167
271
            obj = known_hooks_key_to_object(key)
168
272
            self.assertIsInstance(obj, Hooks)
169
273
            new_hooks = factory()
173
277
 
174
278
    def test_known_hooks_key_to_object(self):
175
279
        self.assertIs(branch.Branch.hooks,
176
 
            known_hooks_key_to_object(('bzrlib.branch', 'Branch.hooks')))
 
280
                      known_hooks_key_to_object(('breezy.branch', 'Branch.hooks')))
177
281
 
178
282
    def test_known_hooks_key_to_parent_and_attribute(self):
179
283
        self.assertEqual((branch.Branch, 'hooks'),
180
 
            known_hooks_key_to_parent_and_attribute(
181
 
            ('bzrlib.branch', 'Branch.hooks')))
 
284
                         known_hooks.key_to_parent_and_attribute(
 
285
            ('breezy.branch', 'Branch.hooks')))
182
286
        self.assertEqual((branch, 'Branch'),
183
 
            known_hooks_key_to_parent_and_attribute(
184
 
            ('bzrlib.branch', 'Branch')))
 
287
                         known_hooks.key_to_parent_and_attribute(
 
288
            ('breezy.branch', 'Branch')))