← 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: Vincent Ladeuil
  • Date: 2011-09-09 13:30:12 UTC
  • mfrom: (5609.48.11 2.3)
  • mto: (6015.33.3 2.4)
  • mto: This revision was merged to the branch mainline in revision 6134.
  • Revision ID: v.ladeuil+lp@free.fr-20110909133012-jc1d1zyqgak57123
Merge 2.3 into 2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_trace.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
26
26
import tempfile
27
27
 
28
28
from bzrlib import (
 
29
    debug,
29
30
    errors,
 
31
    trace,
30
32
    )
31
 
from bzrlib.tests import TestCaseInTempDir, TestCase
 
33
from bzrlib.tests import features, TestCaseInTempDir, TestCase
32
34
from bzrlib.trace import (
33
35
    mutter, mutter_callsite, report_exception,
34
36
    set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
35
37
    pop_log_file,
36
38
    push_log_file,
37
39
    _rollover_trace_maybe,
 
40
    show_error,
38
41
    )
39
42
 
40
43
 
48
51
class TestTrace(TestCase):
49
52
 
50
53
    def test_format_sys_exception(self):
 
54
        # Test handling of an internal/unexpected error that probably
 
55
        # indicates a bug in bzr.  The details of the message may vary
 
56
        # depending on whether apport is available or not.  See test_crash for
 
57
        # more.
51
58
        try:
52
59
            raise NotImplementedError, "time travel"
53
60
        except NotImplementedError:
56
63
        self.assertEqualDiff(err.splitlines()[0],
57
64
                'bzr: ERROR: exceptions.NotImplementedError: time travel')
58
65
        self.assertContainsRe(err,
59
 
                r'File.*test_trace.py')
 
66
            'Bazaar has encountered an internal error.')
60
67
 
61
68
    def test_format_interrupt_exception(self):
62
69
        try:
68
75
        self.assertTrue(len(msg) > 0)
69
76
        self.assertEqualDiff(msg, 'bzr: interrupted\n')
70
77
 
 
78
    def test_format_memory_error(self):
 
79
        try:
 
80
            raise MemoryError()
 
81
        except MemoryError:
 
82
            pass
 
83
        msg = _format_exception()
 
84
        self.assertEquals(msg,
 
85
            "bzr: out of memory\nUse -Dmem_dump to dump memory to a file.\n")
 
86
 
 
87
    def test_format_mem_dump(self):
 
88
        self.requireFeature(features.meliae)
 
89
        debug.debug_flags.add('mem_dump')
 
90
        try:
 
91
            raise MemoryError()
 
92
        except MemoryError:
 
93
            pass
 
94
        msg = _format_exception()
 
95
        self.assertStartsWith(msg,
 
96
            "bzr: out of memory\nMemory dumped to ")
 
97
 
71
98
    def test_format_os_error(self):
72
99
        try:
73
100
            os.rmdir('nosuchfile22222')
74
 
        except OSError:
75
 
            pass
 
101
        except OSError, e:
 
102
            e_str = str(e)
76
103
        msg = _format_exception()
