← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-11-04 18:51:39 UTC
  • mfrom: (2961.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20071104185139-kaio3sneodg2kp71
Authentication ring implementation (read-only)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
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
 
Support for Launchpad's central bug tracker is built in. For other bug
48
 
trackers, configuration is required in advance so that the correct URL
49
 
can be recorded.
50
 
 
51
 
In addition to Launchpad, Bazaar directly supports the generation of
52
 
URLs appropriate for Bugzilla and Trac. If your project uses a different
53
 
bug tracker, it is easy to add support for it.
54
 
If you use Bugzilla or Trac, then you only need to set a configuration
55
 
variable which contains the base URL of the bug tracker. These options
56
 
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
57
 
configuration section in ``locations.conf``.  You can set up these values
58
 
for each of the projects you work on.
59
 
 
60
 
Note: As you provide a short name for each tracker, you can specify one or
61
 
more bugs in one or more trackers at commit time if you wish.
62
 
 
63
 
bugzilla_<tracker_abbreviation>_url
64
 
-----------------------------------
65
 
 
66
 
If present, the location of the Bugzilla bug tracker referred to by
67
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
68
 
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
69
 
example::
70
 
 
71
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
72
 
 
73
 
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
74
 
fixed.
75
 
 
76
 
trac_<tracker_abbrevation>_url
77
 
------------------------------
78
 
 
79
 
If present, the location of the Trac instance referred to by
80
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
81
 
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
82
 
example::
83
 
 
84
 
    trac_twisted_url = http://www.twistedmatrix.com/trac
85
 
 
86
 
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
87
 
fixed.
88
 
 
89
 
bugtracker_<tracker_abbrevation>_url
90
 
------------------------------------
91
 
 
92
 
If present, the location of a generic bug tracker instance referred to by
93
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
94
 
which will be replaced by a specific bug ID. This option can then be used
95
 
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
96
 
fixed by that commit. For example::
97
 
 
98
 
    bugtracker_python_url = http://bugs.python.org/issue{id}
99
 
 
100
 
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
101
 
Roundup bug tracker as fixed, or::
102
 
 
103
 
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
104
 
 
105
 
for CPAN's RT bug tracker.
106
 
"""
107
 
 
108
 
 
109
42
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
110
43
    """Return a URL pointing to the canonical web page of the bug identified by
111
44
    'bug_id'.
132
65
                                                   branch)
133
66
 
134
67
    def help_topic(self, topic):
135
 
        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
        """)
136
75
 
137
76
 
138
77
tracker_registry = TrackerRegistry()
171
110
    """A style of bug tracker that exists in one place only, such as Launchpad.
172
111
 
173
112
    If you have one of these trackers then register an instance passing in an
174
 
    abbreviated name for the bug tracker and a base URL. The bug ids are
175
 
    appended directly to the URL.
 
113
    abbreviated name for the bug tracker and a base URL.
176
114
    """
177
115
 
178
116
    def __init__(self, abbreviated_bugtracker_name, base_url):
188
126
 
189
127
    def _get_bug_url(self, bug_id):
190
128
        """Return the URL for bug_id."""
191
 
        return self.base_url + bug_id
 
129
        return urlutils.join(self.base_url, bug_id)
192
130
 
193
131
 
194
132
tracker_registry.register(
199
137
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
200
138
 
201
139
 
202
 
tracker_registry.register('gnome',
203
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
204
 
 
205
 
 
206
140
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
207
141
    """A type of bug tracker that can be found on a variety of different sites,
208
142
    and thus needs to have the base URL configured.
237
171
tracker_registry.register(
238
172
    'bugzilla',
239
173
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
240
 
 
241
 
 
242
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
243
 
    """Generic bug tracker specified by an URL template."""
244
 
 
245
 
    def __init__(self):
246
 
        super(GenericBugTracker, self).__init__('bugtracker', None)
247
 
 
248
 
    def get(self, abbreviation, branch):
249
 
        self._abbreviation = abbreviation
250
 
        return super(GenericBugTracker, self).get(abbreviation, branch)
251
 
 
252
 
    def _get_bug_url(self, bug_id):
253
 
        """Given a validated bug_id, return the bug's web page's URL."""
254
 
        if '{id}' not in self._base_url:
255
 
            raise errors.InvalidBugTrackerURL(self._abbreviation,
256
 
                                              self._base_url)
257
 
        return self._base_url.replace('{id}', str(bug_id))
258
 
 
259
 
 
260
 
tracker_registry.register('generic', GenericBugTracker())