1
# Copyright (C) 2009, 2010, 2011 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 breezy.merge.Merger."""
21
from ..conflicts import TextConflict
28
TestCaseWithTransport,
30
from .test_merge_core import MergeBuilder
33
def load_tests(loader, standard_tests, pattern):
34
"""Multiply tests for tranport implementations."""
35
result = loader.suiteClass()
37
(name, {'merge_type': merger})
38
for name, merger in _mod_merge.merge_type_registry.items()]
39
return multiply_tests(standard_tests, scenarios, result)
42
class TestMergeImplementation(TestCaseWithTransport):
44
def do_merge(self, target_tree, source_tree, **kwargs):
45
merger = _mod_merge.Merger.from_revision_ids(
46
target_tree, source_tree.last_revision(),
47
other_branch=source_tree.branch)
48
merger.merge_type = self.merge_type
49
for name, value in kwargs.items():
50
setattr(merger, name, value)
53
def test_merge_specific_file(self):
54
this_tree = self.make_branch_and_tree('this')
55
this_tree.lock_write()
56
self.addCleanup(this_tree.unlock)
57
self.build_tree_contents([
58
('this/file1', b'a\nb\n'),
59
('this/file2', b'a\nb\n')
61
this_tree.add(['file1', 'file2'])
62
this_tree.commit('Added files')
63
other_tree = this_tree.controldir.sprout('other').open_workingtree()
64
self.build_tree_contents([
65
('other/file1', b'a\nb\nc\n'),
66
('other/file2', b'a\nb\nc\n')
68
other_tree.commit('modified both')
69
self.build_tree_contents([
70
('this/file1', b'd\na\nb\n'),
71
('this/file2', b'd\na\nb\n')
73
this_tree.commit('modified both')
74
self.do_merge(this_tree, other_tree, interesting_files=['file1'])
75
self.assertFileEqual(b'd\na\nb\nc\n', 'this/file1')
76
self.assertFileEqual(b'd\na\nb\n', 'this/file2')
78
def test_merge_move_and_change(self):
79
this_tree = self.make_branch_and_tree('this')
80
this_tree.lock_write()
81
self.addCleanup(this_tree.unlock)
82
self.build_tree_contents([
83
('this/file1', b'line 1\nline 2\nline 3\nline 4\n'),
85
this_tree.add('file1',)
86
this_tree.commit('Added file')
87
other_tree = this_tree.controldir.sprout('other').open_workingtree()
88
self.build_tree_contents([
89
('other/file1', b'line 1\nline 2 to 2.1\nline 3\nline 4\n'),
91
other_tree.commit('Changed 2 to 2.1')
92
self.build_tree_contents([
93
('this/file1', b'line 1\nline 3\nline 2\nline 4\n'),
95
this_tree.commit('Swapped 2 & 3')
96
self.do_merge(this_tree, other_tree)
97
if self.merge_type is _mod_merge.LCAMerger:
99
"lca merge doesn't conflict for move and change",
100
self.assertFileEqual,
108
'>>>>>>> MERGE-SOURCE\n'
109
'line 4\n', 'this/file1')
111
self.assertFileEqual(
119
'>>>>>>> MERGE-SOURCE\n'
120
'line 4\n', 'this/file1')
122
def test_modify_conflicts_with_delete(self):
123
# If one side deletes a line, and the other modifies that line, then
124
# the modification should be considered a conflict
125
builder = self.make_branch_builder('test')
126
builder.start_series()
127
builder.build_snapshot(None,
128
[('add', ('', None, 'directory', None)),
129
('add', ('foo', b'foo-id', 'file', b'a\nb\nc\nd\ne\n')),
130
], revision_id=b'BASE-id')
132
builder.build_snapshot([b'BASE-id'],
133
[('modify', ('foo', b'a\nc\nd\ne\n'))],
134
revision_id=b'OTHER-id')
135
# Modify 'b\n', add 'X\n'
136
builder.build_snapshot([b'BASE-id'],
137
[('modify', ('foo', b'a\nb2\nc\nd\nX\ne\n'))],
138
revision_id=b'THIS-id')
139
builder.finish_series()
140
branch = builder.get_branch()
141
this_tree = branch.controldir.create_workingtree()
142
this_tree.lock_write()
143
self.addCleanup(this_tree.unlock)
144
other_tree = this_tree.controldir.sprout(
145
'other', b'OTHER-id').open_workingtree()
146
self.do_merge(this_tree, other_tree)
147
if self.merge_type is _mod_merge.LCAMerger:
148
self.expectFailure("lca merge doesn't track deleted lines",
149
self.assertFileEqual,
154
'>>>>>>> MERGE-SOURCE\n'
160
self.assertFileEqual(
165
b'>>>>>>> MERGE-SOURCE\n'
171
def get_limbodir_deletiondir(self, wt):
172
transform = wt.get_transform()
173
limbodir = transform._limbodir
174
deletiondir = transform._deletiondir
176
return (limbodir, deletiondir)
178
def test_merge_with_existing_limbo_empty(self):
179
"""Empty limbo dir is just cleaned up - see bug 427773"""
180
wt = self.make_branch_and_tree('this')
181
(limbodir, deletiondir) = self.get_limbodir_deletiondir(wt)
183
self.do_merge(wt, wt)
185
def test_merge_with_existing_limbo_non_empty(self):
186
wt = self.make_branch_and_tree('this')
187
(limbodir, deletiondir) = self.get_limbodir_deletiondir(wt)
189
os.mkdir(os.path.join(limbodir, 'something'))
190
self.assertRaises(errors.ExistingLimbo, self.do_merge, wt, wt)
191
self.assertRaises(errors.LockError, wt.unlock)
193
def test_merge_with_pending_deletion_empty(self):
194
wt = self.make_branch_and_tree('this')
195
(limbodir, deletiondir) = self.get_limbodir_deletiondir(wt)
196
os.mkdir(deletiondir)
197
self.do_merge(wt, wt)
199
def test_merge_with_pending_deletion_non_empty(self):
200
"""Also see bug 427773"""
201
wt = self.make_branch_and_tree('this')
202
(limbodir, deletiondir) = self.get_limbodir_deletiondir(wt)
203
os.mkdir(deletiondir)
204
os.mkdir(os.path.join(deletiondir, 'something'))
205
self.assertRaises(errors.ExistingPendingDeletion,
206
self.do_merge, wt, wt)
207
self.assertRaises(errors.LockError, wt.unlock)
210
class TestHookMergeFileContent(TestCaseWithTransport):
211
"""Tests that the 'merge_file_content' hook is invoked."""
214
super(TestHookMergeFileContent, self).setUp()
217
def install_hook_inactive(self):
218
def inactive_factory(merger):
219
# This hook is never active
220
self.hook_log.append(('inactive',))
222
_mod_merge.Merger.hooks.install_named_hook(
223
'merge_file_content', inactive_factory, 'test hook (inactive)')
225
def install_hook_noop(self):
228
class HookNA(_mod_merge.AbstractPerFileMerger):
229
def merge_contents(self, merge_params):
230
# This hook unconditionally does nothing.
231
test.hook_log.append(('no-op',))
232
return 'not_applicable', None
234
def hook_na_factory(merger):
235
return HookNA(merger)
236
_mod_merge.Merger.hooks.install_named_hook(
237
'merge_file_content', hook_na_factory, 'test hook (no-op)')
239
def install_hook_success(self):
242
class HookSuccess(_mod_merge.AbstractPerFileMerger):
243
def merge_contents(self, merge_params):
244
test.hook_log.append(('success',))
245
if merge_params.this_path == 'name1':
246
return 'success', [b'text-merged-by-hook']
247
return 'not_applicable', None
249
def hook_success_factory(merger):
250
return HookSuccess(merger)
251
_mod_merge.Merger.hooks.install_named_hook(
252
'merge_file_content', hook_success_factory, 'test hook (success)')
254
def install_hook_conflict(self):
257
class HookConflict(_mod_merge.AbstractPerFileMerger):
258
def merge_contents(self, merge_params):
259
test.hook_log.append(('conflict',))
260
if merge_params.this_path == 'name1':
261
return ('conflicted',
262
[b'text-with-conflict-markers-from-hook'])
263
return 'not_applicable', None
265
def hook_conflict_factory(merger):
266
return HookConflict(merger)
267
_mod_merge.Merger.hooks.install_named_hook(
268
'merge_file_content', hook_conflict_factory, 'test hook (delete)')
270
def install_hook_delete(self):
273
class HookDelete(_mod_merge.AbstractPerFileMerger):
274
def merge_contents(self, merge_params):
275
test.hook_log.append(('delete',))
276
if merge_params.this_path == 'name1':
277
return 'delete', None
278
return 'not_applicable', None
280
def hook_delete_factory(merger):
281
return HookDelete(merger)
282
_mod_merge.Merger.hooks.install_named_hook(
283
'merge_file_content', hook_delete_factory, 'test hook (delete)')
285
def install_hook_log_lines(self):
286
"""Install a hook that saves the get_lines for the this, base and other
287
versions of the file.
291
class HookLogLines(_mod_merge.AbstractPerFileMerger):
292
def merge_contents(self, merge_params):
293
test.hook_log.append((
295
merge_params.this_lines,
296
merge_params.other_lines,
297
merge_params.base_lines,
299
return 'not_applicable', None
301
def hook_log_lines_factory(merger):
302
return HookLogLines(merger)
303
_mod_merge.Merger.hooks.install_named_hook(
304
'merge_file_content', hook_log_lines_factory,
305
'test hook (log_lines)')
307
def make_merge_builder(self):
308
builder = MergeBuilder(self.test_base_dir)
309
self.addCleanup(builder.cleanup)
312
def create_file_needing_contents_merge(self, builder, name):
313
file_id = name.encode('ascii') + b'-id'
314
builder.add_file(file_id, builder.tree_root, name, b"text1", True)
315
builder.change_contents(file_id, other=b"text4", this=b"text3")
317
def test_change_vs_change(self):
318
"""Hook is used for (changed, changed)"""
319
self.install_hook_success()
320
builder = self.make_merge_builder()
321
builder.add_file(b"1", builder.tree_root, "name1", b"text1", True)
322
builder.change_contents(b"1", other=b"text4", this=b"text3")
323
conflicts = builder.merge(self.merge_type)
324
self.assertEqual(conflicts, [])
325
with builder.this.get_file('name1') as f:
326
self.assertEqual(f.read(), b'text-merged-by-hook')
328
def test_change_vs_deleted(self):
329
"""Hook is used for (changed, deleted)"""
330
self.install_hook_success()
331
builder = self.make_merge_builder()
332
builder.add_file(b"1", builder.tree_root, "name1", b"text1", True)
333
builder.change_contents(b"1", this=b"text2")
334
builder.remove_file(b"1", other=True)
335
conflicts = builder.merge(self.merge_type)
336
self.assertEqual(conflicts, [])
337
with builder.this.get_file('name1') as f:
338
self.assertEqual(f.read(), b'text-merged-by-hook')
340
def test_result_can_be_delete(self):
341
"""A hook's result can be the deletion of a file."""
342
self.install_hook_delete()
343
builder = self.make_merge_builder()
344
self.create_file_needing_contents_merge(builder, "name1")
345
conflicts = builder.merge(self.merge_type)
346
self.assertEqual(conflicts, [])
347
self.assertFalse(builder.this.is_versioned('name1'))
348
self.assertEqual([], list(builder.this.list_files()))
350
def test_result_can_be_conflict(self):
351
"""A hook's result can be a conflict."""
352
self.install_hook_conflict()
353
builder = self.make_merge_builder()
354
self.create_file_needing_contents_merge(builder, "name1")
355
conflicts = builder.merge(self.merge_type)
356
self.assertEqual(conflicts, [TextConflict('name1', file_id=b'name1-id')])
357
# The hook still gets to set the file contents in this case, so that it
358
# can insert custom conflict markers.
359
with builder.this.get_file('name1') as f:
360
self.assertEqual(f.read(), b'text-with-conflict-markers-from-hook')
362
def test_can_access_this_other_and_base_versions(self):
363
"""The hook function can call params.merger.get_lines to access the
364
THIS/OTHER/BASE versions of the file.
366
self.install_hook_log_lines()
367
builder = self.make_merge_builder()
368
builder.add_file(b"1", builder.tree_root, "name1", b"text1", True)
369
builder.change_contents(b"1", this=b"text2", other=b"text3")
370
conflicts = builder.merge(self.merge_type)
372
[('log_lines', [b'text2'], [b'text3'], [b'text1'])], self.hook_log)
374
def test_chain_when_not_active(self):
375
"""When a hook function returns None, merging still works."""
376
self.install_hook_inactive()
377
self.install_hook_success()
378
builder = self.make_merge_builder()
379
self.create_file_needing_contents_merge(builder, "name1")
380
conflicts = builder.merge(self.merge_type)
381
self.assertEqual(conflicts, [])
382
with builder.this.get_file('name1') as f:
383
self.assertEqual(f.read(), b'text-merged-by-hook')
384
self.assertEqual([('inactive',), ('success',)], self.hook_log)
386
def test_chain_when_not_applicable(self):
387
"""When a hook function returns not_applicable, the next function is
388
tried (when one exists).
390
self.install_hook_noop()
391
self.install_hook_success()
392
builder = self.make_merge_builder()
393
self.create_file_needing_contents_merge(builder, "name1")
394
conflicts = builder.merge(self.merge_type)
395
self.assertEqual(conflicts, [])
396
with builder.this.get_file('name1') as f:
397
self.assertEqual(f.read(), b'text-merged-by-hook')
398
self.assertEqual([('no-op',), ('success',)], self.hook_log)
400
def test_chain_stops_after_success(self):
401
"""When a hook function returns success, no later functions are tried.
403
self.install_hook_success()
404
self.install_hook_noop()
405
builder = self.make_merge_builder()
406
self.create_file_needing_contents_merge(builder, "name1")
407
conflicts = builder.merge(self.merge_type)
408
self.assertEqual([('success',)], self.hook_log)
410
def test_chain_stops_after_conflict(self):
411
"""When a hook function returns conflict, no later functions are tried.
413
self.install_hook_conflict()
414
self.install_hook_noop()
415
builder = self.make_merge_builder()
416
self.create_file_needing_contents_merge(builder, "name1")
417
conflicts = builder.merge(self.merge_type)
418
self.assertEqual([('conflict',)], self.hook_log)
420
def test_chain_stops_after_delete(self):
421
"""When a hook function returns delete, no later functions are tried.
423
self.install_hook_delete()
424
self.install_hook_noop()
425
builder = self.make_merge_builder()
426
self.create_file_needing_contents_merge(builder, "name1")
427
conflicts = builder.merge(self.merge_type)
428
self.assertEqual([('delete',)], self.hook_log)
added
removed
breezy/tests/per_merger.py
