~bzr-pqm/bzr/bzr.dev

6614.1.3 by Vincent Ladeuil
Fix assertEquals being deprecated by using assertEqual.
1
# Copyright (C) 2005-2011, 2016 Canonical Ltd
1185.33.9 by Martin Pool
Add new selftest module.
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1185.33.9 by Martin Pool
Add new selftest module.
16
17
# "weren't nothing promised to you.  do i look like i got a promise face?"
18
19
"""Tests for trace library"""
20
1948.1.5 by John Arbash Meinel
Make sure BzrCommandError can handle unicode arguments
21
from cStringIO import StringIO
1740.5.7 by Martin Pool
Add test for formatting of EPIPE
22
import errno
6015.52.1 by Martin Packman
Add tests for logging various problematic values
23
import logging
1185.33.9 by Martin Pool
Add new selftest module.
24
import os
3195.1.1 by Andrew Bennetts
Always include timestamps in the trace file (i.e. remove -Dtimes in favour of having it switched on permanently)
25
import re
1185.33.9 by Martin Pool
Add new selftest module.
26
import sys
3173.1.12 by Martin Pool
Add test_push_log_file
27
import tempfile
1185.33.9 by Martin Pool
Add new selftest module.
28
1948.1.5 by John Arbash Meinel
Make sure BzrCommandError can handle unicode arguments
29
from bzrlib import (
5448.5.8 by Karl Bielefeldt
Add test for message format with -Dmem_dump
30
    debug,
1948.1.5 by John Arbash Meinel
Make sure BzrCommandError can handle unicode arguments
31
    errors,
4634.118.1 by John Arbash Meinel
Fix bug #503886, errors setting up logging go to stderr.
32
    trace,
1948.1.5 by John Arbash Meinel
Make sure BzrCommandError can handle unicode arguments
33
    )
5200.4.5 by Martin
Move pywintypes ModuleAvailableFeature to bzrlib.tests.features
34
from bzrlib.tests import features, TestCaseInTempDir, TestCase
2768.1.10 by Ian Clatworthy
Add tests for new methods in trace.py
35
from bzrlib.trace import (
36
    mutter, mutter_callsite, report_exception,
37
    set_verbosity_level, get_verbosity_level, is_quiet, is_verbose, be_quiet,
3173.1.12 by Martin Pool
Add test_push_log_file
38
    pop_log_file,
39
    push_log_file,
2851.3.1 by Martin Pool
Add unit test for _rollover_trace_maybe
40
    _rollover_trace_maybe,
5055.4.1 by Gordon Tyler
Fixed show_error args and added test for show_error.
41
    show_error,
2768.1.10 by Ian Clatworthy
Add tests for new methods in trace.py
42
    )
1185.33.9 by Martin Pool
Add new selftest module.
43
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
44
45
def _format_exception():
46
    """Format an exception as it would normally be displayed to the user"""
47
    buf = StringIO()
5765.1.1 by John Arbash Meinel
Merge Federico Culloca's PointlessCommit message, and revert accidental changes.
48
    report_exception(sys.exc_info(), buf)
1551.9.3 by Aaron Bentley
Revert buggy apport changes
49
    return buf.getvalue()
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
50
51
1185.33.9 by Martin Pool
Add new selftest module.
52
class TestTrace(TestCase):
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
53
1551.9.3 by Aaron Bentley
Revert buggy apport changes
54
    def test_format_sys_exception(self):
4584.3.20 by Martin Pool
Tweak trace tests to cope without the traceback being printed
55
        # Test handling of an internal/unexpected error that probably
56
        # indicates a bug in bzr.  The details of the message may vary
57
        # depending on whether apport is available or not.  See test_crash for
58
        # more.
1185.33.9 by Martin Pool
Add new selftest module.
59
        try:
60
            raise NotImplementedError, "time travel"
61
        except NotImplementedError:
62
            pass
1551.9.3 by Aaron Bentley
Revert buggy apport changes
63
        err = _format_exception()
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
64
        self.assertEqualDiff(err.splitlines()[0],
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
65
                'bzr: ERROR: exceptions.NotImplementedError: time travel')
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
66
        self.assertContainsRe(err,
4584.3.20 by Martin Pool
Tweak trace tests to cope without the traceback being printed
67
            'Bazaar has encountered an internal error.')