77
 
        self.assertContainsRe(msg,
78
 
            r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile22222')
 
104
        # Linux seems to give "No such file" but Windows gives "The system
 
105
        # cannot find the file specified".
 
106
        self.assertEqual('bzr: ERROR: %s\n' % (e_str,), msg)
79
107
 
80
108
    def test_format_io_error(self):
81
109
        try:
83
111
        except IOError:
84
112
            pass
85
113
        msg = _format_exception()
86
 
        self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
 
114
        # Even though Windows and Linux differ for 'os.rmdir', they both give
 
115
        # 'No such file' for open()
 
116
        self.assertContainsRe(msg,
 
117
            r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
 
118
 
 
119
    def test_format_pywintypes_error(self):
 
120
        self.requireFeature(features.pywintypes)
 
121
        import pywintypes, win32file
 
122
        try:
 
123
            win32file.RemoveDirectory('nosuchfile22222')
 
124
        except pywintypes.error:
 
125
            pass
 
126
        msg = _format_exception()
 
127
        # GZ 2010-05-03: Formatting for pywintypes.error is basic, a 3-tuple
 
128
        #                with errno, function name, and locale error message
 
129
        self.assertContainsRe(msg,
 
130
            r"^bzr: ERROR: \(2, 'RemoveDirectory[AW]?', .*\)")
 
131
            
 
132
    def test_format_sockets_error(self):
 
133
        try:
 
134
            import socket
 
135
            sock = socket.socket()
 
136
            sock.send("This should fail.")
 
137
        except socket.error:
 
138
            pass
 
139
        msg = _format_exception()
 
140
        
 
141
        self.assertNotContainsRe(msg,
 
142
            r"Traceback (most recent call last):")
87
143
 
88
144
    def test_format_unicode_error(self):
89
145
        try:
122
178
            pass
123
179
        msg = _format_exception()
124
180
        self.assertContainsRe(msg,
125
 
            r"Traceback \(most recent call last\)")
 
181
            r'Bazaar has encountered an internal error')
126
182
 
127
183
    def test_trace_unicode(self):
128
184
        """Write Unicode to trace log"""
129
185
        self.log(u'the unicode character for benzene is \N{BENZENE RING}')
130
 
        self.assertContainsRe(self._get_log(keep_log_file=True),
131
 
                              "the unicode character for benzene is")
 
186
        log = self.get_log()
 
187
        self.assertContainsRe(log, "the unicode character for benzene is")
132
188
 
133
189
    def test_trace_argument_unicode(self):
134
190
        """Write a Unicode argument to the trace log"""
135
191
        mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
136
 
        self.assertContainsRe(self._get_log(keep_log_file=True),
137
 
                              'the unicode character')
 
192
        log = self.get_log()
 
193
        self.assertContainsRe(log, 'the unicode character')
138
194
 
139
195
    def test_trace_argument_utf8(self):
140
196
        """Write a Unicode argument to the trace log"""
141
197
        mutter(u'the unicode character for benzene is %s',
142
198
               u'\N{BENZENE RING}'.encode('utf-8'))
143
 
        self.assertContainsRe(self._get_log(keep_log_file=True),
144
 
                              'the unicode character')
 
199
        log = self.get_log()
 
200
        self.assertContainsRe(log, 'the unicode character')
145
201
 
146
202
    def test_report_broken_pipe(self):
147
203
        try:
160
216
    def test_mutter_callsite_1(self):
161
217
        """mutter_callsite can capture 1 level of stack frame."""
162
218
        mutter_callsite(1, "foo %s", "a string")
163
 
        log = self._get_log(keep_log_file=True)
 
219
        log = self.get_log()
164
220
        # begin with the message
165
221
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
166
222
        # should show two frame: this frame and the one above
172
228
    def test_mutter_callsite_2(self):
173
229
        """mutter_callsite can capture 2 levels of stack frame."""
174
230
        mutter_callsite(2, "foo %s", "a string")
175
 
        log = self._get_log(keep_log_file=True)
 
231
        log = self.get_log()
176
232
        # begin with the message
177
233
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
178
234
        # should show two frame: this frame and the one above
184
240
    def test_mutter_never_fails(self):
185
241
        # Even if the decode/encode stage fails, mutter should not
186
242
        # raise an exception
 
243
        # This test checks that mutter doesn't fail; the current behaviour
 
244
        # is that it doesn't fail *and writes non-utf8*.
187
245
        mutter(u'Writing a greek mu (\xb5) works in a unicode string')
188
246
        mutter('But fails in an ascii string \xb5')
189
247
        mutter('and in an ascii argument: %s', '\xb5')
190
 
        log = self._get_log(keep_log_file=True)
 
248
        log = self.get_log()
191
249
        self.assertContainsRe(log, 'Writing a greek mu')
192
250
        self.assertContainsRe(log, "But fails in an ascii string")
193
 
        self.assertContainsRe(log, u"ascii argument: \xb5")
 
251
        # However, the log content object does unicode replacement on reading
 
252
        # to let it get unicode back where good data has been written. So we
 
253
        # have to do a replaceent here as well.
 
254
        self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
 
255
            'replace'))
 
