1
=== modified file 'lib/lp/bugs/doc/externalbugtracker-trac.txt'
2
--- lib/lp/bugs/doc/externalbugtracker-trac.txt	2009-06-15 11:10:49 +0000
3
+++ lib/lp/bugs/doc/externalbugtracker-trac.txt	2010-01-11 14:05:35 +0000
4
@@ -48,15 +48,46 @@
5
48
    >>> chosen_trac.baseurl
48
    >>> chosen_trac.baseurl
6
49
    'http://example.com'
49
    'http://example.com'
7
50
50
10
51
In the unlikely case where the token would be valid, a 200 would be
51
Some Trac instances in the wild return HTTP 200 when the resource is
11
52
returned. This also causes a TracLPPlugin to be used.
52
not found (HTTP 404 would be more appropriate). A distinguishing
12
53
difference between a 200 response from a broken Trac and a response
13
54
from a Trac with the plugin installed (when we've accidentally passed
14
55
a valid token, which is very unlikely), is that the broken Trac will
15
56
not include a "trac_auth" cookie.
16
53
57
17
58
    >>> from httplib import HTTPMessage
18
59
    >>> from urllib import addinfourl
19
54
    >>> from StringIO import StringIO
60
    >>> from StringIO import StringIO
20
61
21
62
    >>> class TracReturning200ForPageNotFound(Trac):
22
63
    ...     def urlopen(self, url):
23
64
    ...         print url
24
65
    ...         return addinfourl(
25
66
    ...             StringIO(''), HTTPMessage(StringIO('')), url)
26
67
27
55
    >>> class TracHavingLPPlugin200(Trac):
68
    >>> class TracHavingLPPlugin200(Trac):
28
56
    ...     def urlopen(self, url):
69
    ...     def urlopen(self, url):
29
57
    ...         print url
70
    ...         print url
32
58
    ...         return StringIO('')
71
    ...         return addinfourl(
33
59
    >>> trac = TracHavingLPPlugin401('http://example.com/')
72
    ...             StringIO(''), HTTPMessage(
34
73
    ...                 StringIO('Set-Cookie: trac_auth=1234')), url)
35
74
36
75
The plain, non-plugin, external bug tracker is selected for broken
37
76
Trac installations:
38
77
39
78
    >>> trac = TracReturning200ForPageNotFound('http://example.com/')
40
79
    >>> chosen_trac = trac.getExternalBugTrackerToUse()
41
80
    http://example.com/launchpad-auth/check
42
81
43
82
    >>> isinstance(chosen_trac, TracLPPlugin)
44
83
    False
45
84
    >>> chosen_trac.baseurl
46
85
    'http://example.com'
47
86
48
87
In the event that our deliberately bogus token is considered valid,
49
88
the external bug tracker that groks the plugin is selected:
50
89
51
90
    >>> trac = TracHavingLPPlugin200('http://example.com/')
52
60
    >>> chosen_trac = trac.getExternalBugTrackerToUse()
91
    >>> chosen_trac = trac.getExternalBugTrackerToUse()
53
61
    http://example.com/launchpad-auth/check
92
    http://example.com/launchpad-auth/check
