← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Martin Packman
  • Date: 2011-12-23 19:38:22 UTC
  • mto: This revision was merged to the branch mainline in revision 6405.
  • Revision ID: martin.packman@canonical.com-20111223193822-hesheea4o8aqwexv
Accept and document passing the medium rather than transport for smart connections

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 bzrlib import registry
20
18
from bzrlib.lazy_import import lazy_import
21
19
lazy_import(globals(), """
22
20
from bzrlib import errors, urlutils
39
37
"""
40
38
 
41
39
 
 
40
_bugs_help = \
 
41
"""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
 
43
entry is included in the 'bugs' revision property stating '<url> <status>'.
 
44
(The only ``status`` value currently supported is ``fixed.``)
 
45
 
 
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
 
 
49
    bzr commit --fixes <tracker>:<id>
 
50
 
 
51
or::
 
52
 
 
53
    bzr commit --fixes <id>
 
54
 
 
55
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
 
56
identifier for that bug within the bugtracker, usually the bug number.
 
57
If "<tracker>" is not specified the ``bugtracker`` set in the branch
 
58
or global configuration is used.
 
59
 
 
60
Bazaar knows about a few bug trackers that have many users. If
 
61
you use one of these bug trackers then there is no setup required to
 
62
use this feature, you just need to know the tracker identifier to use.
 
63
These are the bugtrackers that are built in:
 
64
 
 
65
  ============================ ============ ============
 
66
  URL                          Abbreviation Example
 
67
  ============================ ============ ============
 
68
  https://bugs.launchpad.net/  lp           lp:12345
 
69
  http://bugs.debian.org/      deb          deb:12345
 
70
  http://bugzilla.gnome.org/   gnome        gnome:12345
 
71
  ============================ ============ ============
 
72
 
 
73
For the bug trackers not listed above configuration is required.
 
74
Support for generating the URLs for any project using Bugzilla or Trac
 
75
is built in, along with a template mechanism for other bugtrackers with
 
76
simple URL schemes. If your bug tracker can't be described by one
 
77
of the schemes described below then you can write a plugin to support
 
78
it.
 
79
 
 
80
If you use Bugzilla or Trac, then you only need to set a configuration
 
81
variable which contains the base URL of the bug tracker. These options
 
82
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
 
83
configuration section in ``locations.conf``.  You can set up these values
 
84
for each of the projects you work on.
 
85
 
 
86
Note: As you provide a short name for each tracker, you can specify one or
 
87
more bugs in one or more trackers at commit time if you wish.
 
88
 
 
89
Launchpad
 
90
---------
 
91
 
 
92
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
 
93
 
 
94
bugzilla_<tracker>_url
 
95
----------------------
 
96
 
 
97
If present, the location of the Bugzilla bug tracker referred to by
 
98
<tracker>. This option can then be used together with ``bzr commit
 
99
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
 
100
example::
 
101
 
 
102
    bugzilla_squid_url = http://bugs.squid-cache.org
 
103
 
 
104
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
 
105
fixed.
 
106
 
 
107
trac_<tracker>_url
 
108
------------------
 
109
 
 
110
If present, the location of the Trac instance referred to by
 
111
<tracker>. This option can then be used together with ``bzr commit
 
112
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
 
113
example::
 
114
 
 
115
    trac_twisted_url = http://www.twistedmatrix.com/trac
 
116
 
 
117
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
 
118
fixed.
 
119
 
 
120
bugtracker_<tracker>_url
 
121
------------------------
 
122
 
 
123
If present, the location of a generic bug tracker instance referred to by
 
124
<tracker>. The location must contain an ``{id}`` placeholder,
 
125
which will be replaced by a specific bug ID. This option can then be used
 
126
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
 
127
fixed by that commit. For example::
 
128
 
 
129
    bugtracker_python_url = http://bugs.python.org/issue{id}
 
130
 
 
131
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
 
132
Roundup bug tracker as fixed, or::
 
133
 
 
134
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
 
135
 
 
136
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
 
137
RT bug tracker as fixed, or::
 
138
 
 
139
    bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
 
140
 
 
141
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
 
142
in Hudson's JIRA bug tracker as fixed.
 
143
"""
 
144
 
 
145
 
42
146
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
43
147
    """Return a URL pointing to the canonical web page of the bug identified by
44
148
    'bug_id'.
65
169
                                                   branch)
66
170
 
67
171
    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
 
        """)
 
