1
# Copyright (C) 2007-2010 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 __future__ import absolute_import
23
from .lazy_import import lazy_import
24
lazy_import(globals(), """
25
from breezy import urlutils
29
"""Provides a shorthand for referring to bugs on a variety of bug trackers.
31
'commit --fixes' stores references to bugs as a <bug_url> -> <bug_status>
32
mapping in the properties for that revision.
34
However, it's inconvenient to type out full URLs for bugs on the command line,
35
particularly given that many users will be using only a single bug tracker per
38
Thus, this module provides a registry of types of bug tracker (e.g. Launchpad,
39
Trac). Given an abbreviated name (e.g. 'lp', 'twisted') and a branch with
40
configuration information, these tracker types can return an instance capable
41
of converting bug IDs into URLs.
46
"""When making a commit, metadata about bugs fixed by that change can be
47
recorded by using the ``--fixes`` option. For each bug marked as fixed, an
48
entry is included in the 'bugs' revision property stating '<url> <status>'.
49
(The only ``status`` value currently supported is ``fixed.``)
51
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
52
rather than a full URL. This looks like::
54
bzr commit --fixes <tracker>:<id>
58
bzr commit --fixes <id>
60
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
61
identifier for that bug within the bugtracker, usually the bug number.
62
If "<tracker>" is not specified the ``bugtracker`` set in the branch
63
or global configuration is used.
65
Bazaar knows about a few bug trackers that have many users. If
66
you use one of these bug trackers then there is no setup required to
67
use this feature, you just need to know the tracker identifier to use.
68
These are the bugtrackers that are built in:
70
============================ ============ ============
71
URL Abbreviation Example
72
============================ ============ ============
73
https://bugs.launchpad.net/ lp lp:12345
74
http://bugs.debian.org/ deb deb:12345
75
http://bugzilla.gnome.org/ gnome gnome:12345
76
============================ ============ ============
78
For the bug trackers not listed above configuration is required.
79
Support for generating the URLs for any project using Bugzilla or Trac
80
is built in, along with a template mechanism for other bugtrackers with
81
simple URL schemes. If your bug tracker can't be described by one
82
of the schemes described below then you can write a plugin to support
85
If you use Bugzilla or Trac, then you only need to set a configuration
86
variable which contains the base URL of the bug tracker. These options
87
can go into ``breezy.conf``, ``branch.conf`` or into a branch-specific
88
configuration section in ``locations.conf``. You can set up these values
89
for each of the projects you work on.
91
Note: As you provide a short name for each tracker, you can specify one or
92
more bugs in one or more trackers at commit time if you wish.
97
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
99
bugzilla_<tracker>_url
100
----------------------
102
If present, the location of the Bugzilla bug tracker referred to by
103
<tracker>. This option can then be used together with ``bzr commit
104
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
107
bugzilla_squid_url = http://bugs.squid-cache.org
109
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
115
If present, the location of the Trac instance referred to by
116
<tracker>. This option can then be used together with ``bzr commit
117
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
120
trac_twisted_url = http://www.twistedmatrix.com/trac
122
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
125
bugtracker_<tracker>_url
126
------------------------
128
If present, the location of a generic bug tracker instance referred to by
129
<tracker>. The location must contain an ``{id}`` placeholder,
130
which will be replaced by a specific bug ID. This option can then be used
131
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
132
fixed by that commit. For example::
134
bugtracker_python_url = http://bugs.python.org/issue{id}
136
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
137
Roundup bug tracker as fixed, or::
139
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
141
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
142
RT bug tracker as fixed, or::
144
bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
146
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
147
in Hudson's JIRA bug tracker as fixed.
151
class MalformedBugIdentifier(errors.BzrError):
153
_fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
154
'See "brz help bugs" for more information on this feature.')
156
def __init__(self, bug_id, reason):
161
class InvalidBugTrackerURL(errors.BzrError):
163
_fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
164
"contain {id}: %(url)s")
166
def __init__(self, abbreviation, url):
167
self.abbreviation = abbreviation
171
class UnknownBugTrackerAbbreviation(errors.BzrError):
173
_fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
176
def __init__(self, abbreviation, branch):
177
self.abbreviation = abbreviation
181
class InvalidLineInBugsProperty(errors.BzrError):
183
_fmt = ("Invalid line in bugs property: '%(line)s'")
185
def __init__(self, line):
189
class InvalidBugStatus(errors.BzrError):
191
_fmt = ("Invalid bug status: '%(status)s'")
193
def __init__(self, status):
197
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
198
"""Return a URL pointing to the canonical web page of the bug identified by
201
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
202
return tracker.get_bug_url(bug_id)
205
class TrackerRegistry(registry.Registry):
206
"""Registry of bug tracker types."""
208
def get_tracker(self, abbreviated_bugtracker_name, branch):
209
"""Return the first registered tracker that understands
210
'abbreviated_bugtracker_name'.
212
If no such tracker is found, raise KeyError.
214
for tracker_name in self.keys():
215
tracker_type = self.get(tracker_name)
216
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
217
if tracker is not None:
219
raise UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
222
def help_topic(self, topic):
226
tracker_registry = TrackerRegistry()
227
"""Registry of bug trackers."""
230
class BugTracker(object):
231
"""Base class for bug trackers."""
233
def check_bug_id(self, bug_id):
234
"""Check that the bug_id is valid.
236
The base implementation assumes that all bug_ids are valid.
239
def get_bug_url(self, bug_id):
240
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
241
self.check_bug_id(bug_id)
242
return self._get_bug_url(bug_id)
244
def _get_bug_url(self, bug_id):
245
"""Given a validated bug_id, return the bug's web page's URL."""
248
class IntegerBugTracker(BugTracker):
249
"""A bug tracker that only allows integer bug IDs."""
251
def check_bug_id(self, bug_id):
255
raise MalformedBugIdentifier(bug_id, "Must be an integer")
258
class UniqueIntegerBugTracker(IntegerBugTracker):
259
"""A style of bug tracker that exists in one place only, such as Launchpad.
261
If you have one of these trackers then register an instance passing in an
262
abbreviated name for the bug tracker and a base URL. The bug ids are
263
appended directly to the URL.
266
def __init__(self, abbreviated_bugtracker_name, base_url):
267
self.abbreviation = abbreviated_bugtracker_name
268
self.base_url = base_url
270
def get(self, abbreviated_bugtracker_name, branch):
271
"""Returns the tracker if the abbreviation matches, otherwise ``None``.
273
if abbreviated_bugtracker_name != self.abbreviation:
277
def _get_bug_url(self, bug_id):
278
"""Return the URL for bug_id."""
279
return self.base_url + str(bug_id)
282
class ProjectIntegerBugTracker(IntegerBugTracker):
283
"""A bug tracker that exists in one place only with per-project ids.
285
If you have one of these trackers then register an instance passing in an
286
abbreviated name for the bug tracker and a base URL. The bug ids are
287
appended directly to the URL.
290
def __init__(self, abbreviated_bugtracker_name, base_url):
291
self.abbreviation = abbreviated_bugtracker_name
292
self._base_url = base_url
294
def get(self, abbreviated_bugtracker_name, branch):
295
"""Returns the tracker if the abbreviation matches, otherwise ``None``.
297
if abbreviated_bugtracker_name != self.abbreviation:
301
def check_bug_id(self, bug_id):
303
(project, bug_id) = bug_id.rsplit('/', 1)
305
raise MalformedBugIdentifier(bug_id, "Expected format: project/id")
309
raise MalformedBugIdentifier(bug_id, "Bug id must be an integer")
311
def _get_bug_url(self, bug_id):
312
(project, bug_id) = bug_id.rsplit('/', 1)
313
"""Return the URL for bug_id."""
314
if '{id}' not in self._base_url:
315
raise InvalidBugTrackerURL(self._abbreviation, self._base_url)
316
if '{project}' not in self._base_url:
317
raise InvalidBugTrackerURL(self._abbreviation, self._base_url)
318
return self._base_url.replace(
319
'{project}', project).replace('{id}', str(bug_id))
322
tracker_registry.register(
323
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
326
tracker_registry.register(
327
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
330
tracker_registry.register('gnome',
331
UniqueIntegerBugTracker('gnome',
332
'http://bugzilla.gnome.org/show_bug.cgi?id='))
335
tracker_registry.register(
336
'github', ProjectIntegerBugTracker(
337
'github', 'https://github.com/{project}/issues/{id}'))
340
class URLParametrizedBugTracker(BugTracker):
341
"""A type of bug tracker that can be found on a variety of different sites,
342
and thus needs to have the base URL configured.
344
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
345
`type_name` is the name of the type of tracker and `abbreviation`
346
is a short name for the particular instance.
349
def get(self, abbreviation, branch):
350
config = branch.get_config()
351
url = config.get_user_option(
352
"%s_%s_url" % (self.type_name, abbreviation), expand=False)
358
def __init__(self, type_name, bug_area):
359
self.type_name = type_name
360
self._bug_area = bug_area
362
def _get_bug_url(self, bug_id):
363
"""Return a URL for a bug on this Trac instance."""
364
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
367
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
368
URLParametrizedBugTracker):
369
"""A type of bug tracker that only allows integer bug IDs.
371
This can be found on a variety of different sites, and thus needs to have
372
the base URL configured.
374
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
375
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
376
and `abbreviation` is a short name for the particular instance (e.g.
377
'squid' or 'apache').
380
tracker_registry.register(
381
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
383
tracker_registry.register(
385
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
388
class GenericBugTracker(URLParametrizedBugTracker):
389
"""Generic bug tracker specified by an URL template."""
392
super(GenericBugTracker, self).__init__('bugtracker', None)
394
def get(self, abbreviation, branch):
395
self._abbreviation = abbreviation
396
return super(GenericBugTracker, self).get(abbreviation, branch)
398
def _get_bug_url(self, bug_id):
399
"""Given a validated bug_id, return the bug's web page's URL."""
400
if '{id}' not in self._base_url:
401
raise InvalidBugTrackerURL(self._abbreviation, self._base_url)
402
return self._base_url.replace('{id}', str(bug_id))
405
tracker_registry.register('generic', GenericBugTracker())
410
ALLOWED_BUG_STATUSES = {FIXED}
413
def encode_fixes_bug_urls(bug_urls):
414
"""Get the revision property value for a commit that fixes bugs.
416
:param bug_urls: An iterable of escaped URLs to bugs. These normally
417
come from `get_bug_url`.
418
:return: A string that will be set as the 'bugs' property of a revision
421
return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)
added
removed
breezy/bugtracker.py
