20
19
"""Tests for trace library"""
21
from cStringIO import StringIO
25
29
from bzrlib.tests import TestCaseInTempDir, TestCase
26
from bzrlib.trace import format_exception_short, mutter
27
from bzrlib.errors import NotBranchError, BzrError, BzrNewError
30
from bzrlib.trace import (
31
mutter, mutter_callsite, report_exception,
32
set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
33
_rollover_trace_maybe,
37
def _format_exception():
38
"""Format an exception as it would normally be displayed to the user"""
40
report_exception(sys.exc_info(), buf)
29
44
class TestTrace(TestCase):
30
46
def test_format_sys_exception(self):
31
"""Short formatting of exceptions"""
33
48
raise NotImplementedError, "time travel"
34
49
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$')
51
err = _format_exception()
52
self.assertEqualDiff(err.splitlines()[0],
53
'bzr: ERROR: exceptions.NotImplementedError: time travel')
54
self.assertContainsRe(err,
55
r'File.*test_trace.py')
57
def test_format_interrupt_exception(self):
59
raise KeyboardInterrupt()
60
except KeyboardInterrupt:
61
# XXX: Some risk that a *real* keyboard interrupt won't be seen
63
msg = _format_exception()
64
self.assertTrue(len(msg) > 0)
65
self.assertEqualDiff(msg, 'bzr: interrupted\n')
67
def test_format_os_error(self):
69
file('nosuchfile22222')
70
except (OSError, IOError):
72
msg = _format_exception()
73
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
75
def test_format_unicode_error(self):
77
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
78
except errors.BzrCommandError:
80
msg = _format_exception()
44
82
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')
83
"""Short formatting of bzr exceptions"""
85
raise errors.NotBranchError('wibble')
86
except errors.NotBranchError:
88
msg = _format_exception()
89
self.assertTrue(len(msg) > 0)
90
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
64
92
def test_trace_unicode(self):
65
93
"""Write Unicode to trace log"""
66
94
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
67
self.assertContainsRe('the unicode character',
95
self.assertContainsRe(self._get_log(keep_log_file=True),
96
"the unicode character for benzene is")
98
def test_trace_argument_unicode(self):
99
"""Write a Unicode argument to the trace log"""
100
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
101
self.assertContainsRe(self._get_log(keep_log_file=True),
102
'the unicode character')
104
def test_trace_argument_utf8(self):
105
"""Write a Unicode argument to the trace log"""
106
mutter(u'the unicode character for benzene is %s',
107
u'\N{BENZENE RING}'.encode('utf-8'))
108
self.assertContainsRe(self._get_log(keep_log_file=True),
109
'the unicode character')
111
def test_report_broken_pipe(self):
113
raise IOError(errno.EPIPE, 'broken pipe foofofo')
115
msg = _format_exception()
116
self.assertEquals(msg, "bzr: broken pipe\n")
118
self.fail("expected error not raised")
120
def test_mutter_callsite_1(self):
121
"""mutter_callsite can capture 1 level of stack frame."""
122
mutter_callsite(1, "foo %s", "a string")
123
log = self._get_log(keep_log_file=True)
124
# begin with the message
125
self.assertStartsWith(log, 'foo a string\nCalled from:\n')
126
# should show two frame: this frame and the one above
127
self.assertContainsRe(log,
128
'test_trace\.py", line \d+, in test_mutter_callsite_1\n')
129
# this frame should be the final one
130
self.assertEndsWith(log, ' "a string")\n')
132
def test_mutter_callsite_2(self):
133
"""mutter_callsite can capture 2 levels of stack frame."""
134
mutter_callsite(2, "foo %s", "a string")
135
log = self._get_log(keep_log_file=True)
136
# begin with the message
137
self.assertStartsWith(log, 'foo a string\nCalled from:\n')
138
# should show two frame: this frame and the one above
139
self.assertContainsRe(log,
140
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
141
# this frame should be the final one
142
self.assertEndsWith(log, ' "a string")\n')
144
def test_mutter_never_fails(self):
145
# Even if the decode/encode stage fails, mutter should not
147
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
148
mutter('But fails in an ascii string \xb5')
149
mutter('and in an ascii argument: %s', '\xb5')
150
log = self._get_log(keep_log_file=True)
151
self.assertContainsRe(log, 'Writing a greek mu')
152
self.assertContainsRe(log, "But fails in an ascii string")
153
self.assertContainsRe(log, u"ascii argument: \xb5")
156
class TestVerbosityLevel(TestCase):
158
def test_verbosity_level(self):
159
set_verbosity_level(1)
160
self.assertEqual(1, get_verbosity_level())
161
self.assertTrue(is_verbose())
162
self.assertFalse(is_quiet())
163
set_verbosity_level(-1)
164
self.assertEqual(-1, get_verbosity_level())
165
self.assertFalse(is_verbose())
166
self.assertTrue(is_quiet())
167
set_verbosity_level(0)
168
self.assertEqual(0, get_verbosity_level())
169
self.assertFalse(is_verbose())
170
self.assertFalse(is_quiet())
172
def test_be_quiet(self):
173
# Confirm the old API still works
175
self.assertEqual(-1, get_verbosity_level())
177
self.assertEqual(0, get_verbosity_level())
180
class TestBzrLog(TestCaseInTempDir):
182
def test_log_rollover(self):
183
temp_log_name = 'test-log'
184
trace_file = open(temp_log_name, 'at')
185
trace_file.write('test_log_rollover padding\n' * 1000000)
187
_rollover_trace_maybe(temp_log_name)
188
# should have been rolled over
189
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