172
        return _bugs_help
75
173
 
76
174
 
77
175
tracker_registry = TrackerRegistry()
110
208
    """A style of bug tracker that exists in one place only, such as Launchpad.
111
209
 
112
210
    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.
 
211
    abbreviated name for the bug tracker and a base URL. The bug ids are
 
212
    appended directly to the URL.
114
213
    """
115
214
 
116
215
    def __init__(self, abbreviated_bugtracker_name, base_url):
126
225
 
127
226
    def _get_bug_url(self, bug_id):
128
227
        """Return the URL for bug_id."""
129
 
        return urlutils.join(self.base_url, bug_id)
 
228
        return self.base_url + bug_id
130
229
 
131
230
 
132
231
tracker_registry.register(
137
236
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
138
237
 
139
238
 
140
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
239
tracker_registry.register('gnome',
 
240
    UniqueIntegerBugTracker('gnome',
 
241
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
242
 
 
243
 
 
244
class URLParametrizedBugTracker(BugTracker):
141
245
    """A type of bug tracker that can be found on a variety of different sites,
142
246
    and thus needs to have the base URL configured.
143
247
 
144
248
    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').
 
249
    `type_name` is the name of the type of tracker and `abbreviation`
 
250
    is a short name for the particular instance.
148
251
    """
149
252
 
150
253
    def get(self, abbreviation, branch):
151
254
        config = branch.get_config()
152
255
        url = config.get_user_option(
153
 
            "%s_%s_url" % (self.type_name, abbreviation))
 
256
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
154
257
        if url is None:
155
258
            return None
156
259
        self._base_url = url
165
268
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
166
269
 
167
270
 
 
271
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
 
272
                                       URLParametrizedBugTracker):
 
273
    """A type of bug tracker that  only allows integer bug IDs.
 
274
 
 
275
    This can be found on a variety of different sites, and thus needs to have
 
276
    the base URL configured.
 
277
 
 
278
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
 
279
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
 
280
    and `abbreviation` is a short name for the particular instance (e.g.
 
281
    'squid' or 'apache').
 
282
    """
 
283
 
168
284
tracker_registry.register(
169
285
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
170
286
 
171
287
tracker_registry.register(
172
288
    'bugzilla',
173
289
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
 
290
 
 
291
 
 
292
class GenericBugTracker(URLParametrizedBugTracker):
 
293
    """Generic bug tracker specified by an URL template."""
 
294
 
 
295
    def __init__(self):
 
296
        super(GenericBugTracker, self).__init__('bugtracker', None)
 
297
 
 
298
    def get(self, abbreviation, branch):
 
299
        self._abbreviation = abbreviation
 
300
        return super(GenericBugTracker, self).get(abbreviation, branch)
 
301
 
 
302
    def _get_bug_url(self, bug_id):
 
303
        """Given a validated bug_id, return the bug's web page's URL."""
 
304
        if '{id}' not in self._base_url:
 
305
            raise errors.InvalidBugTrackerURL(self._abbreviation,
 
306
                                              self._base_url)
 
307
        return self._base_url.replace('{id}', str(bug_id))
 
308
 
 
309
 
 
310
tracker_registry.register('generic', GenericBugTracker())
 
311
 
 
312
 
 
313
FIXED = 'fixed'
 
314
 
 
315
ALLOWED_BUG_STATUSES = set([FIXED])
 
316
 
 
317
 
 
318
def encode_fixes_bug_urls(bug_urls):
 
319
    """Get the revision property value for a commit that fixes bugs.
 
320
 
 
321
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
 
322
        come from `get_bug_url`.
 
323
    :return: A string that will be set as the 'bugs' property of a revision
 
324
        as part of a commit.
 
325
    """
 
326
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)