← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-20 14:15:25 UTC
  • mto: (6471.1.4 iter-child-entries)
  • mto: This revision was merged to the branch mainline in revision 6472.
  • Revision ID: jelmer@samba.org-20120220141525-9azkfei62st8yc7w
Use inventories directly in fewer places.

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
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
 
import textwrap
 
17
from __future__ import absolute_import
18
18
 
19
 
from bzrlib import registry, help_topics
 
19
from bzrlib import registry
20
20
from bzrlib.lazy_import import lazy_import
21
21
lazy_import(globals(), """
22
22
from bzrlib import errors, urlutils
41
41
 
42
42
_bugs_help = \
43
43
"""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
 
44
recorded by using the ``--fixes`` option. For each bug marked as fixed, an
45
45
entry is included in the 'bugs' revision property stating '<url> <status>'.
46
46
(The only ``status`` value currently supported is ``fixed.``)
47
47
 
48
 
The --fixes option allows you to specify a bug tracker and a bug identifier
49
 
rather than a full URL. This looks like
 
48
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
 
49
rather than a full URL. This looks like::
50
50
 
51
51
    bzr commit --fixes <tracker>:<id>
52
52
 
 
53
or::
 
54
 
 
55
    bzr commit --fixes <id>
 
56
 
53
57
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
54
58
identifier for that bug within the bugtracker, usually the bug number.
 
59
If "<tracker>" is not specified the ``bugtracker`` set in the branch
 
60
or global configuration is used.
55
61
 
56
62
Bazaar knows about a few bug trackers that have many users. If
57
63
you use one of these bug trackers then there is no setup required to
58
64
use this feature, you just need to know the tracker identifier to use.
59
65
These are the bugtrackers that are built in:
60
66
 
61
 
     URL                          | Abbreviation | Example
62
 
     https://bugs.launchpad.net/  | lp           | lp:12345
63
 
     http://bugs.debian.org/      | deb          | deb:12345
64
 
     http://bugzilla.gnome.org/   | gnome        | gnome:12345
 
67
  ============================ ============ ============
 
68
  URL                          Abbreviation Example
 
69
  ============================ ============ ============
 
70
  https://bugs.launchpad.net/  lp           lp:12345
 
71
  http://bugs.debian.org/      deb          deb:12345
 
72
  http://bugzilla.gnome.org/   gnome        gnome:12345
 
73
  ============================ ============ ============
65
74
 
66
75
For the bug trackers not listed above configuration is required.
67
76
Support for generating the URLs for any project using Bugzilla or Trac
84
93
 
85
94
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
86
95
 
87
 
bugzilla_<tracker_abbreviation>_url
88
 
-----------------------------------
 
96
bugzilla_<tracker>_url
 
97
----------------------
89
98
 
90
99
If present, the location of the Bugzilla bug tracker referred to by
91
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
100
<tracker>. This option can then be used together with ``bzr commit
92
101
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
93
102
example::
94
103
 
95
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
 
104
    bugzilla_squid_url = http://bugs.squid-cache.org
96
105
 
97
106
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
98
107
fixed.
99
108
 
100
 
trac_<tracker_abbrevation>_url
101
 
------------------------------
 
109
trac_<tracker>_url
 
110
------------------
102
111
 
103
112
If present, the location of the Trac instance referred to by
104
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
113
<tracker>. This option can then be used together with ``bzr commit
105
114
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
106
115
example::
107
116
 
110
119
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
111
120
fixed.
112
121
 
113
 
bugtracker_<tracker_abbrevation>_url
114
 
------------------------------------
 
122
bugtracker_<tracker>_url
 
123
------------------------
115
124
 
116
125
If present, the location of a generic bug tracker instance referred to by
117
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
126
<tracker>. The location must contain an ``{id}`` placeholder,
118
127
which will be replaced by a specific bug ID. This option can then be used
119
128
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
120
129
fixed by that commit. For example::
126
135
 
127
136
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
128
137
 
129
 
for CPAN's RT bug tracker.
 
138
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
 
139
RT bug tracker as fixed, or::
 
140
 
 
141
    bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
 
142
 
 
143
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
 
144
in Hudson's JIRA bug tracker as fixed.
130
145
"""
131
146
 
132
147
 
224
239
 
225
240
 
226
241
tracker_registry.register('gnome',
227
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
228
 
 
229
 
 
230
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
242
    UniqueIntegerBugTracker('gnome',
 
243
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
244
 
 
245
 
 
246
class URLParametrizedBugTracker(BugTracker):
231
247
    """A type of bug tracker that can be found on a variety of different sites,
232
248
    and thus needs to have the base URL configured.
233
249
 
234
250
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
235
 
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
236
 
    and `abbreviation` is a short name for the particular instance (e.g.
237
 
    'squid' or 'apache').
 
251
    `type_name` is the name of the type of tracker and `abbreviation`
 
252
    is a short name for the particular instance.
238
253
    """
239
254
 
240
255
    def get(self, abbreviation, branch):
241
256
        config = branch.get_config()
242
257
        url = config.get_user_option(
243
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
258
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
244
259
        if url is None:
245
260
            return None
246
261
        self._base_url = url
255
270
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
256
271
 
257
272
 
 
273
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
 
274
                                       URLParametrizedBugTracker):
 
275
    """A type of bug tracker that  only allows integer bug IDs.
 
276
 
 
277
    This can be found on a variety of different sites, and thus needs to have
 
278
    the base URL configured.
 
279
 
 
280
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
 
281
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
 
282
    and `abbreviation` is a short name for the particular instance (e.g.
 
283
    'squid' or 'apache').
 
284
    """
 
285
 
258
286
tracker_registry.register(
259
287
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
260
288
 
263
291
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
264
292
 
265
293
 
266
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
 
294
class GenericBugTracker(URLParametrizedBugTracker):
267
295
    """Generic bug tracker specified by an URL template."""
268
296
 
269
297
    def __init__(self):