1
# Copyright (C) 2005-2011 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
28
28
from bzrlib import (
33
from bzrlib.tests import features, TestCaseInTempDir, TestCase
31
from bzrlib.tests import TestCaseInTempDir, TestCase
34
32
from bzrlib.trace import (
35
33
mutter, mutter_callsite, report_exception,
36
34
set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
39
37
_rollover_trace_maybe,
51
48
class TestTrace(TestCase):
53
50
def test_format_sys_exception(self):
54
# Test handling of an internal/unexpected error that probably
55
# indicates a bug in bzr. The details of the message may vary
56
# depending on whether apport is available or not. See test_crash for
59
52
raise NotImplementedError, "time travel"
60
53
except NotImplementedError:
63
56
self.assertEqualDiff(err.splitlines()[0],
64
57
'bzr: ERROR: exceptions.NotImplementedError: time travel')
65
58
self.assertContainsRe(err,
66
'Bazaar has encountered an internal error.')
59
r'File.*test_trace.py')
68
61
def test_format_interrupt_exception(self):
75
68
self.assertTrue(len(msg) > 0)
76
69
self.assertEqualDiff(msg, 'bzr: interrupted\n')
78
def test_format_memory_error(self):
83
msg = _format_exception()
84
self.assertEquals(msg,
85
"bzr: out of memory\nUse -Dmem_dump to dump memory to a file.\n")
87
def test_format_mem_dump(self):
88
self.requireFeature(features.meliae)
89
debug.debug_flags.add('mem_dump')
94
msg = _format_exception()
95
self.assertStartsWith(msg,
96
"bzr: out of memory\nMemory dumped to ")
98
71
def test_format_os_error(self):
100
73
os.rmdir('nosuchfile22222')
103
76
msg = _format_exception()
104
# Linux seems to give "No such file" but Windows gives "The system
105
# cannot find the file specified".
106
self.assertEqual('bzr: ERROR: %s\n' % (e_str,), msg)
77
self.assertContainsRe(msg,
78
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile22222')
108
80
def test_format_io_error(self):
113
85
msg = _format_exception()
114
# Even though Windows and Linux differ for 'os.rmdir', they both give
115
# 'No such file' for open()
116
self.assertContainsRe(msg,
117
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
119
def test_format_pywintypes_error(self):
120
self.requireFeature(features.pywintypes)
121
import pywintypes, win32file
123
win32file.RemoveDirectory('nosuchfile22222')
124
except pywintypes.error:
126
msg = _format_exception()
127
# GZ 2010-05-03: Formatting for pywintypes.error is basic, a 3-tuple
128
# with errno, function name, and locale error message
129
self.assertContainsRe(msg,
130
r"^bzr: ERROR: \(2, 'RemoveDirectory[AW]?', .*\)")
132
def test_format_sockets_error(self):
135
sock = socket.socket()
136
sock.send("This should fail.")
139
msg = _format_exception()
141
self.assertNotContainsRe(msg,
142
r"Traceback (most recent call last):")
86
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
144
88
def test_format_unicode_error(self):
179
123
msg = _format_exception()
180
124
self.assertContainsRe(msg,
181
r'Bazaar has encountered an internal error')
125
r"Traceback \(most recent call last\)")
183
127
def test_trace_unicode(self):
184
128
"""Write Unicode to trace log"""
185
129
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
187
self.assertContainsRe(log, "the unicode character for benzene is")
130
self.assertContainsRe(self._get_log(keep_log_file=True),
131
"the unicode character for benzene is")
189
133
def test_trace_argument_unicode(self):
190
134
"""Write a Unicode argument to the trace log"""
191
135
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
193
self.assertContainsRe(log, 'the unicode character')
136
self.assertContainsRe(self._get_log(keep_log_file=True),
137
'the unicode character')
195
139
def test_trace_argument_utf8(self):
196
140
"""Write a Unicode argument to the trace log"""
197
141
mutter(u'the unicode character for benzene is %s',
198
142
u'\N{BENZENE RING}'.encode('utf-8'))
200
self.assertContainsRe(log, 'the unicode character')
143
self.assertContainsRe(self._get_log(keep_log_file=True),
144
'the unicode character')
202
146
def test_report_broken_pipe(self):
216
160
def test_mutter_callsite_1(self):
217
161
"""mutter_callsite can capture 1 level of stack frame."""
218
162
mutter_callsite(1, "foo %s", "a string")
163
log = self._get_log(keep_log_file=True)
220
164
# begin with the message
221
165
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
222
166
# should show two frame: this frame and the one above
228
172
def test_mutter_callsite_2(self):
229
173
"""mutter_callsite can capture 2 levels of stack frame."""
230
174
mutter_callsite(2, "foo %s", "a string")
175
log = self._get_log(keep_log_file=True)
232
176
# begin with the message
233
177
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
234
178
# should show two frame: this frame and the one above
240
184
def test_mutter_never_fails(self):
241
185
# Even if the decode/encode stage fails, mutter should not
242
186
# raise an exception
243
# This test checks that mutter doesn't fail; the current behaviour
244
# is that it doesn't fail *and writes non-utf8*.
245
187
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
246
188
mutter('But fails in an ascii string \xb5')
247
189
mutter('and in an ascii argument: %s', '\xb5')
190
log = self._get_log(keep_log_file=True)
249
191
self.assertContainsRe(log, 'Writing a greek mu')
250
192
self.assertContainsRe(log, "But fails in an ascii string")
251
# However, the log content object does unicode replacement on reading
252
# to let it get unicode back where good data has been written. So we
253
# have to do a replaceent here as well.
254
self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
257
def test_show_error(self):
259
show_error(u'error2 \xb5 blah')
260
show_error('arg: %s', 'blah')
261
show_error('arg2: %(key)s', {'key':'stuff'})
263
raise Exception("oops")
265
show_error('kwarg', exc_info=True)
267
self.assertContainsRe(log, 'error1')
268
self.assertContainsRe(log, u'error2 \xb5 blah')
269
self.assertContainsRe(log, 'arg: blah')
270
self.assertContainsRe(log, 'arg2: stuff')
271
self.assertContainsRe(log, 'kwarg')
272
self.assertContainsRe(log, 'Traceback \\(most recent call last\\):')
273
self.assertContainsRe(log, 'File ".*test_trace.py", line .*, in test_show_error')
274
self.assertContainsRe(log, 'raise Exception\\("oops"\\)')
275
self.assertContainsRe(log, 'Exception: oops')
193
self.assertContainsRe(log, u"ascii argument: \xb5")
277
195
def test_push_log_file(self):
278
196
"""Can push and pop log file, and this catches mutter messages.
310
def test__open_bzr_log_uses_stderr_for_failures(self):
311
# If _open_bzr_log cannot open the file, then we should write the
312
# warning to stderr. Since this is normally happening before logging is
314
self.overrideAttr(sys, 'stderr', StringIO())
315
# Set the log file to something that cannot exist
316
self.overrideEnv('BZR_LOG', os.getcwd() + '/no-dir/bzr.log')
317
self.overrideAttr(trace, '_bzr_log_filename')
318
logf = trace._open_bzr_log()
319
self.assertIs(None, logf)
320
self.assertContainsRe(sys.stderr.getvalue(),
321
'failed to open trace file: .*/no-dir/bzr.log')
324
229
class TestVerbosityLevel(TestCase):
350
255
def test_log_rollover(self):
351
256
temp_log_name = 'test-log'
352
257
trace_file = open(temp_log_name, 'at')
353
trace_file.writelines(['test_log_rollover padding\n'] * 200000)
258
trace_file.write('test_log_rollover padding\n' * 1000000)
354
259
trace_file.close()
355
260
_rollover_trace_maybe(temp_log_name)
356
261
# should have been rolled over
357
262
self.assertFalse(os.access(temp_log_name, os.R_OK))
360
class TestTraceConfiguration(TestCaseInTempDir):
362
def test_default_config(self):
363
config = trace.DefaultConfig()
364
self.overrideAttr(trace, "_bzr_log_filename", None)
365
trace._bzr_log_filename = None
366
expected_filename = trace._get_bzr_log_filename()
367
self.assertEqual(None, trace._bzr_log_filename)
370
# Should have entered and setup a default filename.
371
self.assertEqual(expected_filename, trace._bzr_log_filename)
373
config.__exit__(None, None, None)
374
# Should have exited and cleaned up.
375
self.assertEqual(None, trace._bzr_log_filename)