1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
32
from bzrlib.tests import TestCaseInTempDir, TestCase
33
from bzrlib.trace import (
34
mutter, mutter_callsite, report_exception,
35
set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
38
_rollover_trace_maybe,
42
def _format_exception():
43
"""Format an exception as it would normally be displayed to the user"""
45
report_exception(sys.exc_info(), buf)
49
class TestTrace(TestCase):
51
def test_format_sys_exception(self):
52
# Test handling of an internal/unexpected error that probably
53
# indicates a bug in bzr. The details of the message may vary
54
# depending on whether apport is available or not. See test_crash for
57
raise NotImplementedError, "time travel"
58
except NotImplementedError:
60
err = _format_exception()
61
self.assertEqualDiff(err.splitlines()[0],
62
'bzr: ERROR: exceptions.NotImplementedError: time travel')
63
self.assertContainsRe(err,
64
'Bazaar has encountered an internal error.')
66
def test_format_interrupt_exception(self):
68
raise KeyboardInterrupt()
69
except KeyboardInterrupt:
70
# XXX: Some risk that a *real* keyboard interrupt won't be seen
72
msg = _format_exception()
73
self.assertTrue(len(msg) > 0)
74
self.assertEqualDiff(msg, 'bzr: interrupted\n')
76
def test_format_memory_error(self):
81
msg = _format_exception()
82
self.assertEquals(msg,
83
"bzr: out of memory\n")
85
def test_format_os_error(self):
87
os.rmdir('nosuchfile22222')
90
msg = _format_exception()
91
# Linux seems to give "No such file" but Windows gives "The system
92
# cannot find the file specified".
93
self.assertEqual('bzr: ERROR: %s\n' % (e_str,), msg)
95
def test_format_io_error(self):
97
file('nosuchfile22222')
100
msg = _format_exception()
101
# Even though Windows and Linux differ for 'os.rmdir', they both give
102
# 'No such file' for open()
103
self.assertContainsRe(msg,
104
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
106
def test_format_unicode_error(self):
108
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
109
except errors.BzrCommandError:
111
msg = _format_exception()
113
def test_format_exception(self):
114
"""Short formatting of bzr exceptions"""
116
raise errors.NotBranchError('wibble')
117
except errors.NotBranchError:
119
msg = _format_exception()
120
self.assertTrue(len(msg) > 0)
121
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
123
def test_report_external_import_error(self):
124
"""Short friendly message for missing system modules."""
126
import ImaginaryModule
127
except ImportError, e:
130
self.fail("somehow succeeded in importing %r" % ImaginaryModule)
131
msg = _format_exception()
132
self.assertEqual(msg,
133
'bzr: ERROR: No module named ImaginaryModule\n'
134
'You may need to install this Python library separately.\n')
136
def test_report_import_syntax_error(self):
138
raise ImportError("syntax error")
139
except ImportError, e:
141
msg = _format_exception()
142
self.assertContainsRe(msg,
143
r'Bazaar has encountered an internal error')
145
def test_trace_unicode(self):
146
"""Write Unicode to trace log"""
147
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
149
self.assertContainsRe(log, "the unicode character for benzene is")
151
def test_trace_argument_unicode(self):
152
"""Write a Unicode argument to the trace log"""
153
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
155
self.assertContainsRe(log, 'the unicode character')
157
def test_trace_argument_utf8(self):
158
"""Write a Unicode argument to the trace log"""
159
mutter(u'the unicode character for benzene is %s',
160
u'\N{BENZENE RING}'.encode('utf-8'))
162
self.assertContainsRe(log, 'the unicode character')
164
def test_report_broken_pipe(self):
166
raise IOError(errno.EPIPE, 'broken pipe foofofo')
168
msg = _format_exception()
169
self.assertEquals(msg, "bzr: broken pipe\n")
171
self.fail("expected error not raised")
173
def assertLogStartsWith(self, log, string):
174
"""Like assertStartsWith, but skips the log timestamp."""
175
self.assertContainsRe(log,
176
'^\\d+\\.\\d+ ' + re.escape(string))
178
def test_mutter_callsite_1(self):
179
"""mutter_callsite can capture 1 level of stack frame."""
180
mutter_callsite(1, "foo %s", "a string")
182
# begin with the message
183
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
184
# should show two frame: this frame and the one above
185
self.assertContainsRe(log,
186
'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
187
# this frame should be the final one
188
self.assertEndsWith(log, ' "a string")\n')
190
def test_mutter_callsite_2(self):
191
"""mutter_callsite can capture 2 levels of stack frame."""
192
mutter_callsite(2, "foo %s", "a string")
194
# begin with the message
195
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
196
# should show two frame: this frame and the one above
197
self.assertContainsRe(log,
198
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
199
# this frame should be the final one
200
self.assertEndsWith(log, ' "a string")\n')
202
def test_mutter_never_fails(self):
203
# Even if the decode/encode stage fails, mutter should not
205
# This test checks that mutter doesn't fail; the current behaviour
206
# is that it doesn't fail *and writes non-utf8*.
207
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
208
mutter('But fails in an ascii string \xb5')
209
mutter('and in an ascii argument: %s', '\xb5')
211
self.assertContainsRe(log, 'Writing a greek mu')
212
self.assertContainsRe(log, "But fails in an ascii string")
213
# However, the log content object does unicode replacement on reading
214
# to let it get unicode back where good data has been written. So we
215
# have to do a replaceent here as well.
216
self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
219
def test_push_log_file(self):
220
"""Can push and pop log file, and this catches mutter messages.
222
This is primarily for use in the test framework.
224
tmp1 = tempfile.NamedTemporaryFile()
225
tmp2 = tempfile.NamedTemporaryFile()
227
memento1 = push_log_file(tmp1)
228
mutter("comment to file1")
230
memento2 = push_log_file(tmp2)
232
mutter("comment to file2")
234
pop_log_file(memento2)
235
mutter("again to file1")
237
pop_log_file(memento1)
238
# the files were opened in binary mode, so should have exactly
239
# these bytes. and removing the file as the log target should
240
# have caused them to be flushed out. need to match using regexps
241
# as there's a timestamp at the front.
243
self.assertContainsRe(tmp1.read(),
244
r"\d+\.\d+ comment to file1\n\d+\.\d+ again to file1\n")
246
self.assertContainsRe(tmp2.read(),
247
r"\d+\.\d+ comment to file2\n")
252
def test__open_bzr_log_uses_stderr_for_failures(self):
253
# If _open_bzr_log cannot open the file, then we should write the
254
# warning to stderr. Since this is normally happening before logging is
256
self.addCleanup(setattr, sys, 'stderr', sys.stderr)
257
self.addCleanup(setattr, trace, '_bzr_log_filename',
258
trace._bzr_log_filename)
259
sys.stderr = StringIO()
260
# Set the log file to something that cannot exist
261
os.environ['BZR_LOG'] = os.getcwd() + '/no-dir/bzr.log'
262
logf = trace._open_bzr_log()
263
self.assertIs(None, logf)
264
self.assertContainsRe(sys.stderr.getvalue(),
265
'failed to open trace file: .*/no-dir/bzr.log')
267
class TestVerbosityLevel(TestCase):
269
def test_verbosity_level(self):
270
set_verbosity_level(1)
271
self.assertEqual(1, get_verbosity_level())
272
self.assertTrue(is_verbose())
273
self.assertFalse(is_quiet())
274
set_verbosity_level(-1)
275
self.assertEqual(-1, get_verbosity_level())
276
self.assertFalse(is_verbose())
277
self.assertTrue(is_quiet())
278
set_verbosity_level(0)
279
self.assertEqual(0, get_verbosity_level())
280
self.assertFalse(is_verbose())
281
self.assertFalse(is_quiet())
283
def test_be_quiet(self):
284
# Confirm the old API still works
286
self.assertEqual(-1, get_verbosity_level())
288
self.assertEqual(0, get_verbosity_level())
291
class TestBzrLog(TestCaseInTempDir):
293
def test_log_rollover(self):
294
temp_log_name = 'test-log'
295
trace_file = open(temp_log_name, 'at')
296
trace_file.writelines(['test_log_rollover padding\n'] * 200000)
298
_rollover_trace_maybe(temp_log_name)
299
# should have been rolled over
300
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
