1
# Copyright (C) 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Tests for the core Hooks logic."""
19
from bzrlib import errors
20
from bzrlib.hooks import (
24
from bzrlib.errors import (
28
from bzrlib.symbol_versioning import one_five
29
from bzrlib.tests import TestCase
32
class TestHooks(TestCase):
34
def test_create_hook_first(self):
36
doc = ("Invoked after changing the tip of a branch object. Called with"
37
"a bzrlib.branch.PostChangeBranchTipParams object")
38
hook = HookPoint("post_tip_change", doc, (0, 15), None)
39
hooks.create_hook(hook)
40
self.assertEqual(hook, hooks['post_tip_change'])
42
def test_create_hook_name_collision_errors(self):
44
doc = ("Invoked after changing the tip of a branch object. Called with"
45
"a bzrlib.branch.PostChangeBranchTipParams object")
46
hook = HookPoint("post_tip_change", doc, (0, 15), None)
47
hook2 = HookPoint("post_tip_change", None, None, None)
48
hooks.create_hook(hook)
49
self.assertRaises(errors.DuplicateKey, hooks.create_hook, hook2)
50
self.assertEqual(hook, hooks['post_tip_change'])
53
"""docs() should return something reasonable about the Hooks."""
58
hook1 = HookPoint('post_tip_change',
59
"Invoked after the tip of a branch changes. Called with "
60
"a ChangeBranchTipParams object.", (1, 4), None)
61
hook2 = HookPoint('pre_tip_change',
62
"Invoked before the tip of a branch changes. Called with "
63
"a ChangeBranchTipParams object. Hooks should raise "
64
"TipChangeRejected to signal that a tip change is not permitted.",
66
hooks.create_hook(hook1)
67
hooks.create_hook(hook2)
75
"An old-style hook. For documentation see the __init__ method of 'MyHooks'\n"
80
"Introduced in: 1.4\n"
81
"Deprecated in: Not deprecated\n"
83
"Invoked after the tip of a branch changes. Called with a\n"
84
"ChangeBranchTipParams object.\n"
89
"Introduced in: 1.6\n"
90
"Deprecated in: Not deprecated\n"
92
"Invoked before the tip of a branch changes. Called with a\n"
93
"ChangeBranchTipParams object. Hooks should raise TipChangeRejected to\n"
94
"signal that a tip change is not permitted.\n", hooks.docs())
96
def test_install_hook_raises_unknown_hook(self):
97
"""install_hook should raise UnknownHook if a hook is unknown."""
99
self.assertRaises(UnknownHook, self.applyDeprecated, one_five,
100
hooks.install_hook, 'silly', None)
102
def test_install_hook_appends_known_hook(self):
103
"""install_hook should append the callable for known hooks."""
106
self.applyDeprecated(one_five, hooks.install_hook, 'set_rh', None)
107
self.assertEqual(hooks['set_rh'], [None])
109
def test_install_named_hook_raises_unknown_hook(self):
111
self.assertRaises(UnknownHook, hooks.install_named_hook, 'silly',
114
def test_install_named_hook_appends_known_hook(self):
117
hooks.install_named_hook('set_rh', None, "demo")
118
self.assertEqual(hooks['set_rh'], [None])
120
def test_install_named_hook_and_retrieve_name(self):
123
hooks.install_named_hook('set_rh', None, "demo")
124
self.assertEqual("demo", hooks.get_hook_name(None))
126
def test_name_hook_and_retrieve_name(self):
127
"""name_hook puts the name in the names mapping."""
130
self.applyDeprecated(one_five, hooks.install_hook, 'set_rh', None)
131
hooks.name_hook(None, 'demo')
132
self.assertEqual("demo", hooks.get_hook_name(None))
134
def test_get_unnamed_hook_name_is_unnamed(self):
137
self.applyDeprecated(one_five, hooks.install_hook, 'set_rh', None)
138
self.assertEqual("No hook name", hooks.get_hook_name(None))
141
class TestHook(TestCase):
143
def test___init__(self):
144
doc = ("Invoked after changing the tip of a branch object. Called with"
145
"a bzrlib.branch.PostChangeBranchTipParams object")
146
hook = HookPoint("post_tip_change", doc, (0, 15), None)
147
self.assertEqual(doc, hook.__doc__)
148
self.assertEqual("post_tip_change", hook.name)
149
self.assertEqual((0, 15), hook.introduced)
150
self.assertEqual(None, hook.deprecated)
151
self.assertEqual([], list(hook))
154
doc = ("Invoked after changing the tip of a branch object. Called with"
155
" a bzrlib.branch.PostChangeBranchTipParams object")
156
hook = HookPoint("post_tip_change", doc, (0, 15), None)
157
self.assertEqual("post_tip_change\n"
160
"Introduced in: 0.15\n"
161
"Deprecated in: Not deprecated\n"
163
"Invoked after changing the tip of a branch object. Called with a\n"
164
"bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
167
hook = HookPoint("foo", "no docs", None, None)
170
hook.hook(callback, "my callback")
171
self.assertEqual([callback], list(hook))
173
def test___repr(self):
174
# The repr should list all the callbacks, with names.
175
hook = HookPoint("foo", "no docs", None, None)
178
hook.hook(callback, "my callback")
179
callback_repr = repr(callback)
181
'<HookPoint(foo), callbacks=[%s(my callback)]>' %
182
callback_repr, repr(hook))
added
removed
bzrlib/tests/test_hooks.py
