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 mutter, report_exception
33
def _format_exception():
34
"""Format an exception as it would normally be displayed to the user"""
36
report_exception(sys.exc_info(), buf)
29
40
class TestTrace(TestCase):
30
42
def test_format_sys_exception(self):
31
"""Short formatting of exceptions"""
33
44
raise NotImplementedError, "time travel"
34
45
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$')
47
err = _format_exception()
48
self.assertEqualDiff(err.splitlines()[0],
49
'bzr: ERROR: exceptions.NotImplementedError: time travel')
50
self.assertContainsRe(err,
51
r'File.*test_trace.py')
53
def test_format_interrupt_exception(self):
55
raise KeyboardInterrupt()
56
except KeyboardInterrupt:
57
# XXX: Some risk that a *real* keyboard interrupt won't be seen
59
msg = _format_exception()
60
self.assertTrue(len(msg) > 0)
61
self.assertEqualDiff(msg, 'bzr: interrupted\n')
63
def test_format_os_error(self):
65
file('nosuchfile22222')
66
except (OSError, IOError):
68
msg = _format_exception()
69
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
71
def test_format_unicode_error(self):
73
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
74
except errors.BzrCommandError:
76
msg = _format_exception()
44
78
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')
79
"""Short formatting of bzr exceptions"""
81
raise errors.NotBranchError, 'wibble'
82
except errors.NotBranchError:
84
msg = _format_exception()
85
self.assertTrue(len(msg) > 0)
86
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: wibble\n')
64
88
def test_trace_unicode(self):
65
89
"""Write Unicode to trace log"""
66
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
67
self.assertContainsRe('the unicode character',
90
mutter(u'the unicode character for benzene is \N{BENZENE RING}')
91
self._log_file.flush()
92
self.assertContainsRe(self._get_log(), 'the unicode character',)
94
def test_trace_argument_unicode(self):
95
"""Write a Unicode argument to the trace log"""
96
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
97
self._log_file.flush()
98
self.assertContainsRe(self._get_log(), 'the unicode character')
100
def test_trace_argument_utf8(self):
101
"""Write a Unicode argument to the trace log"""
102
mutter(u'the unicode character for benzene is %s',
103
u'\N{BENZENE RING}'.encode('utf-8'))
104
self._log_file.flush()
105
self.assertContainsRe(self._get_log(), 'the unicode character')
107
def test_report_broken_pipe(self):
109
raise IOError(errno.EPIPE, 'broken pipe foofofo')
111
msg = _format_exception()
112
self.assertEquals(msg, "bzr: broken pipe\n")
114
self.fail("expected error not raised")
116
def test_mutter_never_fails(self):
117
# Even if the decode/encode stage fails, mutter should not
119
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
120
mutter('But fails in an ascii string \xb5')
121
mutter('and in an ascii argument: %s', '\xb5')
122
# TODO: jam 20051227 mutter() doesn't flush the log file, and
123
# self._get_log() opens the file directly and reads it.
124
# So we need to manually flush the log file
125
self._log_file.flush()
126
log = self._get_log()
127
self.assertContainsRe(log, 'Writing a greek mu')
128
self.assertContainsRe(log, "But fails in an ascii string")
129
self.assertContainsRe(log, u"ascii argument: \xb5")