← 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: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

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-2010 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,
30
31
    )
31
 
from bzrlib.tests import TestCaseInTempDir, TestCase
 
32
from bzrlib.tests import features, TestCaseInTempDir, TestCase
32
33
from bzrlib.trace import (
33
34
    mutter, mutter_callsite, report_exception,
34
35
    set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
35
36
    pop_log_file,
36
37
    push_log_file,
37
38
    _rollover_trace_maybe,
 
39
    show_error,
38
40
    )
39
41
 
40
42
 
48
50
class TestTrace(TestCase):
49
51
 
50
52
    def test_format_sys_exception(self):
 
53
        # Test handling of an internal/unexpected error that probably
 
54
        # indicates a bug in bzr.  The details of the message may vary
 
55
        # depending on whether apport is available or not.  See test_crash for
 
56
        # more.
51
57
        try:
52
58
            raise NotImplementedError, "time travel"
53
59
        except NotImplementedError:
56
62
        self.assertEqualDiff(err.splitlines()[0],
57
63
                'bzr: ERROR: exceptions.NotImplementedError: time travel')
58
64
        self.assertContainsRe(err,
59
 
                r'File.*test_trace.py')
 
65
            'Bazaar has encountered an internal error.')
60
66
 
61
67
    def test_format_interrupt_exception(self):
62
68
        try:
68
74
        self.assertTrue(len(msg) > 0)
69
75
        self.assertEqualDiff(msg, 'bzr: interrupted\n')
70
76
 
 
77
    def test_format_memory_error(self):
 
78
        try:
 
79
            raise MemoryError()
 
80
        except MemoryError:
 
81
            pass
 
82
        msg = _format_exception()
 
83
        self.assertEquals(msg,
 
84
            "bzr: out of memory\n")
 
85
 
71
86
    def test_format_os_error(self):
72
87
        try:
73
88
            os.rmdir('nosuchfile22222')
74
 
        except OSError:
75
 
            pass
 
89
        except OSError, e:
 
90
            e_str = str(e)
76
91
        msg = _format_exception()
77
 
        self.assertContainsRe(msg,
78
 
            r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile22222')
 
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)
79
95
 
80
96
    def test_format_io_error(self):
81
97
        try:
83
99
        except IOError:
84
100
            pass
85
101
        msg = _format_exception()
86
 
        self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
 
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]?', .*\)")
87
119
 
88
120
    def test_format_unicode_error(self):
89
121
        try:
122
154
            pass
123
155
        msg = _format_exception()
124
156
        self.assertContainsRe(msg,
125
 
            r"Traceback \(most recent call last\)")
 
157
            r'Bazaar has encountered an internal error')
126
158
 
127
159
    def test_trace_unicode(self):
128
160
        """Write Unicode to trace log"""
129
161
        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")
 
162
        log = self.get_log()
 
163
        self.assertContainsRe(log, "the unicode character for benzene is")
132
164
 
133
165
    def test_trace_argument_unicode(self):
134
166
        """Write a Unicode argument to the trace log"""
135
167
        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')
 
168
        log = self.get_log()
 
169
        self.assertContainsRe(log, 'the unicode character')
138
170
 
139
171
    def test_trace_argument_utf8(self):
140
172
        """Write a Unicode argument to the trace log"""
141
173
        mutter(u'the unicode character for benzene is %s',
142
174
               u'\N{BENZENE RING}'.encode('utf-8'))
143
 
        self.assertContainsRe(self._get_log(keep_log_file=True),
144
 
                              'the unicode character')
 
175
        log = self.get_log()
 
176
        self.assertContainsRe(log, 'the unicode character')
145
177
 
146
178
    def test_report_broken_pipe(self):
147
179
        try:
160
192
    def test_mutter_callsite_1(self):
161
193
        """mutter_callsite can capture 1 level of stack frame."""
162
194
        mutter_callsite(1, "foo %s", "a string")
163
 
        log = self._get_log(keep_log_file=True)
 
195
        log = self.get_log()
164
196
        # begin with the message
165
197
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
166
198
        # should show two frame: this frame and the one above
172
204
    def test_mutter_callsite_2(self):
173
205
        """mutter_callsite can capture 2 levels of stack frame."""
174
206
        mutter_callsite(2, "foo %s", "a string")
175
 
        log = self._get_log(keep_log_file=True)
 
207
        log = self.get_log()
176
208
        # begin with the message
177
209
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
178
210
        # should show two frame: this frame and the one above
184
216
    def test_mutter_never_fails(self):
185
217
        # Even if the decode/encode stage fails, mutter should not
186
218
        # 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*.
187
221
        mutter(u'Writing a greek mu (\xb5) works in a unicode string')
188
222
        mutter('But fails in an ascii string \xb5')
189
223
        mutter('and in an ascii argument: %s', '\xb5')
190
 
        log = self._get_log(keep_log_file=True)
 
224
        log = self.get_log()
191
225
        self.assertContainsRe(log, 'Writing a greek mu')
192
226
        self.assertContainsRe(log, "But fails in an ascii string")
193
 
        self.assertContainsRe(log, u"ascii argument: \xb5")
 
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')
194
252
 
195
253
    def test_push_log_file(self):
196
254
        """Can push and pop log file, and this catches mutter messages.
225
283
            tmp1.close()
226
284
            tmp2.close()
227
285
 
 
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
 
228
301
 
229
302
class TestVerbosityLevel(TestCase):
230
303
 
255
328
    def test_log_rollover(self):
256
329
        temp_log_name = 'test-log'
257
330
        trace_file = open(temp_log_name, 'at')
258
 
        trace_file.write('test_log_rollover padding\n' * 1000000)
 
331
        trace_file.writelines(['test_log_rollover padding\n'] * 200000)
259
332
        trace_file.close()
260
333
        _rollover_trace_maybe(temp_log_name)
261
334
        # should have been rolled over
262
335
        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)