← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-11 02:07:30 UTC
  • mto: (3119.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3120.
  • Revision ID: ian.clatworthy@internode.on.net-20071211020730-sdj4kj794dw0628e
make help topics more discoverable

Show diffs side-by-side

added added

removed removed

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