1
# Copyright (C) 2007-2012, 2016 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for the core Hooks logic."""
26
from bzrlib.hooks import (
29
install_lazy_named_hook,
31
known_hooks_key_to_object,
33
from bzrlib.symbol_versioning import (
38
class TestHooks(tests.TestCase):
41
"""docs() should return something reasonable about the Hooks."""
44
hooks = MyHooks("bzrlib.tests.test_hooks", "some_hooks")
46
hooks.add_hook('post_tip_change',
47
"Invoked after the tip of a branch changes. Called with "
48
"a ChangeBranchTipParams object.", (1, 4))
49
hooks.add_hook('pre_tip_change',
50
"Invoked before the tip of a branch changes. Called with "
51
"a ChangeBranchTipParams object. Hooks should raise "
52
"TipChangeRejected to signal that a tip change is not permitted.",
61
"An old-style hook. For documentation see the __init__ method of 'MyHooks'\n"
66
"Introduced in: 1.4\n"
68
"Invoked after the tip of a branch changes. Called with a\n"
69
"ChangeBranchTipParams object.\n"
74
"Introduced in: 1.6\n"
76
"Invoked before the tip of a branch changes. Called with a\n"
77
"ChangeBranchTipParams object. Hooks should raise TipChangeRejected to\n"
78
"signal that a tip change is not permitted.\n", hooks.docs())
80
def test_install_named_hook_raises_unknown_hook(self):
81
hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
82
self.assertRaises(errors.UnknownHook, hooks.install_named_hook, 'silly',
85
def test_install_named_hook_appends_known_hook(self):
86
hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
88
hooks.install_named_hook('set_rh', None, "demo")
89
self.assertEqual(hooks['set_rh'], [None])
91
def test_install_named_hook_and_retrieve_name(self):
92
hooks = Hooks("bzrlib.tests.test_hooks", "somehooks")
94
hooks.install_named_hook('set_rh', None, "demo")
95
self.assertEqual("demo", hooks.get_hook_name(None))
97
def test_uninstall_named_hook(self):
98
hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
99
hooks.add_hook('set_rh', "Set revision history", (2, 0))
100
hooks.install_named_hook('set_rh', None, "demo")
101
self.assertEqual(1, len(hooks["set_rh"]))
102
hooks.uninstall_named_hook("set_rh", "demo")
103
self.assertEqual(0, len(hooks["set_rh"]))
105
def test_uninstall_multiple_named_hooks(self):
106
# Multiple callbacks with the same label all get removed
107
hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
108
hooks.add_hook('set_rh', "Set revision history", (2, 0))
109
hooks.install_named_hook('set_rh', 1, "demo")
110
hooks.install_named_hook('set_rh', 2, "demo")
111
hooks.install_named_hook('set_rh', 3, "othername")
112
self.assertEqual(3, len(hooks["set_rh"]))
113
hooks.uninstall_named_hook("set_rh", "demo")
114
self.assertEqual(1, len(hooks["set_rh"]))
116
def test_uninstall_named_hook_unknown_callable(self):
117
hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
118
hooks.add_hook('set_rh', "Set revision hsitory", (2, 0))
119
self.assertRaises(KeyError, hooks.uninstall_named_hook, "set_rh",
122
def test_uninstall_named_hook_raises_unknown_hook(self):
123
hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
124
self.assertRaises(errors.UnknownHook, hooks.uninstall_named_hook,
127
def test_uninstall_named_hook_old_style(self):
128
hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
130
hooks.install_named_hook('set_rh', None, "demo")
131
self.assertRaises(errors.UnsupportedOperation,
132
hooks.uninstall_named_hook, "set_rh", "demo")
134
hooks = Hooks("bzrlib.tests.test_hooks", "TestHooks.hooks")
136
def test_install_lazy_named_hook(self):
137
# When the hook points are not yet registered the hook is
138
# added to the _lazy_hooks dictionary in bzrlib.hooks.
139
self.hooks.add_hook('set_rh', "doc", (0, 15))
140
set_rh = lambda: None
141
install_lazy_named_hook('bzrlib.tests.test_hooks',
142
'TestHooks.hooks', 'set_rh', set_rh, "demo")
143
set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
144
('bzrlib.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
145
self.assertEqual(1, len(set_rh_lazy_hooks))
146
self.assertEqual(set_rh, set_rh_lazy_hooks[0][0].get_obj())
147
self.assertEqual("demo", set_rh_lazy_hooks[0][1])
148
self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
150
set_rh = lambda: None
152
def test_install_named_hook_lazy(self):
153
hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
154
hooks['set_rh'] = HookPoint("set_rh", "doc", (0, 15), None)
155
hooks.install_named_hook_lazy('set_rh', 'bzrlib.tests.test_hooks',
156
'TestHooks.set_rh', "demo")
157
self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
159
def test_install_named_hook_lazy_old(self):
160
# An exception is raised if a lazy hook is raised for
161
# an old style hook point.
162
hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
164
self.assertRaises(errors.UnsupportedOperation,
165
hooks.install_named_hook_lazy,
166
'set_rh', 'bzrlib.tests.test_hooks', 'TestHooks.set_rh',
169
def test_valid_lazy_hooks(self):
170
# Make sure that all the registered lazy hooks are referring to existing
171
# hook points which allow lazy registration.
172
for key, callbacks in _mod_hooks._lazy_hooks.iteritems():
173
(module_name, member_name, hook_name) = key
174
obj = pyutils.get_named_object(module_name, member_name)
175
self.assertEqual(obj._module, module_name)
176
self.assertEqual(obj._member_name, member_name)
177
self.assertTrue(hook_name in obj)
178
self.assertIs(callbacks, obj[hook_name]._callbacks)
181
class TestHook(tests.TestCase):
183
def test___init__(self):
184
doc = ("Invoked after changing the tip of a branch object. Called with"
185
"a bzrlib.branch.PostChangeBranchTipParams object")
186
hook = HookPoint("post_tip_change", doc, (0, 15), None)
187
self.assertEqual(doc, hook.__doc__)
188
self.assertEqual("post_tip_change", hook.name)
189
self.assertEqual((0, 15), hook.introduced)
190
self.assertEqual(None, hook.deprecated)
191
self.assertEqual([], list(hook))
194
doc = ("Invoked after changing the tip of a branch object. Called with"
195
" a bzrlib.branch.PostChangeBranchTipParams object")
196
hook = HookPoint("post_tip_change", doc, (0, 15), None)
197
self.assertEqual("post_tip_change\n"
200
"Introduced in: 0.15\n"
202
"Invoked after changing the tip of a branch object. Called with a\n"
203
"bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
206
hook = HookPoint("foo", "no docs", None, None)
209
hook.hook(callback, "my callback")
210
self.assertEqual([callback], list(hook))
215
def test_lazy_hook(self):
216
hook = HookPoint("foo", "no docs", None, None)
218
"bzrlib.tests.test_hooks", "TestHook.lazy_callback",
220
self.assertEqual([TestHook.lazy_callback], list(hook))
222
def test_uninstall(self):
223
hook = HookPoint("foo", "no docs", None, None)
225
"bzrlib.tests.test_hooks", "TestHook.lazy_callback",
227
self.assertEqual([TestHook.lazy_callback], list(hook))
228
hook.uninstall("my callback")
229
self.assertEqual([], list(hook))
231
def test_uninstall_unknown(self):
232
hook = HookPoint("foo", "no docs", None, None)
233
self.assertRaises(KeyError, hook.uninstall, "my callback")
235
def test___repr(self):
236
# The repr should list all the callbacks, with names.
237
hook = HookPoint("foo", "no docs", None, None)
240
hook.hook(callback, "my callback")
241
callback_repr = repr(callback)
243
'<HookPoint(foo), callbacks=[%s(my callback)]>' %
244
callback_repr, repr(hook))
247
class TestHookRegistry(tests.TestCase):
249
def test_items_are_reasonable_keys(self):
250
# All the items in the known_hooks registry need to map from
251
# (module_name, member_name) tuples to the callable used to get an
252
# empty Hooks for that attribute. This is used to support the test
253
# suite which needs to generate empty hooks (and HookPoints) to ensure
254
# isolation and prevent tests failing spuriously.
255
for key, factory in known_hooks.items():
256
self.assertTrue(callable(factory),
257
"The factory(%r) for %r is not callable" % (factory, key))
258
obj = known_hooks_key_to_object(key)
259
self.assertIsInstance(obj, Hooks)
260
new_hooks = factory()
261
self.assertIsInstance(obj, Hooks)
262
self.assertEqual(type(obj), type(new_hooks))
263
self.assertEqual("No hook name", new_hooks.get_hook_name(None))
265
def test_known_hooks_key_to_object(self):
266
self.assertIs(branch.Branch.hooks,
267
known_hooks_key_to_object(('bzrlib.branch', 'Branch.hooks')))
269
def test_known_hooks_key_to_parent_and_attribute(self):
270
self.assertEqual((branch.Branch, 'hooks'),
271
known_hooks.key_to_parent_and_attribute(
272
('bzrlib.branch', 'Branch.hooks')))
273
self.assertEqual((branch, 'Branch'),
274
known_hooks.key_to_parent_and_attribute(
275
('bzrlib.branch', 'Branch')))
added
removed
bzrlib/tests/test_hooks.py
