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
17
from bzrlib import registry, help_topics
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>
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.
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:
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
64
For the bug trackers not listed above configuration is required.
65
Support for generating the URLs for any project using Bugzilla or Trac
66
is built in, along with a template mechanism for other bugtrackers with
67
simple URL schemes. If your bug tracker can't be described by one
68
of the schemes described below then you can write a plugin to support
71
If you use Bugzilla or Trac, then you only need to set a configuration
72
variable which contains the base URL of the bug tracker. These options
73
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
74
configuration section in ``locations.conf``. You can set up these values
75
for each of the projects you work on.
77
Note: As you provide a short name for each tracker, you can specify one or
78
more bugs in one or more trackers at commit time if you wish.
83
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
85
bugzilla_<tracker_abbreviation>_url
86
-----------------------------------
88
If present, the location of the Bugzilla bug tracker referred to by
89
<tracker_abbreviation>. This option can then be used together with ``bzr commit
90
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
93
bugzilla_squid_url = http://www.squid-cache.org/bugs
95
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
98
trac_<tracker_abbrevation>_url
99
------------------------------
101
If present, the location of the Trac instance referred to by
102
<tracker_abbreviation>. This option can then be used together with ``bzr commit
103
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
106
trac_twisted_url = http://www.twistedmatrix.com/trac
108
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
111
bugtracker_<tracker_abbrevation>_url
112
------------------------------------
114
If present, the location of a generic bug tracker instance referred to by
115
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
116
which will be replaced by a specific bug ID. This option can then be used
117
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
118
fixed by that commit. For example::
120
bugtracker_python_url = http://bugs.python.org/issue{id}
122
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
123
Roundup bug tracker as fixed, or::
125
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
127
for CPAN's RT bug tracker.
131
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
132
"""Return a URL pointing to the canonical web page of the bug identified by
135
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
136
return tracker.get_bug_url(bug_id)
139
class TrackerRegistry(registry.Registry):
140
"""Registry of bug tracker types."""
142
def get_tracker(self, abbreviated_bugtracker_name, branch):
143
"""Return the first registered tracker that understands
144
'abbreviated_bugtracker_name'.
146
If no such tracker is found, raise KeyError.
148
for tracker_name in self.keys():
149
tracker_type = self.get(tracker_name)
150
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
151
if tracker is not None:
153
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
156
def help_topic(self, topic):
160
tracker_registry = TrackerRegistry()
161
"""Registry of bug trackers."""
164
class BugTracker(object):
165
"""Base class for bug trackers."""
167
def check_bug_id(self, bug_id):
168
"""Check that the bug_id is valid.
170
The base implementation assumes that all bug_ids are valid.
173
def get_bug_url(self, bug_id):
174
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
175
self.check_bug_id(bug_id)
176
return self._get_bug_url(bug_id)
178
def _get_bug_url(self, bug_id):
179
"""Given a validated bug_id, return the bug's web page's URL."""
182
class IntegerBugTracker(BugTracker):
183
"""A bug tracker that only allows integer bug IDs."""
185
def check_bug_id(self, bug_id):
189
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
192
class UniqueIntegerBugTracker(IntegerBugTracker):
193
"""A style of bug tracker that exists in one place only, such as Launchpad.
195
If you have one of these trackers then register an instance passing in an
196
abbreviated name for the bug tracker and a base URL. The bug ids are
197
appended directly to the URL.
200
def __init__(self, abbreviated_bugtracker_name, base_url):
201
self.abbreviation = abbreviated_bugtracker_name
202
self.base_url = base_url
204
def get(self, abbreviated_bugtracker_name, branch):
205
"""Returns the tracker if the abbreviation matches. Returns None
207
if abbreviated_bugtracker_name != self.abbreviation:
211
def _get_bug_url(self, bug_id):
212
"""Return the URL for bug_id."""
213
return self.base_url + bug_id
216
tracker_registry.register(
217
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
220
tracker_registry.register(
221
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
224
tracker_registry.register('gnome',
225
UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
228
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
229
"""A type of bug tracker that can be found on a variety of different sites,
230
and thus needs to have the base URL configured.
232
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
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').
238
def get(self, abbreviation, branch):
239
config = branch.get_config()
240
url = config.get_user_option(
241
"%s_%s_url" % (self.type_name, abbreviation))
247
def __init__(self, type_name, bug_area):
248
self.type_name = type_name
249
self._bug_area = bug_area
251
def _get_bug_url(self, bug_id):
252
"""Return a URL for a bug on this Trac instance."""
253
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
256
tracker_registry.register(
257
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
259
tracker_registry.register(
261
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
264
class GenericBugTracker(URLParametrizedIntegerBugTracker):
265
"""Generic bug tracker specified by an URL template."""
268
super(GenericBugTracker, self).__init__('bugtracker', None)
270
def get(self, abbreviation, branch):
271
self._abbreviation = abbreviation
272
return super(GenericBugTracker, self).get(abbreviation, branch)
274
def _get_bug_url(self, bug_id):
275
"""Given a validated bug_id, return the bug's web page's URL."""
276
if '{id}' not in self._base_url:
277
raise errors.InvalidBugTrackerURL(self._abbreviation,
279
return self._base_url.replace('{id}', str(bug_id))
282
tracker_registry.register('generic', GenericBugTracker())
287
ALLOWED_BUG_STATUSES = set([FIXED])
290
def encode_fixes_bug_urls(bug_urls):
291
"""Get the revision property value for a commit that fixes bugs.
293
:param bug_urls: An iterable of escaped URLs to bugs. These normally
294
come from `get_bug_url`.
295
:return: A string that will be set as the 'bugs' property of a revision
298
return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)
added
removed
bzrlib/bugtracker.py
