← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Martin Pool
  • Date: 2010-07-02 07:29:40 UTC
  • mfrom: (129.1.7 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100702072940-hpzq5elg8wjve8rh
http://bugs.debian.org/452024
http://bugs.debian.org/464688
http://bugs.debian.org/523595
http://bugs.debian.org/526233
http://bugs.debian.org/537708
http://bugs.debian.org/555336
http://bugs.debian.org/555343
https://launchpad.net/bugs/249452
https://launchpad.net/bugs/385074
* PPA rebuild.
* PPA rebuild for Karmic.
* PPA rebuild for Jaunty.
* PPA rebuild for Hardy.
* From postinst, actually remove the example bash completion scripts.
  (LP: #249452)
* New upstream release.
* New upstream release.
* New upstream release.
* Revert change to Build-depends: Dapper does not have python-central.
  Should be python-support..
* Target ppa..
* Target ppa..
* Target ppa..
* Target ppa..
* New upstream release.
* Switch to dpkg-source 3.0 (quilt) format.
* Bump standards version to 3.8.4.
* Remove embedded copy of python-configobj. Closes: #555336
* Remove embedded copy of python-elementtree. Closes: #555343
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* debian/control: Fix obsolete-relation-form-in-source
  lintian warning. 
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split out docs into bzr-doc package.
* New upstream release.
* Added John Francesco Ferlito to Uploaders.
* Fix install path to quick-reference guide
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again, again.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to path changes.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Bump standards version to 3.8.3.
* Remove unused patch system.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix copy and paste tab error in .install file
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
 + Fixes compatibility with Python 2.4. Closes: #537708
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream version.
* Bump standards version to 3.8.2.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add python-pyrex to build-deps to ensure C extensions are always build.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix API compatibility version. (Closes: #526233)
* New upstream release.
  + Fixes default format for upgrade command. (Closes: #464688)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add missing dependency on zlib development library. (Closes:
  #523595)
* Add zlib build-depends.
* Add zlib build-depends.
* Add zlib build-depends.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Move to section vcs.
* Bump standards version to 3.8.1.
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Recommend ca-certificates. (Closes: #452024)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Update watch file. bazaar now uses launchpad to host its sources.
* Remove patch for inventory root revision copy, applied upstream.
* New upstream release.
* New upstream release.
* New upstream release
* Force removal of files installed in error to /etc/bash_completion.d/
  (LP: #249452)
* New upstream release.
* New upstream release
* New upstream release.
* Bump standards version.
* Include patch for inventory root revision copy, required for bzr-svn.
* New upstream release.
* Remove unused lintian overrides.
* Correct the package version not to be native.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Final 1.5 release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add myself as a co-maintainer.
* Add a Dm-Upload-Allowed: yes header.
* New upstream bugfix release.
* New upstream release.
* Final 1.3 release.
* New upstream release.
* First release candidate of the upcoming 1.3 release.
* Rebuild to fix the problem caused by a build with a broken python-central.
* New upstream release.
* Rebuild for dapper PPA.
* Apply Lamont's patches to fix build-dependencies on dapper.
  (See: https://bugs.launchpad.net/bzr/+bug/189915)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
 
1
# Copyright (C) 2007-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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, help_topics
 
18
from bzrlib.lazy_import import lazy_import
 
19
lazy_import(globals(), """
 
20
from bzrlib import errors, urlutils
 
21
""")
 
22
 
 
23
 
 
24
"""Provides a shorthand for referring to bugs on a variety of bug trackers.
 
25
 
 
26
'commit --fixes' stores references to bugs as a <bug_url> -> <bug_status>
 
27
mapping in the properties for that revision.
 
28
 
 
29
However, it's inconvenient to type out full URLs for bugs on the command line,
 
30
particularly given that many users will be using only a single bug tracker per
 
31
branch.
 
32
 
 
33
Thus, this module provides a registry of types of bug tracker (e.g. Launchpad,
 
34
Trac). Given an abbreviated name (e.g. 'lp', 'twisted') and a branch with
 
35
configuration information, these tracker types can return an instance capable
 
36
of converting bug IDs into URLs.
 
37
"""
 
38
 
 
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
 
 
134
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
 
135
    """Return a URL pointing to the canonical web page of the bug identified by
 
136
    'bug_id'.
 
137
    """
 
138
    tracker = tracker_registry.get_tracker(abbreviated_bugtracker_name, branch)
 
139
    return tracker.get_bug_url(bug_id)
 
140
 
 
141
 
 
142
class TrackerRegistry(registry.Registry):
 
143
    """Registry of bug tracker types."""
 
144
 
 
145
    def get_tracker(self, abbreviated_bugtracker_name, branch):
 
146
        """Return the first registered tracker that understands
 
147
        'abbreviated_bugtracker_name'.
 
148
 
 
149
        If no such tracker is found, raise KeyError.
 
150
        """
 
151
        for tracker_name in self.keys():
 
152
            tracker_type = self.get(tracker_name)
 
153
            tracker = tracker_type.get(abbreviated_bugtracker_name, branch)
 
154
            if tracker is not None:
 
155
                return tracker
 
156
        raise errors.UnknownBugTrackerAbbreviation(abbreviated_bugtracker_name,
 
157
                                                   branch)
 
158
 
 
159
    def help_topic(self, topic):
 
160
        return _bugs_help
 
161
 
 
162
 
 
163
tracker_registry = TrackerRegistry()
 
164
"""Registry of bug trackers."""
 
165
 
 
166
 
 
167
class BugTracker(object):
 
168
    """Base class for bug trackers."""
 
169
 
 
170
    def check_bug_id(self, bug_id):
 
171
        """Check that the bug_id is valid.
 
172
 
 
173
        The base implementation assumes that all bug_ids are valid.
 
174
        """
 
175
 
 
176
    def get_bug_url(self, bug_id):
 
177
        """Return the URL for bug_id. Raise an error if bug ID is malformed."""
 
178
        self.check_bug_id(bug_id)
 
179
        return self._get_bug_url(bug_id)
 
180
 
 
181
    def _get_bug_url(self, bug_id):
 
182
        """Given a validated bug_id, return the bug's web page's URL."""
 
183
 
 
184
 
 
185
class IntegerBugTracker(BugTracker):
 
186
    """A bug tracker that only allows integer bug IDs."""
 
187
 
 
188
    def check_bug_id(self, bug_id):
 
189
        try:
 
190
            int(bug_id)
 
191
        except ValueError:
 
192
            raise errors.MalformedBugIdentifier(bug_id, "Must be an integer")
 
193
 
 
194
 
 
195
class UniqueIntegerBugTracker(IntegerBugTracker):
 
196
    """A style of bug tracker that exists in one place only, such as Launchpad.
 
197
 
 
198
    If you have one of these trackers then register an instance passing in an
 
199
    abbreviated name for the bug tracker and a base URL. The bug ids are
 
200
    appended directly to the URL.
 
201
    """
 
202
 
 
203
    def __init__(self, abbreviated_bugtracker_name, base_url):
 
204
        self.abbreviation = abbreviated_bugtracker_name
 
205
        self.base_url = base_url
 
206
 
 
207
    def get(self, abbreviated_bugtracker_name, branch):
 
208
        """Returns the tracker if the abbreviation matches. Returns None
 
209
        otherwise."""
 
210
        if abbreviated_bugtracker_name != self.abbreviation:
 
211
            return None
 
212
        return self
 
213
 
 
214
    def _get_bug_url(self, bug_id):
 
215
        """Return the URL for bug_id."""
 
216
        return self.base_url + bug_id
 
217
 
 
218
 
 
219
tracker_registry.register(
 
220
    'launchpad', UniqueIntegerBugTracker('lp', 'https://launchpad.net/bugs/'))
 
221
 
 
222
 
 
223
tracker_registry.register(
 
224
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
 
225
 
 
226
 
 
227
tracker_registry.register('gnome',
 
228
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
229
 
 
230
 
 
231
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
 
232
    """A type of bug tracker that can be found on a variety of different sites,
 
233
    and thus needs to have the base URL configured.
 
234
 
 
235
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
 
236
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
 
237
    and `abbreviation` is a short name for the particular instance (e.g.
 
238
    'squid' or 'apache').
 
239
    """
 
240
 
 
241
    def get(self, abbreviation, branch):
 
242
        config = branch.get_config()
 
243
        url = config.get_user_option(
 
244
            "%s_%s_url" % (self.type_name, abbreviation))
 
245
        if url is None:
 
246
            return None
 
247
        self._base_url = url
 
248
        return self
 
249
 
 
250
    def __init__(self, type_name, bug_area):
 
251
        self.type_name = type_name
 
252
        self._bug_area = bug_area
 
253
 
 
254
    def _get_bug_url(self, bug_id):
 
255
        """Return a URL for a bug on this Trac instance."""
 
256
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
 
257
 
 
258
 
 
259
tracker_registry.register(
 
260
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
 
261
 
 
262
tracker_registry.register(
 
263
    'bugzilla',
 
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)