1
# Copyright (C) 2007, 2009 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."""
19
from bzrlib import branch, errors
20
from bzrlib.hooks import (
24
known_hooks_key_to_object,
25
known_hooks_key_to_parent_and_attribute,
27
from bzrlib.errors import (
31
from bzrlib.tests import TestCase
34
class TestHooks(TestCase):
36
def test_create_hook_first(self):
38
doc = ("Invoked after changing the tip of a branch object. Called with"
39
"a bzrlib.branch.PostChangeBranchTipParams object")
40
hook = HookPoint("post_tip_change", doc, (0, 15), None)
41
hooks.create_hook(hook)
42
self.assertEqual(hook, hooks['post_tip_change'])
44
def test_create_hook_name_collision_errors(self):
46
doc = ("Invoked after changing the tip of a branch object. Called with"
47
"a bzrlib.branch.PostChangeBranchTipParams object")
48
hook = HookPoint("post_tip_change", doc, (0, 15), None)
49
hook2 = HookPoint("post_tip_change", None, None, None)
50
hooks.create_hook(hook)
51
self.assertRaises(errors.DuplicateKey, hooks.create_hook, hook2)
52
self.assertEqual(hook, hooks['post_tip_change'])
55
"""docs() should return something reasonable about the Hooks."""
60
hook1 = HookPoint('post_tip_change',
61
"Invoked after the tip of a branch changes. Called with "
62
"a ChangeBranchTipParams object.", (1, 4), None)
63
hook2 = HookPoint('pre_tip_change',
64
"Invoked before the tip of a branch changes. Called with "
65
"a ChangeBranchTipParams object. Hooks should raise "
66
"TipChangeRejected to signal that a tip change is not permitted.",
68
hooks.create_hook(hook1)
69
hooks.create_hook(hook2)
77
"An old-style hook. For documentation see the __init__ method of 'MyHooks'\n"
82
"Introduced in: 1.4\n"
83
"Deprecated in: Not deprecated\n"
85
"Invoked after the tip of a branch changes. Called with a\n"
86
"ChangeBranchTipParams object.\n"
91
"Introduced in: 1.6\n"
92
"Deprecated in: Not deprecated\n"
94
"Invoked before the tip of a branch changes. Called with a\n"
95
"ChangeBranchTipParams object. Hooks should raise TipChangeRejected to\n"
96
"signal that a tip change is not permitted.\n", hooks.docs())
98
def test_install_named_hook_raises_unknown_hook(self):
100
self.assertRaises(UnknownHook, hooks.install_named_hook, 'silly',
103
def test_install_named_hook_appends_known_hook(self):
106
hooks.install_named_hook('set_rh', None, "demo")
107
self.assertEqual(hooks['set_rh'], [None])
109
def test_install_named_hook_and_retrieve_name(self):
112
hooks.install_named_hook('set_rh', None, "demo")
113
self.assertEqual("demo", hooks.get_hook_name(None))
116
class TestHook(TestCase):
118
def test___init__(self):
119
doc = ("Invoked after changing the tip of a branch object. Called with"
120
"a bzrlib.branch.PostChangeBranchTipParams object")
121
hook = HookPoint("post_tip_change", doc, (0, 15), None)
122
self.assertEqual(doc, hook.__doc__)
123
self.assertEqual("post_tip_change", hook.name)
124
self.assertEqual((0, 15), hook.introduced)
125
self.assertEqual(None, hook.deprecated)
126
self.assertEqual([], list(hook))
129
doc = ("Invoked after changing the tip of a branch object. Called with"
130
" a bzrlib.branch.PostChangeBranchTipParams object")
131
hook = HookPoint("post_tip_change", doc, (0, 15), None)
132
self.assertEqual("post_tip_change\n"
135
"Introduced in: 0.15\n"
136
"Deprecated in: Not deprecated\n"
138
"Invoked after changing the tip of a branch object. Called with a\n"
139
"bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
142
hook = HookPoint("foo", "no docs", None, None)
145
hook.hook(callback, "my callback")
146
self.assertEqual([callback], list(hook))
148
def test___repr(self):
149
# The repr should list all the callbacks, with names.
150
hook = HookPoint("foo", "no docs", None, None)
153
hook.hook(callback, "my callback")
154
callback_repr = repr(callback)
156
'<HookPoint(foo), callbacks=[%s(my callback)]>' %
157
callback_repr, repr(hook))
160
class TestHookRegistry(TestCase):
162
def test_items_are_reasonable_keys(self):
163
# All the items in the known_hooks registry need to map from
164
# (module_name, member_name) tuples to the callable used to get an
165
# empty Hooks for that attribute. This is used to support the test
166
# suite which needs to generate empty hooks (and HookPoints) to ensure
167
# isolation and prevent tests failing spuriously.
168
for key, factory in known_hooks.items():
169
self.assertTrue(callable(factory),
170
"The factory(%r) for %r is not callable" % (factory, key))
171
obj = known_hooks_key_to_object(key)
172
self.assertIsInstance(obj, Hooks)
173
new_hooks = factory()
174
self.assertIsInstance(obj, Hooks)
175
self.assertEqual(type(obj), type(new_hooks))
177
def test_known_hooks_key_to_object(self):
178
self.assertIs(branch.Branch.hooks,
179
known_hooks_key_to_object(('bzrlib.branch', 'Branch.hooks')))
181
def test_known_hooks_key_to_parent_and_attribute(self):
182
self.assertEqual((branch.Branch, 'hooks'),
183
known_hooks_key_to_parent_and_attribute(
184
('bzrlib.branch', 'Branch.hooks')))
185
self.assertEqual((branch, 'Branch'),
186
known_hooks_key_to_parent_and_attribute(
187
('bzrlib.branch', 'Branch')))
added
removed
bzrlib/tests/test_hooks.py
