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 its /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
41
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
42
if 'no_apport' not in debug.debug_flags:
44
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
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)
83
58
def report_bug_legacy(exc_info, err_file):
84
59
"""Report a bug by just printing a message to the user."""
85
60
trace.print_exception(exc_info, err_file)
86
61
err_file.write('\n')
89
err_file.write(textwrap.fill(l,
90
width=78, subsequent_indent=' ') + '\n')
91
print_wrapped('bzr %s on python %s (%s)\n' % \
93
bzrlib._format_version_tuple(sys.version_info),
94
platform.platform(aliased=1)))
95
print_wrapped('arguments: %r\n' % sys.argv)
96
print_wrapped(textwrap.fill(
97
'plugins: ' + plugin.format_concise_plugin_list(),
99
subsequent_indent=' ',
62
err_file.write('bzr %s on python %s (%s)\n' % \
64
bzrlib._format_version_tuple(sys.version_info),
65
platform.platform(aliased=1)))
66
err_file.write('arguments: %r\n' % sys.argv)
102
68
'encoding: %r, fsenc: %r, lang: %r\n' % (
103
69
osutils.get_user_encoding(), sys.getfilesystemencoding(),
104
70
os.environ.get('LANG')))
105
# We used to show all the plugins here, but it's too verbose.
71
err_file.write("plugins:\n")
72
err_file.write(_format_plugin_list())
108
75
"*** Bazaar has encountered an internal error. This probably indicates a\n"
109
76
" bug in Bazaar. You can help us fix it by filing a bug report at\n"
110
77
" https://bugs.launchpad.net/bzr/+filebug\n"
115
82
def report_bug_to_apport(exc_info, stderr):
116
83
"""Report a bug to apport for optional automatic filing.
118
:returns: The name of the crash file, or None if we didn't write one.
120
# this function is based on apport_package_hook.py, but omitting some of the
85
# this is based on apport_package_hook.py, but omitting some of the
121
86
# Ubuntu-specific policy about what to report and when
123
# This import is apparently not used, but we're doing it so that if the
124
# import fails, the exception will be caught at a higher level and we'll
125
# report the error by other means.
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.
128
crash_filename = _write_apport_report_to_file(exc_info)
130
if crash_filename is None:
132
"apport is set to ignore crashes in this version of bzr.\n"
135
trace.print_exception(exc_info, stderr)
137
"You can report this problem to Bazaar's developers by running\n"
139
"if a bug-reporting window does not automatically appear.\n"
141
# XXX: on Windows, Mac, and other platforms where we might have the
142
# apport libraries but not have an apport always running, we could
143
# synchronously file now
145
return crash_filename
148
def _write_apport_report_to_file(exc_info):
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):
150
115
from apport.report import Report
152
117
exc_type, exc_object, exc_tb = exc_info
155
# add_proc_info sets the ExecutablePath, InterpreterPath, etc.
157
# It also adds ProcMaps which for us is rarely useful and mostly noise, so
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.
160
124
pr.add_user_info()
162
# Package and SourcePackage are needed so that apport will report about even
163
# non-packaged versions of bzr; also this reports on their packaged
164
# dependencies which is useful.
165
pr['SourcePackage'] = 'bzr'
166
pr['Package'] = 'bzr'
168
125
pr['CommandLine'] = pprint.pformat(sys.argv)
169
126
pr['BzrVersion'] = bzrlib.__version__
170
127
pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
176
133
pr['PythonLoadedModules'] = _format_module_list()
177
134
pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
179
# actually we'd rather file directly against the upstream product, but
180
# apport does seem to count on there being one in there; we might need to
181
# redirect it elsewhere anyhow
182
pr['SourcePackage'] = 'bzr'
183
pr['Package'] = 'bzr'
185
# tell apport to file directly against the bzr package using
186
# <https://bugs.launchpad.net/bzr/+bug/391015>
188
# XXX: unfortunately apport may crash later if the crashdb definition
190
pr['CrashDb'] = 'bzr'
192
136
tb_file = StringIO()
193
137
traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
194
138
pr['Traceback'] = tb_file.getvalue()
198
# We want to use the 'bzr' crashdb so that it gets sent directly upstream,
199
# which is a reasonable default for most internal errors. However, if we
200
# set it here then apport will crash later if it doesn't know about that
201
# crashdb. Instead, we rely on the bzr package installing both a
202
# source hook telling crashes to go to this crashdb, and a crashdb
203
# configuration describing it.
205
# these may contain some sensitive info (smtp_passwords)
206
# TODO: strip that out and attach the rest
208
#attach_file_if_exists(report,
209
# os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
210
#attach_file_if_exists(report,
211
# os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
213
# strip username, hostname, etc
216
if pr.check_ignored():
217
# eg configured off in ~/.apport-ignore.xml
220
crash_file_name, crash_file = _open_crash_file()
223
return crash_file_name
226
def _attach_log_tail(pr):
228
bzr_log = open(trace._get_bzr_log_filename(), 'rt')
229
except (IOError, OSError), e:
230
pr['BzrLogTail'] = repr(e)
233
lines = bzr_log.readlines()
234
pr['BzrLogTail'] = ''.join(lines[-40:])
239
143
def _open_crash_file():
240
144
crash_dir = config.crash_dir()
145
# user-readable only, just in case the contents are sensitive.
241
146
if not osutils.isdir(crash_dir):
242
# on unix this should be /var/crash and should already exist; on
243
# Windows or if it's manually configured it might need to be created,
244
# and then it should be private
245
os.makedirs(crash_dir, mode=0600)
246
date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
247
# XXX: getuid doesn't work on win32, but the crash directory is per-user
248
if sys.platform == 'win32':
251
user_part = '.%d' % os.getuid()
252
filename = osutils.pathjoin(
257
# be careful here that people can't play tmp-type symlink mischief in the
258
# world-writable directory
259
return filename, os.fdopen(
261
os.O_WRONLY|os.O_CREAT|os.O_EXCL,
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')
266
154
def _format_plugin_list():
267
return ''.join(plugin.describe_plugins(show_paths=True))
156
for name, a_plugin in sorted(plugin.plugins().items()):
157
plugin_lines.append(" %-20s %s [%s]" %
158
(name, a_plugin.path(), a_plugin.__version__))
159
return '\n'.join(plugin_lines)
270
162
def _format_module_list():
added
removed
bzrlib/crash.py
