← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/selftest/testlog.py

  • Committer: Martin Pool
  • Date: 2005-10-04 11:13:33 UTC
  • mto: (1185.13.3)
  • mto: This revision was merged to the branch mainline in revision 1403.
  • Revision ID: mbp@sourcefrog.net-20051004111332-f7b8a6bd41b9fe22
- tweak capture_tree formatting

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/selftest/testlog.py
1
1
# Copyright (C) 2005 by Canonical Ltd
2
 
# -*- coding: utf-8 -*-
3
 
# vim: encoding=utf-8
4
 
#
 
2
 
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
#
 
7
 
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
#
 
12
 
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
17
import os
20
18
from cStringIO import StringIO
21
19
 
22
 
from bzrlib.tests import BzrTestBase, TestCaseWithTransport
23
 
from bzrlib.log import (show_log, 
24
 
                        get_view_revisions, 
25
 
                        LogFormatter, 
26
 
                        LongLogFormatter, 
27
 
                        ShortLogFormatter, 
28
 
                        LineLogFormatter)
 
20
from bzrlib.selftest import BzrTestBase, TestCaseInTempDir
 
21
from bzrlib.log import LogFormatter, show_log, LongLogFormatter
29
22
from bzrlib.branch import Branch
30
23
from bzrlib.errors import InvalidRevisionNumber
31
24
 
32
 
 
33
25
class _LogEntry(object):
34
26
    # should probably move into bzrlib.log?
35
27
    pass
47
39
    def __init__(self):
48
40
        super(LogCatcher, self).__init__(to_file=None)
49
41
        self.logs = []
50
 
 
 
42
        
 
43
        
51
44
    def show(self, revno, rev, delta):
52
45
        le = _LogEntry()
53
46
        le.revno = revno
56
49
        self.logs.append(le)
57
50
 
58
51
 
59
 
class SimpleLogTest(TestCaseWithTransport):
 
52
class SimpleLogTest(TestCaseInTempDir):
60
53
 
61
54
    def checkDelta(self, delta, **kw):
62
55
        """Check the filenames touched by a delta are as expected."""
64
57
            expected = kw.get(n, [])
65
58
 
66
59
            # tests are written with unix paths; fix them up for windows
67
 
            #if os.sep != '/':
68
 
            #    expected = [x.replace('/', os.sep) for x in expected]
 
60
            if os.sep != '/':
 
61
                expected = [x.replace('/', os.sep) for x in expected]
69
62
 
70
63
            # strip out only the path components
71
64
            got = [x[0] for x in getattr(delta, n)]
72
65
            self.assertEquals(expected, got)
73
66
 
74
67
    def test_cur_revno(self):
75
 
        wt = self.make_branch_and_tree('.')
76
 
        b = wt.branch
 
68
        b = Branch('.', init=True)
77
69
 
78
70
        lf = LogCatcher()
79
 
        wt.commit('empty commit')
 
71
        b.commit('empty commit')
80
72
        show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
81
73
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
82
74
                          start_revision=2, end_revision=1) 
92
84
                          start_revision=1, end_revision=-1) 
93
85
 
94
86
    def test_cur_revno(self):
95
 
        wt = self.make_branch_and_tree('.')
96
 
        b = wt.branch
 
87
        b = Branch.initialize('.')
97
88
 
98
89
        lf = LogCatcher()
99
 
        wt.commit('empty commit')
 
90
        b.commit('empty commit')
100
91
        show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
101
92
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
102
93
                          start_revision=2, end_revision=1) 
114
105
    def test_simple_log(self):
115
106
        eq = self.assertEquals
116
107
        
117
 
        wt = self.make_branch_and_tree('.')
118
 
        b = wt.branch
 
108
        b = Branch.initialize('.')
119
109
 
120
110
        lf = LogCatcher()
121
111
        show_log(b, lf)
122
112
        # no entries yet
123
113
        eq(lf.logs, [])
124
114
 
125
 
        wt.commit('empty commit')
 
115
 
 
116
        b.commit('empty commit')
126
117
        lf = LogCatcher()
127
118
        show_log(b, lf, verbose=True)
128
119
        eq(len(lf.logs), 1)