1185.33.9 by Martin Pool
Add new selftest module.
68
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
69
    def test_format_interrupt_exception(self):
70
        try:
71
            raise KeyboardInterrupt()
1740.5.5 by Martin Pool
Show short form for OSError and IOError too
72
        except KeyboardInterrupt:
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
73
            # XXX: Some risk that a *real* keyboard interrupt won't be seen
74
            pass
1551.9.3 by Aaron Bentley
Revert buggy apport changes
75
        msg = _format_exception()
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
76
        self.assertTrue(len(msg) > 0)
77
        self.assertEqualDiff(msg, 'bzr: interrupted\n')
78
4634.26.1 by Martin Pool
Cleaner message when out of memory
79
    def test_format_memory_error(self):
80
        try:
81
            raise MemoryError()
82
        except MemoryError:
83
            pass
84
        msg = _format_exception()
6614.1.3 by Vincent Ladeuil
Fix assertEquals being deprecated by using assertEqual.
85
        self.assertEqual(msg,
5448.5.7 by Karl Bielefeldt
Fix test_format_memory_error self test
86
            "bzr: out of memory\nUse -Dmem_dump to dump memory to a file.\n")
4634.26.1 by Martin Pool
Cleaner message when out of memory
87
5448.5.8 by Karl Bielefeldt
Add test for message format with -Dmem_dump
88
    def test_format_mem_dump(self):
6091.2.2 by Max Bowsher
Per jam's review comments, get rid of features.meliae_feature, which is new in
89
        self.requireFeature(features.meliae)
5448.5.8 by Karl Bielefeldt
Add test for message format with -Dmem_dump
90
        debug.debug_flags.add('mem_dump')
91
        try:
92
            raise MemoryError()
93
        except MemoryError:
94
            pass
95
        msg = _format_exception()
96
        self.assertStartsWith(msg,
97
            "bzr: out of memory\nMemory dumped to ")
98
1740.5.5 by Martin Pool
Show short form for OSError and IOError too
99
    def test_format_os_error(self):
100
        try:
4095.1.1 by Martin Pool
Add more distinct tests for IOError and OSError
101
            os.rmdir('nosuchfile22222')
4789.22.1 by John Arbash Meinel
Fix a test_trace failure on Windows.
102
        except OSError, e:
103
            e_str = str(e)
4095.1.1 by Martin Pool
Add more distinct tests for IOError and OSError
104
        msg = _format_exception()
4789.22.1 by John Arbash Meinel
Fix a test_trace failure on Windows.
105
        # Linux seems to give "No such file" but Windows gives "The system
106
        # cannot find the file specified".
107
        self.assertEqual('bzr: ERROR: %s\n' % (e_str,), msg)
4095.1.1 by Martin Pool
Add more distinct tests for IOError and OSError
108
109
    def test_format_io_error(self):
110
        try:
1740.5.5 by Martin Pool
Show short form for OSError and IOError too
111
            file('nosuchfile22222')
4095.1.1 by Martin Pool
Add more distinct tests for IOError and OSError
112
        except IOError:
1740.5.5 by Martin Pool
Show short form for OSError and IOError too
113
            pass
1551.9.3 by Aaron Bentley
Revert buggy apport changes
114
        msg = _format_exception()
4789.22.1 by John Arbash Meinel
Fix a test_trace failure on Windows.
115
        # Even though Windows and Linux differ for 'os.rmdir', they both give
116
        # 'No such file' for open()
6138.3.11 by Jonathan Riddell
this test gets translated so can not check for specific message
117
        # However it now gets translated so we can not test for a specific message
4789.22.1 by John Arbash Meinel
Fix a test_trace failure on Windows.
118
        self.assertContainsRe(msg,
6138.3.11 by Jonathan Riddell
this test gets translated so can not check for specific message
119
            r'^bzr: ERROR: \[Errno .*\] .*nosuchfile')
1740.5.5 by Martin Pool
Show short form for OSError and IOError too
120
5200.4.1 by Martin
Test how pywintypes.error is displayed to the user
121
    def test_format_pywintypes_error(self):
5200.4.5 by Martin
Move pywintypes ModuleAvailableFeature to bzrlib.tests.features
122
        self.requireFeature(features.pywintypes)
