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.
42
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
43
"""Return a URL pointing to the canonical web page of the bug identified by
46
tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
47
return tracker.get_bug_url(bug_id)
50
class TrackerRegistry(registry.Registry):
51
"""Registry of bug tracker types."""
53
def get_tracker(self, abbreviated_bugtracker_name, branch):
54
"""Return the first registered tracker that understands
55
'abbreviated_bugtracker_name'.
57
If no such tracker is found, raise KeyError.
59
for tracker_name in self.keys():
60
tracker_type = self.get(tracker_name)
61
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
62
if tracker is not None:
64
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
67
def help_topic(self, topic):
68
return textwrap.dedent("""\
69
Bazaar provides the ability to store information about bugs being fixed
70
as metadata on a revision.
72
For each bug marked as fixed, an entry is included in the 'bugs'
73
revision property stating '<url> <status>'.
77
tracker_registry = TrackerRegistry()
78
"""Registry of bug trackers."""
81
class BugTracker(object):
82
"""Base class for bug trackers."""
84
def check_bug_id(self, bug_id):
85
"""Check that the bug_id is valid.
87
The base implementation assumes that all bug_ids are valid.
90
def get_bug_url(self, bug_id):
91
"""Return the URL for bug_id. Raise an error if bug ID is malformed."""
92
self.check_bug_id(bug_id)
93
return self._get_bug_url(bug_id)
95
def _get_bug_url(self, bug_id):
96
"""Given a validated bug_id, return the bug's web page's URL."""
99
class IntegerBugTracker(BugTracker):
100
"""A bug tracker that only allows integer bug IDs."""
102
def check_bug_id(self, bug_id):
106
raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
109
class UniqueIntegerBugTracker(IntegerBugTracker):
110
"""A style of bug tracker that exists in one place only, such as Launchpad.
112
If you have one of these trackers then register an instance passing in an
113
abbreviated name for the bug tracker and a base URL.
116
def __init__(self, abbreviated_bugtracker_name, base_url):
117
self.abbreviation = abbreviated_bugtracker_name
118
self.base_url = base_url
120
def get(self, abbreviated_bugtracker_name, branch):
121
"""Returns the tracker if the abbreviation matches. Returns None
123
if abbreviated_bugtracker_name != self.abbreviation:
127
def _get_bug_url(self, bug_id):
128
"""Return the URL for bug_id."""
129
return urlutils.join(self.base_url, bug_id)
132
tracker_registry.register(
133
'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
136
tracker_registry.register(
137
'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
140
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
141
"""A type of bug tracker that can be found on a variety of different sites,
142
and thus needs to have the base URL configured.
144
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
145
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
146
and `abbreviation` is a short name for the particular instance (e.g.
147
'squid' or 'apache').
150
def get(self, abbreviation, branch):
151
config = branch.get_config()
152
url = config.get_user_option(
153
"%s_%s_url" % (self.type_name, abbreviation))
159
def __init__(self, type_name, bug_area):
160
self.type_name = type_name
161
self._bug_area = bug_area
163
def _get_bug_url(self, bug_id):
164
"""Return a URL for a bug on this Trac instance."""
165
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
168
tracker_registry.register(
169
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
171
tracker_registry.register(
173
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
added
removed
bzrlib/bugtracker.py
