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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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.``)
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
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.
54
If you use Bugzilla or Trac, then you only need to set a configuration
55
variable which contains the base URL of the bug tracker. These options
56
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
57
configuration section in ``locations.conf``. You can set up these values
58
for each of the projects you work on.
60
Note: As you provide a short name for each tracker, you can specify one or
61
more bugs in one or more trackers at commit time if you wish.
66
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
68
bugzilla_<tracker_abbreviation>_url
69
-----------------------------------
71
If present, the location of the Bugzilla bug tracker referred to by
72
<tracker_abbreviation>. This option can then be used together with ``bzr commit
73
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
76
bugzilla_squid_url = http://www.squid-cache.org/bugs
78
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
81
trac_<tracker_abbrevation>_url
82
------------------------------
84
If present, the location of the Trac instance referred to by
85
<tracker_abbreviation>. This option can then be used together with ``bzr commit
86
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
89
trac_twisted_url = http://www.twistedmatrix.com/trac
91
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
94
bugtracker_<tracker_abbrevation>_url
95
------------------------------------
97
If present, the location of a generic bug tracker instance referred to by
98
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
99
which will be replaced by a specific bug ID. This option can then be used
100
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
101
fixed by that commit. For example::
103
bugtracker_python_url = http://bugs.python.org/issue{id}
105
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
106
Roundup bug tracker as fixed, or::
108
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
110
for CPAN's RT bug tracker.
114
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
115
"""Return a URL pointing to the canonical web page of the bug identified by
118
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
119
return tracker.get_bug_url(bug_id)
122
class TrackerRegistry(registry.Registry):
123
"""Registry of bug tracker types."""
125
def get_tracker(self, abbreviated_bugtracker_name, branch):
126
"""Return the first registered tracker that understands
127
'abbreviated_bugtracker_name'.
129
If no such tracker is found, raise KeyError.
131
for tracker_name in self.keys():
132
tracker_type = self.get(tracker_name)
133
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
134
if tracker is not None:
136
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
139
def help_topic(self, topic):
143
tracker_registry = TrackerRegistry()
144
"""Registry of bug trackers."""
147
class BugTracker(object):
148
"""Base class for bug trackers."""
150
def check_bug_id(self, bug_id):
151
"""Check that the bug_id is valid.
153
The base implementation assumes that all bug_ids are valid.
156
def get_bug_url(self, bug_id):
157
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
158
self.check_bug_id(bug_id)
159
return self._get_bug_url(bug_id)
161
def _get_bug_url(self, bug_id):
162
"""Given a validated bug_id, return the bug's web page's URL."""
165
class IntegerBugTracker(BugTracker):
166
"""A bug tracker that only allows integer bug IDs."""
168
def check_bug_id(self, bug_id):
172
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
175
class UniqueIntegerBugTracker(IntegerBugTracker):
176
"""A style of bug tracker that exists in one place only, such as Launchpad.
178
If you have one of these trackers then register an instance passing in an
179
abbreviated name for the bug tracker and a base URL. The bug ids are
180
appended directly to the URL.
183
def __init__(self, abbreviated_bugtracker_name, base_url):
184
self.abbreviation = abbreviated_bugtracker_name
185
self.base_url = base_url
187
def get(self, abbreviated_bugtracker_name, branch):
188
"""Returns the tracker if the abbreviation matches. Returns None
190
if abbreviated_bugtracker_name != self.abbreviation:
194
def _get_bug_url(self, bug_id):
195
"""Return the URL for bug_id."""
196
return self.base_url + bug_id
199
tracker_registry.register(
200
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
203
tracker_registry.register(
204
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
207
tracker_registry.register('gnome',
208
UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
211
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
212
"""A type of bug tracker that can be found on a variety of different sites,
213
and thus needs to have the base URL configured.
215
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
216
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
217
and `abbreviation` is a short name for the particular instance (e.g.
218
'squid' or 'apache').
221
def get(self, abbreviation, branch):
222
config = branch.get_config()
223
url = config.get_user_option(
224
"%s_%s_url" % (self.type_name, abbreviation))
230
def __init__(self, type_name, bug_area):
231
self.type_name = type_name
232
self._bug_area = bug_area
234
def _get_bug_url(self, bug_id):
235
"""Return a URL for a bug on this Trac instance."""
236
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
239
tracker_registry.register(
240
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
242
tracker_registry.register(
244
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
247
class GenericBugTracker(URLParametrizedIntegerBugTracker):
248
"""Generic bug tracker specified by an URL template."""
251
super(GenericBugTracker, self).__init__('bugtracker', None)
253
def get(self, abbreviation, branch):
254
self._abbreviation = abbreviation
255
return super(GenericBugTracker, self).get(abbreviation, branch)
257
def _get_bug_url(self, bug_id):
258
"""Given a validated bug_id, return the bug's web page's URL."""
259
if '{id}' not in self._base_url:
260
raise errors.InvalidBugTrackerURL(self._abbreviation,
262
return self._base_url.replace('{id}', str(bug_id))
265
tracker_registry.register('generic', GenericBugTracker())
added
removed
bzrlib/bugtracker.py
