1
# Copyright (C) 2007-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from bzrlib import registry
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from bzrlib import errors, urlutils
26
"""Provides a shorthand for referring to bugs on a variety of bug trackers.
28
'commit --fixes' stores references to bugs as a <bug_url> -> <bug_status>
29
mapping in the properties for that revision.
31
However, it's inconvenient to type out full URLs for bugs on the command line,
32
particularly given that many users will be using only a single bug tracker per
35
Thus, this module provides a registry of types of bug tracker (e.g. Launchpad,
36
Trac). Given an abbreviated name (e.g. 'lp', 'twisted') and a branch with
37
configuration information, these tracker types can return an instance capable
38
of converting bug IDs into URLs.
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
45
entry is included in the 'bugs' revision property stating '<url> <status>'.
46
(The only ``status`` value currently supported is ``fixed.``)
48
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
49
rather than a full URL. This looks like::
51
bzr commit --fixes <tracker>:<id>
55
bzr commit --fixes <id>
57
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
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.
62
Bazaar knows about a few bug trackers that have many users. If
63
you use one of these bug trackers then there is no setup required to
64
use this feature, you just need to know the tracker identifier to use.
65
These are the bugtrackers that are built in:
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
============================ ============ ============
75
For the bug trackers not listed above configuration is required.
76
Support for generating the URLs for any project using Bugzilla or Trac
77
is built in, along with a template mechanism for other bugtrackers with
78
simple URL schemes. If your bug tracker can't be described by one
79
of the schemes described below then you can write a plugin to support
82
If you use Bugzilla or Trac, then you only need to set a configuration
83
variable which contains the base URL of the bug tracker. These options
84
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
85
configuration section in ``locations.conf``. You can set up these values
86
for each of the projects you work on.
88
Note: As you provide a short name for each tracker, you can specify one or
89
more bugs in one or more trackers at commit time if you wish.
94
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
96
bugzilla_<tracker>_url
97
----------------------
99
If present, the location of the Bugzilla bug tracker referred to by
100
<tracker>. This option can then be used together with ``bzr commit
101
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
104
bugzilla_squid_url = http://bugs.squid-cache.org
106
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
112
If present, the location of the Trac instance referred to by
113
<tracker>. This option can then be used together with ``bzr commit
114
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
117
trac_twisted_url = http://www.twistedmatrix.com/trac
119
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
122
bugtracker_<tracker>_url
123
------------------------
125
If present, the location of a generic bug tracker instance referred to by
126
<tracker>. The location must contain an ``{id}`` placeholder,
127
which will be replaced by a specific bug ID. This option can then be used
128
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
129
fixed by that commit. For example::
131
bugtracker_python_url = http://bugs.python.org/issue{id}
133
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
134
Roundup bug tracker as fixed, or::
136
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
138
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
139
RT bug tracker as fixed, or::
141
bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
143
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
144
in Hudson's JIRA bug tracker as fixed.
148
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
149
"""Return a URL pointing to the canonical web page of the bug identified by
152
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
153
return tracker.get_bug_url(bug_id)
156
class TrackerRegistry(registry.Registry):
157
"""Registry of bug tracker types."""
159
def get_tracker(self, abbreviated_bugtracker_name, branch):
160
"""Return the first registered tracker that understands
161
'abbreviated_bugtracker_name'.
163
If no such tracker is found, raise KeyError.
165
for tracker_name in self.keys():
166
tracker_type = self.get(tracker_name)
167
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
168
if tracker is not None:
170
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
173
def help_topic(self, topic):
177
tracker_registry = TrackerRegistry()
178
"""Registry of bug trackers."""
181
class BugTracker(object):
182
"""Base class for bug trackers."""
184
def check_bug_id(self, bug_id):
185
"""Check that the bug_id is valid.
187
The base implementation assumes that all bug_ids are valid.
190
def get_bug_url(self, bug_id):
191
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
192
self.check_bug_id(bug_id)
193
return self._get_bug_url(bug_id)
195
def _get_bug_url(self, bug_id):
196
"""Given a validated bug_id, return the bug's web page's URL."""
199
class IntegerBugTracker(BugTracker):
200
"""A bug tracker that only allows integer bug IDs."""
202
def check_bug_id(self, bug_id):
206
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
209
class UniqueIntegerBugTracker(IntegerBugTracker):
210
"""A style of bug tracker that exists in one place only, such as Launchpad.
212
If you have one of these trackers then register an instance passing in an
213
abbreviated name for the bug tracker and a base URL. The bug ids are
214
appended directly to the URL.
217
def __init__(self, abbreviated_bugtracker_name, base_url):
218
self.abbreviation = abbreviated_bugtracker_name
219
self.base_url = base_url
221
def get(self, abbreviated_bugtracker_name, branch):
222
"""Returns the tracker if the abbreviation matches. Returns None
224
if abbreviated_bugtracker_name != self.abbreviation:
228
def _get_bug_url(self, bug_id):
229
"""Return the URL for bug_id."""
230
return self.base_url + bug_id
233
tracker_registry.register(
234
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
237
tracker_registry.register(
238
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
241
tracker_registry.register('gnome',
242
UniqueIntegerBugTracker('gnome',
243
'http://bugzilla.gnome.org/show_bug.cgi?id='))
246
class URLParametrizedBugTracker(BugTracker):
247
"""A type of bug tracker that can be found on a variety of different sites,
248
and thus needs to have the base URL configured.
250
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.
255
def get(self, abbreviation, branch):
256
config = branch.get_config()
257
url = config.get_user_option(
258
"%s_%s_url" % (self.type_name, abbreviation), expand=False)
264
def __init__(self, type_name, bug_area):
265
self.type_name = type_name
266
self._bug_area = bug_area
268
def _get_bug_url(self, bug_id):
269
"""Return a URL for a bug on this Trac instance."""
270
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
273
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
274
URLParametrizedBugTracker):
275
"""A type of bug tracker that only allows integer bug IDs.
277
This can be found on a variety of different sites, and thus needs to have
278
the base URL configured.
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').
286
tracker_registry.register(
287
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
289
tracker_registry.register(
291
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
294
class GenericBugTracker(URLParametrizedBugTracker):
295
"""Generic bug tracker specified by an URL template."""
298
super(GenericBugTracker, self).__init__('bugtracker', None)
300
def get(self, abbreviation, branch):
301
self._abbreviation = abbreviation
302
return super(GenericBugTracker, self).get(abbreviation, branch)
304
def _get_bug_url(self, bug_id):
305
"""Given a validated bug_id, return the bug's web page's URL."""
306
if '{id}' not in self._base_url:
307
raise errors.InvalidBugTrackerURL(self._abbreviation,
309
return self._base_url.replace('{id}', str(bug_id))
312
tracker_registry.register('generic', GenericBugTracker())
317
ALLOWED_BUG_STATUSES = set([FIXED])
320
def encode_fixes_bug_urls(bug_urls):
321
"""Get the revision property value for a commit that fixes bugs.
323
:param bug_urls: An iterable of escaped URLs to bugs. These normally
324
come from `get_bug_url`.
325
:return: A string that will be set as the 'bugs' property of a revision
328
return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)
added
removed
bzrlib/bugtracker.py
