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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
If present, the location of a generic bug tracker instance referred to by
91
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
92
which will be replaced by a specific bug ID. This option can then be used
93
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
94
fixed by that commit. For example::
96
bugtracker_python_url = http://bugs.python.org/issue{id}
98
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
99
Roundup bug tracker as fixed, or::
101
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
103
for CPAN's RT bug tracker.
107
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
108
"""Return a URL pointing to the canonical web page of the bug identified by
111
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
112
return tracker.get_bug_url(bug_id)
115
class TrackerRegistry(registry.Registry):
116
"""Registry of bug tracker types."""
118
def get_tracker(self, abbreviated_bugtracker_name, branch):
119
"""Return the first registered tracker that understands
120
'abbreviated_bugtracker_name'.
122
If no such tracker is found, raise KeyError.
124
for tracker_name in self.keys():
125
tracker_type = self.get(tracker_name)
126
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
127
if tracker is not None:
129
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
132
def help_topic(self, topic):
136
tracker_registry = TrackerRegistry()
137
"""Registry of bug trackers."""
140
class BugTracker(object):
141
"""Base class for bug trackers."""
143
def check_bug_id(self, bug_id):
144
"""Check that the bug_id is valid.
146
The base implementation assumes that all bug_ids are valid.
149
def get_bug_url(self, bug_id):
150
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
151
self.check_bug_id(bug_id)
152
return self._get_bug_url(bug_id)
154
def _get_bug_url(self, bug_id):
155
"""Given a validated bug_id, return the bug's web page's URL."""
158
class IntegerBugTracker(BugTracker):
159
"""A bug tracker that only allows integer bug IDs."""
161
def check_bug_id(self, bug_id):
165
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
168
class UniqueIntegerBugTracker(IntegerBugTracker):
169
"""A style of bug tracker that exists in one place only, such as Launchpad.
171
If you have one of these trackers then register an instance passing in an
172
abbreviated name for the bug tracker and a base URL.
175
def __init__(self, abbreviated_bugtracker_name, base_url):
176
self.abbreviation = abbreviated_bugtracker_name
177
self.base_url = base_url
179
def get(self, abbreviated_bugtracker_name, branch):
180
"""Returns the tracker if the abbreviation matches. Returns None
182
if abbreviated_bugtracker_name != self.abbreviation:
186
def _get_bug_url(self, bug_id):
187
"""Return the URL for bug_id."""
188
return urlutils.join(self.base_url, bug_id)
191
tracker_registry.register(
192
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
195
tracker_registry.register(
196
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
199
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
200
"""A type of bug tracker that can be found on a variety of different sites,
201
and thus needs to have the base URL configured.
203
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
204
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
205
and `abbreviation` is a short name for the particular instance (e.g.
206
'squid' or 'apache').
209
def get(self, abbreviation, branch):
210
config = branch.get_config()
211
url = config.get_user_option(
212
"%s_%s_url" % (self.type_name, abbreviation))
218
def __init__(self, type_name, bug_area):
219
self.type_name = type_name
220
self._bug_area = bug_area
222
def _get_bug_url(self, bug_id):
223
"""Return a URL for a bug on this Trac instance."""
224
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
227
tracker_registry.register(
228
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
230
tracker_registry.register(
232
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
235
class GenericBugTracker(URLParametrizedIntegerBugTracker):
236
"""Generic bug tracker specified by an URL template."""
239
super(GenericBugTracker, self).__init__('bugtracker', None)
241
def get(self, abbreviation, branch):
242
self._abbreviation = abbreviation
243
return super(GenericBugTracker, self).get(abbreviation, branch)
245
def _get_bug_url(self, bug_id):
246
"""Given a validated bug_id, return the bug's web page's URL."""
247
if '{id}' not in self._base_url:
248
raise errors.InvalidBugTrackerURL(self._abbreviation,
250
return self._base_url.replace('{id}', str(bug_id))
253
tracker_registry.register('generic', GenericBugTracker())
added
removed
bzrlib/bugtracker.py
