← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
16
 
 
17
 
import textwrap
18
 
 
19
 
from bzrlib import registry, help_topics
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
from bzrlib import registry
20
20
from bzrlib.lazy_import import lazy_import
21
21
lazy_import(globals(), """
22
22
from bzrlib import errors, urlutils
41
41
 
42
42
_bugs_help = \
43
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
 
44
recorded by using the ``--fixes`` option. For each bug marked as fixed, an
45
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
48
 
can be recorded.
49
 
 
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.
 
46
(The only ``status`` value currently supported is ``fixed.``)
 
47
 
 
48
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
 
49
rather than a full URL. This looks like::
 
50
 
 
51
    bzr commit --fixes <tracker>:<id>
 
52
 
 
53
or::
 
54
 
 
55
    bzr commit --fixes <id>
 
56
 
 
57
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
 
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.
 
61
 
 
62
Bazaar knows about a few bug trackers that have many users. If
 
63
you use one of these bug trackers then there is no setup required to
 
64
use this feature, you just need to know the tracker identifier to use.
 
65
These are the bugtrackers that are built in:
 
66
 
 
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
  ============================ ============ ============
 
74
 
 
75
For the bug trackers not listed above configuration is required.
 
76
Support for generating the URLs for any project using Bugzilla or Trac
 
77
is built in, along with a template mechanism for other bugtrackers with
 
78
simple URL schemes. If your bug tracker can't be described by one
 
79
of the schemes described below then you can write a plugin to support
 
80
it.
 
81
 
53
82
If you use Bugzilla or Trac, then you only need to set a configuration
54
83
variable which contains the base URL of the bug tracker. These options
55
84
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
59
88
Note: As you provide a short name for each tracker, you can specify one or
60
89
more bugs in one or more trackers at commit time if you wish.
61
90
 
62
 
bugzilla_<tracker_abbreviation>_url
63
 
-----------------------------------
 
91
Launchpad
 
92
---------
 
93
 
 
94
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
 
95
 
 
96
bugzilla_<tracker>_url
 
97
----------------------
64
98
 
65
99
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
 
100
<tracker>. This option can then be used together with ``bzr commit
67
101
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
68
102
example::
69
103
 
70
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
 
104
    bugzilla_squid_url = http://bugs.squid-cache.org
71
105
 
72
106
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
73
107
fixed.
74
108
 
75
 
trac_<tracker_abbrevation>_url
76
 
------------------------------
 
109
trac_<tracker>_url
 
110
------------------
77
111
 
78
112
If present, the location of the Trac instance referred to by
79
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
113
<tracker>. This option can then be used together with ``bzr commit
80
114
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
81
115
example::
82
116
 
85
119
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
86
120
fixed.
87
121
 
88
 
bugtracker_<tracker_abbrevation>_url
89
 
------------------------------------
 
122
bugtracker_<tracker>_url
 
123
------------------------
90
124
 
91
125
If present, the location of a generic bug tracker instance referred to by
92
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
126
<tracker>. The location must contain an ``{id}`` placeholder,
93
127
which will be replaced by a specific bug ID. This option can then be used
94
128
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
95
129
fixed by that commit. For example::
101
135
 
102
136
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
103
137
 
104
 
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.
105
145
"""
106
146
 
107
147
 
170
210
    """A style of bug tracker that exists in one place only, such as Launchpad.
171
211
 
172
212
    If you have one of these trackers then register an instance passing in an
173
 
    abbreviated name for the bug tracker and a base URL.
 
213
    abbreviated name for the bug tracker and a base URL. The bug ids are
 
214
    appended directly to the URL.
174
215
    """
175
216
 
176
217
    def __init__(self, abbreviated_bugtracker_name, base_url):
186
227
 
187
228
    def _get_bug_url(self, bug_id):
188
229
        """Return the URL for bug_id."""
189
 
        return urlutils.join(self.base_url, bug_id)
 
230
        return self.base_url + bug_id
190
231
 
191
232
 
192
233
tracker_registry.register(
197
238
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
198
239
 
199
240
 
200
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
241
tracker_registry.register('gnome',
 
242
    UniqueIntegerBugTracker('gnome',
 
243
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
244
 
 
245
 
 
246
class URLParametrizedBugTracker(BugTracker):
201
247
    """A type of bug tracker that can be found on a variety of different sites,
202
248
    and thus needs to have the base URL configured.
203
249
 
204
250
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
205
 
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
206
 
    and `abbreviation` is a short name for the particular instance (e.g.
207
 
    '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.
208
253
    """
209
254
 
210
255
    def get(self, abbreviation, branch):
211
256
        config = branch.get_config()
212
257
        url = config.get_user_option(
213
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
258
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
214
259
        if url is None:
215
260
            return None
216
261
        self._base_url = url
225
270
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
226
271
 
227
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
 
228
286
tracker_registry.register(
229
287
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
230
288
 
233
291
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
234
292
 
235
293
 
236
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
 
294
class GenericBugTracker(URLParametrizedBugTracker):
237
295
    """Generic bug tracker specified by an URL template."""
238
296
 
239
297
    def __init__(self):
252
310
 
253
311
 
254
312
tracker_registry.register('generic', GenericBugTracker())
 
313
 
 
314
 
 
315
FIXED = 'fixed'
 
316
 
 
317
ALLOWED_BUG_STATUSES = set([FIXED])
 
318
 
 
319
 
 
320
def encode_fixes_bug_urls(bug_urls):
 
321
    """Get the revision property value for a commit that fixes bugs.
 
322
 
 
323
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
 
324
        come from `get_bug_url`.
 
325
    :return: A string that will be set as the 'bugs' property of a revision
 
326
        as part of a commit.
 
327
    """
 
328
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)