← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_trace.py

  • Committer: Andrew Bennetts
  • Date: 2009-10-08 01:55:33 UTC
  • mto: This revision was merged to the branch mainline in revision 4732.
  • Revision ID: andrew.bennetts@canonical.com-20091008015533-pfzig4dpr3kqt2cc
Add NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_trace.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
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
27
27
 
28
28
from bzrlib import (
29
29
    errors,
30
 
    trace,
31
30
    )
32
 
from bzrlib.tests import features, TestCaseInTempDir, TestCase
 
31
from bzrlib.tests import TestCaseInTempDir, TestCase
33
32
from bzrlib.trace import (
34
33
    mutter, mutter_callsite, report_exception,
35
34
    set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
36
35
    pop_log_file,
37
36
    push_log_file,
38
37
    _rollover_trace_maybe,
39
 
    show_error,
40
38
    )
41
39
 
42
40
 
86
84
    def test_format_os_error(self):
87
85
        try:
88
86
            os.rmdir('nosuchfile22222')
89
 
        except OSError, e:
90
 
            e_str = str(e)
 
87
        except OSError:
 
88
            pass
91
89
        msg = _format_exception()
92
 
        # Linux seems to give "No such file" but Windows gives "The system
93
 
        # cannot find the file specified".
94
 
        self.assertEqual('bzr: ERROR: %s\n' % (e_str,), msg)
 
90
        self.assertContainsRe(msg,
 
91
            r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile22222')
95
92
 
96
93
    def test_format_io_error(self):
97
94
        try:
99
96
        except IOError:
100
97
            pass
101
98
        msg = _format_exception()
102
 
        # Even though Windows and Linux differ for 'os.rmdir', they both give
103
 
        # 'No such file' for open()
104
 
        self.assertContainsRe(msg,
105
 
            r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
106
 
 
107
 
    def test_format_pywintypes_error(self):
108
 
        self.requireFeature(features.pywintypes)
109
 
        import pywintypes, win32file
110
 
        try:
111
 
            win32file.RemoveDirectory('nosuchfile22222')
112
 
        except pywintypes.error:
113
 
            pass
114
 
        msg = _format_exception()
115
 
        # GZ 2010-05-03: Formatting for pywintypes.error is basic, a 3-tuple
116
 
        #                with errno, function name, and locale error message
117
 
        self.assertContainsRe(msg,
118
 
            r"^bzr: ERROR: \(2, 'RemoveDirectory[AW]?', .*\)")
 
99
        self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
119
100
 
120
101
    def test_format_unicode_error(self):
121
102
        try:
159
140
    def test_trace_unicode(self):
160
141
        """Write Unicode to trace log"""
161
142
        self.log(u'the unicode character for benzene is \N{BENZENE RING}')
162
 
        log = self.get_log()
163
 
        self.assertContainsRe(log, "the unicode character for benzene is")
 
143
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
144
                              "the unicode character for benzene is")
164
145
 
165
146
    def test_trace_argument_unicode(self):
166
147
        """Write a Unicode argument to the trace log"""
167
148
        mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
168
 
        log = self.get_log()
169
 
        self.assertContainsRe(log, 'the unicode character')
 
149
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
150
                              'the unicode character')
170
151
 
171
152
    def test_trace_argument_utf8(self):
172
153
        """Write a Unicode argument to the trace log"""
173
154
        mutter(u'the unicode character for benzene is %s',
174
155
               u'\N{BENZENE RING}'.encode('utf-8'))
175
 
        log = self.get_log()
176
 
        self.assertContainsRe(log, 'the unicode character')
 
156
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
157
                              'the unicode character')
177
158
 
178
159
    def test_report_broken_pipe(self):
179
160
        try:
192
173
    def test_mutter_callsite_1(self):
193
174
        """mutter_callsite can capture 1 level of stack frame."""
194
175
        mutter_callsite(1, "foo %s", "a string")
195
 
        log = self.get_log()
 
176
        log = self._get_log(keep_log_file=True)
196
177
        # begin with the message
197
178
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
198
179
        # should show two frame: this frame and the one above
204
185
    def test_mutter_callsite_2(self):
205
186
        """mutter_callsite can capture 2 levels of stack frame."""
206
187
        mutter_callsite(2, "foo %s", "a string")
207
 
        log = self.get_log()
 
188
        log = self._get_log(keep_log_file=True)
208
189
        # begin with the message
209
190
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
210
191
        # should show two frame: this frame and the one above
216
197
    def test_mutter_never_fails(self):
217
198
        # Even if the decode/encode stage fails, mutter should not
218
199
        # raise an exception
