1
# Copyright (C) 2009, 2010 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
"""Implementation tests for bzrlib.merge.Merger."""
21
from bzrlib.conflicts import TextConflict
28
from bzrlib.tests import (
30
TestCaseWithTransport,
32
from bzrlib.tests.test_merge_core import MergeBuilder
33
from bzrlib.transform import TreeTransform
37
def load_tests(standard_tests, module, loader):
38
"""Multiply tests for tranport implementations."""
39
result = loader.suiteClass()
41
(name, {'merge_type': merger})
42
for name, merger in option._merge_type_registry.items()]
43
return multiply_tests(standard_tests, scenarios, result)
46
class TestMergeImplementation(TestCaseWithTransport):
48
def do_merge(self, target_tree, source_tree, **kwargs):
49
merger = _mod_merge.Merger.from_revision_ids(progress.DummyProgress(),
50
target_tree, source_tree.last_revision(),
51
other_branch=source_tree.branch)
52
merger.merge_type=self.merge_type
53
for name, value in kwargs.items():
54
setattr(merger, name, value)
57
def test_merge_specific_file(self):
58
this_tree = self.make_branch_and_tree('this')
59
this_tree.lock_write()
60
self.addCleanup(this_tree.unlock)
61
self.build_tree_contents([
62
('this/file1', 'a\nb\n'),
63
('this/file2', 'a\nb\n')
65
this_tree.add(['file1', 'file2'])
66
this_tree.commit('Added files')
67
other_tree = this_tree.bzrdir.sprout('other').open_workingtree()
68
self.build_tree_contents([
69
('other/file1', 'a\nb\nc\n'),
70
('other/file2', 'a\nb\nc\n')
72
other_tree.commit('modified both')
73
self.build_tree_contents([
74
('this/file1', 'd\na\nb\n'),
75
('this/file2', 'd\na\nb\n')
77
this_tree.commit('modified both')
78
self.do_merge(this_tree, other_tree, interesting_files=['file1'])
79
self.assertFileEqual('d\na\nb\nc\n', 'this/file1')
80
self.assertFileEqual('d\na\nb\n', 'this/file2')
82
def test_merge_move_and_change(self):
83
this_tree = self.make_branch_and_tree('this')
84
this_tree.lock_write()
85
self.addCleanup(this_tree.unlock)
86
self.build_tree_contents([
87
('this/file1', 'line 1\nline 2\nline 3\nline 4\n'),
89
this_tree.add('file1',)
90
this_tree.commit('Added file')
91
other_tree = this_tree.bzrdir.sprout('other').open_workingtree()
92
self.build_tree_contents([
93
('other/file1', 'line 1\nline 2 to 2.1\nline 3\nline 4\n'),
95
other_tree.commit('Changed 2 to 2.1')
96
self.build_tree_contents([
97
('this/file1', 'line 1\nline 3\nline 2\nline 4\n'),
99
this_tree.commit('Swapped 2 & 3')
100
self.do_merge(this_tree, other_tree)
101
if self.merge_type is _mod_merge.LCAMerger:
103
"lca merge doesn't conflict for move and change",
104
self.assertFileEqual,
112
'>>>>>>> MERGE-SOURCE\n'
113
'line 4\n', 'this/file1')
115
self.assertFileEqual('line 1\n'
122
'>>>>>>> MERGE-SOURCE\n'
123
'line 4\n', 'this/file1')
125
def test_modify_conflicts_with_delete(self):
126
# If one side deletes a line, and the other modifies that line, then
127
# the modification should be considered a conflict
128
builder = self.make_branch_builder('test')
129
builder.start_series()
130
builder.build_snapshot('BASE-id', None,
131
[('add', ('', None, 'directory', None)),
132
('add', ('foo', 'foo-id', 'file', 'a\nb\nc\nd\ne\n')),
135
builder.build_snapshot('OTHER-id', ['BASE-id'],
136
[('modify', ('foo-id', 'a\nc\nd\ne\n'))])
137
# Modify 'b\n', add 'X\n'
138
builder.build_snapshot('THIS-id', ['BASE-id'],
139
[('modify', ('foo-id', 'a\nb2\nc\nd\nX\ne\n'))])
140
builder.finish_series()
141
branch = builder.get_branch()
142
this_tree = branch.bzrdir.create_workingtree()
143
this_tree.lock_write()
144
self.addCleanup(this_tree.unlock)
145
other_tree = this_tree.bzrdir.sprout('other',
146
'OTHER-id').open_workingtree()
147
self.do_merge(this_tree, other_tree)
148
if self.merge_type is _mod_merge.LCAMerger:
149
self.expectFailure("lca merge doesn't track deleted lines",
150
self.assertFileEqual,
155
'>>>>>>> MERGE-SOURCE\n'
161
self.assertFileEqual(
166
'>>>>>>> MERGE-SOURCE\n'
172
def get_limbodir_deletiondir(self, wt):
173
transform = TreeTransform(wt)
174
limbodir = transform._limbodir
175
deletiondir = transform._deletiondir
177
return (limbodir, deletiondir)
179
def test_merge_with_existing_limbo(self):
180
wt = self.make_branch_and_tree('this')
181
(limbodir, deletiondir) = self.get_limbodir_deletiondir(wt)
183
self.assertRaises(errors.ExistingLimbo, self.do_merge, wt, wt)
184
self.assertRaises(errors.LockError, wt.unlock)
186
def test_merge_with_pending_deletion(self):
187
wt = self.make_branch_and_tree('this')
188
(limbodir, deletiondir) = self.get_limbodir_deletiondir(wt)
189
os.mkdir(deletiondir)
190
self.assertRaises(errors.ExistingPendingDeletion, self.do_merge, wt, wt)
191
self.assertRaises(errors.LockError, wt.unlock)
194
class TestHookMergeFileContent(TestCaseWithTransport):
195
"""Tests that the 'merge_file_content' hook is invoked."""
198
TestCaseWithTransport.setUp(self)
201
def install_hook_inactive(self):
202
def inactive_factory(merger):
203
# This hook is never active
204
self.hook_log.append(('inactive',))
206
_mod_merge.Merger.hooks.install_named_hook(
207
'merge_file_content', inactive_factory, 'test hook (inactive)')
209
def install_hook_noop(self):
211
class HookNA(_mod_merge.AbstractPerFileMerger):
212
def merge_contents(self, merge_params):
213
# This hook unconditionally does nothing.
214
test.hook_log.append(('no-op',))
215
return 'not_applicable', None
216
def hook_na_factory(merger):
217
return HookNA(merger)
218
_mod_merge.Merger.hooks.install_named_hook(
219
'merge_file_content', hook_na_factory, 'test hook (no-op)')
221
def install_hook_success(self):
223
class HookSuccess(_mod_merge.AbstractPerFileMerger):
224
def merge_contents(self, merge_params):
225
test.hook_log.append(('success',))
226
if merge_params.file_id == '1':
227
return 'success', ['text-merged-by-hook']
228
return 'not_applicable', None
229
def hook_success_factory(merger):
230
return HookSuccess(merger)
231
_mod_merge.Merger.hooks.install_named_hook(
232
'merge_file_content', hook_success_factory, 'test hook (success)')
234
def install_hook_conflict(self):
236
class HookConflict(_mod_merge.AbstractPerFileMerger):
237
def merge_contents(self, merge_params):
238
test.hook_log.append(('conflict',))
239
if merge_params.file_id == '1':
240
return ('conflicted',
241
['text-with-conflict-markers-from-hook'])
242
return 'not_applicable', None
243
def hook_conflict_factory(merger):
244
return HookConflict(merger)
245
_mod_merge.Merger.hooks.install_named_hook(
246
'merge_file_content', hook_conflict_factory, 'test hook (delete)')
248
def install_hook_delete(self):
250
class HookDelete(_mod_merge.AbstractPerFileMerger):
251
def merge_contents(self, merge_params):
252
test.hook_log.append(('delete',))
253
if merge_params.file_id == '1':
254
return 'delete', None
255
return 'not_applicable', None
256
def hook_delete_factory(merger):
257
return HookDelete(merger)
258
_mod_merge.Merger.hooks.install_named_hook(
259
'merge_file_content', hook_delete_factory, 'test hook (delete)')
261
def install_hook_log_lines(self):
262
"""Install a hook that saves the get_lines for the this, base and other
263
versions of the file.
266
class HookLogLines(_mod_merge.AbstractPerFileMerger):
267
def merge_contents(self, merge_params):
268
test.hook_log.append((
270
merge_params.this_lines,
271
merge_params.other_lines,
272
merge_params.base_lines,
274
return 'not_applicable', None
275
def hook_log_lines_factory(merger):
276
return HookLogLines(merger)
277
_mod_merge.Merger.hooks.install_named_hook(
278
'merge_file_content', hook_log_lines_factory,
279
'test hook (log_lines)')
281
def make_merge_builder(self):
282
builder = MergeBuilder(self.test_base_dir)
283
self.addCleanup(builder.cleanup)
286
def create_file_needing_contents_merge(self, builder, file_id):
287
builder.add_file(file_id, builder.tree_root, "name1", "text1", True)
288
builder.change_contents(file_id, other="text4", this="text3")
290
def test_change_vs_change(self):
291
"""Hook is used for (changed, changed)"""
292
self.install_hook_success()
293
builder = self.make_merge_builder()
294
builder.add_file("1", builder.tree_root, "name1", "text1", True)
295
builder.change_contents("1", other="text4", this="text3")
296
conflicts = builder.merge(self.merge_type)
297
self.assertEqual(conflicts, [])
299
builder.this.get_file('1').read(), 'text-merged-by-hook')
301
def test_change_vs_deleted(self):
302
"""Hook is used for (changed, deleted)"""
303
self.install_hook_success()
304
builder = self.make_merge_builder()
305
builder.add_file("1", builder.tree_root, "name1", "text1", True)
306
builder.change_contents("1", this="text2")
307
builder.remove_file("1", other=True)
308
conflicts = builder.merge(self.merge_type)
309
self.assertEqual(conflicts, [])
311
builder.this.get_file('1').read(), 'text-merged-by-hook')
313
def test_result_can_be_delete(self):
314
"""A hook's result can be the deletion of a file."""
315
self.install_hook_delete()
316
builder = self.make_merge_builder()
317
self.create_file_needing_contents_merge(builder, "1")
318
conflicts = builder.merge(self.merge_type)
319
self.assertEqual(conflicts, [])
320
self.assertRaises(errors.NoSuchId, builder.this.id2path, '1')
321
self.assertEqual([], list(builder.this.list_files()))
323
def test_result_can_be_conflict(self):
324
"""A hook's result can be a conflict."""
325
self.install_hook_conflict()
326
builder = self.make_merge_builder()
327
self.create_file_needing_contents_merge(builder, "1")
328
conflicts = builder.merge(self.merge_type)
329
self.assertEqual(conflicts, [TextConflict('name1', file_id='1')])
330
# The hook still gets to set the file contents in this case, so that it
331
# can insert custom conflict markers.
333
builder.this.get_file('1').read(),
334
'text-with-conflict-markers-from-hook')
336
def test_can_access_this_other_and_base_versions(self):
337
"""The hook function can call params.merger.get_lines to access the
338
THIS/OTHER/BASE versions of the file.
340
self.install_hook_log_lines()
341
builder = self.make_merge_builder()
342
builder.add_file("1", builder.tree_root, "name1", "text1", True)
343
builder.change_contents("1", this="text2", other="text3")
344
conflicts = builder.merge(self.merge_type)
346
[('log_lines', ['text2'], ['text3'], ['text1'])], self.hook_log)
348
def test_chain_when_not_active(self):
349
"""When a hook function returns None, merging still works."""
350
self.install_hook_inactive()
351
self.install_hook_success()
352
builder = self.make_merge_builder()
353
self.create_file_needing_contents_merge(builder, "1")
354
conflicts = builder.merge(self.merge_type)
355
self.assertEqual(conflicts, [])
357
builder.this.get_file('1').read(), 'text-merged-by-hook')
358
self.assertEqual([('inactive',), ('success',)], self.hook_log)
360
def test_chain_when_not_applicable(self):
361
"""When a hook function returns not_applicable, the next function is
362
tried (when one exists).
364
self.install_hook_noop()
365
self.install_hook_success()
366
builder = self.make_merge_builder()
367
self.create_file_needing_contents_merge(builder, "1")
368
conflicts = builder.merge(self.merge_type)
369
self.assertEqual(conflicts, [])
371
builder.this.get_file('1').read(), 'text-merged-by-hook')
372
self.assertEqual([('no-op',), ('success',)], self.hook_log)
374
def test_chain_stops_after_success(self):
375
"""When a hook function returns success, no later functions are tried.
377
self.install_hook_success()
378
self.install_hook_noop()
379
builder = self.make_merge_builder()
380
self.create_file_needing_contents_merge(builder, "1")
381
conflicts = builder.merge(self.merge_type)
382
self.assertEqual([('success',)], self.hook_log)
384
def test_chain_stops_after_conflict(self):
385
"""When a hook function returns conflict, no later functions are tried.
387
self.install_hook_conflict()
388
self.install_hook_noop()
389
builder = self.make_merge_builder()
390
self.create_file_needing_contents_merge(builder, "1")
391
conflicts = builder.merge(self.merge_type)
392
self.assertEqual([('conflict',)], self.hook_log)
394
def test_chain_stops_after_delete(self):
395
"""When a hook function returns delete, no later functions are tried.
397
self.install_hook_delete()
398
self.install_hook_noop()
399
builder = self.make_merge_builder()
400
self.create_file_needing_contents_merge(builder, "1")
401
conflicts = builder.merge(self.merge_type)
402
self.assertEqual([('delete',)], self.hook_log)
added
removed
bzrlib/tests/per_merger.py
