1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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,
75
72
self.assertTrue(len(msg) > 0)
76
73
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
75
def test_format_os_error(self):
100
77
os.rmdir('nosuchfile22222')
103
80
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)
81
self.assertContainsRe(msg,
82
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile22222')
108
84
def test_format_io_error(self):
113
89
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]?', .*\)")
90
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
132
92
def test_format_unicode_error(self):
171
131
def test_trace_unicode(self):
172
132
"""Write Unicode to trace log"""
173
133
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
175
self.assertContainsRe(log, "the unicode character for benzene is")
134
self.assertContainsRe(self._get_log(keep_log_file=True),
135
"the unicode character for benzene is")
177
137
def test_trace_argument_unicode(self):
178
138
"""Write a Unicode argument to the trace log"""
179
139
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
181
self.assertContainsRe(log, 'the unicode character')
140
self.assertContainsRe(self._get_log(keep_log_file=True),
141
'the unicode character')
183
143
def test_trace_argument_utf8(self):
184
144
"""Write a Unicode argument to the trace log"""
185
145
mutter(u'the unicode character for benzene is %s',
186
146
u'\N{BENZENE RING}'.encode('utf-8'))
188
self.assertContainsRe(log, 'the unicode character')
147
self.assertContainsRe(self._get_log(keep_log_file=True),
148
'the unicode character')
190
150
def test_report_broken_pipe(self):
204
164
def test_mutter_callsite_1(self):
205
165
"""mutter_callsite can capture 1 level of stack frame."""
206
166
mutter_callsite(1, "foo %s", "a string")
167
log = self._get_log(keep_log_file=True)
208
168
# begin with the message
209
169
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
210
170
# should show two frame: this frame and the one above
216
176
def test_mutter_callsite_2(self):
217
177
"""mutter_callsite can capture 2 levels of stack frame."""
218
178
mutter_callsite(2, "foo %s", "a string")
179
log = self._get_log(keep_log_file=True)
220
180
# begin with the message
221
181
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
222
182
# should show two frame: this frame and the one above
228
188
def test_mutter_never_fails(self):
229
189
# Even if the decode/encode stage fails, mutter should not
230
190
# raise an exception
231
# This test checks that mutter doesn't fail; the current behaviour
232
# is that it doesn't fail *and writes non-utf8*.
233
191
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
234
192
mutter('But fails in an ascii string \xb5')
235
193
mutter('and in an ascii argument: %s', '\xb5')
194
log = self._get_log(keep_log_file=True)
237
195
self.assertContainsRe(log, 'Writing a greek mu')
238
196
self.assertContainsRe(log, "But fails in an ascii string")
239
# However, the log content object does unicode replacement on reading
240
# to let it get unicode back where good data has been written. So we
241
# have to do a replaceent here as well.
242
self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
245
def test_show_error(self):
247
show_error(u'error2 \xb5 blah')
248
show_error('arg: %s', 'blah')
249
show_error('arg2: %(key)s', {'key':'stuff'})
251
raise Exception("oops")
253
show_error('kwarg', exc_info=True)
255
self.assertContainsRe(log, 'error1')
256
self.assertContainsRe(log, u'error2 \xb5 blah')
257
self.assertContainsRe(log, 'arg: blah')
258
self.assertContainsRe(log, 'arg2: stuff')
259
self.assertContainsRe(log, 'kwarg')
260
self.assertContainsRe(log, 'Traceback \\(most recent call last\\):')
261
self.assertContainsRe(log, 'File ".*test_trace.py", line .*, in test_show_error')
262
self.assertContainsRe(log, 'raise Exception\\("oops"\\)')
263
self.assertContainsRe(log, 'Exception: oops')
197
self.assertContainsRe(log, u"ascii argument: \xb5")
265
199
def test_push_log_file(self):
266
200
"""Can push and pop log file, and this catches mutter messages.
298
def test__open_bzr_log_uses_stderr_for_failures(self):
299
# If _open_bzr_log cannot open the file, then we should write the
300
# warning to stderr. Since this is normally happening before logging is
302
self.overrideAttr(sys, 'stderr', StringIO())
303
# Set the log file to something that cannot exist
304
self.overrideEnv('BZR_LOG', os.getcwd() + '/no-dir/bzr.log')
305
self.overrideAttr(trace, '_bzr_log_filename')
306
logf = trace._open_bzr_log()
307
self.assertIs(None, logf)
308
self.assertContainsRe(sys.stderr.getvalue(),
309
'failed to open trace file: .*/no-dir/bzr.log')
312
233
class TestVerbosityLevel(TestCase):
338
259
def test_log_rollover(self):
339
260
temp_log_name = 'test-log'
340
261
trace_file = open(temp_log_name, 'at')
341
trace_file.writelines(['test_log_rollover padding\n'] * 200000)
262
trace_file.write('test_log_rollover padding\n' * 1000000)
342
263
trace_file.close()
343
264
_rollover_trace_maybe(temp_log_name)
344
265
# should have been rolled over
345
266
self.assertFalse(os.access(temp_log_name, os.R_OK))
348
class TestTraceConfiguration(TestCaseInTempDir):
350
def test_default_config(self):
351
config = trace.DefaultConfig()
352
self.overrideAttr(trace, "_bzr_log_filename", None)
353
trace._bzr_log_filename = None
354
expected_filename = trace._get_bzr_log_filename()
355
self.assertEqual(None, trace._bzr_log_filename)
358
# Should have entered and setup a default filename.
359
self.assertEqual(expected_filename, trace._bzr_log_filename)
361
config.__exit__(None, None, None)
362
# Should have exited and cleaned up.
363
self.assertEqual(None, trace._bzr_log_filename)