← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Martin Pool
  • Date: 2007-07-11 01:55:33 UTC
  • mto: This revision was merged to the branch mainline in revision 2599.
  • Revision ID: mbp@sourcefrog.net-20070711015533-dzcxkjg0ujh8yuhl
Option help improvements (thanks jamesw)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import textwrap
16
18
 
17
19
from bzrlib import registry, help_topics
18
20
from bzrlib.lazy_import import lazy_import
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
 
     URL                          | Abbreviation | Example
60
 
     https://bugs.launchpad.net/  | lp           | lp:12345
61
 
     http://bugs.debian.org/      | deb          | deb:12345
62
 
     http://bugzilla.gnome.org/   | gnome        | gnome:12345
63
 
 
64
 
For the bug trackers not listed above configuration is required.
65
 
Support for generating the URLs for any project using Bugzilla or Trac
66
 
is built in, along with a template mechanism for other bugtrackers with
67
 
simple URL schemes. If your bug tracker can't be described by one
68
 
of the schemes described below then you can write a plugin to support
69
 
it.
70
 
 
71
 
If you use Bugzilla or Trac, then you only need to set a configuration
72
 
variable which contains the base URL of the bug tracker. These options
73
 
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
74
 
configuration section in ``locations.conf``.  You can set up these values
75
 
for each of the projects you work on.
76
 
 
77
 
Note: As you provide a short name for each tracker, you can specify one or
78
 
more bugs in one or more trackers at commit time if you wish.
79
 
 
80
 
Launchpad
81
 
---------
82
 
 
83
 
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
84
 
 
85
 
bugzilla_<tracker_abbreviation>_url
86
 
-----------------------------------
87
 
 
88
 
If present, the location of the Bugzilla bug tracker referred to by
89
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
90
 
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
91
 
example::
92
 
 
93
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
94
 
 
95
 
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
96
 
fixed.
97
 
 
98
 
trac_<tracker_abbrevation>_url
99
 
------------------------------
100
 
 
101
 
If present, the location of the Trac instance referred to by
102
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
103
 
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
104
 
example::
105
 
 
106
 
    trac_twisted_url = http://www.twistedmatrix.com/trac
107
 
 
108
 
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
109
 
fixed.
110
 
 
111
 
bugtracker_<tracker_abbrevation>_url
112
 
------------------------------------
113
 
 
114
 
If present, the location of a generic bug tracker instance referred to by
115
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
116
 
which will be replaced by a specific bug ID. This option can then be used
117
 
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
118
 
fixed by that commit. For example::
119
 
 
120
 
    bugtracker_python_url = http://bugs.python.org/issue{id}
121
 
 
122
 
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
123
 
Roundup bug tracker as fixed, or::
124
 
 
125
 
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
126
 
 
127
 
for CPAN's RT bug tracker.
128
 
"""
129
 
 
130
 
 
131
42
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
132
43
    """Return a URL pointing to the canonical web page of the bug identified by
133
44
    'bug_id'.
154
65
                                                   branch)
155
66
 
156
67
    def help_topic(self, topic):
157
 
        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
        """)
158
75
 
159
76
 
160
77
tracker_registry = TrackerRegistry()
193
110
    """A style of bug tracker that exists in one place only, such as Launchpad.
194
111
 
195
112
    If you have one of these trackers then register an instance passing in an
196
 
    abbreviated name for the bug tracker and a base URL. The bug ids are
197
 
    appended directly to the URL.
 
113
    abbreviated name for the bug tracker and a base URL.
198
114
    """
199
115
 
200
116
    def __init__(self, abbreviated_bugtracker_name, base_url):
210
126
 
211
127
    def _get_bug_url(self, bug_id):
212
128
        """Return the URL for bug_id."""
213
 
        return self.base_url + bug_id
 
129
        return urlutils.join(self.base_url, bug_id)
214
130
 
215
131
 
216
132
tracker_registry.register(
221
137
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
222
138
 
223
139
 
224
 
tracker_registry.register('gnome',
225
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
226
 
 
227
 
 
228
140
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
229
141
    """A type of bug tracker that can be found on a variety of different sites,
230
142
    and thus needs to have the base URL configured.
259
171
tracker_registry.register(
260
172
    'bugzilla',
261
173
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
262
 
 
263
 
 
264
 
class GenericBugTracker(URLParametrizedIntegerBugTracker):
265
 
    """Generic bug tracker specified by an URL template."""
266
 
 
267
 
    def __init__(self):
268
 
        super(GenericBugTracker, self).__init__('bugtracker', None)
269
 
 
270
 
    def get(self, abbreviation, branch):
271
 
        self._abbreviation = abbreviation
272
 
        return super(GenericBugTracker, self).get(abbreviation, branch)
273
 
 
274
 
    def _get_bug_url(self, bug_id):
275
 
        """Given a validated bug_id, return the bug's web page's URL."""
276
 
        if '{id}' not in self._base_url:
277
 
            raise errors.InvalidBugTrackerURL(self._abbreviation,
278
 
                                              self._base_url)
279
 
        return self._base_url.replace('{id}', str(bug_id))
280
 
 
281
 
 
282
 
tracker_registry.register('generic', GenericBugTracker())
283
 
 
284
 
 
285
 
FIXED = 'fixed'
286
 
 
287
 
ALLOWED_BUG_STATUSES = set([FIXED])
288
 
 
289
 
 
290
 
def encode_fixes_bug_urls(bug_urls):
291
 
    """Get the revision property value for a commit that fixes bugs.
292
 
 
293
 
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
294
 
        come from `get_bug_url`.
295
 
    :return: A string that will be set as the 'bugs' property of a revision
296
 
        as part of a commit.
297
 
    """
298
 
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)