~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_log.py

  • Committer: Aaron Bentley
  • Date: 2007-06-21 23:43:17 UTC
  • mto: (2520.5.2 bzr.mpbundle)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070621234317-5w3h8h36oe90sups
Implement new merge directive format

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
 
from bzrlib import (
21
 
    errors,
22
 
    log,
23
 
    registry,
24
 
    revision,
25
 
    revisionspec,
26
 
    symbol_versioning,
27
 
    tests,
28
 
    )
29
 
 
30
 
 
31
 
class TestLogMixin(object):
32
 
 
33
 
    def wt_commit(self, wt, message, **kwargs):
34
 
        """Use some mostly fixed values for commits to simplify tests.
35
 
 
36
 
        Tests can use this function to get some commit attributes. The time
37
 
        stamp is incremented at each commit.
38
 
        """
39
 
        if getattr(self, 'timestamp', None) is None:
40
 
            self.timestamp = 1132617600 # Mon 2005-11-22 00:00:00 +0000
41
 
        else:
42
 
            self.timestamp += 1 # 1 second between each commit
43
 
        kwargs.setdefault('timestamp', self.timestamp)
44
 
        kwargs.setdefault('timezone', 0) # UTC
45
 
        kwargs.setdefault('committer', 'Joe Foo <joe@foo.com>')
46
 
 
47
 
        return wt.commit(message, **kwargs)
48
 
 
49
 
 
50
 
class TestCaseForLogFormatter(tests.TestCaseWithTransport, TestLogMixin):
51
 
 
52
 
    def setUp(self):
53
 
        super(TestCaseForLogFormatter, self).setUp()
54
 
        # keep a reference to the "current" custom prop. handler registry
55
 
        self.properties_handler_registry = log.properties_handler_registry
56
 
        # Use a clean registry for log
57
 
        log.properties_handler_registry = registry.Registry()
58
 
 
59
 
        def restore():
60
 
            log.properties_handler_registry = self.properties_handler_registry
61
 
        self.addCleanup(restore)
62
 
 
63
 
    def assertFormatterResult(self, result, branch, formatter_class,
64
 
                              formatter_kwargs=None, show_log_kwargs=None):
65
 
        logfile = self.make_utf8_encoded_stringio()
66
 
        if formatter_kwargs is None:
67
 
            formatter_kwargs = {}
68
 
        formatter = formatter_class(to_file=logfile, **formatter_kwargs)
69
 
        if show_log_kwargs is None:
70
 
            show_log_kwargs = {}
71
 
        log.show_log(branch, formatter, **show_log_kwargs)
72
 
        self.assertEqualDiff(result, logfile.getvalue())
73
 
 
74
 
    def make_standard_commit(self, branch_nick, **kwargs):
75
 
        wt = self.make_branch_and_tree('.')
76
 
        wt.lock_write()
77
 
        self.addCleanup(wt.unlock)
78
 
        self.build_tree(['a'])
79
 
        wt.add(['a'])
80
 
        wt.branch.nick = branch_nick
81
 
        kwargs.setdefault('committer', 'Lorem Ipsum <test@example.com>')
82
 
        kwargs.setdefault('authors', ['John Doe <jdoe@example.com>'])
83
 
        self.wt_commit(wt, 'add a', **kwargs)
84
 
        return wt
85
 
 
86
 
    def make_commits_with_trailing_newlines(self, wt):
87
 
        """Helper method for LogFormatter tests"""
88
 
        b = wt.branch
89
 
        b.nick = 'test'
90
 
        self.build_tree_contents([('a', 'hello moto\n')])
91
 
        self.wt_commit(wt, 'simple log message', rev_id='a1')
92
 
        self.build_tree_contents([('b', 'goodbye\n')])
93
 
        wt.add('b')
94
 
        self.wt_commit(wt, 'multiline\nlog\nmessage\n', rev_id='a2')
95
 
 
96
 
        self.build_tree_contents([('c', 'just another manic monday\n')])
97
 
        wt.add('c')
98
 
        self.wt_commit(wt, 'single line with trailing newline\n', rev_id='a3')
99
 
        return b
100
 
 
101
 
    def _prepare_tree_with_merges(self, with_tags=False):
102
 
        wt = self.make_branch_and_memory_tree('.')
103
 
        wt.lock_write()
104
 
        self.addCleanup(wt.unlock)
105
 
        wt.add('')
106
 
        self.wt_commit(wt, 'rev-1', rev_id='rev-1')
107
 
        self.wt_commit(wt, 'rev-merged', rev_id='rev-2a')
108
 
        wt.set_parent_ids(['rev-1', 'rev-2a'])
109
 
        wt.branch.set_last_revision_info(1, 'rev-1')
110
 
        self.wt_commit(wt, 'rev-2', rev_id='rev-2b')
111
 
        if with_tags:
112
 
            branch = wt.branch
113
 
            branch.tags.set_tag('v0.2', 'rev-2b')
114
 
            self.wt_commit(wt, 'rev-3', rev_id='rev-3')
115
 
            branch.tags.set_tag('v1.0rc1', 'rev-3')
116
 
            branch.tags.set_tag('v1.0', 'rev-3')
117
 
        return wt
118
 
 
119
 
class LogCatcher(log.LogFormatter):
120
 
    """Pull log messages into a list rather than displaying them.
121
 
 
122
 
    To simplify testing we save logged revisions here rather than actually
123
 
    formatting anything, so that we can precisely check the result without
124
 
    being dependent on the formatting.
 
20
from bzrlib import log
 
21
from bzrlib.tests import BzrTestBase, TestCaseWithTransport
 
22
from bzrlib.log import (show_log,
 
23
                        get_view_revisions,
 
24
                        LogRevision,
 
25
                        LogFormatter,
 
26
                        LongLogFormatter,
 
27
                        ShortLogFormatter,
 
28
                        LineLogFormatter)
 
29
from bzrlib.branch import Branch
 
30
from bzrlib.errors import InvalidRevisionNumber
 
31
 
 
32
 
 
33
class LogCatcher(LogFormatter):
 
34
    """Pull log messages into list rather than displaying them.
 
35
 
 
36
    For ease of testing we save log messages here rather than actually
 
37
    formatting them, so that we can precisely check the result without
 
38
    being too dependent on the exact formatting.
 
39
 
 
40
    We should also test the LogFormatter.
125
41
    """
126
42
 
127
 
    supports_merge_revisions = True
128
43
    supports_delta = True
129
 
    supports_diff = True
130
 
    preferred_levels = 0
131
44
 
132
 
    def __init__(self, *args, **kwargs):
133
 
        kwargs.update(dict(to_file=None))
134
 
        super(LogCatcher, self).__init__(*args, **kwargs)
135
 
        self.revisions = []
 
45
    def __init__(self):
 
46
        super(LogCatcher, self).__init__(to_file=None)
 
47
        self.logs = []
136
48
 
137
49
    def log_revision(self, revision):
138
 
        self.revisions.append(revision)
139
 
 
140
 
 
141
 
class TestShowLog(tests.TestCaseWithTransport):
 
50
        self.logs.append(revision)
 
51
 
 
52
 
 
53
class SimpleLogTest(TestCaseWithTransport):
142
54
 
143
55
    def checkDelta(self, delta, **kw):
144
 
        """Check the filenames touched by a delta are as expected.
145
 
 
146
 
        Caller only have to pass in the list of files for each part, all
147
 
        unspecified parts are considered empty (and checked as such).
