← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
import textwrap
18
 
 
19
 
from bzrlib import registry, help_topics
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from bzrlib import registry
20
18
from bzrlib.lazy_import import lazy_import
21
19
lazy_import(globals(), """
22
20
from bzrlib import errors, urlutils
41
39
 
42
40
_bugs_help = \
43
41
"""When making a commit, metadata about bugs fixed by that change can be
44
 
recorded by using the --fixes option. For each bug marked as fixed, an
 
42
recorded by using the ``--fixes`` option. For each bug marked as fixed, an
45
43
entry is included in the 'bugs' revision property stating '<url> <status>'.
46
44
(The only ``status`` value currently supported is ``fixed.``)
47
 
Support for Launchpad's central bug tracker is built in. For other bug
48
 
trackers, configuration is required in advance so that the correct URL
49
 
can be recorded.
50
 
 
51
 
In addition to Launchpad, Bazaar directly supports the generation of
52
 
URLs appropriate for Bugzilla and Trac. If your project uses a different
53
 
bug tracker, it is easy to add support for it.
 
45
 
 
46
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
 
47
rather than a full URL. This looks like::
 
48
 
 
49
    bzr commit --fixes <tracker>:<id>
 
50
 
 
51
or::
 
52
 
 
53
    bzr commit --fixes <id>
 
54
 
 
55
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
 
56
identifier for that bug within the bugtracker, usually the bug number.
 
57
If "<tracker>" is not specified the ``bugtracker`` set in the branch
 
58
or global configuration is used.
 
59
 
 
60
Bazaar knows about a few bug trackers that have many users. If
 
61
you use one of these bug trackers then there is no setup required to
 
62
use this feature, you just need to know the tracker identifier to use.
 
63
These are the bugtrackers that are built in:
 
64
 
 
65
  ============================ ============ ============
 
66
  URL                          Abbreviation Example
 
67
  ============================ ============ ============
 
68
  https://bugs.launchpad.net/  lp           lp:12345
 
69
  http://bugs.debian.org/      deb          deb:12345
 
70
  http://bugzilla.gnome.org/   gnome        gnome:12345
 
71
  ============================ ============ ============
 
72
 
 
73
For the bug trackers not listed above configuration is required.
 
74
Support for generating the URLs for any project using Bugzilla or Trac
 
75
is built in, along with a template mechanism for other bugtrackers with
 
76
simple URL schemes. If your bug tracker can't be described by one
 
77
of the schemes described below then you can write a plugin to support
 
78
it.
 
79
 
54
80
If you use Bugzilla or Trac, then you only need to set a configuration
55
81
variable which contains the base URL of the bug tracker. These options
56
82
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
65
91
 
66
92
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
67
93
 
68
 
bugzilla_<tracker_abbreviation>_url
69
 
-----------------------------------
 
94
bugzilla_<tracker>_url
 
95
----------------------
70
96
 
71
97
If present, the location of the Bugzilla bug tracker referred to by
72
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
98
<tracker>. This option can then be used together with ``bzr commit
73
99
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
74
100
example::
75
101
 
76
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
 
102
    bugzilla_squid_url = http://bugs.squid-cache.org
77
103
 
78
104
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
79
105
fixed.
80
106
 
81
 
trac_<tracker_abbrevation>_url
82
 
------------------------------
 
107
trac_<tracker>_url
 
108
------------------
83
109
 
84
110
If present, the location of the Trac instance referred to by
85
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
111
<tracker>. This option can then be used together with ``bzr commit
86
112
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
87
113
example::
88
114
 
91
117
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
92
118
fixed.
93
119
 
94
 
bugtracker_<tracker_abbrevation>_url
95
 
------------------------------------
 
120
bugtracker_<tracker>_url
 
121
------------------------
96
122
 
97
123
If present, the location of a generic bug tracker instance referred to by
98
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
124
<tracker>. The location must contain an ``{id}`` placeholder,
99
125
which will be replaced by a specific bug ID. This option can then be used
100
126
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
101
127
fixed by that commit. For example::
107
133
 
108
134
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
109
135
 
110
 
for CPAN's RT bug tracker.
 
136
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
 
137
RT bug tracker as fixed, or::
 
138
 
 
139
    bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
 
140
 
 
141
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
 
142
in Hudson's JIRA bug tracker as fixed.
111
143
"""
112
144
 
113
145
 
205
237
 
206
238
 
207
239
tracker_registry.register('gnome',
208
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
209
 
 
210
 
 
211
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
240
    UniqueIntegerBugTracker('gnome',
 
241
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
242
 
 
243
 
 
244
class URLParametrizedBugTracker(BugTracker):
212
245
    """A type of bug tracker that can be found on a variety of different sites,
213
246
    and thus needs to have the base URL configured.
214
247
 
215
248
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
216
 
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
217
 
    and `abbreviation` is a short name for the particular instance (e.g.
218
 
    'squid' or 'apache').
 
249
    `type_name` is the name of the type of tracker and `abbreviation`
 
250
    is a short name for the particular instance.
219
251
    """
220
252
 
221
253
    def get(self, abbreviation, branch):
222
254
        config = branch.get_config()
223
255
        url = config.get_user_option(
224
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
256
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
225
257
        if url is None:
226
258
            return None
227
259
        self._base_url = url
236
268
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
237
269
 
238
270
 
 
271
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
 
272
                                       URLParametrizedBugTracker):
 
273
    """A type of bug tracker that  only allows integer bug IDs.
 
274
 
 
275
    This can be found on a variety of different sites, and thus needs to have
 
276
    the base URL configured.
 
277
 
 
278
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
 
279
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
 
280
    and `abbreviation` is a short name for the particular instance (e.g.
 
281
    'squid' or 'apache').
 
282
    """
 
283
 
239
284
tracker_registry.register(
240
285
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
241
286
 
244
289
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
245
290
 
246
291
 
247
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
 
292
class GenericBugTracker(URLParametrizedBugTracker):
248
293
    """Generic bug tracker specified by an URL template."""
249
294
 
250
295
    def __init__(self):
263
308
 
264
309
 
265
310
tracker_registry.register('generic', GenericBugTracker())
 
311
 
 
312
 
 
313
FIXED = 'fixed'
 
314
 
 
315
ALLOWED_BUG_STATUSES = set([FIXED])
 
316
 
 
317
 
 
318
def encode_fixes_bug_urls(bug_urls):
 
319
    """Get the revision property value for a commit that fixes bugs.
 
320
 
 
321
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
 
322
        come from `get_bug_url`.
 
323
    :return: A string that will be set as the 'bugs' property of a revision
 
324
        as part of a commit.
 
325
    """
 
326
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)