/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: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

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