/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 bzrlib/crash.py

  • Committer: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

Show diffs side-by-side

added added

removed removed

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