← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Kuno Meyer
  • Date: 2007-07-24 19:40:40 UTC
  • mto: This revision was merged to the branch mainline in revision 2655.
  • Revision ID: kuno.meyer@gmx.ch-20070724194040-ocyjulqhy31xe3j1
Extended tests for unicode chars outside of the iso-8859-* range
Two workarounds for incorrect glob.glob() implementation

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