/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_trace.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-09-16 01:57:02 UTC
  • mfrom: (2014.1.1 update-deprecated)
  • Revision ID: pqm@pqm.ubuntu.com-20060916015702-d6561b23f958bfdd
(jam) don't use deprecated pending_merges for 'bzr update'

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by 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
 
21
21
from cStringIO import StringIO
22
22
import errno
23
23
import os
24
 
import re
25
24
import sys
26
 
import tempfile
27
25
 
28
26
from bzrlib import (
29
27
    errors,
30
 
    trace,
31
 
    )
32
 
from bzrlib.tests import TestCaseInTempDir, TestCase, ModuleAvailableFeature
33
 
from bzrlib.trace import (
34
 
    mutter, mutter_callsite, report_exception,
35
 
    set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
36
 
    pop_log_file,
37
 
    push_log_file,
38
 
    _rollover_trace_maybe,
39
 
    show_error,
40
 
    )
 
28
    )
 
29
from bzrlib.tests import TestCaseInTempDir, TestCase
 
30
from bzrlib.trace import mutter, report_exception
41
31
 
42
32
 
43
33
def _format_exception():
50
40
class TestTrace(TestCase):
51
41
 
52
42
    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.
57
43
        try:
58
44
            raise NotImplementedError, "time travel"
59
45
        except NotImplementedError:
62
48
        self.assertEqualDiff(err.splitlines()[0],
63
49
                'bzr: ERROR: exceptions.NotImplementedError: time travel')
64
50
        self.assertContainsRe(err,
65
 
            'Bazaar has encountered an internal error.')
 
51
                r'File.*test_trace.py')
66
52
 
67
53
    def test_format_interrupt_exception(self):
68
54
        try:
74
60
        self.assertTrue(len(msg) > 0)
75
61
        self.assertEqualDiff(msg, 'bzr: interrupted\n')
76
62
 
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
 
 
86
63
    def test_format_os_error(self):
87
64
        try:
88
 
            os.rmdir('nosuchfile22222')
89
 
        except OSError, e:
90
 
            e_str = str(e)
91
 
        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)
95
 
 
96
 
    def test_format_io_error(self):
97
 
        try:
98
65
            file('nosuchfile22222')
99
 
        except IOError:
100
 
            pass
