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_DISABLE in the environment or
40
21
# for interactive testing, try the 'bzr assert-fail' command
41
22
# 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
63
40
def report_bug(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
41
if 'no_apport' not in debug.debug_flags:
43
report_bug_to_apport(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)
46
# this should only happen if apport is installed but it didn't
47
# work, eg because of an io error writing the crash file
48
sys.stderr.write("bzr: failed to report crash using apport:\n "
51
report_bug_legacy(exc_info, stderr)
83
54
def report_bug_legacy(exc_info, err_file):
107
78
def report_bug_to_apport(exc_info, stderr):
108
79
"""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.
81
:returns: True if the bug was filed or otherwise handled;
82
False to use a fallback method.
112
# this function is based on apport_package_hook.py, but omitting some of the
84
# this is based on apport_package_hook.py, but omitting some of the
113
85
# Ubuntu-specific policy about what to report and when
115
# if the import fails, the exception will be caught at a higher level and
116
# we'll report the error by other means
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):
87
from apport.report import Report
88
except ImportError, e:
89
trace.warning("couldn't find apport bug-reporting library: %s" % e)
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],
114
def _write_apport_report_to_file(exc_info, crash_file):
141
117
from apport.report import Report
143
119
exc_type, exc_object, exc_tb = exc_info
146
# add_proc_info gives you the memory map of the process, which is not so
147
# useful for Bazaar but does tell you what binary libraries are loaded.
148
# More importantly it sets the ExecutablePath, InterpreterPath, etc.
122
# add_proc_info gives you the memory map of the process: this seems rarely
123
# useful for Bazaar and it does make the report harder to scan, though it
124
# does tell you what binary modules are loaded.
150
126
pr.add_user_info()
152
# Package and SourcePackage are needed so that apport will report about even
153
# non-packaged versions of bzr; also this reports on their packaged
154
# dependencies which is useful.
155
pr['SourcePackage'] = 'bzr'
156
pr['Package'] = 'bzr'
158
127
pr['CommandLine'] = pprint.pformat(sys.argv)
159
128
pr['BzrVersion'] = bzrlib.__version__
160
129
pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
166
135
pr['PythonLoadedModules'] = _format_module_list()
167
136
pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
169
# actually we'd rather file directly against the upstream product, but
170
# apport does seem to count on there being one in there; we might need to
171
# redirect it elsewhere anyhow
172
pr['SourcePackage'] = 'bzr'
173
pr['Package'] = 'bzr'
175
# tell apport to file directly against the bzr package using
176
# <https://bugs.edge.launchpad.net/bzr/+bug/391015>
178
# XXX: unfortunately apport may crash later if the crashdb definition
180
pr['CrashDb'] = 'bzr'
182
138
tb_file = StringIO()
183
139
traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
184
140
pr['Traceback'] = tb_file.getvalue()
188
# We want to use the 'bzr' crashdb so that it gets sent directly upstream,
189
# which is a reasonable default for most internal errors. However, if we
190
# set it here then apport will crash later if it doesn't know about that
191
# crashdb. Instead, we rely on the bzr package installing both a
192
# source hook telling crashes to go to this crashdb, and a crashdb
193
# configuration describing it.
195
# these may contain some sensitive info (smtp_passwords)
196
# TODO: strip that out and attach the rest
198
#attach_file_if_exists(report,
199
# os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
200
#attach_file_if_exists(report,
201
# os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
203
# strip username, hostname, etc
206
if pr.check_ignored():
207
# eg configured off in ~/.apport-ignore.xml
210
crash_file_name, crash_file = _open_crash_file()
213
return crash_file_name
216
def _attach_log_tail(pr):
218
bzr_log = open(trace._get_bzr_log_filename(), 'rt')
219
except (IOError, OSError), e:
220
pr['BzrLogTail'] = repr(e)
223
lines = bzr_log.readlines()
224
pr['BzrLogTail'] = ''.join(lines[-40:])
229
145
def _open_crash_file():
230
146
crash_dir = config.crash_dir()
147
# user-readable only, just in case the contents are sensitive.
231
148
if not osutils.isdir(crash_dir):
232
# on unix this should be /var/crash and should already exist; on
233
# Windows or if it's manually configured it might need to be created,
234
# and then it should be private
235
os.makedirs(crash_dir, mode=0600)
236
date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
237
# XXX: getuid doesn't work on win32, but the crash directory is per-user
238
if sys.platform == 'win32':
241
user_part = '.%d' % os.getuid()
242
filename = osutils.pathjoin(
247
# be careful here that people can't play tmp-type symlink mischief in the
248
# world-writable directory
249
return filename, os.fdopen(
251
os.O_WRONLY|os.O_CREAT|os.O_EXCL,
149
os.makedirs(crash_dir, mode=0700)
150
filename = 'bzr-%s-%s.crash' % (
151
osutils.compact_date(time.time()),
153
return open(osutils.pathjoin(crash_dir, filename), 'wt')
256
156
def _format_plugin_list():
added
removed
bzrlib/crash.py
