1
# Copyright (C) 2006-2009, 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
"""Whitebox tests for annotate functionality."""
20
from cStringIO import StringIO
30
return [tuple(l.split(' ', 1)) for l in text.splitlines(True)]
33
parent_1 = annotation("""\
42
parent_2 = annotation("""\
52
expected_2_1 = annotation("""\
61
# a: in both, same value, kept
63
# c: in both, same value, kept
64
# d: in both, same value, kept
65
# e: 1 and 2 disagree, so it goes to blahblah
66
# f: in 2, but not in new, so ignored
67
# g: not in 1 or 2, so it goes to blahblah
68
# h: only in parent 2, so 2 gets it
69
expected_1_2_2 = annotation("""\
88
expected_1 = annotation("""\
108
# For the 'duplicate' series, both sides introduce the same change, which then
109
# gets merged around. The last-modified should properly reflect this.
110
# We always change the fourth line so that the file is properly tracked as
111
# being modified in each revision. In reality, this probably would happen over
112
# many revisions, and it would be a different line that changes.
115
# A B # line should be annotated as new for A and B
117
# C D # line should 'converge' and say A
119
# E # D should supersede A and stay as D (not become E because C references
121
duplicate_base = annotation("""\
128
duplicate_A = annotation("""\
135
duplicate_B = annotation("""\
142
duplicate_C = annotation("""\
149
duplicate_D = annotation("""\
156
duplicate_E = annotation("""\
164
class TestAnnotate(tests.TestCaseWithTransport):
166
def create_merged_trees(self):
167
"""create 2 trees with merges between them.
177
builder = self.make_branch_builder('branch')
178
builder.start_series()
179
self.addCleanup(builder.finish_series)
180
builder.build_snapshot('rev-1', None, [
181
('add', ('', 'root-id', 'directory', None)),
182
('add', ('a', 'a-id', 'file', 'first\n')),
183
], timestamp=1166046000.00, timezone=0, committer="joe@foo.com")
184
builder.build_snapshot('rev-2', ['rev-1'], [
185
('modify', ('a-id', 'first\nsecond\n')),
186
], timestamp=1166046001.00, timezone=0, committer="joe@foo.com")
187
builder.build_snapshot('rev-1_1_1', ['rev-1'], [
188
('modify', ('a-id', 'first\nthird\n')),
189
], timestamp=1166046002.00, timezone=0, committer="barry@foo.com")
190
builder.build_snapshot('rev-3', ['rev-2', 'rev-1_1_1'], [
191
('modify', ('a-id', 'first\nsecond\nthird\n')),
192
], timestamp=1166046003.00, timezone=0, committer="sal@foo.com")
195
def create_deeply_merged_trees(self):
196
"""Create some trees with a more complex merge history.
204
rev-3 rev-1_1_2 rev-1_2_1 ------+
208
rev-4 rev-1_2_2 rev-1_3_1
210
+-----------------+ |
214
+--------------------------------+
218
builder = self.create_merged_trees()
219
builder.build_snapshot('rev-1_1_2', ['rev-1_1_1'], [])
220
builder.build_snapshot('rev-4', ['rev-3', 'rev-1_1_2'], [])
221
builder.build_snapshot('rev-1_2_1', ['rev-1_1_1'], [
222
('modify', ('a-id', 'first\nthird\nfourth\n')),
223
], timestamp=1166046003.00, timezone=0, committer="jerry@foo.com")
224
builder.build_snapshot('rev-1_2_2', ['rev-1_2_1'], [],
225
timestamp=1166046004.00, timezone=0, committer="jerry@foo.com")
226
builder.build_snapshot('rev-5', ['rev-4', 'rev-1_2_2'], [
227
('modify', ('a-id', 'first\nsecond\nthird\nfourth\n')),
228
], timestamp=1166046004.00, timezone=0, committer="jerry@foo.com")
229
builder.build_snapshot('rev-1_3_1', ['rev-1_2_1'], [
230
('modify', ('a-id', 'first\nthird\nfourth\nfifth\nsixth\n')),
231
], timestamp=1166046005.00, timezone=0, committer="george@foo.com")
232
builder.build_snapshot('rev-6', ['rev-5', 'rev-1_3_1'], [
234
'first\nsecond\nthird\nfourth\nfifth\nsixth\n')),
238
def create_duplicate_lines_tree(self):
239
builder = self.make_branch_builder('branch')
240
builder.start_series()
241
self.addCleanup(builder.finish_series)
242
base_text = ''.join(l for r, l in duplicate_base)
243
a_text = ''.join(l for r, l in duplicate_A)
244
b_text = ''.join(l for r, l in duplicate_B)
245
c_text = ''.join(l for r, l in duplicate_C)
246
d_text = ''.join(l for r, l in duplicate_D)
247
e_text = ''.join(l for r, l in duplicate_E)
248
builder.build_snapshot('rev-base', None, [
249
('add', ('', 'root-id', 'directory', None)),
250
('add', ('file', 'file-id', 'file', base_text)),
252
builder.build_snapshot('rev-A', ['rev-base'], [
253
('modify', ('file-id', a_text))])
254
builder.build_snapshot('rev-B', ['rev-base'], [
255
('modify', ('file-id', b_text))])
256
builder.build_snapshot('rev-C', ['rev-A'], [
257
('modify', ('file-id', c_text))])
258
builder.build_snapshot('rev-D', ['rev-B', 'rev-A'], [
259
('modify', ('file-id', d_text))])
260
builder.build_snapshot('rev-E', ['rev-C', 'rev-D'], [
261
('modify', ('file-id', e_text))])
264
def assertAnnotateEqualDiff(self, actual, expected):
265
if actual != expected:
266
# Create an easier to understand diff when the lines don't actually
268
self.assertEqualDiff(''.join('\t'.join(l) for l in expected),
269
''.join('\t'.join(l) for l in actual))
271
def assertBranchAnnotate(self, expected, branch, file_id, revision_id,
272
verbose=False, full=False, show_ids=False):
273
tree = branch.repository.revision_tree(revision_id)
275
annotate.annotate_file_tree(tree, file_id, to_file,
276
verbose=verbose, full=full, show_ids=show_ids, branch=branch)
277
self.assertAnnotateEqualDiff(to_file.getvalue(), expected)
279
def assertRepoAnnotate(self, expected, repo, file_id, revision_id):
280
"""Assert that the revision is properly annotated."""
281
actual = list(repo.revision_tree(revision_id).annotate_iter(file_id))
282
self.assertAnnotateEqualDiff(actual, expected)
284
def test_annotate_duplicate_lines(self):
285
# XXX: Should this be a per_repository test?
286
builder = self.create_duplicate_lines_tree()
287
repo = builder.get_branch().repository
289
self.addCleanup(repo.unlock)
290
self.assertRepoAnnotate(duplicate_base, repo, 'file-id', 'rev-base')
291
self.assertRepoAnnotate(duplicate_A, repo, 'file-id', 'rev-A')
292
self.assertRepoAnnotate(duplicate_B, repo, 'file-id', 'rev-B')
293
self.assertRepoAnnotate(duplicate_C, repo, 'file-id', 'rev-C')
294
self.assertRepoAnnotate(duplicate_D, repo, 'file-id', 'rev-D')
295
self.assertRepoAnnotate(duplicate_E, repo, 'file-id', 'rev-E')
297
def test_annotate_shows_dotted_revnos(self):
298
builder = self.create_merged_trees()
300
self.assertBranchAnnotate('1 joe@foo | first\n'
301
'2 joe@foo | second\n'
302
'1.1.1 barry@f | third\n',
303
builder.get_branch(), 'a-id', 'rev-3')
305
def test_annotate_file(self):
306
builder = self.create_merged_trees()
309
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
310
annotate.annotate_file, builder.get_branch(),
311
'rev-3', 'a-id', to_file=to_file)
313
self.assertAnnotateEqualDiff('1 joe@foo | first\n'
314
'2 joe@foo | second\n'
315
'1.1.1 barry@f | third\n',
318
def test_annotate_limits_dotted_revnos(self):
319
"""Annotate should limit dotted revnos to a depth of 12"""
320
builder = self.create_deeply_merged_trees()
322
self.assertBranchAnnotate('1 joe@foo | first\n'
323
'2 joe@foo | second\n'
324
'1.1.1 barry@f | third\n'
325
'1.2.1 jerry@f | fourth\n'
326
'1.3.1 george@ | fifth\n'
328
builder.get_branch(), 'a-id', 'rev-6',
329
verbose=False, full=False)
331
self.assertBranchAnnotate('1 joe@foo | first\n'
332
'2 joe@foo | second\n'
333
'1.1.1 barry@f | third\n'
334
'1.2.1 jerry@f | fourth\n'
335
'1.3.1 george@ | fifth\n'
336
'1.3.1 george@ | sixth\n',
337
builder.get_branch(), 'a-id', 'rev-6',
338
verbose=False, full=True)
340
# verbose=True shows everything, the full revno, user id, and date
341
self.assertBranchAnnotate('1 joe@foo.com 20061213 | first\n'
342
'2 joe@foo.com 20061213 | second\n'
343
'1.1.1 barry@foo.com 20061213 | third\n'
344
'1.2.1 jerry@foo.com 20061213 | fourth\n'
345
'1.3.1 george@foo.com 20061213 | fifth\n'
347
builder.get_branch(), 'a-id', 'rev-6',
348
verbose=True, full=False)
350
self.assertBranchAnnotate('1 joe@foo.com 20061213 | first\n'
351
'2 joe@foo.com 20061213 | second\n'
352
'1.1.1 barry@foo.com 20061213 | third\n'
353
'1.2.1 jerry@foo.com 20061213 | fourth\n'
354
'1.3.1 george@foo.com 20061213 | fifth\n'
355
'1.3.1 george@foo.com 20061213 | sixth\n',
356
builder.get_branch(), 'a-id', 'rev-6',
357
verbose=True, full=True)
359
def test_annotate_uses_branch_context(self):
360
"""Dotted revnos should use the Branch context.
362
When annotating a non-mainline revision, the annotation should still
363
use dotted revnos from the mainline.
365
builder = self.create_deeply_merged_trees()
367
self.assertBranchAnnotate('1 joe@foo | first\n'
368
'1.1.1 barry@f | third\n'
369
'1.2.1 jerry@f | fourth\n'
370
'1.3.1 george@ | fifth\n'
372
builder.get_branch(), 'a-id', 'rev-1_3_1',
373
verbose=False, full=False)
375
def test_annotate_show_ids(self):
376
builder = self.create_deeply_merged_trees()
378
# It looks better with real revision ids :)
379
self.assertBranchAnnotate(' rev-1 | first\n'
381
'rev-1_1_1 | third\n'
382
'rev-1_2_1 | fourth\n'
383
'rev-1_3_1 | fifth\n'
385
builder.get_branch(), 'a-id', 'rev-6',
386
show_ids=True, full=False)
388
self.assertBranchAnnotate(' rev-1 | first\n'
390
'rev-1_1_1 | third\n'
391
'rev-1_2_1 | fourth\n'
392
'rev-1_3_1 | fifth\n'
393
'rev-1_3_1 | sixth\n',
394
builder.get_branch(), 'a-id', 'rev-6',
395
show_ids=True, full=True)
397
def test_annotate_unicode_author(self):
398
tree1 = self.make_branch_and_tree('tree1')
400
self.build_tree_contents([('tree1/a', 'adi\xc3\xb3s')])
401
tree1.add(['a'], ['a-id'])
402
tree1.commit('a', rev_id='rev-1',
403
committer=u'Pepe P\xe9rez <pperez@ejemplo.com>',
404
timestamp=1166046000.00, timezone=0)
406
self.build_tree_contents([('tree1/b', 'bye')])
407
tree1.add(['b'], ['b-id'])
408
tree1.commit('b', rev_id='rev-2',
409
committer=u'p\xe9rez',
410
timestamp=1166046000.00, timezone=0)
413
self.addCleanup(tree1.unlock)
415
revtree_1 = tree1.branch.repository.revision_tree('rev-1')
416
revtree_2 = tree1.branch.repository.revision_tree('rev-2')
418
# this passes if no exception is raised
420
annotate.annotate_file_tree(revtree_1, 'a-id',
421
to_file=to_file, branch=tree1.branch)
424
to_file = codecs.getwriter('ascii')(sio)
425
to_file.encoding = 'ascii' # codecs does not set it
426
annotate.annotate_file_tree(revtree_2, 'b-id',
427
to_file=to_file, branch=tree1.branch)
428
self.assertEqualDiff('2 p?rez | bye\n', sio.getvalue())
430
# test now with to_file.encoding = None
431
to_file = tests.StringIOWrapper()
432
to_file.encoding = None
433
annotate.annotate_file_tree(revtree_2, 'b-id',
434
to_file=to_file, branch=tree1.branch)
435
self.assertContainsRe('2 p.rez | bye\n', to_file.getvalue())
437
# and when it does not exist
439
annotate.annotate_file_tree(revtree_2, 'b-id',
440
to_file=to_file, branch=tree1.branch)
441
self.assertContainsRe('2 p.rez | bye\n', to_file.getvalue())
443
def test_annotate_author_or_committer(self):
444
tree1 = self.make_branch_and_tree('tree1')
446
self.build_tree_contents([('tree1/a', 'hello')])
447
tree1.add(['a'], ['a-id'])
448
tree1.commit('a', rev_id='rev-1',
449
committer='Committer <committer@example.com>',
450
timestamp=1166046000.00, timezone=0)
452
self.build_tree_contents([('tree1/b', 'bye')])
453
tree1.add(['b'], ['b-id'])
454
tree1.commit('b', rev_id='rev-2',
455
committer='Committer <committer@example.com>',
456
authors=['Author <author@example.com>'],
457
timestamp=1166046000.00, timezone=0)
460
self.addCleanup(tree1.unlock)
462
self.assertBranchAnnotate('1 committ | hello\n', tree1.branch,
466
self.assertBranchAnnotate('2 author@ | bye\n', tree1.branch,
470
class TestReannotate(tests.TestCase):
472
def annotateEqual(self, expected, parents, newlines, revision_id,
474
annotate_list = list(annotate.reannotate(parents, newlines,
475
revision_id, blocks))
476
self.assertEqual(len(expected), len(annotate_list))
477
for e, a in zip(expected, annotate_list):
478
self.assertEqual(e, a)
480
def test_reannotate(self):
481
self.annotateEqual(parent_1, [parent_1], new_1, 'blahblah')
482
self.annotateEqual(expected_2_1, [parent_2], new_1, 'blahblah')
483
self.annotateEqual(expected_1_2_2, [parent_1, parent_2], new_2,
486
def test_reannotate_no_parents(self):
487
self.annotateEqual(expected_1, [], new_1, 'blahblah')
489
def test_reannotate_left_matching_blocks(self):
490
"""Ensure that left_matching_blocks has an impact.
492
In this case, the annotation is ambiguous, so the hint isn't actually
495
parent = [('rev1', 'a\n')]
496
new_text = ['a\n', 'a\n']
497
blocks = [(0, 0, 1), (1, 2, 0)]
498
self.annotateEqual([('rev1', 'a\n'), ('rev2', 'a\n')], [parent],
499
new_text, 'rev2', blocks)
500
blocks = [(0, 1, 1), (1, 2, 0)]
501
self.annotateEqual([('rev2', 'a\n'), ('rev1', 'a\n')], [parent],
502
new_text, 'rev2', blocks)
added
removed
bzrlib/tests/test_annotate.py