219
 
        # This test checks that mutter doesn't fail; the current behaviour
220
 
        # is that it doesn't fail *and writes non-utf8*.
221
200
        mutter(u'Writing a greek mu (\xb5) works in a unicode string')
222
201
        mutter('But fails in an ascii string \xb5')
223
202
        mutter('and in an ascii argument: %s', '\xb5')
224
 
        log = self.get_log()
 
203
        log = self._get_log(keep_log_file=True)
225
204
        self.assertContainsRe(log, 'Writing a greek mu')
226
205
        self.assertContainsRe(log, "But fails in an ascii string")
227
 
        # However, the log content object does unicode replacement on reading
228
 
        # to let it get unicode back where good data has been written. So we
229
 
        # have to do a replaceent here as well.
230
 
        self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
231
 
            'replace'))
232
 
        
233
 
    def test_show_error(self):
234
 
        show_error('error1')
235
 
        show_error(u'error2 \xb5 blah')
236
 
        show_error('arg: %s', 'blah')
237
 
        show_error('arg2: %(key)s', {'key':'stuff'})
238
 
        try:
239
 
            raise Exception("oops")
240
 
        except:
241
 
            show_error('kwarg', exc_info=True)
242
 
        log = self.get_log()
243
 
        self.assertContainsRe(log, 'error1')
244
 
        self.assertContainsRe(log, u'error2 \xb5 blah')
245
 
        self.assertContainsRe(log, 'arg: blah')
246
 
        self.assertContainsRe(log, 'arg2: stuff')
247
 
        self.assertContainsRe(log, 'kwarg')
248
 
        self.assertContainsRe(log, 'Traceback \\(most recent call last\\):')
249
 
        self.assertContainsRe(log, 'File ".*test_trace.py", line .*, in test_show_error')
250
 
        self.assertContainsRe(log, 'raise Exception\\("oops"\\)')
251
 
        self.assertContainsRe(log, 'Exception: oops')
 
206
        self.assertContainsRe(log, u"ascii argument: \xb5")
252
207
 
253
208
    def test_push_log_file(self):
254
209
        """Can push and pop log file, and this catches mutter messages.
283
238
            tmp1.close()
284
239
            tmp2.close()
285
240
 
286
 
    def test__open_bzr_log_uses_stderr_for_failures(self):
287
 
        # If _open_bzr_log cannot open the file, then we should write the
288
 
        # warning to stderr. Since this is normally happening before logging is
289
 
        # set up.
290
 
        self.overrideAttr(sys, 'stderr', StringIO())
291
 
        # Set the log file to something that cannot exist
292
 
        # FIXME: A bit dangerous: we are not in an isolated dir here -- vilajam
293
 
        # 20100125
294
 
        os.environ['BZR_LOG'] = os.getcwd() + '/no-dir/bzr.log'
295
 
        self.overrideAttr(trace, '_bzr_log_filename')
296
 
        logf = trace._open_bzr_log()
297
 
        self.assertIs(None, logf)
298
 
        self.assertContainsRe(sys.stderr.getvalue(),
299
 
                              'failed to open trace file: .*/no-dir/bzr.log')
300
 
 
301
241
 
302
242
class TestVerbosityLevel(TestCase):
303
243
 
328
268
    def test_log_rollover(self):
329
269
        temp_log_name = 'test-log'
330
270
        trace_file = open(temp_log_name, 'at')
331
 
        trace_file.writelines(['test_log_rollover padding\n'] * 200000)
 
271
        trace_file.write('test_log_rollover padding\n' * 1000000)
332
272
        trace_file.close()
333
273
        _rollover_trace_maybe(temp_log_name)
334
274
        # should have been rolled over
335
275
        self.assertFalse(os.access(temp_log_name, os.R_OK))
336
 
 
337
 
 
338
 
class TestTraceConfiguration(TestCaseInTempDir):
339
 
 
340
 
    def test_default_config(self):
341
 
        config = trace.DefaultConfig()
342
 
        self.overrideAttr(trace, "_bzr_log_filename", None)
343
 
        trace._bzr_log_filename = None
344
 
        expected_filename = trace._get_bzr_log_filename()
345
 
        self.assertEqual(None, trace._bzr_log_filename)
346
 
        config.__enter__()
347
 
        try:
348
 
            # Should have entered and setup a default filename.
349
 
            self.assertEqual(expected_filename, trace._bzr_log_filename)
350
 
        finally:
351
 
            config.__exit__(None, None, None)
352
 
            # Should have exited and cleaned up.
353
 
            self.assertEqual(None, trace._bzr_log_filename)