/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/crash.py

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/crash.py
1
 
# Copyright (C) 2009-2011 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
"""Handling and reporting crashes.
18
 
 
19
 
A crash is an exception propagated up almost to the top level of Bazaar.
20
 
 
21
 
If we have apport <https://launchpad.net/apport/>, we store a report of the
22
 
crash using apport into its /var/crash spool directory, from where the user
23
 
can either manually send it to Launchpad.  In some cases (at least Ubuntu
24
 
development releases), Apport may pop up a window asking if they want
25
 
to send it.
26
 
 
27
 
Without apport, we just write a crash report to stderr and the user can report
28
 
this manually if the wish.
29
 
 
30
 
We never send crash data across the network without user opt-in.
31
 
 
32
 
In principle apport can run on any platform though as of Feb 2010 there seem
33
 
to be some portability bugs.
34
 
 
35
 
To force this off in brz turn set APPORT_DISABLE in the environment or
36
 
-Dno_apport.
37
 
"""
38
 
 
39
 
from __future__ import absolute_import
40
 
 
41
 
# for interactive testing, try the 'brz assert-fail' command
42
 
# or see http://code.launchpad.net/~mbp/bzr/bzr-fail
43
 
#
44
 
# to test with apport it's useful to set
45
 
# export APPORT_IGNORE_OBSOLETE_PACKAGES=1
46
 
 
47
 
import os
48
 
import platform
49
 
import pprint
50
 
import sys
51
 
import time
52
 
 
53
 
import breezy
54
 
from . import (
55
 
    bedding,
56
 
    debug,
57
 
    osutils,
58
 
    plugin,
59
 
    trace,
60
 
    )
61
 
from .sixish import (
62
 
    StringIO,
63
 
    )
64
 
 
65
 
 
66
 
def report_bug(exc_info, stderr):
67
 
    if ('no_apport' in debug.debug_flags) or \
68
 
            os.environ.get('APPORT_DISABLE', None):
69
 
        return report_bug_legacy(exc_info, stderr)
70
 
    try:
71
 
        if report_bug_to_apport(exc_info, stderr):
72
 
            # wrote a file; if None then report the old way
73
 
            return
74
 
    except ImportError as e:
75
 
        trace.mutter("couldn't find apport bug-reporting library: %s" % e)
76
 
    except Exception as e:
77
 
        # this should only happen if apport is installed but it didn't
78
 
        # work, eg because of an io error writing the crash file
79
 
        trace.mutter("brz: failed to report crash using apport: %r" % e)
80
 
        trace.log_exception_quietly()
81
 
    return report_bug_legacy(exc_info, stderr)
82
 
 
83
 
 
84
 
def report_bug_legacy(exc_info, err_file):
85
 
    """Report a bug by just printing a message to the user."""
86
 
    trace.print_exception(exc_info, err_file)
87
 
    err_file.write('\n')
88
 
    import textwrap
89
 
 
90
 
    def print_wrapped(l):
91
 
        err_file.write(textwrap.fill(
92
 
            l, width=78, subsequent_indent='    ') + '\n')
93
 
    print_wrapped('brz %s on python %s (%s)\n' %
94
 
                  (breezy.__version__,
95
 
                   breezy._format_version_tuple(sys.version_info),
96
 
                   platform.platform(aliased=1)))
97
 
    print_wrapped('arguments: %r\n' % sys.argv)
98
 
    print_wrapped(textwrap.fill(
99
 
        'plugins: ' + plugin.format_concise_plugin_list(),
100
 
        width=78,
101
 
        subsequent_indent='    ',
102
 
        ) + '\n')
103
 
    print_wrapped(
104
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
105
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
106
 
            os.environ.get('LANG')))
107
 
    # We used to show all the plugins here, but it's too verbose.
108
 
    err_file.write(
109
 
        "\n"
110
 
        "*** Bazaar has encountered an internal error.  This probably indicates a\n"
111
 
        "    bug in Bazaar.  You can help us fix it by filing a bug report at\n"
112
 
        "        https://bugs.launchpad.net/brz/+filebug\n"
113
 
        "    including this traceback and a description of the problem.\n"
114
 
        )
115
 
 
116
 
 
117
 
def report_bug_to_apport(exc_info, stderr):
118
 
    """Report a bug to apport for optional automatic filing.
119
 
 
120
 
    :returns: The name of the crash file, or None if we didn't write one.
121
 
    """
122
 
    # this function is based on apport_package_hook.py, but omitting some of the
123
 
    # Ubuntu-specific policy about what to report and when
124
 
 
125
 
    # This import is apparently not used, but we're doing it so that if the
126
 
    # import fails, the exception will be caught at a higher level and we'll
127
 
    # report the error by other means.
128
 
    import apport  # noqa: F401
129
 
 
130
 
    crash_filename = _write_apport_report_to_file(exc_info)
131
 
 
132
 
    if crash_filename is None:
133
 
        stderr.write("\n"
134
 
                     "apport is set to ignore crashes in this version of brz.\n"
135
 
                     )
136
 
    else:
137
 
        trace.print_exception(exc_info, stderr)
138
 
        stderr.write("\n"
139
 
                     "You can report this problem to Bazaar's developers by running\n"
140
 
                     "    apport-bug %s\n"
141
 
                     "if a bug-reporting window does not automatically appear.\n"
142
 
                     % (crash_filename))
143
 
        # XXX: on Windows, Mac, and other platforms where we might have the
144
 
        # apport libraries but not have an apport always running, we could
145
 
        # synchronously file now
146
 
 
147
 
    return crash_filename
148
 
 
149
 
 
150
 
