/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_log.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-12-12 01:24:50 UTC
  • mfrom: (3882.4.2 doc-hacking)
  • Revision ID: pqm@pqm.ubuntu.com-20081212012450-3gw576prpztxziib
(mbp) Developer documentation about when to add new exception classes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
from cStringIO import StringIO
19
19
 
20
20
from bzrlib import (
21
 
    branchbuilder,
22
21
    errors,
23
22
    log,
24
23
    registry,
25
24
    revision,
26
25
    revisionspec,
27
 
    symbol_versioning,
28
26
    tests,
29
27
    )
30
28
 
31
29
 
32
 
class TestLogMixin(object):
33
 
 
34
 
    def wt_commit(self, wt, message, **kwargs):
35
 
        """Use some mostly fixed values for commits to simplify tests.
36
 
 
37
 
        Tests can use this function to get some commit attributes. The time
38
 
        stamp is incremented at each commit.
39
 
        """
40
 
        if getattr(self, 'timestamp', None) is None:
41
 
            self.timestamp = 1132617600 # Mon 2005-11-22 00:00:00 +0000
42
 
        else:
43
 
            self.timestamp += 1 # 1 second between each commit
44
 
        kwargs.setdefault('timestamp', self.timestamp)
45
 
        kwargs.setdefault('timezone', 0) # UTC
46
 
        kwargs.setdefault('committer', 'Joe Foo <joe@foo.com>')
47
 
 
48
 
        return wt.commit(message, **kwargs)
49
 
 
50
 
 
51
 
class TestCaseForLogFormatter(tests.TestCaseWithTransport, TestLogMixin):
 
30
class TestCaseWithoutPropsHandler(tests.TestCaseWithTransport):
52
31
 
53
32
    def setUp(self):
54
 
        super(TestCaseForLogFormatter, self).setUp()
 
33
        super(TestCaseWithoutPropsHandler, self).setUp()
55
34
        # keep a reference to the "current" custom prop. handler registry
56
35
        self.properties_handler_registry = log.properties_handler_registry
57
 
        # Use a clean registry for log
 
36
        # clean up the registry in log
58
37
        log.properties_handler_registry = registry.Registry()
59
38
 
60
 
        def restore():
61
 
            log.properties_handler_registry = self.properties_handler_registry
62
 
        self.addCleanup(restore)
63
 
 
64
 
    def assertFormatterResult(self, result, branch, formatter_class,
65
 
                              formatter_kwargs=None, show_log_kwargs=None):
66
 
        logfile = self.make_utf8_encoded_stringio()
67
 
        if formatter_kwargs is None:
68
 
            formatter_kwargs = {}
69
 
        formatter = formatter_class(to_file=logfile, **formatter_kwargs)
70
 
        if show_log_kwargs is None:
71
 
            show_log_kwargs = {}
72
 
        log.show_log(branch, formatter, **show_log_kwargs)
73
 
        self.assertEqualDiff(result, logfile.getvalue())
74
 
 
75
 
    def make_standard_commit(self, branch_nick, **kwargs):
76
 
        wt = self.make_branch_and_tree('.')
77
 
        wt.lock_write()
78
 
        self.addCleanup(wt.unlock)
79
 
        self.build_tree(['a'])
80
 
        wt.add(['a'])
81
 
        wt.branch.nick = branch_nick
82
 
        kwargs.setdefault('committer', 'Lorem Ipsum <test@example.com>')
83
 
        kwargs.setdefault('authors', ['John Doe <jdoe@example.com>'])
84
 
        self.wt_commit(wt, 'add a', **kwargs)
85
 
        return wt
86
 
 
87
 
    def make_commits_with_trailing_newlines(self, wt):
88
 
        """Helper method for LogFormatter tests"""
89
 
        b = wt.branch
90
 
        b.nick = 'test'
91
 
        self.build_tree_contents([('a', 'hello moto\n')])
92
 
        self.wt_commit(wt, 'simple log message', rev_id='a1')
93
 
        self.build_tree_contents([('b', 'goodbye\n')])
94
 
        wt.add('b')
95
 
        self.wt_commit(wt, 'multiline\nlog\nmessage\n', rev_id='a2')
96
 
 
97
 
        self.build_tree_contents([('c', 'just another manic monday\n')])
98
 
        wt.add('c')
99
 
        self.wt_commit(wt, 'single line with trailing newline\n', rev_id='a3')
100
 
        return b
101
 
 
102
 
    def _prepare_tree_with_merges(self, with_tags=False):
103
 
        wt = self.make_branch_and_memory_tree('.')
104
 
        wt.lock_write()
105
 
        self.addCleanup(wt.unlock)
106
 
        wt.add('')
107
 
        self.wt_commit(wt, 'rev-1', rev_id='rev-1')
108
 
        self.wt_commit(wt, 'rev-merged', rev_id='rev-2a')
109
 
        wt.set_parent_ids(['rev-1', 'rev-2a'])
110
 
        wt.branch.set_last_revision_info(1, 'rev-1')
111
 
        self.wt_commit(wt, 'rev-2', rev_id='rev-2b')
112
 
        if with_tags:
113
 
            branch = wt.branch
114
 
            branch.tags.set_tag('v0.2', 'rev-2b')
115
 
            self.wt_commit(wt, 'rev-3', rev_id='rev-3')
116
 
            branch.tags.set_tag('v1.0rc1', 'rev-3')
117
 
            branch.tags.set_tag('v1.0', 'rev-3')
118
 
        return wt
 
39
    def _cleanup(self):
 
40
        super(TestCaseWithoutPropsHandler, self)._cleanup()
 
41
        # restore the custom properties handler registry
 
42
        log.properties_handler_registry = self.properties_handler_registry
 
43
 
119
44
 
120
45
class LogCatcher(log.LogFormatter):
121
 
    """Pull log messages into a list rather than displaying them.
122
 
 
123
 
    To simplify testing we save logged revisions here rather than actually
124
 
    formatting anything, so that we can precisely check the result without
125
 
    being dependent on the formatting.
 
46
    """Pull log messages into list rather than displaying them.
 
47
 
 
48
    For ease of testing we save log messages here rather than actually
 
49
    formatting them, so that we can precisely check the result without
 
50
    being too dependent on the exact formatting.
 
51
 
 
52
    We should also test the LogFormatter.
126
53
    """
127
54
 
128
 
    supports_merge_revisions = True
129
55
    supports_delta = True
130
 
    supports_diff = True
131
 
    preferred_levels = 0
132
56
 
133
 
    def __init__(self, *args, **kwargs):
134
 
        kwargs.update(dict(to_file=None))
135
 
        super(LogCatcher, self).__init__(*args, **kwargs)
136
 
        self.revisions = []
 
57
    def __init__(self):
 
58
        super(LogCatcher, self).__init__(to_file=None)
 
59
        self.logs = []
137
60
 
138
61
    def log_revision(self, revision):
139
 
        self.revisions.append(revision)
 
62
        self.logs.append(revision)
140
63
 
141
64
 
142
65
class TestShowLog(tests.TestCaseWithTransport):
183
106
        lf = LogCatcher()
184
107
        log.show_log(wt.branch, lf)
185
108
        # no entries yet
186
 
        self.assertEqual([], lf.revisions)
 
109
        self.assertEqual([], lf.logs)
187
110
 
188
111
    def test_empty_commit(self):
189
112
        wt = self.make_branch_and_tree('.')
191
114
        wt.commit('empty commit')
192
115
        lf = LogCatcher()
193
116
        log.show_log(wt.branch, lf, verbose=True)
194
 
        revs = lf.revisions
195
 
        self.assertEqual(1, len(revs))
196
 
        self.assertEqual('1', revs[0].revno)
197
 
        self.assertEqual('empty commit', revs[0].rev.message)
198
 
        self.checkDelta(revs[0].delta)
 
117
        self.assertEqual(1, len(lf.logs))
 
118
        self.assertEqual('1', lf.logs[0].revno)
 
119
        self.assertEqual('empty commit', lf.logs[0].rev.message)
 
120
        self.checkDelta(lf.logs[0].delta)
199
121
 
200
122
    def test_simple_commit(self):
201
123
        wt = self.make_branch_and_tree('.')
207
129
                            u'<test@example.com>')
208
130
        lf = LogCatcher()
209
131
        log.show_log(wt.branch, lf, verbose=True)
210
 
        self.assertEqual(2, len(lf.revisions))
 
132
        self.assertEqual(2, len(lf.logs))
211
133
        # first one is most recent
212
 
        log_entry = lf.revisions[0]
 
134
        log_entry = lf.logs[0]
213
135
        self.assertEqual('2', log_entry.revno)
214
136
        self.assertEqual('add one file', log_entry.rev.message)
215
137
        self.checkDelta(log_entry.delta, added=['hello'])
221
143
        wt.commit(msg)
222
144
        lf = LogCatcher()
223
145
        log.show_log(wt.branch, lf, verbose=True)
224
 
        committed_msg = lf.revisions[0].rev.message
225
 
        if wt.branch.repository._serializer.squashes_xml_invalid_characters:
226
 
            self.assertNotEqual(msg, committed_msg)
227
 
            self.assertTrue(len(committed_msg) > len(msg))
228
 
        else:
229
 
            self.assertEqual(msg, committed_msg)
 
146
        committed_msg = lf.logs[0].rev.message
 
147
        self.assertNotEqual(msg, committed_msg)
 
148
        self.assertTrue(len(committed_msg) > len(msg))
230
149
 
231
150
    def test_commit_message_without_control_chars(self):
232
151
        wt = self.make_branch_and_tree('.')
238
157
        wt.commit(msg)
239
158
        lf = LogCatcher()
240
159
        log.show_log(wt.branch, lf, verbose=True)
241
 
        committed_msg = lf.revisions[0].rev.message
 
160
        committed_msg = lf.logs[0].rev.message
242
161
        self.assertEqual(msg, committed_msg)
243
162
 
244
163
    def test_deltas_in_merge_revisions(self):
262
181
        lf.supports_merge_revisions = True
263
182
        log.show_log(b, lf, verbose=True)
264
183
 
265
 
        revs = lf.revisions
266
 
        self.assertEqual(3, len(revs))
 
184
        self.assertEqual(3, len(lf.logs))
267
185
 
268
 
        logentry = revs[0]
 
186
        logentry = lf.logs[0]
269
187
        self.assertEqual('2', logentry.revno)
270
188
        self.assertEqual('merge child branch', logentry.rev.message)
271
189
        self.checkDelta(logentry.delta, removed=['file1'], modified=['file2'])
272
190
 
273
 
        logentry = revs[1]
 
191
        logentry = lf.logs[1]
274
192
        self.assertEqual('1.1.1', logentry.revno)
275
193
        self.assertEqual('remove file1 and modify file2', logentry.rev.message)
276
194
        self.checkDelta(logentry.delta, removed=['file1'], modified=['file2'])
277
195
 
278
 
        logentry = revs[2]
 
196
        logentry = lf.logs[2]
279
197
        self.assertEqual('1', logentry.revno)
280
198
        self.assertEqual('add file1 and file2', logentry.rev.message)
281
199
        self.checkDelta(logentry.delta, added=['file1', 'file2'])
282
200
 
283
 
 
284
 
class TestShortLogFormatter(TestCaseForLogFormatter):
 
201
    def test_merges_nonsupporting_formatter(self):
 
202
        """Tests that show_log will raise if the formatter doesn't
 