101
 
        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(ModuleAvailableFeature("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.expectFailure("pywintypes.error not treated as user error",
118
 
            self.assertContainsRe, msg,
119
 
            r"^bzr: ERROR: \(2, 'RemoveDirectory', .*\)")
 
66
        except (OSError, IOError):
 
67
            pass
 
68
        msg = _format_exception()
 
69
        self.assertContainsRe(msg, r'^bzr: ERROR: \[Errno .*\] No such file.*nosuchfile')
120
70
 
121
71
    def test_format_unicode_error(self):
122
72
        try:
128
78
    def test_format_exception(self):
129
79
        """Short formatting of bzr exceptions"""
130
80
        try:
131
 
            raise errors.NotBranchError('wibble')
 
81
            raise errors.NotBranchError, 'wibble'
132
82
        except errors.NotBranchError:
133
83
            pass
134
84
        msg = _format_exception()
135
85
        self.assertTrue(len(msg) > 0)
136
 
        self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
137
 
 
138
 
    def test_report_external_import_error(self):
139
 
        """Short friendly message for missing system modules."""
140
 
        try:
141
 
            import ImaginaryModule
142
 
        except ImportError, e:
143
 
            pass
144
 
        else:
145
 
            self.fail("somehow succeeded in importing %r" % ImaginaryModule)
146
 
        msg = _format_exception()
147
 
        self.assertEqual(msg,
148
 
            'bzr: ERROR: No module named ImaginaryModule\n'
149
 
            'You may need to install this Python library separately.\n')
150
 
 
151
 
    def test_report_import_syntax_error(self):
152
 
        try:
153
 
            raise ImportError("syntax error")
154
 
        except ImportError, e:
155
 
            pass
156
 
        msg = _format_exception()
157
 
        self.assertContainsRe(msg,
158
 
            r'Bazaar has encountered an internal error')
 
86
        self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: wibble\n')
159
87
 
160
88
    def test_trace_unicode(self):
161
89
        """Write Unicode to trace log"""
162
 
        self.log(u'the unicode character for benzene is \N{BENZENE RING}')
163
 
        log = self.get_log()
164
 
        self.assertContainsRe(log, "the unicode character for benzene is")
165
 
 
 
90
        mutter(u'the unicode character for benzene is \N{BENZENE RING}')
 
91
        self._log_file.flush()
 
92
        self.assertContainsRe(self._get_log(), 'the unicode character',)
 
93
    
166
94
    def test_trace_argument_unicode(self):
167
95
        """Write a Unicode argument to the trace log"""
168
96
        mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
169
 
        log = self.get_log()
170
 
        self.assertContainsRe(log, 'the unicode character')
 
97
        self._log_file.flush()
 
98
        self.assertContainsRe(self._get_log(), 'the unicode character')
171
99
 
172
100
    def test_trace_argument_utf8(self):
173
101
        """Write a Unicode argument to the trace log"""
174
102
        mutter(u'the unicode character for benzene is %s',
175
103
               u'\N{BENZENE RING}'.encode('utf-8'))
176
 
        log = self.get_log()
177
 
        self.assertContainsRe(log, 'the unicode character')
 
104
        self._log_file.flush()
 
105
        self.assertContainsRe(self._get_log(), 'the unicode character')
178
106
 
179
107
    def test_report_broken_pipe(self):
180
108
        try:
185
113
        else:
186
114
            self.fail("expected error not raised")
187
115
 
188
 
    def assertLogStartsWith(self, log, string):
189
 
        """Like assertStartsWith, but skips the log timestamp."""
190
 
        self.assertContainsRe(log,
191
 
            '^\\d+\\.\\d+  ' + re.escape(string))
192
 
 
193
 
    def test_mutter_callsite_1(self):
194
 
        """mutter_callsite can capture 1 level of stack frame."""
195
 
        mutter_callsite(1, "foo %s", "a string")
196
 
        log = self.get_log()
197
 
        # begin with the message
198
 
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
199
 
        # should show two frame: this frame and the one above
200
 
        self.assertContainsRe(log,
201
 
            'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
202
 
        # this frame should be the final one
203
 
        self.assertEndsWith(log, ' "a string")\n')
204
 
 
205
 
    def test_mutter_callsite_2(self):
206
 
        """mutter_callsite can capture 2 levels of stack frame."""
207
 
        mutter_callsite(2, "foo %s", "a string")
208
 
        log = self.get_log()
209
 
        # begin with the message
210
 
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
211
 
        # should show two frame: this frame and the one above
212
 
        self.assertContainsRe(log,
213
 
            'test_trace.py", line \d+, in test_mutter_callsite_2\n')
214
 
        # this frame should be the final one
215
 
        self.assertEndsWith(log, ' "a string")\n')
216
 
 
217
116
    def test_mutter_never_fails(self):
218
117
        # Even if the decode/encode stage fails, mutter should not
219
118
        # raise an exception
220
 
        # This test checks that mutter doesn't fail; the current behaviour
221
 
        # is that it doesn't fail *and writes non-utf8*.
222
119
        mutter(u'Writing a greek mu (\xb5) works in a unicode string')
223
120
        mutter('But fails in an ascii string \xb5')
224
121
        mutter('and in an ascii argument: %s', '\xb5')
225
 
        log = self.get_log()
 
122
        # TODO: jam 20051227 mutter() doesn't flush the log file, and
 
123
        #       self._get_log() opens the file directly and reads it.
 
124
        #       So we need to manually flush the log file
 
125
        self._log_file.flush()
 
126
        log = self._get_log()
226
127
        self.assertContainsRe(log, 'Writing a greek mu')
227
128
        self.assertContainsRe(log, "But fails in an ascii string")
228
 
        # However, the log content object does unicode replacement on reading
229
 
        # to let it get unicode back where good data has been written. So we
230
 
        # have to do a replaceent here as well.
231
 
        self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
232
 
            'replace'))
233
 
        
234
 
    def test_show_error(self):
235
 
        show_error('error1')
236
 
        show_error(u'error2 \xb5 blah')
237
 
        show_error('arg: %s', 'blah')
238
 
        show_error('arg2: %(key)s', {'key':'stuff'})
239
 
        try:
240
 
            raise Exception("oops")
241
 
        except:
242
 
            show_error('kwarg', exc_info=True)
243
 
        log = self.get_log()
244
 
        self.assertContainsRe(log, 'error1')
245
 
        self.assertContainsRe(log, u'error2 \xb5 blah')
246
 
        self.assertContainsRe(log, 'arg: blah')
247
 
        self.assertContainsRe(log, 'arg2: stuff')
