1
=== modified file 'lib/lp/bugs/doc/externalbugtracker-bugzilla.txt'
2
--- lib/lp/bugs/doc/externalbugtracker-bugzilla.txt	2009-06-15 11:10:49 +0000
3
+++ lib/lp/bugs/doc/externalbugtracker-bugzilla.txt	2009-09-23 12:24:10 +0000
4
@@ -67,14 +67,18 @@
5
67
67
6
68
== Launchpad plugin ==
68
== Launchpad plugin ==
7
69
69
10
70
Some Bugzillas have a Launchpad plugin installed. For these bugtrackers,
70
Some Bugzillas offer the Bugzilla 3.4 XML-RPC API or have a Launchpad
11
71
we use the BugzillaLPPlugin ExternalBugTracker class. The Bugzilla
71
plugin installed. For these bugtrackers, we use the BugzillaAPI
12
72
ExternalBugTracker or its subclass, BugzillaLPPlugin, depending upon
13
73
which type of Bugzilla we're dealing with. The Bugzilla
14
72
ExternalBugTracker class has a getExternalBugTrackerToUse() method which
74
ExternalBugTracker class has a getExternalBugTrackerToUse() method which
17
73
will return a BugzillaLPPlugin instance if the remote Bugzilla has the
75
will return a BugzillaAPI instance if the remote Bugzilla offers the 3.4
18
74
plugin installed or a standard Bugzilla ExternalBugTracker if not.
76
API or a  BugzillaLPPlugin instance if the remote Bugzilla has the
19
77
plugin installed. If neither of these is offered, a standard Bugzilla
20
78
ExternalBugTracker will be returned.
21
75
79
24
76
The Bugzilla ExternalBugTracker has an xmlrpc_proxy property which we
80
The Bugzilla ExternalBugTracker has a _test_xmlrpc_proxy property which
25
77
override for the purpose of this test.
81
we override for the purpose of this test.
26
78
82
27
79
    >>> import xmlrpclib
83
    >>> import xmlrpclib
28
80
    >>> class FailingXMLRPCTransport(xmlrpclib.Transport):
84
    >>> class FailingXMLRPCTransport(xmlrpclib.Transport):
29
@@ -103,14 +107,14 @@
30
103
Bugzilla instance.
107
Bugzilla instance.
31
104
108
32
105
    >>> from lp.bugs.externalbugtracker import (
109
    >>> from lp.bugs.externalbugtracker import (
34
106
    ...     BugzillaLPPlugin)
110
    ...     BugzillaAPI, BugzillaLPPlugin)
35
107
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
111
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
36
108
112
37
109
The returned bugtracker will be a Bugzilla instance bug not a
113
The returned bugtracker will be a Bugzilla instance bug not a
39
110
BugzillaLPPlugin instance.
114
BugzillaAPI instance.
40
111
115
41
112
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
116
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
43
113
    ...  not isinstance(bugzilla_to_use, BugzillaLPPlugin))
117
    ...  not isinstance(bugzilla_to_use, BugzillaAPI))
44
114
    True
118
    True
45
115
119
46
116
The same is true if getExternalBugTrackerToUse() receives a 404 error
120
The same is true if getExternalBugTrackerToUse() receives a 404 error
47
@@ -122,7 +126,7 @@
48
122
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
126
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
49
123
127
50
124
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
128
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
52
125
    ...  not isinstance(bugzilla_to_use, BugzillaLPPlugin))
129
    ...  not isinstance(bugzilla_to_use, BugzillaAPI))
53
126
    True
130
    True
54
127
131
55
128
Some Bugzillas respond to an invalid XML-RPC method call by returning a
132
Some Bugzillas respond to an invalid XML-RPC method call by returning a
56
@@ -134,7 +138,7 @@
57
134
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
138
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
58
135
139
59
136
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
140
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
61
137
    ...  not isinstance(bugzilla_to_use, BugzillaLPPlugin))
141
    ...  not isinstance(bugzilla_to_use, BugzillaAPI))
62
138
    True
142
    True
63
139
143
64
140
Some other Bugzillas generate an unparsable response, causing
144
Some other Bugzillas generate an unparsable response, causing
65
@@ -144,9 +148,59 @@
66
144
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
148
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
67
145
149
68
146
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
150
    >>> (isinstance(bugzilla_to_use, Bugzilla) and
69
151
    ...  not isinstance(bugzilla_to_use, BugzillaAPI))
