18
18
"""Handling and reporting crashes.
20
A crash is an exception propagated up almost to the top level of Bazaar.
22
If we have apport <https://launchpad.net/apport/>, we store a report of the
23
crash using apport into it's /var/crash spool directory, from where the user
24
can either manually send it to Launchpad. In some cases (at least Ubuntu
25
development releases), Apport may pop up a window asking if they want
28
Without apport, we just write a crash report to stderr and the user can report
29
this manually if the wish.
31
We never send crash data across the network without user opt-in.
33
In principle apport can run on any platform though as of Feb 2010 there seem
34
to be some portability bugs.
36
To force this off in bzr turn set APPORT_DISBLE in the environment or
21
40
# for interactive testing, try the 'bzr assert-fail' command
22
41
# or see http://code.launchpad.net/~mbp/bzr/bzr-fail
43
# to test with apport it's useful to set
44
# export APPORT_IGNORE_OBSOLETE_PACKAGES=1
41
63
def report_bug(exc_info, stderr):
42
if 'no_apport' not in debug.debug_flags:
44
report_bug_to_apport(exc_info, stderr)
64
if ('no_apport' in debug.debug_flags) or \
65
os.environ.get('APPORT_DISABLE', None):
66
return report_bug_legacy(exc_info, stderr)
68
if report_bug_to_apport(exc_info, stderr):
69
# wrote a file; if None then report the old way
46
except ImportError, e:
47
trace.mutter("couldn't find apport bug-reporting library: %s" % e)
50
# this should only happen if apport is installed but it didn't
51
# work, eg because of an io error writing the crash file
52
sys.stderr.write("bzr: failed to report crash using apport:\n "
55
report_bug_legacy(exc_info, stderr)
71
except ImportError, e:
72
trace.mutter("couldn't find apport bug-reporting library: %s" % e)
75
# this should only happen if apport is installed but it didn't
76
# work, eg because of an io error writing the crash file
77
stderr.write("bzr: failed to report crash using apport:\n "
80
return report_bug_legacy(exc_info, stderr)
58
83
def report_bug_legacy(exc_info, err_file):
82
107
def report_bug_to_apport(exc_info, stderr):
83
108
"""Report a bug to apport for optional automatic filing.
110
:returns: The name of the crash file, or None if we didn't write one.
85
# this is based on apport_package_hook.py, but omitting some of the
112
# this function is based on apport_package_hook.py, but omitting some of the
86
113
# Ubuntu-specific policy about what to report and when
88
# if this fails its caught at a higher level; we don't want to open the
89
# crash file unless apport can be loaded.
115
# if the import fails, the exception will be caught at a higher level and
116
# we'll report the error by other means
92
crash_file = _open_crash_file()
94
_write_apport_report_to_file(exc_info, crash_file)
98
stderr.write("bzr: ERROR: %s.%s: %s\n"
100
"*** Bazaar has encountered an internal error. This probably indicates a\n"
101
" bug in Bazaar. You can help us fix it by filing a bug report at\n"
102
" https://bugs.launchpad.net/bzr/+filebug\n"
103
" attaching the crash file\n"
105
" and including a description of the problem.\n"
107
" The crash file is plain text and you can inspect or edit it to remove\n"
108
" private information.\n"
109
% (exc_info[0].__module__, exc_info[0].__name__, exc_info[1],
113
def _write_apport_report_to_file(exc_info, crash_file):
119
crash_filename = _write_apport_report_to_file(exc_info)
121
if crash_filename is None:
123
"apport is set to ignore crashes in this version of bzr.\n"
126
trace.print_exception(exc_info, stderr)
128
"You can report this problem to Bazaar's developers by running\n"
130
"if a bug-reporting window does not automatically appear.\n"
132
# XXX: on Windows, Mac, and other platforms where we might have the
133
# apport libraries but not have an apport always running, we could
134
# synchronously file now
136
return crash_filename
139
def _write_apport_report_to_file(exc_info):
115
141
from apport.report import Report
117
143
exc_type, exc_object, exc_tb = exc_info
120
# add_proc_info gives you the memory map of the process: this seems rarely
121
# useful for Bazaar and it does make the report harder to scan, though it
122
# does tell you what binary modules are loaded.
146
# add_proc_info gets the executable and interpreter path, which is needed,
147
# plus some less useful stuff like the memory map
124
149
pr.add_user_info()
151
# Package and SourcePackage are needed so that apport will report about even
152
# non-packaged versions of bzr; also this reports on their packaged
153
# dependencies which is useful.
154
pr['SourcePackage'] = 'bzr'
155
pr['Package'] = 'bzr'
125
157
pr['CommandLine'] = pprint.pformat(sys.argv)
126
158
pr['BzrVersion'] = bzrlib.__version__
127
159
pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
137
169
traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
138
170
pr['Traceback'] = tb_file.getvalue()
174
# We want to use the 'bzr' crashdb so that it gets sent directly upstream,
175
# which is a reasonable default for most internal errors. However, if we
176
# set it here then apport will crash later if it doesn't know about that
177
# crashdb. Instead, we rely on the bzr package installing both a
178
# source hook telling crashes to go to this crashdb, and a crashdb
179
# configuration describing it.
181
# these may contain some sensitive info (smtp_passwords)
182
# TODO: strip that out and attach the rest
184
#attach_file_if_exists(report,
185
# os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
186
#attach_file_if_exists(report,
187
# os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
189
# strip username, hostname, etc
192
if pr.check_ignored():
193
# eg configured off in ~/.apport-ignore.xml
196
crash_file_name, crash_file = _open_crash_file()
199
return crash_file_name
202
def _attach_log_tail(pr):
204
bzr_log = open(trace._get_bzr_log_filename(), 'rt')
205
except (IOError, OSError), e:
206
pr['BzrLogTail'] = repr(e)
209
lines = bzr_log.readlines()
210
pr['BzrLogTail'] = ''.join(lines[-40:])
143
215
def _open_crash_file():
144
216
crash_dir = config.crash_dir()
145
# user-readable only, just in case the contents are sensitive.
146
217
if not osutils.isdir(crash_dir):
147
os.makedirs(crash_dir, mode=0700)
148
filename = 'bzr-%s-%s.crash' % (
149
osutils.compact_date(time.time()),
151
return open(osutils.pathjoin(crash_dir, filename), 'wt')
218
# on unix this should be /var/crash and should already exist; on
219
# Windows or if it's manually configured it might need to be created,
220
# and then it should be private
221
os.makedirs(crash_dir, mode=0600)
222
date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
223
# XXX: getuid doesn't work on win32, but the crash directory is per-user
224
if sys.platform == 'win32':
227
user_part = '.%d' % os.getuid()
228
filename = osutils.pathjoin(
233
# be careful here that people can't play tmp-type symlink mischief in the
234
# world-writable directory
235
return filename, os.fdopen(
237
os.O_WRONLY|os.O_CREAT|os.O_EXCL,
154
242
def _format_plugin_list():
added
removed
bzrlib/crash.py
