/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

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

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
 
# for interactive testing, try the 'brz assert-fail' command
40
 
# 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
 
 
45
 
from io import StringIO
46
 
import os
47
 
import platform
48
 
import pprint
49
 
import sys
50
 
import time
51
 
 
52
 
import breezy
53
 
from . import (
54
 
    bedding,
55
 
    debug,
56
 
    osutils,
57
 
    plugin,
58
 
    trace,
59
 
    )
60
 
 
61
 
 
62
 
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
69
 
            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)
78
 
 
79
 
 
80
 
def report_bug_legacy(exc_info, err_file):
81
 
    """Report a bug by just printing a message to the user."""
82
 
    trace.print_exception(exc_info, err_file)
83
 
    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(
100
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
101
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
102
 
            os.environ.get('LANG')))
103
 
    # We used to show all the plugins here, but it's too verbose.
104
 
    err_file.write(
105
 
        "\n"
106
 
        "*** Bazaar has encountered an internal error.  This probably indicates a\n"
107
 
        "    bug in Bazaar.  You can help us fix it by filing a bug report at\n"
108
 
        "        https://bugs.launchpad.net/brz/+filebug\n"
109
 
        "    including this traceback and a description of the problem.\n"
110
 
        )
111
 
 
112
 
 
113
 
def report_bug_to_apport(exc_info, stderr):
114
 
    """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
 
    """
118
 
    # this function is based on apport_package_hook.py, but omitting some of the
119
 
    # Ubuntu-specific policy about what to report and when
120
 
 
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):
147
 
    import traceback
148
 
    from apport.report import Report
149
 
 
150
 
    exc_type, exc_object, exc_tb = exc_info
151
 
 
152
 
    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']
158
 
    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
 
    pr['CommandLine'] = pprint.pformat(sys.argv)
167
 
    pr['BrzVersion'] = breezy.__version__
168
 
    pr['PythonVersion'] = breezy._format_version_tuple(sys.version_info)
169
 
    pr['Platform'] = platform.platform(aliased=1)
170
 
    pr['UserEncoding'] = osutils.get_user_encoding()
171
 
    pr['FileSystemEncoding'] = sys.getfilesystemencoding()
172
 
    pr['Locale'] = os.environ.get('LANG', 'C')
173
 
    pr['BrzPlugins'] = _format_plugin_list()
174
 
    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'
189
 
 
190
 
    tb_file = StringIO()
191
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
192
 
    pr['Traceback'] = tb_file.getvalue()
193
 
 
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()
235
 
 
236
 
 
237
 
def _open_crash_file():
238
 
    crash_dir = bedding.crash_dir()
239
 
    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')
262
 
 
263
 
 
264
 
def _format_plugin_list():
265
 
    return ''.join(plugin.describe_plugins(show_paths=True))
266
 
 
267
 
 
268
 
def _format_module_list():
269
 
    return pprint.pformat(sys.modules)