256
        
 
257
    def test_show_error(self):
 
258
        show_error('error1')
 
259
        show_error(u'error2 \xb5 blah')
 
260
        show_error('arg: %s', 'blah')
 
261
        show_error('arg2: %(key)s', {'key':'stuff'})
 
262
        try:
 
263
            raise Exception("oops")
 
264
        except:
 
265
            show_error('kwarg', exc_info=True)
 
266
        log = self.get_log()
 
267
        self.assertContainsRe(log, 'error1')
 
268
        self.assertContainsRe(log, u'error2 \xb5 blah')
 
269
        self.assertContainsRe(log, 'arg: blah')
 
270
        self.assertContainsRe(log, 'arg2: stuff')
 
271
        self.assertContainsRe(log, 'kwarg')
 
272
        self.assertContainsRe(log, 'Traceback \\(most recent call last\\):')
 
273
        self.assertContainsRe(log, 'File ".*test_trace.py", line .*, in test_show_error')
 
274
        self.assertContainsRe(log, 'raise Exception\\("oops"\\)')
 
275
        self.assertContainsRe(log, 'Exception: oops')
194
276
 
195
277
    def test_push_log_file(self):
196
278
        """Can push and pop log file, and this catches mutter messages.
225
307
            tmp1.close()
226
308
            tmp2.close()
227
309
 
 
310
    def test__open_bzr_log_uses_stderr_for_failures(self):
 
311
        # If _open_bzr_log cannot open the file, then we should write the
 
312
        # warning to stderr. Since this is normally happening before logging is
 
313
        # set up.
 
314
        self.overrideAttr(sys, 'stderr', StringIO())
 
315
        # Set the log file to something that cannot exist
 
316
        self.overrideEnv('BZR_LOG', os.getcwd() + '/no-dir/bzr.log')
 
317
        self.overrideAttr(trace, '_bzr_log_filename')
 
318
        logf = trace._open_bzr_log()
 
319
        self.assertIs(None, logf)
 
320
        self.assertContainsRe(sys.stderr.getvalue(),
 
321
                              'failed to open trace file: .*/no-dir/bzr.log')
 
322
 
228
323
 
229
324
class TestVerbosityLevel(TestCase):
230
325
 
255
350
    def test_log_rollover(self):
256
351
        temp_log_name = 'test-log'
257
352
        trace_file = open(temp_log_name, 'at')
258
 
        trace_file.write('test_log_rollover padding\n' * 1000000)
 
353
        trace_file.writelines(['test_log_rollover padding\n'] * 200000)
259
354
        trace_file.close()
260
355
        _rollover_trace_maybe(temp_log_name)
261
356
        # should have been rolled over
262
357
        self.assertFalse(os.access(temp_log_name, os.R_OK))
 
358
 
 
359
 
 
360
class TestTraceConfiguration(TestCaseInTempDir):
 
361
 
 
362
    def test_default_config(self):
 
363
        config = trace.DefaultConfig()
 
364
        self.overrideAttr(trace, "_bzr_log_filename", None)
 
365
        trace._bzr_log_filename = None
 
366
        expected_filename = trace._get_bzr_log_filename()
 
367
        self.assertEqual(None, trace._bzr_log_filename)
 
368
        config.__enter__()
 
369
        try:
 
370
            # Should have entered and setup a default filename.
 
371
            self.assertEqual(expected_filename, trace._bzr_log_filename)
 
372
        finally:
 
373
            config.__exit__(None, None, None)
 
374
            # Should have exited and cleaned up.
 
375
            self.assertEqual(None, trace._bzr_log_filename)