1
# Copyright (C) 2007 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
19
from bzrlib import registry, help_topics
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>
53
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
54
identifier for that bug within the bugtracker, usually the bug number.
56
Bazaar knows about a few bug trackers that have many users. If
57
you use one of these bug trackers then there is no setup required to
58
use this feature, you just need to know the tracker identifier to use.
59
These are the bugtrackers that are built in:
61
URL | Abbreviation | Example
62
https://bugs.launchpad.net/ | lp | lp:12345
63
http://bugs.debian.org/ | deb | deb:12345
64
http://bugzilla.gnome.org/ | gnome | gnome:12345
66
For the bug trackers not listed above configuration is required.
67
Support for generating the URLs for any project using Bugzilla or Trac
68
is built in, along with a template mechanism for other bugtrackers with
69
simple URL schemes. If your bug tracker can't be described by one
70
of the schemes described below then you can write a plugin to support
73
If you use Bugzilla or Trac, then you only need to set a configuration
74
variable which contains the base URL of the bug tracker. These options
75
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
76
configuration section in ``locations.conf``. You can set up these values
77
for each of the projects you work on.
79
Note: As you provide a short name for each tracker, you can specify one or
80
more bugs in one or more trackers at commit time if you wish.
85
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
87
bugzilla_<tracker_abbreviation>_url
88
-----------------------------------
90
If present, the location of the Bugzilla bug tracker referred to by
91
<tracker_abbreviation>. This option can then be used together with ``bzr commit
92
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
95
bugzilla_squid_url = http://www.squid-cache.org/bugs
97
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
100
trac_<tracker_abbrevation>_url
101
------------------------------
103
If present, the location of the Trac instance referred to by
104
<tracker_abbreviation>. This option can then be used together with ``bzr commit
105
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
108
trac_twisted_url = http://www.twistedmatrix.com/trac
110
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
113
bugtracker_<tracker_abbrevation>_url
114
------------------------------------
116
If present, the location of a generic bug tracker instance referred to by
117
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
118
which will be replaced by a specific bug ID. This option can then be used
119
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
120
fixed by that commit. For example::
122
bugtracker_python_url = http://bugs.python.org/issue{id}
124
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
125
Roundup bug tracker as fixed, or::
127
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
129
for CPAN's RT bug tracker.
133
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
134
"""Return a URL pointing to the canonical web page of the bug identified by
137
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
138
return tracker.get_bug_url(bug_id)
141
class TrackerRegistry(registry.Registry):
142
"""Registry of bug tracker types."""
144
def get_tracker(self, abbreviated_bugtracker_name, branch):
145
"""Return the first registered tracker that understands
146
'abbreviated_bugtracker_name'.
148
If no such tracker is found, raise KeyError.
150
for tracker_name in self.keys():
151
tracker_type = self.get(tracker_name)
152
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
153
if tracker is not None:
155
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
158
def help_topic(self, topic):
162
tracker_registry = TrackerRegistry()
163
"""Registry of bug trackers."""
166
class BugTracker(object):
167
"""Base class for bug trackers."""
169
def check_bug_id(self, bug_id):
170
"""Check that the bug_id is valid.
172
The base implementation assumes that all bug_ids are valid.
175
def get_bug_url(self, bug_id):
176
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
177
self.check_bug_id(bug_id)
178
return self._get_bug_url(bug_id)
180
def _get_bug_url(self, bug_id):
181
"""Given a validated bug_id, return the bug's web page's URL."""
184
class IntegerBugTracker(BugTracker):
185
"""A bug tracker that only allows integer bug IDs."""
187
def check_bug_id(self, bug_id):
191
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
194
class UniqueIntegerBugTracker(IntegerBugTracker):
195
"""A style of bug tracker that exists in one place only, such as Launchpad.
197
If you have one of these trackers then register an instance passing in an
198
abbreviated name for the bug tracker and a base URL. The bug ids are
199
appended directly to the URL.
202
def __init__(self, abbreviated_bugtracker_name, base_url):
203
self.abbreviation = abbreviated_bugtracker_name
204
self.base_url = base_url
206
def get(self, abbreviated_bugtracker_name, branch):
207
"""Returns the tracker if the abbreviation matches. Returns None
209
if abbreviated_bugtracker_name != self.abbreviation:
213
def _get_bug_url(self, bug_id):
214
"""Return the URL for bug_id."""
215
return self.base_url + bug_id
218
tracker_registry.register(
219
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
222
tracker_registry.register(
223
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
226
tracker_registry.register('gnome',
227
UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
230
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
231
"""A type of bug tracker that can be found on a variety of different sites,
232
and thus needs to have the base URL configured.
234
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
235
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
236
and `abbreviation` is a short name for the particular instance (e.g.
237
'squid' or 'apache').
240
def get(self, abbreviation, branch):
241
config = branch.get_config()
242
url = config.get_user_option(
243
"%s_%s_url" % (self.type_name, abbreviation))
249
def __init__(self, type_name, bug_area):
250
self.type_name = type_name
251
self._bug_area = bug_area
253
def _get_bug_url(self, bug_id):
254
"""Return a URL for a bug on this Trac instance."""
255
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
258
tracker_registry.register(
259
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
261
tracker_registry.register(
263
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
266
class GenericBugTracker(URLParametrizedIntegerBugTracker):
267
"""Generic bug tracker specified by an URL template."""
270
super(GenericBugTracker, self).__init__('bugtracker', None)
272
def get(self, abbreviation, branch):
273
self._abbreviation = abbreviation
274
return super(GenericBugTracker, self).get(abbreviation, branch)
276
def _get_bug_url(self, bug_id):
277
"""Given a validated bug_id, return the bug's web page's URL."""
278
if '{id}' not in self._base_url:
279
raise errors.InvalidBugTrackerURL(self._abbreviation,
281
return self._base_url.replace('{id}', str(bug_id))
284
tracker_registry.register('generic', GenericBugTracker())
289
ALLOWED_BUG_STATUSES = set([FIXED])
292
def encode_fixes_bug_urls(bug_urls):
293
"""Get the revision property value for a commit that fixes bugs.
295
:param bug_urls: An iterable of escaped URLs to bugs. These normally
296
come from `get_bug_url`.
297
:return: A string that will be set as the 'bugs' property of a revision
300
return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)
added
removed
bzrlib/bugtracker.py