203
        support merge revisions."""
 
204
        wt = self.make_branch_and_memory_tree('.')
 
205
        wt.lock_write()
 
206
        self.addCleanup(wt.unlock)
 
207
        wt.add('')
 
208
        wt.commit('rev-1', rev_id='rev-1',
 
209
                  timestamp=1132586655, timezone=36000,
 
210
                  committer='Joe Foo <joe@foo.com>')
 
211
        wt.commit('rev-merged', rev_id='rev-2a',
 
212
                  timestamp=1132586700, timezone=36000,
 
213
                  committer='Joe Foo <joe@foo.com>')
 
214
        wt.set_parent_ids(['rev-1', 'rev-2a'])
 
215
        wt.branch.set_last_revision_info(1, 'rev-1')
 
216
        wt.commit('rev-2', rev_id='rev-2b',
 
217
                  timestamp=1132586800, timezone=36000,
 
218
                  committer='Joe Foo <joe@foo.com>')
 
219
        logfile = self.make_utf8_encoded_stringio()
 
220
        formatter = log.ShortLogFormatter(to_file=logfile)
 
221
        wtb = wt.branch
 
222
        lf = LogCatcher()
 
223
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
 
224
        rev = revspec.in_history(wtb)
 
225
        self.assertRaises(errors.BzrCommandError, log.show_log, wtb, lf,
 
226
                          start_revision=rev, end_revision=rev)
 
227
 
 
228
 
 
229
def make_commits_with_trailing_newlines(wt):
 
230
    """Helper method for LogFormatter tests"""
 
231
    b = wt.branch
 
232
    b.nick='test'
 
233
    open('a', 'wb').write('hello moto\n')
 
234
    wt.add('a')
 
235
    wt.commit('simple log message', rev_id='a1',
 
236
              timestamp=1132586655.459960938, timezone=-6*3600,
 
237
              committer='Joe Foo <joe@foo.com>')
 
238
    open('b', 'wb').write('goodbye\n')
 
239
    wt.add('b')
 
240
    wt.commit('multiline\nlog\nmessage\n', rev_id='a2',
 
241
              timestamp=1132586842.411175966, timezone=-6*3600,
 
242
              committer='Joe Foo <joe@foo.com>',
 
243
              author='Joe Bar <joe@bar.com>')
 
244
 
 
245
    open('c', 'wb').write('just another manic monday\n')
 
246
    wt.add('c')
 
247
    wt.commit('single line with trailing newline\n', rev_id='a3',
 
248
              timestamp=1132587176.835228920, timezone=-6*3600,
 
249
              committer = 'Joe Foo <joe@foo.com>')
 
250
    return b
 
251
 
 
252
 
 
253
def normalize_log(log):
 
254
    """Replaces the variable lines of logs with fixed lines"""
 
255
    author = 'author: Dolor Sit <test@example.com>'
 
256
    committer = 'committer: Lorem Ipsum <test@example.com>'
 
257
    lines = log.splitlines(True)
 
258
    for idx,line in enumerate(lines):
 
259
        stripped_line = line.lstrip()
 
260
        indent = ' ' * (len(line) - len(stripped_line))
 
261
        if stripped_line.startswith('author:'):
 
262
            lines[idx] = indent + author + '\n'
 
263
        elif stripped_line.startswith('committer:'):
 
264
            lines[idx] = indent + committer + '\n'
 
265
        elif stripped_line.startswith('timestamp:'):
 
266
            lines[idx] = indent + 'timestamp: Just now\n'
 
267
    return ''.join(lines)
 
268
 
 
269
 
 
270
class TestShortLogFormatter(tests.TestCaseWithTransport):
285
271
 
286
272
    def test_trailing_newlines(self):
287
273
        wt = self.make_branch_and_tree('.')
288
 
        b = self.make_commits_with_trailing_newlines(wt)
289
 
        self.assertFormatterResult("""\
290
 
    3 Joe Foo\t2005-11-22
 
274
        b = make_commits_with_trailing_newlines(wt)
 
275
        sio = self.make_utf8_encoded_stringio()
 
276
        lf = log.ShortLogFormatter(to_file=sio)
 
277
        log.show_log(b, lf)
 
278
        self.assertEqualDiff("""\
 
279
    3 Joe Foo\t2005-11-21
291
280
      single line with trailing newline
292
281
 
293
 
    2 Joe Foo\t2005-11-22
 
282
    2 Joe Bar\t2005-11-21
294
283
      multiline
295
284
      log
296
285
      message
297
286
 
298
 
    1 Joe Foo\t2005-11-22
 
287
    1 Joe Foo\t2005-11-21
299
288
      simple log message
300
289
 
301
290
""",
302
 
            b, log.ShortLogFormatter)
 
291
                             sio.getvalue())
303
292
 
304
293
    def test_short_log_with_merges(self):
305
 
        wt = self._prepare_tree_with_merges()
306
 
        self.assertFormatterResult("""\
307
 
    2 Joe Foo\t2005-11-22 [merge]
308
 
      rev-2
309
 
 
310
 
    1 Joe Foo\t2005-11-22
311
 
      rev-1
312
 
 
313
 
""",
314
 
            wt.branch, log.ShortLogFormatter)
315
 
 
316
 
    def test_short_log_with_merges_and_advice(self):
317
 
        wt = self._prepare_tree_with_merges()
318
 
        self.assertFormatterResult("""\
319
 
    2 Joe Foo\t2005-11-22 [merge]
320
 
      rev-2
321
 
 
322
 
    1 Joe Foo\t2005-11-22
323
 
      rev-1
324
 
 
325
 
Use --include-merges or -n0 to see merged revisions.
326
 
""",
327
 
            wt.branch, log.ShortLogFormatter,
328
 
            formatter_kwargs=dict(show_advice=True))
329
 
 
330
 
    def test_short_log_with_merges_and_range(self):
331
 
        wt = self._prepare_tree_with_merges()
332
 
        self.wt_commit(wt, 'rev-3a', rev_id='rev-3a')
333
 
        wt.branch.set_last_revision_info(2, 'rev-2b')
334
 
        wt.set_parent_ids(['rev-2b', 'rev-3a'])
335
 
        self.wt_commit(wt, 'rev-3b', rev_id='rev-3b')
336
 
        self.assertFormatterResult("""\
337
 
    3 Joe Foo\t2005-11-22 [merge]
338
 
      rev-3b
339
 
 
340
 
    2 Joe Foo\t2005-11-22 [merge]
341
 
      rev-2
342
 
 
343
 
""",
344
 
            wt.branch, log.ShortLogFormatter,
345
 
            show_log_kwargs=dict(start_revision=2, end_revision=3))
346
 
 
347
 
    def test_short_log_with_tags(self):
348
 
        wt = self._prepare_tree_with_merges(with_tags=True)
349
 
        self.assertFormatterResult("""\
350
 
    3 Joe Foo\t2005-11-22 {v1.0, v1.0rc1}
351
 
      rev-3
352
 
 
353
 
    2 Joe Foo\t2005-11-22 {v0.2} [merge]
354
 
      rev-2
355
 
 
356
 
    1 Joe Foo\t2005-11-22
357
 
      rev-1
358
 
 
359
 
""",
360
 
            wt.branch, log.ShortLogFormatter)
 
294
        wt = self.make_branch_and_memory_tree('.')
 
295
        wt.lock_write()
 
296
        self.addCleanup(wt.unlock)
 
297
        wt.add('')
 
298
        wt.commit('rev-1', rev_id='rev-1',
 
299
                  timestamp=1132586655, timezone=36000,
 
300
                  committer='Joe Foo <joe@foo.com>')
 
301
        wt.commit('rev-merged', rev_id='rev-2a',
 
302
                  timestamp=1132586700, timezone=36000,
 
303
                  committer='Joe Foo <joe@foo.com>')
 
304
        wt.set_parent_ids(['rev-1', 'rev-2a'])
 
305
        wt.branch.set_last_revision_info(1, 'rev-1')
 
306
        wt.commit('rev-2', rev_id='rev-2b',
 
307
                  timestamp=1132586800, timezone=36000,
 
308
                  committer='Joe Foo <joe@foo.com>')
 
309
        logfile = self.make_utf8_encoded_stringio()
 
310
        formatter = log.ShortLogFormatter(to_file=logfile)
 
311
        log.show_log(wt.branch, formatter)
 
312
        self.assertEqualDiff("""\
 
313
    2 Joe Foo\t2005-11-22 [merge]
 
314
      rev-2
 
315
 
 
316
    1 Joe Foo\t2005-11-22
 
317
      rev-1
 
318
 
 
319
""",
 
320
                             logfile.getvalue())
361
321
 
362
322
    def test_short_log_single_merge_revision(self):
363
 
        wt = self._prepare_tree_with_merges()
364
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
365
 
        rev = revspec.in_history(wt.branch)
