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')
64
96
def test_trace_unicode(self):
65
97
"""Write Unicode to trace log"""
66
98
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
67
self.assertContainsRe('the unicode character',
99
self.assertContainsRe(self._get_log(keep_log_file=True),
100
"the unicode character for benzene is")
102
def test_trace_argument_unicode(self):
103
"""Write a Unicode argument to the trace log"""
104
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
105
self.assertContainsRe(self._get_log(keep_log_file=True),
106
'the unicode character')
108
def test_trace_argument_utf8(self):
109
"""Write a Unicode argument to the trace log"""
110
mutter(u'the unicode character for benzene is %s',
111
u'\N{BENZENE RING}'.encode('utf-8'))
112
self.assertContainsRe(self._get_log(keep_log_file=True),
113
'the unicode character')
115
def test_report_broken_pipe(self):
117
raise IOError(errno.EPIPE, 'broken pipe foofofo')
119
msg = _format_exception()
120
self.assertEquals(msg, "bzr: broken pipe\n")
122
self.fail("expected error not raised")
124
def assertLogStartsWith(self, log, string):
125
"""Like assertStartsWith, but skips the log timestamp."""
126
self.assertContainsRe(log,
127
'^\\d+\\.\\d+ ' + re.escape(string))
129
def test_mutter_callsite_1(self):
130
"""mutter_callsite can capture 1 level of stack frame."""
131
mutter_callsite(1, "foo %s", "a string")
132
log = self._get_log(keep_log_file=True)
133
# begin with the message
134
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
135
# should show two frame: this frame and the one above
136
self.assertContainsRe(log,
137
'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
138
# this frame should be the final one
139
self.assertEndsWith(log, ' "a string")\n')
141
def test_mutter_callsite_2(self):
142
"""mutter_callsite can capture 2 levels of stack frame."""
143
mutter_callsite(2, "foo %s", "a string")
144
log = self._get_log(keep_log_file=True)
145
# begin with the message
146
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
147
# should show two frame: this frame and the one above
148
self.assertContainsRe(log,
149
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
150
# this frame should be the final one
151
self.assertEndsWith(log, ' "a string")\n')
153
def test_mutter_never_fails(self):
154
# Even if the decode/encode stage fails, mutter should not
156
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
157
mutter('But fails in an ascii string \xb5')
158
mutter('and in an ascii argument: %s', '\xb5')
159
log = self._get_log(keep_log_file=True)
160
self.assertContainsRe(log, 'Writing a greek mu')
161
self.assertContainsRe(log, "But fails in an ascii string")
162
self.assertContainsRe(log, u"ascii argument: \xb5")
164
def test_push_log_file(self):
165
"""Can push and pop log file, and this catches mutter messages.
167
This is primarily for use in the test framework.
169
tmp1 = tempfile.NamedTemporaryFile()
170
tmp2 = tempfile.NamedTemporaryFile()
172
memento1 = push_log_file(tmp1)
173
mutter("comment to file1")
175
memento2 = push_log_file(tmp2)
177
mutter("comment to file2")
179
pop_log_file(memento2)
180
mutter("again to file1")
182
pop_log_file(memento1)
183
# the files were opened in binary mode, so should have exactly
184
# these bytes. and removing the file as the log target should
185
# have caused them to be flushed out. need to match using regexps
186
# as there's a timestamp at the front.
188
self.assertContainsRe(tmp1.read(),
189
r"\d+\.\d+ comment to file1\n\d+\.\d+ again to file1\n")
191
self.assertContainsRe(tmp2.read(),
192
r"\d+\.\d+ comment to file2\n")
198
class TestVerbosityLevel(TestCase):
200
def test_verbosity_level(self):
201
set_verbosity_level(1)
202
self.assertEqual(1, get_verbosity_level())
203
self.assertTrue(is_verbose())
204
self.assertFalse(is_quiet())
205
set_verbosity_level(-1)
206
self.assertEqual(-1, get_verbosity_level())
207
self.assertFalse(is_verbose())
208
self.assertTrue(is_quiet())
209
set_verbosity_level(0)
210
self.assertEqual(0, get_verbosity_level())
211
self.assertFalse(is_verbose())
212
self.assertFalse(is_quiet())
214
def test_be_quiet(self):
215
# Confirm the old API still works
217
self.assertEqual(-1, get_verbosity_level())
219
self.assertEqual(0, get_verbosity_level())
222
class TestBzrLog(TestCaseInTempDir):
224
def test_log_rollover(self):
225
temp_log_name = 'test-log'
226
trace_file = open(temp_log_name, 'at')
227
trace_file.write('test_log_rollover padding\n' * 1000000)
229
_rollover_trace_maybe(temp_log_name)
230
# should have been rolled over
231
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