5200.4.1 by Martin
Test how pywintypes.error is displayed to the user
123
        import pywintypes, win32file
124
        try:
125
            win32file.RemoveDirectory('nosuchfile22222')
126
        except pywintypes.error:
127
            pass
128
        msg = _format_exception()
129
        # GZ 2010-05-03: Formatting for pywintypes.error is basic, a 3-tuple
130
        #                with errno, function name, and locale error message
5200.4.2 by Martin
Treat pywintypes.error as a user error as per OSError, rather than an internal error
131
        self.assertContainsRe(msg,
5200.4.3 by Martin
Allow real with terminal A or W in function name for pywin32 trace test
132
            r"^bzr: ERROR: \(2, 'RemoveDirectory[AW]?', .*\)")
5920.2.1 by Toon Nolten
Added a test for a sockets.error that wasn't caught in versions prior to python 2.6
133
            
134
    def test_format_sockets_error(self):
135
        try:
5920.2.2 by Toon Nolten
Fixed typo, and import
136
            import socket
5920.2.1 by Toon Nolten
Added a test for a sockets.error that wasn't caught in versions prior to python 2.6
137
            sock = socket.socket()
5920.2.3 by Toon Nolten
More general test.
138
            sock.send("This should fail.")
5920.2.2 by Toon Nolten
Fixed typo, and import
139
        except socket.error:
5920.2.1 by Toon Nolten
Added a test for a sockets.error that wasn't caught in versions prior to python 2.6
140
            pass
141
        msg = _format_exception()
142
        
5920.2.3 by Toon Nolten
More general test.
143
        self.assertNotContainsRe(msg,
144
            r"Traceback (most recent call last):")
5200.4.1 by Martin
Test how pywintypes.error is displayed to the user
145
1948.1.5 by John Arbash Meinel
Make sure BzrCommandError can handle unicode arguments
146
    def test_format_unicode_error(self):
147
        try:
148
            raise errors.BzrCommandError(u'argument foo\xb5 does not exist')
149
        except errors.BzrCommandError:
150
            pass
1551.9.3 by Aaron Bentley
Revert buggy apport changes
151
        msg = _format_exception()
1740.5.5 by Martin Pool
Show short form for OSError and IOError too
152
1185.33.9 by Martin Pool
Add new selftest module.
153
    def test_format_exception(self):
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
154
        """Short formatting of bzr exceptions"""
1185.33.9 by Martin Pool
Add new selftest module.
155
        try:
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
156
            raise errors.NotBranchError('wibble')
1948.1.5 by John Arbash Meinel
Make sure BzrCommandError can handle unicode arguments
157
        except errors.NotBranchError:
1185.33.9 by Martin Pool
Add new selftest module.
158
            pass
1551.9.3 by Aaron Bentley
Revert buggy apport changes
159
        msg = _format_exception()
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
160
        self.assertTrue(len(msg) > 0)
2745.3.2 by Daniel Watkins
Updated tests to reflect new error text.
161
        self.assertEqualDiff(msg, 'bzr: ERROR: Not a branch: \"wibble\".\n')
1185.33.63 by Martin Pool
Better display of BzrError classes that are not BzrNewErrors.
162
3497.3.2 by Martin Pool
Show short error for missing libraries
163
    def test_report_external_import_error(self):
164
        """Short friendly message for missing system modules."""
165
        try:
166
            import ImaginaryModule
167
        except ImportError, e:
168
            pass
169
        else:
170
            self.fail("somehow succeeded in importing %r" % ImaginaryModule)
171
        msg = _format_exception()
172
        self.assertEqual(msg,
173
            'bzr: ERROR: No module named ImaginaryModule\n'
174
            'You may need to install this Python library separately.\n')
175
176
    def test_report_import_syntax_error(self):
177
        try:
178
            raise ImportError("syntax error")
179
        except ImportError, e:
180
            pass
181
        msg = _format_exception()
182
        self.assertContainsRe(msg,
4584.3.20 by Martin Pool
Tweak trace tests to cope without the traceback being printed
183
            r'Bazaar has encountered an internal error')
3497.3.2 by Martin Pool
Show short error for missing libraries
184
1185.33.51 by Martin Pool
Fix trace of non-ascii messages, and add test.
185
    def test_trace_unicode(self):