366
 
        self.assertFormatterResult("""\
367
 
      1.1.1 Joe Foo\t2005-11-22
368
 
            rev-merged
369
 
 
370
 
""",
371
 
            wt.branch, log.ShortLogFormatter,
372
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
373
 
 
374
 
 
375
 
class TestShortLogFormatterWithMergeRevisions(TestCaseForLogFormatter):
376
 
 
377
 
    def test_short_merge_revs_log_with_merges(self):
378
 
        wt = self._prepare_tree_with_merges()
379
 
        # Note that the 1.1.1 indenting is in fact correct given that
380
 
        # the revision numbers are right justified within 5 characters
381
 
        # for mainline revnos and 9 characters for dotted revnos.
382
 
        self.assertFormatterResult("""\
383
 
    2 Joe Foo\t2005-11-22 [merge]
384
 
      rev-2
385
 
 
386
 
          1.1.1 Joe Foo\t2005-11-22
387
 
                rev-merged
388
 
 
389
 
    1 Joe Foo\t2005-11-22
390
 
      rev-1
391
 
 
392
 
""",
393
 
            wt.branch, log.ShortLogFormatter,
394
 
            formatter_kwargs=dict(levels=0))
395
 
 
396
 
    def test_short_merge_revs_log_single_merge_revision(self):
397
 
        wt = self._prepare_tree_with_merges()
398
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
399
 
        rev = revspec.in_history(wt.branch)
400
 
        self.assertFormatterResult("""\
401
 
      1.1.1 Joe Foo\t2005-11-22
402
 
            rev-merged
403
 
 
404
 
""",
405
 
            wt.branch, log.ShortLogFormatter,
406
 
            formatter_kwargs=dict(levels=0),
407
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
408
 
 
409
 
 
410
 
class TestLongLogFormatter(TestCaseForLogFormatter):
 
323
        wt = self.make_branch_and_memory_tree('.')
 
324
        wt.lock_write()
 
325
        self.addCleanup(wt.unlock)
 
326
        wt.add('')
 
327
        wt.commit('rev-1', rev_id='rev-1',
 
328
                  timestamp=1132586655, timezone=36000,
 
329
                  committer='Joe Foo <joe@foo.com>')
 
330
        wt.commit('rev-merged', rev_id='rev-2a',
 
331
                  timestamp=1132586700, timezone=36000,
 
332
                  committer='Joe Foo <joe@foo.com>')
 
333
        wt.set_parent_ids(['rev-1', 'rev-2a'])
 
334
        wt.branch.set_last_revision_info(1, 'rev-1')
 
335
        wt.commit('rev-2', rev_id='rev-2b',
 
336
                  timestamp=1132586800, timezone=36000,
 
337
                  committer='Joe Foo <joe@foo.com>')
 
338
        logfile = self.make_utf8_encoded_stringio()
 
339
        formatter = log.ShortLogFormatter(to_file=logfile)
 
340
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
 
341
        wtb = wt.branch
 
342
        rev = revspec.in_history(wtb)
 
343
        log.show_log(wtb, formatter, start_revision=rev, end_revision=rev)
 
344
        self.assertEqualDiff("""\
 
345
1.1.1 Joe Foo\t2005-11-22
 
346
      rev-merged
 
347
 
 
348
""",
 
349
                             logfile.getvalue())
 
350
 
 
351
 
 
352
class TestLongLogFormatter(TestCaseWithoutPropsHandler):
411
353
 
412
354
    def test_verbose_log(self):
413
355
        """Verbose log includes changed files
414
 
 
 
356
        
415
357
        bug #4676
416
358
        """
417
 
        wt = self.make_standard_commit('test_verbose_log', authors=[])
418
 
        self.assertFormatterResult('''\
 
359
        wt = self.make_branch_and_tree('.')
 
360
        b = wt.branch
 
361
        self.build_tree(['a'])
 
362
        wt.add('a')
 
363
        # XXX: why does a longer nick show up?
 
364
        b.nick = 'test_verbose_log'
 
365
        wt.commit(message='add a',
 
366
                  timestamp=1132711707,
 
367
                  timezone=36000,
 
368
                  committer='Lorem Ipsum <test@example.com>')
 
369
        logfile = file('out.tmp', 'w+')
 
370
        formatter = log.LongLogFormatter(to_file=logfile)
 
371
        log.show_log(b, formatter, verbose=True)
 
372
        logfile.flush()
 
373
        logfile.seek(0)
 
374
        log_contents = logfile.read()
 
375
        self.assertEqualDiff('''\
419
376
------------------------------------------------------------
420
377
revno: 1
421
378
committer: Lorem Ipsum <test@example.com>
422
379
branch nick: test_verbose_log
423
 
timestamp: Tue 2005-11-22 00:00:00 +0000
 
380
timestamp: Wed 2005-11-23 12:08:27 +1000
424
381
message:
425
382
  add a
426
383
added:
427
384
  a
428
385
''',
429
 
            wt.branch, log.LongLogFormatter,
430
 
            show_log_kwargs=dict(verbose=True))
 
386
                             log_contents)
431
387
 
432
388
    def test_merges_are_indented_by_level(self):
433
389
        wt = self.make_branch_and_tree('parent')
434
 
        self.wt_commit(wt, 'first post')
435
 
        child_wt = wt.bzrdir.sprout('child').open_workingtree()
436
 
        self.wt_commit(child_wt, 'branch 1')
437
 
        smallerchild_wt = wt.bzrdir.sprout('smallerchild').open_workingtree()
438
 
        self.wt_commit(smallerchild_wt, 'branch 2')
439
 
        child_wt.merge_from_branch(smallerchild_wt.branch)
440
 
        self.wt_commit(child_wt, 'merge branch 2')
441
 
        wt.merge_from_branch(child_wt.branch)
442
 
        self.wt_commit(wt, 'merge branch 1')
443
 
        self.assertFormatterResult("""\
 
390
        wt.commit('first post')
 
391
        self.run_bzr('branch parent child')
 
392
        self.run_bzr(['commit', '-m', 'branch 1', '--unchanged', 'child'])
 
393
        self.run_bzr('branch child smallerchild')
 
394
        self.run_bzr(['commit', '-m', 'branch 2', '--unchanged',
 
395
            'smallerchild'])
 
396
        os.chdir('child')
 
397
        self.run_bzr('merge ../smallerchild')
 
398
        self.run_bzr(['commit', '-m', 'merge branch 2'])
 
399
        os.chdir('../parent')
 
400
        self.run_bzr('merge ../child')
 
401
        wt.commit('merge branch 1')
 
402
        b = wt.branch
 
403
        sio = self.make_utf8_encoded_stringio()
 
404
        lf = log.LongLogFormatter(to_file=sio)
 
405
        log.show_log(b, lf, verbose=True)
 
406
        the_log = normalize_log(sio.getvalue())
 
407
        self.assertEqualDiff("""\
444
408
------------------------------------------------------------
445
 
revno: 2 [merge]
446
 
committer: Joe Foo <joe@foo.com>
 
409
revno: 2
 
410
committer: Lorem Ipsum <test@example.com>
447
411
branch nick: parent
448
 
timestamp: Tue 2005-11-22 00:00:04 +0000
 
412
timestamp: Just now
449
413
message:
450
414
  merge branch 1
451
415
    ------------------------------------------------------------
452
 
    revno: 1.1.2 [merge]
453
 
    committer: Joe Foo <joe@foo.com>
 
416
    revno: 1.1.2
 
417
    committer: Lorem Ipsum <test@example.com>
454
418
    branch nick: child
455
 
    timestamp: Tue 2005-11-22 00:00:03 +0000
 
419
    timestamp: Just now
456
420
    message:
457
421
      merge branch 2
458
422
        ------------------------------------------------------------
459
423
        revno: 1.2.1
460
 
        committer: Joe Foo <joe@foo.com>
 
424
        committer: Lorem Ipsum <test@example.com>
461
425
        branch nick: smallerchild
462
 
        timestamp: Tue 2005-11-22 00:00:02 +0000
 
426
        timestamp: Just now
463
427
        message:
464
428
          branch 2
465
429
    ------------------------------------------------------------
466
430
    revno: 1.1.1
467
 
    committer: Joe Foo <joe@foo.com>
 
431
    committer: Lorem Ipsum <test@example.com>
468
432
    branch nick: child
469
 
    timestamp: Tue 2005-11-22 00:00:01 +0000
 
433
    timestamp: Just now
470
434
    message:
471
435
      branch 1
472
436
------------------------------------------------------------
473
437
revno: 1
474
 
committer: Joe Foo <joe@foo.com>
 
438
committer: Lorem Ipsum <test@example.com>
475
439
branch nick: parent
476
 
timestamp: Tue 2005-11-22 00:00:00 +0000
 
440
timestamp: Just now
477
441
message:
478
442
  first post
479
443
""",
480
 
            wt.branch, log.LongLogFormatter,
481
 
            formatter_kwargs=dict(levels=0),
482
 
            show_log_kwargs=dict(verbose=True))
 
444
                             the_log)
483
445
 
484
446
    def test_verbose_merge_revisions_contain_deltas(self):
485
447
        wt = self.make_branch_and_tree('parent')
486
448
        self.build_tree(['parent/f1', 'parent/f2'])
487
449
        wt.add(['f1','f2'])
488
 
        self.wt_commit(wt, 'first post')
489
 
        child_wt = wt.bzrdir.sprout('child').open_workingtree()
 
450
        wt.commit('first post')
 
451
        self.run_bzr('branch parent child')
490
452
        os.unlink('child/f1')
491
 
        self.build_tree_contents([('child/f2', 'hello\n')])
492
 
        self.wt_commit(child_wt, 'removed f1 and modified f2')
493
 
        wt.merge_from_branch(child_wt.branch)
494
 
        self.wt_commit(wt, 'merge branch 1')
495
 
        self.assertFormatterResult("""\
 
453
        file('child/f2', 'wb').write('hello\n')
 
454
        self.run_bzr(['commit', '-m', 'removed f1 and modified f2',
 
455
            'child'])
 
456
        os.chdir('parent')
 
457
        self.run_bzr('merge ../child')
 
458
        wt.commit('merge branch 1')
 
459
        b = wt.branch
 
460
        sio = self.make_utf8_encoded_stringio()
 
461
        lf = log.LongLogFormatter(to_file=sio)
 
462
        log.show_log(b, lf, verbose=True)
 
463
        the_log = normalize_log(sio.getvalue())
 
464
        self.assertEqualDiff("""\
496
465
------------------------------------------------------------
497
 
revno: 2 [merge]
498
 
committer: Joe Foo <joe@foo.com>
 
466
revno: 2
 
467
committer: Lorem Ipsum <test@example.com>
499
468
branch nick: parent
500
 
timestamp: Tue 2005-11-22 00:00:02 +0000
 
469
timestamp: Just now
501
470
message:
502
471
  merge branch 1
503
472
removed:
506
475
  f2
507
476
    ------------------------------------------------------------
508
477
    revno: 1.1.1
509
 
    committer: Joe Foo <joe@foo.com>
 
478
    committer: Lorem Ipsum <test@example.com>
510
479
    branch nick: child
511
 
    timestamp: Tue 2005-11-22 00:00:01 +0000
 
480
    timestamp: Just now
512
481
    message:
513
482
      removed f1 and modified f2
514
483
    removed:
517
486
      f2
518
487
------------------------------------------------------------
519
488
revno: 1
520
 
committer: Joe Foo <joe@foo.com>
 
489
committer: Lorem Ipsum <test@example.com>
521
490
branch nick: parent
522
 
timestamp: Tue 2005-11-22 00:00:00 +0000
 
491
timestamp: Just now
523
492
message:
524
493
  first post
525
494
added:
526
495
  f1
527
496
  f2
528
497
""",
529
 
            wt.branch, log.LongLogFormatter,
530
 
            formatter_kwargs=dict(levels=0),
531
 
            show_log_kwargs=dict(verbose=True))
 
498
                             the_log)
532
499
 
533
500
    def test_trailing_newlines(self):
534
501
        wt = self.make_branch_and_tree('.')
535
 
        b = self.make_commits_with_trailing_newlines(wt)
536
 
        self.assertFormatterResult("""\
 
502
        b = make_commits_with_trailing_newlines(wt)
 
503
        sio = self.make_utf8_encoded_stringio()
 
504
        lf = log.LongLogFormatter(to_file=sio)
 
505
        log.show_log(b, lf)
 
506
        self.assertEqualDiff("""\
537
507
------------------------------------------------------------
538
508
revno: 3
539
509
committer: Joe Foo <joe@foo.com>
540
510
branch nick: test
541
 
timestamp: Tue 2005-11-22 00:00:02 +0000
 
511
timestamp: Mon 2005-11-21 09:32:56 -0600
542
512
message:
543
513
  single line with trailing newline
544
514
------------------------------------------------------------
545
515
revno: 2
 
516
author: Joe Bar <joe@bar.com>
546
517
committer: Joe Foo <joe@foo.com>
547
518
branch nick: test
548
 
timestamp: Tue 2005-11-22 00:00:01 +0000
 
519
timestamp: Mon 2005-11-21 09:27:22 -0600
549
520
message:
550
521
  multiline
551
522
  log
554
525
revno: 1
555
526
committer: Joe Foo <joe@foo.com>
556
527
branch nick: test
557
 
timestamp: Tue 2005-11-22 00:00:00 +0000
 
528
timestamp: Mon 2005-11-21 09:24:15 -0600
558
529
message:
559
530
  simple log message
560
531
""",
561
 
        b, log.LongLogFormatter)
 
532
                             sio.getvalue())
562
533
 
563
534
    def test_author_in_log(self):
564
535
        """Log includes the author name if it's set in
565
536
        the revision properties
566
537
        """
567
 
        wt = self.make_standard_commit('test_author_log',
568
 
            authors=['John Doe <jdoe@example.com>',
569
 
                     'Jane Rey <jrey@example.com>'])
570
 
        self.assertFormatterResult("""\
 
538
        wt = self.make_branch_and_tree('.')
 
539
        b = wt.branch
 
540
        self.build_tree(['a'])
 
541
        wt.add('a')
 
542
        b.nick = 'test_author_log'
 
543
        wt.commit(message='add a',
 
544
                  timestamp=1132711707,
 
545
                  timezone=36000,
 
546
                  committer='Lorem Ipsum <test@example.com>',
 
547
                  author='John Doe <jdoe@example.com>')
 
548
        sio = StringIO()
 
549
        formatter = log.LongLogFormatter(to_file=sio)
 
550
        log.show_log(b, formatter)
 
551
        self.assertEqualDiff('''\
571
552
------------------------------------------------------------
572
553
revno: 1
573
 
author: John Doe <jdoe@example.com>, Jane Rey <jrey@example.com>
 
554
author: John Doe <jdoe@example.com>
574
555
committer: Lorem Ipsum <test@example.com>
575
556
branch nick: test_author_log
576
 
timestamp: Tue 2005-11-22 00:00:00 +0000
 
557
timestamp: Wed 2005-11-23 12:08:27 +1000
577
558
message:
578
559
  add a
579
 
""",
580
 
        wt.branch, log.LongLogFormatter)
 
560
''',
 
561
                             sio.getvalue())
581
562
 
582
563
    def test_properties_in_log(self):
583
 
        """Log includes the custom properties returned by the registered
 
564
        """Log includes the custom properties returned by the registered 
584
565
        handlers.
585
566
        """
586
 
        wt = self.make_standard_commit('test_properties_in_log')
587
 
        def trivial_custom_prop_handler(revision):
588
 
            return {'test_prop':'test_value'}
 
567
        wt = self.make_branch_and_tree('.')
 
568
        b = wt.branch
 
569
        self.build_tree(['a'])
 
570
        wt.add('a')
 
571
        b.nick = 'test_properties_in_log'
 
572
        wt.commit(message='add a',
 
573
                  timestamp=1132711707,
 
574
                  timezone=36000,
 
575
                  committer='Lorem Ipsum <test@example.com>',
 
576
                  author='John Doe <jdoe@example.com>')
 
577
        sio = StringIO()
 
578
        formatter = log.LongLogFormatter(to_file=sio)
 
579
        try:
 
580
            def trivial_custom_prop_handler(revision):
 
581
                return {'test_prop':'test_value'}
589
582
 
590
 
        # Cleaned up in setUp()
591
 
        log.properties_handler_registry.register(
592
 
            'trivial_custom_prop_handler',
593
 
            trivial_custom_prop_handler)
594
 
        self.assertFormatterResult("""\
 
583
            log.properties_handler_registry.register(
 
584
                'trivial_custom_prop_handler',
 
585
                trivial_custom_prop_handler)
 
586
            log.show_log(b, formatter)
 
587
        finally:
 
588
            log.properties_handler_registry.remove(
 
589
                'trivial_custom_prop_handler')
 
590
            self.assertEqualDiff('''\
595
591
------------------------------------------------------------
596
592
revno: 1
597
593
test_prop: test_value
598
594
author: John Doe <jdoe@example.com>
599
595
committer: Lorem Ipsum <test@example.com>
600
596
branch nick: test_properties_in_log
601
 
timestamp: Tue 2005-11-22 00:00:00 +0000
 
597
timestamp: Wed 2005-11-23 12:08:27 +1000
602
598
message:
603
599
  add a
604
 
""",
605
 
            wt.branch, log.LongLogFormatter)
606
 
 
607
 
    def test_properties_in_short_log(self):
608
 
        """Log includes the custom properties returned by the registered
609
 
        handlers.
610
 
        """
611
 
        wt = self.make_standard_commit('test_properties_in_short_log')
612
 
        def trivial_custom_prop_handler(revision):
613
 
            return {'test_prop':'test_value'}
614
 
 
615
 
        log.properties_handler_registry.register(
616
 
            'trivial_custom_prop_handler',
617
 
            trivial_custom_prop_handler)
618
 
        self.assertFormatterResult("""\
619
 
    1 John Doe\t2005-11-22
620
 
      test_prop: test_value
621
 
      add a
622
 
 
623
 
""",
624
 
            wt.branch, log.ShortLogFormatter)
 
600
''',
 
601
                                 sio.getvalue())
625
602
 
626
603
    def test_error_in_properties_handler(self):
627
 
        """Log includes the custom properties returned by the registered
 
604
        """Log includes the custom properties returned by the registered 
628
605
        handlers.
629
606
        """
630
 
        wt = self.make_standard_commit('error_in_properties_handler',
631
 
            revprops={'first_prop':'first_value'})
632
 
        sio = self.make_utf8_encoded_stringio()
 
607
        wt = self.make_branch_and_tree('.')
 
608
        b = wt.branch
 
609
        self.build_tree(['a'])
 
610
        wt.add('a')
 
611
        b.nick = 'test_author_log'
 
612
        wt.commit(message='add a',
 
613
                  timestamp=1132711707,
 
614
                  timezone=36000,
 
615
                  committer='Lorem Ipsum <test@example.com>',
 
616
                  author='John Doe <jdoe@example.com>',
 
617
                  revprops={'first_prop':'first_value'})
 
618
        sio = StringIO()
633
619
        formatter = log.LongLogFormatter(to_file=sio)
634
 
        def trivial_custom_prop_handler(revision):
635
 
            raise StandardError("a test error")
 
620
        try:
 
621
            def trivial_custom_prop_handler(revision):
 
622
                raise StandardError("a test error")
636
623
 
637
 
        log.properties_handler_registry.register(
638
 
            'trivial_custom_prop_handler',
639
 
            trivial_custom_prop_handler)
640
 
        self.assertRaises(StandardError, log.show_log, wt.branch, formatter,)
 
624
            log.properties_handler_registry.register(
 
625
                'trivial_custom_prop_handler',
 
626
                trivial_custom_prop_handler)
 
627
            self.assertRaises(StandardError, log.show_log, b, formatter,)
 
628
        finally:
 
629
            log.properties_handler_registry.remove(
 
630
                'trivial_custom_prop_handler')
641
631
 
642
632
    def test_properties_handler_bad_argument(self):
643
 
        wt = self.make_standard_commit('bad_argument',
644
 
              revprops={'a_prop':'test_value'})
645
 
        sio = self.make_utf8_encoded_stringio()
 
633
        wt = self.make_branch_and_tree('.')
 
634
        b = wt.branch
 
635
        self.build_tree(['a'])
 
636
        wt.add('a')
 
637
        b.nick = 'test_author_log'
 
638
        wt.commit(message='add a',
 
639
                  timestamp=1132711707,
 
640
                  timezone=36000,
 
641
                  committer='Lorem Ipsum <test@example.com>',
 
642
                  author='John Doe <jdoe@example.com>',
 
643
                  revprops={'a_prop':'test_value'})
 
644
        sio = StringIO()
646
645
        formatter = log.LongLogFormatter(to_file=sio)
647
 
        def bad_argument_prop_handler(revision):
648
 
            return {'custom_prop_name':revision.properties['a_prop']}
649
 
 
650
 
        log.properties_handler_registry.register(
651
 
            'bad_argument_prop_handler',
652
 
            bad_argument_prop_handler)
653
 
 
654
 
        self.assertRaises(AttributeError, formatter.show_properties,
655
 
                          'a revision', '')
656
 
 
657
 
        revision = wt.branch.repository.get_revision(wt.branch.last_revision())
658
 
        formatter.show_properties(revision, '')
659
 
        self.assertEqualDiff('''custom_prop_name: test_value\n''',
660
 
                             sio.getvalue())
661
 
 
662
 
 
663
 
class TestLongLogFormatterWithoutMergeRevisions(TestCaseForLogFormatter):
664
 
 
665
 
    def test_long_verbose_log(self):
666
 
        """Verbose log includes changed files
667
 
 
668
 
        bug #4676
669
 
        """
670
 
        wt = self.make_standard_commit('test_long_verbose_log', authors=[])
671
 
        self.assertFormatterResult("""\
672
 
------------------------------------------------------------
673
 
revno: 1
674
 
committer: Lorem Ipsum <test@example.com>
675
 
branch nick: test_long_verbose_log
676
 
timestamp: Tue 2005-11-22 00:00:00 +0000
677
 
message:
678
 
  add a
679
 
added:
680
 
  a
681
 
""",
682
 
            wt.branch, log.LongLogFormatter,
683
 
            formatter_kwargs=dict(levels=1),
684
 
            show_log_kwargs=dict(verbose=True))
685
 
 
686
 
    def test_long_verbose_contain_deltas(self):
687
 
        wt = self.make_branch_and_tree('parent')
688
 
        self.build_tree(['parent/f1', 'parent/f2'])
689
 
        wt.add(['f1','f2'])
690
 
        self.wt_commit(wt, 'first post')
691
 
        child_wt = wt.bzrdir.sprout('child').open_workingtree()
692
 
        os.unlink('child/f1')
693
 
        self.build_tree_contents([('child/f2', 'hello\n')])
694
 
        self.wt_commit(child_wt, 'removed f1 and modified f2')
695
 
        wt.merge_from_branch(child_wt.branch)
696
 
        self.wt_commit(wt, 'merge branch 1')
697
 
        self.assertFormatterResult("""\
698
 
------------------------------------------------------------
699
 
revno: 2 [merge]
700
 
committer: Joe Foo <joe@foo.com>
701
 
branch nick: parent
702
 
timestamp: Tue 2005-11-22 00:00:02 +0000
703
 
message:
704
 
  merge branch 1
705
 
removed:
706
 
  f1
707
 
modified:
708
 
  f2
709
 
------------------------------------------------------------
710
 
revno: 1
711
 
committer: Joe Foo <joe@foo.com>
712
 
branch nick: parent
713
 
timestamp: Tue 2005-11-22 00:00:00 +0000
714
 
message:
715
 
  first post
716
 
added:
717
 
  f1
718
 
  f2
719
 
""",
720
 
            wt.branch, log.LongLogFormatter,
721
 
            formatter_kwargs=dict(levels=1),
722
 
            show_log_kwargs=dict(verbose=True))
723
 
 
724
 
    def test_long_trailing_newlines(self):
725
 
        wt = self.make_branch_and_tree('.')
726
 
        b = self.make_commits_with_trailing_newlines(wt)
727
 
        self.assertFormatterResult("""\
728
 
------------------------------------------------------------
729
 
revno: 3
730
 
committer: Joe Foo <joe@foo.com>
731
 
branch nick: test
732
 
timestamp: Tue 2005-11-22 00:00:02 +0000
733
 
message:
734
 
  single line with trailing newline
735
 
------------------------------------------------------------
736
 
revno: 2
737
 
committer: Joe Foo <joe@foo.com>
738
 
branch nick: test
739
 
timestamp: Tue 2005-11-22 00:00:01 +0000
740
 
message:
741
 
  multiline
742
 
  log
743
 
  message
744
 
------------------------------------------------------------
745
 
revno: 1
746
 
committer: Joe Foo <joe@foo.com>
747
 
branch nick: test
748
 
timestamp: Tue 2005-11-22 00:00:00 +0000
749
 
message:
750
 
  simple log message
751
 
""",
752
 
        b, log.LongLogFormatter,
753
 
        formatter_kwargs=dict(levels=1))
754
 
 
755
 
    def test_long_author_in_log(self):
756
 
        """Log includes the author name if it's set in
757
 
        the revision properties
758
 
        """
759
 
        wt = self.make_standard_commit('test_author_log')
760
 
        self.assertFormatterResult("""\
761
 
------------------------------------------------------------
762
 
revno: 1
763
 
author: John Doe <jdoe@example.com>
764
 
committer: Lorem Ipsum <test@example.com>
765
 
branch nick: test_author_log
766
 
timestamp: Tue 2005-11-22 00:00:00 +0000
767
 
message:
768
 
  add a
769
 
""",
770
 
            wt.branch, log.LongLogFormatter,
771
 
            formatter_kwargs=dict(levels=1))
772
 
 
773
 
    def test_long_properties_in_log(self):
774
 
        """Log includes the custom properties returned by the registered
775
 
        handlers.
776
 
        """
777
 
        wt = self.make_standard_commit('test_properties_in_log')
778
 
        def trivial_custom_prop_handler(revision):
779
 
            return {'test_prop':'test_value'}
780
 
 
781
 
        log.properties_handler_registry.register(
782
 
            'trivial_custom_prop_handler',
783
 
            trivial_custom_prop_handler)
784
 
        self.assertFormatterResult("""\
785
 
------------------------------------------------------------
786
 
revno: 1
787
 
test_prop: test_value
788
 
author: John Doe <jdoe@example.com>
789
 
committer: Lorem Ipsum <test@example.com>
790
 
branch nick: test_properties_in_log
791
 
timestamp: Tue 2005-11-22 00:00:00 +0000
792
 
message:
793
 
  add a
794
 
""",
795
 
            wt.branch, log.LongLogFormatter,
796
 
            formatter_kwargs=dict(levels=1))
797
 
 
798
 
 
799
 
class TestLineLogFormatter(TestCaseForLogFormatter):
 
646
        try:
 
647
            def bad_argument_prop_handler(revision):
 
648
                return {'custom_prop_name':revision.properties['a_prop']}
 
649
 
 
650
            log.properties_handler_registry.register(
 
651
                'bad_argument_prop_handler',
 
652
                bad_argument_prop_handler)
 
653
 
 
654
            self.assertRaises(AttributeError, formatter.show_properties,
 
655
                              'a revision', '')
 
656
 
 
657
            revision = b.repository.get_revision(b.last_revision())
 
658
            formatter.show_properties(revision, '')
 
659
            self.assertEqualDiff('''custom_prop_name: test_value\n''',
 
660
                                 sio.getvalue())
 
661
        finally:
 
662
            log.properties_handler_registry.remove(
 
663
                'bad_argument_prop_handler')
 
664
 
 
665
 
 
666
class TestLineLogFormatter(tests.TestCaseWithTransport):
800
667
 
801
668
    def test_line_log(self):
802
669
        """Line log should show revno
803
 
 
 
670
        
804
671
        bug #5162
805
672
        """
806
 
        wt = self.make_standard_commit('test-line-log',
807
 
                committer='Line-Log-Formatter Tester <test@line.log>',
808
 
                authors=[])
809
 
        self.assertFormatterResult("""\
810
 
1: Line-Log-Formatte... 2005-11-22 add a
811
 
""",
812
 
            wt.branch, log.LineLogFormatter)
 
673
        wt = self.make_branch_and_tree('.')
 
674
        b = wt.branch
 
675
        self.build_tree(['a'])
 
676
        wt.add('a')
 
677
        b.nick = 'test-line-log'
 
678
        wt.commit(message='add a',
 
679
                  timestamp=1132711707,
 
680
                  timezone=36000,
 
681
                  committer='Line-Log-Formatter Tester <test@line.log>')
 
682
        logfile = file('out.tmp', 'w+')
 
683
        formatter = log.LineLogFormatter(to_file=logfile)
 
684
        log.show_log(b, formatter)
 
685
        logfile.flush()
 
686
        logfile.seek(0)
 
687
        log_contents = logfile.read()
 
688
        self.assertEqualDiff('1: Line-Log-Formatte... 2005-11-23 add a\n',
 
689
                             log_contents)
813
690
 
814
691
    def test_trailing_newlines(self):
815
692
        wt = self.make_branch_and_tree('.')
816
 
        b = self.make_commits_with_trailing_newlines(wt)
817
 
        self.assertFormatterResult("""\
818
 
3: Joe Foo 2005-11-22 single line with trailing newline
819
 
2: Joe Foo 2005-11-22 multiline
820
 
1: Joe Foo 2005-11-22 simple log message
 
693
        b = make_commits_with_trailing_newlines(wt)
 
694
        sio = self.make_utf8_encoded_stringio()
 
695
        lf = log.LineLogFormatter(to_file=sio)
 
696
        log.show_log(b, lf)
 
697
        self.assertEqualDiff("""\
 
698
3: Joe Foo 2005-11-21 single line with trailing newline
 
699
2: Joe Bar 2005-11-21 multiline
 
700
1: Joe Foo 2005-11-21 simple log message
821
701
""",
822
 
            b, log.LineLogFormatter)
 
702
                             sio.getvalue())
823
703
 
824
704
    def test_line_log_single_merge_revision(self):
825
 
        wt = self._prepare_tree_with_merges()
826
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
827
 
        rev = revspec.in_history(wt.branch)
828
 
        self.assertFormatterResult("""\
829
 
1.1.1: Joe Foo 2005-11-22 rev-merged
830
 
""",
831
 
            wt.branch, log.LineLogFormatter,
832
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
833
 
 
834
 
    def test_line_log_with_tags(self):
835
 
        wt = self._prepare_tree_with_merges(with_tags=True)
836
 
        self.assertFormatterResult("""\
837
 
3: Joe Foo 2005-11-22 {v1.0, v1.0rc1} rev-3
838
 
2: Joe Foo 2005-11-22 [merge] {v0.2} rev-2
839
 
1: Joe Foo 2005-11-22 rev-1
840
 
""",
841
 
            wt.branch, log.LineLogFormatter)
842
 
 
843
 
 
844
 
class TestLineLogFormatterWithMergeRevisions(TestCaseForLogFormatter):
845
 
 
846
 
    def test_line_merge_revs_log(self):
847
 
        """Line log should show revno
848
 
 
849
 
        bug #5162
850
 
        """
851
 
        wt = self.make_standard_commit('test-line-log',
852
 
                committer='Line-Log-Formatter Tester <test@line.log>',
853
 
                authors=[])
854
 
        self.assertFormatterResult("""\
855
 
1: Line-Log-Formatte... 2005-11-22 add a
856
 
""",
857
 
            wt.branch, log.LineLogFormatter)
858
 
 
859
 
    def test_line_merge_revs_log_single_merge_revision(self):
860
 
        wt = self._prepare_tree_with_merges()
861
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
862
 
        rev = revspec.in_history(wt.branch)
863
 
        self.assertFormatterResult("""\
864
 
1.1.1: Joe Foo 2005-11-22 rev-merged
865
 
""",
866
 
            wt.branch, log.LineLogFormatter,
867
 
            formatter_kwargs=dict(levels=0),
868
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
869
 
 
870
 
    def test_line_merge_revs_log_with_merges(self):
871
 
        wt = self._prepare_tree_with_merges()
872
 
        self.assertFormatterResult("""\
873
 
2: Joe Foo 2005-11-22 [merge] rev-2
874
 
  1.1.1: Joe Foo 2005-11-22 rev-merged
875
 
1: Joe Foo 2005-11-22 rev-1
876
 
""",
877
 
            wt.branch, log.LineLogFormatter,
878
 
            formatter_kwargs=dict(levels=0))
879
 
 
880
 
 
881
 
class TestGnuChangelogFormatter(TestCaseForLogFormatter):
882
 
 
883
 
    def test_gnu_changelog(self):
884
 
        wt = self.make_standard_commit('nicky', authors=[])
885
 
        self.assertFormatterResult('''\
886
 
2005-11-22  Lorem Ipsum  <test@example.com>
887
 
 
888
 
\tadd a
889
 
 
890
 
''',
891
 
            wt.branch, log.GnuChangelogLogFormatter)
892
 
 
893
 
    def test_with_authors(self):
894
 
        wt = self.make_standard_commit('nicky',
895
 
            authors=['Fooa Fooz <foo@example.com>',
896
 
                     'Bari Baro <bar@example.com>'])
897
 
        self.assertFormatterResult('''\
898
 
2005-11-22  Fooa Fooz  <foo@example.com>
899
 
 
900
 
\tadd a
901
 
 
902
 
''',
903
 
            wt.branch, log.GnuChangelogLogFormatter)
904
 
 
905
 
    def test_verbose(self):
906
 
        wt = self.make_standard_commit('nicky')
907
 
        self.assertFormatterResult('''\
908
 
2005-11-22  John Doe  <jdoe@example.com>
909
 
 
910
 
\t* a:
911
 
 
912
 
\tadd a
913
 
 
914
 
''',
915
 
            wt.branch, log.GnuChangelogLogFormatter,
916
 
            show_log_kwargs=dict(verbose=True))
917
 
 
918
 
class TestGetViewRevisions(tests.TestCaseWithTransport, TestLogMixin):
919
 
 
920
 
    def _get_view_revisions(self, *args, **kwargs):
921
 
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
922
 
                                    log.get_view_revisions, *args, **kwargs)
 
705
        wt = self.make_branch_and_memory_tree('.')
 
706
        wt.lock_write()
 
707
        self.addCleanup(wt.unlock)
 
708
        wt.add('')
 
709
        wt.commit('rev-1', rev_id='rev-1',
 
710
                  timestamp=1132586655, timezone=36000,
 
711
                  committer='Joe Foo <joe@foo.com>')
 
712
        wt.commit('rev-merged', rev_id='rev-2a',
 
713
                  timestamp=1132586700, timezone=36000,
 
714
                  committer='Joe Foo <joe@foo.com>')
 
715
        wt.set_parent_ids(['rev-1', 'rev-2a'])
 
716
        wt.branch.set_last_revision_info(1, 'rev-1')
 
717
        wt.commit('rev-2', rev_id='rev-2b',
 
718
                  timestamp=1132586800, timezone=36000,
 
719
                  committer='Joe Foo <joe@foo.com>')
 
720
        logfile = self.make_utf8_encoded_stringio()
 
721
        formatter = log.LineLogFormatter(to_file=logfile)
 
722
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
 
723
        wtb = wt.branch
 
724
        rev = revspec.in_history(wtb)
 
725
        log.show_log(wtb, formatter, start_revision=rev, end_revision=rev)
 
726
        self.assertEqualDiff("""\
 
727
1.1.1: Joe Foo 2005-11-22 rev-merged
 
728
""",
 
729
                             logfile.getvalue())
 
730
 
 
731
 
 
732
 
 
733
class TestGetViewRevisions(tests.TestCaseWithTransport):
923
734
 
924
735
    def make_tree_with_commits(self):
925
736
        """Create a tree with well-known revision ids"""
926
737
        wt = self.make_branch_and_tree('tree1')
927
 
        self.wt_commit(wt, 'commit one', rev_id='1')
928
 
        self.wt_commit(wt, 'commit two', rev_id='2')
929
 
        self.wt_commit(wt, 'commit three', rev_id='3')
 
738
        wt.commit('commit one', rev_id='1')
 
739
        wt.commit('commit two', rev_id='2')
 
740
        wt.commit('commit three', rev_id='3')
930
741
        mainline_revs = [None, '1', '2', '3']
931
742
        rev_nos = {'1': 1, '2': 2, '3': 3}
932
743
        return mainline_revs, rev_nos, wt
935
746
        """Create a tree with well-known revision ids and a merge"""
936
747
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
937
748
        tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
938
 
        self.wt_commit(tree2, 'four-a', rev_id='4a')
 
749
        tree2.commit('four-a', rev_id='4a')
939
750
        wt.merge_from_branch(tree2.branch)
940
 
        self.wt_commit(wt, 'four-b', rev_id='4b')
 
751
        wt.commit('four-b', rev_id='4b')
941
752
        mainline_revs.append('4b')
942
753
        rev_nos['4b'] = 4
943
754
        # 4a: 3.1.1
944
755
        return mainline_revs, rev_nos, wt
945
756
 
946
 
    def make_branch_with_many_merges(self):
 
757
    def make_tree_with_many_merges(self):
947
758
        """Create a tree with well-known revision ids"""
948
 
        builder = self.make_branch_builder('tree1')
949
 
        builder.start_series()
950
 
        builder.build_snapshot('1', None, [
951
 
            ('add', ('', 'TREE_ROOT', 'directory', '')),
952
 
            ('add', ('f', 'f-id', 'file', '1\n'))])
953
 
        builder.build_snapshot('2', ['1'], [])
954
 
        builder.build_snapshot('3a', ['2'], [
955
 
            ('modify', ('f-id', '1\n2\n3a\n'))])
956
 
        builder.build_snapshot('3b', ['2', '3a'], [
957
 
            ('modify', ('f-id', '1\n2\n3a\n'))])
958
 
        builder.build_snapshot('3c', ['2', '3b'], [
959
 
            ('modify', ('f-id', '1\n2\n3a\n'))])
960
 
        builder.build_snapshot('4a', ['3b'], [])
961
 
        builder.build_snapshot('4b', ['3c', '4a'], [])
962
 
        builder.finish_series()
963
 
 
964
 
        # 1
965
 
        # |
966
 
        # 2-.
967
 
        # |\ \
968
 
        # | | 3a
969
 
        # | |/
970
 
        # | 3b
971
 
        # |/|
972
 
        # 3c4a
973
 
        # |/
974
 
        # 4b
 
759
        wt = self.make_branch_and_tree('tree1')
 
760
        self.build_tree_contents([('tree1/f', '1\n')])
 
761
        wt.add(['f'], ['f-id'])
 
762
        wt.commit('commit one', rev_id='1')
 
763
        wt.commit('commit two', rev_id='2')
 
764
 
 
765
        tree3 = wt.bzrdir.sprout('tree3').open_workingtree()
 
766
        self.build_tree_contents([('tree3/f', '1\n2\n3a\n')])
 
767
        tree3.commit('commit three a', rev_id='3a')
 
768
 
 
769
        tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
 
770
        tree2.merge_from_branch(tree3.branch)
 
771
        tree2.commit('commit three b', rev_id='3b')
 
772
 
 
773
        wt.merge_from_branch(tree2.branch)
 
774
        wt.commit('commit three c', rev_id='3c')
 
775
        tree2.commit('four-a', rev_id='4a')
 
776
 
 
777
        wt.merge_from_branch(tree2.branch)
 
778
        wt.commit('four-b', rev_id='4b')
975
779
 
976
780
        mainline_revs = [None, '1', '2', '3c', '4b']
977
781
        rev_nos = {'1':1, '2':2, '3c': 3, '4b':4}
984
788
            '4a': '2.2.2', # second commit tree 2
985
789
            '4b': '4', # merges 4a to main
986
790
            }
987
 
        return mainline_revs, rev_nos, builder.get_branch()
 
791
        return mainline_revs, rev_nos, wt
988
792
 
989
793
    def test_get_view_revisions_forward(self):
990
794
        """Test the get_view_revisions method"""
991
795
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
992
796
        wt.lock_read()
993
797
        self.addCleanup(wt.unlock)
994
 
        revisions = list(self._get_view_revisions(
 
798
        revisions = list(log.get_view_revisions(
995
799
                mainline_revs, rev_nos, wt.branch, 'forward'))
996
800
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0)],
997
801
                         revisions)
998
 
        revisions2 = list(self._get_view_revisions(
 
802
        revisions2 = list(log.get_view_revisions(
999
803
                mainline_revs, rev_nos, wt.branch, 'forward',
1000
804
                include_merges=False))
1001
805
        self.assertEqual(revisions, revisions2)
1005
809
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
1006
810
        wt.lock_read()
1007
811
        self.addCleanup(wt.unlock)
1008
 
        revisions = list(self._get_view_revisions(
 
812
        revisions = list(log.get_view_revisions(
1009
813
                mainline_revs, rev_nos, wt.branch, 'reverse'))
1010
814
        self.assertEqual([('3', '3', 0), ('2', '2', 0), ('1', '1', 0), ],
1011
815
                         revisions)
1012
 
        revisions2 = list(self._get_view_revisions(
 
816
        revisions2 = list(log.get_view_revisions(
1013
817
                mainline_revs, rev_nos, wt.branch, 'reverse',
1014
818
                include_merges=False))
1015
819
        self.assertEqual(revisions, revisions2)
1019
823
        mainline_revs, rev_nos, wt = self.make_tree_with_merges()
1020
824
        wt.lock_read()
1021
825
        self.addCleanup(wt.unlock)
1022
 
        revisions = list(self._get_view_revisions(
 
826
        revisions = list(log.get_view_revisions(
1023
827
                mainline_revs, rev_nos, wt.branch, 'forward'))
1024
828
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
1025
829
                          ('4b', '4', 0), ('4a', '3.1.1', 1)],
1026
830
                         revisions)
1027
 
        revisions = list(self._get_view_revisions(
 
831
        revisions = list(log.get_view_revisions(
1028
832
                mainline_revs, rev_nos, wt.branch, 'forward',
1029
833
                include_merges=False))
1030
834
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
1036
840
        mainline_revs, rev_nos, wt = self.make_tree_with_merges()
1037
841
        wt.lock_read()
1038
842
        self.addCleanup(wt.unlock)
1039
 
        revisions = list(self._get_view_revisions(
 
843
        revisions = list(log.get_view_revisions(
1040
844
                mainline_revs, rev_nos, wt.branch, 'reverse'))
1041
845
        self.assertEqual([('4b', '4', 0), ('4a', '3.1.1', 1),
1042
846
                          ('3', '3', 0), ('2', '2', 0), ('1', '1', 0)],
1043
847
                         revisions)
1044
 
        revisions = list(self._get_view_revisions(
 
848
        revisions = list(log.get_view_revisions(
1045
849
                mainline_revs, rev_nos, wt.branch, 'reverse',
1046
850
                include_merges=False))
1047
851
        self.assertEqual([('4b', '4', 0), ('3', '3', 0), ('2', '2', 0),
1050
854
 
1051
855
    def test_get_view_revisions_merge2(self):
1052
856
        """Test get_view_revisions when there are merges"""
1053
 
        mainline_revs, rev_nos, b = self.make_branch_with_many_merges()
1054
 
        b.lock_read()
1055
 
        self.addCleanup(b.unlock)
1056
 
        revisions = list(self._get_view_revisions(
1057
 
                mainline_revs, rev_nos, b, 'forward'))
 
857
        mainline_revs, rev_nos, wt = self.make_tree_with_many_merges()
 
858
        wt.lock_read()
 
859
        self.addCleanup(wt.unlock)
 
860
        revisions = list(log.get_view_revisions(
 
861
                mainline_revs, rev_nos, wt.branch, 'forward'))
1058
862
        expected = [('1', '1', 0), ('2', '2', 0), ('3c', '3', 0),
1059
 
                    ('3b', '2.2.1', 1), ('3a', '2.1.1', 2), ('4b', '4', 0),
 
863
                    ('3a', '2.1.1', 1), ('3b', '2.2.1', 1), ('4b', '4', 0),
1060
864
                    ('4a', '2.2.2', 1)]
1061
865
        self.assertEqual(expected, revisions)
1062
 
        revisions = list(self._get_view_revisions(
1063
 
                mainline_revs, rev_nos, b, 'forward',
 
866
        revisions = list(log.get_view_revisions(
 
867
                mainline_revs, rev_nos, wt.branch, 'forward',
1064
868
                include_merges=False))
1065
869
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3c', '3', 0),
1066
870
                          ('4b', '4', 0)],
1067
871
                         revisions)
1068
872
 
 
873
 
1069
874
    def test_file_id_for_range(self):
1070
 
        mainline_revs, rev_nos, b = self.make_branch_with_many_merges()
1071
 
        b.lock_read()
1072
 
        self.addCleanup(b.unlock)
 
875
        mainline_revs, rev_nos, wt = self.make_tree_with_many_merges()
 
876
        wt.lock_read()
 
877
        self.addCleanup(wt.unlock)
1073
878
 
1074
879
        def rev_from_rev_id(revid, branch):
1075
880
            revspec = revisionspec.RevisionSpec.from_string('revid:%s' % revid)
1076
881
            return revspec.in_history(branch)
1077
882
 
1078
883
        def view_revs(start_rev, end_rev, file_id, direction):
1079
 
            revs = self.applyDeprecated(
1080
 
                symbol_versioning.deprecated_in((2, 2, 0)),
1081
 
                log.calculate_view_revisions,
1082
 
                b,
 
884
            revs = log.calculate_view_revisions(
 
885
                wt.branch,
1083
886
                start_rev, # start_revision
1084
887
                end_rev, # end_revision
1085
888
                direction, # direction
1086
889
                file_id, # specific_fileid
1087
890
                True, # generate_merge_revisions
 
891
                True, # allow_single_merge_revision
1088
892
                )
1089
893
            return revs
1090
894
 
1091
 
        rev_3a = rev_from_rev_id('3a', b)
1092
 
        rev_4b = rev_from_rev_id('4b', b)
1093
 
        self.assertEqual([('3c', '3', 0), ('3b', '2.2.1', 1),
1094
 
                          ('3a', '2.1.1', 2)],
 
895
        rev_3a = rev_from_rev_id('3a', wt.branch)
 
896
        rev_4b = rev_from_rev_id('4b', wt.branch)
 
897
        self.assertEqual([('3c', '3', 0), ('3a', '2.1.1', 1)],
1095
898
                          view_revs(rev_3a, rev_4b, 'f-id', 'reverse'))
1096
 
        # Note: 3c still appears before 3a here because of depth-based sorting
1097
 
        self.assertEqual([('3c', '3', 0), ('3b', '2.2.1', 1),
1098
 
                          ('3a', '2.1.1', 2)],
 
899
        # Note that the depth is 0 for 3a because depths are normalized, but
 
900
        # there is still a bug somewhere... most probably in
 
901
        # _filter_revision_range and/or get_view_revisions still around a bad
 
902
        # use of reverse_by_depth
 
903
        self.assertEqual([('3a', '2.1.1', 0)],
1099
904
                          view_revs(rev_3a, rev_4b, 'f-id', 'forward'))
1100
905
 
1101
906
 
1102
907
class TestGetRevisionsTouchingFileID(tests.TestCaseWithTransport):
1103
908
 
1104
 
    def get_view_revisions(self, *args):
1105
 
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1106
 
                                    log.get_view_revisions, *args)
1107
 
 
1108
909
    def create_tree_with_single_merge(self):
1109
910
        """Create a branch with a moderate layout.
1110
911
 
1128
929
        #       use it. Since 'log' only uses the tree in a readonly
1129
930
        #       fashion, it seems a shame to regenerate an identical
1130
931
        #       tree for each test.
1131
 
        # TODO: vila 20100122 One way to address the shame above will be to
1132
 
        #       create a memory tree during test parametrization and give a
1133
 
        #       *copy* of this tree to each test. Copying a memory tree ought
1134
 
        #       to be cheap, at least cheaper than creating them with such
1135
 
        #       complex setups.
1136
932
        tree = self.make_branch_and_tree('tree')
1137
933
        tree.lock_write()
1138
934
        self.addCleanup(tree.unlock)
1213
1009
        mainline = tree.branch.revision_history()
1214
1010
        mainline.insert(0, None)
1215
1011
        revnos = dict((rev, idx+1) for idx, rev in enumerate(mainline))
1216
 
        view_revs_iter = self.get_view_revisions(
1217
 
            mainline, revnos, tree.branch, 'reverse', True)
 
1012
        view_revs_iter = log.get_view_revisions(mainline, revnos, tree.branch,
 
1013
                                                'reverse', True)
1218
1014
        actual_revs = log._filter_revisions_touching_file_id(
1219
 
            tree.branch, file_id, list(view_revs_iter))
 
1015
                            tree.branch,
 
1016
                            file_id,
 
1017
                            list(view_revs_iter))
1220
1018
        self.assertEqual(revisions, [r for r, revno, depth in actual_revs])
1221
1019
 
1222
1020
    def test_file_id_f1(self):
1250
1048
        self.assertAllRevisionsForFileID(tree, 'f1-id', ['XX', 'B', 'A'])
1251
1049
        self.assertAllRevisionsForFileID(tree, 'f2-id', ['D', 'C', 'A'])
1252
1050
 
1253
 
    def test_unknown_file_id(self):
1254
 
        tree = self.create_tree_with_single_merge()
1255
 
        self.assertAllRevisionsForFileID(tree, 'unknown', [])
1256
 
 
1257
 
    def test_empty_branch_unknown_file_id(self):
1258
 
        tree = self.make_branch_and_tree('tree')
1259
 
        self.assertAllRevisionsForFileID(tree, 'unknown', [])
1260
 
 
1261
1051
 
1262
1052
class TestShowChangedRevisions(tests.TestCaseWithTransport):
1263
1053
 
1274
1064
 
1275
1065
class TestLogFormatter(tests.TestCase):
1276
1066
 
1277
 
    def setUp(self):
1278
 
        super(TestLogFormatter, self).setUp()
1279
 
        self.rev = revision.Revision('a-id')
1280
 
        self.lf = log.LogFormatter(None)
1281
 
 
1282
1067
    def test_short_committer(self):
1283
 
        def assertCommitter(expected, committer):
1284
 
            self.rev.committer = committer
1285
 
            self.assertEqual(expected, self.lf.short_committer(self.rev))
1286
 
 
1287
 
        assertCommitter('John Doe', 'John Doe <jdoe@example.com>')
1288
 
        assertCommitter('John Smith', 'John Smith <jsmith@example.com>')
1289
 
        assertCommitter('John Smith', 'John Smith')
1290
 
        assertCommitter('jsmith@example.com', 'jsmith@example.com')
1291
 
        assertCommitter('jsmith@example.com', '<jsmith@example.com>')
1292
 
        assertCommitter('John Smith', 'John Smith jsmith@example.com')
 
1068
        rev = revision.Revision('a-id')
 
1069
        rev.committer = 'John Doe <jdoe@example.com>'
 
1070
        lf = log.LogFormatter(None)
 
1071
        self.assertEqual('John Doe', lf.short_committer(rev))
 
1072
        rev.committer = 'John Smith <jsmith@example.com>'
 
1073
        self.assertEqual('John Smith', lf.short_committer(rev))
 
1074
        rev.committer = 'John Smith'
 
1075
        self.assertEqual('John Smith', lf.short_committer(rev))
 
1076
        rev.committer = 'jsmith@example.com'
 
1077
        self.assertEqual('jsmith@example.com', lf.short_committer(rev))
 
1078
        rev.committer = '<jsmith@example.com>'
 
1079
        self.assertEqual('jsmith@example.com', lf.short_committer(rev))
 
1080
        rev.committer = 'John Smith jsmith@example.com'
 
1081
        self.assertEqual('John Smith', lf.short_committer(rev))
1293
1082
 
1294
1083
    def test_short_author(self):
1295
 
        def assertAuthor(expected, author):
1296
 
            self.rev.properties['author'] = author
1297
 
            self.assertEqual(expected, self.lf.short_author(self.rev))
1298
 
 
1299
 
        assertAuthor('John Smith', 'John Smith <jsmith@example.com>')
1300
 
        assertAuthor('John Smith', 'John Smith')
1301
 
        assertAuthor('jsmith@example.com', 'jsmith@example.com')
1302
 
        assertAuthor('jsmith@example.com', '<jsmith@example.com>')
1303
 
        assertAuthor('John Smith', 'John Smith jsmith@example.com')
1304
 
 
1305
 
    def test_short_author_from_committer(self):
1306
 
        self.rev.committer = 'John Doe <jdoe@example.com>'
1307
 
        self.assertEqual('John Doe', self.lf.short_author(self.rev))
1308
 
 
1309
 
    def test_short_author_from_authors(self):
1310
 
        self.rev.properties['authors'] = ('John Smith <jsmith@example.com>\n'
1311
 
                                          'Jane Rey <jrey@example.com>')
1312
 
        self.assertEqual('John Smith', self.lf.short_author(self.rev))
 
1084
        rev = revision.Revision('a-id')
 
1085
        rev.committer = 'John Doe <jdoe@example.com>'
 
1086
        lf = log.LogFormatter(None)
 
1087
        self.assertEqual('John Doe', lf.short_author(rev))
 
1088
        rev.properties['author'] = 'John Smith <jsmith@example.com>'
 
1089
        self.assertEqual('John Smith', lf.short_author(rev))
 
1090
        rev.properties['author'] = 'John Smith'
 
1091
        self.assertEqual('John Smith', lf.short_author(rev))
 
1092
        rev.properties['author'] = 'jsmith@example.com'
 
1093
        self.assertEqual('jsmith@example.com', lf.short_author(rev))
 
1094
        rev.properties['author'] = '<jsmith@example.com>'
 
1095
        self.assertEqual('jsmith@example.com', lf.short_author(rev))
 
1096
        rev.properties['author'] = 'John Smith jsmith@example.com'
 
1097
        self.assertEqual('John Smith', lf.short_author(rev))
1313
1098
 
1314
1099
 
1315
1100
class TestReverseByDepth(tests.TestCase):
1364
1149
        # revisions are not in the same order.
1365
1150
        self.assertReversed([('1', 2), ('2', 2), ('3', 3), ('4', 4)],
1366
1151
                            [('3', 3), ('4', 4), ('2', 2), ('1', 2),])
1367
 
 
1368
 
 
1369
 
class TestHistoryChange(tests.TestCaseWithTransport):
1370
 
 
1371
 
    def setup_a_tree(self):
1372
 
        tree = self.make_branch_and_tree('tree')
1373
 
        tree.lock_write()
1374
 
        self.addCleanup(tree.unlock)
1375
 
        tree.commit('1a', rev_id='1a')
1376
 
        tree.commit('2a', rev_id='2a')
1377
 
        tree.commit('3a', rev_id='3a')
1378
 
        return tree
1379
 
 
1380
 
    def setup_ab_tree(self):
1381
 
        tree = self.setup_a_tree()
1382
 
        tree.set_last_revision('1a')
1383
 
        tree.branch.set_last_revision_info(1, '1a')
1384
 
        tree.commit('2b', rev_id='2b')
1385
 
        tree.commit('3b', rev_id='3b')
1386
 
        return tree
1387
 
 
1388
 
    def setup_ac_tree(self):
1389
 
        tree = self.setup_a_tree()
1390
 
        tree.set_last_revision(revision.NULL_REVISION)
1391
 
        tree.branch.set_last_revision_info(0, revision.NULL_REVISION)
1392
 
        tree.commit('1c', rev_id='1c')
1393
 
        tree.commit('2c', rev_id='2c')
1394
 
        tree.commit('3c', rev_id='3c')
1395
 
        return tree
1396
 
 
1397
 
    def test_all_new(self):
1398
 
        tree = self.setup_ab_tree()
1399
 
        old, new = log.get_history_change('1a', '3a', tree.branch.repository)
1400
 
        self.assertEqual([], old)
1401
 
        self.assertEqual(['2a', '3a'], new)
1402
 
 
1403
 
    def test_all_old(self):
1404
 
        tree = self.setup_ab_tree()
1405
 
        old, new = log.get_history_change('3a', '1a', tree.branch.repository)
1406
 
        self.assertEqual([], new)
1407
 
        self.assertEqual(['2a', '3a'], old)
1408
 
 
1409
 
    def test_null_old(self):
1410
 
        tree = self.setup_ab_tree()
1411
 
        old, new = log.get_history_change(revision.NULL_REVISION,
1412
 
                                          '3a', tree.branch.repository)
1413
 
        self.assertEqual([], old)
1414
 
        self.assertEqual(['1a', '2a', '3a'], new)
1415
 
 
1416
 
    def test_null_new(self):
1417
 
        tree = self.setup_ab_tree()
1418
 
        old, new = log.get_history_change('3a', revision.NULL_REVISION,
1419
 
                                          tree.branch.repository)
1420
 
        self.assertEqual([], new)
1421
 
        self.assertEqual(['1a', '2a', '3a'], old)
1422
 
 
1423
 
    def test_diverged(self):
1424
 
        tree = self.setup_ab_tree()
1425
 
        old, new = log.get_history_change('3a', '3b', tree.branch.repository)
1426
 
        self.assertEqual(old, ['2a', '3a'])
1427
 
        self.assertEqual(new, ['2b', '3b'])
1428
 
 
1429
 
    def test_unrelated(self):
1430
 
        tree = self.setup_ac_tree()
1431
 
        old, new = log.get_history_change('3a', '3c', tree.branch.repository)
1432
 
        self.assertEqual(old, ['1a', '2a', '3a'])
1433
 
        self.assertEqual(new, ['1c', '2c', '3c'])
1434
 
 
1435
 
    def test_show_branch_change(self):
1436
 
        tree = self.setup_ab_tree()
1437
 
        s = StringIO()
1438
 
        log.show_branch_change(tree.branch, s, 3, '3a')
1439
 
        self.assertContainsRe(s.getvalue(),
1440
 
            '[*]{60}\nRemoved Revisions:\n(.|\n)*2a(.|\n)*3a(.|\n)*'
1441
 
            '[*]{60}\n\nAdded Revisions:\n(.|\n)*2b(.|\n)*3b')
1442
 
 
1443
 
    def test_show_branch_change_no_change(self):
1444
 
        tree = self.setup_ab_tree()
1445
 
        s = StringIO()
1446
 
        log.show_branch_change(tree.branch, s, 3, '3b')
1447
 
        self.assertEqual(s.getvalue(),
1448
 
            'Nothing seems to have changed\n')
1449
 
 
1450
 
    def test_show_branch_change_no_old(self):
1451
 
        tree = self.setup_ab_tree()
1452
 
        s = StringIO()
1453
 
        log.show_branch_change(tree.branch, s, 2, '2b')
1454
 
        self.assertContainsRe(s.getvalue(), 'Added Revisions:')
1455
 
        self.assertNotContainsRe(s.getvalue(), 'Removed Revisions:')
1456
 
 
1457
 
    def test_show_branch_change_no_new(self):
1458
 
        tree = self.setup_ab_tree()
1459
 
        tree.branch.set_last_revision_info(2, '2b')
1460
 
        s = StringIO()
1461
 
        log.show_branch_change(tree.branch, s, 3, '3b')
1462
 
        self.assertContainsRe(s.getvalue(), 'Removed Revisions:')
1463
 
        self.assertNotContainsRe(s.getvalue(), 'Added Revisions:')
1464
 
 
1465
 
 
1466
 
 
1467
 
class TestLogWithBugs(TestCaseForLogFormatter, TestLogMixin):
1468
 
 
1469
 
    def setUp(self):
1470
 
        TestCaseForLogFormatter.setUp(self)
1471
 
        log.properties_handler_registry.register(
1472
 
            'bugs_properties_handler',
1473
 
            log._bugs_properties_handler)
1474
 
 
1475
 
    def make_commits_with_bugs(self):
1476
 
        """Helper method for LogFormatter tests"""
1477
 
        tree = self.make_branch_and_tree(u'.')
1478
 
        self.build_tree(['a', 'b'])
1479
 
        tree.add('a')
1480
 
        self.wt_commit(tree, 'simple log message', rev_id='a1',
1481
 
                       revprops={'bugs': 'test://bug/id fixed'})
1482
 
        tree.add('b')
1483
 
        self.wt_commit(tree, 'multiline\nlog\nmessage\n', rev_id='a2',
1484
 
                       authors=['Joe Bar <joe@bar.com>'],
1485
 
                       revprops={'bugs': 'test://bug/id fixed\n'
1486
 
                                 'test://bug/2 fixed'})
1487
 
        return tree
1488
 
 
1489
 
 
1490
 
    def test_long_bugs(self):
1491
 
        tree = self.make_commits_with_bugs()
1492
 
        self.assertFormatterResult("""\
1493
 
------------------------------------------------------------
1494
 
revno: 2
1495
 
fixes bug(s): test://bug/id test://bug/2
1496
 
author: Joe Bar <joe@bar.com>
1497
 
committer: Joe Foo <joe@foo.com>
1498
 
branch nick: work
1499
 
timestamp: Tue 2005-11-22 00:00:01 +0000
1500
 
message:
1501
 
  multiline
1502
 
  log
1503
 
  message
1504
 
------------------------------------------------------------
1505
 
revno: 1
1506
 
fixes bug(s): test://bug/id
1507
 
committer: Joe Foo <joe@foo.com>
1508
 
branch nick: work
1509
 
timestamp: Tue 2005-11-22 00:00:00 +0000
1510
 
message:
1511
 
  simple log message
1512
 
""",
1513
 
            tree.branch, log.LongLogFormatter)
1514
 
 
1515
 
    def test_short_bugs(self):
1516
 
        tree = self.make_commits_with_bugs()
1517
 
        self.assertFormatterResult("""\
1518
 
    2 Joe Bar\t2005-11-22
1519
 
      fixes bug(s): test://bug/id test://bug/2
1520
 
      multiline
1521
 
      log
1522
 
      message
1523
 
 
1524
 
    1 Joe Foo\t2005-11-22
1525
 
      fixes bug(s): test://bug/id
1526
 
      simple log message
1527
 
 
1528
 
""",
1529
 
            tree.branch, log.ShortLogFormatter)
1530
 
 
1531
 
    def test_wrong_bugs_property(self):
1532
 
        tree = self.make_branch_and_tree(u'.')
1533
 
        self.build_tree(['foo'])
1534
 
        self.wt_commit(tree, 'simple log message', rev_id='a1',
1535
 
                       revprops={'bugs': 'test://bug/id invalid_value'})
1536
 
        self.assertFormatterResult("""\
1537
 
    1 Joe Foo\t2005-11-22
1538
 
      simple log message
1539
 
 
1540
 
""",
1541
 
            tree.branch, log.ShortLogFormatter)
1542
 
 
1543
 
    def test_bugs_handler_present(self):
1544
 
        self.properties_handler_registry.get('bugs_properties_handler')
1545
 
 
1546
 
class TestLogExcludeAncestry(tests.TestCaseWithTransport):
1547
 
 
1548
 
    def make_branch_with_alternate_ancestries(self, relpath='.'):
1549
 
        # See test_merge_sorted_exclude_ancestry below for the difference with
1550
 
        # bt.per_branch.test_iter_merge_sorted_revision.
1551
 
        # TestIterMergeSortedRevisionsBushyGraph. 
1552
 
        # make_branch_with_alternate_ancestries
1553
 
        # and test_merge_sorted_exclude_ancestry
1554
 
        # See the FIXME in assertLogRevnos too.
1555
 
        builder = branchbuilder.BranchBuilder(self.get_transport(relpath))
1556
 
        # 1
1557
 
        # |\
1558
 
        # 2 \
1559
 
        # |  |
1560
 
        # |  1.1.1
1561
 
        # |  | \
1562
 
        # |  |  1.2.1
1563
 
        # |  | /
1564
 
        # |  1.1.2
1565
 
        # | /
1566
 
        # 3
1567
 
        builder.start_series()
1568
 
        builder.build_snapshot('1', None, [
1569
 
            ('add', ('', 'TREE_ROOT', 'directory', '')),])
1570
 
        builder.build_snapshot('1.1.1', ['1'], [])
1571
 
        builder.build_snapshot('2', ['1'], [])
1572
 
        builder.build_snapshot('1.2.1', ['1.1.1'], [])
1573
 
        builder.build_snapshot('1.1.2', ['1.1.1', '1.2.1'], [])
1574
 
        builder.build_snapshot('3', ['2', '1.1.2'], [])
1575
 
        builder.finish_series()
1576
 
        br = builder.get_branch()
1577
 
        br.lock_read()
1578
 
        self.addCleanup(br.unlock)
1579
 
        return br
1580
 
 
1581
 
    def assertLogRevnos(self, expected_revnos, b, start, end,
1582
 
                        exclude_common_ancestry):
1583
 
        # FIXME: the layering in log makes it hard to test intermediate levels,
1584
 
        # I wish adding filters with their parameters were easier...
1585
 
        # -- vila 20100413
1586
 
        iter_revs = log._calc_view_revisions(
1587
 
            b, start, end, direction='reverse',
1588
 
            generate_merge_revisions=True,
1589
 
            exclude_common_ancestry=exclude_common_ancestry)
1590
 
        self.assertEqual(expected_revnos,
1591
 
                         [revid for revid, revno, depth in iter_revs])
1592
 
 
1593
 
    def test_merge_sorted_exclude_ancestry(self):
1594
 
        b = self.make_branch_with_alternate_ancestries()
1595
 
        self.assertLogRevnos(['3', '1.1.2', '1.2.1', '1.1.1', '2', '1'],
1596
 
                             b, '1', '3', False)
1597
 
        # '2' is part of the '3' ancestry but not part of '1.1.1' ancestry so
1598
 
        # it should be mentioned even if merge_sort order will make it appear
1599
 
        # after 1.1.1
1600
 
        self.assertLogRevnos(['3', '1.1.2', '1.2.1', '2'],
1601
 
                             b, '1.1.1', '3', True)
1602
 
 
1603