132
123
        self.log('log delta: %r' % d)
133
124
        self.checkDelta(d)
134
125
 
 
126
 
135
127
        self.build_tree(['hello'])
136
 
        wt.add('hello')
137
 
        wt.commit('add one file')
 
128
        b.add('hello')
 
129
        b.commit('add one file')
138
130
 
139
131
        lf = StringIO()
140
132
        # log using regular thing
161
153
        
162
154
        # commit a log message with control characters
163
155
        msg = "All 8-bit chars: " +  ''.join([unichr(x) for x in range(256)])
164
 
        self.log("original commit message: %r", msg)
165
 
        wt.commit(msg)
 
156
        b.commit(msg)
166
157
        lf = LogCatcher()
167
158
        show_log(b, lf, verbose=True)
168
159
        committed_msg = lf.logs[0].rev.message
169
160
        self.log("escaped commit message: %r", committed_msg)
170
161
        self.assert_(msg != committed_msg)
171
162
        self.assert_(len(committed_msg) > len(msg))
172
 
 
173
 
        # Check that log message with only XML-valid characters isn't
174
 
        # escaped.  As ElementTree apparently does some kind of
175
 
        # newline conversion, neither LF (\x0A) nor CR (\x0D) are
176
 
        # included in the test commit message, even though they are
177
 
        # valid XML 1.0 characters.
178
 
        msg = "\x09" + ''.join([unichr(x) for x in range(0x20, 256)])
179
 
        self.log("original commit message: %r", msg)
180
 
        wt.commit(msg)
181
 
        lf = LogCatcher()
182
 
        show_log(b, lf, verbose=True)
183
 
        committed_msg = lf.logs[0].rev.message
184
 
        self.log("escaped commit message: %r", committed_msg)
185
 
        self.assert_(msg == committed_msg)
186
 
 
187
 
    def test_trailing_newlines(self):
188
 
        wt = self.make_branch_and_tree('.')
189
 
        b = wt.branch
190
 
        b.nick='test'
191
 
        open('a', 'wb').write('hello moto\n')
192
 
        wt.add('a')
193
 
        wt.commit('simple log message', rev_id='a1'
194
 
                , timestamp=1132586655.459960938, timezone=-6*3600
195
 
                , committer='Joe Foo <joe@foo.com>')
196
 
        open('b', 'wb').write('goodbye\n')
197
 
        wt.add('b')
198
 
        wt.commit('multiline\nlog\nmessage\n', rev_id='a2'
199
 
                , timestamp=1132586842.411175966, timezone=-6*3600
200
 
                , committer='Joe Foo <joe@foo.com>')
201
 
 
202
 
        open('c', 'wb').write('just another manic monday\n')
203
 
        wt.add('c')
204
 
        wt.commit('single line with trailing newline\n', rev_id='a3'
205
 
                , timestamp=1132587176.835228920, timezone=-6*3600
206
 
                , committer = 'Joe Foo <joe@foo.com>')
207
 
 
208
 
        sio = StringIO()
209
 
        lf = ShortLogFormatter(to_file=sio)
210
 
        show_log(b, lf)
211
 
        self.assertEquals(sio.getvalue(), """\
212
 
    3 Joe Foo\t2005-11-21
213
 
      single line with trailing newline
214
 
 
215
 
    2 Joe Foo\t2005-11-21
216
 
      multiline
217
 
      log
218
 
      message
219
 
 
220
 
    1 Joe Foo\t2005-11-21
221
 
      simple log message
222
 
 
223
 
""")
224
 
 
225
 
        sio = StringIO()
226
 
        lf = LongLogFormatter(to_file=sio)
227
 
        show_log(b, lf)
228
 
        self.assertEquals(sio.getvalue(), """\
229
 
------------------------------------------------------------
230
 
revno: 3
231
 
committer: Joe Foo <joe@foo.com>
232
 
branch nick: test
233
 
timestamp: Mon 2005-11-21 09:32:56 -0600
234
 
message:
235
 
  single line with trailing newline
236
 
------------------------------------------------------------
237
 
revno: 2
238
 
committer: Joe Foo <joe@foo.com>
239
 
branch nick: test
240
 
timestamp: Mon 2005-11-21 09:27:22 -0600
241
 
message:
242
 
  multiline
243
 
  log
244
 
  message
245
 
------------------------------------------------------------
246
 
revno: 1
247
 
committer: Joe Foo <joe@foo.com>
248
 
branch nick: test
249
 
timestamp: Mon 2005-11-21 09:24:15 -0600
250
 
message:
251
 
  simple log message
252
 
""")
253
 
        
254
 
    def test_verbose_log(self):
