1
# Copyright (C) 2005 by Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
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
 
 
18
from cStringIO import StringIO
 
 
20
from bzrlib.selftest import BzrTestBase, TestCaseInTempDir
 
 
21
from bzrlib.log import LogFormatter, show_log, LongLogFormatter
 
 
22
from bzrlib.branch import Branch
 
 
23
from bzrlib.errors import InvalidRevisionNumber
 
 
25
class _LogEntry(object):
 
 
26
    # should probably move into bzrlib.log?
 
 
30
class LogCatcher(LogFormatter):
 
 
31
    """Pull log messages into list rather than displaying them.
 
 
33
    For ease of testing we save log messages here rather than actually
 
 
34
    formatting them, so that we can precisely check the result without
 
 
35
    being too dependent on the exact formatting.
 
 
37
    We should also test the LogFormatter.
 
 
40
        super(LogCatcher, self).__init__(to_file=None)
 
 
44
    def show(self, revno, rev, delta):
 
 
52
class SimpleLogTest(TestCaseInTempDir):
 
 
54
    def checkDelta(self, delta, **kw):
 
 
55
        """Check the filenames touched by a delta are as expected."""
 
 
56
        for n in 'added', 'removed', 'renamed', 'modified', 'unchanged':
 
 
57
            expected = kw.get(n, [])
 
 
59
            # tests are written with unix paths; fix them up for windows
 
 
61
                expected = [x.replace('/', os.sep) for x in expected]
 
 
63
            # strip out only the path components
 
 
64
            got = [x[0] for x in getattr(delta, n)]
 
 
65
            self.assertEquals(expected, got)
 
 
67
    def test_cur_revno(self):
 
 
68
        b = Branch('.', init=True)
 
 
71
        b.working_tree().commit('empty commit')
 
 
72
        show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
 
 
73
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
74
                          start_revision=2, end_revision=1) 
 
 
75
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
76
                          start_revision=1, end_revision=2) 
 
 
77
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
78
                          start_revision=0, end_revision=2) 
 
 
79
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
80
                          start_revision=1, end_revision=0) 
 
 
81
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
82
                          start_revision=-1, end_revision=1) 
 
 
83
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
84
                          start_revision=1, end_revision=-1) 
 
 
86
    def test_cur_revno(self):
 
 
87
        b = Branch.initialize('.')
 
 
90
        b.working_tree().commit('empty commit')
 
 
91
        show_log(b, lf, verbose=True, start_revision=1, end_revision=1)
 
 
92
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
93
                          start_revision=2, end_revision=1) 
 
 
94
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
95
                          start_revision=1, end_revision=2) 
 
 
96
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
97
                          start_revision=0, end_revision=2) 
 
 
98
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
99
                          start_revision=1, end_revision=0) 
 
 
100
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
101
                          start_revision=-1, end_revision=1) 
 
 
102
        self.assertRaises(InvalidRevisionNumber, show_log, b, lf,
 
 
103
                          start_revision=1, end_revision=-1) 
 
 
105
    def test_simple_log(self):
 
 
106
        eq = self.assertEquals
 
 
108
        b = Branch.initialize('.')
 
 
116
        b.working_tree().commit('empty commit')
 
 
118
        show_log(b, lf, verbose=True)
 
 
120
        eq(lf.logs[0].revno, 1)
 
 
121
        eq(lf.logs[0].rev.message, 'empty commit')
 
 
123
        self.log('log delta: %r' % d)
 
 
127
        self.build_tree(['hello'])
 
 
129
        b.working_tree().commit('add one file')
 
 
132
        # log using regular thing
 
 
133
        show_log(b, LongLogFormatter(lf))
 
 
135
        for l in lf.readlines():
 
 
138
        # get log as data structure
 
 
140
        show_log(b, lf, verbose=True)
 
 
142
        self.log('log entries:')
 
 
143
        for logentry in lf.logs:
 
 
144
            self.log('%4d %s' % (logentry.revno, logentry.rev.message))
 
 
146
        # first one is most recent
 
 
147
        logentry = lf.logs[0]
 
 
148
        eq(logentry.revno, 2)
 
 
149
        eq(logentry.rev.message, 'add one file')
 
 
151
        self.log('log 2 delta: %r' % d)
 
 
152
        # self.checkDelta(d, added=['hello'])
 
 
154
        # commit a log message with control characters
 
 
155
        msg = "All 8-bit chars: " +  ''.join([unichr(x) for x in range(256)])
 
 
156
        b.working_tree().commit(msg)
 
 
158
        show_log(b, lf, verbose=True)
 
 
159
        committed_msg = lf.logs[0].rev.message
 
 
160
        self.log("escaped commit message: %r", committed_msg)
 
 
161
        self.assert_(msg != committed_msg)
 
 
162
        self.assert_(len(committed_msg) > len(msg))