1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# Copyright (C) 2009 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Handling and reporting crashes.
"""
# for interactive testing, try the 'bzr assert-fail' command
# or see http://code.launchpad.net/~mbp/bzr/bzr-fail
import os
import pprint
import sys
import time
import bzrlib
from bzrlib import (
config,
debug,
osutils,
plugin,
trace,
)
def report_bug(exc_info, stderr):
if 'no_apport' not in debug.debug_flags:
try:
report_bug_to_apport(exc_info, stderr)
return
except Exception, e:
# this should only happen if apport is installed but it didn't
# work, eg because of an io error writing the crash file
sys.stderr.write("failed to report crash using apport: %r" % e)
pass
report_bug_legacy(exc_info, stderr)
def report_bug_legacy(exc_info, err_file):
"""Report a bug by just printing a message to the user."""
trace.print_exception(exc_info, err_file)
err_file.write('\n')
err_file.write('bzr %s on python %s (%s)\n' % \
(bzrlib.__version__,
bzrlib._format_version_tuple(sys.version_info),
sys.platform))
err_file.write('arguments: %r\n' % sys.argv)
err_file.write(
'encoding: %r, fsenc: %r, lang: %r\n' % (
osutils.get_user_encoding(), sys.getfilesystemencoding(),
os.environ.get('LANG')))
err_file.write("plugins:\n")
for name, a_plugin in sorted(plugin.plugins().items()):
err_file.write(" %-20s %s [%s]\n" %
(name, a_plugin.path(), a_plugin.__version__))
err_file.write(
"*** Bazaar has encountered an internal error. This probably indicates a\n"
"*** bug in Bazaar. You can help us fix it by filing a bug report at\n"
"*** https://bugs.launchpad.net/bzr/+filebug\n"
"*** including this traceback and a description of the problem.\n"
)
def report_bug_to_apport(exc_info, stderr):
"""Report a bug to apport for optional automatic filing.
:returns: True if the bug was filed or otherwise handled;
False to use a fallback method.
"""
# this is based on apport_package_hook.py, but omitting some of the
# Ubuntu-specific policy about what to report and when
try:
from apport.report import Report
except ImportError, e:
trace.warning("couldn't find apport bug-reporting library: %s" % e)
return False
crash_file = _open_crash_file()
try:
_write_apport_report_to_file(crash_file)
finally:
crash_file.close()
stderr.write("bzr: ERROR: %s.%s: %s\n"
"\n"
"*** Bazaar has encountered an internal error. This probably indicates a\n"
"*** bug in Bazaar. You can help us fix it by filing a bug report at\n"
"*** https://bugs.launchpad.net/bzr/+filebug\n"
"*** attaching the crash file\n"
"*** %s\n"
"*** and including a description of the problem.\n"
% (exc_info[0].__module__, exc_info[0].__name__, exc_info[1],
crash_file.name))
return True
def _write_apport_report_to_file(exc_info, crash_file):
import platform
from apport.report import Report
pr = Report()
# add_proc_info gives you the memory map of the process: this seems rarely
# useful for Bazaar and it does make the report harder to scan, though it
# does tell you what binary modules are loaded.
# pr.add_proc_info()
pr.add_user_info()
pr['BzrVersion'] = bzrlib.__version__
pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
pr['Platform'] = platform.platform(aliased=1)
pr['UserEncoding'] = osutils.get_user_encoding()
pr['FileSystemEncoding'] = sys.getfilesystemencoding()
pr['Locale'] = os.environ.get('LANG')
pr['BzrPlugins'] = _format_plugin_list()
pr['PythonLoadedModules'] = _format_module_list()
pr.write(crash_file)
def _open_crash_file():
crash_dir = config.crash_dir()
# user-readable only, just in case the contents are sensitive.
if not osutils.isdir(crash_dir):
os.makedirs(crash_dir, mode=0700)
filename = 'bzr-%s-%s.crash' % (
osutils.compact_date(time.time()),
os.getpid(),)
return open(osutils.pathjoin(crash_dir, filename), 'wt')
def _format_plugin_list():
plugin_lines = []
for name, a_plugin in sorted(plugin.plugins().items()):
plugin_lines.append(" %-20s %s [%s]" %
(name, a_plugin.path(), a_plugin.__version__))
return '\n'.join(plugin_lines)
def _format_module_list():
return pprint.pformat(sys.modules)
|