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
self.assertContainsRe(msg,
92
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile22222')
94
def test_format_io_error(self):
96
file('nosuchfile22222')
99
msg = _format_exception()
100
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
102
def test_format_unicode_error(self):
104
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
105
except errors.BzrCommandError:
107
msg = _format_exception()
109
def test_format_exception(self):
110
"""Short formatting of bzr exceptions"""
112
raise errors.NotBranchError('wibble')
113
except errors.NotBranchError:
115
msg = _format_exception()
116
self.assertTrue(len(msg) > 0)
117
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
119
def test_report_external_import_error(self):
120
"""Short friendly message for missing system modules."""
122
import ImaginaryModule
123
except ImportError, e:
126
self.fail("somehow succeeded in importing %r" % ImaginaryModule)
127
msg = _format_exception()
128
self.assertEqual(msg,
129
'bzr: ERROR: No module named ImaginaryModule\n'
130
'You may need to install this Python library separately.\n')
132
def test_report_import_syntax_error(self):
134
raise ImportError("syntax error")
135
except ImportError, e:
137
msg = _format_exception()
138
self.assertContainsRe(msg,
139
r'Bazaar has encountered an internal error')
141
def test_trace_unicode(self):
142
"""Write Unicode to trace log"""
143
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
144
self.assertContainsRe(self._get_log(keep_log_file=True),
145
"the unicode character for benzene is")
147
def test_trace_argument_unicode(self):
148
"""Write a Unicode argument to the trace log"""
149
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
150
self.assertContainsRe(self._get_log(keep_log_file=True),
151
'the unicode character')
153
def test_trace_argument_utf8(self):
154
"""Write a Unicode argument to the trace log"""
155
mutter(u'the unicode character for benzene is %s',
156
u'\N{BENZENE RING}'.encode('utf-8'))
157
self.assertContainsRe(self._get_log(keep_log_file=True),
158
'the unicode character')
160
def test_report_broken_pipe(self):
162
raise IOError(errno.EPIPE, 'broken pipe foofofo')
164
msg = _format_exception()
165
self.assertEquals(msg, "bzr: broken pipe\n")
167
self.fail("expected error not raised")
169
def assertLogStartsWith(self, log, string):
170
"""Like assertStartsWith, but skips the log timestamp."""
171
self.assertContainsRe(log,
172
'^\\d+\\.\\d+ ' + re.escape(string))
174
def test_mutter_callsite_1(self):
175
"""mutter_callsite can capture 1 level of stack frame."""
176
mutter_callsite(1, "foo %s", "a string")
177
log = self._get_log(keep_log_file=True)
178
# begin with the message
179
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
180
# should show two frame: this frame and the one above
181
self.assertContainsRe(log,
182
'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
183
# this frame should be the final one
184
self.assertEndsWith(log, ' "a string")\n')
186
def test_mutter_callsite_2(self):
187
"""mutter_callsite can capture 2 levels of stack frame."""
188
mutter_callsite(2, "foo %s", "a string")
189
log = self._get_log(keep_log_file=True)
190
# begin with the message
191
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
192
# should show two frame: this frame and the one above
193
self.assertContainsRe(log,
194
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
195
# this frame should be the final one
196
self.assertEndsWith(log, ' "a string")\n')
198
def test_mutter_never_fails(self):
199
# Even if the decode/encode stage fails, mutter should not
201
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
202
mutter('But fails in an ascii string \xb5')
203
mutter('and in an ascii argument: %s', '\xb5')
204
log = self._get_log(keep_log_file=True)
205
self.assertContainsRe(log, 'Writing a greek mu')
206
self.assertContainsRe(log, "But fails in an ascii string")
207
self.assertContainsRe(log, u"ascii argument: \xb5")
209
def test_push_log_file(self):
210
"""Can push and pop log file, and this catches mutter messages.
212
This is primarily for use in the test framework.
214
tmp1 = tempfile.NamedTemporaryFile()
215
tmp2 = tempfile.NamedTemporaryFile()
217
memento1 = push_log_file(tmp1)
218
mutter("comment to file1")
220
memento2 = push_log_file(tmp2)
222
mutter("comment to file2")
224
pop_log_file(memento2)
225
mutter("again to file1")
227
pop_log_file(memento1)
228
# the files were opened in binary mode, so should have exactly
229
# these bytes. and removing the file as the log target should
230
# have caused them to be flushed out. need to match using regexps
231
# as there's a timestamp at the front.
233
self.assertContainsRe(tmp1.read(),
234
r"\d+\.\d+ comment to file1\n\d+\.\d+ again to file1\n")
236
self.assertContainsRe(tmp2.read(),
237
r"\d+\.\d+ comment to file2\n")
242
def test__open_bzr_log_uses_stderr_for_failures(self):
243
# If _open_bzr_log cannot open the file, then we should write the
244
# warning to stderr. Since this is normally happening before logging is
246
self.addCleanup(setattr, sys, 'stderr', sys.stderr)
247
self.addCleanup(setattr, trace, '_bzr_log_filename',
248
trace._bzr_log_filename)
249
sys.stderr = StringIO()
250
# Set the log file to something that cannot exist
251
os.environ['BZR_LOG'] = os.getcwd() + '/no-dir/bzr.log'
252
logf = trace._open_bzr_log()
253
self.assertIs(None, logf)
254
self.assertContainsRe(sys.stderr.getvalue(),
255
'failed to open trace file: .*/no-dir/bzr.log')
257
class TestVerbosityLevel(TestCase):
259
def test_verbosity_level(self):
260
set_verbosity_level(1)
261
self.assertEqual(1, get_verbosity_level())
262
self.assertTrue(is_verbose())
263
self.assertFalse(is_quiet())
264
set_verbosity_level(-1)
265
self.assertEqual(-1, get_verbosity_level())
266
self.assertFalse(is_verbose())
267
self.assertTrue(is_quiet())
268
set_verbosity_level(0)
269
self.assertEqual(0, get_verbosity_level())
270
self.assertFalse(is_verbose())
271
self.assertFalse(is_quiet())
273
def test_be_quiet(self):
274
# Confirm the old API still works
276
self.assertEqual(-1, get_verbosity_level())
278
self.assertEqual(0, get_verbosity_level())
281
class TestBzrLog(TestCaseInTempDir):
283
def test_log_rollover(self):
284
temp_log_name = 'test-log'
285
trace_file = open(temp_log_name, 'at')
286
trace_file.write('test_log_rollover padding\n' * 1000000)
288
_rollover_trace_maybe(temp_log_name)
289
# should have been rolled over
290
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
