~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Martin Pool
  • Date: 2005-08-30 01:35:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050830013540-34e8996a86ba25fb
- rename FunctionalTest to TestCaseInTempDir

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
#
3
1
# This program is free software; you can redistribute it and/or modify
4
2
# it under the terms of the GNU General Public License as published by
5
3
# the Free Software Foundation; either version 2 of the License, or
6
4
# (at your option) any later version.
7
 
#
 
5
 
8
6
# This program is distributed in the hope that it will be useful,
9
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
9
# GNU General Public License for more details.
12
 
#
 
10
 
13
11
# You should have received a copy of the GNU General Public License
14
12
# along with this program; if not, write to the Free Software
15
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
14
 
17
 
"""Messages and logging for bazaar-ng.
18
 
 
19
 
Messages are supplied by callers as a string-formatting template, plus values
20
 
to be inserted into it.  The actual %-formatting is deferred to the log
21
 
library so that it doesn't need to be done for messages that won't be emitted.
22
 
 
23
 
Messages are classified by severity levels: critical, error, warning, info,
24
 
and debug.
25
 
 
26
 
They can be sent to two places: to stderr, and to ~/.bzr.log.  For purposes
27
 
such as running the test suite, they can also be redirected away from both of
28
 
those two places to another location.
29
 
 
30
 
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
31
 
This trace file is always in UTF-8, regardless of the user's default encoding,
32
 
so that we can always rely on writing any message.
33
 
 
34
 
Output to stderr depends on the mode chosen by the user.  By default, messages
35
 
of info and above are sent out, which results in progress messages such as the
36
 
list of files processed by add and commit.  In quiet mode, only warnings and
37
 
above are shown.  In debug mode, stderr gets debug messages too.
38
 
 
39
 
Errors that terminate an operation are generally passed back as exceptions;
40
 
others may be just emitted as messages.
41
 
 
42
 
Exceptions are reported in a brief form to stderr so as not to look scary.
43
 
BzrErrors are required to be able to format themselves into a properly
44
 
explanatory message.  This is not true for builtin exceptions such as
45
 
KeyError, which typically just str to "0".  They're printed in a different
46
 
form.
 
15
 
 
16
"""Messages and logging for bazaar-ng
 
17
 
 
18
Messages are sent out through the Python logging library.
 
19
 
 
20
They can be sent to two places: to stderr, and to ~/.bzr.log.
 
21
 
 
22
~/.bzr.log gets all messages, and tracebacks of all uncaught
 
23
exceptions.
 
24
 
 
25
Normally stderr only gets messages of level INFO and higher, and gets
 
26
only a summary of exceptions, not the traceback.
47
27
"""
48
28
 
49
 
# FIXME: Unfortunately it turns out that python's logging module
50
 
# is quite expensive, even when the message is not printed by any handlers.
51
 
# We should perhaps change back to just simply doing it here.
52
 
 
53
 
 
54
 
import errno
 
29
 
 
30
# TODO: in debug mode, stderr should get full tracebacks and also
 
31
# debug messages.  (Is this really needed?)
 
32
 
 
33
# TODO: When running the test suites, we should add an additional
 
34
# logger that sends messages into the test log file.
 
35
 
 
36
 
 
37
import sys
55
38
import os
56
 
import sys
57
39
import logging
 
40
import traceback
58
41
 
59
 
import bzrlib
60
 
from bzrlib.errors import BzrError, BzrNewError
61
 
from bzrlib.symbol_versioning import (deprecated_function,
62
 
        zero_nine,
63
 
        )
64
42
 
65
43
_file_handler = None
66
44
_stderr_handler = None
67
 
_stderr_quiet = False
68
 
_trace_file = None
69
 
_trace_depth = 0
70
 
_bzr_log_file = None
71
 
 
72
 
 
 
45
 
 
46
 
 
47
class QuietFormatter(logging.Formatter):
 
48
    """Formatter that supresses the details of errors.
 
49
 
 
50
    This is used by default on stderr so as not to scare the user.
 
