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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
from cStringIO import StringIO
20
from bzrlib import log
21
from bzrlib.tests import TestCase, TestCaseWithTransport
22
from bzrlib.log import (show_log,
29
from bzrlib.branch import Branch
30
from bzrlib.errors import (
32
InvalidRevisionNumber,
34
from bzrlib.revision import Revision
35
from bzrlib.revisionspec import (
41
class LogCatcher(LogFormatter):
42
"""Pull log messages into list rather than displaying them.
44
For ease of testing we save log messages here rather than actually
45
formatting them, so that we can precisely check the result without
46
being too dependent on the exact formatting.
48
We should also test the LogFormatter.
31
class TestLogMixin(object):
33
def wt_commit(self, wt, message, **kwargs):
34
"""Use some mostly fixed values for commits to simplify tests.
36
Tests can use this function to get some commit attributes. The time
37
stamp is incremented at each commit.
39
if getattr(self, 'timestamp', None) is None:
40
self.timestamp = 1132617600 # Mon 2005-11-22 00:00:00 +0000
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>')
47
return wt.commit(message, **kwargs)
50
class TestCaseForLogFormatter(tests.TestCaseWithTransport, TestLogMixin):
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()
60
log.properties_handler_registry = self.properties_handler_registry
61
self.addCleanup(restore)
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:
68
formatter = formatter_class(to_file=logfile, **formatter_kwargs)
69
if show_log_kwargs is None:
71
log.show_log(branch, formatter, **show_log_kwargs)
72
self.assertEqualDiff(result, logfile.getvalue())
74
def make_standard_commit(self, branch_nick, **kwargs):
75
wt = self.make_branch_and_tree('.')
77
self.addCleanup(wt.unlock)
78
self.build_tree(['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)
86
def make_commits_with_trailing_newlines(self, wt):
87
"""Helper method for LogFormatter tests"""
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')])
94
self.wt_commit(wt, 'multiline\nlog\nmessage\n', rev_id='a2')
96
self.build_tree_contents([('c', 'just another manic monday\n')])
98
self.wt_commit(wt, 'single line with trailing newline\n', rev_id='a3')
101
def _prepare_tree_with_merges(self, with_tags=False):
102
wt = self.make_branch_and_memory_tree('.')
104
self.addCleanup(wt.unlock)
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')
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')
119
class LogCatcher(log.LogFormatter):
120
"""Pull log messages into a list rather than displaying them.
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.
127
supports_merge_revisions = True
51
128
supports_delta = True
54
super(LogCatcher, self).__init__(to_file=None)
132
def __init__(self, *args, **kwargs):
133
kwargs.update(dict(to_file=None))
134
super(LogCatcher, self).__init__(*args, **kwargs)
57
137
def log_revision(self, revision):
58
self.logs.append(revision)
61
class TestShowLog(TestCaseWithTransport):
138
self.revisions.append(revision)
141
class TestShowLog(tests.TestCaseWithTransport):
63
143
def checkDelta(self, delta, **kw):
64
"""Check the filenames touched by a delta are as expected."""
144
"""Check the filenames touched by a delta are as expected.
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).
65
149
for n in 'added', 'removed', 'renamed', 'modified', 'unchanged':
150
# By default we expect an empty list
66
151
expected = kw.get(n, [])
67
152
# strip out only the path components
68
153
got = [x[0] for x in getattr(delta, n)]
69
self.assertEquals(expected, got)
154
self.assertEqual(expected, got)
156
def assertInvalidRevisonNumber(self, br, start, end):
158
self.assertRaises(errors.InvalidRevisionNumber,
159
log.show_log, br, lf,
160
start_revision=start, end_revision=end)
71
162
def test_cur_revno(self):
72
163
wt = self.make_branch_and_tree('.')
76
167
wt.commit('empty commit')
77
show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
78
self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
79
start_revision=2, end_revision=1)
80
self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
81
start_revision=1, end_revision=2)
82
self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
83
start_revision=0, end_revision=2)
84
self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
85
start_revision=1, end_revision=0)
86
self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
87
start_revision=-1, end_revision=1)
88
self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
89
start_revision=1, end_revision=-1)
91
def test_simple_log(self):
92
eq = self.assertEquals
168
log.show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
170
# Since there is a single revision in the branch all the combinations
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)
179
def test_empty_branch(self):
94
180
wt = self.make_branch_and_tree('.')
183
log.show_log(wt.branch, lf)
185
self.assertEqual([], lf.revisions)
187
def test_empty_commit(self):
188
wt = self.make_branch_and_tree('.')
102
190
wt.commit('empty commit')
103
191
lf = LogCatcher()
104
show_log(b, lf, verbose=True)
106
eq(lf.logs[0].revno, '1')
107
eq(lf.logs[0].rev.message, 'empty commit')
109
self.log('log delta: %r' % d)
192
log.show_log(wt.branch, lf, verbose=True)
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)
199
def test_simple_commit(self):
200
wt = self.make_branch_and_tree('.')
201
wt.commit('empty commit')
112
202
self.build_tree(['hello'])
114
204
wt.commit('add one file',
115
205
committer=u'\u013d\xf3r\xe9m \xcdp\u0161\xfam '
116
206
u'<test@example.com>')
118
lf = self.make_utf8_encoded_stringio()
119
# log using regular thing
120
show_log(b, LongLogFormatter(lf))
122
for l in lf.readlines():
125
# get log as data structure
126
207
lf = LogCatcher()
127
show_log(b, lf, verbose=True)
129
self.log('log entries:')
130
for logentry in lf.logs:
131
self.log('%4s %s' % (logentry.revno, logentry.rev.message))
208
log.show_log(wt.branch, lf, verbose=True)
209
self.assertEqual(2, len(lf.revisions))
133
210
# first one is most recent
134
logentry = lf.logs[0]
135
eq(logentry.revno, '2')
136
eq(logentry.rev.message, 'add one file')
138
self.log('log 2 delta: %r' % d)
139
self.checkDelta(d, added=['hello'])
141
# commit a log message with control characters
142
msg = "All 8-bit chars: " + ''.join([unichr(x) for x in range(256)])
143
self.log("original commit message: %r", msg)
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'])
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')
145
221
lf = LogCatcher()
146
show_log(b, lf, verbose=True)
147
committed_msg = lf.logs[0].rev.message
148
self.log("escaped commit message: %r", committed_msg)
149
self.assert_(msg != committed_msg)
150
self.assert_(len(committed_msg) > len(msg))
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))
228
self.assertEqual(msg, committed_msg)
152
# Check that log message with only XML-valid characters isn't
230
def test_commit_message_without_control_chars(self):
231
wt = self.make_branch_and_tree('.')
153
232
# escaped. As ElementTree apparently does some kind of
154
233
# newline conversion, neither LF (\x0A) nor CR (\x0D) are
155
234
# included in the test commit message, even though they are
156
235
# valid XML 1.0 characters.
157
236
msg = "\x09" + ''.join([unichr(x) for x in range(0x20, 256)])
158
self.log("original commit message: %r", msg)
160
238
lf = LogCatcher()
161
show_log(b, lf, verbose=True)
162
committed_msg = lf.logs[0].rev.message
163
self.log("escaped commit message: %r", committed_msg)
164
self.assert_(msg == committed_msg)
239
log.show_log(wt.branch, lf, verbose=True)
240
committed_msg = lf.revisions[0].rev.message
241
self.assertEqual(msg, committed_msg)
166
243
def test_deltas_in_merge_revisions(self):
167
244
"""Check deltas created for both mainline and merge revisions"""
168
eq = self.assertEquals
169
245
wt = self.make_branch_and_tree('parent')
170
246
self.build_tree(['parent/file1', 'parent/file2', 'parent/file3'])
184
260
lf = LogCatcher()
185
261
lf.supports_merge_revisions = True
186
show_log(b, lf, verbose=True)
188
logentry = lf.logs[0]
189
eq(logentry.revno, '2')
190
eq(logentry.rev.message, 'merge child branch')
192
self.checkDelta(d, removed=['file1'], modified=['file2'])
193
logentry = lf.logs[1]
194
eq(logentry.revno, '1.1.1')
195
eq(logentry.rev.message, 'remove file1 and modify file2')
197
self.checkDelta(d, removed=['file1'], modified=['file2'])
198
logentry = lf.logs[2]
199
eq(logentry.revno, '1')
200
eq(logentry.rev.message, 'add file1 and file2')
202
self.checkDelta(d, added=['file1', 'file2'])
204
def test_merges_nonsupporting_formatter(self):
205
"""Tests that show_log will raise if the formatter doesn't
206
support merge revisions."""
207
wt = self.make_branch_and_memory_tree('.')
211
wt.commit('rev-1', rev_id='rev-1',
212
timestamp=1132586655, timezone=36000,
213
committer='Joe Foo <joe@foo.com>')
214
wt.commit('rev-merged', rev_id='rev-2a',
215
timestamp=1132586700, timezone=36000,
216
committer='Joe Foo <joe@foo.com>')
217
wt.set_parent_ids(['rev-1', 'rev-2a'])
218
wt.branch.set_last_revision_info(1, 'rev-1')
219
wt.commit('rev-2', rev_id='rev-2b',
220
timestamp=1132586800, timezone=36000,
221
committer='Joe Foo <joe@foo.com>')
222
logfile = self.make_utf8_encoded_stringio()
223
formatter = ShortLogFormatter(to_file=logfile)
226
revspec = RevisionSpec.from_string('1.1.1')
227
rev = revspec.in_history(wtb)
228
self.assertRaises(BzrCommandError, show_log, wtb, lf,
229
start_revision=rev, end_revision=rev)
234
def make_commits_with_trailing_newlines(wt):
235
"""Helper method for LogFormatter tests"""
238
open('a', 'wb').write('hello moto\n')
240
wt.commit('simple log message', rev_id='a1',
241
timestamp=1132586655.459960938, timezone=-6*3600,
242
committer='Joe Foo <joe@foo.com>')
243
open('b', 'wb').write('goodbye\n')
245
wt.commit('multiline\nlog\nmessage\n', rev_id='a2',
246
timestamp=1132586842.411175966, timezone=-6*3600,
247
committer='Joe Foo <joe@foo.com>',
248
author='Joe Bar <joe@bar.com>')
250
open('c', 'wb').write('just another manic monday\n')
252
wt.commit('single line with trailing newline\n', rev_id='a3',
253
timestamp=1132587176.835228920, timezone=-6*3600,
254
committer = 'Joe Foo <joe@foo.com>')
258
def normalize_log(log):
259
"""Replaces the variable lines of logs with fixed lines"""
260
author = 'author: Dolor Sit <test@example.com>'
261
committer = 'committer: Lorem Ipsum <test@example.com>'
262
lines = log.splitlines(True)
263
for idx,line in enumerate(lines):
264
stripped_line = line.lstrip()
265
indent = ' ' * (len(line) - len(stripped_line))
266
if stripped_line.startswith('author:'):
267
lines[idx] = indent + author + '\n'
268
elif stripped_line.startswith('committer:'):
269
lines[idx] = indent + committer + '\n'
270
elif stripped_line.startswith('timestamp:'):
271
lines[idx] = indent + 'timestamp: Just now\n'
272
return ''.join(lines)
275
class TestShortLogFormatter(TestCaseWithTransport):
262
log.show_log(b, lf, verbose=True)
265
self.assertEqual(3, len(revs))
268
self.assertEqual('2', logentry.revno)
269
self.assertEqual('merge child branch', logentry.rev.message)
270
self.checkDelta(logentry.delta, removed=['file1'], modified=['file2'])
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'])
278
self.assertEqual('1', logentry.revno)
279
self.assertEqual('add file1 and file2', logentry.rev.message)
280
self.checkDelta(logentry.delta, added=['file1', 'file2'])
283
class TestShortLogFormatter(TestCaseForLogFormatter):
277
285
def test_trailing_newlines(self):
278
286
wt = self.make_branch_and_tree('.')
279
b = make_commits_with_trailing_newlines(wt)
280
sio = self.make_utf8_encoded_stringio()
281
lf = ShortLogFormatter(to_file=sio)
283
self.assertEqualDiff(sio.getvalue(), """\
284
3 Joe Foo\t2005-11-21
287
b = self.make_commits_with_trailing_newlines(wt)
288
self.assertFormatterResult("""\
289
3 Joe Foo\t2005-11-22
285
290
single line with trailing newline
287
2 Joe Bar\t2005-11-21
292
2 Joe Foo\t2005-11-22
292
1 Joe Foo\t2005-11-21
297
1 Joe Foo\t2005-11-22
293
298
simple log message
301
b, log.ShortLogFormatter)
297
303
def test_short_log_with_merges(self):
298
wt = self.make_branch_and_memory_tree('.')
302
wt.commit('rev-1', rev_id='rev-1',
303
timestamp=1132586655, timezone=36000,
304
committer='Joe Foo <joe@foo.com>')
305
wt.commit('rev-merged', rev_id='rev-2a',
306
timestamp=1132586700, timezone=36000,
307
committer='Joe Foo <joe@foo.com>')
308
wt.set_parent_ids(['rev-1', 'rev-2a'])
309
wt.branch.set_last_revision_info(1, 'rev-1')
310
wt.commit('rev-2', rev_id='rev-2b',
311
timestamp=1132586800, timezone=36000,
312
committer='Joe Foo <joe@foo.com>')
313
logfile = self.make_utf8_encoded_stringio()
314
formatter = ShortLogFormatter(to_file=logfile)
315
show_log(wt.branch, formatter)
316
self.assertEqualDiff(logfile.getvalue(), """\
317
2 Joe Foo\t2005-11-22 [merge]
320
1 Joe Foo\t2005-11-22
304
wt = self._prepare_tree_with_merges()
305
self.assertFormatterResult("""\
306
2 Joe Foo\t2005-11-22 [merge]
309
1 Joe Foo\t2005-11-22
313
wt.branch, log.ShortLogFormatter)
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]
321
1 Joe Foo\t2005-11-22
324
Use --include-merges or -n0 to see merged revisions.
326
wt.branch, log.ShortLogFormatter,
327
formatter_kwargs=dict(show_advice=True))
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]
339
2 Joe Foo\t2005-11-22 [merge]
343
wt.branch, log.ShortLogFormatter,
344
show_log_kwargs=dict(start_revision=2, end_revision=3))
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}
352
2 Joe Foo\t2005-11-22 {v0.2} [merge]
355
1 Joe Foo\t2005-11-22
359
wt.branch, log.ShortLogFormatter)
327
361
def test_short_log_single_merge_revision(self):
328
wt = self.make_branch_and_memory_tree('.')
332
wt.commit('rev-1', rev_id='rev-1',
333
timestamp=1132586655, timezone=36000,
334
committer='Joe Foo <joe@foo.com>')
335
wt.commit('rev-merged', rev_id='rev-2a',
336
timestamp=1132586700, timezone=36000,
337
committer='Joe Foo <joe@foo.com>')
338
wt.set_parent_ids(['rev-1', 'rev-2a'])
339
wt.branch.set_last_revision_info(1, 'rev-1')
340
wt.commit('rev-2', rev_id='rev-2b',
341
timestamp=1132586800, timezone=36000,
342
committer='Joe Foo <joe@foo.com>')
343
logfile = self.make_utf8_encoded_stringio()
344
formatter = ShortLogFormatter(to_file=logfile)
345
revspec = RevisionSpec.from_string('1.1.1')
347
rev = revspec.in_history(wtb)
348
show_log(wtb, formatter, start_revision=rev, end_revision=rev)
349
self.assertEqualDiff(logfile.getvalue(), """\
350
1.1.1 Joe Foo\t2005-11-22
358
class TestLongLogFormatter(TestCaseWithTransport):
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
370
wt.branch, log.ShortLogFormatter,
371
show_log_kwargs=dict(start_revision=rev, end_revision=rev))
374
class TestShortLogFormatterWithMergeRevisions(TestCaseForLogFormatter):
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]
385
1.1.1 Joe Foo\t2005-11-22
388
1 Joe Foo\t2005-11-22
392
wt.branch, log.ShortLogFormatter,
393
formatter_kwargs=dict(levels=0))
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
404
wt.branch, log.ShortLogFormatter,
405
formatter_kwargs=dict(levels=0),
406
show_log_kwargs=dict(start_revision=rev, end_revision=rev))
409
class TestLongLogFormatter(TestCaseForLogFormatter):
360
411
def test_verbose_log(self):
361
412
"""Verbose log includes changed files
365
wt = self.make_branch_and_tree('.')
367
self.build_tree(['a'])
369
# XXX: why does a longer nick show up?
370
b.nick = 'test_verbose_log'
371
wt.commit(message='add a',
372
timestamp=1132711707,
374
committer='Lorem Ipsum <test@example.com>')
375
logfile = file('out.tmp', 'w+')
376
formatter = LongLogFormatter(to_file=logfile)
377
show_log(b, formatter, verbose=True)
380
log_contents = logfile.read()
381
self.assertEqualDiff(log_contents, '''\
416
wt = self.make_standard_commit('test_verbose_log', authors=[])
417
self.assertFormatterResult('''\
382
418
------------------------------------------------------------
384
420
committer: Lorem Ipsum <test@example.com>
385
421
branch nick: test_verbose_log
386
timestamp: Wed 2005-11-23 12:08:27 +1000
422
timestamp: Tue 2005-11-22 00:00:00 +0000
428
wt.branch, log.LongLogFormatter,
429
show_log_kwargs=dict(verbose=True))
393
431
def test_merges_are_indented_by_level(self):
394
432
wt = self.make_branch_and_tree('parent')
395
wt.commit('first post')
396
self.run_bzr('branch parent child')
397
self.run_bzr(['commit', '-m', 'branch 1', '--unchanged', 'child'])
398
self.run_bzr('branch child smallerchild')
399
self.run_bzr(['commit', '-m', 'branch 2', '--unchanged',
402
self.run_bzr('merge ../smallerchild')
403
self.run_bzr(['commit', '-m', 'merge branch 2'])
404
os.chdir('../parent')
405
self.run_bzr('merge ../child')
406
wt.commit('merge branch 1')
408
sio = self.make_utf8_encoded_stringio()
409
lf = LongLogFormatter(to_file=sio)
410
show_log(b, lf, verbose=True)
411
log = normalize_log(sio.getvalue())
412
self.assertEqualDiff(log, """\
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("""\
413
443
------------------------------------------------------------
415
committer: Lorem Ipsum <test@example.com>
445
committer: Joe Foo <joe@foo.com>
416
446
branch nick: parent
447
timestamp: Tue 2005-11-22 00:00:04 +0000
420
450
------------------------------------------------------------
422
committer: Lorem Ipsum <test@example.com>
452
committer: Joe Foo <joe@foo.com>
423
453
branch nick: child
454
timestamp: Tue 2005-11-22 00:00:03 +0000
427
457
------------------------------------------------------------
429
committer: Lorem Ipsum <test@example.com>
459
committer: Joe Foo <joe@foo.com>
430
460
branch nick: smallerchild
461
timestamp: Tue 2005-11-22 00:00:02 +0000
434
464
------------------------------------------------------------
436
committer: Lorem Ipsum <test@example.com>
466
committer: Joe Foo <joe@foo.com>
437
467
branch nick: child
468
timestamp: Tue 2005-11-22 00:00:01 +0000
441
471
------------------------------------------------------------
443
committer: Lorem Ipsum <test@example.com>
473
committer: Joe Foo <joe@foo.com>
444
474
branch nick: parent
475
timestamp: Tue 2005-11-22 00:00:00 +0000
479
wt.branch, log.LongLogFormatter,
480
formatter_kwargs=dict(levels=0),
481
show_log_kwargs=dict(verbose=True))
450
483
def test_verbose_merge_revisions_contain_deltas(self):
451
484
wt = self.make_branch_and_tree('parent')
452
485
self.build_tree(['parent/f1', 'parent/f2'])
453
486
wt.add(['f1','f2'])
454
wt.commit('first post')
455
self.run_bzr('branch parent child')
487
self.wt_commit(wt, 'first post')
488
child_wt = wt.bzrdir.sprout('child').open_workingtree()
456
489
os.unlink('child/f1')
457
file('child/f2', 'wb').write('hello\n')
458
self.run_bzr(['commit', '-m', 'removed f1 and modified f2',
461
self.run_bzr('merge ../child')
462
wt.commit('merge branch 1')
464
sio = self.make_utf8_encoded_stringio()
465
lf = LongLogFormatter(to_file=sio)
466
show_log(b, lf, verbose=True)
467
log = normalize_log(sio.getvalue())
468
self.assertEqualDiff(log, """\
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("""\
469
495
------------------------------------------------------------
471
committer: Lorem Ipsum <test@example.com>
497
committer: Joe Foo <joe@foo.com>
472
498
branch nick: parent
499
timestamp: Tue 2005-11-22 00:00:02 +0000
529
554
committer: Joe Foo <joe@foo.com>
530
555
branch nick: test
531
timestamp: Mon 2005-11-21 09:24:15 -0600
556
timestamp: Tue 2005-11-22 00:00:00 +0000
533
558
simple log message
560
b, log.LongLogFormatter)
536
562
def test_author_in_log(self):
537
563
"""Log includes the author name if it's set in
538
564
the revision properties
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
------------------------------------------------------------
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
579
wt.branch, log.LongLogFormatter)
581
def test_properties_in_log(self):
582
"""Log includes the custom properties returned by the registered
585
wt = self.make_standard_commit('test_properties_in_log')
586
def trivial_custom_prop_handler(revision):
587
return {'test_prop':'test_value'}
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
------------------------------------------------------------
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
604
wt.branch, log.LongLogFormatter)
606
def test_properties_in_short_log(self):
607
"""Log includes the custom properties returned by the registered
610
wt = self.make_standard_commit('test_properties_in_short_log')
611
def trivial_custom_prop_handler(revision):
612
return {'test_prop':'test_value'}
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
623
wt.branch, log.ShortLogFormatter)
625
def test_error_in_properties_handler(self):
626
"""Log includes the custom properties returned by the registered
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")
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,)
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']}
649
log.properties_handler_registry.register(
650
'bad_argument_prop_handler',
651
bad_argument_prop_handler)
653
self.assertRaises(AttributeError, formatter.show_properties,
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''',
662
class TestLongLogFormatterWithoutMergeRevisions(TestCaseForLogFormatter):
664
def test_long_verbose_log(self):
665
"""Verbose log includes changed files
669
wt = self.make_standard_commit('test_long_verbose_log', authors=[])
670
self.assertFormatterResult("""\
671
------------------------------------------------------------
673
committer: Lorem Ipsum <test@example.com>
674
branch nick: test_long_verbose_log
675
timestamp: Tue 2005-11-22 00:00:00 +0000
681
wt.branch, log.LongLogFormatter,
682
formatter_kwargs=dict(levels=1),
683
show_log_kwargs=dict(verbose=True))
685
def test_long_verbose_contain_deltas(self):
686
wt = self.make_branch_and_tree('parent')
687
self.build_tree(['parent/f1', 'parent/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
------------------------------------------------------------
699
committer: Joe Foo <joe@foo.com>
701
timestamp: Tue 2005-11-22 00:00:02 +0000
708
------------------------------------------------------------
710
committer: Joe Foo <joe@foo.com>
712
timestamp: Tue 2005-11-22 00:00:00 +0000
719
wt.branch, log.LongLogFormatter,
720
formatter_kwargs=dict(levels=1),
721
show_log_kwargs=dict(verbose=True))
723
def test_long_trailing_newlines(self):
540
724
wt = self.make_branch_and_tree('.')
542
self.build_tree(['a'])
544
b.nick = 'test_author_log'
545
wt.commit(message='add a',
546
timestamp=1132711707,
548
committer='Lorem Ipsum <test@example.com>',
549
author='John Doe <jdoe@example.com>')
551
formatter = LongLogFormatter(to_file=sio)
552
show_log(b, formatter)
553
self.assertEqualDiff(sio.getvalue(), '''\
725
b = self.make_commits_with_trailing_newlines(wt)
726
self.assertFormatterResult("""\
727
------------------------------------------------------------
729
committer: Joe Foo <joe@foo.com>
731
timestamp: Tue 2005-11-22 00:00:02 +0000
733
single line with trailing newline
734
------------------------------------------------------------
736
committer: Joe Foo <joe@foo.com>
738
timestamp: Tue 2005-11-22 00:00:01 +0000
743
------------------------------------------------------------
745
committer: Joe Foo <joe@foo.com>
747
timestamp: Tue 2005-11-22 00:00:00 +0000
751
b, log.LongLogFormatter,
752
formatter_kwargs=dict(levels=1))
754
def test_long_author_in_log(self):
755
"""Log includes the author name if it's set in
756
the revision properties
758
wt = self.make_standard_commit('test_author_log')
759
self.assertFormatterResult("""\
554
760
------------------------------------------------------------
556
762
author: John Doe <jdoe@example.com>
557
763
committer: Lorem Ipsum <test@example.com>
558
764
branch nick: test_author_log
559
timestamp: Wed 2005-11-23 12:08:27 +1000
566
class TestLineLogFormatter(TestCaseWithTransport):
765
timestamp: Tue 2005-11-22 00:00:00 +0000
769
wt.branch, log.LongLogFormatter,
770
formatter_kwargs=dict(levels=1))
772
def test_long_properties_in_log(self):
773
"""Log includes the custom properties returned by the registered
776
wt = self.make_standard_commit('test_properties_in_log')
777
def trivial_custom_prop_handler(revision):
778
return {'test_prop':'test_value'}
780
log.properties_handler_registry.register(
781
'trivial_custom_prop_handler',
782
trivial_custom_prop_handler)
783
self.assertFormatterResult("""\
784
------------------------------------------------------------
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
794
wt.branch, log.LongLogFormatter,
795
formatter_kwargs=dict(levels=1))
798
class TestLineLogFormatter(TestCaseForLogFormatter):
568
800
def test_line_log(self):
569
801
"""Line log should show revno
573
wt = self.make_branch_and_tree('.')
575
self.build_tree(['a'])
577
b.nick = 'test-line-log'
578
wt.commit(message='add a',
579
timestamp=1132711707,
581
committer='Line-Log-Formatter Tester <test@line.log>')
582
logfile = file('out.tmp', 'w+')
583
formatter = LineLogFormatter(to_file=logfile)
584
show_log(b, formatter)
587
log_contents = logfile.read()
588
self.assertEqualDiff(log_contents,
589
'1: Line-Log-Formatte... 2005-11-23 add a\n')
805
wt = self.make_standard_commit('test-line-log',
806
committer='Line-Log-Formatter Tester <test@line.log>',
808
self.assertFormatterResult("""\
809
1: Line-Log-Formatte... 2005-11-22 add a
811
wt.branch, log.LineLogFormatter)
591
813
def test_trailing_newlines(self):
592
814
wt = self.make_branch_and_tree('.')
593
b = make_commits_with_trailing_newlines(wt)
594
sio = self.make_utf8_encoded_stringio()
595
lf = LineLogFormatter(to_file=sio)
597
self.assertEqualDiff(sio.getvalue(), """\
598
3: Joe Foo 2005-11-21 single line with trailing newline
599
2: Joe Bar 2005-11-21 multiline
600
1: Joe Foo 2005-11-21 simple log message
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
821
b, log.LineLogFormatter)
603
823
def test_line_log_single_merge_revision(self):
604
wt = self.make_branch_and_memory_tree('.')
608
wt.commit('rev-1', rev_id='rev-1',
609
timestamp=1132586655, timezone=36000,
610
committer='Joe Foo <joe@foo.com>')
611
wt.commit('rev-merged', rev_id='rev-2a',
612
timestamp=1132586700, timezone=36000,
613
committer='Joe Foo <joe@foo.com>')
614
wt.set_parent_ids(['rev-1', 'rev-2a'])
615
wt.branch.set_last_revision_info(1, 'rev-1')
616
wt.commit('rev-2', rev_id='rev-2b',
617
timestamp=1132586800, timezone=36000,
618
committer='Joe Foo <joe@foo.com>')
619
logfile = self.make_utf8_encoded_stringio()
620
formatter = LineLogFormatter(to_file=logfile)
621
revspec = RevisionSpec.from_string('1.1.1')
623
rev = revspec.in_history(wtb)
624
show_log(wtb, formatter, start_revision=rev, end_revision=rev)
625
self.assertEqualDiff(logfile.getvalue(), """\
626
1.1.1: Joe Foo 2005-11-22 rev-merged
633
class TestGetViewRevisions(TestCaseWithTransport):
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
830
wt.branch, log.LineLogFormatter,
831
show_log_kwargs=dict(start_revision=rev, end_revision=rev))
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
840
wt.branch, log.LineLogFormatter)
843
class TestLineLogFormatterWithMergeRevisions(TestCaseForLogFormatter):
845
def test_line_merge_revs_log(self):
846
"""Line log should show revno
850
wt = self.make_standard_commit('test-line-log',
851
committer='Line-Log-Formatter Tester <test@line.log>',
853
self.assertFormatterResult("""\
854
1: Line-Log-Formatte... 2005-11-22 add a
856
wt.branch, log.LineLogFormatter)
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
865
wt.branch, log.LineLogFormatter,
866
formatter_kwargs=dict(levels=0),
867
show_log_kwargs=dict(start_revision=rev, end_revision=rev))
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
876
wt.branch, log.LineLogFormatter,
877
formatter_kwargs=dict(levels=0))
880
class TestGnuChangelogFormatter(TestCaseForLogFormatter):
882
def test_gnu_changelog(self):
883
wt = self.make_standard_commit('nicky', authors=[])
884
self.assertFormatterResult('''\
885
2005-11-22 Lorem Ipsum <test@example.com>
890
wt.branch, log.GnuChangelogLogFormatter)
892
def test_with_authors(self):
893
wt = self.make_standard_commit('nicky',
894
authors=['Fooa Fooz <foo@example.com>',
895
'Bari Baro <bar@example.com>'])
896
self.assertFormatterResult('''\
897
2005-11-22 Fooa Fooz <foo@example.com>
902
wt.branch, log.GnuChangelogLogFormatter)
904
def test_verbose(self):
905
wt = self.make_standard_commit('nicky')
906
self.assertFormatterResult('''\
907
2005-11-22 John Doe <jdoe@example.com>
914
wt.branch, log.GnuChangelogLogFormatter,
915
show_log_kwargs=dict(verbose=True))
917
class TestGetViewRevisions(tests.TestCaseWithTransport, TestLogMixin):
919
def _get_view_revisions(self, *args, **kwargs):
920
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
921
log.get_view_revisions, *args, **kwargs)
635
923
def make_tree_with_commits(self):
636
924
"""Create a tree with well-known revision ids"""
637
925
wt = self.make_branch_and_tree('tree1')
638
wt.commit('commit one', rev_id='1')
639
wt.commit('commit two', rev_id='2')
640
wt.commit('commit three', rev_id='3')
926
self.wt_commit(wt, 'commit one', rev_id='1')
927
self.wt_commit(wt, 'commit two', rev_id='2')
928
self.wt_commit(wt, 'commit three', rev_id='3')
641
929
mainline_revs = [None, '1', '2', '3']
642
930
rev_nos = {'1': 1, '2': 2, '3': 3}
643
931
return mainline_revs, rev_nos, wt
646
934
"""Create a tree with well-known revision ids and a merge"""
647
935
mainline_revs, rev_nos, wt = self.make_tree_with_commits()
648
936
tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
649
tree2.commit('four-a', rev_id='4a')
937
self.wt_commit(tree2, 'four-a', rev_id='4a')
650
938
wt.merge_from_branch(tree2.branch)
651
wt.commit('four-b', rev_id='4b')
939
self.wt_commit(wt, 'four-b', rev_id='4b')
652
940
mainline_revs.append('4b')
653
941
rev_nos['4b'] = 4
655
943
return mainline_revs, rev_nos, wt
657
def make_tree_with_many_merges(self):
945
def make_branch_with_many_merges(self):
658
946
"""Create a tree with well-known revision ids"""
659
wt = self.make_branch_and_tree('tree1')
660
wt.commit('commit one', rev_id='1')
661
wt.commit('commit two', rev_id='2')
662
tree3 = wt.bzrdir.sprout('tree3').open_workingtree()
663
tree3.commit('commit three a', rev_id='3a')
664
tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
665
tree2.merge_from_branch(tree3.branch)
666
tree2.commit('commit three b', rev_id='3b')
667
wt.merge_from_branch(tree2.branch)
668
wt.commit('commit three c', rev_id='3c')
669
tree2.commit('four-a', rev_id='4a')
670
wt.merge_from_branch(tree2.branch)
671
wt.commit('four-b', rev_id='4b')
947
builder = self.make_branch_builder('tree1')
948
builder.start_series()
949
builder.build_snapshot('1', None, [
950
('add', ('', 'TREE_ROOT', 'directory', '')),
951
('add', ('f', 'f-id', 'file', '1\n'))])
952
builder.build_snapshot('2', ['1'], [])
953
builder.build_snapshot('3a', ['2'], [
954
('modify', ('f-id', '1\n2\n3a\n'))])
955
builder.build_snapshot('3b', ['2', '3a'], [
956
('modify', ('f-id', '1\n2\n3a\n'))])
957
builder.build_snapshot('3c', ['2', '3b'], [
958
('modify', ('f-id', '1\n2\n3a\n'))])
959
builder.build_snapshot('4a', ['3b'], [])
960
builder.build_snapshot('4b', ['3c', '4a'], [])
961
builder.finish_series()
672
975
mainline_revs = [None, '1', '2', '3c', '4b']
673
976
rev_nos = {'1':1, '2':2, '3c': 3, '4b':4}
674
977
full_rev_nos_for_reference = {
677
'3a': '2.2.1', #first commit tree 3
678
'3b': '2.1.1', # first commit tree 2
980
'3a': '2.1.1', #first commit tree 3
981
'3b': '2.2.1', # first commit tree 2
679
982
'3c': '3', #merges 3b to main
680
'4a': '2.1.2', # second commit tree 2
983
'4a': '2.2.2', # second commit tree 2
681
984
'4b': '4', # merges 4a to main
683
return mainline_revs, rev_nos, wt
986
return mainline_revs, rev_nos, builder.get_branch()
685
988
def test_get_view_revisions_forward(self):
686
989
"""Test the get_view_revisions method"""
687
990
mainline_revs, rev_nos, wt = self.make_tree_with_commits()
688
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
992
self.addCleanup(wt.unlock)
993
revisions = list(self._get_view_revisions(
994
mainline_revs, rev_nos, wt.branch, 'forward'))
690
995
self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0)],
692
revisions2 = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
693
'forward', include_merges=False))
997
revisions2 = list(self._get_view_revisions(
998
mainline_revs, rev_nos, wt.branch, 'forward',
999
include_merges=False))
694
1000
self.assertEqual(revisions, revisions2)
696
1002
def test_get_view_revisions_reverse(self):
697
1003
"""Test the get_view_revisions with reverse"""
698
1004
mainline_revs, rev_nos, wt = self.make_tree_with_commits()
699
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
1006
self.addCleanup(wt.unlock)
1007
revisions = list(self._get_view_revisions(
1008
mainline_revs, rev_nos, wt.branch, 'reverse'))
701
1009
self.assertEqual([('3', '3', 0), ('2', '2', 0), ('1', '1', 0), ],
703
revisions2 = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
704
'reverse', include_merges=False))
1011
revisions2 = list(self._get_view_revisions(
1012
mainline_revs, rev_nos, wt.branch, 'reverse',
1013
include_merges=False))
705
1014
self.assertEqual(revisions, revisions2)
707
1016
def test_get_view_revisions_merge(self):
708
1017
"""Test get_view_revisions when there are merges"""
709
1018
mainline_revs, rev_nos, wt = self.make_tree_with_merges()
710
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
712
self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
713
('4b', '4', 0), ('4a', '3.1.1', 1)],
715
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
716
'forward', include_merges=False))
717
self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
1020
self.addCleanup(wt.unlock)
1021
revisions = list(self._get_view_revisions(
1022
mainline_revs, rev_nos, wt.branch, 'forward'))
1023
self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
1024
('4b', '4', 0), ('4a', '3.1.1', 1)],
1026
revisions = list(self._get_view_revisions(
1027
mainline_revs, rev_nos, wt.branch, 'forward',
1028
include_merges=False))
1029
self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3', '3', 0),
721
1033
def test_get_view_revisions_merge_reverse(self):
722
1034
"""Test get_view_revisions in reverse when there are merges"""
723
1035
mainline_revs, rev_nos, wt = self.make_tree_with_merges()
724
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
1037
self.addCleanup(wt.unlock)
1038
revisions = list(self._get_view_revisions(
1039
mainline_revs, rev_nos, wt.branch, 'reverse'))
726
1040
self.assertEqual([('4b', '4', 0), ('4a', '3.1.1', 1),
727
('3', '3', 0), ('2', '2', 0), ('1', '1', 0)],
729
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
730
'reverse', include_merges=False))
1041
('3', '3', 0), ('2', '2', 0), ('1', '1', 0)],
1043
revisions = list(self._get_view_revisions(
1044
mainline_revs, rev_nos, wt.branch, 'reverse',
1045
include_merges=False))
731
1046
self.assertEqual([('4b', '4', 0), ('3', '3', 0), ('2', '2', 0),
735
1050
def test_get_view_revisions_merge2(self):
736
1051
"""Test get_view_revisions when there are merges"""
737
mainline_revs, rev_nos, wt = self.make_tree_with_many_merges()
738
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
1052
mainline_revs, rev_nos, b = self.make_branch_with_many_merges()
1054
self.addCleanup(b.unlock)
1055
revisions = list(self._get_view_revisions(
1056
mainline_revs, rev_nos, b, 'forward'))
740
1057
expected = [('1', '1', 0), ('2', '2', 0), ('3c', '3', 0),
741
('3a', '2.2.1', 1), ('3b', '2.1.1', 1), ('4b', '4', 0),
1058
('3b', '2.2.1', 1), ('3a', '2.1.1', 2), ('4b', '4', 0),
743
1060
self.assertEqual(expected, revisions)
744
revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
745
'forward', include_merges=False))
1061
revisions = list(self._get_view_revisions(
1062
mainline_revs, rev_nos, b, 'forward',
1063
include_merges=False))
746
1064
self.assertEqual([('1', '1', 0), ('2', '2', 0), ('3c', '3', 0),
751
class TestGetRevisionsTouchingFileID(TestCaseWithTransport):
1068
def test_file_id_for_range(self):
1069
mainline_revs, rev_nos, b = self.make_branch_with_many_merges()
1071
self.addCleanup(b.unlock)
1073
def rev_from_rev_id(revid, branch):
1074
revspec = revisionspec.RevisionSpec.from_string('revid:%s' % revid)
1075
return revspec.in_history(branch)
1077
def view_revs(start_rev, end_rev, file_id, direction):
1078
revs = self.applyDeprecated(
1079
symbol_versioning.deprecated_in((2, 2, 0)),
1080
log.calculate_view_revisions,
1082
start_rev, # start_revision
1083
end_rev, # end_revision
1084
direction, # direction
1085
file_id, # specific_fileid
1086
True, # generate_merge_revisions
1090
rev_3a = rev_from_rev_id('3a', b)
1091
rev_4b = rev_from_rev_id('4b', b)
1092
self.assertEqual([('3c', '3', 0), ('3b', '2.2.1', 1),
1093
('3a', '2.1.1', 2)],
1094
view_revs(rev_3a, rev_4b, 'f-id', 'reverse'))
1095
# Note: 3c still appears before 3a here because of depth-based sorting
1096
self.assertEqual([('3c', '3', 0), ('3b', '2.2.1', 1),
1097
('3a', '2.1.1', 2)],
1098
view_revs(rev_3a, rev_4b, 'f-id', 'forward'))
1101
class TestGetRevisionsTouchingFileID(tests.TestCaseWithTransport):
1103
def get_view_revisions(self, *args):
1104
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1105
log.get_view_revisions, *args)
753
1107
def create_tree_with_single_merge(self):
754
1108
"""Create a branch with a moderate layout.
804
1163
tree.commit('D', rev_id='D')
806
1165
# Switch to a read lock for this tree.
807
# We still have addCleanup(unlock)
1166
# We still have an addCleanup(tree.unlock) pending
809
1168
tree.lock_read()
1171
def check_delta(self, delta, **kw):
1172
"""Check the filenames touched by a delta are as expected.
1174
Caller only have to pass in the list of files for each part, all
1175
unspecified parts are considered empty (and checked as such).
1177
for n in 'added', 'removed', 'renamed', 'modified', 'unchanged':
1178
# By default we expect an empty list
1179
expected = kw.get(n, [])
1180
# strip out only the path components
1181
got = [x[0] for x in getattr(delta, n)]
1182
self.assertEqual(expected, got)
812
1184
def test_tree_with_single_merge(self):
813
1185
"""Make sure the tree layout is correct."""
814
1186
tree = self.create_tree_with_single_merge()
815
1187
rev_A_tree = tree.branch.repository.revision_tree('A')
816
1188
rev_B_tree = tree.branch.repository.revision_tree('B')
818
f1_changed = (u'f1', 'f1-id', 'file', True, False)
819
f2_changed = (u'f2', 'f2-id', 'file', True, False)
820
f3_changed = (u'f3', 'f3-id', 'file', True, False)
822
delta = rev_B_tree.changes_from(rev_A_tree)
823
self.assertEqual([f1_changed, f3_changed], delta.modified)
824
self.assertEqual([], delta.renamed)
825
self.assertEqual([], delta.added)
826
self.assertEqual([], delta.removed)
828
1189
rev_C_tree = tree.branch.repository.revision_tree('C')
829
delta = rev_C_tree.changes_from(rev_A_tree)
830
self.assertEqual([f2_changed, f3_changed], delta.modified)
831
self.assertEqual([], delta.renamed)
832
self.assertEqual([], delta.added)
833
self.assertEqual([], delta.removed)
835
1190
rev_D_tree = tree.branch.repository.revision_tree('D')
836
delta = rev_D_tree.changes_from(rev_B_tree)
837
self.assertEqual([f2_changed, f3_changed], delta.modified)
838
self.assertEqual([], delta.renamed)
839
self.assertEqual([], delta.added)
840
self.assertEqual([], delta.removed)
842
delta = rev_D_tree.changes_from(rev_C_tree)
843
self.assertEqual([f1_changed, f3_changed], delta.modified)
844
self.assertEqual([], delta.renamed)
845
self.assertEqual([], delta.added)
846
self.assertEqual([], delta.removed)
1192
self.check_delta(rev_B_tree.changes_from(rev_A_tree),
1193
modified=['f1', 'f3'])
1195
self.check_delta(rev_C_tree.changes_from(rev_A_tree),
1196
modified=['f2', 'f3'])
1198
self.check_delta(rev_D_tree.changes_from(rev_B_tree),
1199
modified=['f2', 'f3'])
1201
self.check_delta(rev_D_tree.changes_from(rev_C_tree),
1202
modified=['f1', 'f3'])
848
1204
def assertAllRevisionsForFileID(self, tree, file_id, revisions):
849
"""Make sure _filter_revisions_touching_file_id returns the right values.
1205
"""Ensure _filter_revisions_touching_file_id returns the right values.
851
1207
Get the return value from _filter_revisions_touching_file_id and make
852
1208
sure they are correct.
854
# The api for _get_revisions_touching_file_id is a little crazy,
1210
# The api for _filter_revisions_touching_file_id is a little crazy.
855
1211
# So we do the setup here.
856
1212
mainline = tree.branch.revision_history()
857
1213
mainline.insert(0, None)
858
1214
revnos = dict((rev, idx+1) for idx, rev in enumerate(mainline))
859
view_revs_iter = log.get_view_revisions(mainline, revnos, tree.branch,
1215
view_revs_iter = self.get_view_revisions(
1216
mainline, revnos, tree.branch, 'reverse', True)
861
1217
actual_revs = log._filter_revisions_touching_file_id(
865
list(view_revs_iter))
1218
tree.branch, file_id, list(view_revs_iter))
866
1219
self.assertEqual(revisions, [r for r, revno, depth in actual_revs])
868
1221
def test_file_id_f1(self):
895
1271
self.assertNotContainsRe(s.getvalue(), 'foo')
898
class TestLogFormatter(TestCase):
1274
class TestLogFormatter(tests.TestCase):
1277
super(TestLogFormatter, self).setUp()
1278
self.rev = revision.Revision('a-id')
1279
self.lf = log.LogFormatter(None)
900
1281
def test_short_committer(self):
901
rev = Revision('a-id')
902
rev.committer = 'John Doe <jdoe@example.com>'
903
lf = LogFormatter(None)
904
self.assertEqual('John Doe', lf.short_committer(rev))
905
rev.committer = 'John Smith <jsmith@example.com>'
906
self.assertEqual('John Smith', lf.short_committer(rev))
907
rev.committer = 'John Smith'
908
self.assertEqual('John Smith', lf.short_committer(rev))
909
rev.committer = 'jsmith@example.com'
910
self.assertEqual('jsmith@example.com', lf.short_committer(rev))
911
rev.committer = '<jsmith@example.com>'
912
self.assertEqual('jsmith@example.com', lf.short_committer(rev))
913
rev.committer = 'John Smith jsmith@example.com'
914
self.assertEqual('John Smith', lf.short_committer(rev))
1282
def assertCommitter(expected, committer):
1283
self.rev.committer = committer
1284
self.assertEqual(expected, self.lf.short_committer(self.rev))
1286
assertCommitter('John Doe', 'John Doe <jdoe@example.com>')
1287
assertCommitter('John Smith', 'John Smith <jsmith@example.com>')
1288
assertCommitter('John Smith', 'John Smith')
1289
assertCommitter('jsmith@example.com', 'jsmith@example.com')
1290
assertCommitter('jsmith@example.com', '<jsmith@example.com>')
1291
assertCommitter('John Smith', 'John Smith jsmith@example.com')
916
1293
def test_short_author(self):
917
rev = Revision('a-id')
918
rev.committer = 'John Doe <jdoe@example.com>'
919
lf = LogFormatter(None)
920
self.assertEqual('John Doe', lf.short_author(rev))
921
rev.properties['author'] = 'John Smith <jsmith@example.com>'
922
self.assertEqual('John Smith', lf.short_author(rev))
923
rev.properties['author'] = 'John Smith'
924
self.assertEqual('John Smith', lf.short_author(rev))
925
rev.properties['author'] = 'jsmith@example.com'
926
self.assertEqual('jsmith@example.com', lf.short_author(rev))
927
rev.properties['author'] = '<jsmith@example.com>'
928
self.assertEqual('jsmith@example.com', lf.short_author(rev))
929
rev.properties['author'] = 'John Smith jsmith@example.com'
930
self.assertEqual('John Smith', lf.short_author(rev))
1294
def assertAuthor(expected, author):
1295
self.rev.properties['author'] = author
1296
self.assertEqual(expected, self.lf.short_author(self.rev))
1298
assertAuthor('John Smith', 'John Smith <jsmith@example.com>')
1299
assertAuthor('John Smith', 'John Smith')
1300
assertAuthor('jsmith@example.com', 'jsmith@example.com')
1301
assertAuthor('jsmith@example.com', '<jsmith@example.com>')
1302
assertAuthor('John Smith', 'John Smith jsmith@example.com')
1304
def test_short_author_from_committer(self):
1305
self.rev.committer = 'John Doe <jdoe@example.com>'
1306
self.assertEqual('John Doe', self.lf.short_author(self.rev))
1308
def test_short_author_from_authors(self):
1309
self.rev.properties['authors'] = ('John Smith <jsmith@example.com>\n'
1310
'Jane Rey <jrey@example.com>')
1311
self.assertEqual('John Smith', self.lf.short_author(self.rev))
1314
class TestReverseByDepth(tests.TestCase):
1315
"""Test reverse_by_depth behavior.
1317
This is used to present revisions in forward (oldest first) order in a nice
1320
The tests use lighter revision description to ease reading.
1323
def assertReversed(self, forward, backward):
1324
# Transform the descriptions to suit the API: tests use (revno, depth),
1325
# while the API expects (revid, revno, depth)
1326
def complete_revisions(l):
1327
"""Transform the description to suit the API.
1329
Tests use (revno, depth) whil the API expects (revid, revno, depth).
1330
Since the revid is arbitrary, we just duplicate revno
1332
return [ (r, r, d) for r, d in l]
1333
forward = complete_revisions(forward)
1334
backward= complete_revisions(backward)
1335
self.assertEqual(forward, log.reverse_by_depth(backward))
1338
def test_mainline_revisions(self):
1339
self.assertReversed([( '1', 0), ('2', 0)],
1340
[('2', 0), ('1', 0)])
1342
def test_merged_revisions(self):
1343
self.assertReversed([('1', 0), ('2', 0), ('2.2', 1), ('2.1', 1),],
1344
[('2', 0), ('2.1', 1), ('2.2', 1), ('1', 0),])
1345
def test_shifted_merged_revisions(self):
1346
"""Test irregular layout.
1348
Requesting revisions touching a file can produce "holes" in the depths.
1350
self.assertReversed([('1', 0), ('2', 0), ('1.1', 2), ('1.2', 2),],
1351
[('2', 0), ('1.2', 2), ('1.1', 2), ('1', 0),])
1353
def test_merged_without_child_revisions(self):
1354
"""Test irregular layout.
1356
Revision ranges can produce "holes" in the depths.
1358
# When a revision of higher depth doesn't follow one of lower depth, we
1359
# assume a lower depth one is virtually there
1360
self.assertReversed([('1', 2), ('2', 2), ('3', 3), ('4', 4)],
1361
[('4', 4), ('3', 3), ('2', 2), ('1', 2),])
1362
# So we get the same order after reversing below even if the original
1363
# revisions are not in the same order.
1364
self.assertReversed([('1', 2), ('2', 2), ('3', 3), ('4', 4)],
1365
[('3', 3), ('4', 4), ('2', 2), ('1', 2),])
1368
class TestHistoryChange(tests.TestCaseWithTransport):
1370
def setup_a_tree(self):
1371
tree = self.make_branch_and_tree('tree')
1373
self.addCleanup(tree.unlock)
1374
tree.commit('1a', rev_id='1a')
1375
tree.commit('2a', rev_id='2a')
1376
tree.commit('3a', rev_id='3a')
1379
def setup_ab_tree(self):
1380
tree = self.setup_a_tree()
1381
tree.set_last_revision('1a')
1382
tree.branch.set_last_revision_info(1, '1a')
1383
tree.commit('2b', rev_id='2b')
1384
tree.commit('3b', rev_id='3b')
1387
def setup_ac_tree(self):
1388
tree = self.setup_a_tree()
1389
tree.set_last_revision(revision.NULL_REVISION)
1390
tree.branch.set_last_revision_info(0, revision.NULL_REVISION)
1391
tree.commit('1c', rev_id='1c')
1392
tree.commit('2c', rev_id='2c')
1393
tree.commit('3c', rev_id='3c')
1396
def test_all_new(self):
1397
tree = self.setup_ab_tree()
1398
old, new = log.get_history_change('1a', '3a', tree.branch.repository)
1399
self.assertEqual([], old)
1400
self.assertEqual(['2a', '3a'], new)
1402
def test_all_old(self):
1403
tree = self.setup_ab_tree()
1404
old, new = log.get_history_change('3a', '1a', tree.branch.repository)
1405
self.assertEqual([], new)
1406
self.assertEqual(['2a', '3a'], old)
1408
def test_null_old(self):
1409
tree = self.setup_ab_tree()
1410
old, new = log.get_history_change(revision.NULL_REVISION,
1411
'3a', tree.branch.repository)
1412
self.assertEqual([], old)
1413
self.assertEqual(['1a', '2a', '3a'], new)
1415
def test_null_new(self):
1416
tree = self.setup_ab_tree()
1417
old, new = log.get_history_change('3a', revision.NULL_REVISION,
1418
tree.branch.repository)
1419
self.assertEqual([], new)
1420
self.assertEqual(['1a', '2a', '3a'], old)
1422
def test_diverged(self):
1423
tree = self.setup_ab_tree()
1424
old, new = log.get_history_change('3a', '3b', tree.branch.repository)
1425
self.assertEqual(old, ['2a', '3a'])
1426
self.assertEqual(new, ['2b', '3b'])
1428
def test_unrelated(self):
1429
tree = self.setup_ac_tree()
1430
old, new = log.get_history_change('3a', '3c', tree.branch.repository)
1431
self.assertEqual(old, ['1a', '2a', '3a'])
1432
self.assertEqual(new, ['1c', '2c', '3c'])
1434
def test_show_branch_change(self):
1435
tree = self.setup_ab_tree()
1437
log.show_branch_change(tree.branch, s, 3, '3a')
1438
self.assertContainsRe(s.getvalue(),
1439
'[*]{60}\nRemoved Revisions:\n(.|\n)*2a(.|\n)*3a(.|\n)*'
1440
'[*]{60}\n\nAdded Revisions:\n(.|\n)*2b(.|\n)*3b')
1442
def test_show_branch_change_no_change(self):
1443
tree = self.setup_ab_tree()
1445
log.show_branch_change(tree.branch, s, 3, '3b')
1446
self.assertEqual(s.getvalue(),
1447
'Nothing seems to have changed\n')
1449
def test_show_branch_change_no_old(self):
1450
tree = self.setup_ab_tree()
1452
log.show_branch_change(tree.branch, s, 2, '2b')
1453
self.assertContainsRe(s.getvalue(), 'Added Revisions:')
1454
self.assertNotContainsRe(s.getvalue(), 'Removed Revisions:')
1456
def test_show_branch_change_no_new(self):
1457
tree = self.setup_ab_tree()
1458
tree.branch.set_last_revision_info(2, '2b')
1460
log.show_branch_change(tree.branch, s, 3, '3b')
1461
self.assertContainsRe(s.getvalue(), 'Removed Revisions:')
1462
self.assertNotContainsRe(s.getvalue(), 'Added Revisions:')
1466
class TestLogWithBugs(TestCaseForLogFormatter, TestLogMixin):
1469
TestCaseForLogFormatter.setUp(self)
1470
log.properties_handler_registry.register(
1471
'bugs_properties_handler',
1472
log._bugs_properties_handler)
1474
def make_commits_with_bugs(self):
1475
"""Helper method for LogFormatter tests"""
1476
tree = self.make_branch_and_tree(u'.')
1477
self.build_tree(['a', 'b'])
1479
self.wt_commit(tree, 'simple log message', rev_id='a1',
1480
revprops={'bugs': 'test://bug/id fixed'})
1482
self.wt_commit(tree, 'multiline\nlog\nmessage\n', rev_id='a2',
1483
authors=['Joe Bar <joe@bar.com>'],
1484
revprops={'bugs': 'test://bug/id fixed\n'
1485
'test://bug/2 fixed'})
1489
def test_long_bugs(self):
1490
tree = self.make_commits_with_bugs()
1491
self.assertFormatterResult("""\
1492
------------------------------------------------------------
1494
fixes bug(s): test://bug/id test://bug/2
1495
author: Joe Bar <joe@bar.com>
1496
committer: Joe Foo <joe@foo.com>
1498
timestamp: Tue 2005-11-22 00:00:01 +0000
1503
------------------------------------------------------------
1505
fixes bug(s): test://bug/id
1506
committer: Joe Foo <joe@foo.com>
1508
timestamp: Tue 2005-11-22 00:00:00 +0000
1512
tree.branch, log.LongLogFormatter)
1514
def test_short_bugs(self):
1515
tree = self.make_commits_with_bugs()
1516
self.assertFormatterResult("""\
1517
2 Joe Bar\t2005-11-22
1518
fixes bug(s): test://bug/id test://bug/2
1523
1 Joe Foo\t2005-11-22
1524
fixes bug(s): test://bug/id
1528
tree.branch, log.ShortLogFormatter)
1530
def test_wrong_bugs_property(self):
1531
tree = self.make_branch_and_tree(u'.')
1532
self.build_tree(['foo'])
1533
self.wt_commit(tree, 'simple log message', rev_id='a1',
1534
revprops={'bugs': 'test://bug/id invalid_value'})
1535
self.assertFormatterResult("""\
1536
1 Joe Foo\t2005-11-22
1540
tree.branch, log.ShortLogFormatter)
1542
def test_bugs_handler_present(self):
1543
self.properties_handler_registry.get('bugs_properties_handler')
added
removed
bzrlib/tests/test_log.py
