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_os_error(self):
77
os.rmdir('nosuchfile22222')
80
msg = _format_exception()
81
self.assertContainsRe(msg,
82
r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile22222')
84
def test_format_io_error(self):
86
file('nosuchfile22222')
89
msg = _format_exception()
90
self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
92
def test_format_unicode_error(self):
94
raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
95
except errors.BzrCommandError:
97
msg = _format_exception()
99
def test_format_exception(self):
100
"""Short formatting of bzr exceptions"""
102
raise errors.NotBranchError('wibble')
103
except errors.NotBranchError:
105
msg = _format_exception()
106
self.assertTrue(len(msg) > 0)
107
self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
109
def test_report_external_import_error(self):
110
"""Short friendly message for missing system modules."""
112
import ImaginaryModule
113
except ImportError, e:
116
self.fail("somehow succeeded in importing %r" % ImaginaryModule)
117
msg = _format_exception()
118
self.assertEqual(msg,
119
'bzr: ERROR: No module named ImaginaryModule\n'
120
'You may need to install this Python library separately.\n')
122
def test_report_import_syntax_error(self):
124
raise ImportError("syntax error")
125
except ImportError, e:
127
msg = _format_exception()
128
self.assertContainsRe(msg,
129
r'Bazaar has encountered an internal error')
131
def test_trace_unicode(self):
132
"""Write Unicode to trace log"""
133
self.log(u'the unicode character for benzene is \N{BENZENE RING}')
134
self.assertContainsRe(self._get_log(keep_log_file=True),
135
"the unicode character for benzene is")
137
def test_trace_argument_unicode(self):
138
"""Write a Unicode argument to the trace log"""
139
mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
140
self.assertContainsRe(self._get_log(keep_log_file=True),
141
'the unicode character')
143
def test_trace_argument_utf8(self):
144
"""Write a Unicode argument to the trace log"""
145
mutter(u'the unicode character for benzene is %s',
146
u'\N{BENZENE RING}'.encode('utf-8'))
147
self.assertContainsRe(self._get_log(keep_log_file=True),
148
'the unicode character')
150
def test_report_broken_pipe(self):
152
raise IOError(errno.EPIPE, 'broken pipe foofofo')
154
msg = _format_exception()
155
self.assertEquals(msg, "bzr: broken pipe\n")
157
self.fail("expected error not raised")
159
def assertLogStartsWith(self, log, string):
160
"""Like assertStartsWith, but skips the log timestamp."""
161
self.assertContainsRe(log,
162
'^\\d+\\.\\d+ ' + re.escape(string))
164
def test_mutter_callsite_1(self):
165
"""mutter_callsite can capture 1 level of stack frame."""
166
mutter_callsite(1, "foo %s", "a string")
167
log = self._get_log(keep_log_file=True)
168
# begin with the message
169
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
170
# should show two frame: this frame and the one above
171
self.assertContainsRe(log,
172
'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
173
# this frame should be the final one
174
self.assertEndsWith(log, ' "a string")\n')
176
def test_mutter_callsite_2(self):
177
"""mutter_callsite can capture 2 levels of stack frame."""
178
mutter_callsite(2, "foo %s", "a string")
179
log = self._get_log(keep_log_file=True)
180
# begin with the message
181
self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
182
# should show two frame: this frame and the one above
183
self.assertContainsRe(log,
184
'test_trace.py", line \d+, in test_mutter_callsite_2\n')
185
# this frame should be the final one
186
self.assertEndsWith(log, ' "a string")\n')
188
def test_mutter_never_fails(self):
189
# Even if the decode/encode stage fails, mutter should not
191
mutter(u'Writing a greek mu (\xb5) works in a unicode string')
192
mutter('But fails in an ascii string \xb5')
193
mutter('and in an ascii argument: %s', '\xb5')
194
log = self._get_log(keep_log_file=True)
195
self.assertContainsRe(log, 'Writing a greek mu')
196
self.assertContainsRe(log, "But fails in an ascii string")
197
self.assertContainsRe(log, u"ascii argument: \xb5")
199
def test_push_log_file(self):
200
"""Can push and pop log file, and this catches mutter messages.
202
This is primarily for use in the test framework.
204
tmp1 = tempfile.NamedTemporaryFile()
205
tmp2 = tempfile.NamedTemporaryFile()
207
memento1 = push_log_file(tmp1)
208
mutter("comment to file1")
210
memento2 = push_log_file(tmp2)
212
mutter("comment to file2")
214
pop_log_file(memento2)
215
mutter("again to file1")
217
pop_log_file(memento1)
218
# the files were opened in binary mode, so should have exactly
219
# these bytes. and removing the file as the log target should
220
# have caused them to be flushed out. need to match using regexps
221
# as there's a timestamp at the front.
223
self.assertContainsRe(tmp1.read(),
224
r"\d+\.\d+ comment to file1\n\d+\.\d+ again to file1\n")
226
self.assertContainsRe(tmp2.read(),
227
r"\d+\.\d+ comment to file2\n")
233
class TestVerbosityLevel(TestCase):
235
def test_verbosity_level(self):
236
set_verbosity_level(1)
237
self.assertEqual(1, get_verbosity_level())
238
self.assertTrue(is_verbose())
239
self.assertFalse(is_quiet())
240
set_verbosity_level(-1)
241
self.assertEqual(-1, get_verbosity_level())
242
self.assertFalse(is_verbose())
243
self.assertTrue(is_quiet())
244
set_verbosity_level(0)
245
self.assertEqual(0, get_verbosity_level())
246
self.assertFalse(is_verbose())
247
self.assertFalse(is_quiet())
249
def test_be_quiet(self):
250
# Confirm the old API still works
252
self.assertEqual(-1, get_verbosity_level())
254
self.assertEqual(0, get_verbosity_level())
257
class TestBzrLog(TestCaseInTempDir):
259
def test_log_rollover(self):
260
temp_log_name = 'test-log'
261
trace_file = open(temp_log_name, 'at')
262
trace_file.write('test_log_rollover padding\n' * 1000000)
264
_rollover_trace_maybe(temp_log_name)
265
# should have been rolled over
266
self.assertFalse(os.access(temp_log_name, os.R_OK))
added
removed
bzrlib/tests/test_trace.py
