/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/plugins/launchpad/lp_registration.py

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_registration.py
1
 
# Copyright (C) 2006-2017 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
from __future__ import absolute_import
18
 
 
19
 
from io import BytesIO
20
 
import os
21
 
import socket
22
 
try:
23
 
    from urllib.parse import urlsplit, urlunsplit
24
 
except ImportError:
25
 
    from urlparse import urlsplit, urlunsplit  # noqa: F401
26
 
import urllib
27
 
try:
28
 
    from xmlrpc.client import (
29
 
        __version__ as xmlrpc_version,
30
 
        Fault,
31
 
        ProtocolError,
32
 
        ServerProxy,
33
 
        Transport,
34
 
        )
35
 
except ImportError:  # python < 3
36
 
    from xmlrpclib import (
37
 
        __version__ as xmlrpc_version,
38
 
        Fault,
39
 
        ProtocolError,
40
 
        Transport,
41
 
        ServerProxy,
42
 
        )
43
 
 
44
 
from ... import (
45
 
    errors,
46
 
    urlutils,
47
 
    __version__ as _breezy_version,
48
 
    )
49
 
from ...transport import http, get_transport
50
 
 
51
 
from .uris import (
52
 
    DEFAULT_INSTANCE,
53
 
    LAUNCHPAD_DOMAINS,
54
 
    LAUNCHPAD_BAZAAR_DOMAINS,
55
 
    )
56
 
 
57
 
 
58
 
# for testing, do
59
 
'''
60
 
export BRZ_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
61
 
'''
62
 
 
63
 
 
64
 
class InvalidURL(errors.PathError):
65
 
 
66
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
67
 
 
68
 
 
69
 
class InvalidLaunchpadInstance(errors.BzrError):
70
 
 
71
 
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
72
 
 
73
 
    def __init__(self, lp_instance):
74
 
        errors.BzrError.__init__(self, lp_instance=lp_instance)
75
 
 
76
 
 
77
 
class NotLaunchpadBranch(errors.BzrError):
78
 
 
79
 
    _fmt = "%(url)s is not registered on Launchpad."
80
 
 
81
 
    def __init__(self, url):
82
 
        errors.BzrError.__init__(self, url=url)
83
 
 
84
 
 
85
 
class XMLRPCTransport(Transport):
86
 
 
87
 
    def __init__(self, scheme):
88
 
        Transport.__init__(self)
89
 
        self._scheme = scheme
90
 
        self.verbose = 0
91
 
        self._possible_bzr_transports = []
92
 
 
93
 
    def request(self, host, handler, request_body, verbose=0):
94
 
        self.verbose = verbose
95
 
        url = self._scheme + "://" + host + handler
96
 
        transport = get_transport(
97
 
            url, possible_transports=self._possible_bzr_transports)
98
 
        response = transport.request("POST", url, body=request_body, headers={
99
 
            "Content-Type": "text/xml"})
100
 
 
101
 
        if response.status != 200:
102
 
            raise ProtocolError(url, response.status,
103
 
                                response.text, response.headers)
104
 
        return self.parse_response(BytesIO(response.data))
105
 
 
106
 
 
107
 
class LaunchpadService(object):
108
 
    """A service to talk to Launchpad via XMLRPC.
109
 
 
110
 
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we
111
 
    can call.
112
 
    """
113
 
 
114
 
    # NB: these should always end in a slash to avoid xmlrpclib appending
115
 
    # '/RPC2'
116
 
    LAUNCHPAD_INSTANCE = {}
117
 
    for instance, domain in LAUNCHPAD_DOMAINS.items():
118
 
        LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
119
 
 
120
 
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
121
 
 
122
 
    transport = None
123
 
    registrant_email = None
124
 
    registrant_password = None
125
 
 
126
 
    def __init__(self, transport=None, lp_instance=None):
127
 
        """Construct a new service talking to the launchpad rpc server"""
128
 
        self._lp_instance = lp_instance
129
 
        if transport is None:
130
 
            uri_type = urlutils.parse_url(self.service_url)[0]
131
 
            transport = XMLRPCTransport(uri_type)
132
 
        self.transport = transport
133
 
 
134
 
    @property
135
 
    def service_url(self):
136
 
        """Return the http or https url for the xmlrpc server.
137
 
 
138
 
        This does not include the username/password credentials.
139
 
        """
140
 
        key = 'BRZ_LP_XMLRPC_URL'
141
 
        if key in os.environ:
142
 
            return os.environ[key]
143
 
        elif self._lp_instance is not None:
144
 
            try:
145
 
                return self.LAUNCHPAD_INSTANCE[self._lp_instance]
146
 
            except KeyError:
147
 
                raise InvalidLaunchpadInstance(self._lp_instance)
148
 
        else:
149
 
            return self.DEFAULT_SERVICE_URL
