← 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: Canonical.com Patch Queue Manager
  • Date: 2008-03-13 23:45:11 UTC
  • mfrom: (3272.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080313234511-fkj5oa8gm3nrfcro
(Neil Martinsen-Burrell) Explain version-info --custom in the User
        Guide

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 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
# "weren't nothing promised to you.  do i look like i got a promise face?"
18
18
 
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
 
51
48
class TestTrace(TestCase):
52
49
 
53
50
    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.
58
51
        try:
59
52
            raise NotImplementedError, "time travel"
60
53
        except NotImplementedError:
63
56
        self.assertEqualDiff(err.splitlines()[0],
64
57
                'bzr: ERROR: exceptions.NotImplementedError: time travel')
65
58
        self.assertContainsRe(err,
66
 
            'Bazaar has encountered an internal error.')
 
59
                r'File.*test_trace.py')
67
60
 
68
61
    def test_format_interrupt_exception(self):
69
62
        try:
75
68
        self.assertTrue(len(msg) > 0)
76
69
        self.assertEqualDiff(msg, 'bzr: interrupted\n')
77
70
 
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
 
 
98
71
    def test_format_os_error(self):
99
72
        try:
100
 
            os.rmdir('nosuchfile22222')
101
 
        except OSError, e:
102
 
            e_str = str(e)
103
 
        msg = _format_exception()
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)
107
 
 
108
 
    def test_format_io_error(self):
109
 
        try:
110
73
            file('nosuchfile22222')
111
 
        except IOError:
112
 
            pass
113
 
        msg = _format_exception()
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):")
 
74
        except (OSError, IOError):
 
75
            pass
 
76
        msg = _format_exception()
 
77
        self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
143
78
 
144
79
    def test_format_unicode_error(self):
145
80
        try:
158
93
        self.assertTrue(len(msg) > 0)
159
94
        self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
160
95
 
161
 
    def test_report_external_import_error(self):
162
 
        """Short friendly message for missing system modules."""
163
 
        try:
164
 
            import ImaginaryModule
165
 
        except ImportError, e:
166
 
            pass
167
 
        else:
168
 
            self.fail("somehow succeeded in importing %r" % ImaginaryModule)
169
 
        msg = _format_exception()
170
 
        self.assertEqual(msg,
171
 
            'bzr: ERROR: No module named ImaginaryModule\n'
172
 
            'You may need to install this Python library separately.\n')
173
 
 
174
 
    def test_report_import_syntax_error(self):
175
 
        try:
176
 
            raise ImportError("syntax error")
177
 
        except ImportError, e:
178
 
            pass
179
 
        msg = _format_exception()
180
 
        self.assertContainsRe(msg,
181
 
            r'Bazaar has encountered an internal error')
182
 
 
183
96
    def test_trace_unicode(self):
184
97
        """Write Unicode to trace log"""
185
98
        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")
188
 
 
 
99
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
100
                              "the unicode character for benzene is")
 
101
    
189
102
    def test_trace_argument_unicode(self):
190
103
        """Write a Unicode argument to the trace log"""
191
104
        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')
 
105
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
106
                              'the unicode character')
194
107
 
195
108
    def test_trace_argument_utf8(self):
196
109
        """Write a Unicode argument to the trace log"""
197
110
        mutter(u'the unicode character for benzene is %s',
198
111
               u'\N{BENZENE RING}'.encode('utf-8'))
199
 
        log = self.get_log()
200
 
        self.assertContainsRe(log, 'the unicode character')
 
112
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
113
                              'the unicode character')
201
114
 
202
115
    def test_report_broken_pipe(self):
203
116
        try:
216
129
    def test_mutter_callsite_1(self):
217
130
        """mutter_callsite can capture 1 level of stack frame."""
218
131
        mutter_callsite(1, "foo %s", "a string")
219
 
        log = self.get_log()
 
132
        log = self._get_log(keep_log_file=True)
220
133
        # begin with the message
221
134
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
222
135
        # should show two frame: this frame and the one above
228
141
    def test_mutter_callsite_2(self):
229
142
        """mutter_callsite can capture 2 levels of stack frame."""
230
143
        mutter_callsite(2, "foo %s", "a string")
231
 
        log = self.get_log()
 
144
        log = self._get_log(keep_log_file=True)
232
145
        # begin with the message
233
146
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
234
147
        # should show two frame: this frame and the one above
240
153
    def test_mutter_never_fails(self):
241
154
        # Even if the decode/encode stage fails, mutter should not
242
155
        # 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
156
        mutter(u'Writing a greek mu (\xb5) works in a unicode string')
246
157
        mutter('But fails in an ascii string \xb5')
247
158
        mutter('and in an ascii argument: %s', '\xb5')
248
 
        log = self.get_log()
 
159
        log = self._get_log(keep_log_file=True)
249
160
        self.assertContainsRe(log, 'Writing a greek mu')
250
161
        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')
 
162
        self.assertContainsRe(log, u"ascii argument: \xb5")
276
163
 
277
164
    def test_push_log_file(self):
278
165
        """Can push and pop log file, and this catches mutter messages.
279
166
 
280
 
        This is primarily for use in the test framework.
 
167
        This is primarily for use in the test framework. 
281
168
        """
282
169
        tmp1 = tempfile.NamedTemporaryFile()
283
170
        tmp2 = tempfile.NamedTemporaryFile()
307
194
            tmp1.close()
308
195
            tmp2.close()
309
196
 
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
197
 
324
198
class TestVerbosityLevel(TestCase):
325
199
 
350
224
    def test_log_rollover(self):
351
225
        temp_log_name = 'test-log'
352
226
        trace_file = open(temp_log_name, 'at')
353
 
        trace_file.writelines(['test_log_rollover padding\n'] * 200000)
 
227
        trace_file.write('test_log_rollover padding\n' * 1000000)
354
228
        trace_file.close()
355
229
        _rollover_trace_maybe(temp_log_name)
356
230
        # should have been rolled over
357
231
        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)