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
31
from bzrlib.tests import TestCaseInTempDir, TestCase
32
from bzrlib.trace import (
33
mutter, mutter_callsite, report_exception,
34
set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
37
_rollover_trace_maybe,
41
def _format_exception():
42
"""Format an exception as it would normally be displayed to the user"""
44
report_exception(sys.exc_info(), buf)
48
class TestTrace(TestCase):
50
def test_format_sys_exception(self):
51
# Test handling of an internal/unexpected error that probably
52
# indicates a bug in bzr. The details of the message may vary
53
# depending on whether apport is available or not. See test_crash for
56
raise NotImplementedError, "time travel"
57
except NotImplementedError:
59
err = _format_exception()
60
self.assertEqualDiff(err.splitlines()[0],
61
'bzr: ERROR: exceptions.NotImplementedError: time travel')
62
self.assertContainsRe(err,
63
'Bazaar has encountered an internal error.')
65
def test_format_interrupt_exception(self):
67
raise KeyboardInterrupt()
68
except KeyboardInterrupt:
69
# XXX: Some risk that a *real* keyboard interrupt won't be seen
71
msg = _format_exception()
72
self.assertTrue(len(msg) > 0)
73
self.assertEqualDiff(msg, 'bzr: interrupted\n')
75
def test_format_memory_error(self):
80
msg = _format_exception()
81
self.assertEquals(msg,
82
"bzr: out of memory\n")
84
def test_format_os_error(self):
86
os.rmdir('nosuchfile22222')
89
msg = _format_exception()
90
# Linux seems to give "No such file" but Windows gives "The system
91
# cannot find the file specified".
92
self.assertEqual('bzr: ERROR: %s\n' % (e_str,), msg)
94
def test_format_io_error(self):
96
file('nosuchfile22222')
99
msg = _format_exception()
100
# Even though Windows and Linux differ for 'os.rmdir', they both give
101
# 'No such file' for open()
102
self.assertContainsRe(msg,
103
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
105
def test_format_unicode_error(self):
107
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
108
except errors.BzrCommandError:
110
msg = _format_exception()
112
def test_format_exception(self):
113
"""Short formatting of bzr exceptions"""
115
raise errors.NotBranchError('wibble')
116
except errors.NotBranchError:
118
msg = _format_exception()
119
self.assertTrue(len(msg) > 0)
120
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
122
def test_report_external_import_error(self):
123
"""Short friendly message for missing system modules."""
125
import ImaginaryModule
126
except ImportError, e:
129
self.fail("somehow succeeded in importing %r" % ImaginaryModule)
130
msg = _format_exception()
131
self.assertEqual(msg,
132
'bzr: ERROR: No module named ImaginaryModule\n'
133
'You may need to install this Python library separately.\n')
135
def test_report_import_syntax_error(self):
137
raise ImportError("syntax error")
138
except ImportError, e:
140
msg = _format_exception()
141
self.assertContainsRe(msg,
142
r'Bazaar has encountered an internal error')
144
def test_trace_unicode(self):
145
"""Write Unicode to trace log"""
146
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
148
self.assertContainsRe(log, "the unicode character for benzene is")
150
def test_trace_argument_unicode(self):
151
"""Write a Unicode argument to the trace log"""
152
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
154
self.assertContainsRe(log, 'the unicode character')
156
def test_trace_argument_utf8(self):
157
"""Write a Unicode argument to the trace log"""
158
mutter(u'the unicode character for benzene is %s',
159
u'\N{BENZENE RING}'.encode('utf-8'))
161
self.assertContainsRe(log, 'the unicode character')
163
def test_report_broken_pipe(self):
165
raise IOError(errno.EPIPE, 'broken pipe foofofo')
167
msg = _format_exception()
168
self.assertEquals(msg, "bzr: broken pipe\n")
170
self.fail("expected error not raised")
172
def assertLogStartsWith(self, log, string):
173
"""Like assertStartsWith, but skips the log timestamp."""
174
self.assertContainsRe(log,
175
'^\\d+\\.\\d+ ' + re.escape(string))
177
def test_mutter_callsite_1(self):
178
"""mutter_callsite can capture 1 level of stack frame."""
179
mutter_callsite(1, "foo %s", "a string")
181
# begin with the message
182
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
183
# should show two frame: this frame and the one above
184
self.assertContainsRe(log,
185
'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
186
# this frame should be the final one
187
self.assertEndsWith(log, ' "a string")\n')
189
def test_mutter_callsite_2(self):
190
"""mutter_callsite can capture 2 levels of stack frame."""
191
mutter_callsite(2, "foo %s", "a string")
193
# begin with the message
194
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
195
# should show two frame: this frame and the one above
196
self.assertContainsRe(log,
197
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
198
# this frame should be the final one
199
self.assertEndsWith(log, ' "a string")\n')
201
def test_mutter_never_fails(self):
202
# Even if the decode/encode stage fails, mutter should not
204
# This test checks that mutter doesn't fail; the current behaviour
205
# is that it doesn't fail *and writes non-utf8*.
206
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
207
mutter('But fails in an ascii string \xb5')
208
mutter('and in an ascii argument: %s', '\xb5')
210
self.assertContainsRe(log, 'Writing a greek mu')
211
self.assertContainsRe(log, "But fails in an ascii string")
212
# However, the log content object does unicode replacement on reading
213
# to let it get unicode back where good data has been written. So we
214
# have to do a replaceent here as well.
215
self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
218
def test_push_log_file(self):
219
"""Can push and pop log file, and this catches mutter messages.
221
This is primarily for use in the test framework.
223
tmp1 = tempfile.NamedTemporaryFile()
224
tmp2 = tempfile.NamedTemporaryFile()
226
memento1 = push_log_file(tmp1)
227
mutter("comment to file1")
229
memento2 = push_log_file(tmp2)
231
mutter("comment to file2")
233
pop_log_file(memento2)
234
mutter("again to file1")
236
pop_log_file(memento1)
237
# the files were opened in binary mode, so should have exactly
238
# these bytes. and removing the file as the log target should
239
# have caused them to be flushed out. need to match using regexps
240
# as there's a timestamp at the front.
242
self.assertContainsRe(tmp1.read(),
243
r"\d+\.\d+ comment to file1\n\d+\.\d+ again to file1\n")
245
self.assertContainsRe(tmp2.read(),
246
r"\d+\.\d+ comment to file2\n")
252
class TestVerbosityLevel(TestCase):
254
def test_verbosity_level(self):
255
set_verbosity_level(1)
256
self.assertEqual(1, get_verbosity_level())
257
self.assertTrue(is_verbose())
258
self.assertFalse(is_quiet())
259
set_verbosity_level(-1)
260
self.assertEqual(-1, get_verbosity_level())
261
self.assertFalse(is_verbose())
262
self.assertTrue(is_quiet())
263
set_verbosity_level(0)
264
self.assertEqual(0, get_verbosity_level())
265
self.assertFalse(is_verbose())
266
self.assertFalse(is_quiet())
268
def test_be_quiet(self):
269
# Confirm the old API still works
271
self.assertEqual(-1, get_verbosity_level())
273
self.assertEqual(0, get_verbosity_level())
276
class TestBzrLog(TestCaseInTempDir):
278
def test_log_rollover(self):
279
temp_log_name = 'test-log'
280
trace_file = open(temp_log_name, 'at')
281
trace_file.writelines(['test_log_rollover padding\n'] * 200000)
283
_rollover_trace_maybe(temp_log_name)
284
# should have been rolled over
285
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
