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."""
30
install_lazy_named_hook,
32
known_hooks_key_to_object,
36
class TestErrors(tests.TestCase):
38
def test_unknown_hook(self):
39
error = UnknownHook("branch", "foo")
40
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
43
error = UnknownHook("tree", "bar")
44
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
49
class TestHooks(tests.TestCase):
52
"""docs() should return something reasonable about the Hooks."""
55
hooks = MyHooks("breezy.tests.test_hooks", "some_hooks")
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.",
72
"An old-style hook. For documentation see the __init__ method of 'MyHooks'\n"
77
"Introduced in: 1.4\n"
79
"Invoked after the tip of a branch changes. Called with a\n"
80
"ChangeBranchTipParams object.\n"
85
"Introduced in: 1.6\n"
87
"Invoked before the tip of a branch changes. Called with a\n"
88
"ChangeBranchTipParams object. Hooks should raise TipChangeRejected to\n"
89
"signal that a tip change is not permitted.\n", hooks.docs())
91
def test_install_named_hook_raises_unknown_hook(self):
92
hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
93
self.assertRaises(UnknownHook, hooks.install_named_hook, 'silly',
96
def test_install_named_hook_appends_known_hook(self):
97
hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
99
hooks.install_named_hook('set_rh', None, "demo")
100
self.assertEqual(hooks['set_rh'], [None])
102
def test_install_named_hook_and_retrieve_name(self):
103
hooks = Hooks("breezy.tests.test_hooks", "somehooks")
105
hooks.install_named_hook('set_rh', None, "demo")
106
self.assertEqual("demo", hooks.get_hook_name(None))
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"]))
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"]))
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",
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', "")
137
def test_uninstall_named_hook_old_style(self):
138
hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
140
hooks.install_named_hook('set_rh', None, "demo")
141
self.assertRaises(errors.UnsupportedOperation,
142
hooks.uninstall_named_hook, "set_rh", "demo")
144
hooks = Hooks("breezy.tests.test_hooks", "TestHooks.hooks")
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
set_rh = lambda: None
151
install_lazy_named_hook('breezy.tests.test_hooks',
152
'TestHooks.hooks', 'set_rh', set_rh, "demo")
153
set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
154
('breezy.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
155
self.assertEqual(1, len(set_rh_lazy_hooks))
156
self.assertEqual(set_rh, set_rh_lazy_hooks[0][0].get_obj())
157
self.assertEqual("demo", set_rh_lazy_hooks[0][1])
158
self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
160
set_rh = lambda: None
162
def test_install_named_hook_lazy(self):
163
hooks = Hooks("breezy.tests.hooks", "some_hooks")
164
hooks['set_rh'] = HookPoint("set_rh", "doc", (0, 15), None)
165
hooks.install_named_hook_lazy('set_rh', 'breezy.tests.test_hooks',
166
'TestHooks.set_rh', "demo")
167
self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
169
def test_install_named_hook_lazy_old(self):
170
# An exception is raised if a lazy hook is raised for
171
# an old style hook point.
172
hooks = Hooks("breezy.tests.hooks", "some_hooks")
174
self.assertRaises(errors.UnsupportedOperation,
175
hooks.install_named_hook_lazy,
176
'set_rh', 'breezy.tests.test_hooks', 'TestHooks.set_rh',
179
def test_valid_lazy_hooks(self):
180
# Make sure that all the registered lazy hooks are referring to existing
181
# hook points which allow lazy registration.
182
for key, callbacks in _mod_hooks._lazy_hooks.items():
183
(module_name, member_name, hook_name) = key
184
obj = pyutils.get_named_object(module_name, member_name)
185
self.assertEqual(obj._module, module_name)
186
self.assertEqual(obj._member_name, member_name)
187
self.assertTrue(hook_name in obj)
188
self.assertIs(callbacks, obj[hook_name]._callbacks)
191
class TestHook(tests.TestCase):
193
def test___init__(self):
194
doc = ("Invoked after changing the tip of a branch object. Called with"
195
"a breezy.branch.PostChangeBranchTipParams object")
196
hook = HookPoint("post_tip_change", doc, (0, 15), None)
197
self.assertEqual(doc, hook.__doc__)
198
self.assertEqual("post_tip_change", hook.name)
199
self.assertEqual((0, 15), hook.introduced)
200
self.assertEqual(None, hook.deprecated)
201
self.assertEqual([], list(hook))
204
doc = ("Invoked after changing the tip of a branch object. Called with"
205
" a breezy.branch.PostChangeBranchTipParams object")
206
hook = HookPoint("post_tip_change", doc, (0, 15), None)
207
self.assertEqual("post_tip_change\n"
210
"Introduced in: 0.15\n"
212
"Invoked after changing the tip of a branch object. Called with a\n"
213
"breezy.branch.PostChangeBranchTipParams object\n", hook.docs())
216
hook = HookPoint("foo", "no docs", None, None)
219
hook.hook(callback, "my callback")
220
self.assertEqual([callback], list(hook))
225
def test_lazy_hook(self):
226
hook = HookPoint("foo", "no docs", None, None)
228
"breezy.tests.test_hooks", "TestHook.lazy_callback",
230
self.assertEqual([TestHook.lazy_callback], list(hook))
232
def test_uninstall(self):
233
hook = HookPoint("foo", "no docs", None, None)
235
"breezy.tests.test_hooks", "TestHook.lazy_callback",
237
self.assertEqual([TestHook.lazy_callback], list(hook))
238
hook.uninstall("my callback")
239
self.assertEqual([], list(hook))
241
def test_uninstall_unknown(self):
242
hook = HookPoint("foo", "no docs", None, None)
243
self.assertRaises(KeyError, hook.uninstall, "my callback")
245
def test___repr(self):
246
# The repr should list all the callbacks, with names.
247
hook = HookPoint("foo", "no docs", None, None)
250
hook.hook(callback, "my callback")
251
callback_repr = repr(callback)
253
'<HookPoint(foo), callbacks=[%s(my callback)]>' %
254
callback_repr, repr(hook))
257
class TestHookRegistry(tests.TestCase):
259
def test_items_are_reasonable_keys(self):
260
# All the items in the known_hooks registry need to map from
261
# (module_name, member_name) tuples to the callable used to get an
262
# empty Hooks for that attribute. This is used to support the test
263
# suite which needs to generate empty hooks (and HookPoints) to ensure
264
# isolation and prevent tests failing spuriously.
265
for key, factory in known_hooks.items():
266
self.assertTrue(callable(factory),
267
"The factory(%r) for %r is not callable" % (factory, key))
268
obj = known_hooks_key_to_object(key)
269
self.assertIsInstance(obj, Hooks)
270
new_hooks = factory()
271
self.assertIsInstance(obj, Hooks)
272
self.assertEqual(type(obj), type(new_hooks))
273
self.assertEqual("No hook name", new_hooks.get_hook_name(None))
275
def test_known_hooks_key_to_object(self):
276
self.assertIs(branch.Branch.hooks,
277
known_hooks_key_to_object(('breezy.branch', 'Branch.hooks')))
279
def test_known_hooks_key_to_parent_and_attribute(self):
280
self.assertEqual((branch.Branch, 'hooks'),
281
known_hooks.key_to_parent_and_attribute(
282
('breezy.branch', 'Branch.hooks')))
283
self.assertEqual((branch, 'Branch'),
284
known_hooks.key_to_parent_and_attribute(
285
('breezy.branch', 'Branch')))
added
removed
breezy/tests/test_hooks.py
