20
19
"""Tests for trace library"""
21
from cStringIO import StringIO
25
from bzrlib.tests import TestCaseInTempDir, TestCase
26
from bzrlib.trace import format_exception_short, mutter
27
from bzrlib.errors import NotBranchError, BzrError, BzrNewError
31
from bzrlib.tests import TestCaseInTempDir, TestCase, TestSkipped
32
from bzrlib.trace import mutter, report_exception
35
def _format_exception():
36
"""Format an exception as it would normally be displayed to the user"""
38
report = report_exception(sys.exc_info(), buf)
39
return buf.getvalue(), report
29
42
class TestTrace(TestCase):
30
def test_format_sys_exception(self):
31
"""Short formatting of exceptions"""
33
raise NotImplementedError, "time travel"
34
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$')
44
def test_format_sys_exception_no_apport(self):
46
raise NotImplementedError, "time travel"
47
except NotImplementedError:
49
old_use_apport = trace._use_apport
50
trace._use_apport = False
52
err, report = _format_exception()
54
trace._use_apport = old_use_apport
55
self.assertEqual(None, report)
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_sys_exception_apport(self):
65
raise TestSkipped('Apport not installed')
67
raise NotImplementedError, "time travel"
68
except NotImplementedError:
71
sys.argv = ['foo', 'bar', 'quux']
73
err, (report, report_filename) = _format_exception()
76
self.assertIsInstance(report, problem_report.ProblemReport)
77
# the error formatting is checked by the blackbox ui command.
78
# here we need to check that the file on disk - the problem report
79
# will contain the right information.
85
# check the report logical data.
86
self.assertEqual('foo bar quux', report['CommandLine'])
87
known_plugins = ' '.join(plugin.all_plugins())
88
self.assertEqual(known_plugins, report['BzrPlugins'])
89
self.assertContainsRe(report['Traceback'], r'Traceback')
90
# Stock apport facilities we just invoke, no need to test their
92
self.assertNotEqual(None, report['Package'])
93
self.assertNotEqual(None, report['Uname'])
94
# check the file 'looks' like a good file, because we dont
95
# want apport changes to break the user interface.
96
report_file = file(report_filename, 'r')
98
report_text = report_file.read()
101
# so we check this by looking across two fields and they should
102
# be just \n separated.
103
self.assertTrue('ProblemType: Crash\n'
104
'BzrPlugins: ' in report_text)
106
def test_format_interrupt_exception(self):
108
raise KeyboardInterrupt()
109
except KeyboardInterrupt:
110
# XXX: Some risk that a *real* keyboard interrupt won't be seen
111
# We can probably detect that by checking for the specific line
112
# that we raise from in the test being in the backtrace.
114
msg, report = _format_exception()
115
self.assertTrue(len(msg) > 0)
116
self.assertEqualDiff(msg, 'bzr: interrupted\n')
118
def test_format_os_error(self):
120
file('nosuchfile22222')
121
except (OSError, IOError):
123
msg, report = _format_exception()
124
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
126
def test_format_unicode_error(self):
128
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
129
except errors.BzrCommandError:
131
msg, report = _format_exception()
44
133
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')
134
"""Short formatting of bzr exceptions"""
136
raise errors.NotBranchError('wibble')
137
except errors.NotBranchError:
139
msg, report = _format_exception()
140
self.assertTrue(len(msg) > 0)
141
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: wibble\n')
64
143
def test_trace_unicode(self):
65
144
"""Write Unicode to trace log"""
66
145
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
67
self.assertContainsRe('the unicode character',
146
self.assertContainsRe(self._get_log(keep_log_file=True),
147
"the unicode character for benzene is")
149
def test_trace_argument_unicode(self):
150
"""Write a Unicode argument to the trace log"""
151
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
152
self.assertContainsRe(self._get_log(keep_log_file=True),
153
'the unicode character')
155
def test_trace_argument_utf8(self):
156
"""Write a Unicode argument to the trace log"""
157
mutter(u'the unicode character for benzene is %s',
158
u'\N{BENZENE RING}'.encode('utf-8'))
159
self.assertContainsRe(self._get_log(keep_log_file=True),
160
'the unicode character')
162
def test_report_broken_pipe(self):
164
raise IOError(errno.EPIPE, 'broken pipe foofofo')
166
msg, report = _format_exception()
167
self.assertEquals(msg, "bzr: broken pipe\n")
169
self.fail("expected error not raised")
171
def test_mutter_never_fails(self):
172
# Even if the decode/encode stage fails, mutter should not
174
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
175
mutter('But fails in an ascii string \xb5')
176
mutter('and in an ascii argument: %s', '\xb5')
177
log = self._get_log(keep_log_file=True)
178
self.assertContainsRe(log, 'Writing a greek mu')
179
self.assertContainsRe(log, "But fails in an ascii string")
180
self.assertContainsRe(log, u"ascii argument: \xb5")
added
removed
bzrlib/tests/test_trace.py