70
152
    True
71
153
72
154
If the remote Bugzilla offers the Bugzilla 3.4 API, an instance of
73
155
BuzillaAPI will be returned. To test this, we use a specially-crafted
74
156
XML-RPC proxy that behaves like a Bugzilla 3.4 instance.
75
157
76
158
    >>> class APIXMLRPCTransport(xmlrpclib.Transport):
77
159
    ...
78
160
    ...     version = '3.4.2'
79
161
    ...
80
162
    ...     def request(self, host, handler, request, verbose=None):
81
163
    ...         args, method_name = xmlrpclib.loads(request)
82
164
    ...
83
165
    ...         if method_name == 'Bugzilla.version':
84
166
    ...             return [{'version': self.version}]
85
167
    ...         else:
86
168
    ...             raise xmlrpclib.Fault('Client', 'No such method')
87
169
    ...
88
170
    >>> test_transport = APIXMLRPCTransport()
89
171
90
172
    >>> bugzilla._test_xmlrpc_proxy = xmlrpclib.ServerProxy(
91
173
    ...     'http://example.com/xmlrpc.cgi',
92
174
    ...     transport=test_transport)
93
175
94
176
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
95
177
    >>> (isinstance(bugzilla_to_use, BugzillaAPI) and
96
147
    ...  not isinstance(bugzilla_to_use, BugzillaLPPlugin))
178
    ...  not isinstance(bugzilla_to_use, BugzillaLPPlugin))
97
148
    True
179
    True
98
149
180
99
181
If the remote system has the Launchpad plugin installed, an
100
182
getExternalBugTrackerToUse() will return a BugzillaLPPlugin instance.
101
183
102
184
    >>> class PluginXMLRPCTransport(xmlrpclib.Transport):
103
185
    ...
104
186
    ...     def request(self, host, handler, request, verbose=None):
105
187
    ...         args, method_name = xmlrpclib.loads(request)
106
188
    ...
107
189
    ...         if method_name == 'Launchpad.plugin_version':
108
190
    ...             return [{'version': '0.2'}]
109
191
    ...         else:
110
192
    ...             raise xmlrpclib.Fault('Client', 'No such method')
111
193
    ...
112
194
    >>> test_transport = PluginXMLRPCTransport()
113
195
114
196
    >>> bugzilla._test_xmlrpc_proxy = xmlrpclib.ServerProxy(
115
197
    ...     'http://example.com/xmlrpc.cgi',
116
198
    ...     transport=test_transport)
117
199
118
200
    >>> bugzilla_to_use = bugzilla.getExternalBugTrackerToUse()
119
201
    >>> isinstance(bugzilla_to_use, BugzillaLPPlugin)
120
202
    True
121
203
122
150
204
123
151
== Status Conversion ==
205
== Status Conversion ==
124
152
206
125
153
207
126
=== modified file 'lib/lp/bugs/externalbugtracker/bugzilla.py'
127
--- lib/lp/bugs/externalbugtracker/bugzilla.py	2009-09-02 08:32:27 +0000
128
+++ lib/lp/bugs/externalbugtracker/bugzilla.py	2009-09-23 12:24:10 +0000
129
@@ -54,23 +54,61 @@
130
54
        self.remote_bug_status = {}
54
        self.remote_bug_status = {}
131
55
        self.remote_bug_product = {}
55
        self.remote_bug_product = {}
132
56
56
137
57
    def getExternalBugTrackerToUse(self):
57
    def _remoteSystemHasBugzillaAPI(self):
138
58
        """Return the correct `Bugzilla` subclass for the current bugtracker.
58
        """Return True if the remote host offers the Bugzilla API.
139
59
59
140
60
        See `IExternalBugTracker`.
60
        :return: True if the remote host offers an XML-RPC API and its
141
61
            version is > 3.4. Return False otherwise.
