← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

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
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://www.squid-cache.org/bugs
 
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
for CPAN's RT bug tracker.
 
131
"""
 
132
 
 
133
 
42
134
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
43
135
    """Return a URL pointing to the canonical web page of the bug identified by
44
136
    'bug_id'.
65
157
                                                   branch)
66
158
 
67
159
    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
 
        """)
 
160
        return _bugs_help
75
161
 
76
162
 
77
163
tracker_registry = TrackerRegistry()
110
196
    """A style of bug tracker that exists in one place only, such as Launchpad.
111
197
 
112
198
    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.
 
199
    abbreviated name for the bug tracker and a base URL. The bug ids are
 
200
    appended directly to the URL.
114
201
    """
115
202
 
116
203
    def __init__(self, abbreviated_bugtracker_name, base_url):
126
213
 
127
214
    def _get_bug_url(self, bug_id):
128
215
        """Return the URL for bug_id."""
129
 
        return urlutils.join(self.base_url, bug_id)
 
216
        return self.base_url + bug_id
130
217
 
131
218
 
132
219
tracker_registry.register(
137
224
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
138
225
 
139
226
 
 
227
tracker_registry.register('gnome',
 
228
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
229
 
 
230
 
140
231
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
141
232
    """A type of bug tracker that can be found on a variety of different sites,
142
233
    and thus needs to have the base URL configured.
171
262
tracker_registry.register(
172
263
    'bugzilla',
173
264
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
 
265
 
 
266
 
 
267
class GenericBugTracker(URLParametrizedIntegerBugTracker):
 
268
    """Generic bug tracker specified by an URL template."""
 
269
 
 
270
    def __init__(self):
 
271
        super(GenericBugTracker, self).__init__('bugtracker', None)
 
272
 
 
273
    def get(self, abbreviation, branch):
 
274
        self._abbreviation = abbreviation
 
275
        return super(GenericBugTracker, self).get(abbreviation, branch)
 
276
 
 
277
    def _get_bug_url(self, bug_id):
 
278
        """Given a validated bug_id, return the bug's web page's URL."""
 
279
        if '{id}' not in self._base_url:
 
280
            raise errors.InvalidBugTrackerURL(self._abbreviation,
 
281
                                              self._base_url)
 
282
        return self._base_url.replace('{id}', str(bug_id))
 
283
 
 
284
 
 
285
tracker_registry.register('generic', GenericBugTracker())
 
286
 
 
287
 
 
288
FIXED = 'fixed'
 
289
 
 
290
ALLOWED_BUG_STATUSES = set([FIXED])
 
291
 
 
292
 
 
293
def encode_fixes_bug_urls(bug_urls):
 
294
    """Get the revision property value for a commit that fixes bugs.
 
295
 
 
296
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
 
297
        come from `get_bug_url`.
 
298
    :return: A string that will be set as the 'bugs' property of a revision
 
299
        as part of a commit.
 
300
    """
 
301
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)