248
 
        self.assertContainsRe(log, 'kwarg')
249
 
        self.assertContainsRe(log, 'Traceback \\(most recent call last\\):')
250
 
        self.assertContainsRe(log, 'File ".*test_trace.py", line .*, in test_show_error')
251
 
        self.assertContainsRe(log, 'raise Exception\\("oops"\\)')
252
 
        self.assertContainsRe(log, 'Exception: oops')
253
 
 
254
 
    def test_push_log_file(self):
255
 
        """Can push and pop log file, and this catches mutter messages.
256
 
 
257
 
        This is primarily for use in the test framework.
258
 
        """
259
 
        tmp1 = tempfile.NamedTemporaryFile()
260
 
        tmp2 = tempfile.NamedTemporaryFile()
261
 
        try:
262
 
            memento1 = push_log_file(tmp1)
263
 
            mutter("comment to file1")
264
 
            try:
265
 
                memento2 = push_log_file(tmp2)
266
 
                try:
267
 
                    mutter("comment to file2")
268
 
                finally:
269
 
                    pop_log_file(memento2)
270
 
                mutter("again to file1")
271
 
            finally:
272
 
                pop_log_file(memento1)
273
 
            # the files were opened in binary mode, so should have exactly
274
 
            # these bytes.  and removing the file as the log target should
275
 
            # have caused them to be flushed out.  need to match using regexps
276
 
            # as there's a timestamp at the front.
277
 
            tmp1.seek(0)
278
 
            self.assertContainsRe(tmp1.read(),
279
 
                r"\d+\.\d+  comment to file1\n\d+\.\d+  again to file1\n")
280
 
            tmp2.seek(0)
281
 
            self.assertContainsRe(tmp2.read(),
282
 
                r"\d+\.\d+  comment to file2\n")
283
 
        finally:
284
 
            tmp1.close()
285
 
            tmp2.close()
286
 
 
287
 
    def test__open_bzr_log_uses_stderr_for_failures(self):
288
 
        # If _open_bzr_log cannot open the file, then we should write the
289
 
        # warning to stderr. Since this is normally happening before logging is
290
 
        # set up.
291
 
        self.overrideAttr(sys, 'stderr', StringIO())
292
 
        # Set the log file to something that cannot exist
293
 
        # FIXME: A bit dangerous: we are not in an isolated dir here -- vilajam
294
 
        # 20100125
295
 
        os.environ['BZR_LOG'] = os.getcwd() + '/no-dir/bzr.log'
296
 
        self.overrideAttr(trace, '_bzr_log_filename')
297
 
        logf = trace._open_bzr_log()
298
 
        self.assertIs(None, logf)
299
 
        self.assertContainsRe(sys.stderr.getvalue(),
300
 
                              'failed to open trace file: .*/no-dir/bzr.log')
301
 
 
302
 
 
303
 
class TestVerbosityLevel(TestCase):
304
 
 
305
 
    def test_verbosity_level(self):
306
 
        set_verbosity_level(1)
307
 
        self.assertEqual(1, get_verbosity_level())
308
 
        self.assertTrue(is_verbose())
309
 
        self.assertFalse(is_quiet())
310
 
        set_verbosity_level(-1)
311
 
        self.assertEqual(-1, get_verbosity_level())
312
 
        self.assertFalse(is_verbose())
313
 
        self.assertTrue(is_quiet())
314
 
        set_verbosity_level(0)
315
 
        self.assertEqual(0, get_verbosity_level())
316
 
        self.assertFalse(is_verbose())
317
 
        self.assertFalse(is_quiet())
318
 
 
319
 
    def test_be_quiet(self):
320
 
        # Confirm the old API still works
321
 
        be_quiet(True)
322
 
        self.assertEqual(-1, get_verbosity_level())
323
 
        be_quiet(False)
324
 
        self.assertEqual(0, get_verbosity_level())
325
 
 
326
 
 
327
 
class TestBzrLog(TestCaseInTempDir):
328
 
 
329
 
    def test_log_rollover(self):
330
 
        temp_log_name = 'test-log'
331
 
        trace_file = open(temp_log_name, 'at')
332
 
        trace_file.writelines(['test_log_rollover padding\n'] * 200000)
333
 
        trace_file.close()
334
 
        _rollover_trace_maybe(temp_log_name)
335
 
        # should have been rolled over
336
 
        self.assertFalse(os.access(temp_log_name, os.R_OK))
 
129
        self.assertContainsRe(log, u"ascii argument: \xb5")