20
19
"""Tests for trace library"""
21
from cStringIO import StringIO
25
31
from bzrlib.tests import TestCaseInTempDir, TestCase
26
from bzrlib.trace import format_exception_short, mutter
27
from bzrlib.errors import NotBranchError, BzrError, BzrNewError
32
from bzrlib.trace import (
33
mutter, mutter_callsite, report_exception,
34
set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
37
_rollover_trace_maybe,
41
def _format_exception():
42
"""Format an exception as it would normally be displayed to the user"""
44
report_exception(sys.exc_info(), buf)
29
48
class TestTrace(TestCase):
30
50
def test_format_sys_exception(self):
31
"""Short formatting of exceptions"""
33
52
raise NotImplementedError, "time travel"
34
53
except NotImplementedError:
36
error_lines = format_exception_short(sys.exc_info()).splitlines()
37
self.assertEqualDiff(error_lines[0],
38
'exceptions.NotImplementedError: time travel')
39
self.assertContainsRe(error_lines[1],
40
r'^ at .*trace\.py line \d+$')
41
self.assertContainsRe(error_lines[2],
42
r'^ in test_format_sys_exception$')
55
err = _format_exception()
56
self.assertEqualDiff(err.splitlines()[0],
57
'bzr: ERROR: exceptions.NotImplementedError: time travel')
58
self.assertContainsRe(err,
59
r'File.*test_trace.py')
61
def test_format_interrupt_exception(self):
63
raise KeyboardInterrupt()
64
except KeyboardInterrupt:
65
# XXX: Some risk that a *real* keyboard interrupt won't be seen
67
msg = _format_exception()
68
self.assertTrue(len(msg) > 0)
69
self.assertEqualDiff(msg, 'bzr: interrupted\n')
71
def test_format_os_error(self):
73
file('nosuchfile22222')
74
except (OSError, IOError):
76
msg = _format_exception()
77
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
79
def test_format_unicode_error(self):
81
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
82
except errors.BzrCommandError:
84
msg = _format_exception()
44
86
def test_format_exception(self):
45
"""Short formatting of exceptions"""
47
raise NotBranchError, 'wibble'
48
except NotBranchError:
50
msg = format_exception_short(sys.exc_info())
51
self.assertEqualDiff(msg, 'Not a branch: wibble')
53
def test_format_old_exception(self):
54
# format a class that doesn't descend from BzrNewError;
55
# remove this test when everything is unified there
56
self.assertFalse(issubclass(BzrError, BzrNewError))
58
raise BzrError('some old error')
61
msg = format_exception_short(sys.exc_info())
62
self.assertEqualDiff(msg, 'some old error')
87
"""Short formatting of bzr exceptions"""
89
raise errors.NotBranchError('wibble')
90
except errors.NotBranchError:
92
msg = _format_exception()
93
self.assertTrue(len(msg) > 0)
94
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
96
def test_report_external_import_error(self):
97
"""Short friendly message for missing system modules."""
99
import ImaginaryModule
100
except ImportError, e:
103
self.fail("somehow succeeded in importing %r" % ImaginaryModule)
104
msg = _format_exception()
105
self.assertEqual(msg,
106
'bzr: ERROR: No module named ImaginaryModule\n'
107
'You may need to install this Python library separately.\n')
109
def test_report_import_syntax_error(self):
111
raise ImportError("syntax error")
112
except ImportError, e:
114
msg = _format_exception()
115
self.assertContainsRe(msg,
116
r"Traceback \(most recent call last\)")
64
118
def test_trace_unicode(self):
65
119
"""Write Unicode to trace log"""
66
120
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
67
self.assertContainsRe('the unicode character',
121
self.assertContainsRe(self._get_log(keep_log_file=True),
122
"the unicode character for benzene is")
124
def test_trace_argument_unicode(self):
125
"""Write a Unicode argument to the trace log"""
126
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
127
self.assertContainsRe(self._get_log(keep_log_file=True),
128
'the unicode character')
130
def test_trace_argument_utf8(self):
131
"""Write a Unicode argument to the trace log"""
132
mutter(u'the unicode character for benzene is %s',
133
u'\N{BENZENE RING}'.encode('utf-8'))
134
self.assertContainsRe(self._get_log(keep_log_file=True),
135
'the unicode character')
137
def test_report_broken_pipe(self):
139
raise IOError(errno.EPIPE, 'broken pipe foofofo')
141
msg = _format_exception()
142
self.assertEquals(msg, "bzr: broken pipe\n")
144
self.fail("expected error not raised")
146
def assertLogStartsWith(self, log, string):
147
"""Like assertStartsWith, but skips the log timestamp."""
148
self.assertContainsRe(log,
149
'^\\d+\\.\\d+ ' + re.escape(string))
151
def test_mutter_callsite_1(self):
152
"""mutter_callsite can capture 1 level of stack frame."""
153
mutter_callsite(1, "foo %s", "a string")
154
log = self._get_log(keep_log_file=True)
155
# begin with the message
156
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
157
# should show two frame: this frame and the one above
158
self.assertContainsRe(log,
159
'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
160
# this frame should be the final one
161
self.assertEndsWith(log, ' "a string")\n')
163
def test_mutter_callsite_2(self):
164
"""mutter_callsite can capture 2 levels of stack frame."""
165
mutter_callsite(2, "foo %s", "a string")
166
log = self._get_log(keep_log_file=True)
167
# begin with the message
168
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
169
# should show two frame: this frame and the one above
170
self.assertContainsRe(log,
171
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
172
# this frame should be the final one
173
self.assertEndsWith(log, ' "a string")\n')
70
175
def test_mutter_never_fails(self):
71
176
# Even if the decode/encode stage fails, mutter should not
72
177
# raise an exception
73
178
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
74
179
mutter('But fails in an ascii string \xb5')
75
# TODO: jam 20051227 mutter() doesn't flush the log file, and
76
# self._get_log() opens the file directly and reads it.
77
# So we need to manually flush the log file
79
bzrlib.trace._trace_file.flush()
180
mutter('and in an ascii argument: %s', '\xb5')
181
log = self._get_log(keep_log_file=True)
81
182
self.assertContainsRe(log, 'Writing a greek mu')
82
self.assertContainsRe(log, 'UnicodeError')
83
self.assertContainsRe(log, "'But fails in an ascii string")
183
self.assertContainsRe(log, "But fails in an ascii string")
184
self.assertContainsRe(log, u"ascii argument: \xb5")
186
def test_push_log_file(self):
187
"""Can push and pop log file, and this catches mutter messages.
189
This is primarily for use in the test framework.
191
tmp1 = tempfile.NamedTemporaryFile()
192
tmp2 = tempfile.NamedTemporaryFile()
194
memento1 = push_log_file(tmp1)
195
mutter("comment to file1")
197
memento2 = push_log_file(tmp2)
199
mutter("comment to file2")
201
pop_log_file(memento2)
202
mutter("again to file1")
204
pop_log_file(memento1)
205
# the files were opened in binary mode, so should have exactly
206
# these bytes. and removing the file as the log target should
207
# have caused them to be flushed out. need to match using regexps
208
# as there's a timestamp at the front.
210
self.assertContainsRe(tmp1.read(),
211
r"\d+\.\d+ comment to file1\n\d+\.\d+ again to file1\n")
213
self.assertContainsRe(tmp2.read(),
214
r"\d+\.\d+ comment to file2\n")
220
class TestVerbosityLevel(TestCase):
222
def test_verbosity_level(self):
223
set_verbosity_level(1)
224
self.assertEqual(1, get_verbosity_level())
225
self.assertTrue(is_verbose())
226
self.assertFalse(is_quiet())
227
set_verbosity_level(-1)
228
self.assertEqual(-1, get_verbosity_level())
229
self.assertFalse(is_verbose())
230
self.assertTrue(is_quiet())
231
set_verbosity_level(0)
232
self.assertEqual(0, get_verbosity_level())
233
self.assertFalse(is_verbose())
234
self.assertFalse(is_quiet())
236
def test_be_quiet(self):
237
# Confirm the old API still works
239
self.assertEqual(-1, get_verbosity_level())
241
self.assertEqual(0, get_verbosity_level())
244
class TestBzrLog(TestCaseInTempDir):
246
def test_log_rollover(self):
247
temp_log_name = 'test-log'
248
trace_file = open(temp_log_name, 'at')
249
trace_file.write('test_log_rollover padding\n' * 1000000)
251
_rollover_trace_maybe(temp_log_name)
252
# should have been rolled over
253
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