186
        """Write Unicode to trace log"""
187
        self.log(u'the unicode character for benzene is \N{BENZENE RING}')
4794.1.15 by Robert Collins
Review feedback.
188
        log = self.get_log()
4794.1.8 by Robert Collins
Move the passing of test logs to the result to be via the getDetails API and remove all public use of TestCase._get_log.
189
        self.assertContainsRe(log, "the unicode character for benzene is")
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
190
1948.1.2 by John Arbash Meinel
Fix the test_trace functions to actually test that things are written to the log
191
    def test_trace_argument_unicode(self):
192
        """Write a Unicode argument to the trace log"""
193
        mutter(u'the unicode character for benzene is %s', u'\N{BENZENE RING}')
4794.1.15 by Robert Collins
Review feedback.
194
        log = self.get_log()
4794.1.8 by Robert Collins
Move the passing of test logs to the result to be via the getDetails API and remove all public use of TestCase._get_log.
195
        self.assertContainsRe(log, 'the unicode character')
1185.85.5 by John Arbash Meinel
mutter() should not fail because of unicode errors
196
1948.1.3 by John Arbash Meinel
Fix mutter() so even if args are invalid, it still works
197
    def test_trace_argument_utf8(self):
198
        """Write a Unicode argument to the trace log"""
199
        mutter(u'the unicode character for benzene is %s',
200
               u'\N{BENZENE RING}'.encode('utf-8'))
4794.1.15 by Robert Collins
Review feedback.
201
        log = self.get_log()
4794.1.8 by Robert Collins
Move the passing of test logs to the result to be via the getDetails API and remove all public use of TestCase._get_log.
202
        self.assertContainsRe(log, 'the unicode character')
1948.1.3 by John Arbash Meinel
Fix mutter() so even if args are invalid, it still works
203
1740.5.7 by Martin Pool
Add test for formatting of EPIPE
204
    def test_report_broken_pipe(self):
205
        try:
206
            raise IOError(errno.EPIPE, 'broken pipe foofofo')
6614.1.3 by Vincent Ladeuil
Fix assertEquals being deprecated by using assertEqual.
207
        except IOError as e:
1551.9.3 by Aaron Bentley
Revert buggy apport changes
208
            msg = _format_exception()
6614.1.3 by Vincent Ladeuil
Fix assertEquals being deprecated by using assertEqual.
209
            self.assertEqual(msg, "bzr: broken pipe\n")
1740.5.7 by Martin Pool
Add test for formatting of EPIPE
210
        else:
211
            self.fail("expected error not raised")
1740.5.9 by Martin Pool
[merge] bzr.dev
212
3195.1.1 by Andrew Bennetts
Always include timestamps in the trace file (i.e. remove -Dtimes in favour of having it switched on permanently)
213
    def assertLogStartsWith(self, log, string):
214
        """Like assertStartsWith, but skips the log timestamp."""
215
        self.assertContainsRe(log,
216
            '^\\d+\\.\\d+  ' + re.escape(string))
217
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
218
    def test_mutter_callsite_1(self):
219
        """mutter_callsite can capture 1 level of stack frame."""
220
        mutter_callsite(1, "foo %s", "a string")
4794.1.15 by Robert Collins
Review feedback.
221
        log = self.get_log()
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
222
        # begin with the message
3195.1.1 by Andrew Bennetts
Always include timestamps in the trace file (i.e. remove -Dtimes in favour of having it switched on permanently)
223
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
224
        # should show two frame: this frame and the one above
225
        self.assertContainsRe(log,
3195.1.1 by Andrew Bennetts
Always include timestamps in the trace file (i.e. remove -Dtimes in favour of having it switched on permanently)
226
            'test_trace\\.py", line \\d+, in test_mutter_callsite_1\n')
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
227
        # this frame should be the final one
228
        self.assertEndsWith(log, ' "a string")\n')
229
230
    def test_mutter_callsite_2(self):
231
        """mutter_callsite can capture 2 levels of stack frame."""
232
        mutter_callsite(2, "foo %s", "a string")
4794.1.15 by Robert Collins
Review feedback.
233
        log = self.get_log()
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
234
        # begin with the message