142
62
        """
143
63
        api = BugzillaAPI(self.baseurl)
144
64
        if self._test_xmlrpc_proxy is not None:
145
65
            proxy = self._test_xmlrpc_proxy
146
66
        else:
147
67
            proxy = api.xmlrpc_proxy
148
68
149
69
        try:
150
70
            # We try calling Bugzilla.version() on the remote
151
71
            # server because it's the most lightweight method there is.
152
72
            remote_version_dict = proxy.Bugzilla.version()
153
73
        except xmlrpclib.Fault, fault:
154
74
            if fault.faultCode == 'Client':
155
75
                return False
156
76
            else:
157
77
                raise
158
78
        except xmlrpclib.ProtocolError, error:
159
79
            # We catch 404s, which occur when xmlrpc.cgi doesn't exist
160
80
            # on the remote server, and 500s, which sometimes occur when
161
81
            # an invalid request is made to the remote server. We allow
162
82
            # any other error types to propagate upward.
163
83
            if error.errcode in (404, 500):
164
84
                return False
165
85
            else:
166
86
                raise
167
87
        except xmlrpclib.ResponseError:
168
88
            # The server returned an unparsable response.
169
89
            return False
170
90
        else:
171
91
            if remote_version_dict['version'] >= '3.4':
172
92
                return True
173
93
            else:
174
94
                return False
175
95
176
96
    def _remoteSystemHasPluginAPI(self):
177
97
        """Return True if the remote host has the Launchpad plugin installed.
178
61
        """
98
        """
179
62
        plugin = BugzillaLPPlugin(self.baseurl)
99
        plugin = BugzillaLPPlugin(self.baseurl)
180
100
        if self._test_xmlrpc_proxy is not None:
181
101
            proxy = self._test_xmlrpc_proxy
182
102
        else:
183
103
            proxy = plugin.xmlrpc_proxy
184
104
185
63
        try:
105
        try:
186
64
            # We try calling Launchpad.plugin_version() on the remote
106
            # We try calling Launchpad.plugin_version() on the remote
187
65
            # server because it's the most lightweight method there is.
107
            # server because it's the most lightweight method there is.
188
66
            if self._test_xmlrpc_proxy is not None:
189
67
                proxy = self._test_xmlrpc_proxy
190
68
            else:
191
69
                proxy = plugin.xmlrpc_proxy
192
70
            proxy.Launchpad.plugin_version()
108
            proxy.Launchpad.plugin_version()
193
71
        except xmlrpclib.Fault, fault:
109
        except xmlrpclib.Fault, fault:
194
72
            if fault.faultCode == 'Client':
110
            if fault.faultCode == 'Client':
196
73
                return self
111
                return False
197
74
            else:
112
            else:
198
75
                raise
113
                raise
199
76
        except xmlrpclib.ProtocolError, error:
114
        except xmlrpclib.ProtocolError, error:
200
@@ -80,14 +118,26 @@
201
80
            # can consider to be a problem, so we let it travel up the
118
            # can consider to be a problem, so we let it travel up the
202
81
            # stack for the error log.
119
            # stack for the error log.
203
82
            if error.errcode in (404, 500):
120
            if error.errcode in (404, 500):
205
83
                return self
121
                return False
206
84
            else:
122
            else:
207
85
                raise
123
                raise
208
86
        except xmlrpclib.ResponseError:
124
        except xmlrpclib.ResponseError:
209
87
            # The server returned an unparsable response.
125
            # The server returned an unparsable response.
210
126
            return False
211
127
        else:
212
128
            return True
213
129
214
130
    def getExternalBugTrackerToUse(self):
215
131
        """Return the correct `Bugzilla` subclass for the current bugtracker.
216
132
217
133
        See `IExternalBugTracker`.
218
134
        """
219
135
        if self._remoteSystemHasPluginAPI():
220
136
            return BugzillaLPPlugin(self.baseurl)
221
137
        elif self._remoteSystemHasBugzillaAPI():
222
138
            return BugzillaAPI(self.baseurl)
223
139
        else:
224
88
            return self
140
            return self
225
89
        else:
226
90
            return plugin
227
91
141
228
92
    def _parseDOMString(self, contents):
142
    def _parseDOMString(self, contents):
229
93
        """Return a minidom instance representing the XML contents supplied"""
143
        """Return a minidom instance representing the XML contents supplied"""
Status:	Merged
Approved by:	Brad Crittenden on 2009-09-23
Approved revision:	no longer in the source branch.
Merged at revision:	not available
Proposed branch:	lp:~gmb/launchpad/enable-bz-3.4-bug-415779
Merge into:	lp:launchpad/db-devel
Diff against target:	None lines
To merge this branch:	bzr merge lp:~gmb/launchpad/enable-bz-3.4-bug-415779
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Brad Crittenden (community)	release-critical code	2009-09-23	Approve on 2009-09-23
Canonical Launchpad Engineering	code	2009-09-23	Pending
Review via email: mp+12276@code.launchpad.net