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 bzrlib import registry
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
20
from bzrlib import errors, urlutils
24
"""Provides a shorthand for referring to bugs on a variety of bug trackers.
26
'commit --fixes' stores references to bugs as a <bug_url> -> <bug_status>
27
mapping in the properties for that revision.
29
However, it's inconvenient to type out full URLs for bugs on the command line,
30
particularly given that many users will be using only a single bug tracker per
33
Thus, this module provides a registry of types of bug tracker (e.g. Launchpad,
34
Trac). Given an abbreviated name (e.g. 'lp', 'twisted') and a branch with
35
configuration information, these tracker types can return an instance capable
36
of converting bug IDs into URLs.
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
43
entry is included in the 'bugs' revision property stating '<url> <status>'.
44
(The only ``status`` value currently supported is ``fixed.``)
46
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
47
rather than a full URL. This looks like::
49
bzr commit --fixes <tracker>:<id>
53
bzr commit --fixes <id>
55
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
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.
60
Bazaar knows about a few bug trackers that have many users. If
61
you use one of these bug trackers then there is no setup required to
62
use this feature, you just need to know the tracker identifier to use.
63
These are the bugtrackers that are built in:
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
============================ ============ ============
73
For the bug trackers not listed above configuration is required.
74
Support for generating the URLs for any project using Bugzilla or Trac
75
is built in, along with a template mechanism for other bugtrackers with
76
simple URL schemes. If your bug tracker can't be described by one
77
of the schemes described below then you can write a plugin to support
80
If you use Bugzilla or Trac, then you only need to set a configuration
81
variable which contains the base URL of the bug tracker. These options
82
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
83
configuration section in ``locations.conf``. You can set up these values
84
for each of the projects you work on.
86
Note: As you provide a short name for each tracker, you can specify one or
87
more bugs in one or more trackers at commit time if you wish.
92
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
94
bugzilla_<tracker>_url
95
----------------------
97
If present, the location of the Bugzilla bug tracker referred to by
98
<tracker>. This option can then be used together with ``bzr commit
99
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
102
bugzilla_squid_url = http://bugs.squid-cache.org
104
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
110
If present, the location of the Trac instance referred to by
111
<tracker>. This option can then be used together with ``bzr commit
112
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
115
trac_twisted_url = http://www.twistedmatrix.com/trac
117
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
120
bugtracker_<tracker>_url
121
------------------------
123
If present, the location of a generic bug tracker instance referred to by
124
<tracker>. The location must contain an ``{id}`` placeholder,
125
which will be replaced by a specific bug ID. This option can then be used
126
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
127
fixed by that commit. For example::
129
bugtracker_python_url = http://bugs.python.org/issue{id}
131
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
132
Roundup bug tracker as fixed, or::
134
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
136
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
137
RT bug tracker as fixed, or::
139
bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
141
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
142
in Hudson's JIRA bug tracker as fixed.
146
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
147
"""Return a URL pointing to the canonical web page of the bug identified by
150
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
151
return tracker.get_bug_url(bug_id)
154
class TrackerRegistry(registry.Registry):
155
"""Registry of bug tracker types."""
157
def get_tracker(self, abbreviated_bugtracker_name, branch):
158
"""Return the first registered tracker that understands
159
'abbreviated_bugtracker_name'.
161
If no such tracker is found, raise KeyError.
163
for tracker_name in self.keys():
164
tracker_type = self.get(tracker_name)
165
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
166
if tracker is not None:
168
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
171
def help_topic(self, topic):
175
tracker_registry = TrackerRegistry()
176
"""Registry of bug trackers."""
179
class BugTracker(object):
180
"""Base class for bug trackers."""
182
def check_bug_id(self, bug_id):
183
"""Check that the bug_id is valid.
185
The base implementation assumes that all bug_ids are valid.
188
def get_bug_url(self, bug_id):
189
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
190
self.check_bug_id(bug_id)
191
return self._get_bug_url(bug_id)
193
def _get_bug_url(self, bug_id):
194
"""Given a validated bug_id, return the bug's web page's URL."""
197
class IntegerBugTracker(BugTracker):
198
"""A bug tracker that only allows integer bug IDs."""
200
def check_bug_id(self, bug_id):
204
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
207
class UniqueIntegerBugTracker(IntegerBugTracker):
208
"""A style of bug tracker that exists in one place only, such as Launchpad.
210
If you have one of these trackers then register an instance passing in an
211
abbreviated name for the bug tracker and a base URL. The bug ids are
212
appended directly to the URL.
215
def __init__(self, abbreviated_bugtracker_name, base_url):
216
self.abbreviation = abbreviated_bugtracker_name
217
self.base_url = base_url
219
def get(self, abbreviated_bugtracker_name, branch):
220
"""Returns the tracker if the abbreviation matches. Returns None
222
if abbreviated_bugtracker_name != self.abbreviation:
226
def _get_bug_url(self, bug_id):
227
"""Return the URL for bug_id."""
228
return self.base_url + bug_id
231
tracker_registry.register(
232
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
235
tracker_registry.register(
236
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
239
tracker_registry.register('gnome',
240
UniqueIntegerBugTracker('gnome',
241
'http://bugzilla.gnome.org/show_bug.cgi?id='))
244
class URLParametrizedBugTracker(BugTracker):
245
"""A type of bug tracker that can be found on a variety of different sites,
246
and thus needs to have the base URL configured.
248
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
249
`type_name` is the name of the type of tracker and `abbreviation`
250
is a short name for the particular instance.
253
def get(self, abbreviation, branch):
254
config = branch.get_config()
255
url = config.get_user_option(
256
"%s_%s_url" % (self.type_name, abbreviation), expand=False)
262
def __init__(self, type_name, bug_area):
263
self.type_name = type_name
264
self._bug_area = bug_area
266
def _get_bug_url(self, bug_id):
267
"""Return a URL for a bug on this Trac instance."""
268
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
271
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
272
URLParametrizedBugTracker):
273
"""A type of bug tracker that only allows integer bug IDs.
275
This can be found on a variety of different sites, and thus needs to have
276
the base URL configured.
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').
284
tracker_registry.register(
285
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
287
tracker_registry.register(
289
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
292
class GenericBugTracker(URLParametrizedBugTracker):
293
"""Generic bug tracker specified by an URL template."""
296
super(GenericBugTracker, self).__init__('bugtracker', None)
298
def get(self, abbreviation, branch):
299
self._abbreviation = abbreviation
300
return super(GenericBugTracker, self).get(abbreviation, branch)
302
def _get_bug_url(self, bug_id):
303
"""Given a validated bug_id, return the bug's web page's URL."""
304
if '{id}' not in self._base_url:
305
raise errors.InvalidBugTrackerURL(self._abbreviation,
307
return self._base_url.replace('{id}', str(bug_id))
310
tracker_registry.register('generic', GenericBugTracker())
315
ALLOWED_BUG_STATUSES = set([FIXED])
318
def encode_fixes_bug_urls(bug_urls):
319
"""Get the revision property value for a commit that fixes bugs.
321
:param bug_urls: An iterable of escaped URLs to bugs. These normally
322
come from `get_bug_url`.
323
:return: A string that will be set as the 'bugs' property of a revision
326
return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)
added
removed
bzrlib/bugtracker.py
