← 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: Neil Martinsen-Burrell
  • Date: 2009-12-07 21:51:01 UTC
  • mto: This revision was merged to the branch mainline in revision 4910.
  • Revision ID: nmb@wartburg.edu-20091207215101-lv1fyi2blzer4h5j
tweaks based on JAMs review

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_trace.py
1
 
# Copyright (C) 2005-2011 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
26
26
import tempfile
27
27
 
28
28
from bzrlib import (
29
 
    debug,
30
29
    errors,
31
 
    trace,
32
30
    )
33
 
from bzrlib.tests import features, TestCaseInTempDir, TestCase
 
31
from bzrlib.tests import TestCaseInTempDir, TestCase
34
32
from bzrlib.trace import (
35
33
    mutter, mutter_callsite, report_exception,
36
34
    set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
37
35
    pop_log_file,
38
36
    push_log_file,
39
37
    _rollover_trace_maybe,
40
 
    show_error,
41
38
    )
42
39
 
43
40
 
82
79
            pass
83
80
        msg = _format_exception()
84
81
        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 ")
 
82
            "bzr: out of memory\n")
97
83
 
98
84
    def test_format_os_error(self):
99
85
        try:
116
102
        self.assertContainsRe(msg,
117
103
            r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
118
104
 
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):")
143
 
 
144
105
    def test_format_unicode_error(self):
145
106
        try:
146
107
            raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
183
144
    def test_trace_unicode(self):
184
145
        """Write Unicode to trace log"""
185
146
        self.log(u'the unicode character for benzene is \N{BENZENE RING}')
186
 
        log = self.get_log()
187
 
        self.assertContainsRe(log, "the unicode character for benzene is")
 
147
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
148
                              "the unicode character for benzene is")
188
149
 
189
150
    def test_trace_argument_unicode(self):
190
151
        """Write a Unicode argument to the trace log"""
191
152
        mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
192
 
        log = self.get_log()
193
 
        self.assertContainsRe(log, 'the unicode character')
 
153
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
154
                              'the unicode character')
194
155
 
195
156
    def test_trace_argument_utf8(self):
196
157
        """Write a Unicode argument to the trace log"""
197
158
        mutter(u'the unicode character for benzene is %s',
198
159
               u'\N{BENZENE RING}'.encode('utf-8'))
199
 
        log = self.get_log()
200
 
        self.assertContainsRe(log, 'the unicode character')
 
160
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
161
                              'the unicode character')
201
162
 
202
163
    def test_report_broken_pipe(self):
203
164
        try:
216
177
    def test_mutter_callsite_1(self):
217
178
        """mutter_callsite can capture 1 level of stack frame."""
218
179
        mutter_callsite(1, "foo %s", "a string")
219
 
        log = self.get_log()
 
180
        log = self._get_log(keep_log_file=True)
220
181
        # begin with the message
221
182
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
222
183
        # should show two frame: this frame and the one above
228
189
    def test_mutter_callsite_2(self):
229
190
        """mutter_callsite can capture 2 levels of stack frame."""
230
191
        mutter_callsite(2, "foo %s", "a string")
231
 
        log = self.get_log()
 
192
        log = self._get_log(keep_log_file=True)
232
193
        # begin with the message
233
194
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
234
195
        # should show two frame: this frame and the one above
240
201
    def test_mutter_never_fails(self):
241
202
        # Even if the decode/encode stage fails, mutter should not
242
203
        # 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*.
245
204
        mutter(u'Writing a greek mu (\xb5) works in a unicode string')
246
205
        mutter('But fails in an ascii string \xb5')
247
206
        mutter('and in an ascii argument: %s', '\xb5')
248
 
        log = self.get_log()
 
207
        log = self._get_log(keep_log_file=True)
249
208
        self.assertContainsRe(log, 'Writing a greek mu')
250
209
        self.assertContainsRe(log, "But fails in an ascii string")
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')
 
210
        self.assertContainsRe(log, u"ascii argument: \xb5")
276
211
 
277
212
    def test_push_log_file(self):
278
213
        """Can push and pop log file, and this catches mutter messages.
307
242
            tmp1.close()
308
243
            tmp2.close()
309
244
 
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
 
 
323
245
 
324
246
class TestVerbosityLevel(TestCase):
325
247
 
355
277
        _rollover_trace_maybe(temp_log_name)
356
278
        # should have been rolled over
357
279
        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)