~bzr-pqm/bzr/bzr.dev

5752.2.9 by John Arbash Meinel
Clean up an accidental module change
1
# Copyright (C) 2009-2011 Canonical Ltd
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
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
18
"""Handling and reporting crashes.
4634.128.17 by Martin Pool
Add a docstring about the general approach to apport
19
20
A crash is an exception propagated up almost to the top level of Bazaar.
21
22
If we have apport <https://launchpad.net/apport/>, we store a report of the
5448.2.1 by Martin
Fix some "its" vs. "it's" spelling confusion in bzrlib code... also, ahem, a name in the NEWS file
23
crash using apport into its /var/crash spool directory, from where the user
4634.128.17 by Martin Pool
Add a docstring about the general approach to apport
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
26
to send it.
27
28
Without apport, we just write a crash report to stderr and the user can report
29
this manually if the wish.
30
31
We never send crash data across the network without user opt-in.
32
33
In principle apport can run on any platform though as of Feb 2010 there seem
34
to be some portability bugs.
4634.128.21 by Martin Pool
Better check for APPORT_DISABLE; review tweaks from Robert
35
5129.2.1 by Gary van der Merwe
Fix spelling of APPORT_DISABLE in crash doc string.
36
To force this off in bzr turn set APPORT_DISABLE in the environment or 
4634.128.21 by Martin Pool
Better check for APPORT_DISABLE; review tweaks from Robert
37
-Dno_apport.
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
38
"""
39
4584.3.17 by Martin Pool
Better message in apport crash
40
# for interactive testing, try the 'bzr assert-fail' command 
41
# or see http://code.launchpad.net/~mbp/bzr/bzr-fail
4634.128.11 by Martin Pool
comment
42
#
43
# to test with apport it's useful to set
44
# export APPORT_IGNORE_OBSOLETE_PACKAGES=1
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
45
46
import os
4584.3.30 by Martin Pool
Fix call to platform() when apport not present
47
import platform
4584.3.13 by Martin Pool
Refactor _format_plugin_list and include list of loaded modules in apport
48
import pprint
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
49
import sys
50
import time
4584.3.22 by Martin Pool
further tweaks to and tests of bzr apport reporting
51
from StringIO import StringIO
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
52
53
import bzrlib
54
from bzrlib import (
55
    config,
4584.3.16 by Martin Pool
Add -Dno_apport and fallback if apport fails
56
    debug,
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
57
    osutils,
58
    plugin,
59
    trace,
60
    )
61
62
63
def report_bug(exc_info, stderr):
4634.128.21 by Martin Pool
Better check for APPORT_DISABLE; review tweaks from Robert
64
    if ('no_apport' in debug.debug_flags) or \
65
        os.environ.get('APPORT_DISABLE', None):
4634.128.19 by Martin Pool
Add APPORT_DISABLE to turn it off
66
        return report_bug_legacy(exc_info, stderr)
67
    try:
4634.128.21 by Martin Pool
Better check for APPORT_DISABLE; review tweaks from Robert
68
        if report_bug_to_apport(exc_info, stderr):
69
            # wrote a file; if None then report the old way
70
            return
4634.128.19 by Martin Pool
Add APPORT_DISABLE to turn it off
71
    except ImportError, e:
72
        trace.mutter("couldn't find apport bug-reporting library: %s" % e)
73
        pass
74
    except Exception, 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 "
78
            "    %r\n" % e)
79
        pass
80
    return report_bug_legacy(exc_info, stderr)
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
81
82
83
def report_bug_legacy(exc_info, err_file):
84
    """Report a bug by just printing a message to the user."""
85
    trace.print_exception(exc_info, err_file)
86
    err_file.write('\n')
5609.23.6 by Martin Pool
Show concise list of plugins in non-apport crash; add test for this
87
    import textwrap
88
    def print_wrapped(l):
89
        err_file.write(textwrap.fill(l,
90
            width=78, subsequent_indent='    ') + '\n')
91
    print_wrapped('bzr %s on python %s (%s)\n' % \
92
        (bzrlib.__version__,
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(),
98
        width=78,
99
        subsequent_indent='    ',
100
        ) + '\n')
101
    print_wrapped(
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
102
        'encoding: %r, fsenc: %r, lang: %r\n' % (
103
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
104
            os.environ.get('LANG')))