51
    """
 
52
    # At first I tried overriding formatException to suppress the
 
53
    # exception details, but that has global effect: no loggers
 
54
    # can get the exception details is we suppress them here.
 
55
 
 
56
    def format(self, record):
 
57
        s = 'bzr: '
 
58
        if record.levelno >= logging.WARNING:
 
59
            s += record.levelname + ': '
 
60
            
 
61
        s += record.getMessage() 
 
62
            
 
63
        if record.exc_info:
 
64
            # give just a summary of the exception, not the whole thing
 
65
            exinfo = traceback.extract_tb(record.exc_info[2])
 
66
            # the format of this string matches one of the REs
 
67
            s += '\n'
 
68
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
 
69
            s += '  see ~/.bzr.log for debug information'
 
70
 
 
71
        return s
 
72
        
 
73
 
 
74
 
 
75
 
 
76
################
73
77
# configure convenient aliases for output routines
74
78
 
75
79
_bzr_logger = logging.getLogger('bzr')
76
 
 
77
 
def note(*args, **kwargs):
78
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
79
 
    import bzrlib.ui
80
 
    bzrlib.ui.ui_factory.clear_term()
81
 
    _bzr_logger.info(*args, **kwargs)
82
 
 
83
 
def warning(*args, **kwargs):
84
 
    import bzrlib.ui
85
 
    bzrlib.ui.ui_factory.clear_term()
86
 
    _bzr_logger.warning(*args, **kwargs)
87
 
 
88
 
info = note
 
80
_bzr_logger.setLevel(logging.DEBUG) 
 
81
 
 
82
info = note = _bzr_logger.info
 
83
warning =   _bzr_logger.warning
89
84
log_error = _bzr_logger.error
90
85
error =     _bzr_logger.error
91
 
 
92
 
 
93
 
def mutter(fmt, *args):
94
 
    if _trace_file is None:
95
 
        return
96
 
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
97
 
        return
98
 
    if len(args) > 0:
99
 
        # It seems that if we do ascii % (unicode, ascii) we can
100
 
        # get a unicode cannot encode ascii error, so make sure that "fmt"
101
 
        # is a unicode string
102
 
        out = unicode(fmt) % args
103
 
    else:
104
 
        out = fmt
105
 
    out += '\n'
106
 
    try:
107
 
        _trace_file.write(out)
108
 
    except UnicodeError, e:
109
 
        warning('UnicodeError: %s', e)
110
 
        _trace_file.write(repr(out))
111
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
112
 
    #_trace_file.flush()
113
 
debug = mutter
114
 
 
 
86
mutter =    _bzr_logger.debug
 
87
debug =     _bzr_logger.debug
 
88
 
 
89
 
 
90
 
 
91
 
 
92
# we do the rollover using this code, rather than the default from python
 
93
# logging, because we only want to rollover at program startup, not on each
 
94
# message.  maybe that's not a good enough reason.
115
95
 
116
96
def _rollover_trace_maybe(trace_fname):
117
97
    import stat
120
100
        if size <= 4 << 20:
121
101
            return
122
102
        old_fname = trace_fname + '.old'
123
 
        from osutils import rename
124
 
        rename(trace_fname, old_fname)
 
103
 
 
104
        try:
 
105
            # must remove before rename on windows
 
106
            os.remove(old_fname)
 
107
        except OSError:
 
108
            pass
 
109
 
 
110
        try:
 
111
            # might fail if in use on windows
 
112
            os.rename(trace_fname, old_fname)
 
113
        except OSError:
 
114
            pass
125
115
    except OSError:
126
116
        return
127
117
 
128
118
 
 
119
 
129
120
def open_tracefile(tracefilename='~/.bzr.log'):
130
121
    # Messages are always written to here, so that we have some
131
122
    # information if something goes wrong.  In a future version this
132
123
    # file will be removed on successful completion.
133
 
    global _file_handler, _bzr_log_file
134
 
    import codecs
 
124
    global _file_handler
 
125
    import stat, codecs
135
126
 
136
127
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
137
128
    _rollover_trace_maybe(trace_fname)
 
129
 
 
130
    # buffering=1 means line buffered
138
131
    try:
139
 
        LINE_BUFFERED = 1
140
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
141
 
        _bzr_log_file = tf
142
 
        if tf.tell() == 0:
 
132
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
133
 
 
134
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
143
135
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
144
136
            tf.write("you can delete or truncate this file, or include sections in\n")
145
137
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
138
        
146
139
        _file_handler = logging.StreamHandler(tf)
147
140
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
148
141
        datefmt = r'%a %H:%M:%S'
149
142
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
150
143
        _file_handler.setLevel(logging.DEBUG)
151
144
        logging.getLogger('').addHandler(_file_handler)
 
145
 
152
146
    except IOError, e:
153
147
        warning("failed to open trace file: %s" % (e))
154
148
 
155
149
 
156
 
@deprecated_function(zero_nine)
 
150
def log_startup(argv):
 
151
    import bzrlib
 
152
 
 
153
    debug('bzr %s invoked on python %s (%s)',
 
154
          bzrlib.__version__,
 
155
          '.'.join(map(str, sys.version_info)),
 
156
          sys.platform)
 
157
 
 
158
    debug('  arguments: %r', argv)
 
159
    debug('  working dir: %s', os.getcwdu())
 
160
 
 
161
 
157
162
def log_exception(msg=None):
158
 
    """Log the last exception to stderr and the trace file.
 
163
    """Log the last exception into the trace file.
159
164
 
160
165
    The exception string representation is used as the error
161
166
    summary, unless msg is given.
162
167
    """
163
 
    if msg:
164
 
        error(msg)
165
 
    else:
166
 
        exc_str = format_exception_short(sys.exc_info())
167
 
        error(exc_str)
168
 
    log_exception_quietly()
169
 
 
170
 
 
171
 
def log_exception_quietly():
172
 
    """Log the last exception to the trace file only.
173
 
 
174
 
    Used for exceptions that occur internally and that may be 
175
 
    interesting to developers but not to users.  For example, 
176
 
    errors loading plugins.
177
 
    """
178
 
    import traceback
179
 
    debug(traceback.format_exc())
 