54
62
93
55
63
94
56
=== modified file 'lib/lp/bugs/externalbugtracker/trac.py'
57
--- lib/lp/bugs/externalbugtracker/trac.py	2010-01-06 14:35:52 +0000
58
+++ lib/lp/bugs/externalbugtracker/trac.py	2010-01-11 14:05:35 +0000
59
@@ -12,13 +12,13 @@
60
12
import urllib2
12
import urllib2
61
13
import xmlrpclib
13
import xmlrpclib
62
14
14
63
15
from Cookie import SimpleCookie
64
15
from cookielib import CookieJar
16
from cookielib import CookieJar
65
16
from datetime import datetime
17
from datetime import datetime
66
17
from email.Utils import parseaddr
18
from email.Utils import parseaddr
67
18
from zope.component import getUtility
19
from zope.component import getUtility
68
19
from zope.interface import implements
20
from zope.interface import implements
69
20
21
70
21
from canonical.cachedproperty import cachedproperty
71
22
from canonical.config import config
22
from canonical.config import config
72
23
from lp.bugs.externalbugtracker.base import (
23
from lp.bugs.externalbugtracker.base import (
73
24
    BugNotFound, BugTrackerAuthenticationError, ExternalBugTracker,
24
    BugNotFound, BugTrackerAuthenticationError, ExternalBugTracker,
74
@@ -48,6 +48,7 @@
75
48
# Fault code constants for the LP Plugin
48
# Fault code constants for the LP Plugin
76
49
FAULT_TICKET_NOT_FOUND = 1001
49
FAULT_TICKET_NOT_FOUND = 1001
77
50
50
78
51
79
51
class Trac(ExternalBugTracker):
52
class Trac(ExternalBugTracker):
80
52
    """An ExternalBugTracker instance for handling Trac bugtrackers."""
53
    """An ExternalBugTracker instance for handling Trac bugtrackers."""
81
53
54
82
@@ -61,11 +62,26 @@
83
61
        # Any token will do.
62
        # Any token will do.
84
62
        auth_url = urlappend(base_auth_url, 'check')
63
        auth_url = urlappend(base_auth_url, 'check')
85
63
        try:
64
        try:
87
64
            self.urlopen(auth_url)
65
            response = self.urlopen(auth_url)
88
65
        except urllib2.HTTPError, error:
66
        except urllib2.HTTPError, error:
92
66
            if error.code != 401:
67
            # If the error is HTTP 401 Unauthorized then we're
93
67
                return self
68
            # probably talking to the LP plugin.
94
68
        return TracLPPlugin(self.baseurl)
69
            if error.code == 401:
95
70
                return TracLPPlugin(self.baseurl)
96
71
            else:
97
72
                return self
98
73
        else:
99
74
            # If the response contains a trac_auth cookie then we're
100
75
            # talking to the LP plugin. However, it's unlikely that
101
76
            # the remote system will authorize the bogus auth token we
102
77
            # sent, so this check is really intended to detect broken
103
78
            # Trac instances that return HTTP 200 for a missing page.
104
79
            for set_cookie in response.headers.getheaders('Set-Cookie'):
105
80
                cookie = SimpleCookie(set_cookie)
106
81
                if 'trac_auth' in cookie:
107
82
                    return TracLPPlugin(self.baseurl)
108
83
            else:
109
84
                return self
110
69
85
111
70
    def supportsSingleExports(self, bug_ids):
86
    def supportsSingleExports(self, bug_ids):
112
71
        """Return True if the Trac instance provides CSV exports for single
87
        """Return True if the Trac instance provides CSV exports for single
113
@@ -83,11 +99,11 @@
114
83
                # We try to retrive the ticket in HTML form, since that will
99
                # We try to retrive the ticket in HTML form, since that will
115
84
                # tell us whether or not it is actually a valid ticket
100
                # tell us whether or not it is actually a valid ticket
116
85
                ticket_id = int(bug_ids.pop())
101
                ticket_id = int(bug_ids.pop())
118
86
                html_data = self.urlopen(html_ticket_url % ticket_id)
102
                self.urlopen(html_ticket_url % ticket_id)
119
87
            except (ValueError, urllib2.HTTPError):
103
            except (ValueError, urllib2.HTTPError):
120
88
                # If we get an HTTP error we can consider the ticket to be
104
                # If we get an HTTP error we can consider the ticket to be
121
89
                # invalid. If we get a ValueError then the ticket_id couldn't
105
                # invalid. If we get a ValueError then the ticket_id couldn't
123
90
                # be intified and it's of no use to us anyway.
106
                # be identified and it's of no use to us anyway.
124
91
                pass
107
                pass
125
92
            else:
108
            else:
126
93
                # If we didn't get an error we can try to get the ticket in
109
                # If we didn't get an error we can try to get the ticket in
127
@@ -345,7 +361,7 @@
128
345
        auth_url = urlappend(base_auth_url, token_text)
361
        auth_url = urlappend(base_auth_url, token_text)
129
346
362
130
347
        try:
363
        try:
132
348
            response = self.urlopen(auth_url)
364
            self.urlopen(auth_url)
133
349
        except urllib2.HTTPError, error:
365
        except urllib2.HTTPError, error:
134
350
            raise BugTrackerAuthenticationError(
366
            raise BugTrackerAuthenticationError(
135
351
                self.baseurl, '%s "%s"' % (error.code, error.msg))
367
                self.baseurl, '%s "%s"' % (error.code, error.msg))
136
@@ -481,7 +497,7 @@
137
481
            launchpad_bug_id = 0
497
            launchpad_bug_id = 0
138
482
498
139
483
        try:
499
        try:
141
484
            timestamp = self._server.launchpad.set_launchpad_bug(
500
            self._server.launchpad.set_launchpad_bug(
142
485
                remote_bug, launchpad_bug_id)
501
                remote_bug, launchpad_bug_id)
143
486
        except xmlrpclib.Fault, fault:
502
        except xmlrpclib.Fault, fault:
144
487
            # Deal with "Ticket does not exist" faults. We re-raise
503
            # Deal with "Ticket does not exist" faults. We re-raise
145
@@ -490,4 +506,3 @@
146
490
                raise BugNotFound(remote_bug)
506
                raise BugNotFound(remote_bug)
147
491
            else:
507
            else:
148
492
                raise
508
                raise
149
493
Reviewer	Review Type	Date Requested	Status
Eleanor Berger (community)		2010-01-11	Approve on 2010-01-11
Review via email: mp+17139@code.launchpad.net