150
 
 
151
 
    @classmethod
152
 
    def for_url(cls, url, **kwargs):
153
 
        """Return the Launchpad service corresponding to the given URL."""
154
 
        result = urlsplit(url)
155
 
        lp_instance = result[1]
156
 
        if lp_instance == '':
157
 
            lp_instance = None
158
 
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
159
 
            raise InvalidURL(url)
160
 
        return cls(lp_instance=lp_instance, **kwargs)
161
 
 
162
 
    def get_proxy(self):
163
 
        """Return the proxy for XMLRPC requests."""
164
 
        url = self.service_url
165
 
        return ServerProxy(url, transport=self.transport)
166
 
 
167
 
    def send_request(self, method_name, method_params):
168
 
        proxy = self.get_proxy()
169
 
        method = getattr(proxy, method_name)
170
 
        try:
171
 
            result = method(*method_params)
172
 
        except ProtocolError as e:
173
 
            if e.errcode == 301:
174
 
                # TODO: This can give a ProtocolError representing a 301 error, whose
175
 
                # e.headers['location'] tells where to go and e.errcode==301; should
176
 
                # probably log something and retry on the new url.
177
 
                raise NotImplementedError("should resend request to %s, but this isn't implemented"
178
 
                                          % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
179
 
            else:
180
 
                # we don't want to print the original message because its
181
 
                # str representation includes the plaintext password.
182
 
                # TODO: print more headers to help in tracking down failures
183
 
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
184
 
                                      % (self.service_url, e.errcode, e.errmsg))
185
 
        except socket.gaierror as e:
186
 
            raise errors.ConnectionError(
187
 
                "Could not resolve '%s'" % self.domain,
188
 
                orig_error=e)
189
 
        return result
190
 
 
191
 
    @property
192
 
    def domain(self):
193
 
        if self._lp_instance is None:
194
 
            instance = DEFAULT_INSTANCE
195
 
        else:
196
 
            instance = self._lp_instance
197
 
        return LAUNCHPAD_DOMAINS[instance]
198
 
 
199
 
    def _guess_branch_path(self, branch_url, _request_factory=None):
200
 
        scheme, hostinfo, path = urlsplit(branch_url)[:3]
201
 
        if _request_factory is None:
202
 
            _request_factory = ResolveLaunchpadPathRequest
203
 
        if scheme == 'lp':
204
 
            resolve = _request_factory(path)
205
 
            try:
206
 
                result = resolve.submit(self)
207
 
            except Fault as fault:
208
 
                raise InvalidURL(branch_url, str(fault))
209
 
            branch_url = result['urls'][0]
210
 
            path = urlsplit(branch_url)[2]
211
 
        else:
212
 
            if hostinfo not in LAUNCHPAD_BAZAAR_DOMAINS:
213
 
                raise NotLaunchpadBranch(branch_url)
214
 
        return path.lstrip('/')
215
 
 
216
 
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
217
 
        """Get the Launchpad web URL for the given branch URL.
218
 
 
219
 
        :raise InvalidURL: if 'branch_url' cannot be identified as a
220
 
            Launchpad branch URL.
221
 
        :return: The URL of the branch on Launchpad.
222
 
        """
223
 
        path = self._guess_branch_path(branch_url, _request_factory)
224
 
        return urlutils.join('https://code.%s' % self.domain, path)
225
 
 
226
 
 
227
 
class BaseRequest(object):
228
 
    """Base request for talking to a XMLRPC server."""
229
 
 
230
 
    # Set this to the XMLRPC method name.
231
 
    _methodname = None
232
 
 
233
 
    def _request_params(self):
234
 
        """Return the arguments to pass to the method"""
235
 
        raise NotImplementedError(self._request_params)
236
 
 
237
 
    def submit(self, service):
238
 
        """Submit request to Launchpad XMLRPC server.
239
 
 
240
 
        :param service: LaunchpadService indicating where to send the request.
241
 
        """
242
 
        return service.send_request(self._methodname, self._request_params())
243
 
 
244
 
 
245
 
class DryRunLaunchpadService(LaunchpadService):
246
 
    """Service that just absorbs requests without sending to server."""
247
 
 
248
 
    def send_request(self, method_name, method_params):
249
 
        pass
250
 
 
251
 
 
252
 
class ResolveLaunchpadPathRequest(BaseRequest):
253
 
    """Request to resolve the path component of an lp: URL."""
254
 
 
255
 
    _methodname = 'resolve_lp_path'
256
 
 
257
 
    def __init__(self, path):
258
 
        if not path:
259
 
            raise InvalidURL(url=path, extra="You must specify a project.")
260
 
        self.path = path
261
 
 
262
 
    def _request_params(self):
263
 
        """Return xmlrpc request parameters"""
264
 
        return (self.path,)