← 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: 2011-10-14 13:56:45 UTC
  • mfrom: (6215 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20111014135645-phc3q3y21k2ks0s2
Merge bzr.dev.

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
 
from bzrlib import registry, help_topics
 
17
from bzrlib import registry
18
18
from bzrlib.lazy_import import lazy_import
19
19
lazy_import(globals(), """
20
20
from bzrlib import errors, urlutils
39
39
 
40
40
_bugs_help = \
41
41
"""When making a commit, metadata about bugs fixed by that change can be
42
 
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
43
43
entry is included in the 'bugs' revision property stating '<url> <status>'.
44
44
(The only ``status`` value currently supported is ``fixed.``)
45
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
 
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
48
 
49
49
    bzr commit --fixes <tracker>:<id>
50
50
 
 
51
or::
 
52
 
 
53
    bzr commit --fixes <id>
 
54
 
51
55
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
52
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.
53
59
 
54
60
Bazaar knows about a few bug trackers that have many users. If
55
61
you use one of these bug trackers then there is no setup required to
56
62
use this feature, you just need to know the tracker identifier to use.
57
63
These are the bugtrackers that are built in:
58
64
 
59
 
     URL                          | Abbreviation | Example
60
 
     https://bugs.launchpad.net/  | lp           | lp:12345
61
 
     http://bugs.debian.org/      | deb          | deb:12345
62
 
     http://bugzilla.gnome.org/   | gnome        | gnome:12345
 
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
  ============================ ============ ============
63
72
 
64
73
For the bug trackers not listed above configuration is required.
65
74
Support for generating the URLs for any project using Bugzilla or Trac
82
91
 
83
92
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
84
93
 
85
 
bugzilla_<tracker_abbreviation>_url
86
 
-----------------------------------
 
94
bugzilla_<tracker>_url
 
95
----------------------
87
96
 
88
97
If present, the location of the Bugzilla bug tracker referred to by
89
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
98
<tracker>. This option can then be used together with ``bzr commit
90
99
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
91
100
example::
92
101
 
93
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
 
102
    bugzilla_squid_url = http://bugs.squid-cache.org
94
103
 
95
104
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
96
105
fixed.
97
106
 
98
 
trac_<tracker_abbrevation>_url
99
 
------------------------------
 
107
trac_<tracker>_url
 
108
------------------
100
109
 
101
110
If present, the location of the Trac instance referred to by
102
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
111
<tracker>. This option can then be used together with ``bzr commit
103
112
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
104
113
example::
105
114
 
108
117
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
109
118
fixed.
110
119
 
111
 
bugtracker_<tracker_abbrevation>_url
112
 
------------------------------------
 
120
bugtracker_<tracker>_url
 
121
------------------------
113
122
 
114
123
If present, the location of a generic bug tracker instance referred to by
115
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
124
<tracker>. The location must contain an ``{id}`` placeholder,
116
125
which will be replaced by a specific bug ID. This option can then be used
117
126
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
118
127
fixed by that commit. For example::
124
133
 
125
134
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
126
135
 
127
 
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.
128
143
"""
129
144
 
130
145
 
222
237
 
223
238
 
224
239
tracker_registry.register('gnome',
225
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
226
 
 
227
 
 
228
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
240
    UniqueIntegerBugTracker('gnome',
 
241
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
242
 
 
243
 
 
244
class URLParametrizedBugTracker(BugTracker):
229
245
    """A type of bug tracker that can be found on a variety of different sites,
230
246
    and thus needs to have the base URL configured.
231
247
 
232
248
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
233
 
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
234
 
    and `abbreviation` is a short name for the particular instance (e.g.
235
 
    '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.
236
251
    """
237
252
 
238
253
    def get(self, abbreviation, branch):
239
254
        config = branch.get_config()
240
255
        url = config.get_user_option(
241
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
256
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
242
257
        if url is None:
243
258
            return None
244
259
        self._base_url = url
253
268
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
254
269
 
255
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
 
256
284
tracker_registry.register(
257
285
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
258
286
 
261
289
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
262
290
 
263
291
 
264
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
 
292
class GenericBugTracker(URLParametrizedBugTracker):
265
293
    """Generic bug tracker specified by an URL template."""
266
294
 
267
295
    def __init__(self):