3195.1.1 by Andrew Bennetts
Always include timestamps in the trace file (i.e. remove -Dtimes in favour of having it switched on permanently)
235
        self.assertLogStartsWith(log, 'foo a string\nCalled from:\n')
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
236
        # should show two frame: this frame and the one above
237
        self.assertContainsRe(log,
238
            'test_trace.py", line \d+, in test_mutter_callsite_2\n')
239
        # this frame should be the final one
240
        self.assertEndsWith(log, ' "a string")\n')
241
1185.85.5 by John Arbash Meinel
mutter() should not fail because of unicode errors
242
    def test_mutter_never_fails(self):
243
        # Even if the decode/encode stage fails, mutter should not
244
        # raise an exception
4794.1.8 by Robert Collins
Move the passing of test logs to the result to be via the getDetails API and remove all public use of TestCase._get_log.
245
        # This test checks that mutter doesn't fail; the current behaviour
246
        # is that it doesn't fail *and writes non-utf8*.
1185.85.5 by John Arbash Meinel
mutter() should not fail because of unicode errors
247
        mutter(u'Writing a greek mu (\xb5) works in a unicode string')
248
        mutter('But fails in an ascii string \xb5')
1948.1.4 by John Arbash Meinel
Update test_never_fails, to cover one of the failure points
249
        mutter('and in an ascii argument: %s', '\xb5')
4794.1.15 by Robert Collins
Review feedback.
250
        log = self.get_log()
1185.85.5 by John Arbash Meinel
mutter() should not fail because of unicode errors
251
        self.assertContainsRe(log, 'Writing a greek mu')
1948.1.9 by John Arbash Meinel
Change mutter() so that it doesn't try so hard to write out perfect utf8, instead, rather than using a utf8 file, it changes unicode to utf8 manually
252
        self.assertContainsRe(log, "But fails in an ascii string")
4794.1.8 by Robert Collins
Move the passing of test logs to the result to be via the getDetails API and remove all public use of TestCase._get_log.
253
        # However, the log content object does unicode replacement on reading
254
        # to let it get unicode back where good data has been written. So we
255
        # have to do a replaceent here as well.
256
        self.assertContainsRe(log, "ascii argument: \xb5".decode('utf8',
257
            'replace'))
6325.3.1 by Vincent Ladeuil
Give meaningful deprecation warnings for deprecated test features
258
5055.4.1 by Gordon Tyler
Fixed show_error args and added test for show_error.
259
    def test_show_error(self):
260
        show_error('error1')
261
        show_error(u'error2 \xb5 blah')
5055.4.2 by Gordon Tyler
Improved test_show_error to test kwargs passing.
262
        show_error('arg: %s', 'blah')
5055.4.3 by Gordon Tyler
Improved test_show_error to check kwargs, dict substitution and exception handling.
263
        show_error('arg2: %(key)s', {'key':'stuff'})
264
        try:
265
            raise Exception("oops")
266
        except:
267
            show_error('kwarg', exc_info=True)
5055.4.1 by Gordon Tyler
Fixed show_error args and added test for show_error.
268
        log = self.get_log()
269
        self.assertContainsRe(log, 'error1')
270
        self.assertContainsRe(log, u'error2 \xb5 blah')
5055.4.2 by Gordon Tyler
Improved test_show_error to test kwargs passing.
271
        self.assertContainsRe(log, 'arg: blah')
5055.4.3 by Gordon Tyler
Improved test_show_error to check kwargs, dict substitution and exception handling.
272
        self.assertContainsRe(log, 'arg2: stuff')
273
        self.assertContainsRe(log, 'kwarg')
274
        self.assertContainsRe(log, 'Traceback \\(most recent call last\\):')
275
        self.assertContainsRe(log, 'File ".*test_trace.py", line .*, in test_show_error')
276
        self.assertContainsRe(log, 'raise Exception\\("oops"\\)')
277
        self.assertContainsRe(log, 'Exception: oops')
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
278
3173.1.12 by Martin Pool
Add test_push_log_file
279
    def test_push_log_file(self):
280
        """Can push and pop log file, and this catches mutter messages.
281
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
282
        This is primarily for use in the test framework.
3173.1.12 by Martin Pool
Add test_push_log_file
283
        """
284
        tmp1 = tempfile.NamedTemporaryFile()
