1
# Copyright (C) 2005, 2006 by Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# "weren't nothing promised to you. do i look like i got a promise face?"
19
"""Tests for trace library"""
21
from cStringIO import StringIO
29
from bzrlib.tests import TestCaseInTempDir, TestCase
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)
40
class TestTrace(TestCase):
42
def test_format_sys_exception(self):
44
raise NotImplementedError, "time travel"
45
except NotImplementedError:
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()
78
def test_format_exception(self):
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')
88
def test_trace_unicode(self):
89
"""Write Unicode to trace log"""
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")