← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Vincent Ladeuil
  • Date: 2011-08-12 09:49:24 UTC
  • mfrom: (6015.9.10 2.4)
  • mto: This revision was merged to the branch mainline in revision 6066.
  • Revision ID: v.ladeuil+lp@free.fr-20110812094924-knc5s0g7vs31a2f1
Merge 2.4 into trunk

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
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
 
52
identifier for that bug within the bugtracker, usually the bug number.
 
53
 
 
54
Bazaar knows about a few bug trackers that have many users. If
 
55
you use one of these bug trackers then there is no setup required to
 
56
use this feature, you just need to know the tracker identifier to use.
 
57
These are the bugtrackers that are built in:
 
58
 
 
59
  ============================ ============ ============
 
60
  URL                          Abbreviation Example
 
61
  ============================ ============ ============
 
62
  https://bugs.launchpad.net/  lp           lp:12345
 
63
  http://bugs.debian.org/      deb          deb:12345
 
64
  http://bugzilla.gnome.org/   gnome        gnome:12345
 
65
  ============================ ============ ============
 
66
 
 
67
For the bug trackers not listed above configuration is required.
 
68
Support for generating the URLs for any project using Bugzilla or Trac
 
69
is built in, along with a template mechanism for other bugtrackers with
 
70
simple URL schemes. If your bug tracker can't be described by one
 
71
of the schemes described below then you can write a plugin to support
 
72
it.
 
73
 
54
74
If you use Bugzilla or Trac, then you only need to set a configuration
55
75
variable which contains the base URL of the bug tracker. These options
56
76
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
60
80
Note: As you provide a short name for each tracker, you can specify one or
61
81
more bugs in one or more trackers at commit time if you wish.
62
82
 
63
 
bugzilla_<tracker_abbreviation>_url
64
 
-----------------------------------
 
83
Launchpad
 
84
---------
 
85
 
 
86
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
 
87
 
 
88
bugzilla_<tracker>_url
 
89
----------------------
65
90
 
66
91
If present, the location of the Bugzilla bug tracker referred to by
67
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
92
<tracker>. This option can then be used together with ``bzr commit
68
93
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
69
94
example::
70
95
 
71
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
 
96
    bugzilla_squid_url = http://bugs.squid-cache.org
72
97
 
73
98
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
74
99
fixed.
75
100
 
76
 
trac_<tracker_abbrevation>_url
77
 
------------------------------
 
101
trac_<tracker>_url
 
102
------------------
78
103
 
79
104
If present, the location of the Trac instance referred to by
80
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
105
<tracker>. This option can then be used together with ``bzr commit
81
106
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
82
107
example::
83
108
 
86
111
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
87
112
fixed.
88
113
 
89
 
bugtracker_<tracker_abbrevation>_url
90
 
------------------------------------
 
114
bugtracker_<tracker>_url
 
115
------------------------
91
116
 
92
117
If present, the location of a generic bug tracker instance referred to by
93
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
118
<tracker>. The location must contain an ``{id}`` placeholder,
94
119
which will be replaced by a specific bug ID. This option can then be used
95
120
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
96
121
fixed by that commit. For example::
102
127
 
103
128
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
104
129
 
105
 
for CPAN's RT bug tracker.
 
130
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
 
131
RT bug tracker as fixed, or::
 
132
 
 
133
    bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
 
134
 
 
135
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
 
136
in Hudson's JIRA bug tracker as fixed.
106
137
"""
107
138
 
108
139
 
200
231
 
201
232
 
202
233
tracker_registry.register('gnome',
203
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
204
 
 
205
 
 
206
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
234
    UniqueIntegerBugTracker('gnome',
 
235
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
236
 
 
237
 
 
238
class URLParametrizedBugTracker(BugTracker):
207
239
    """A type of bug tracker that can be found on a variety of different sites,
208
240
    and thus needs to have the base URL configured.
209
241
 
210
242
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
211
 
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
212
 
    and `abbreviation` is a short name for the particular instance (e.g.
213
 
    'squid' or 'apache').
 
243
    `type_name` is the name of the type of tracker and `abbreviation`
 
244
    is a short name for the particular instance.
214
245
    """
215
246
 
216
247
    def get(self, abbreviation, branch):
217
248
        config = branch.get_config()
218
249
        url = config.get_user_option(
219
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
250
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
220
251
        if url is None:
221
252
            return None
222
253
        self._base_url = url
231
262
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
232
263
 
233
264
 
 
265
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
 
266
                                       URLParametrizedBugTracker):
 
267
    """A type of bug tracker that  only allows integer bug IDs.
 
268
 
 
269
    This can be found on a variety of different sites, and thus needs to have
 
270
    the base URL configured.
 
271
 
 
272
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
 
273
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
 
274
    and `abbreviation` is a short name for the particular instance (e.g.
 
275
    'squid' or 'apache').
 
276
    """
 
277
 
234
278
tracker_registry.register(
235
279
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
236
280
 
239
283
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
240
284
 
241
285
 
242
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
 
286
class GenericBugTracker(URLParametrizedBugTracker):
243
287
    """Generic bug tracker specified by an URL template."""
244
288
 
245
289
    def __init__(self):
258
302
 
259
303
 
260
304
tracker_registry.register('generic', GenericBugTracker())
 
305
 
 
306
 
 
307
FIXED = 'fixed'
 
308
 
 
309
ALLOWED_BUG_STATUSES = set([FIXED])
 
310
 
 
311
 
 
312
def encode_fixes_bug_urls(bug_urls):
 
313
    """Get the revision property value for a commit that fixes bugs.
 
314
 
 
315
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
 
316
        come from `get_bug_url`.
 
317
    :return: A string that will be set as the 'bugs' property of a revision
 
318
        as part of a commit.
 
319
    """
 
320
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)