148
 
        """
 
56
        """Check the filenames touched by a delta are as expected."""
149
57
        for n in 'added', 'removed', 'renamed', 'modified', 'unchanged':
150
 
            # By default we expect an empty list
151
58
            expected = kw.get(n, [])
 
59
 
 
60
            # tests are written with unix paths; fix them up for windows
 
61
            #if os.sep != '/':
 
62
            #    expected = [x.replace('/', os.sep) for x in expected]
 
63
 
152
64
            # strip out only the path components
153
65
            got = [x[0] for x in getattr(delta, n)]
154
 
            self.assertEqual(expected, got)
155
 
 
156
 
    def assertInvalidRevisonNumber(self, br, start, end):
157
 
        lf = LogCatcher()
158
 
        self.assertRaises(errors.InvalidRevisionNumber,
159
 
                          log.show_log, br, lf,
160
 
                          start_revision=start, end_revision=end)
 
66
            self.assertEquals(expected, got)
161
67
 
162
68
    def test_cur_revno(self):
163
69
        wt = self.make_branch_and_tree('.')
165
71
 
166
72
        lf = LogCatcher()
167
73
        wt.commit('empty commit')
168
 
        log.show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
169
 
 
170
 
        # Since there is a single revision in the branch all the combinations
171
 
        # below should fail.
172
 
        self.assertInvalidRevisonNumber(b, 2, 1)
173
 
        self.assertInvalidRevisonNumber(b, 1, 2)
174
 
        self.assertInvalidRevisonNumber(b, 0, 2)
175
 
        self.assertInvalidRevisonNumber(b, 1, 0)
176
 
        self.assertInvalidRevisonNumber(b, -1, 1)
177
 
        self.assertInvalidRevisonNumber(b, 1, -1)
178
 
 
179
 
    def test_empty_branch(self):
 
74
        show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
 
75
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
76
                          start_revision=2, end_revision=1) 
 
77
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
78
                          start_revision=1, end_revision=2) 
 
79
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
80
                          start_revision=0, end_revision=2) 
 
81
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
82
                          start_revision=1, end_revision=0) 
 
83
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
84
                          start_revision=-1, end_revision=1) 
 
85
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
86
                          start_revision=1, end_revision=-1) 
 
87
 
 
88
    def test_simple_log(self):
 
89
        eq = self.assertEquals
 
90
        
180
91
        wt = self.make_branch_and_tree('.')
 
92
        b = wt.branch
181
93
 
182
94
        lf = LogCatcher()
183
 
        log.show_log(wt.branch, lf)
 
95
        show_log(b, lf)
184
96
        # no entries yet
185
 
        self.assertEqual([], lf.revisions)
186
 
 
187
 
    def test_empty_commit(self):
188
 
        wt = self.make_branch_and_tree('.')
 
97
        eq(lf.logs, [])
189
98
 
190
99
        wt.commit('empty commit')
191
100
        lf = LogCatcher()
192
 
        log.show_log(wt.branch, lf, verbose=True)
193
 
        revs = lf.revisions
194
 
        self.assertEqual(1, len(revs))
195
 
        self.assertEqual('1', revs[0].revno)
196
 
        self.assertEqual('empty commit', revs[0].rev.message)
197
 
        self.checkDelta(revs[0].delta)
 
101
        show_log(b, lf, verbose=True)
 
102
        eq(len(lf.logs), 1)
 
103
        eq(lf.logs[0].revno, '1')
 
104
        eq(lf.logs[0].rev.message, 'empty commit')
 
105
        d = lf.logs[0].delta
 
106
        self.log('log delta: %r' % d)
 
107
        self.checkDelta(d)
198
108
 
199
 
    def test_simple_commit(self):
200
 
        wt = self.make_branch_and_tree('.')
201
 
        wt.commit('empty commit')
202
109
        self.build_tree(['hello'])
203
110
        wt.add('hello')
204
 
        wt.commit('add one file',
205
 
                  committer=u'\u013d\xf3r\xe9m \xcdp\u0161\xfam '
206
 
                            u'<test@example.com>')
 
111
        wt.commit('add one file')
 
112
 
 
113
        lf = StringIO()
 
114
        # log using regular thing
 
115
        show_log(b, LongLogFormatter(lf))
 
116
        lf.seek(0)
 
117
        for l in lf.readlines():
 
118
            self.log(l)
 
119
 
 
120
        # get log as data structure
207
121
        lf = LogCatcher()
208
 
        log.show_log(wt.branch, lf, verbose=True)
209
 
        self.assertEqual(2, len(lf.revisions))
 
122
        show_log(b, lf, verbose=True)
 
123
        eq(len(lf.logs), 2)
 
124
        self.log('log entries:')
 
125
        for logentry in lf.logs:
 
126
            self.log('%4s %s' % (logentry.revno, logentry.rev.message))
 
127
        
210
128
        # first one is most recent
211
 
        log_entry = lf.revisions[0]
212
 
        self.assertEqual('2', log_entry.revno)
213
 
        self.assertEqual('add one file', log_entry.rev.message)
214
 
        self.checkDelta(log_entry.delta, added=['hello'])
215
 
 
216
 
    def test_commit_message_with_control_chars(self):
217
 
        wt = self.make_branch_and_tree('.')
218
 
        msg = u"All 8-bit chars: " +  ''.join([unichr(x) for x in range(256)])
219
 
        msg = msg.replace(u'\r', u'\n')
 
129
        logentry = lf.logs[0]
 
130
        eq(logentry.revno, '2')
 
131
        eq(logentry.rev.message, 'add one file')
 
132
        d = logentry.delta
 
133
        self.log('log 2 delta: %r' % d)
 
134
        # self.checkDelta(d, added=['hello'])
 
135
        
 
136
        # commit a log message with control characters
 
137
        msg = "All 8-bit chars: " +  ''.join([unichr(x) for x in range(256)])
 
138
        self.log("original commit message: %r", msg)
220
139
        wt.commit(msg)
221
140
        lf = LogCatcher()
222
 
        log.show_log(wt.branch, lf, verbose=True)
223
 
        committed_msg = lf.revisions[0].rev.message
224
 
        if wt.branch.repository._serializer.squashes_xml_invalid_characters:
225
 
            self.assertNotEqual(msg, committed_msg)
226
 
            self.assertTrue(len(committed_msg) > len(msg))
227
 
        else:
228
 
            self.assertEqual(msg, committed_msg)
 
141
        show_log(b, lf, verbose=True)
 
142
        committed_msg = lf.logs[0].rev.message
 
143
        self.log("escaped commit message: %r", committed_msg)
 
144
        self.assert_(msg != committed_msg)
 
145
        self.assert_(len(committed_msg) > len(msg))
229
146
 
230
 
    def test_commit_message_without_control_chars(self):
231
 
        wt = self.make_branch_and_tree('.')
 
147
        # Check that log message with only XML-valid characters isn't
232
148
        # escaped.  As ElementTree apparently does some kind of
233
149
        # newline conversion, neither LF (\x0A) nor CR (\x0D) are
234
150
        # included in the test commit message, even though they are
235
151
        # valid XML 1.0 characters.
236
152
        msg = "\x09" + ''.join([unichr(x) for x in range(0x20, 256)])
 
153
        self.log("original commit message: %r", msg)
237
154
        wt.commit(msg)
238
155
        lf = LogCatcher()
239
 
        log.show_log(wt.branch, lf, verbose=True)
240
 
        committed_msg = lf.revisions[0].rev.message
241
 
        self.assertEqual(msg, committed_msg)
242
 
 
243
 
    def test_deltas_in_merge_revisions(self):
244
 
        """Check deltas created for both mainline and merge revisions"""
245
 
        wt = self.make_branch_and_tree('parent')
246
 
        self.build_tree(['parent/file1', 'parent/file2', 'parent/file3'])
247
 
        wt.add('file1')
248
 
        wt.add('file2')
249
 
        wt.commit(message='add file1 and file2')
250
 
        self.run_bzr('branch parent child')
251
 
        os.unlink('child/file1')
252
 
        file('child/file2', 'wb').write('hello\n')
253
 
        self.run_bzr(['commit', '-m', 'remove file1 and modify file2',
254
 
            'child'])
255
 
        os.chdir('parent')
256
 
        self.run_bzr('merge ../child')
257
 
        wt.commit('merge child branch')
258
 
        os.chdir('..')
259
 
        b = wt.branch
260
 
        lf = LogCatcher()
261
 
        lf.supports_merge_revisions = True
262
 
        log.show_log(b, lf, verbose=True)
263
 
 
264
 
        revs = lf.revisions
265
 
        self.assertEqual(3, len(revs))
266
 
 
267
 
        logentry = revs[0]
268
 
        self.assertEqual('2', logentry.revno)
269
 
        self.assertEqual('merge child branch', logentry.rev.message)
270
 
        self.checkDelta(logentry.delta, removed=['file1'], modified=['file2'])
271
 
 
272
 
        logentry = revs[1]
273
 
        self.assertEqual('1.1.1', logentry.revno)
274
 
        self.assertEqual('remove file1 and modify file2', logentry.rev.message)
275
 
        self.checkDelta(logentry.delta, removed=['file1'], modified=['file2'])
276
 
 
277
 
        logentry = revs[2]
278
 
        self.assertEqual('1', logentry.revno)
279
 
        self.assertEqual('add file1 and file2', logentry.rev.message)
280
 
        self.checkDelta(logentry.delta, added=['file1', 'file2'])
281
 
 
282
 
 
283
 
class TestShortLogFormatter(TestCaseForLogFormatter):
 
156
        show_log(b, lf, verbose=True)
 
157
        committed_msg = lf.logs[0].rev.message
 
158
        self.log("escaped commit message: %r", committed_msg)
 
159
        self.assert_(msg == committed_msg)
284
160
 
285
161
    def test_trailing_newlines(self):
286
162
        wt = self.make_branch_and_tree('.')
287
 
        b = self.make_commits_with_trailing_newlines(wt)
288
 
        self.assertFormatterResult("""\
289
 
    3 Joe Foo\t2005-11-22
 
163
        b = wt.branch
 
164
        b.nick='test'
 
165
        open('a', 'wb').write('hello moto\n')
 
166
        wt.add('a')
 
167
        wt.commit('simple log message', rev_id='a1'
 
168
                , timestamp=1132586655.459960938, timezone=-6*3600
 
169
                , committer='Joe Foo <joe@foo.com>')
 
170
        open('b', 'wb').write('goodbye\n')
 
171
        wt.add('b')
 
172
        wt.commit('multiline\nlog\nmessage\n', rev_id='a2'
 
173
                , timestamp=1132586842.411175966, timezone=-6*3600
 
174
                , committer='Joe Foo <joe@foo.com>')
 
175
 
 
176
        open('c', 'wb').write('just another manic monday\n')
 
177
        wt.add('c')
 
178
        wt.commit('single line with trailing newline\n', rev_id='a3'
 
179
                , timestamp=1132587176.835228920, timezone=-6*3600
 
180
                , committer = 'Joe Foo <joe@foo.com>')
 
181
 
 
182
        sio = StringIO()
 
183
        lf = ShortLogFormatter(to_file=sio)
 
184
        show_log(b, lf)
 
185
        self.assertEquals(sio.getvalue(), """\
 
186
    3 Joe Foo\t2005-11-21
290
187
      single line with trailing newline
291
188
 
292
 
    2 Joe Foo\t2005-11-22
 
189
    2 Joe Foo\t2005-11-21
293
190
      multiline
294
191
      log
295
192
      message
296
193
 
297
 
    1 Joe Foo\t2005-11-22
 
194
    1 Joe Foo\t2005-11-21
298
195
      simple log message
299
196
 
300
 
""",
301
 
            b, log.ShortLogFormatter)
302
 
 
303
 
    def test_short_log_with_merges(self):
304
 
        wt = self._prepare_tree_with_merges()
305
 
        self.assertFormatterResult("""\
306
 
    2 Joe Foo\t2005-11-22 [merge]
307
 
      rev-2
308
 
 
309
 
    1 Joe Foo\t2005-11-22
310
 
      rev-1
311
 
 
312
 
""",
313
 
            wt.branch, log.ShortLogFormatter)
314
 
 
315
 
    def test_short_log_with_merges_and_advice(self):
316
 
        wt = self._prepare_tree_with_merges()
317
 
        self.assertFormatterResult("""\
318
 
    2 Joe Foo\t2005-11-22 [merge]
319
 
      rev-2
320
 
 
321
 
    1 Joe Foo\t2005-11-22
322
 
      rev-1
323
 
 
324
 
Use --include-merges or -n0 to see merged revisions.
325
 
""",
326
 
            wt.branch, log.ShortLogFormatter,
327
 
            formatter_kwargs=dict(show_advice=True))
328
 
 
329
 
    def test_short_log_with_merges_and_range(self):
330
 
        wt = self._prepare_tree_with_merges()
331
 
        self.wt_commit(wt, 'rev-3a', rev_id='rev-3a')
332
 
        wt.branch.set_last_revision_info(2, 'rev-2b')
333
 
        wt.set_parent_ids(['rev-2b', 'rev-3a'])
334
 
        self.wt_commit(wt, 'rev-3b', rev_id='rev-3b')
