← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

https://launchpad.net/bugs/524184
NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007 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 __future__ import absolute_import
18
 
 
19
 
from bzrlib import registry
 
17
from bzrlib import registry, help_topics
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
45
 
48
 
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
49
 
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
50
48
 
51
49
    bzr commit --fixes <tracker>:<id>
52
50
 
53
 
or::
54
 
 
55
 
    bzr commit --fixes <id>
56
 
 
57
51
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
58
52
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.
61
53
 
62
54
Bazaar knows about a few bug trackers that have many users. If
63
55
you use one of these bug trackers then there is no setup required to
64
56
use this feature, you just need to know the tracker identifier to use.
65
57
These are the bugtrackers that are built in:
66
58
 
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
 
  ============================ ============ ============
 
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
74
63
 
75
64
For the bug trackers not listed above configuration is required.
76
65
Support for generating the URLs for any project using Bugzilla or Trac
93
82
 
94
83
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
95
84
 
96
 
bugzilla_<tracker>_url
97
 
----------------------
 
85
bugzilla_<tracker_abbreviation>_url
 
86
-----------------------------------
98
87
 
99
88
If present, the location of the Bugzilla bug tracker referred to by
100
 
<tracker>. This option can then be used together with ``bzr commit
 
89
<tracker_abbreviation>. This option can then be used together with ``bzr commit
101
90
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
102
91
example::
103
92
 
104
 
    bugzilla_squid_url = http://bugs.squid-cache.org
 
93
    bugzilla_squid_url = http://www.squid-cache.org/bugs
105
94
 
106
95
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
107
96
fixed.
108
97
 
109
 
trac_<tracker>_url
110
 
------------------
 
98
trac_<tracker_abbrevation>_url
 
99
------------------------------
111
100
 
112
101
If present, the location of the Trac instance referred to by
113
 
<tracker>. This option can then be used together with ``bzr commit
 
102
<tracker_abbreviation>. This option can then be used together with ``bzr commit
114
103
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
115
104
example::
116
105
 
119
108
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
120
109
fixed.
121
110
 
122
 
bugtracker_<tracker>_url
123
 
------------------------
 
111
bugtracker_<tracker_abbrevation>_url
 
112
------------------------------------
124
113
 
125
114
If present, the location of a generic bug tracker instance referred to by
126
 
<tracker>. The location must contain an ``{id}`` placeholder,
 
115
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
127
116
which will be replaced by a specific bug ID. This option can then be used
128
117
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
129
118
fixed by that commit. For example::
135
124
 
136
125
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
137
126
 
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.
 
127
for CPAN's RT bug tracker.
145
128
"""
146
129
 
147
130
 
239
222
 
240
223
 
241
224
tracker_registry.register('gnome',
242
 
    UniqueIntegerBugTracker('gnome',
243
 
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
244
 
 
245
 
 
246
 
class URLParametrizedBugTracker(BugTracker):
 
225
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
226
 
 
227
 
 
228
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
247
229
    """A type of bug tracker that can be found on a variety of different sites,
248
230
    and thus needs to have the base URL configured.
249
231
 
250
232
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
251
 
    `type_name` is the name of the type of tracker and `abbreviation`
252
 
    is a short name for the particular instance.
 
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').
253
236
    """
254
237
 
255
238
    def get(self, abbreviation, branch):
256
239
        config = branch.get_config()
257
240
        url = config.get_user_option(
258
 
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
 
241
            "%s_%s_url" % (self.type_name, abbreviation))
259
242
        if url is None:
260
243
            return None
261
244
        self._base_url = url
270
253
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
271
254
 
272
255
 
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
 
 
286
256
tracker_registry.register(
287
257
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
288
258
 
291
261
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
292
262
 
293
263
 
294
 
class GenericBugTracker(URLParametrizedBugTracker):
 
264
class GenericBugTracker(URLParametrizedIntegerBugTracker):
295
265
    """Generic bug tracker specified by an URL template."""
296
266
 
297
267
    def __init__(self):