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."""
56
hook1 = HookPoint('post_tip_change',
57
"Invoked after the tip of a branch changes. Called with "
58
"a ChangeBranchTipParams object.", (1, 4), None)
59
hook2 = HookPoint('pre_tip_change',
60
"Invoked before the tip of a branch changes. Called with "
61
"a ChangeBranchTipParams object. Hooks should raise "
62
"TipChangeRejected to signal that a tip change is not permitted.",
64
hooks.create_hook(hook1)
65
hooks.create_hook(hook2)
70
"An old-style hook. For documentation see the __init__ method of 'Hooks'\n"
75
"Introduced in: 1.4\n"
76
"Deprecated in: Not deprecated\n"
78
"Invoked after the tip of a branch changes. Called with a\n"
79
"ChangeBranchTipParams object.\n"
84
"Introduced in: 1.6\n"
85
"Deprecated in: Not deprecated\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_hook_raises_unknown_hook(self):
92
"""install_hook should raise UnknownHook if a hook is unknown."""
94
self.assertRaises(UnknownHook, self.applyDeprecated, one_five,
95
hooks.install_hook, 'silly', None)
97
def test_install_hook_appends_known_hook(self):
98
"""install_hook should append the callable for known hooks."""
101
self.applyDeprecated(one_five, hooks.install_hook, 'set_rh', None)
102
self.assertEqual(hooks['set_rh'], [None])
104
def test_install_named_hook_raises_unknown_hook(self):
106
self.assertRaises(UnknownHook, hooks.install_named_hook, 'silly',
109
def test_install_named_hook_appends_known_hook(self):
112
hooks.install_named_hook('set_rh', None, "demo")
113
self.assertEqual(hooks['set_rh'], [None])
115
def test_install_named_hook_and_retrieve_name(self):
118
hooks.install_named_hook('set_rh', None, "demo")
119
self.assertEqual("demo", hooks.get_hook_name(None))
121
def test_name_hook_and_retrieve_name(self):
122
"""name_hook puts the name in the names mapping."""
125
self.applyDeprecated(one_five, hooks.install_hook, 'set_rh', None)
126
hooks.name_hook(None, 'demo')
127
self.assertEqual("demo", hooks.get_hook_name(None))
129
def test_get_unnamed_hook_name_is_unnamed(self):
132
self.applyDeprecated(one_five, hooks.install_hook, 'set_rh', None)
133
self.assertEqual("No hook name", hooks.get_hook_name(None))
136
class TestHook(TestCase):
138
def test___init__(self):
139
doc = ("Invoked after changing the tip of a branch object. Called with"
140
"a bzrlib.branch.PostChangeBranchTipParams object")
141
hook = HookPoint("post_tip_change", doc, (0, 15), None)
142
self.assertEqual(doc, hook.__doc__)
143
self.assertEqual("post_tip_change", hook.name)
144
self.assertEqual((0, 15), hook.introduced)
145
self.assertEqual(None, hook.deprecated)
146
self.assertEqual([], list(hook))
149
doc = ("Invoked after changing the tip of a branch object. Called with"
150
" a bzrlib.branch.PostChangeBranchTipParams object")
151
hook = HookPoint("post_tip_change", doc, (0, 15), None)
152
self.assertEqual("post_tip_change\n"
155
"Introduced in: 0.15\n"
156
"Deprecated in: Not deprecated\n"
158
"Invoked after changing the tip of a branch object. Called with a\n"
159
"bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
162
hook = HookPoint("foo", "no docs", None, None)
165
hook.hook(callback, "my callback")
166
self.assertEqual([callback], list(hook))
168
def test___repr(self):
169
# The repr should list all the callbacks, with names.
170
hook = HookPoint("foo", "no docs", None, None)
173
hook.hook(callback, "my callback")
174
callback_repr = repr(callback)
176
'<HookPoint(foo), callbacks=[%s(my callback)]>' %
177
callback_repr, repr(hook))
added
removed
bzrlib/tests/test_hooks.py
