14
14
# along with this program; if not, write to the Free Software
15
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
17
from bzrlib import registry
18
from bzrlib.lazy_import import lazy_import
24
19
lazy_import(globals(), """
25
from breezy import urlutils
20
from bzrlib import errors, urlutils
54
49
bzr commit --fixes <tracker>:<id>
58
bzr commit --fixes <id>
60
51
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
61
52
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
54
Bazaar knows about a few bug trackers that have many users. If
66
55
you use one of these bug trackers then there is no setup required to
85
74
If you use Bugzilla or Trac, then you only need to set a configuration
86
75
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
76
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
88
77
configuration section in ``locations.conf``. You can set up these values
89
78
for each of the projects you work on.
139
128
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.
130
for CPAN's RT bug tracker.
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
134
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
198
135
"""Return a URL pointing to the canonical web page of the bug identified by
216
153
tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
217
154
if tracker is not None:
219
raise UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
156
raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
222
159
def help_topic(self, topic):
223
160
return _bugs_help
268
205
self.base_url = base_url
270
207
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))
208
"""Returns the tracker if the abbreviation matches. Returns None
210
if abbreviated_bugtracker_name != self.abbreviation:
214
def _get_bug_url(self, bug_id):
215
"""Return the URL for bug_id."""
216
return self.base_url + bug_id
322
219
tracker_registry.register(
330
227
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):
228
UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
231
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
341
232
"""A type of bug tracker that can be found on a variety of different sites,
342
233
and thus needs to have the base URL configured.
344
235
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.
236
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
237
and `abbreviation` is a short name for the particular instance (e.g.
238
'squid' or 'apache').
349
241
def get(self, abbreviation, branch):
350
242
config = branch.get_config()
351
243
url = config.get_user_option(
352
"%s_%s_url" % (self.type_name, abbreviation), expand=False)
244
"%s_%s_url" % (self.type_name, abbreviation))
355
247
self._base_url = url
364
256
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
259
tracker_registry.register(
381
260
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
398
277
def _get_bug_url(self, bug_id):
399
278
"""Given a validated bug_id, return the bug's web page's URL."""
400
279
if '{id}' not in self._base_url:
401
raise InvalidBugTrackerURL(self._abbreviation, self._base_url)
280
raise errors.InvalidBugTrackerURL(self._abbreviation,
402
282
return self._base_url.replace('{id}', str(bug_id))