5609.23.3 by Martin Pool
Don't print full list of plugins in non-apport crash
105
    # We used to show all the plugins here, but it's too verbose.
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
106
    err_file.write(
5609.23.6 by Martin Pool
Show concise list of plugins in non-apport crash; add test for this
107
        "\n"
4584.3.19 by Martin Pool
Tweak crash message and use the same one with apport or without.
108
        "*** Bazaar has encountered an internal error.  This probably indicates a\n"
4584.3.22 by Martin Pool
further tweaks to and tests of bzr apport reporting
109
        "    bug in Bazaar.  You can help us fix it by filing a bug report at\n"
110
        "        https://bugs.launchpad.net/bzr/+filebug\n"
111
        "    including this traceback and a description of the problem.\n"
4584.3.19 by Martin Pool
Tweak crash message and use the same one with apport or without.
112
        )
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
113
114
115
def report_bug_to_apport(exc_info, stderr):
116
    """Report a bug to apport for optional automatic filing.
4634.128.21 by Martin Pool
Better check for APPORT_DISABLE; review tweaks from Robert
117
118
    :returns: The name of the crash file, or None if we didn't write one.
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
119
    """
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
120
    # this function is based on apport_package_hook.py, but omitting some of the
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
121
    # Ubuntu-specific policy about what to report and when
4584.3.25 by Martin Pool
Better handling of ImportError from apport
122
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
123
    # if the import fails, the exception will be caught at a higher level and
124
    # we'll report the error by other means
4584.3.25 by Martin Pool
Better handling of ImportError from apport
125
    import apport
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
126
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
127
    crash_filename = _write_apport_report_to_file(exc_info)
4584.3.21 by Martin Pool
Start adding tests for apport
128
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
129
    if crash_filename is None:
130
        stderr.write("\n"
131
            "apport is set to ignore crashes in this version of bzr.\n"
132
            )
133
    else:
4634.128.21 by Martin Pool
Better check for APPORT_DISABLE; review tweaks from Robert
134
        trace.print_exception(exc_info, stderr)
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
135
        stderr.write("\n"
136
            "You can report this problem to Bazaar's developers by running\n"
137
            "    apport-bug %s\n"
138
            "if a bug-reporting window does not automatically appear.\n"
139
            % (crash_filename))
4634.128.7 by Martin Pool
comment
140
        # XXX: on Windows, Mac, and other platforms where we might have the
141
        # apport libraries but not have an apport always running, we could
142
        # synchronously file now
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
143
4634.128.18 by Martin Pool
Update apport crash tests
144
    return crash_filename
145
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
146
147
def _write_apport_report_to_file(exc_info):
4584.3.22 by Martin Pool
further tweaks to and tests of bzr apport reporting
148
    import traceback
4584.3.21 by Martin Pool
Start adding tests for apport
149
    from apport.report import Report
4584.3.22 by Martin Pool
further tweaks to and tests of bzr apport reporting
150
151
    exc_type, exc_object, exc_tb = exc_info
152
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
153
    pr = Report()
5616.2.1 by Martin Pool
Don't put ProcMaps in apport crash reports.
154
    # add_proc_info sets the ExecutablePath, InterpreterPath, etc.
4797.33.9 by Martin Pool
Call apport add_proc_info to make sure necessary fields are present
155
    pr.add_proc_info()
5616.2.1 by Martin Pool
Don't put ProcMaps in apport crash reports.
156
    # It also adds ProcMaps which for us is rarely useful and mostly noise, so
157
    # let's remove it.
158
    del pr['ProcMaps']
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
159
    pr.add_user_info()
4634.128.4 by Martin Pool
Prepopulate apport Package and SourcePackage
160
161
    # Package and SourcePackage are needed so that apport will report about even
162
    # non-packaged versions of bzr; also this reports on their packaged
163
    # dependencies which is useful.
164
    pr['SourcePackage'] = 'bzr'
165
    pr['Package'] = 'bzr'
166
4584.3.22 by Martin Pool
further tweaks to and tests of bzr apport reporting
167
    pr['CommandLine'] = pprint.pformat(sys.argv)
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
168
    pr['BzrVersion'] = bzrlib.__version__
169
    pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
170
    pr['Platform'] = platform.platform(aliased=1)
171
    pr['UserEncoding'] = osutils.get_user_encoding()
172
    pr['FileSystemEncoding'] = sys.getfilesystemencoding()
173
    pr['Locale'] = os.environ.get('LANG')
4584.3.13 by Martin Pool
Refactor _format_plugin_list and include list of loaded modules in apport
174
    pr['BzrPlugins'] = _format_plugin_list()
175
    pr['PythonLoadedModules'] = _format_module_list()
4584.3.22 by Martin Pool
further tweaks to and tests of bzr apport reporting
176
    pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
177
4797.33.10 by Martin Pool
Hardcode Package and SourcePackage into apport report
178
    # actually we'd rather file directly against the upstream product, but
179
    # apport does seem to count on there being one in there; we might need to
180
    # redirect it elsewhere anyhow
181
    pr['SourcePackage'] = 'bzr'
182
    pr['Package'] = 'bzr'
183
4797.33.15 by Martin Pool
Put CrashDb=bzr directly into the crash file
184
    # tell apport to file directly against the bzr package using 
5243.1.2 by Martin
Point launchpad links in comments at production server rather than edge
185
    # <https://bugs.launchpad.net/bzr/+bug/391015>
4797.33.15 by Martin Pool
Put CrashDb=bzr directly into the crash file
186
    #