255
 
        """Verbose log includes changed files
256
 
        
257
 
        bug #4676
258
 
        """
259
 
        wt = self.make_branch_and_tree('.')
260
 
        b = wt.branch
261
 
        self.build_tree(['a'])
262
 
        wt.add('a')
263
 
        # XXX: why does a longer nick show up?
264
 
        b.nick = 'test_verbose_log'
265
 
        wt.commit(message='add a', 
266
 
                  timestamp=1132711707, 
267
 
                  timezone=36000,
268
 
                  committer='Lorem Ipsum <test@example.com>')
269
 
        logfile = file('out.tmp', 'w+')
270
 
        formatter = LongLogFormatter(to_file=logfile)
271
 
        show_log(b, formatter, verbose=True)
272
 
        logfile.flush()
273
 
        logfile.seek(0)
274
 
        log_contents = logfile.read()
275
 
        self.assertEqualDiff(log_contents, '''\
276
 
------------------------------------------------------------
277
 
revno: 1
278
 
committer: Lorem Ipsum <test@example.com>
279
 
branch nick: test_verbose_log
280
 
timestamp: Wed 2005-11-23 12:08:27 +1000
281
 
message:
282
 
  add a
283
 
added:
284
 
  a
285
 
''')
286
 
 
287
 
    def test_line_log(self):
288
 
        """Line log should show revno
289
 
        
290
 
        bug #5162
291
 
        """
292
 
        wt = self.make_branch_and_tree('.')
293
 
        b = wt.branch
294
 
        self.build_tree(['a'])
295
 
        wt.add('a')
296
 
        b.nick = 'test-line-log'
297
 
        wt.commit(message='add a', 
298
 
                  timestamp=1132711707, 
299
 
                  timezone=36000,
300
 
                  committer='Line-Log-Formatter Tester <test@line.log>')
301
 
        logfile = file('out.tmp', 'w+')
302
 
        formatter = LineLogFormatter(to_file=logfile)
303
 
        show_log(b, formatter)
304
 
        logfile.flush()
305
 
        logfile.seek(0)
306
 
        log_contents = logfile.read()
307
 
        self.assertEqualDiff(log_contents, '1: Line-Log-Formatte... 2005-11-23 add a\n')
308
 
 
309
 
    def make_tree_with_commits(self):
310
 
        """Create a tree with well-known revision ids"""
311
 
        wt = self.make_branch_and_tree('tree1')
312
 
        wt.commit('commit one', rev_id='1')
313
 
        wt.commit('commit two', rev_id='2')
314
 
        wt.commit('commit three', rev_id='3')
315
 
        mainline_revs = [None, '1', '2', '3']
316
 
        rev_nos = {'1': 1, '2': 2, '3': 3}
317
 
        return mainline_revs, rev_nos, wt
318
 
 
319
 
    def pseudo_merge(self, source, target):
320
 
        revision_id = source.last_revision()
321
 
        target.branch.fetch(source.branch, revision_id)
322
 
        target.add_pending_merge(revision_id)
323
 
 
324
 
    def make_tree_with_merges(self):
325
 
        """Create a tree with well-known revision ids and a merge"""
326
 
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
327
 
        tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
328
 
        tree2.commit('four-a', rev_id='4a')
329
 
        self.pseudo_merge(tree2, wt)
330
 
        wt.commit('four-b', rev_id='4b')
331
 
        mainline_revs.append('4b')
332
 
        rev_nos['4b'] = 4
333
 
        return mainline_revs, rev_nos, wt
334
 
 
335
 
    def make_tree_with_many_merges(self):
336
 
        """Create a tree with well-known revision ids"""
337
 
        wt = self.make_branch_and_tree('tree1')
338
 
        wt.commit('commit one', rev_id='1')
