1
# Copyright (C) 2005, 2006, 2007 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
17
# "weren't nothing promised to you. do i look like i got a promise face?"
19
"""Tests for trace library"""
21
from cStringIO import StringIO
30
from bzrlib.tests import TestCaseInTempDir, TestCase
31
from bzrlib.trace import (
32
mutter, mutter_callsite, report_exception,
33
set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
34
_rollover_trace_maybe,
38
def _format_exception():
39
"""Format an exception as it would normally be displayed to the user"""
41
report_exception(sys.exc_info(), buf)
45
class TestTrace(TestCase):
47
def test_format_sys_exception(self):
49
raise NotImplementedError, "time travel"
50
except NotImplementedError:
52
err = _format_exception()
53
self.assertEqualDiff(err.splitlines()[0],
54
'bzr: ERROR: exceptions.NotImplementedError: time travel')
55
self.assertContainsRe(err,
56
r'File.*test_trace.py')
58
def test_format_interrupt_exception(self):
60
raise KeyboardInterrupt()
61
except KeyboardInterrupt:
62
# XXX: Some risk that a *real* keyboard interrupt won't be seen
64
msg = _format_exception()
65
self.assertTrue(len(msg) > 0)
66
self.assertEqualDiff(msg, 'bzr: interrupted\n')
68
def test_format_os_error(self):
70
file('nosuchfile22222')
71
except (OSError, IOError):
73
msg = _format_exception()
74
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
76
def test_format_unicode_error(self):
78
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
79
except errors.BzrCommandError:
81
msg = _format_exception()
83
def test_format_exception(self):
84
"""Short formatting of bzr exceptions"""
86
raise errors.NotBranchError('wibble')
87
except errors.NotBranchError:
89
msg = _format_exception()
90
self.assertTrue(len(msg) > 0)
91
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
93
def test_trace_unicode(self):
94
"""Write Unicode to trace log"""
95
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
96
self.assertContainsRe(self._get_log(keep_log_file=True),
97
"the unicode character for benzene is")
99
def test_trace_argument_unicode(self):
100
"""Write a Unicode argument to the trace log"""
101
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
102
self.assertContainsRe(self._get_log(keep_log_file=True),
103
'the unicode character')
105
def test_trace_argument_utf8(self):
106
"""Write a Unicode argument to the trace log"""
107
mutter(u'the unicode character for benzene is %s',
108
u'\N{BENZENE RING}'.encode('utf-8'))
109
self.assertContainsRe(self._get_log(keep_log_file=True),
110
'the unicode character')
112
def test_report_broken_pipe(self):
114
raise IOError(errno.EPIPE, 'broken pipe foofofo')
116
msg = _format_exception()
117
self.assertEquals(msg, "bzr: broken pipe\n")
119
self.fail("expected error not raised")
121
def assertLogStartsWith(self, log, string):
122
"""Like assertStartsWith, but skips the log timestamp."""
123
self.assertContainsRe(log,
124
'^\\d+\\.\\d+ ' + re.escape(string))
126
def test_mutter_callsite_1(self):
127
"""mutter_callsite can capture 1 level of stack frame."""
128
mutter_callsite(1, "foo %s", "a string")
129
log = self._get_log(keep_log_file=True)
130
# begin with the message
131
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
132
# should show two frame: this frame and the one above
133
self.assertContainsRe(log,
134
'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
135
# this frame should be the final one
136
self.assertEndsWith(log, ' "a string")\n')
138
def test_mutter_callsite_2(self):
139
"""mutter_callsite can capture 2 levels of stack frame."""
140
mutter_callsite(2, "foo %s", "a string")
141
log = self._get_log(keep_log_file=True)
142
# begin with the message
143
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
144
# should show two frame: this frame and the one above
145
self.assertContainsRe(log,
146
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
147
# this frame should be the final one
148
self.assertEndsWith(log, ' "a string")\n')
150
def test_mutter_never_fails(self):
151
# Even if the decode/encode stage fails, mutter should not
153
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
154
mutter('But fails in an ascii string \xb5')
155
mutter('and in an ascii argument: %s', '\xb5')
156
log = self._get_log(keep_log_file=True)
157
self.assertContainsRe(log, 'Writing a greek mu')
158
self.assertContainsRe(log, "But fails in an ascii string")
159
self.assertContainsRe(log, u"ascii argument: \xb5")
162
class TestVerbosityLevel(TestCase):
164
def test_verbosity_level(self):
165
set_verbosity_level(1)
166
self.assertEqual(1, get_verbosity_level())
167
self.assertTrue(is_verbose())
168
self.assertFalse(is_quiet())
169
set_verbosity_level(-1)
170
self.assertEqual(-1, get_verbosity_level())
171
self.assertFalse(is_verbose())
172
self.assertTrue(is_quiet())
173
set_verbosity_level(0)
174
self.assertEqual(0, get_verbosity_level())
175
self.assertFalse(is_verbose())
176
self.assertFalse(is_quiet())
178
def test_be_quiet(self):
179
# Confirm the old API still works
181
self.assertEqual(-1, get_verbosity_level())
183
self.assertEqual(0, get_verbosity_level())
186
class TestBzrLog(TestCaseInTempDir):
188
def test_log_rollover(self):
189
temp_log_name = 'test-log'
190
trace_file = open(temp_log_name, 'at')
191
trace_file.write('test_log_rollover padding\n' * 1000000)
193
_rollover_trace_maybe(temp_log_name)
194
# should have been rolled over
195
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