187
    # XXX: unfortunately apport may crash later if the crashdb definition
188
    # file isn't present
189
    pr['CrashDb'] = 'bzr'
4797.33.10 by Martin Pool
Hardcode Package and SourcePackage into apport report
190
4584.3.22 by Martin Pool
further tweaks to and tests of bzr apport reporting
191
    tb_file = StringIO()
192
    traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
193
    pr['Traceback'] = tb_file.getvalue()
194
4634.128.10 by Martin Pool
Attach tail of .bzr.log to crash reports
195
    _attach_log_tail(pr)
196
4634.128.9 by Martin Pool
comment
197
    # We want to use the 'bzr' crashdb so that it gets sent directly upstream,
198
    # which is a reasonable default for most internal errors.  However, if we
199
    # set it here then apport will crash later if it doesn't know about that
200
    # crashdb.  Instead, we rely on the bzr package installing both a
201
    # source hook telling crashes to go to this crashdb, and a crashdb
202
    # configuration describing it.
203
4634.128.10 by Martin Pool
Attach tail of .bzr.log to crash reports
204
    # these may contain some sensitive info (smtp_passwords)
205
    # TODO: strip that out and attach the rest
206
    #
207
    #attach_file_if_exists(report,
4999.3.2 by Martin Pool
expand tabs
208
    #   os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
4634.128.10 by Martin Pool
Attach tail of .bzr.log to crash reports
209
    #attach_file_if_exists(report,
4999.3.2 by Martin Pool
expand tabs
210
    #   os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
4634.128.10 by Martin Pool
Attach tail of .bzr.log to crash reports
211
    
4634.128.8 by Martin Pool
Anonymize apport report
212
    # strip username, hostname, etc
213
    pr.anonymize()
214
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
215
    if pr.check_ignored():
216
        # eg configured off in ~/.apport-ignore.xml
217
        return None
218
    else:
4634.128.18 by Martin Pool
Update apport crash tests
219
        crash_file_name, crash_file = _open_crash_file()
4634.128.6 by Martin Pool
Don't write crash reports if apport is configured to ignore them
220
        pr.write(crash_file)
221
        crash_file.close()
4634.128.18 by Martin Pool
Update apport crash tests
222
        return crash_file_name
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
223
224
4634.128.10 by Martin Pool
Attach tail of .bzr.log to crash reports
225
def _attach_log_tail(pr):
226
    try:
227
        bzr_log = open(trace._get_bzr_log_filename(), 'rt')
4634.128.18 by Martin Pool
Update apport crash tests
228
    except (IOError, OSError), e:
229
        pr['BzrLogTail'] = repr(e)
230
        return
231
    try:
4634.128.10 by Martin Pool
Attach tail of .bzr.log to crash reports
232
        lines = bzr_log.readlines()
233
        pr['BzrLogTail'] = ''.join(lines[-40:])
234
    finally:
235
        bzr_log.close()
236
237
4584.3.6 by Martin Pool
Move apport integration to bzrlib.crash and send output to a file.
238
def _open_crash_file():
239
    crash_dir = config.crash_dir()
240
    if not osutils.isdir(crash_dir):
4634.128.2 by Martin Pool
Write crash files into /var/crash where apport can see them.
241
        # on unix this should be /var/crash and should already exist; on
242
        # Windows or if it's manually configured it might need to be created,
243
        # and then it should be private
244
        os.makedirs(crash_dir, mode=0600)
245
    date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
4634.128.14 by Martin Pool
Don't call os.getuid on win32 (thanks gzlist)
246
    # XXX: getuid doesn't work on win32, but the crash directory is per-user
247
    if sys.platform == 'win32':
248
        user_part = ''
249
    else:
250
        user_part = '.%d' % os.getuid()
4634.128.16 by Martin Pool
Open the crash file using O_EXCL etc and set the mode
251
    filename = osutils.pathjoin(
252
        crash_dir,
253
        'bzr%s.%s.crash' % (
254
            user_part,
255
            date_string))
256
    # be careful here that people can't play tmp-type symlink mischief in the
257
    # world-writable directory
4634.128.18 by Martin Pool
Update apport crash tests
258
    return filename, os.fdopen(
4634.128.16 by Martin Pool
Open the crash file using O_EXCL etc and set the mode
259
        os.open(filename, 
260
            os.O_WRONLY|os.O_CREAT|os.O_EXCL,
261
            0600),
262
        'w')
4584.3.13 by Martin Pool
Refactor _format_plugin_list and include list of loaded modules in apport
263
264
265
def _format_plugin_list():
5616.7.10 by Martin Pool
Clean up describe_plugins to sort loaded and unloaded plugins together.
266
    return ''.join(plugin.describe_plugins(show_paths=True))
4584.3.13 by Martin Pool
Refactor _format_plugin_list and include list of loaded modules in apport
267
268
269
def _format_module_list():
270
    return pprint.pformat(sys.modules)