1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
# "weren't nothing promised to you. do i look like i got a promise face?"
28
28
from bzrlib import (
32
from bzrlib.tests import TestCaseInTempDir, TestCase, ModuleAvailableFeature
31
from bzrlib.tests import TestCaseInTempDir, TestCase
33
32
from bzrlib.trace import (
34
33
mutter, mutter_callsite, report_exception,
35
34
set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
38
37
_rollover_trace_maybe,
50
48
class TestTrace(TestCase):
52
50
def test_format_sys_exception(self):
53
# Test handling of an internal/unexpected error that probably
54
# indicates a bug in bzr. The details of the message may vary
55
# depending on whether apport is available or not. See test_crash for
58
52
raise NotImplementedError, "time travel"
59
53
except NotImplementedError:
62
56
self.assertEqualDiff(err.splitlines()[0],
63
57
'bzr: ERROR: exceptions.NotImplementedError: time travel')
64
58
self.assertContainsRe(err,
65
'Bazaar has encountered an internal error.')
59
r'File.*test_trace.py')
67
61
def test_format_interrupt_exception(self):
74
68
self.assertTrue(len(msg) > 0)
75
69
self.assertEqualDiff(msg, 'bzr: interrupted\n')
77
def test_format_memory_error(self):
82
msg = _format_exception()
83
self.assertEquals(msg,
84
"bzr: out of memory\n")
86
71
def test_format_os_error(self):
88
os.rmdir('nosuchfile22222')
91
msg = _format_exception()
92
# Linux seems to give "No such file" but Windows gives "The system
93
# cannot find the file specified".
94
self.assertEqual('bzr: ERROR: %s\n' % (e_str,), msg)
96
def test_format_io_error(self):
98
73
file('nosuchfile22222')
101
msg = _format_exception()
102
# Even though Windows and Linux differ for 'os.rmdir', they both give
103
# 'No such file' for open()
104
self.assertContainsRe(msg,
105
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
107
def test_format_pywintypes_error(self):
108
self.requireFeature(ModuleAvailableFeature("pywintypes"))
109
import pywintypes, win32file
111
win32file.RemoveDirectory('nosuchfile22222')
112
except pywintypes.error:
114
msg = _format_exception()
115
# GZ 2010-05-03: Formatting for pywintypes.error is basic, a 3-tuple
116
# with errno, function name, and locale error message
117
self.assertContainsRe(msg,
118
r"^bzr: ERROR: \(2, 'RemoveDirectory[AW]?', .*\)")
74
except (OSError, IOError):
76
msg = _format_exception()
77
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
120
79
def test_format_unicode_error(self):
155
114
msg = _format_exception()
156
115
self.assertContainsRe(msg,
157
r'Bazaar has encountered an internal error')
116
r"Traceback \(most recent call last\)")
159
118
def test_trace_unicode(self):
160
119
"""Write Unicode to trace log"""
161
120
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
163
self.assertContainsRe(log, "the unicode character for benzene is")
121
self.assertContainsRe(self._get_log(keep_log_file=True),
122
"the unicode character for benzene is")
165
124
def test_trace_argument_unicode(self):
166
125
"""Write a Unicode argument to the trace log"""
167
126
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
169
self.assertContainsRe(log, 'the unicode character')
127
self.assertContainsRe(self._get_log(keep_log_file=True),
128
'the unicode character')
171
130
def test_trace_argument_utf8(self):
172
131
"""Write a Unicode argument to the trace log"""
173
132
mutter(u'the unicode character for benzene is %s',
174
133
u'\N{BENZENE RING}'.encode('utf-8'))
176
self.assertContainsRe(log, 'the unicode character')
134
self.assertContainsRe(self._get_log(keep_log_file=True),
135
'the unicode character')
178
137
def test_report_broken_pipe(self):
192
151
def test_mutter_callsite_1(self):
193
152
"""mutter_callsite can capture 1 level of stack frame."""
194
153
mutter_callsite(1, "foo %s", "a string")
154
log = self._get_log(keep_log_file=True)
196
155
# begin with the message
197
156
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
198
157
# should show two frame: this frame and the one above
204
163
def test_mutter_callsite_2(self):
205
164
"""mutter_callsite can capture 2 levels of stack frame."""
206
165
mutter_callsite(2, "foo %s", "a string")
166
log = self._get_log(keep_log_file=True)
208
167
# begin with the message
209
168
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
210
169
# should show two frame: this frame and the one above
216
175
def test_mutter_never_fails(self):
217
176
# Even if the decode/encode stage fails, mutter should not
218
177
# raise an exception
219
# This test checks that mutter doesn't fail; the current behaviour
220
# is that it doesn't fail *and writes non-utf8*.
221
178
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
222
179
mutter('But fails in an ascii string \xb5')
223
180
mutter('and in an ascii argument: %s', '\xb5')
181
log = self._get_log(keep_log_file=True)
225
182
self.assertContainsRe(log, 'Writing a greek mu')
226
183
self.assertContainsRe(log, "But fails in an ascii string")
227
# However, the log content object does unicode replacement on reading
228
# to let it get unicode back where good data has been written. So we
229
# have to do a replaceent here as well.
230
self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
233
def test_show_error(self):
235
show_error(u'error2 \xb5 blah')
236
show_error('arg: %s', 'blah')
237
show_error('arg2: %(key)s', {'key':'stuff'})
239
raise Exception("oops")
241
show_error('kwarg', exc_info=True)
243
self.assertContainsRe(log, 'error1')
244
self.assertContainsRe(log, u'error2 \xb5 blah')
245
self.assertContainsRe(log, 'arg: blah')
246
self.assertContainsRe(log, 'arg2: stuff')
247
self.assertContainsRe(log, 'kwarg')
248
self.assertContainsRe(log, 'Traceback \\(most recent call last\\):')
249
self.assertContainsRe(log, 'File ".*test_trace.py", line .*, in test_show_error')
250
self.assertContainsRe(log, 'raise Exception\\("oops"\\)')
251
self.assertContainsRe(log, 'Exception: oops')
184
self.assertContainsRe(log, u"ascii argument: \xb5")
253
186
def test_push_log_file(self):
254
187
"""Can push and pop log file, and this catches mutter messages.
286
def test__open_bzr_log_uses_stderr_for_failures(self):
287
# If _open_bzr_log cannot open the file, then we should write the
288
# warning to stderr. Since this is normally happening before logging is
290
self.overrideAttr(sys, 'stderr', StringIO())
291
# Set the log file to something that cannot exist
292
# FIXME: A bit dangerous: we are not in an isolated dir here -- vilajam
294
os.environ['BZR_LOG'] = os.getcwd() + '/no-dir/bzr.log'
295
self.overrideAttr(trace, '_bzr_log_filename')
296
logf = trace._open_bzr_log()
297
self.assertIs(None, logf)
298
self.assertContainsRe(sys.stderr.getvalue(),
299
'failed to open trace file: .*/no-dir/bzr.log')
302
220
class TestVerbosityLevel(TestCase):
328
246
def test_log_rollover(self):
329
247
temp_log_name = 'test-log'
330
248
trace_file = open(temp_log_name, 'at')
331
trace_file.writelines(['test_log_rollover padding\n'] * 200000)
249
trace_file.write('test_log_rollover padding\n' * 1000000)
332
250
trace_file.close()
333
251
_rollover_trace_maybe(temp_log_name)
334
252
# should have been rolled over