def _write_apport_report_to_file(exc_info):
151
 
    import traceback
152
 
    from apport.report import Report
153
 
 
154
 
    exc_type, exc_object, exc_tb = exc_info
155
 
 
156
 
    pr = Report()
157
 
    # add_proc_info sets the ExecutablePath, InterpreterPath, etc.
158
 
    pr.add_proc_info()
159
 
    # It also adds ProcMaps which for us is rarely useful and mostly noise, so
160
 
    # let's remove it.
161
 
    del pr['ProcMaps']
162
 
    pr.add_user_info()
163
 
 
164
 
    # Package and SourcePackage are needed so that apport will report about even
165
 
    # non-packaged versions of brz; also this reports on their packaged
166
 
    # dependencies which is useful.
167
 
    pr['SourcePackage'] = 'brz'
168
 
    pr['Package'] = 'brz'
169
 
 
170
 
    pr['CommandLine'] = pprint.pformat(sys.argv)
171
 
    pr['BrzVersion'] = breezy.__version__
172
 
    pr['PythonVersion'] = breezy._format_version_tuple(sys.version_info)
173
 
    pr['Platform'] = platform.platform(aliased=1)
174
 
    pr['UserEncoding'] = osutils.get_user_encoding()
175
 
    pr['FileSystemEncoding'] = sys.getfilesystemencoding()
176
 
    pr['Locale'] = os.environ.get('LANG', 'C')
177
 
    pr['BrzPlugins'] = _format_plugin_list()
178
 
    pr['PythonLoadedModules'] = _format_module_list()
179
 
    pr['BrzDebugFlags'] = pprint.pformat(debug.debug_flags)
180
 
 
181
 
    # actually we'd rather file directly against the upstream product, but
182
 
    # apport does seem to count on there being one in there; we might need to
183
 
    # redirect it elsewhere anyhow
184
 
    pr['SourcePackage'] = 'brz'
185
 
    pr['Package'] = 'brz'
186
 
 
187
 
    # tell apport to file directly against the brz package using
188
 
    # <https://bugs.launchpad.net/bzr/+bug/391015>
189
 
    #
190
 
    # XXX: unfortunately apport may crash later if the crashdb definition
191
 
    # file isn't present
192
 
    pr['CrashDb'] = 'brz'
193
 
 
194
 
    tb_file = StringIO()
195
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
196
 
    pr['Traceback'] = tb_file.getvalue()
197
 
 
198
 
    _attach_log_tail(pr)
199
 
 
200
 
    # We want to use the 'brz' crashdb so that it gets sent directly upstream,
201
 
    # which is a reasonable default for most internal errors.  However, if we
202
 
    # set it here then apport will crash later if it doesn't know about that
203
 
    # crashdb.  Instead, we rely on the brz package installing both a
204
 
    # source hook telling crashes to go to this crashdb, and a crashdb
205
 
    # configuration describing it.
206
 
 
207
 
    # these may contain some sensitive info (smtp_passwords)
208
 
    # TODO: strip that out and attach the rest
209
 
    #
210
 
    # attach_file_if_exists(report,
211
 
    #   os.path.join(dot_brz, 'breezy.conf', 'BrzConfig')
212
 
    # attach_file_if_exists(report,
213
 
    #   os.path.join(dot_brz, 'locations.conf', 'BrzLocations')
214
 
 
215
 
    # strip username, hostname, etc
216
 
    pr.anonymize()
217
 
 
218
 
    if pr.check_ignored():
219
 
        # eg configured off in ~/.apport-ignore.xml
220
 
        return None
221
 
    else:
222
 
        crash_file_name, crash_file = _open_crash_file()
223
 
        pr.write(crash_file)
224
 
        crash_file.close()
225
 
        return crash_file_name
226
 
 
227
 
 
228
 
def _attach_log_tail(pr):
229
 
    try:
230
 
        brz_log = open(trace._get_brz_log_filename(), 'rt')
231
 
    except (IOError, OSError) as e:
232
 
        pr['BrzLogTail'] = repr(e)
233
 
        return
234
 
    try:
235
 
        lines = brz_log.readlines()
236
 
        pr['BrzLogTail'] = ''.join(lines[-40:])
237
 
    finally:
238
 
        brz_log.close()
239
 
 
240
 
 
241
 
def _open_crash_file():
242
 
    crash_dir = bedding.crash_dir()
243
 
    if not osutils.isdir(crash_dir):
244
 
        # on unix this should be /var/crash and should already exist; on
245
 
        # Windows or if it's manually configured it might need to be created,
246
 
        # and then it should be private
247
 
        os.makedirs(crash_dir, mode=0o600)
248
 
    date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
249
 
    # XXX: getuid doesn't work on win32, but the crash directory is per-user
250
 
    if sys.platform == 'win32':
251
 
        user_part = ''
252
 
    else:
253
 
        user_part = '.%d' % os.getuid()
254
 
    filename = osutils.pathjoin(
255
 
        crash_dir,
256
 
        'brz%s.%s.crash' % (
257
 
            user_part,
258
 
            date_string))
259
 
    # be careful here that people can't play tmp-type symlink mischief in the
260
 
    # world-writable directory
261
 
    return filename, os.fdopen(
262
 
        os.open(filename,
263
 
                os.O_WRONLY | os.O_CREAT | os.O_EXCL,
264
 
                0o600),
265
 
        'wb')
266
 
 
267
 
 
268
 
def _format_plugin_list():
269
 
    return ''.join(plugin.describe_plugins(show_paths=True))
270
 
 
271
 
 
272
 
def _format_module_list():
273
 
    return pprint.pformat(sys.modules)