335
 
        self.assertFormatterResult("""\
336
 
    3 Joe Foo\t2005-11-22 [merge]
337
 
      rev-3b
338
 
 
339
 
    2 Joe Foo\t2005-11-22 [merge]
340
 
      rev-2
341
 
 
342
 
""",
343
 
            wt.branch, log.ShortLogFormatter,
344
 
            show_log_kwargs=dict(start_revision=2, end_revision=3))
345
 
 
346
 
    def test_short_log_with_tags(self):
347
 
        wt = self._prepare_tree_with_merges(with_tags=True)
348
 
        self.assertFormatterResult("""\
349
 
    3 Joe Foo\t2005-11-22 {v1.0, v1.0rc1}
350
 
      rev-3
351
 
 
352
 
    2 Joe Foo\t2005-11-22 {v0.2} [merge]
353
 
      rev-2
354
 
 
355
 
    1 Joe Foo\t2005-11-22
356
 
      rev-1
357
 
 
358
 
""",
359
 
            wt.branch, log.ShortLogFormatter)
360
 
 
361
 
    def test_short_log_single_merge_revision(self):
362
 
        wt = self._prepare_tree_with_merges()
363
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
364
 
        rev = revspec.in_history(wt.branch)
365
 
        self.assertFormatterResult("""\
366
 
      1.1.1 Joe Foo\t2005-11-22
367
 
            rev-merged
368
 
 
369
 
""",
370
 
            wt.branch, log.ShortLogFormatter,
371
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
372
 
 
373
 
 
374
 
class TestShortLogFormatterWithMergeRevisions(TestCaseForLogFormatter):
375
 
 
376
 
    def test_short_merge_revs_log_with_merges(self):
377
 
        wt = self._prepare_tree_with_merges()
378
 
        # Note that the 1.1.1 indenting is in fact correct given that
379
 
        # the revision numbers are right justified within 5 characters
380
 
        # for mainline revnos and 9 characters for dotted revnos.
381
 
        self.assertFormatterResult("""\
382
 
    2 Joe Foo\t2005-11-22 [merge]
383
 
      rev-2
384
 
 
385
 
          1.1.1 Joe Foo\t2005-11-22
386
 
                rev-merged
387
 
 
388
 
    1 Joe Foo\t2005-11-22
389
 
      rev-1
390
 
 
391
 
""",
392
 
            wt.branch, log.ShortLogFormatter,
393
 
            formatter_kwargs=dict(levels=0))
394
 
 
395
 
    def test_short_merge_revs_log_single_merge_revision(self):
396
 
        wt = self._prepare_tree_with_merges()
397
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
398
 
        rev = revspec.in_history(wt.branch)
399
 
        self.assertFormatterResult("""\
400
 
      1.1.1 Joe Foo\t2005-11-22
401
 
            rev-merged
402
 
 
403
 
""",
404
 
            wt.branch, log.ShortLogFormatter,
405
 
            formatter_kwargs=dict(levels=0),
406
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
407
 
 
408
 
 
409
 
class TestLongLogFormatter(TestCaseForLogFormatter):
410
 
 
 
197
""")
 
198
 
 
199
        sio = StringIO()
 
200
        lf = LongLogFormatter(to_file=sio)
 
201
        show_log(b, lf)
 
202
        self.assertEquals(sio.getvalue(), """\
 
203
------------------------------------------------------------
 
204
revno: 3
 
205
committer: Joe Foo <joe@foo.com>
 
206
branch nick: test
 
207
timestamp: Mon 2005-11-21 09:32:56 -0600
 
208
message:
 
209
  single line with trailing newline
 
210
------------------------------------------------------------
 
211
revno: 2
 
212
committer: Joe Foo <joe@foo.com>
 
213
branch nick: test
 
214
timestamp: Mon 2005-11-21 09:27:22 -0600
 
215
message:
 
216
  multiline
 
217
  log
 
218
  message
 
219
------------------------------------------------------------
 
220
revno: 1
 
221
committer: Joe Foo <joe@foo.com>
 
222
branch nick: test
 
223
timestamp: Mon 2005-11-21 09:24:15 -0600
 
224
message:
 
225
  simple log message
 
226
""")
 
227
        
411
228
    def test_verbose_log(self):
412
229
        """Verbose log includes changed files
413
 
 
 
230
        
414
231
        bug #4676
415
232
        """
416
 
        wt = self.make_standard_commit('test_verbose_log', authors=[])
417
 
        self.assertFormatterResult('''\
 
233
        wt = self.make_branch_and_tree('.')
 
234
        b = wt.branch
 
235
        self.build_tree(['a'])
 
236
        wt.add('a')
 
237
        # XXX: why does a longer nick show up?
 
238
        b.nick = 'test_verbose_log'
 
239
        wt.commit(message='add a', 
 
240
                  timestamp=1132711707, 
 
241
                  timezone=36000,
 
242
                  committer='Lorem Ipsum <test@example.com>')
 
243
        logfile = file('out.tmp', 'w+')
 
244
        formatter = LongLogFormatter(to_file=logfile)
 
245
        show_log(b, formatter, verbose=True)
 
246
        logfile.flush()
 
247
        logfile.seek(0)
 
248
        log_contents = logfile.read()
 
249
        self.assertEqualDiff(log_contents, '''\
418
250
------------------------------------------------------------
419
251
revno: 1
420
252
committer: Lorem Ipsum <test@example.com>
421
253
branch nick: test_verbose_log
422
 
timestamp: Tue 2005-11-22 00:00:00 +0000
423
 
message:
424
 
  add a
425
 
added:
426
 
  a
427
 
''',
428
 
            wt.branch, log.LongLogFormatter,
429
 
            show_log_kwargs=dict(verbose=True))
430
 
 
431
 
    def test_merges_are_indented_by_level(self):
432
 
        wt = self.make_branch_and_tree('parent')
433
 
        self.wt_commit(wt, 'first post')
434
 
        child_wt = wt.bzrdir.sprout('child').open_workingtree()
435
 
        self.wt_commit(child_wt, 'branch 1')
436
 
        smallerchild_wt = wt.bzrdir.sprout('smallerchild').open_workingtree()
437
 
        self.wt_commit(smallerchild_wt, 'branch 2')
438
 
        child_wt.merge_from_branch(smallerchild_wt.branch)
439
 
        self.wt_commit(child_wt, 'merge branch 2')
440
 
        wt.merge_from_branch(child_wt.branch)
441
 
        self.wt_commit(wt, 'merge branch 1')
442
 
        self.assertFormatterResult("""\
443
 
------------------------------------------------------------
444
 
revno: 2 [merge]
445
 
committer: Joe Foo <joe@foo.com>
446
 
branch nick: parent
447
 
timestamp: Tue 2005-11-22 00:00:04 +0000
448
 
message:
449
 
  merge branch 1
450
 
    ------------------------------------------------------------
451
 
    revno: 1.1.2 [merge]
452
 
    committer: Joe Foo <joe@foo.com>
453
 
    branch nick: child
454
 
    timestamp: Tue 2005-11-22 00:00:03 +0000
455
 
    message:
456
 
      merge branch 2
457
 
        ------------------------------------------------------------
458
 
        revno: 1.2.1
459
 
        committer: Joe Foo <joe@foo.com>
460
 
        branch nick: smallerchild
461
 
        timestamp: Tue 2005-11-22 00:00:02 +0000
462
 
        message:
463
 
          branch 2
464
 
    ------------------------------------------------------------
465
 
    revno: 1.1.1
466
 
    committer: Joe Foo <joe@foo.com>
467
 
    branch nick: child
468
 
    timestamp: Tue 2005-11-22 00:00:01 +0000
469
 
    message:
470
 
      branch 1
471
 
------------------------------------------------------------
472
 
revno: 1
473
 
committer: Joe Foo <joe@foo.com>
474
 
branch nick: parent
475
 
timestamp: Tue 2005-11-22 00:00:00 +0000
476
 
message:
477
 
  first post
478
 
""",
479
 
            wt.branch, log.LongLogFormatter,
480
 
            formatter_kwargs=dict(levels=0),
481
 
            show_log_kwargs=dict(verbose=True))
482
 
 
483
 
    def test_verbose_merge_revisions_contain_deltas(self):
484
 
        wt = self.make_branch_and_tree('parent')
485
 
        self.build_tree(['parent/f1', 'parent/f2'])
486
 
        wt.add(['f1','f2'])
487
 
        self.wt_commit(wt, 'first post')
488
 
        child_wt = wt.bzrdir.sprout('child').open_workingtree()
489
 
        os.unlink('child/f1')
490
 
        self.build_tree_contents([('child/f2', 'hello\n')])
491
 
        self.wt_commit(child_wt, 'removed f1 and modified f2')
492
 
        wt.merge_from_branch(child_wt.branch)
493
 
        self.wt_commit(wt, 'merge branch 1')
494
 
        self.assertFormatterResult("""\
495
 
------------------------------------------------------------
496
 
revno: 2 [merge]
497
 
committer: Joe Foo <joe@foo.com>
498
 
branch nick: parent
499
 
timestamp: Tue 2005-11-22 00:00:02 +0000
500
 
message:
501
 
  merge branch 1
502
 
removed:
503
 
  f1
504
 
modified:
505
 
  f2
506
 
    ------------------------------------------------------------
507
 
    revno: 1.1.1
508
 
    committer: Joe Foo <joe@foo.com>
509
 
    branch nick: child
510
 
    timestamp: Tue 2005-11-22 00:00:01 +0000
511
 
    message:
512
 
      removed f1 and modified f2
513
 
    removed:
514
 
      f1
515
 
    modified:
516
 
      f2
517
 
------------------------------------------------------------
518
 
revno: 1
519
 
committer: Joe Foo <joe@foo.com>
520
 
branch nick: parent
521
 
timestamp: Tue 2005-11-22 00:00:00 +0000
522
 
message:
523
 
  first post
524
 
added:
525
 
  f1
526
 
  f2
527
 
""",
528
 
            wt.branch, log.LongLogFormatter,
529
 
            formatter_kwargs=dict(levels=0),
530
 
            show_log_kwargs=dict(verbose=True))
531
 
 
532
 
    def test_trailing_newlines(self):
533
 
        wt = self.make_branch_and_tree('.')
534
 
        b = self.make_commits_with_trailing_newlines(wt)
535
 
        self.assertFormatterResult("""\
536
 
------------------------------------------------------------
537
 
revno: 3
538
 
committer: Joe Foo <joe@foo.com>
539
 
branch nick: test
540
 
timestamp: Tue 2005-11-22 00:00:02 +0000
541
 
message:
542
 
  single line with trailing newline
543
 
------------------------------------------------------------
544
 
revno: 2
545
 
committer: Joe Foo <joe@foo.com>
546
 
branch nick: test
547
 
timestamp: Tue 2005-11-22 00:00:01 +0000
548
 
message:
549
 
  multiline
550
 
  log
551
 
  message
552
 
------------------------------------------------------------
553
 
revno: 1
554
 
committer: Joe Foo <joe@foo.com>
555
 
branch nick: test
556
 
timestamp: Tue 2005-11-22 00:00:00 +0000
557
 
message:
558
 
  simple log message
559
 
""",
560
 
        b, log.LongLogFormatter)
561
 
 
562
 
    def test_author_in_log(self):
563
 
        """Log includes the author name if it's set in
564
 
        the revision properties
565
 
        """
566
 
        wt = self.make_standard_commit('test_author_log',
567
 
            authors=['John Doe <jdoe@example.com>',
568
 
                     'Jane Rey <jrey@example.com>'])
569
 
        self.assertFormatterResult("""\
570
 
------------------------------------------------------------
571
 
revno: 1
572
 
author: John Doe <jdoe@example.com>, Jane Rey <jrey@example.com>
573
 
committer: Lorem Ipsum <test@example.com>
574
 
branch nick: test_author_log
575
 
timestamp: Tue 2005-11-22 00:00:00 +0000
576
 
message:
577
 
  add a
578
 
""",
579
 
        wt.branch, log.LongLogFormatter)
580
 
 
581
 
    def test_properties_in_log(self):
582
 
        """Log includes the custom properties returned by the registered
583
 
        handlers.
584
 
        """
585
 
        wt = self.make_standard_commit('test_properties_in_log')
586
 
        def trivial_custom_prop_handler(revision):
587
 
            return {'test_prop':'test_value'}
588
 
 
589
 
        # Cleaned up in setUp()
590
 
        log.properties_handler_registry.register(
591
 
            'trivial_custom_prop_handler',
592
 
            trivial_custom_prop_handler)
593
 
        self.assertFormatterResult("""\
594
 
------------------------------------------------------------
595
 
revno: 1
596
 
test_prop: test_value
597
 
author: John Doe <jdoe@example.com>
598
 
committer: Lorem Ipsum <test@example.com>
599
 
branch nick: test_properties_in_log
600
 
timestamp: Tue 2005-11-22 00:00:00 +0000
601
 
message:
602
 
  add a
603
 
""",
604
 
            wt.branch, log.LongLogFormatter)
605
 
 
606
 
    def test_properties_in_short_log(self):
607
 
        """Log includes the custom properties returned by the registered
608
 
        handlers.
609
 
        """
610
 
        wt = self.make_standard_commit('test_properties_in_short_log')
611
 
        def trivial_custom_prop_handler(revision):
612
 
            return {'test_prop':'test_value'}
613
 
 
614
 
        log.properties_handler_registry.register(
615
 
            'trivial_custom_prop_handler',
616
 
            trivial_custom_prop_handler)
617
 
        self.assertFormatterResult("""\
618
 
    1 John Doe\t2005-11-22
619
 
      test_prop: test_value
620
 
      add a
621
 
 
622
 
""",
623
 
            wt.branch, log.ShortLogFormatter)
624
 
 
625
 
    def test_error_in_properties_handler(self):
626
 
        """Log includes the custom properties returned by the registered
627
 
        handlers.
628
 
        """
629
 
        wt = self.make_standard_commit('error_in_properties_handler',
630
 
            revprops={'first_prop':'first_value'})
631
 
        sio = self.make_utf8_encoded_stringio()
632
 
        formatter = log.LongLogFormatter(to_file=sio)
633
 
        def trivial_custom_prop_handler(revision):
634
 
            raise StandardError("a test error")
635
 
 
636
 
        log.properties_handler_registry.register(
637
 
            'trivial_custom_prop_handler',
638
 
            trivial_custom_prop_handler)
639
 
        self.assertRaises(StandardError, log.show_log, wt.branch, formatter,)
640
 
 
641
 
    def test_properties_handler_bad_argument(self):
642
 
        wt = self.make_standard_commit('bad_argument',
643
 
              revprops={'a_prop':'test_value'})
644
 
        sio = self.make_utf8_encoded_stringio()
645
 
        formatter = log.LongLogFormatter(to_file=sio)
646
 
        def bad_argument_prop_handler(revision):
647
 
            return {'custom_prop_name':revision.properties['a_prop']}
648
 
 
649
 
        log.properties_handler_registry.register(
650
 
            'bad_argument_prop_handler',
651
 
            bad_argument_prop_handler)
652
 
 
653
 
        self.assertRaises(AttributeError, formatter.show_properties,
654
 
                          'a revision', '')
655
 
 
656
 
        revision = wt.branch.repository.get_revision(wt.branch.last_revision())
657
 
        formatter.show_properties(revision, '')
658
 
        self.assertEqualDiff('''custom_prop_name: test_value\n''',
659
 
                             sio.getvalue())
660
 
 
661
 
 
662
 
class TestLongLogFormatterWithoutMergeRevisions(TestCaseForLogFormatter):
663
 
 
664
 
    def test_long_verbose_log(self):
665
 
        """Verbose log includes changed files
666
 
 
667
 
        bug #4676
668
 
        """
669
 
        wt = self.make_standard_commit('test_long_verbose_log', authors=[])
670
 
        self.assertFormatterResult("""\
671
 
------------------------------------------------------------
672
 
revno: 1
673
 
committer: Lorem Ipsum <test@example.com>
674
 
branch nick: test_long_verbose_log
675
 
timestamp: Tue 2005-11-22 00:00:00 +0000
676
 
message:
677
 
  add a
678
 
added:
679
 
  a
680
 
""",
681
 
            wt.branch, log.LongLogFormatter,
682
 
            formatter_kwargs=dict(levels=1),
683
 
            show_log_kwargs=dict(verbose=True))
684
 
 
685
 
    def test_long_verbose_contain_deltas(self):
686
 
        wt = self.make_branch_and_tree('parent')
687
 
        self.build_tree(['parent/f1', 'parent/f2'])
688
 
        wt.add(['f1','f2'])
689
 
        self.wt_commit(wt, 'first post')
690
 
        child_wt = wt.bzrdir.sprout('child').open_workingtree()
691
 
        os.unlink('child/f1')
692
 
        self.build_tree_contents([('child/f2', 'hello\n')])
693
 
        self.wt_commit(child_wt, 'removed f1 and modified f2')
694
 
        wt.merge_from_branch(child_wt.branch)
695
 
        self.wt_commit(wt, 'merge branch 1')
696
 
        self.assertFormatterResult("""\
697
 
------------------------------------------------------------
698
 
revno: 2 [merge]
699
 
committer: Joe Foo <joe@foo.com>
700
 
branch nick: parent
701
 
timestamp: Tue 2005-11-22 00:00:02 +0000
702
 
message:
703
 
  merge branch 1
704
 
removed:
705
 
  f1
706
 
modified:
707
 
  f2
708
 
------------------------------------------------------------
709
 
revno: 1
710
 
committer: Joe Foo <joe@foo.com>
711
 
branch nick: parent
712
 
timestamp: Tue 2005-11-22 00:00:00 +0000
713
 
message:
714
 
  first post
715
 
added:
716
 
  f1
717
 
  f2
718
 
""",
719
 
            wt.branch, log.LongLogFormatter,
720
 
            formatter_kwargs=dict(levels=1),
721
 
            show_log_kwargs=dict(verbose=True))
722
 
 
723
 
    def test_long_trailing_newlines(self):
724
 
        wt = self.make_branch_and_tree('.')
725
 
        b = self.make_commits_with_trailing_newlines(wt)
726
 
        self.assertFormatterResult("""\
727
 
------------------------------------------------------------
728
 
revno: 3
729
 
committer: Joe Foo <joe@foo.com>
730
 
branch nick: test
731
 
timestamp: Tue 2005-11-22 00:00:02 +0000
732
 
message:
733
 
  single line with trailing newline
734
 
------------------------------------------------------------
735
 
revno: 2
736
 
committer: Joe Foo <joe@foo.com>
737
 
branch nick: test
738
 
timestamp: Tue 2005-11-22 00:00:01 +0000
739
 
message:
740
 
  multiline
741
 
  log
742
 
  message
743
 
------------------------------------------------------------
744
 
revno: 1
745
 
committer: Joe Foo <joe@foo.com>
746
 
branch nick: test
747
 
timestamp: Tue 2005-11-22 00:00:00 +0000
748
 
message:
749
 
  simple log message
750
 
""",
751
 
        b, log.LongLogFormatter,
752
 
        formatter_kwargs=dict(levels=1))
753
 
 
754
 
    def test_long_author_in_log(self):
755
 
        """Log includes the author name if it's set in
756
 
        the revision properties
757
 
        """
758
 
        wt = self.make_standard_commit('test_author_log')
759
 
        self.assertFormatterResult("""\
760
 
------------------------------------------------------------
761
 
revno: 1
762
 
author: John Doe <jdoe@example.com>
763
 
committer: Lorem Ipsum <test@example.com>
764
 
branch nick: test_author_log
765
 
timestamp: Tue 2005-11-22 00:00:00 +0000
766
 
message:
767
 
  add a
768
 
""",
769
 
            wt.branch, log.LongLogFormatter,
770
 
            formatter_kwargs=dict(levels=1))
771
 
 
772
 
    def test_long_properties_in_log(self):
773
 
        """Log includes the custom properties returned by the registered
774
 
        handlers.
775
 
        """
776
 
        wt = self.make_standard_commit('test_properties_in_log')
777
 
        def trivial_custom_prop_handler(revision):
778
 
            return {'test_prop':'test_value'}
779
 
 
780
 
        log.properties_handler_registry.register(
781
 
            'trivial_custom_prop_handler',
782
 
            trivial_custom_prop_handler)
783
 
        self.assertFormatterResult("""\
784
 
------------------------------------------------------------
785
 
revno: 1
786
 
test_prop: test_value
787
 
author: John Doe <jdoe@example.com>
788
 
committer: Lorem Ipsum <test@example.com>
789
 
branch nick: test_properties_in_log
790
 
timestamp: Tue 2005-11-22 00:00:00 +0000
791
 
message:
792
 
  add a
793
 
""",
794
 
            wt.branch, log.LongLogFormatter,
795
 
            formatter_kwargs=dict(levels=1))
796
 
 
797
 
 
798
 
class TestLineLogFormatter(TestCaseForLogFormatter):
 
254
timestamp: Wed 2005-11-23 12:08:27 +1000
 
255
message:
 
256
  add a
 
257
added:
 
258
  a
 
259
''')
799
260
 
800
261
    def test_line_log(self):
801
262
        """Line log should show revno
802
 
 
 
263
        
803
264
        bug #5162
804
265
        """
805
 
        wt = self.make_standard_commit('test-line-log',
806
 
                committer='Line-Log-Formatter Tester <test@line.log>',
807
 
                authors=[])
808
 
        self.assertFormatterResult("""\
809
 
1: Line-Log-Formatte... 2005-11-22 add a
810
 
""",
811
 
            wt.branch, log.LineLogFormatter)
812
 
 
813
 
    def test_trailing_newlines(self):
814
266
        wt = self.make_branch_and_tree('.')
815
 
        b = self.make_commits_with_trailing_newlines(wt)
816
 
        self.assertFormatterResult("""\
817
 
3: Joe Foo 2005-11-22 single line with trailing newline
818
 
2: Joe Foo 2005-11-22 multiline
819
 
1: Joe Foo 2005-11-22 simple log message
820
 
""",
821
 
            b, log.LineLogFormatter)
822
 
 
823
 
    def test_line_log_single_merge_revision(self):
824
 
        wt = self._prepare_tree_with_merges()
825
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
826
 
        rev = revspec.in_history(wt.branch)
827
 
        self.assertFormatterResult("""\
828
 
1.1.1: Joe Foo 2005-11-22 rev-merged
829
 
""",
830
 
            wt.branch, log.LineLogFormatter,
831
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
832
 
 
833
 
    def test_line_log_with_tags(self):
834
 
        wt = self._prepare_tree_with_merges(with_tags=True)
835
 
        self.assertFormatterResult("""\
836
 
3: Joe Foo 2005-11-22 {v1.0, v1.0rc1} rev-3
837
 
2: Joe Foo 2005-11-22 [merge] {v0.2} rev-2
838
 
1: Joe Foo 2005-11-22 rev-1
839
 
""",
840
 
            wt.branch, log.LineLogFormatter)
841
 
 
842
 
 
843
 
class TestLineLogFormatterWithMergeRevisions(TestCaseForLogFormatter):
844
 
 
845
 
    def test_line_merge_revs_log(self):
846
 
        """Line log should show revno
847
 
 
848
 
        bug #5162
849
 
        """
850
 
        wt = self.make_standard_commit('test-line-log',
851
 
                committer='Line-Log-Formatter Tester <test@line.log>',
852
 
                authors=[])
853
 
        self.assertFormatterResult("""\
854
 
1: Line-Log-Formatte... 2005-11-22 add a
855
 
""",
856
 
            wt.branch, log.LineLogFormatter)
857
 
 
858
 
    def test_line_merge_revs_log_single_merge_revision(self):
859
 
        wt = self._prepare_tree_with_merges()
860
 
        revspec = revisionspec.RevisionSpec.from_string('1.1.1')
861
 
        rev = revspec.in_history(wt.branch)
862
 
        self.assertFormatterResult("""\
863
 
1.1.1: Joe Foo 2005-11-22 rev-merged
864
 
""",
865
 
            wt.branch, log.LineLogFormatter,
866
 
            formatter_kwargs=dict(levels=0),
867
 
            show_log_kwargs=dict(start_revision=rev, end_revision=rev))
868
 
 
869
 
    def test_line_merge_revs_log_with_merges(self):
870
 
        wt = self._prepare_tree_with_merges()
871
 
        self.assertFormatterResult("""\
872
 
2: Joe Foo 2005-11-22 [merge] rev-2
873
 
  1.1.1: Joe Foo 2005-11-22 rev-merged
874
 
1: Joe Foo 2005-11-22 rev-1
875
 
""",
876
 
            wt.branch, log.LineLogFormatter,
877
 
            formatter_kwargs=dict(levels=0))
878
 
 
879
 
 
880
 
class TestGetViewRevisions(tests.TestCaseWithTransport, TestLogMixin):
881
 
 
882
 
    def _get_view_revisions(self, *args, **kwargs):
883
 
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
884
 
                                    log.get_view_revisions, *args, **kwargs)
 
267
        b = wt.branch
 
268
        self.build_tree(['a'])
 
269
        wt.add('a')
 
270
        b.nick = 'test-line-log'
 
271
        wt.commit(message='add a', 
 
272
                  timestamp=1132711707, 
 
273
                  timezone=36000,
 
274
                  committer='Line-Log-Formatter Tester <test@line.log>')
 
275
        logfile = file('out.tmp', 'w+')
 
276
        formatter = LineLogFormatter(to_file=logfile)
 
277
        show_log(b, formatter)
 
278
        logfile.flush()
 
279
        logfile.seek(0)
 
280
        log_contents = logfile.read()
 
281
        self.assertEqualDiff(log_contents, '1: Line-Log-Formatte... 2005-11-23 add a\n')
 
282
 
 
283
    def test_short_log_with_merges(self):
 
284
        wt = self.make_branch_and_memory_tree('.')
 
285
        wt.lock_write()
 
286
        try:
 
287
            wt.add('')
 
288
            wt.commit('rev-1', rev_id='rev-1',
 
289
                      timestamp=1132586655, timezone=36000,
 
290
                      committer='Joe Foo <joe@foo.com>')
 
291
            wt.commit('rev-merged', rev_id='rev-2a',
 
292
                      timestamp=1132586700, timezone=36000,
 
293
                      committer='Joe Foo <joe@foo.com>')
 
294
            wt.set_parent_ids(['rev-1', 'rev-2a'])
 
295
            wt.branch.set_last_revision_info(1, 'rev-1')
 
296
            wt.commit('rev-2', rev_id='rev-2b',
 
297
                      timestamp=1132586800, timezone=36000,
 
298
                      committer='Joe Foo <joe@foo.com>')
 
299
            logfile = StringIO()
 
300
            formatter = ShortLogFormatter(to_file=logfile)
 
301
            show_log(wt.branch, formatter)
 
302
            logfile.flush()
 
303
            self.assertEqualDiff("""\
 
304
    2 Joe Foo\t2005-11-22 [merge]
 
305
      rev-2
 
306
 
 
307
    1 Joe Foo\t2005-11-22
 
308
      rev-1
 
309
 
 
310
""", logfile.getvalue())
 
311
        finally:
 
312
            wt.unlock()
885
313
 
886
314
    def make_tree_with_commits(self):
887
315
        """Create a tree with well-known revision ids"""
888
316
        wt = self.make_branch_and_tree('tree1')
889
 
        self.wt_commit(wt, 'commit one', rev_id='1')
890
 
        self.wt_commit(wt, 'commit two', rev_id='2')
891
 
        self.wt_commit(wt, 'commit three', rev_id='3')
 
317
        wt.commit('commit one', rev_id='1')
 
318
        wt.commit('commit two', rev_id='2')
 
319
        wt.commit('commit three', rev_id='3')
892
320
        mainline_revs = [None, '1', '2', '3']
893
321
        rev_nos = {'1': 1, '2': 2, '3': 3}
894
322
        return mainline_revs, rev_nos, wt
897
325
        """Create a tree with well-known revision ids and a merge"""
898
326
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
899
327
        tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
900
 
        self.wt_commit(tree2, 'four-a', rev_id='4a')
 
328
        tree2.commit('four-a', rev_id='4a')
901
329
        wt.merge_from_branch(tree2.branch)
902
 
        self.wt_commit(wt, 'four-b', rev_id='4b')
 
330
        wt.commit('four-b', rev_id='4b')
903
331
        mainline_revs.append('4b')
904
332
        rev_nos['4b'] = 4
905
333
        # 4a: 3.1.1
906
334
        return mainline_revs, rev_nos, wt
907
335
 
908
 
    def make_branch_with_many_merges(self):
 
336
    def make_tree_with_many_merges(self):
909
337
        """Create a tree with well-known revision ids"""
910
 
        builder = self.make_branch_builder('tree1')
911
 
        builder.start_series()
912
 
        builder.build_snapshot('1', None, [
913
 
            ('add', ('', 'TREE_ROOT', 'directory', '')),
914
 
            ('add', ('f', 'f-id', 'file', '1\n'))])
915
 
        builder.build_snapshot('2', ['1'], [])
916
 
        builder.build_snapshot('3a', ['2'], [
917
 
            ('modify', ('f-id', '1\n2\n3a\n'))])
918
 
        builder.build_snapshot('3b', ['2', '3a'], [
919
 
            ('modify', ('f-id', '1\n2\n3a\n'))])
920
 
        builder.build_snapshot('3c', ['2', '3b'], [
921
 
            ('modify', ('f-id', '1\n2\n3a\n'))])
922
 
        builder.build_snapshot('4a', ['3b'], [])
923
 
        builder.build_snapshot('4b', ['3c', '4a'], [])
924
 
        builder.finish_series()
925
 
 
926
 
        # 1
927
 
        # |
928
 
        # 2-.
929
 
        # |\ \
930
 
        # | | 3a
931
 
        # | |/
932
 
        # | 3b
933
 
        # |/|
934
 
        # 3c4a
935
 
        # |/
936
 
        # 4b
937
 
 
 
338
        wt = self.make_branch_and_tree('tree1')
 
339
        wt.commit('commit one', rev_id='1')
 
340
        wt.commit('commit two', rev_id='2')
 
341
        tree3 = wt.bzrdir.sprout('tree3').open_workingtree()
 
342
        tree3.commit('commit three a', rev_id='3a')
 
343
        tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
 
344
        tree2.merge_from_branch(tree3.branch)
 
345
        tree2.commit('commit three b', rev_id='3b')
 
346
        wt.merge_from_branch(tree2.branch)
 
347
        wt.commit('commit three c', rev_id='3c')
 
348
        tree2.commit('four-a', rev_id='4a')
 
349
        wt.merge_from_branch(tree2.branch)
 
350
        wt.commit('four-b', rev_id='4b')
938
351
        mainline_revs = [None, '1', '2', '3c', '4b']
939
352
        rev_nos = {'1':1, '2':2, '3c': 3, '4b':4}
940
353
        full_rev_nos_for_reference = {
941
354
            '1': '1',
942
355
            '2': '2',
943
 
            '3a': '2.1.1', #first commit tree 3
944
 
            '3b': '2.2.1', # first commit tree 2
 
356
            '3a': '2.2.1', #first commit tree 3
 
357
            '3b': '2.1.1', # first commit tree 2
945
358
            '3c': '3', #merges 3b to main
946
 
            '4a': '2.2.2', # second commit tree 2
 
359
            '4a': '2.1.2', # second commit tree 2
947
360
            '4b': '4', # merges 4a to main
948
361
            }
949
 
        return mainline_revs, rev_nos, builder.get_branch()
 
362
        return mainline_revs, rev_nos, wt
950
363
 
951
364
    def test_get_view_revisions_forward(self):
952
365
        """Test the get_view_revisions method"""
953
366
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
954
 
        wt.lock_read()
955
 
        self.addCleanup(wt.unlock)
956
 
        revisions = list(self._get_view_revisions(
957
 
                mainline_revs, rev_nos, wt.branch, 'forward'))
 
367
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
368
                                            'forward'))
958
369
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0)],
959
 
                         revisions)
960
 
        revisions2 = list(self._get_view_revisions(
961
 
                mainline_revs, rev_nos, wt.branch, 'forward',
962
 
                include_merges=False))
 
370
            revisions)
 
371
        revisions2 = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
372
                                             'forward', include_merges=False))
963
373
        self.assertEqual(revisions, revisions2)
964
374
 
965
375
    def test_get_view_revisions_reverse(self):
966
376
        """Test the get_view_revisions with reverse"""
967
377
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
968
 
        wt.lock_read()
969
 
        self.addCleanup(wt.unlock)
970
 
        revisions = list(self._get_view_revisions(
971
 
                mainline_revs, rev_nos, wt.branch, 'reverse'))
 
378
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
379
                                            'reverse'))
972
380
        self.assertEqual([('3', '3', 0), ('2', '2', 0), ('1', '1', 0), ],
973
 
                         revisions)
974
 
        revisions2 = list(self._get_view_revisions(
975
 
                mainline_revs, rev_nos, wt.branch, 'reverse',
976
 
                include_merges=False))
 
381
            revisions)
 
382
        revisions2 = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
383
                                             'reverse', include_merges=False))
977
384
        self.assertEqual(revisions, revisions2)
978
385
 
979
386
    def test_get_view_revisions_merge(self):
980
387
        """Test get_view_revisions when there are merges"""
981
388
        mainline_revs, rev_nos, wt = self.make_tree_with_merges()
982
 
        wt.lock_read()
983
 
        self.addCleanup(wt.unlock)
984
 
        revisions = list(self._get_view_revisions(
985
 
                mainline_revs, rev_nos, wt.branch, 'forward'))
986
 
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
987
 
                          ('4b', '4', 0), ('4a', '3.1.1', 1)],
988
 
                         revisions)
989
 
        revisions = list(self._get_view_revisions(
990
 
                mainline_revs, rev_nos, wt.branch, 'forward',
991
 
                include_merges=False))
992
 
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
993
 
                          ('4b', '4', 0)],
994
 
                         revisions)
 
389
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
390
                                            'forward'))
 
391
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
 
392
            ('4b', '4', 0), ('4a', '3.1.1', 1)],
 
393
            revisions)
 
394
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
395
                                             'forward', include_merges=False))
 
396
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
 
397
            ('4b', '4', 0)],
 
398
            revisions)
995
399
 
996
400
    def test_get_view_revisions_merge_reverse(self):
997
401
        """Test get_view_revisions in reverse when there are merges"""
998
402
        mainline_revs, rev_nos, wt = self.make_tree_with_merges()
999
 
        wt.lock_read()
1000
 
        self.addCleanup(wt.unlock)
1001
 
        revisions = list(self._get_view_revisions(
1002
 
                mainline_revs, rev_nos, wt.branch, 'reverse'))
 
403
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
404
                                            'reverse'))
1003
405
        self.assertEqual([('4b', '4', 0), ('4a', '3.1.1', 1),
1004
 
                          ('3', '3', 0), ('2', '2', 0), ('1', '1', 0)],
1005
 
                         revisions)
1006
 
        revisions = list(self._get_view_revisions(
1007
 
                mainline_revs, rev_nos, wt.branch, 'reverse',
1008
 
                include_merges=False))
 
406
            ('3', '3', 0), ('2', '2', 0), ('1', '1', 0)],
 
407
            revisions)
 
408
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
409
                                             'reverse', include_merges=False))
1009
410
        self.assertEqual([('4b', '4', 0), ('3', '3', 0), ('2', '2', 0),
1010
 
                          ('1', '1', 0)],
1011
 
                         revisions)
 
411
            ('1', '1', 0)],
 
412
            revisions)
1012
413
 
1013
414
    def test_get_view_revisions_merge2(self):
1014
415
        """Test get_view_revisions when there are merges"""
1015
 
        mainline_revs, rev_nos, b = self.make_branch_with_many_merges()
1016
 
        b.lock_read()
1017
 
        self.addCleanup(b.unlock)
1018
 
        revisions = list(self._get_view_revisions(
1019
 
                mainline_revs, rev_nos, b, 'forward'))
 
416
        mainline_revs, rev_nos, wt = self.make_tree_with_many_merges()
 
417
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
418
                                            'forward'))
1020
419
        expected = [('1', '1', 0), ('2', '2', 0), ('3c', '3', 0),
1021
 
                    ('3b', '2.2.1', 1), ('3a', '2.1.1', 2), ('4b', '4', 0),
1022
 
                    ('4a', '2.2.2', 1)]
 
420
            ('3a', '2.2.1', 1), ('3b', '2.1.1', 1), ('4b', '4', 0),
 
421
            ('4a', '2.1.2', 1)]
1023
422
        self.assertEqual(expected, revisions)
1024
 
        revisions = list(self._get_view_revisions(
1025
 
                mainline_revs, rev_nos, b, 'forward',
1026
 
                include_merges=False))
 
423
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
 
424
                                             'forward', include_merges=False))
1027
425
        self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3c', '3', 0),
1028
 
                          ('4b', '4', 0)],
1029
 
                         revisions)
1030
 
 
1031
 
    def test_file_id_for_range(self):
1032
 
        mainline_revs, rev_nos, b = self.make_branch_with_many_merges()
1033
 
        b.lock_read()
1034
 
        self.addCleanup(b.unlock)
1035
 
 
1036
 
        def rev_from_rev_id(revid, branch):
1037
 
            revspec = revisionspec.RevisionSpec.from_string('revid:%s' % revid)
1038
 
            return revspec.in_history(branch)
1039
 
 
1040
 
        def view_revs(start_rev, end_rev, file_id, direction):
1041
 
            revs = self.applyDeprecated(
1042
 
                symbol_versioning.deprecated_in((2, 2, 0)),
1043
 
                log.calculate_view_revisions,
1044
 
                b,
1045
 
                start_rev, # start_revision
1046
 
                end_rev, # end_revision
1047
 
                direction, # direction
1048
 
                file_id, # specific_fileid
1049
 
                True, # generate_merge_revisions
1050
 
                )
1051
 
            return revs
1052
 
 
1053
 
        rev_3a = rev_from_rev_id('3a', b)
1054
 
        rev_4b = rev_from_rev_id('4b', b)
1055
 
        self.assertEqual([('3c', '3', 0), ('3b', '2.2.1', 1),
1056
 
                          ('3a', '2.1.1', 2)],
1057
 
                          view_revs(rev_3a, rev_4b, 'f-id', 'reverse'))
1058
 
        # Note: 3c still appears before 3a here because of depth-based sorting
1059
 
        self.assertEqual([('3c', '3', 0), ('3b', '2.2.1', 1),
1060
 
                          ('3a', '2.1.1', 2)],
1061
 
                          view_revs(rev_3a, rev_4b, 'f-id', 'forward'))
1062
 
 
1063
 
 
1064
 
class TestGetRevisionsTouchingFileID(tests.TestCaseWithTransport):
1065
 
 
1066
 
    def get_view_revisions(self, *args):
1067
 
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1068
 
                                    log.get_view_revisions, *args)
 
426
            ('4b', '4', 0)],
 
427
            revisions)
 
428
 
 
429
 
 
430
class TestGetRevisionsTouchingFileID(TestCaseWithTransport):
1069
431
 
1070
432
    def create_tree_with_single_merge(self):
1071
433
        """Create a branch with a moderate layout.
1090
452
        #       use it. Since 'log' only uses the tree in a readonly
1091
453
        #       fashion, it seems a shame to regenerate an identical
1092
454
        #       tree for each test.
1093
 
        # TODO: vila 20100122 One way to address the shame above will be to
1094
 
        #       create a memory tree during test parametrization and give a
1095
 
        #       *copy* of this tree to each test. Copying a memory tree ought
1096
 
        #       to be cheap, at least cheaper than creating them with such
1097
 
        #       complex setups.
1098
455
        tree = self.make_branch_and_tree('tree')
1099
456
        tree.lock_write()
1100
457
        self.addCleanup(tree.unlock)
1126
483
        tree.commit('D', rev_id='D')
1127
484
 
1128
485
        # Switch to a read lock for this tree.
1129
 
        # We still have an addCleanup(tree.unlock) pending
 
486
        # We still have addCleanup(unlock)
1130
487
        tree.unlock()
1131
488
        tree.lock_read()
1132
489
        return tree
1133
490
 
1134
 
    def check_delta(self, delta, **kw):
1135
 
        """Check the filenames touched by a delta are as expected.
1136
 
 
1137
 
        Caller only have to pass in the list of files for each part, all
1138
 
        unspecified parts are considered empty (and checked as such).
1139
 
        """
1140
 
        for n in 'added', 'removed', 'renamed', 'modified', 'unchanged':
1141
 
            # By default we expect an empty list
1142
 
            expected = kw.get(n, [])
1143
 
            # strip out only the path components
1144
 
            got = [x[0] for x in getattr(delta, n)]
1145
 
            self.assertEqual(expected, got)
1146
 
 
1147
491
    def test_tree_with_single_merge(self):
1148
492
        """Make sure the tree layout is correct."""
1149
493
        tree = self.create_tree_with_single_merge()
1150
494
        rev_A_tree = tree.branch.repository.revision_tree('A')
1151
495
        rev_B_tree = tree.branch.repository.revision_tree('B')
 
496
 
 
497
        f1_changed = (u'f1', 'f1-id', 'file', True, False)
 
498
        f2_changed = (u'f2', 'f2-id', 'file', True, False)
 
499
        f3_changed = (u'f3', 'f3-id', 'file', True, False)
 
500
 
 
501
        delta = rev_B_tree.changes_from(rev_A_tree)
 
502
        self.assertEqual([f1_changed, f3_changed], delta.modified)
 
503
        self.assertEqual([], delta.renamed)
 
504
        self.assertEqual([], delta.added)
 
505
        self.assertEqual([], delta.removed)
 
506
 
1152
507
        rev_C_tree = tree.branch.repository.revision_tree('C')
 
508
        delta = rev_C_tree.changes_from(rev_A_tree)
 
509
        self.assertEqual([f2_changed, f3_changed], delta.modified)
 
510
        self.assertEqual([], delta.renamed)
 
511
        self.assertEqual([], delta.added)
 
512
        self.assertEqual([], delta.removed)
 
513
 
1153
514
        rev_D_tree = tree.branch.repository.revision_tree('D')
1154
 
 
1155
 
        self.check_delta(rev_B_tree.changes_from(rev_A_tree),
1156
 
                         modified=['f1', 'f3'])
1157
 
 
1158
 
        self.check_delta(rev_C_tree.changes_from(rev_A_tree),
1159
 
                         modified=['f2', 'f3'])
1160
 
 
1161
 
        self.check_delta(rev_D_tree.changes_from(rev_B_tree),
1162
 
                         modified=['f2', 'f3'])
1163
 
 
1164
 
        self.check_delta(rev_D_tree.changes_from(rev_C_tree),
1165
 
                         modified=['f1', 'f3'])
 
515
        delta = rev_D_tree.changes_from(rev_B_tree)
 
516
        self.assertEqual([f2_changed, f3_changed], delta.modified)
 
517
        self.assertEqual([], delta.renamed)
 
518
        self.assertEqual([], delta.added)
 
519
        self.assertEqual([], delta.removed)
 
520
 
 
521
        delta = rev_D_tree.changes_from(rev_C_tree)
 
522
        self.assertEqual([f1_changed, f3_changed], delta.modified)
 
523
        self.assertEqual([], delta.renamed)
 
524
        self.assertEqual([], delta.added)
 
525
        self.assertEqual([], delta.removed)
1166
526
 
1167
527
    def assertAllRevisionsForFileID(self, tree, file_id, revisions):
1168
 
        """Ensure _filter_revisions_touching_file_id returns the right values.
 
528
        """Make sure _get_revisions_touching_file_id returns the right values.
1169
529
 
1170
 
        Get the return value from _filter_revisions_touching_file_id and make
 
530
        Get the return value from _get_revisions_touching_file_id and make
1171
531
        sure they are correct.
1172
532
        """
1173
 
        # The api for _filter_revisions_touching_file_id is a little crazy.
 
533
        # The api for _get_revisions_touching_file_id is a little crazy,
1174
534
        # So we do the setup here.
1175
535
        mainline = tree.branch.revision_history()
1176
536
        mainline.insert(0, None)
1177
537
        revnos = dict((rev, idx+1) for idx, rev in enumerate(mainline))
1178
 
        view_revs_iter = self.get_view_revisions(
1179
 
            mainline, revnos, tree.branch, 'reverse', True)
1180
 
        actual_revs = log._filter_revisions_touching_file_id(
1181
 
            tree.branch, file_id, list(view_revs_iter))
 
538
        view_revs_iter = log.get_view_revisions(mainline, revnos, tree.branch,
 
539
                                                'reverse', True)
 
540
        actual_revs = log._get_revisions_touching_file_id(tree.branch, file_id,
 
541
                                                          mainline,
 
542
                                                          view_revs_iter)
1182
543
        self.assertEqual(revisions, [r for r, revno, depth in actual_revs])
1183
544
 
1184
545
    def test_file_id_f1(self):
1195
556
    def test_file_id_f3(self):
1196
557
        tree = self.create_tree_with_single_merge()
1197
558
        # f3 should be marked as modified by revisions A, B, C, and D
1198
 
        self.assertAllRevisionsForFileID(tree, 'f3-id', ['D', 'C', 'B', 'A'])
1199
 
 
1200
 
    def test_file_id_with_ghosts(self):
1201
 
        # This is testing bug #209948, where having a ghost would cause
1202
 
        # _filter_revisions_touching_file_id() to fail.
1203
 
        tree = self.create_tree_with_single_merge()
1204
 
        # We need to add a revision, so switch back to a write-locked tree
1205
 
        # (still a single addCleanup(tree.unlock) pending).
1206
 
        tree.unlock()
1207
 
        tree.lock_write()
1208
 
        first_parent = tree.last_revision()
1209
 
        tree.set_parent_ids([first_parent, 'ghost-revision-id'])
1210
 
        self.build_tree_contents([('tree/f1', 'A\nB\nXX\n')])
1211
 
        tree.commit('commit with a ghost', rev_id='XX')
1212
 
        self.assertAllRevisionsForFileID(tree, 'f1-id', ['XX', 'B', 'A'])
1213
559
        self.assertAllRevisionsForFileID(tree, 'f2-id', ['D', 'C', 'A'])
1214
 
 
1215
 
    def test_unknown_file_id(self):
1216
 
        tree = self.create_tree_with_single_merge()
1217
 
        self.assertAllRevisionsForFileID(tree, 'unknown', [])
1218
 
 
1219
 
    def test_empty_branch_unknown_file_id(self):
1220
 
        tree = self.make_branch_and_tree('tree')
1221
 
        self.assertAllRevisionsForFileID(tree, 'unknown', [])
1222
 
 
1223
 
 
1224
 
class TestShowChangedRevisions(tests.TestCaseWithTransport):
1225
 
 
1226
 
    def test_show_changed_revisions_verbose(self):
1227
 
        tree = self.make_branch_and_tree('tree_a')
1228
 
        self.build_tree(['tree_a/foo'])
1229
 
        tree.add('foo')
1230
 
        tree.commit('bar', rev_id='bar-id')
1231
 
        s = self.make_utf8_encoded_stringio()
1232
 
        log.show_changed_revisions(tree.branch, [], ['bar-id'], s)
1233
 
        self.assertContainsRe(s.getvalue(), 'bar')
1234
 
        self.assertNotContainsRe(s.getvalue(), 'foo')
1235
 
 
1236
 
 
1237
 
class TestLogFormatter(tests.TestCase):
1238
 
 
1239
 
    def setUp(self):
1240
 
        super(TestLogFormatter, self).setUp()
1241
 
        self.rev = revision.Revision('a-id')
1242
 
        self.lf = log.LogFormatter(None)
1243
 
 
1244
 
    def test_short_committer(self):
1245
 
        def assertCommitter(expected, committer):
1246
 
            self.rev.committer = committer
1247
 
            self.assertEqual(expected, self.lf.short_committer(self.rev))
1248
 
 
1249
 
        assertCommitter('John Doe', 'John Doe <jdoe@example.com>')
1250
 
        assertCommitter('John Smith', 'John Smith <jsmith@example.com>')
1251
 
        assertCommitter('John Smith', 'John Smith')
1252
 
        assertCommitter('jsmith@example.com', 'jsmith@example.com')
1253
 
        assertCommitter('jsmith@example.com', '<jsmith@example.com>')
1254
 
        assertCommitter('John Smith', 'John Smith jsmith@example.com')
1255
 
 
1256
 
    def test_short_author(self):
1257
 
        def assertAuthor(expected, author):
1258
 
            self.rev.properties['author'] = author
1259
 
            self.assertEqual(expected, self.lf.short_author(self.rev))
1260
 
 
1261
 
        assertAuthor('John Smith', 'John Smith <jsmith@example.com>')
1262
 
        assertAuthor('John Smith', 'John Smith')
1263
 
        assertAuthor('jsmith@example.com', 'jsmith@example.com')
1264
 
        assertAuthor('jsmith@example.com', '<jsmith@example.com>')
1265
 
        assertAuthor('John Smith', 'John Smith jsmith@example.com')
1266
 
 
1267
 
    def test_short_author_from_committer(self):
1268
 
        self.rev.committer = 'John Doe <jdoe@example.com>'
1269
 
        self.assertEqual('John Doe', self.lf.short_author(self.rev))
1270
 
 
1271
 
    def test_short_author_from_authors(self):
1272
 
        self.rev.properties['authors'] = ('John Smith <jsmith@example.com>\n'
1273
 
                                          'Jane Rey <jrey@example.com>')
1274
 
        self.assertEqual('John Smith', self.lf.short_author(self.rev))
1275
 
 
1276
 
 
1277
 
class TestReverseByDepth(tests.TestCase):
1278
 
    """Test reverse_by_depth behavior.
1279
 
 
1280
 
    This is used to present revisions in forward (oldest first) order in a nice
1281
 
    layout.
1282
 
 
1283
 
    The tests use lighter revision description to ease reading.
1284
 
    """
1285
 
 
1286
 
    def assertReversed(self, forward, backward):
1287
 
        # Transform the descriptions to suit the API: tests use (revno, depth),
1288
 
        # while the API expects (revid, revno, depth)
1289
 
        def complete_revisions(l):
1290
 
            """Transform the description to suit the API.
1291
 
 
1292
 
            Tests use (revno, depth) whil the API expects (revid, revno, depth).
1293
 
            Since the revid is arbitrary, we just duplicate revno
1294
 
            """
1295
 
            return [ (r, r, d) for r, d in l]
1296
 
        forward = complete_revisions(forward)
1297
 
        backward= complete_revisions(backward)
1298
 
        self.assertEqual(forward, log.reverse_by_depth(backward))
1299
 
 
1300
 
 
1301
 
    def test_mainline_revisions(self):
1302
 
        self.assertReversed([( '1', 0), ('2', 0)],
1303
 
                            [('2', 0), ('1', 0)])
1304
 
 
1305
 
    def test_merged_revisions(self):
1306
 
        self.assertReversed([('1', 0), ('2', 0), ('2.2', 1), ('2.1', 1),],
1307
 
                            [('2', 0), ('2.1', 1), ('2.2', 1), ('1', 0),])
1308
 
    def test_shifted_merged_revisions(self):
1309
 
        """Test irregular layout.
1310
 
 
1311
 
        Requesting revisions touching a file can produce "holes" in the depths.
1312
 
        """
1313
 
        self.assertReversed([('1', 0), ('2', 0), ('1.1', 2), ('1.2', 2),],
1314
 
                            [('2', 0), ('1.2', 2), ('1.1', 2), ('1', 0),])
1315
 
 
1316
 
    def test_merged_without_child_revisions(self):
1317
 
        """Test irregular layout.
1318
 
 
1319
 
        Revision ranges can produce "holes" in the depths.
1320
 
        """
1321
 
        # When a revision of higher depth doesn't follow one of lower depth, we
1322
 
        # assume a lower depth one is virtually there
1323
 
        self.assertReversed([('1', 2), ('2', 2), ('3', 3), ('4', 4)],
1324
 
                            [('4', 4), ('3', 3), ('2', 2), ('1', 2),])
1325
 
        # So we get the same order after reversing below even if the original
1326
 
        # revisions are not in the same order.
1327
 
        self.assertReversed([('1', 2), ('2', 2), ('3', 3), ('4', 4)],
1328
 
                            [('3', 3), ('4', 4), ('2', 2), ('1', 2),])
1329
 
 
1330
 
 
1331
 
class TestHistoryChange(tests.TestCaseWithTransport):
1332
 
 
1333
 
    def setup_a_tree(self):
1334
 
        tree = self.make_branch_and_tree('tree')
1335
 
        tree.lock_write()
1336
 
        self.addCleanup(tree.unlock)
1337
 
        tree.commit('1a', rev_id='1a')
1338
 
        tree.commit('2a', rev_id='2a')
1339
 
        tree.commit('3a', rev_id='3a')
1340
 
        return tree
1341
 
 
1342
 
    def setup_ab_tree(self):
1343
 
        tree = self.setup_a_tree()
1344
 
        tree.set_last_revision('1a')
1345
 
        tree.branch.set_last_revision_info(1, '1a')
1346
 
        tree.commit('2b', rev_id='2b')
1347
 
        tree.commit('3b', rev_id='3b')
1348
 
        return tree
1349
 
 
1350
 
    def setup_ac_tree(self):
1351
 
        tree = self.setup_a_tree()
1352
 
        tree.set_last_revision(revision.NULL_REVISION)
1353
 
        tree.branch.set_last_revision_info(0, revision.NULL_REVISION)
1354
 
        tree.commit('1c', rev_id='1c')
1355
 
        tree.commit('2c', rev_id='2c')
1356
 
        tree.commit('3c', rev_id='3c')
1357
 
        return tree
1358
 
 
1359
 
    def test_all_new(self):
1360
 
        tree = self.setup_ab_tree()
1361
 
        old, new = log.get_history_change('1a', '3a', tree.branch.repository)
1362
 
        self.assertEqual([], old)
1363
 
        self.assertEqual(['2a', '3a'], new)
1364
 
 
1365
 
    def test_all_old(self):
1366
 
        tree = self.setup_ab_tree()
1367
 
        old, new = log.get_history_change('3a', '1a', tree.branch.repository)
1368
 
        self.assertEqual([], new)
1369
 
        self.assertEqual(['2a', '3a'], old)
1370
 
 
1371
 
    def test_null_old(self):
1372
 
        tree = self.setup_ab_tree()
1373
 
        old, new = log.get_history_change(revision.NULL_REVISION,
1374
 
                                          '3a', tree.branch.repository)
1375
 
        self.assertEqual([], old)
1376
 
        self.assertEqual(['1a', '2a', '3a'], new)
1377
 
 
1378
 
    def test_null_new(self):
1379
 
        tree = self.setup_ab_tree()
1380
 
        old, new = log.get_history_change('3a', revision.NULL_REVISION,
1381
 
                                          tree.branch.repository)
1382
 
        self.assertEqual([], new)
1383
 
        self.assertEqual(['1a', '2a', '3a'], old)
1384
 
 
1385
 
    def test_diverged(self):
1386
 
        tree = self.setup_ab_tree()
1387
 
        old, new = log.get_history_change('3a', '3b', tree.branch.repository)
1388
 
        self.assertEqual(old, ['2a', '3a'])
1389
 
        self.assertEqual(new, ['2b', '3b'])
1390
 
 
1391
 
    def test_unrelated(self):
1392
 
        tree = self.setup_ac_tree()
1393
 
        old, new = log.get_history_change('3a', '3c', tree.branch.repository)
1394
 
        self.assertEqual(old, ['1a', '2a', '3a'])
1395
 
        self.assertEqual(new, ['1c', '2c', '3c'])
1396
 
 
1397
 
    def test_show_branch_change(self):
1398
 
        tree = self.setup_ab_tree()
1399
 
        s = StringIO()
1400
 
        log.show_branch_change(tree.branch, s, 3, '3a')
1401
 
        self.assertContainsRe(s.getvalue(),
1402
 
            '[*]{60}\nRemoved Revisions:\n(.|\n)*2a(.|\n)*3a(.|\n)*'
1403
 
            '[*]{60}\n\nAdded Revisions:\n(.|\n)*2b(.|\n)*3b')
1404
 
 
1405
 
    def test_show_branch_change_no_change(self):
1406
 
        tree = self.setup_ab_tree()
1407
 
        s = StringIO()
1408
 
        log.show_branch_change(tree.branch, s, 3, '3b')
1409
 
        self.assertEqual(s.getvalue(),
1410
 
            'Nothing seems to have changed\n')
1411
 
 
1412
 
    def test_show_branch_change_no_old(self):
1413
 
        tree = self.setup_ab_tree()
1414
 
        s = StringIO()
1415
 
        log.show_branch_change(tree.branch, s, 2, '2b')
1416
 
        self.assertContainsRe(s.getvalue(), 'Added Revisions:')
1417
 
        self.assertNotContainsRe(s.getvalue(), 'Removed Revisions:')
1418
 
 
1419
 
    def test_show_branch_change_no_new(self):
1420
 
        tree = self.setup_ab_tree()
1421
 
        tree.branch.set_last_revision_info(2, '2b')
1422
 
        s = StringIO()
1423
 
        log.show_branch_change(tree.branch, s, 3, '3b')
1424
 
        self.assertContainsRe(s.getvalue(), 'Removed Revisions:')
1425
 
        self.assertNotContainsRe(s.getvalue(), 'Added Revisions:')
1426
 
 
1427
 
 
1428
 
 
1429
 
class TestLogWithBugs(TestCaseForLogFormatter, TestLogMixin):
1430
 
 
1431
 
    def setUp(self):
1432
 
        TestCaseForLogFormatter.setUp(self)
1433
 
        log.properties_handler_registry.register(
1434
 
            'bugs_properties_handler',
1435
 
            log._bugs_properties_handler)
1436
 
 
1437
 
    def make_commits_with_bugs(self):
1438
 
        """Helper method for LogFormatter tests"""
1439
 
        tree = self.make_branch_and_tree(u'.')
1440
 
        self.build_tree(['a', 'b'])
1441
 
        tree.add('a')
1442
 
        self.wt_commit(tree, 'simple log message', rev_id='a1',
1443
 
                       revprops={'bugs': 'test://bug/id fixed'})
1444
 
        tree.add('b')
1445
 
        self.wt_commit(tree, 'multiline\nlog\nmessage\n', rev_id='a2',
1446
 
                       authors=['Joe Bar <joe@bar.com>'],
1447
 
                       revprops={'bugs': 'test://bug/id fixed\n'
1448
 
                                 'test://bug/2 fixed'})
1449
 
        return tree
1450
 
 
1451
 
 
1452
 
    def test_long_bugs(self):
1453
 
        tree = self.make_commits_with_bugs()
1454
 
        self.assertFormatterResult("""\
1455
 
------------------------------------------------------------
1456
 
revno: 2
1457
 
fixes bug(s): test://bug/id test://bug/2
1458
 
author: Joe Bar <joe@bar.com>
1459
 
committer: Joe Foo <joe@foo.com>
1460
 
branch nick: work
1461
 
timestamp: Tue 2005-11-22 00:00:01 +0000
1462
 
message:
1463
 
  multiline
1464
 
  log
1465
 
  message
1466
 
------------------------------------------------------------
1467
 
revno: 1
1468
 
fixes bug(s): test://bug/id
1469
 
committer: Joe Foo <joe@foo.com>
1470
 
branch nick: work
1471
 
timestamp: Tue 2005-11-22 00:00:00 +0000
1472
 
message:
1473
 
  simple log message
1474
 
""",
1475
 
            tree.branch, log.LongLogFormatter)
1476
 
 
1477
 
    def test_short_bugs(self):
1478
 
        tree = self.make_commits_with_bugs()
1479
 
        self.assertFormatterResult("""\
1480
 
    2 Joe Bar\t2005-11-22
1481
 
      fixes bug(s): test://bug/id test://bug/2
1482
 
      multiline
1483
 
      log
1484
 
      message
1485
 
 
1486
 
    1 Joe Foo\t2005-11-22
1487
 
      fixes bug(s): test://bug/id
1488
 
      simple log message
1489
 
 
1490
 
""",
1491
 
            tree.branch, log.ShortLogFormatter)
1492
 
 
1493
 
    def test_wrong_bugs_property(self):
1494
 
        tree = self.make_branch_and_tree(u'.')
1495
 
        self.build_tree(['foo'])
1496
 
        self.wt_commit(tree, 'simple log message', rev_id='a1',
1497
 
                       revprops={'bugs': 'test://bug/id invalid_value'})
1498
 
        self.assertFormatterResult("""\
1499
 
    1 Joe Foo\t2005-11-22
1500
 
      simple log message
1501
 
 
1502
 
""",
1503
 
            tree.branch, log.ShortLogFormatter)
1504
 
 
1505
 
    def test_bugs_handler_present(self):
1506
 
        self.properties_handler_registry.get('bugs_properties_handler')