285
        tmp2 = tempfile.NamedTemporaryFile()
286
        try:
287
            memento1 = push_log_file(tmp1)
288
            mutter("comment to file1")
289
            try:
290
                memento2 = push_log_file(tmp2)
291
                try:
292
                    mutter("comment to file2")
293
                finally:
294
                    pop_log_file(memento2)
295
                mutter("again to file1")
296
            finally:
297
                pop_log_file(memento1)
298
            # the files were opened in binary mode, so should have exactly
299
            # these bytes.  and removing the file as the log target should
3173.1.15 by Martin Pool
Update test_push_log_file to handle there always being timestamps at the start of the trace messages
300
            # have caused them to be flushed out.  need to match using regexps
301
            # as there's a timestamp at the front.
302
            tmp1.seek(0)
303
            self.assertContainsRe(tmp1.read(),
304
                r"\d+\.\d+  comment to file1\n\d+\.\d+  again to file1\n")
305
            tmp2.seek(0)
306
            self.assertContainsRe(tmp2.read(),
307
                r"\d+\.\d+  comment to file2\n")
3173.1.12 by Martin Pool
Add test_push_log_file
308
        finally:
309
            tmp1.close()
310
            tmp2.close()
311
4634.118.1 by John Arbash Meinel
Fix bug #503886, errors setting up logging go to stderr.
312
    def test__open_bzr_log_uses_stderr_for_failures(self):
313
        # If _open_bzr_log cannot open the file, then we should write the
314
        # warning to stderr. Since this is normally happening before logging is
315
        # set up.
4985.1.5 by Vincent Ladeuil
Deploying the new overrideAttr facility further reduces the complexity
316
        self.overrideAttr(sys, 'stderr', StringIO())
4634.118.1 by John Arbash Meinel
Fix bug #503886, errors setting up logging go to stderr.
317
        # Set the log file to something that cannot exist
5570.3.9 by Vincent Ladeuil
More use cases for overrideEnv, _cleanEnvironment *may* contain too much variables now.
318
        self.overrideEnv('BZR_LOG', os.getcwd() + '/no-dir/bzr.log')
4985.1.5 by Vincent Ladeuil
Deploying the new overrideAttr facility further reduces the complexity
319
        self.overrideAttr(trace, '_bzr_log_filename')
4634.118.1 by John Arbash Meinel
Fix bug #503886, errors setting up logging go to stderr.
320
        logf = trace._open_bzr_log()
321
        self.assertIs(None, logf)
322
        self.assertContainsRe(sys.stderr.getvalue(),
323
                              'failed to open trace file: .*/no-dir/bzr.log')
2768.1.10 by Ian Clatworthy
Add tests for new methods in trace.py
324
4985.1.5 by Vincent Ladeuil
Deploying the new overrideAttr facility further reduces the complexity
325
2768.1.10 by Ian Clatworthy
Add tests for new methods in trace.py
326
class TestVerbosityLevel(TestCase):
327
328
    def test_verbosity_level(self):
329
        set_verbosity_level(1)
330
        self.assertEqual(1, get_verbosity_level())
331
        self.assertTrue(is_verbose())
332
        self.assertFalse(is_quiet())
333
        set_verbosity_level(-1)
334
        self.assertEqual(-1, get_verbosity_level())
335
        self.assertFalse(is_verbose())
336
        self.assertTrue(is_quiet())
337
        set_verbosity_level(0)
338
        self.assertEqual(0, get_verbosity_level())
339
        self.assertFalse(is_verbose())
340
        self.assertFalse(is_quiet())
341
342
    def test_be_quiet(self):
343
        # Confirm the old API still works
344
        be_quiet(True)
345
        self.assertEqual(-1, get_verbosity_level())
346
        be_quiet(False)
347
        self.assertEqual(0, get_verbosity_level())
2851.3.1 by Martin Pool
Add unit test for _rollover_trace_maybe
348
349
6015.52.1 by Martin Packman
Add tests for logging various problematic values
350
class TestLogging(TestCase):
351
    """Check logging functionality robustly records information"""
352
353
    def test_note(self):
354
        trace.note("Noted")
355
        self.assertEqual("    INFO  Noted\n", self.get_log())
356
357
    def test_warning(self):
358
        trace.warning("Warned")
