1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
# Copyright (C) 2007 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Tests that branch classes implement hook callouts correctly."""
from bzrlib.branch import Branch, ChangeBranchTipParams
from bzrlib.revision import NULL_REVISION
from bzrlib.tests import TestCaseWithMemoryTransport
class TestSetRevisionHistoryHook(TestCaseWithMemoryTransport):
def setUp(self):
self.hook_calls = []
TestCaseWithMemoryTransport.setUp(self)
def capture_set_rh_hook(self, branch, rev_history):
"""Capture post set-rh hook calls to self.hook_calls.
The call is logged, as is some state of the branch.
"""
self.hook_calls.append(
('set_rh', branch, rev_history, branch.is_locked()))
def test_set_rh_empty_history(self):
branch = self.make_branch('source')
Branch.hooks.install_named_hook('set_rh', self.capture_set_rh_hook,
None)
branch.set_revision_history([])
self.assertEqual(self.hook_calls,
[('set_rh', branch, [], True)])
def test_set_rh_nonempty_history(self):
tree = self.make_branch_and_memory_tree('source')
tree.lock_write()
tree.add('')
tree.commit('another commit', rev_id='f\xc2\xb5')
tree.commit('empty commit', rev_id='foo')
tree.unlock()
branch = tree.branch
Branch.hooks.install_named_hook('set_rh', self.capture_set_rh_hook,
None)
# some branches require that their history be set to a revision in the
# repository
branch.set_revision_history(['f\xc2\xb5'])
self.assertEqual(self.hook_calls,
[('set_rh', branch, ['f\xc2\xb5'], True)])
def test_set_rh_branch_is_locked(self):
branch = self.make_branch('source')
Branch.hooks.install_named_hook('set_rh', self.capture_set_rh_hook,
None)
branch.set_revision_history([])
self.assertEqual(self.hook_calls,
[('set_rh', branch, [], True)])
def test_set_rh_calls_all_hooks_no_errors(self):
branch = self.make_branch('source')
Branch.hooks.install_named_hook('set_rh', self.capture_set_rh_hook,
None)
Branch.hooks.install_named_hook('set_rh', self.capture_set_rh_hook,
None)
branch.set_revision_history([])
self.assertEqual(self.hook_calls,
[('set_rh', branch, [], True),
('set_rh', branch, [], True),
])
class TestPreChangeBranchTip(TestCaseWithMemoryTransport):
"""Tests for pre_change_branch_tip hook.
Most of these tests are very similar to the tests in
TestPostChangeBranchTip.
"""
def install_logging_hook(self):
"""Add a hook that logs calls made to it.
:returns: the list that the calls will be appended to.
"""
hook_calls = []
Branch.hooks.install_named_hook(
'pre_change_branch_tip', hook_calls.append, None)
return hook_calls
def make_branch_with_revision_ids(self, *revision_ids):
"""Makes a branch with the given commits."""
tree = self.make_branch_and_memory_tree('source')
tree.lock_write()
tree.add('')
for revision_id in revision_ids:
tree.commit('Message of ' + revision_id, rev_id=revision_id)
tree.unlock()
branch = tree.branch
return branch
def test_hook_runs_before_change(self):
"""The hook runs *before* the branch's last_revision_info has changed.
"""
branch = self.make_branch_with_revision_ids('revid-one')
def assertBranchAtRevision1(params):
self.assertEquals(
(1, 'revid-one'), params.branch.last_revision_info())
Branch.hooks.install_named_hook(
'pre_change_branch_tip', assertBranchAtRevision1, None)
branch.set_last_revision_info(0, NULL_REVISION)
def test_reject_by_hook(self):
"""If a hook raises an exception, the change does not take effect.
Also, the exception will be propogated.
"""
branch = self.make_branch_with_revision_ids(
'one-\xc2\xb5', 'two-\xc2\xb5')
class PearShapedError(Exception):
pass
def hook_that_raises(params):
raise PearShapedError()
Branch.hooks.install_named_hook(
'pre_change_branch_tip', hook_that_raises, None)
self.assertRaises(
PearShapedError, branch.set_last_revision_info, 0, NULL_REVISION)
# The revision info is unchanged.
self.assertEqual((2, 'two-\xc2\xb5'), branch.last_revision_info())
def test_pre_change_branch_tip_empty_history(self):
branch = self.make_branch('source')
hook_calls = self.install_logging_hook()
branch.set_last_revision_info(0, NULL_REVISION)
expected_params = ChangeBranchTipParams(
branch, 0, 0, NULL_REVISION, NULL_REVISION)
self.assertEqual([expected_params], hook_calls)
def test_pre_change_branch_tip_nonempty_history(self):
# some branches require that their history be set to a revision in the
# repository, so we need to make a branch with non-empty history for
# this test.
branch = self.make_branch_with_revision_ids(
'one-\xc2\xb5', 'two-\xc2\xb5')
hook_calls = self.install_logging_hook()
branch.set_last_revision_info(1, 'one-\xc2\xb5')
expected_params = ChangeBranchTipParams(
branch, 2, 1, 'two-\xc2\xb5', 'one-\xc2\xb5')
self.assertEqual([expected_params], hook_calls)
def test_pre_change_branch_tip_branch_is_locked(self):
branch = self.make_branch('source')
def assertBranchIsLocked(params):
self.assertTrue(params.branch.is_locked())
Branch.hooks.install_named_hook(
'pre_change_branch_tip', assertBranchIsLocked, None)
branch.set_last_revision_info(0, NULL_REVISION)
def test_pre_change_branch_tip_calls_all_hooks_no_errors(self):
branch = self.make_branch('source')
hook_calls_1 = self.install_logging_hook()
hook_calls_2 = self.install_logging_hook()
self.assertIsNot(hook_calls_1, hook_calls_2)
branch.set_last_revision_info(0, NULL_REVISION)
# Both hooks are called.
self.assertEqual(len(hook_calls_1), 1)
self.assertEqual(len(hook_calls_2), 1)
class TestPostChangeBranchTip(TestCaseWithMemoryTransport):
"""Tests for post_change_branch_tip hook.
Most of these tests are very similar to the tests in
TestPostChangeBranchTip.
"""
def install_logging_hook(self):
"""Add a hook that logs calls made to it.
:returns: the list that the calls will be appended to.
"""
hook_calls = []
Branch.hooks.install_named_hook(
'post_change_branch_tip', hook_calls.append, None)
return hook_calls
def make_branch_with_revision_ids(self, *revision_ids):
"""Makes a branch with the given commits."""
tree = self.make_branch_and_memory_tree('source')
tree.lock_write()
tree.add('')
for revision_id in revision_ids:
tree.commit('Message of ' + revision_id, rev_id=revision_id)
tree.unlock()
branch = tree.branch
return branch
def test_hook_runs_after_change(self):
"""The hook runs *after* the branch's last_revision_info has changed.
"""
branch = self.make_branch_with_revision_ids('revid-one')
def assertBranchAtRevision1(params):
self.assertEquals(
(0, NULL_REVISION), params.branch.last_revision_info())
Branch.hooks.install_named_hook(
'post_change_branch_tip', assertBranchAtRevision1, None)
branch.set_last_revision_info(0, NULL_REVISION)
def test_change_branch_tip_empty_history(self):
branch = self.make_branch('source')
hook_calls = self.install_logging_hook()
branch.set_last_revision_info(0, NULL_REVISION)
expected_params = ChangeBranchTipParams(
branch, 0, 0, NULL_REVISION, NULL_REVISION)
self.assertEqual([expected_params], hook_calls)
def test_change_branch_tip_nonempty_history(self):
# some branches require that their history be set to a revision in the
# repository, so we need to make a branch with non-empty history for
# this test.
branch = self.make_branch_with_revision_ids(
'one-\xc2\xb5', 'two-\xc2\xb5')
hook_calls = self.install_logging_hook()
branch.set_last_revision_info(1, 'one-\xc2\xb5')
expected_params = ChangeBranchTipParams(
branch, 2, 1, 'two-\xc2\xb5', 'one-\xc2\xb5')
self.assertEqual([expected_params], hook_calls)
def test_tip_branch_is_locked(self):
"""The branch passed to the hook is locked."""
branch = self.make_branch('source')
def assertBranchIsLocked(params):
self.assertTrue(params.branch.is_locked())
Branch.hooks.install_named_hook(
'post_change_branch_tip', assertBranchIsLocked, None)
branch.set_last_revision_info(0, NULL_REVISION)
def test_change_branch_tip_calls_all_hooks_no_errors(self):
"""If multiple hooks are registered, all are called."""
branch = self.make_branch('source')
hook_calls_1 = self.install_logging_hook()
hook_calls_2 = self.install_logging_hook()
self.assertIsNot(hook_calls_1, hook_calls_2)
branch.set_last_revision_info(0, NULL_REVISION)
# Both hooks are called.
self.assertEqual(len(hook_calls_1), 1)
self.assertEqual(len(hook_calls_2), 1)
|