← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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
39
39
"""
40
40
 
41
41
 
 
42
_bugs_help = \
 
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
 
45
entry is included in the 'bugs' revision property stating '<url> <status>'.
 
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
 
 
82
If you use Bugzilla or Trac, then you only need to set a configuration
 
83
variable which contains the base URL of the bug tracker. These options
 
84
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
 
85
configuration section in ``locations.conf``.  You can set up these values
 
86
for each of the projects you work on.
 
87
 
 
88
Note: As you provide a short name for each tracker, you can specify one or
 
89
more bugs in one or more trackers at commit time if you wish.
 
90
 
 
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
----------------------
 
98
 
 
99
If present, the location of the Bugzilla bug tracker referred to by
 
100
<tracker>. This option can then be used together with ``bzr commit
 
101
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
 
102
example::
 
103
 
 
104
    bugzilla_squid_url = http://bugs.squid-cache.org
 
105
 
 
106
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
 
107
fixed.
 
108
 
 
109
trac_<tracker>_url
 
110
------------------
 
111
 
 
112
If present, the location of the Trac instance referred to by
 
113
<tracker>. This option can then be used together with ``bzr commit
 
114
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
 
115
example::
 
116
 
 
117
    trac_twisted_url = http://www.twistedmatrix.com/trac
 
118
 
 
119
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
 
120
fixed.
 
121
 
 
122
bugtracker_<tracker>_url
 
123
------------------------
 
124
 
 
125
If present, the location of a generic bug tracker instance referred to by
 
126
<tracker>. The location must contain an ``{id}`` placeholder,
 
127
which will be replaced by a specific bug ID. This option can then be used
 
128
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
 
129
fixed by that commit. For example::
 
130
 
 
131
    bugtracker_python_url = http://bugs.python.org/issue{id}
 
132
 
 
133
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
 
134
Roundup bug tracker as fixed, or::
 
135
 
 
136
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
 
137
 
 
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.
 
145
"""
 
146
 
 
147
 
42
148
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
43
149
    """Return a URL pointing to the canonical web page of the bug identified by
44
150
    'bug_id'.
65
171
                                                   branch)
66
172
 
67
173
    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.
71
 
 
72
 
        For each bug marked as fixed, an entry is included in the 'bugs'
73
 
        revision property stating '<url> <status>'.
74
 
        """)
 
174
        return _bugs_help
75
175
 
76
176
 
77
177
tracker_registry = TrackerRegistry()
110
210
    """A style of bug tracker that exists in one place only, such as Launchpad.
111
211
 
112
212
    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.
 
213
    abbreviated name for the bug tracker and a base URL. The bug ids are
 
214
    appended directly to the URL.
114
215
    """
115
216
 
116
217
    def __init__(self, abbreviated_bugtracker_name, base_url):
126
227
 
127
228
    def _get_bug_url(self, bug_id):
128
229
        """Return the URL for bug_id."""
129
 
        return urlutils.join(self.base_url, bug_id)
 
230
        return self.base_url + bug_id
130
231
 
131
232
 
132
233
tracker_registry.register(
137
238
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
138
239
 
139
240
 
140
 
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):
141
247
    """A type of bug tracker that can be found on a variety of different sites,
142
248
    and thus needs to have the base URL configured.
143
249
 
144
250
    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').
 
251
    `type_name` is the name of the type of tracker and `abbreviation`
 
252
    is a short name for the particular instance.
148
253
    """
149
254
 
150
255
    def get(self, abbreviation, branch):
151
256
        config = branch.get_config()
152
257
        url = config.get_user_option(
153
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
258
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
154
259
        if url is None:
155
260
            return None
156
261
        self._base_url = url
165
270
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
166
271
 
167
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
 
168
286
tracker_registry.register(
169
287
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
170
288
 
171
289
tracker_registry.register(
172
290
    'bugzilla',
173
291
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
 
292
 
 
293
 
 
294
class GenericBugTracker(URLParametrizedBugTracker):
 
295
    """Generic bug tracker specified by an URL template."""
 
296
 
 
297
    def __init__(self):
 
298
        super(GenericBugTracker, self).__init__('bugtracker', None)
 
299
 
 
300
    def get(self, abbreviation, branch):
 
301
        self._abbreviation = abbreviation
 
302
        return super(GenericBugTracker, self).get(abbreviation, branch)
 
303
 
 
304
    def _get_bug_url(self, bug_id):
 
305
        """Given a validated bug_id, return the bug's web page's URL."""
 
306
        if '{id}' not in self._base_url:
 
307
            raise errors.InvalidBugTrackerURL(self._abbreviation,
 
308
                                              self._base_url)
 
309
        return self._base_url.replace('{id}', str(bug_id))
 
310
 
 
311
 
 
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)