← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Vincent Ladeuil
  • Date: 2017-01-30 14:30:10 UTC
  • mfrom: (6615.3.7 merges)
  • mto: This revision was merged to the branch mainline in revision 6621.
  • Revision ID: v.ladeuil+lp@free.fr-20170130143010-p31t1ranfeqbaeki
Merge  2.7 into trunk including fix for bug #1657238

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
16
16
 
17
 
from bzrlib import registry, help_topics
 
17
from __future__ import absolute_import
 
18
 
 
19
from bzrlib import registry
18
20
from bzrlib.lazy_import import lazy_import
19
21
lazy_import(globals(), """
20
22
from bzrlib import errors, urlutils
39
41
 
40
42
_bugs_help = \
41
43
"""When making a commit, metadata about bugs fixed by that change can be
42
 
recorded by using the --fixes option. For each bug marked as fixed, an
 
44
recorded by using the ``--fixes`` option. For each bug marked as fixed, an
43
45
entry is included in the 'bugs' revision property stating '<url> <status>'.
44
46
(The only ``status`` value currently supported is ``fixed.``)
45
47
 
46
 
The --fixes option allows you to specify a bug tracker and a bug identifier
47
 
rather than a full URL. This looks like
 
48
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
 
49
rather than a full URL. This looks like::
48
50
 
49
51
    bzr commit --fixes <tracker>:<id>
50
52
 
 
53
or::
 
54
 
 
55
    bzr commit --fixes <id>
 
56
 
51
57
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
52
58
identifier for that bug within the bugtracker, usually the bug number.
 
59
If "<tracker>" is not specified the ``bugtracker`` set in the branch
 
60
or global configuration is used.
53
61
 
54
62
Bazaar knows about a few bug trackers that have many users. If
55
63
you use one of these bug trackers then there is no setup required to
56
64
use this feature, you just need to know the tracker identifier to use.
57
65
These are the bugtrackers that are built in:
58
66
 
59
 
     URL                          | Abbreviation | Example
60
 
     https://bugs.launchpad.net/  | lp           | lp:12345
61
 
     http://bugs.debian.org/      | deb          | deb:12345
62
 
     http://bugzilla.gnome.org/   | gnome        | gnome:12345
 
67
  ============================ ============ ============
 
68
  URL                          Abbreviation Example
 
69
  ============================ ============ ============
 
70
  https://bugs.launchpad.net/  lp           lp:12345
 
71
  http://bugs.debian.org/      deb          deb:12345
 
72
  http://bugzilla.gnome.org/   gnome        gnome:12345
 
73
  ============================ ============ ============
63
74
 
64
75
For the bug trackers not listed above configuration is required.
65
76
Support for generating the URLs for any project using Bugzilla or Trac
82
93
 
83
94
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
84
95
 
85
 
bugzilla_<tracker_abbreviation>_url
86
 
-----------------------------------
 
96
bugzilla_<tracker>_url
 
97
----------------------
87
98
 
88
99
If present, the location of the Bugzilla bug tracker referred to by
89
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
100
<tracker>. This option can then be used together with ``bzr commit
90
101
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
91
102
example::
92
103
 
93
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
 
104
    bugzilla_squid_url = http://bugs.squid-cache.org
94
105
 
95
106
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
96
107
fixed.
97
108
 
98
 
trac_<tracker_abbrevation>_url
99
 
------------------------------
 
109
trac_<tracker>_url
 
110
------------------
100
111
 
101
112
If present, the location of the Trac instance referred to by
102
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
113
<tracker>. This option can then be used together with ``bzr commit
103
114
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
104
115
example::
105
116
 
108
119
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
109
120
fixed.
110
121
 
111
 
bugtracker_<tracker_abbrevation>_url
112
 
------------------------------------
 
122
bugtracker_<tracker>_url
 
123
------------------------
113
124
 
114
125
If present, the location of a generic bug tracker instance referred to by
115
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
126
<tracker>. The location must contain an ``{id}`` placeholder,
116
127
which will be replaced by a specific bug ID. This option can then be used
117
128
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
118
129
fixed by that commit. For example::
124
135
 
125
136
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
126
137
 
127
 
for CPAN's RT bug tracker.
 
138
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
 
139
RT bug tracker as fixed, or::
 
140
 
 
141
    bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
 
142
 
 
143
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
 
144
in Hudson's JIRA bug tracker as fixed.
128
145
"""
129
146
 
130
147
 
222
239
 
223
240
 
224
241
tracker_registry.register('gnome',
225
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
226
 
 
227
 
 
228
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
242
    UniqueIntegerBugTracker('gnome',
 
243
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
244
 
 
245
 
 
246
class URLParametrizedBugTracker(BugTracker):
229
247
    """A type of bug tracker that can be found on a variety of different sites,
230
248
    and thus needs to have the base URL configured.
231
249
 
232
250
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
233
 
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
234
 
    and `abbreviation` is a short name for the particular instance (e.g.
235
 
    'squid' or 'apache').
 
251
    `type_name` is the name of the type of tracker and `abbreviation`
 
252
    is a short name for the particular instance.
236
253
    """
237
254
 
238
255
    def get(self, abbreviation, branch):
239
256
        config = branch.get_config()
240
257
        url = config.get_user_option(
241
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
258
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
242
259
        if url is None:
243
260
            return None
244
261
        self._base_url = url
253
270
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
254
271
 
255
272
 
 
273
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
 
274
                                       URLParametrizedBugTracker):
 
275
    """A type of bug tracker that  only allows integer bug IDs.
 
276
 
 
277
    This can be found on a variety of different sites, and thus needs to have
 
278
    the base URL configured.
 
279
 
 
280
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
 
281
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
 
282
    and `abbreviation` is a short name for the particular instance (e.g.
 
283
    'squid' or 'apache').
 
284
    """
 
285
 
256
286
tracker_registry.register(
257
287
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
258
288
 
261
291
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
262
292
 
263
293
 
264
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
 
294
class GenericBugTracker(URLParametrizedBugTracker):
265
295
    """Generic bug tracker specified by an URL template."""
266
296
 
267
297
    def __init__(self):