168
    if msg == None:
 
169
        ei = sys.exc_info()
 
170
        msg = str(ei[1])
 
171
 
 
172
    if msg and (msg[-1] == '\n'):
 
173
        msg = msg[:-1]
 
174
        
 
175
    _bzr_logger.exception(msg)
 
176
 
180
177
 
181
178
 
182
179
def enable_default_logging():
183
180
    """Configure default logging to stderr and .bzr.log"""
184
 
    # FIXME: if this is run twice, things get confused
185
 
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
181
    global _stderr_handler, _file_handler
 
182
 
186
183
    _stderr_handler = logging.StreamHandler()
187
 
    logging.getLogger('').addHandler(_stderr_handler)
188
 
    _stderr_handler.setLevel(logging.INFO)
 
184
    _stderr_handler.setFormatter(QuietFormatter())
 
185
 
189
186
    if not _file_handler:
190
187
        open_tracefile()
191
 
    _trace_file = _bzr_log_file
192
 
    if _file_handler:
193
 
        _file_handler.setLevel(logging.DEBUG)
194
 
    _bzr_logger.setLevel(logging.DEBUG)
195
 
 
196
 
 
197
 
def be_quiet(quiet=True):
198
 
    global _stderr_handler, _stderr_quiet
199
 
    
200
 
    _stderr_quiet = quiet
201
 
    if quiet:
202
 
        _stderr_handler.setLevel(logging.WARNING)
 
188
 
 
189
    if os.environ.get('BZR_DEBUG'):
 
190
        level = logging.DEBUG
203
191
    else:
204
 
        _stderr_handler.setLevel(logging.INFO)
205
 
 
206
 
 
207
 
def is_quiet():
208
 
    global _stderr_quiet
209
 
    return _stderr_quiet
 
192
        level = logging.INFO
 
193
 
 
194
    _stderr_handler.setLevel(logging.INFO)
 
195
    _file_handler.setLevel(level)
 
196
 
 
197
    logging.getLogger('').addHandler(_stderr_handler)
 
198
 
210
199
 
211
200
 
212
201
def disable_default_logging():
220
209
    l.removeHandler(_stderr_handler)
221
210
    if _file_handler:
222
211
        l.removeHandler(_file_handler)
223
 
    _trace_file = None
224
 
 
225
 
 
226
 
def enable_test_log(to_file):
227
 
    """Redirect logging to a temporary file for a test
228
 
    
229
 
    returns an opaque reference that should be passed to disable_test_log
230
 
    after the test completes.
231
 
    """
232
 
    disable_default_logging()
233
 
    global _trace_file
234
 
    global _trace_depth
235
 
    hdlr = logging.StreamHandler(to_file)
236
 
    hdlr.setLevel(logging.DEBUG)
237
 
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
238
 
    _bzr_logger.addHandler(hdlr)
239
 
    _bzr_logger.setLevel(logging.DEBUG)
240
 
    result = hdlr, _trace_file, _trace_depth
241
 
    _trace_file = to_file
242
 
    _trace_depth += 1
243
 
    return result
244
 
 
245
 
 
246
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
247
 
    _bzr_logger.removeHandler(test_log_hdlr)
248
 
    test_log_hdlr.close()
249
 
    global _trace_file
250
 
    global _trace_depth
251
 
    _trace_file = old_trace_file
252
 
    _trace_depth = old_trace_depth
253
 
    if not _trace_depth:
254
 
        enable_default_logging()
255
 
 
256
 
 
257
 
def report_exception(exc_info, err_file):
258
 
    exc_type, exc_object, exc_tb = exc_info
259
 
    # Log the full traceback to ~/.bzr.log
260
 
    log_exception_quietly()
261
 
    if (isinstance(exc_object, IOError)
262
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
263
 
        print >>err_file, "bzr: broken pipe"
264
 
    elif isinstance(exc_object, KeyboardInterrupt):
265
 
        print >>err_file, "bzr: interrupted"
266
 
    elif getattr(exc_object, 'is_user_error', False):
267
 
        report_user_error(exc_info, err_file)
268
 
    elif isinstance(exc_object, (OSError, IOError)):
269
 
        # Might be nice to catch all of these and show them as something more
270
 
        # specific, but there are too many cases at the moment.
271
 
        report_user_error(exc_info, err_file)
272
 
    else:
273
 
        report_bug(exc_info, err_file)
274
 
 
275
 
 
276
 
# TODO: Should these be specially encoding the output?
277
 
def report_user_error(exc_info, err_file):
278
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
279
 
 
280
 
 
281
 
def report_bug(exc_info, err_file):
282
 
    """Report an exception that probably indicates a bug in bzr"""
283
 
    import traceback
284
 
    exc_type, exc_object, exc_tb = exc_info
285
 
    print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
286
 
    print >>err_file
287
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
288
 
    print >>err_file
289
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
290
 
                       (bzrlib.__version__,
291
 
                        '.'.join(map(str, sys.version_info)),
292
 
                        sys.platform)
293
 
    print >>err_file, 'arguments: %r' % sys.argv
294
 
    print >>err_file
295
 
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"