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
Support for Launchpad's central bug tracker is built in. For other bug
47
trackers, configuration is required in advance so that the correct URL
50
In addition to Launchpad, Bazaar directly supports the generation of
51
URLs appropriate for Bugzilla and Trac. If your project uses a different
52
bug tracker, it is easy to add support for it by writing a plugin, say.
53
If you use Bugzilla or Trac, then you only need to set a configuration
54
variable which contains the base URL of the bug tracker. These options
55
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
56
configuration section in ``locations.conf``. You can set up these values
57
for each of the projects you work on.
59
Note: As you provide a short name for each tracker, you can specify one or
60
more bugs in one or more trackers at commit time if you wish.
62
bugzilla_<tracker_abbreviation>_url
63
-----------------------------------
65
If present, the location of the Bugzilla bug tracker referred to by
66
<tracker_abbreviation>. This option can then be used together with ``bzr commit
67
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
70
bugzilla_squid_url = http://www.squid-cache.org/bugs
72
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
75
trac_<tracker_abbrevation>_url
76
------------------------------
78
If present, the location of the Trac instance referred to by
79
<tracker_abbreviation>. This option can then be used together with ``bzr commit
80
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
83
trac_twisted_url = http://www.twistedmatrix.com/trac
85
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
88
bugtracker_<tracker_abbrevation>_url
89
------------------------------------
91
If present, the location of a generic bug tracker instance referred to by
92
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
93
which will be replaced by a specific bug ID. This option can then be used
94
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
95
fixed by that commit. For example::
97
bugtracker_python_url = http://bugs.python.org/issue{id}
99
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
100
Roundup bug tracker as fixed, or::
102
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
104
for CPAN's RT bug tracker.
108
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
109
"""Return a URL pointing to the canonical web page of the bug identified by
112
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
113
return tracker.get_bug_url(bug_id)
116
class TrackerRegistry(registry.Registry):
117
"""Registry of bug tracker types."""
119
def get_tracker(self, abbreviated_bugtracker_name, branch):
120
"""Return the first registered tracker that understands
121
'abbreviated_bugtracker_name'.
123
If no such tracker is found, raise KeyError.
125
for tracker_name in self.keys():
126
tracker_type = self.get(tracker_name)
127
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
128
if tracker is not None:
130
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
133
def help_topic(self, topic):
137
tracker_registry = TrackerRegistry()
138
"""Registry of bug trackers."""
141
class BugTracker(object):
142
"""Base class for bug trackers."""
144
def check_bug_id(self, bug_id):
145
"""Check that the bug_id is valid.
147
The base implementation assumes that all bug_ids are valid.
150
def get_bug_url(self, bug_id):
151
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
152
self.check_bug_id(bug_id)
153
return self._get_bug_url(bug_id)
155
def _get_bug_url(self, bug_id):
156
"""Given a validated bug_id, return the bug's web page's URL."""
159
class IntegerBugTracker(BugTracker):
160
"""A bug tracker that only allows integer bug IDs."""
162
def check_bug_id(self, bug_id):
166
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
169
class UniqueIntegerBugTracker(IntegerBugTracker):
170
"""A style of bug tracker that exists in one place only, such as Launchpad.
172
If you have one of these trackers then register an instance passing in an
173
abbreviated name for the bug tracker and a base URL.
176
def __init__(self, abbreviated_bugtracker_name, base_url):
177
self.abbreviation = abbreviated_bugtracker_name
178
self.base_url = base_url
180
def get(self, abbreviated_bugtracker_name, branch):
181
"""Returns the tracker if the abbreviation matches. Returns None
183
if abbreviated_bugtracker_name != self.abbreviation:
187
def _get_bug_url(self, bug_id):
188
"""Return the URL for bug_id."""
189
return urlutils.join(self.base_url, bug_id)
192
tracker_registry.register(
193
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
196
tracker_registry.register(
197
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
200
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
201
"""A type of bug tracker that can be found on a variety of different sites,
202
and thus needs to have the base URL configured.
204
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
205
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
206
and `abbreviation` is a short name for the particular instance (e.g.
207
'squid' or 'apache').
210
def get(self, abbreviation, branch):
211
config = branch.get_config()
212
url = config.get_user_option(
213
"%s_%s_url" % (self.type_name, abbreviation))
219
def __init__(self, type_name, bug_area):
220
self.type_name = type_name
221
self._bug_area = bug_area
223
def _get_bug_url(self, bug_id):
224
"""Return a URL for a bug on this Trac instance."""
225
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
228
tracker_registry.register(
229
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
231
tracker_registry.register(
233
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
236
class GenericBugTracker(URLParametrizedIntegerBugTracker):
237
"""Generic bug tracker specified by an URL template."""
240
super(GenericBugTracker, self).__init__('bugtracker', None)
242
def get(self, abbreviation, branch):
243
self._abbreviation = abbreviation
244
return super(GenericBugTracker, self).get(abbreviation, branch)
246
def _get_bug_url(self, bug_id):
247
"""Given a validated bug_id, return the bug's web page's URL."""
248
if '{id}' not in self._base_url:
249
raise errors.InvalidBugTrackerURL(self._abbreviation,
251
return self._base_url.replace('{id}', str(bug_id))
254
tracker_registry.register('generic', GenericBugTracker())
added
removed
bzrlib/bugtracker.py