359
        self.assertEqual(" WARNING  Warned\n", self.get_log())
360
361
    def test_log(self):
362
        logging.getLogger("bzr").error("Errored")
363
        self.assertEqual("   ERROR  Errored\n", self.get_log())
364
365
    def test_log_sub(self):
366
        logging.getLogger("bzr.test_log_sub").debug("Whispered")
367
        self.assertEqual("   DEBUG  Whispered\n", self.get_log())
368
369
    def test_log_unicode_msg(self):
370
        logging.getLogger("bzr").debug(u"\xa7")
371
        self.assertEqual(u"   DEBUG  \xa7\n", self.get_log())
372
373
    def test_log_unicode_arg(self):
374
        logging.getLogger("bzr").debug("%s", u"\xa7")
375
        self.assertEqual(u"   DEBUG  \xa7\n", self.get_log())
376
377
    def test_log_utf8_msg(self):
378
        logging.getLogger("bzr").debug("\xc2\xa7")
379
        self.assertEqual(u"   DEBUG  \xa7\n", self.get_log())
380
381
    def test_log_utf8_arg(self):
382
        logging.getLogger("bzr").debug("%s", "\xc2\xa7")
383
        self.assertEqual(u"   DEBUG  \xa7\n", self.get_log())
384
385
    def test_log_bytes_msg(self):
386
        logging.getLogger("bzr").debug("\xa7")
387
        log = self.get_log()
388
        self.assertContainsString(log, "UnicodeDecodeError: ")
389
        self.assertContainsString(log,
390
            "Logging record unformattable: '\\xa7' % ()\n")
391
392
    def test_log_bytes_arg(self):
393
        logging.getLogger("bzr").debug("%s", "\xa7")
394
        log = self.get_log()
395
        self.assertContainsString(log, "UnicodeDecodeError: ")
396
        self.assertContainsString(log,
397
            "Logging record unformattable: '%s' % ('\\xa7',)\n")
398
399
    def test_log_mixed_strings(self):
400
        logging.getLogger("bzr").debug(u"%s", "\xa7")
401
        log = self.get_log()
402
        self.assertContainsString(log, "UnicodeDecodeError: ")
403
        self.assertContainsString(log,
404
            "Logging record unformattable: u'%s' % ('\\xa7',)\n")
405
406
    def test_log_repr_broken(self):
407
        class BadRepr(object):
408
            def __repr__(self):
409
                raise ValueError("Broken object")
410
        logging.getLogger("bzr").debug("%s", BadRepr())
411
        log = self.get_log()
412
        self.assertContainsRe(log, "ValueError: Broken object\n")
413
        self.assertContainsRe(log, "Logging record unformattable: '%s' % .*\n")
414
415
2851.3.1 by Martin Pool
Add unit test for _rollover_trace_maybe
416
class TestBzrLog(TestCaseInTempDir):
417
418
    def test_log_rollover(self):
419
        temp_log_name = 'test-log'
420
        trace_file = open(temp_log_name, 'at')
4789.22.2 by John Arbash Meinel
Speed up a slow memory-hungry test that doesn't need to be.
421
        trace_file.writelines(['test_log_rollover padding\n'] * 200000)
2851.3.1 by Martin Pool
Add unit test for _rollover_trace_maybe
422
        trace_file.close()
423
        _rollover_trace_maybe(temp_log_name)
424
        # should have been rolled over
425
        self.assertFalse(os.access(temp_log_name, os.R_OK))
5320.2.5 by Robert Collins
Make bzrlib startup use a trace context manager.
426
427
428
class TestTraceConfiguration(TestCaseInTempDir):
429
430
    def test_default_config(self):
431
        config = trace.DefaultConfig()
432
        self.overrideAttr(trace, "_bzr_log_filename", None)
433
        trace._bzr_log_filename = None
434
        expected_filename = trace._get_bzr_log_filename()
435
        self.assertEqual(None, trace._bzr_log_filename)
436
        config.__enter__()
437
        try:
438
            # Should have entered and setup a default filename.
439
            self.assertEqual(expected_filename, trace._bzr_log_filename)
440
        finally:
441
            config.__exit__(None, None, None)
442
            # Should have exited and cleaned up.
443
            self.assertEqual(None, trace._bzr_log_filename)