339
 
        wt.commit('commit two', rev_id='2')
340
 
        tree2 = wt.bzrdir.sprout('tree2').open_workingtree()
341
 
        tree3 = wt.bzrdir.sprout('tree3').open_workingtree()
342
 
        tree3.commit('commit three a', rev_id='3a')
343
 
        self.pseudo_merge(tree3, tree2)
344
 
        tree2.commit('commit three b', rev_id='3b')
345
 
        self.pseudo_merge(tree2, wt)
346
 
        wt.commit('commit three c', rev_id='3c')
347
 
        tree2.commit('four-a', rev_id='4a')
348
 
        self.pseudo_merge(tree2, wt)
349
 
        wt.commit('four-b', rev_id='4b')
350
 
        mainline_revs = [None, '1', '2', '3c', '4b']
351
 
        rev_nos = {'1': 1, '2': 2, '3c': 3, '4b': 4}
352
 
        return mainline_revs, rev_nos, wt
353
 
 
354
 
    def test_get_view_revisions_forward(self):
355
 
        """Test the get_view_revisions method"""
356
 
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
357
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
358
 
                                            'forward'))
359
 
        self.assertEqual(revisions, [('1', 1, 0), ('2', 2, 0), ('3', 3, 0)])
360
 
        revisions2 = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
361
 
                                             'forward', include_merges=False))
362
 
        self.assertEqual(revisions, revisions2)
363
 
 
364
 
    def test_get_view_revisions_reverse(self):
365
 
        """Test the get_view_revisions with reverse"""
366
 
        mainline_revs, rev_nos, wt = self.make_tree_with_commits()
367
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
368
 
                                            'reverse'))
369
 
        self.assertEqual(revisions, [('3', 3, 0), ('2', 2, 0), ('1', 1, 0), ])
370
 
        revisions2 = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
371
 
                                             'reverse', include_merges=False))
372
 
        self.assertEqual(revisions, revisions2)
373
 
 
374
 
    def test_get_view_revisions_merge(self):
375
 
        """Test get_view_revisions when there are merges"""
376
 
        mainline_revs, rev_nos, wt = self.make_tree_with_merges()
377
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
378
 
                                            'forward'))
379
 
        self.assertEqual(revisions, [('1', 1, 0), ('2', 2, 0), ('3', 3, 0),
380
 
                                     ('4b', 4, 0), ('4a', None, 1)])
381
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
382
 
                                             'forward', include_merges=False))
383
 
        self.assertEqual(revisions, [('1', 1, 0), ('2', 2, 0), ('3', 3, 0),
384
 
                                     ('4b', 4, 0)])
385
 
 
386
 
    def test_get_view_revisions_merge_reverse(self):
387
 
        """Test get_view_revisions in reverse when there are merges"""
388
 
        mainline_revs, rev_nos, wt = self.make_tree_with_merges()
389
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
390
 
                                            'reverse'))
391
 
        self.assertEqual(revisions, [('4b', 4, 0), ('4a', None, 1), 
392
 
                                     ('3', 3, 0), ('2', 2, 0), ('1', 1, 0)])
393
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
394
 
                                             'reverse', include_merges=False))
395
 
        self.assertEqual(revisions, [('4b', 4, 0), ('3', 3, 0), ('2', 2, 0),
396
 
                                     ('1', 1, 0)])
397
 
 
398
 
    def test_get_view_revisions_merge2(self):
399
 
        """Test get_view_revisions when there are merges"""
400
 
        mainline_revs, rev_nos, wt = self.make_tree_with_many_merges()
401
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
402
 
                                            'forward'))
403
 
        expected = [('1', 1, 0), ('2', 2, 0), ('3c', 3, 0), ('3a', None, 1),
404
 
                    ('3b', None, 1), ('4b', 4, 0), ('4a', None, 1)]
405
 
        self.assertEqual(revisions, expected)
406
 
        revisions = list(get_view_revisions(mainline_revs, rev_nos, wt.branch,
407
 
                                             'forward', include_merges=False))
408
 
        self.assertEqual(revisions, [('1', 1, 0), ('2', 2, 0), ('3c', 3, 0),
409
 
                                     ('4b', 4, 0)])