← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_annotate.py

  • Committer: Martin Pool
  • Date: 2008-03-16 08:25:21 UTC
  • mto: (3280.2.2 prepare-1.3)
  • mto: This revision was merged to the branch mainline in revision 3284.
  • Revision ID: mbp@sourcefrog.net-20080316082521-xmex8wq1uyj6cxyh
Fix doctest syntax

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_annotate.py
16
16
 
17
17
"""Whitebox tests for annotate functionality."""
18
18
 
 
19
import codecs
19
20
from cStringIO import StringIO
20
21
 
21
22
from bzrlib import (
86
87
e
87
88
""".splitlines(True)
88
89
 
 
90
expected_1 = annotation("""\
 
91
blahblah a
 
92
blahblah b
 
93
blahblah c
 
94
blahblah d
 
95
blahblah e
 
96
""")
 
97
 
89
98
 
90
99
new_2 = """\
91
100
a
98
107
""".splitlines(True)
99
108
 
100
109
 
 
110
# For the 'duplicate' series, both sides introduce the same change, which then
 
111
# gets merged around. The last-modified should properly reflect this.
 
112
# We always change the fourth line so that the file is properly tracked as
 
113
# being modified in each revision. In reality, this probably would happen over
 
114
# many revisions, and it would be a different line that changes.
 
115
# BASE
 
116
#  |\
 
117
#  A B  # line should be annotated as new for A and B
 
118
#  |\|
 
119
#  C D  # line should 'converge' and say D
 
120
#  |/
 
121
#  E    # D should supersede A and stay as D (not become E because C references
 
122
#         A)
 
123
duplicate_base = annotation("""\
 
124
rev-base first
 
125
rev-base second
 
126
rev-base third
 
127
rev-base fourth-base
 
128
""")
 
129
 
 
130
duplicate_A = annotation("""\
 
131
rev-base first
 
132
rev-A alt-second
 
133
rev-base third
 
134
rev-A fourth-A
 
135
""")
 
136
 
 
137
duplicate_B = annotation("""\
 
138
rev-base first
 
139
rev-B alt-second
 
140
rev-base third
 
141
rev-B fourth-B
 
142
""")
 
143
 
 
144
duplicate_C = annotation("""\
 
145
rev-base first
 
146
rev-A alt-second
 
147
rev-base third
 
148
rev-C fourth-C
 
149
""")
 
150
 
 
151
duplicate_D = annotation("""\
 
152
rev-base first
 
153
rev-D alt-second
 
154
rev-base third
 
155
rev-D fourth-D
 
156
""")
 
157
 
 
158
duplicate_E = annotation("""\
 
159
rev-base first
 
160
rev-D alt-second
 
161
rev-base third
 
162
rev-E fourth-E
 
163
""")
 
164
 
 
165
 
101
166
class TestAnnotate(tests.TestCaseWithTransport):
102
167
 
103
168
    def create_merged_trees(self):
140
205
        tree1.commit('merge 2', rev_id='rev-3',
141
206
                     committer='sal@foo.com',
142
207
                     timestamp=1166046003.00, timezone=0)
 
208
        tree1.lock_read()
 
209
        self.addCleanup(tree1.unlock)
143
210
        return tree1, tree2
144
211
 
145
212
    def create_deeply_merged_trees(self):
151
218
         |      |          |
152
219
         +------+          |
153
220
         |      |          |
154
 
        rev-3  rev-1_1_2  rev-1_1_1_1_1 --+
 
221
        rev-3  rev-1_1_2  rev-1_2_1 ------+
155
222
         |      |          |              |
156
223
         +------+          |              |
157
224
         |                 |              |
158
 
        rev-4             rev-1_1_1_1_2  rev-1_1_1_1_1_1_1
 
225
        rev-4             rev-1_2_2  rev-1_3_1
159
226
         |                 |              |
160
227
         +-----------------+              |
161
228
         |                                |
166
233
        rev-6
167
234
        """
168
235
        tree1, tree2 = self.create_merged_trees()
 
236
        tree1.unlock()
169
237
 
170
238
        tree3 = tree2.bzrdir.clone('tree3').open_workingtree()
171
239
 
174
242
        tree1.commit('noop merge', rev_id='rev-4')
175
243
 
176
244
        self.build_tree_contents([('tree3/a', 'first\nthird\nfourth\n')])
177
 
        tree3.commit('four', rev_id='rev-1_1_1_1_1',
 
245
        tree3.commit('four', rev_id='rev-1_2_1',
178
246
                     committer='jerry@foo.com',
179
247
                     timestamp=1166046003.00, timezone=0)
180
248
 
181
249
        tree4 = tree3.bzrdir.clone('tree4').open_workingtree()
182
250
 
183
 
        tree3.commit('noop', rev_id='rev-1_1_1_1_2',
 
251
        tree3.commit('noop', rev_id='rev-1_2_2',
184
252
                     committer='jerry@foo.com',
185
253
                     timestamp=1166046004.00, timezone=0)
186
254
        self.assertEqual(0, tree1.merge_from_branch(tree3.branch))
188
256
 
189
257
        self.build_tree_contents([('tree4/a',
190
258
                                   'first\nthird\nfourth\nfifth\nsixth\n')])
191
 
        tree4.commit('five and six', rev_id='rev-1_1_1_1_1_1_1',
 
259
        tree4.commit('five and six', rev_id='rev-1_3_1',
192
260
                     committer='george@foo.com',
193
261
                     timestamp=1166046005.00, timezone=0)
194
262
        self.assertEqual(0, tree1.merge_from_branch(tree4.branch))
195
263
        tree1.commit('merge five and six', rev_id='rev-6')
196
 
        return tree1
 
264
        tree1.lock_read()
 
265
        return tree1
 
266
 
 
267
    def create_duplicate_lines_tree(self):
 
268
        tree1 = self.make_branch_and_tree('tree1')
 
269
        base_text = ''.join(l for r, l in duplicate_base)
 
270
        a_text = ''.join(l for r, l in duplicate_A)
 
271
        b_text = ''.join(l for r, l in duplicate_B)
 
272
        c_text = ''.join(l for r, l in duplicate_C)
 
273
        d_text = ''.join(l for r, l in duplicate_D)
 
274
        e_text = ''.join(l for r, l in duplicate_E)
 
275
        self.build_tree_contents([('tree1/file', base_text)])
 
276
        tree1.add(['file'], ['file-id'])
 
277
        tree1.commit('base', rev_id='rev-base')
 
278
        tree2 = tree1.bzrdir.clone('tree2').open_workingtree()
 
279
 
 
280
        self.build_tree_contents([('tree1/file', a_text),
 
281
                                  ('tree2/file', b_text)])
 
282
        tree1.commit('A', rev_id='rev-A')
 
283
        tree2.commit('B', rev_id='rev-B')
 
284
 
 
285
        tree2.merge_from_branch(tree1.branch)
 
286
        conflicts.resolve(tree2, None) # Resolve the conflicts
 
287
        self.build_tree_contents([('tree2/file', d_text)])
 
288
        tree2.commit('D', rev_id='rev-D')
 
289
 
 
290
        self.build_tree_contents([('tree1/file', c_text)])
 
291
        tree1.commit('C', rev_id='rev-C')
 
292
 
 
293
        tree1.merge_from_branch(tree2.branch)
 
294
        conflicts.resolve(tree1, None) # Resolve the conflicts
 
295
        self.build_tree_contents([('tree1/file', e_text)])
 
296
        tree1.commit('E', rev_id='rev-E')
 
297
        return tree1
 
298
 
 
299
    def assertRepoAnnotate(self, expected, repo, file_id, revision_id):
 
300
        """Assert that the revision is properly annotated."""
 
301
        actual = list(repo.revision_tree(revision_id).annotate_iter(file_id))
 
302
        if actual != expected:
 
303
            # Create an easier to understand diff when the lines don't actually
 
304
            # match
 
305
            self.assertEqualDiff(''.join('\t'.join(l) for l in expected),
 
306
                                 ''.join('\t'.join(l) for l in actual))
 
307
 
 
308
    def test_annotate_duplicate_lines(self):
 
309
        # XXX: Should this be a repository_implementations test?
 
310
        tree1 = self.create_duplicate_lines_tree()
 
311
        repo = tree1.branch.repository
 
312
        repo.lock_read()
 
313
        self.addCleanup(repo.unlock)
 
314
        self.assertRepoAnnotate(duplicate_base, repo, 'file-id', 'rev-base')
 
315
        self.assertRepoAnnotate(duplicate_A, repo, 'file-id', 'rev-A')
 
316
        self.assertRepoAnnotate(duplicate_B, repo, 'file-id', 'rev-B')
 
317
        self.assertRepoAnnotate(duplicate_C, repo, 'file-id', 'rev-C')
 
318
        self.assertRepoAnnotate(duplicate_D, repo, 'file-id', 'rev-D')
 
319
        self.assertRepoAnnotate(duplicate_E, repo, 'file-id', 'rev-E')
197
320
 
198
321
    def test_annotate_shows_dotted_revnos(self):
199
322
        tree1, tree2 = self.create_merged_trees()
213
336
        sio = StringIO()
214
337
        annotate.annotate_file(tree1.branch, 'rev-6', 'a-id',
215
338
                               to_file=sio, verbose=False, full=False)
216
 
        self.assertEqualDiff('1            joe@foo | first\n'
217
 
                             '2            joe@foo | second\n'
218
 
                             '1.1.1        barry@f | third\n'
219
 
                             '1.1.1.1.1    jerry@f | fourth\n'
220
 
                             '1.1.1.1.1.1> george@ | fifth\n'
221
 
                             '                     | sixth\n',
 
339
        self.assertEqualDiff('1     joe@foo | first\n'
 
340
                             '2     joe@foo | second\n'
 
341
                             '1.1.1 barry@f | third\n'
 
342
                             '1.2.1 jerry@f | fourth\n'
 
343
                             '1.3.1 george@ | fifth\n'
 
344
                             '              | sixth\n',
222
345
                             sio.getvalue())
223
346
 
224
347
        sio = StringIO()
225
348
        annotate.annotate_file(tree1.branch, 'rev-6', 'a-id',
226
349
                               to_file=sio, verbose=False, full=True)
227
 
        self.assertEqualDiff('1            joe@foo | first\n'
228
 
                             '2            joe@foo | second\n'
229
 
                             '1.1.1        barry@f | third\n'
230
 
                             '1.1.1.1.1    jerry@f | fourth\n'
231
 
                             '1.1.1.1.1.1> george@ | fifth\n'
232
 
                             '1.1.1.1.1.1> george@ | sixth\n',
 
350
        self.assertEqualDiff('1     joe@foo | first\n'
 
351
                             '2     joe@foo | second\n'
 
352
                             '1.1.1 barry@f | third\n'
 
353
                             '1.2.1 jerry@f | fourth\n'
 
354
                             '1.3.1 george@ | fifth\n'
 
355
                             '1.3.1 george@ | sixth\n',
233
356
                             sio.getvalue())
234
357
 
235
358
        # verbose=True shows everything, the full revno, user id, and date
236
359
        sio = StringIO()
237
360
        annotate.annotate_file(tree1.branch, 'rev-6', 'a-id',
238
361
                               to_file=sio, verbose=True, full=False)
239
 
        self.assertEqualDiff('1             joe@foo.com    20061213 | first\n'
240
 
                             '2             joe@foo.com    20061213 | second\n'
241
 
                             '1.1.1         barry@foo.com  20061213 | third\n'
242
 
                             '1.1.1.1.1     jerry@foo.com  20061213 | fourth\n'
243
 
                             '1.1.1.1.1.1.1 george@foo.com 20061213 | fifth\n'
244
 
                             '                                      | sixth\n',
 
362
        self.assertEqualDiff('1     joe@foo.com    20061213 | first\n'
 
363
                             '2     joe@foo.com    20061213 | second\n'
 
364
                             '1.1.1 barry@foo.com  20061213 | third\n'
 
365
                             '1.2.1 jerry@foo.com  20061213 | fourth\n'
 
366
                             '1.3.1 george@foo.com 20061213 | fifth\n'
 
367
                             '                              | sixth\n',
245
368
                             sio.getvalue())
246
369
 
247
370
        sio = StringIO()
248
371
        annotate.annotate_file(tree1.branch, 'rev-6', 'a-id',
249
372
                               to_file=sio, verbose=True, full=True)
250
 
        self.assertEqualDiff('1             joe@foo.com    20061213 | first\n'
251
 
                             '2             joe@foo.com    20061213 | second\n'
252
 
                             '1.1.1         barry@foo.com  20061213 | third\n'
253
 
                             '1.1.1.1.1     jerry@foo.com  20061213 | fourth\n'
254
 
                             '1.1.1.1.1.1.1 george@foo.com 20061213 | fifth\n'
255
 
                             '1.1.1.1.1.1.1 george@foo.com 20061213 | sixth\n',
 
373
        self.assertEqualDiff('1     joe@foo.com    20061213 | first\n'
 
374
                             '2     joe@foo.com    20061213 | second\n'
 
375
                             '1.1.1 barry@foo.com  20061213 | third\n'
 
376
                             '1.2.1 jerry@foo.com  20061213 | fourth\n'
 
377
                             '1.3.1 george@foo.com 20061213 | fifth\n'
 
378
                             '1.3.1 george@foo.com 20061213 | sixth\n',
256
379
                             sio.getvalue())
257
380
 
258
381
    def test_annotate_uses_branch_context(self):
264
387
        tree1 = self.create_deeply_merged_trees()
265
388
 
266
389
        sio = StringIO()
267
 
        annotate.annotate_file(tree1.branch, 'rev-1_1_1_1_1_1_1', 'a-id',
 
390
        annotate.annotate_file(tree1.branch, 'rev-1_3_1', 'a-id',
268
391
                               to_file=sio, verbose=False, full=False)
269
 
        self.assertEqualDiff('1            joe@foo | first\n'
270
 
                             '1.1.1        barry@f | third\n'
271
 
                             '1.1.1.1.1    jerry@f | fourth\n'
272
 
                             '1.1.1.1.1.1> george@ | fifth\n'
273
 
                             '                     | sixth\n',
 
392
        self.assertEqualDiff('1     joe@foo | first\n'
 
393
                             '1.1.1 barry@f | third\n'
 
394
                             '1.2.1 jerry@f | fourth\n'
 
395
                             '1.3.1 george@ | fifth\n'
 
396
                             '              | sixth\n',
274
397
                             sio.getvalue())
275
398
 
276
399
    def test_annotate_show_ids(self):
281
404
                               to_file=sio, show_ids=True, full=False)
282
405
 
283
406
        # It looks better with real revision ids :)
284
 
        self.assertEqualDiff('            rev-1 | first\n'
285
 
                             '            rev-2 | second\n'
286
 
                             '        rev-1_1_1 | third\n'
287
 
                             '    rev-1_1_1_1_1 | fourth\n'
288
 
                             'rev-1_1_1_1_1_1_1 | fifth\n'
289
 
                             '                  | sixth\n',
 
407
        self.assertEqualDiff('    rev-1 | first\n'
 
408
                             '    rev-2 | second\n'
 
409
                             'rev-1_1_1 | third\n'
 
410
                             'rev-1_2_1 | fourth\n'
 
411
                             'rev-1_3_1 | fifth\n'
 
412
                             '          | sixth\n',
290
413
                             sio.getvalue())
291
414
 
292
415
        sio = StringIO()
293
416
        annotate.annotate_file(tree1.branch, 'rev-6', 'a-id',
294
417
                               to_file=sio, show_ids=True, full=True)
295
418
 
296
 
        self.assertEqualDiff('            rev-1 | first\n'
297
 
                             '            rev-2 | second\n'
298
 
                             '        rev-1_1_1 | third\n'
299
 
                             '    rev-1_1_1_1_1 | fourth\n'
300
 
                             'rev-1_1_1_1_1_1_1 | fifth\n'
301
 
                             'rev-1_1_1_1_1_1_1 | sixth\n',
 
419
        self.assertEqualDiff('    rev-1 | first\n'
 
420
                             '    rev-2 | second\n'
 
421
                             'rev-1_1_1 | third\n'
 
422
                             'rev-1_2_1 | fourth\n'
 
423
                             'rev-1_3_1 | fifth\n'
 
424
                             'rev-1_3_1 | sixth\n',
302
425
                             sio.getvalue())
303
426
 
 
427
    def test_annotate_unicode_author(self):
 
428
        tree1 = self.make_branch_and_tree('tree1')
 
429
 
 
430
        self.build_tree_contents([('tree1/a', 'adi\xc3\xb3s')])
 
431
        tree1.add(['a'], ['a-id'])
 
432
        tree1.commit('a', rev_id='rev-1',
 
433
                     committer=u'Pepe P\xe9rez <pperez@ejemplo.com>',
 
434
                     timestamp=1166046000.00, timezone=0)
 
435
 
 
436
        self.build_tree_contents([('tree1/b', 'bye')])
 
437
        tree1.add(['b'], ['b-id'])
 
438
        tree1.commit('b', rev_id='rev-2',
 
439
                     committer=u'p\xe9rez',
 
440
                     timestamp=1166046000.00, timezone=0)
 
441
 
 
442
        tree1.lock_read()
 
443
        self.addCleanup(tree1.unlock)
 
444
        # this passes if no exception is raised
 
445
        to_file = StringIO()
 
446
        annotate.annotate_file(tree1.branch, 'rev-1', 'a-id', to_file=to_file)
 
447
 
 
448
        sio = StringIO()
 
449
        to_file = codecs.getwriter('ascii')(sio)
 
450
        to_file.encoding = 'ascii' # codecs does not set it
 
451
        annotate.annotate_file(tree1.branch, 'rev-2', 'b-id', to_file=to_file)
 
452
        self.assertEqualDiff('2   p?rez   | bye\n', sio.getvalue())
 
453
 
 
454
        # test now with to_file.encoding = None
 
455
        to_file = tests.StringIOWrapper()
 
456
        to_file.encoding = None
 
457
        annotate.annotate_file(tree1.branch, 'rev-2', 'b-id', to_file=to_file)
 
458
        self.assertContainsRe('2   p.rez   | bye\n', to_file.getvalue())
 
459
 
 
460
        # and when it does not exist
 
461
        to_file = StringIO()
 
462
        annotate.annotate_file(tree1.branch, 'rev-2', 'b-id', to_file=to_file)
 
463
        self.assertContainsRe('2   p.rez   | bye\n', to_file.getvalue())
 
464
 
 
465
    def test_annotate_author_or_committer(self):
 
466
        tree1 = self.make_branch_and_tree('tree1')
 
467
 
 
468
        self.build_tree_contents([('tree1/a', 'hello')])
 
469
        tree1.add(['a'], ['a-id'])
 
470
        tree1.commit('a', rev_id='rev-1',
 
471
                     committer='Committer <committer@example.com>',
 
472
                     timestamp=1166046000.00, timezone=0)
 
473
 
 
474
        self.build_tree_contents([('tree1/b', 'bye')])
 
475
        tree1.add(['b'], ['b-id'])
 
476
        tree1.commit('b', rev_id='rev-2',
 
477
                     committer='Committer <committer@example.com>',
 
478
                     author='Author <author@example.com>',
 
479
                     timestamp=1166046000.00, timezone=0)
 
480
 
 
481
        tree1.lock_read()
 
482
        self.addCleanup(tree1.unlock)
 
483
        to_file = StringIO()
 
484
        annotate.annotate_file(tree1.branch, 'rev-1', 'a-id', to_file=to_file)
 
485
        self.assertEqual('1   committ | hello\n', to_file.getvalue())
 
486
 
 
487
        to_file = StringIO()
 
488
        annotate.annotate_file(tree1.branch, 'rev-2', 'b-id', to_file=to_file)
 
489
        self.assertEqual('2   author@ | bye\n', to_file.getvalue())
 
490
 
304
491
 
305
492
class TestReannotate(tests.TestCase):
306
493
 
307
 
    def annotateEqual(self, expected, parents, newlines, revision_id):
 
494
    def annotateEqual(self, expected, parents, newlines, revision_id,
 
495
                      blocks=None):
308
496
        annotate_list = list(annotate.reannotate(parents, newlines,
309
 
                             revision_id))
 
497
                             revision_id, blocks))
310
498
        self.assertEqual(len(expected), len(annotate_list))
311
499
        for e, a in zip(expected, annotate_list):
312
500
            self.assertEqual(e, a)
316
504
        self.annotateEqual(expected_2_1, [parent_2], new_1, 'blahblah')
317
505
        self.annotateEqual(expected_1_2_2, [parent_1, parent_2], new_2, 
318
506
                           'blahblah')
 
507
 
 
508
    def test_reannotate_no_parents(self):
 
509
        self.annotateEqual(expected_1, [], new_1, 'blahblah')
 
510
 
 
511
    def test_reannotate_left_matching_blocks(self):
 
512
        """Ensure that left_matching_blocks has an impact.
 
513
 
 
514
        In this case, the annotation is ambiguous, so the hint isn't actually
 
515
        lying.
 
516
        """
 
517
        parent = [('rev1', 'a\n')]
 
518
        new_text = ['a\n', 'a\n']
 
519
        blocks = [(0, 0, 1), (1, 2, 0)]
 
520
        self.annotateEqual([('rev1', 'a\n'), ('rev2', 'a\n')], [parent],
 
521
                           new_text, 'rev2', blocks)
 
522
        blocks = [(0, 1, 1), (1, 2, 0)]
 
523
        self.annotateEqual([('rev2', 'a\n'), ('rev1', 'a\n')], [parent],
 
524
                           new_text, 'rev2', blocks)