1
# Copyright (C) 2009 Canonical Ltd
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.
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.
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Handling and reporting crashes.
21
# for interactive testing, try the 'bzr assert-fail' command
22
# or see http://code.launchpad.net/~mbp/bzr/bzr-fail
28
from StringIO import StringIO
40
def report_bug(exc_info, stderr):
41
if 'no_apport' not in debug.debug_flags:
43
report_bug_to_apport(exc_info, stderr)
45
except ImportError, e:
46
trace.mutter("couldn't find apport bug-reporting library: %s" % e)
49
# this should only happen if apport is installed but it didn't
50
# work, eg because of an io error writing the crash file
51
sys.stderr.write("bzr: failed to report crash using apport:\n "
54
report_bug_legacy(exc_info, stderr)
57
def report_bug_legacy(exc_info, err_file):
58
"""Report a bug by just printing a message to the user."""
59
trace.print_exception(exc_info, err_file)
61
err_file.write('bzr %s on python %s (%s)\n' % \
63
bzrlib._format_version_tuple(sys.version_info),
65
err_file.write('arguments: %r\n' % sys.argv)
67
'encoding: %r, fsenc: %r, lang: %r\n' % (
68
osutils.get_user_encoding(), sys.getfilesystemencoding(),
69
os.environ.get('LANG')))
70
err_file.write("plugins:\n")
71
err_file.write(_format_plugin_list())
74
"*** Bazaar has encountered an internal error. This probably indicates a\n"
75
" bug in Bazaar. You can help us fix it by filing a bug report at\n"
76
" https://bugs.launchpad.net/bzr/+filebug\n"
77
" including this traceback and a description of the problem.\n"
81
def report_bug_to_apport(exc_info, stderr):
82
"""Report a bug to apport for optional automatic filing.
84
# this is based on apport_package_hook.py, but omitting some of the
85
# Ubuntu-specific policy about what to report and when
87
# if this fails its caught at a higher level; we don't want to open the
88
# crash file unless apport can be loaded.
91
crash_file = _open_crash_file()
93
_write_apport_report_to_file(exc_info, crash_file)
97
stderr.write("bzr: ERROR: %s.%s: %s\n"
99
"*** Bazaar has encountered an internal error. This probably indicates a\n"
100
" bug in Bazaar. You can help us fix it by filing a bug report at\n"
101
" https://bugs.launchpad.net/bzr/+filebug\n"
102
" attaching the crash file\n"
104
" and including a description of the problem.\n"
106
" The crash file is plain text and you can inspect or edit it to remove\n"
107
" private information.\n"
108
% (exc_info[0].__module__, exc_info[0].__name__, exc_info[1],
112
def _write_apport_report_to_file(exc_info, crash_file):
115
from apport.report import Report
117
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.
125
pr['CommandLine'] = pprint.pformat(sys.argv)
126
pr['BzrVersion'] = bzrlib.__version__
127
pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
128
pr['Platform'] = platform.platform(aliased=1)
129
pr['UserEncoding'] = osutils.get_user_encoding()
130
pr['FileSystemEncoding'] = sys.getfilesystemencoding()
131
pr['Locale'] = os.environ.get('LANG')
132
pr['BzrPlugins'] = _format_plugin_list()
133
pr['PythonLoadedModules'] = _format_module_list()
134
pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
137
traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
138
pr['Traceback'] = tb_file.getvalue()
143
def _open_crash_file():
144
crash_dir = config.crash_dir()
145
# user-readable only, just in case the contents are sensitive.
146
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')
154
def _format_plugin_list():
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)
162
def _format_module_list():
163
return pprint.pformat(sys.modules)