forked from softlayer/softlayer-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtransports.py
More file actions
401 lines (315 loc) · 12.8 KB
/
transports.py
File metadata and controls
401 lines (315 loc) · 12.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
"""
SoftLayer.transports
~~~~~~~~~~~~~~~~~~~~
XML-RPC transport layer that uses the requests library.
:license: MIT, see LICENSE for more details.
"""
import importlib
import json
import logging
import time
import requests
from SoftLayer import consts
from SoftLayer import exceptions
from SoftLayer import utils
LOGGER = logging.getLogger(__name__)
# transports.Request does have a lot of instance attributes. :(
# pylint: disable=too-many-instance-attributes
__all__ = [
'Request',
'XmlRpcTransport',
'RestTransport',
'TimingTransport',
'FixtureTransport',
'SoftLayerListResult',
]
REST_SPECIAL_METHODS = {
'deleteObject': 'DELETE',
'createObject': 'POST',
'createObjects': 'POST',
'editObject': 'PUT',
'editObjects': 'PUT',
}
class Request(object):
"""Transport request object."""
def __init__(self):
#: API service name. E.G. SoftLayer_Account
self.service = None
#: API method name. E.G. getObject
self.method = None
#: API Parameters.
self.args = tuple()
#: API headers, used for authentication, masks, limits, offsets, etc.
self.headers = {}
#: Transport user.
self.transport_user = None
#: Transport password.
self.transport_password = None
#: Transport headers.
self.transport_headers = {}
#: Boolean specifying if the server certificate should be verified.
self.verify = None
#: Client certificate file path.
self.cert = None
#: InitParameter/identifier of an object.
self.identifier = None
#: SoftLayer mask (dict or string).
self.mask = None
#: SoftLayer Filter (dict).
self.filter = None
#: Integer result limit.
self.limit = None
#: Integer result offset.
self.offset = None
class SoftLayerListResult(list):
"""A SoftLayer API list result."""
def __init__(self, items, total_count):
#: total count of items that exist on the server. This is useful when
#: paginating through a large list of objects.
self.total_count = total_count
super(SoftLayerListResult, self).__init__(items)
class XmlRpcTransport(object):
"""XML-RPC transport."""
def __init__(self,
endpoint_url=None,
timeout=None,
proxy=None,
user_agent=None,
verify=True):
self.endpoint_url = (endpoint_url or
consts.API_PUBLIC_ENDPOINT).rstrip('/')
self.timeout = timeout or None
self.proxy = proxy
self.user_agent = user_agent or consts.USER_AGENT
self.verify = verify
def __call__(self, request):
"""Makes a SoftLayer API call against the XML-RPC endpoint.
:param request request: Request object
"""
largs = list(request.args)
headers = request.headers
if request.identifier is not None:
header_name = request.service + 'InitParameters'
headers[header_name] = {'id': request.identifier}
if request.mask is not None:
headers.update(_format_object_mask_xmlrpc(request.mask,
request.service))
if request.filter is not None:
headers['%sObjectFilter' % request.service] = request.filter
if request.limit:
headers['resultLimit'] = {
'limit': request.limit,
'offset': request.offset or 0,
}
largs.insert(0, {'headers': headers})
request.transport_headers.setdefault('Content-Type', 'application/xml')
request.transport_headers.setdefault('User-Agent', self.user_agent)
url = '/'.join([self.endpoint_url, request.service])
payload = utils.xmlrpc_client.dumps(tuple(largs),
methodname=request.method,
allow_none=True)
# Prefer the request setting, if it's not None
verify = request.verify
if verify is None:
verify = self.verify
LOGGER.debug("=== REQUEST ===")
LOGGER.info('POST %s', url)
LOGGER.debug(request.transport_headers)
LOGGER.debug(payload)
try:
resp = requests.request('POST', url,
data=payload,
headers=request.transport_headers,
timeout=self.timeout,
verify=verify,
cert=request.cert,
proxies=_proxies_dict(self.proxy))
LOGGER.debug("=== RESPONSE ===")
LOGGER.debug(resp.headers)
LOGGER.debug(resp.content)
resp.raise_for_status()
result = utils.xmlrpc_client.loads(resp.content)[0][0]
if isinstance(result, list):
return SoftLayerListResult(
result, int(resp.headers.get('softlayer-total-items', 0)))
else:
return result
except utils.xmlrpc_client.Fault as ex:
# These exceptions are formed from the XML-RPC spec
# http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php
error_mapping = {
'-32700': exceptions.NotWellFormed,
'-32701': exceptions.UnsupportedEncoding,
'-32702': exceptions.InvalidCharacter,
'-32600': exceptions.SpecViolation,
'-32601': exceptions.MethodNotFound,
'-32602': exceptions.InvalidMethodParameters,
'-32603': exceptions.InternalError,
'-32500': exceptions.ApplicationError,
'-32400': exceptions.RemoteSystemError,
'-32300': exceptions.TransportError,
}
_ex = error_mapping.get(ex.faultCode, exceptions.SoftLayerAPIError)
raise _ex(ex.faultCode, ex.faultString)
except requests.HTTPError as ex:
raise exceptions.TransportError(ex.response.status_code, str(ex))
except requests.RequestException as ex:
raise exceptions.TransportError(0, str(ex))
class RestTransport(object):
"""REST transport.
Currently only supports GET requests (no POST, PUT, DELETE) and lacks
support for masks, filters, limits and offsets.
"""
def __init__(self,
endpoint_url=None,
timeout=None,
proxy=None,
user_agent=None,
verify=True):
self.endpoint_url = (endpoint_url or
consts.API_PUBLIC_ENDPOINT_REST).rstrip('/')
self.timeout = timeout or None
self.proxy = proxy
self.user_agent = user_agent or consts.USER_AGENT
self.verify = verify
def __call__(self, request):
"""Makes a SoftLayer API call against the REST endpoint.
This currently only works with GET requests
:param request request: Request object
"""
request.transport_headers.setdefault('Content-Type',
'application/json')
request.transport_headers.setdefault('User-Agent', self.user_agent)
params = request.headers.copy()
if request.mask:
params['objectMask'] = _format_object_mask(request.mask)
if request.limit:
params['limit'] = request.limit
if request.offset:
params['offset'] = request.offset
if request.filter:
params['objectFilter'] = json.dumps(request.filter)
auth = None
if request.transport_user:
auth = requests.auth.HTTPBasicAuth(
request.transport_user,
request.transport_password,
)
method = REST_SPECIAL_METHODS.get(request.method)
is_special_method = True
if method is None:
is_special_method = False
method = 'GET'
body = {}
if request.args:
# NOTE(kmcdonald): force POST when there are arguments because
# the request body is ignored otherwise.
method = 'POST'
body['parameters'] = request.args
raw_body = None
if body:
raw_body = json.dumps(body)
url_parts = [self.endpoint_url, request.service]
if request.identifier is not None:
url_parts.append(str(request.identifier))
# Special methods (createObject, editObject, etc) use the HTTP verb
# to determine the action on the resource
if request.method is not None and not is_special_method:
url_parts.append(request.method)
url = '%s.%s' % ('/'.join(url_parts), 'json')
# Prefer the request setting, if it's not None
verify = request.verify
if verify is None:
verify = self.verify
LOGGER.debug("=== REQUEST ===")
LOGGER.info(url)
LOGGER.debug(request.transport_headers)
LOGGER.debug(raw_body)
try:
resp = requests.request(method, url,
auth=auth,
headers=request.transport_headers,
params=params,
data=raw_body,
timeout=self.timeout,
verify=verify,
cert=request.cert,
proxies=_proxies_dict(self.proxy))
LOGGER.debug("=== RESPONSE ===")
LOGGER.debug(resp.headers)
LOGGER.debug(resp.text)
resp.raise_for_status()
result = json.loads(resp.text)
if isinstance(result, list):
return SoftLayerListResult(
result, int(resp.headers.get('softlayer-total-items', 0)))
else:
return result
except requests.HTTPError as ex:
message = json.loads(ex.response.text)['error']
raise exceptions.SoftLayerAPIError(ex.response.status_code,
message)
except requests.RequestException as ex:
raise exceptions.TransportError(0, str(ex))
class TimingTransport(object):
"""Transport that records API call timings."""
def __init__(self, transport):
self.transport = transport
self.last_calls = []
def __call__(self, call):
"""See Client.call for documentation."""
start_time = time.time()
result = self.transport(call)
end_time = time.time()
self.last_calls.append((call, start_time, end_time - start_time))
return result
def get_last_calls(self):
"""Retrieves the last_calls property.
This property will contain a list of tuples in the form
(Request, initiated_utc_timestamp, execution_time)
"""
last_calls = self.last_calls
self.last_calls = []
return last_calls
class FixtureTransport(object):
"""Implements a transport which returns fixtures."""
def __call__(self, call):
"""Load fixture from the default fixture path."""
try:
module_path = 'SoftLayer.fixtures.%s' % call.service
module = importlib.import_module(module_path)
except ImportError:
raise NotImplementedError('%s fixture is not implemented'
% call.service)
try:
return getattr(module, call.method)
except AttributeError:
raise NotImplementedError('%s::%s fixture is not implemented'
% (call.service, call.method))
def _proxies_dict(proxy):
"""Makes a proxy dict appropriate to pass to requests."""
if not proxy:
return None
return {'http': proxy, 'https': proxy}
def _format_object_mask_xmlrpc(objectmask, service):
"""Format new and old style object masks into proper headers.
:param objectmask: a string- or dict-based object mask
:param service: a SoftLayer API service name
"""
if isinstance(objectmask, dict):
mheader = '%sObjectMask' % service
else:
mheader = 'SoftLayer_ObjectMask'
objectmask = _format_object_mask(objectmask)
return {mheader: {'mask': objectmask}}
def _format_object_mask(objectmask):
"""Format the new style object mask.
This wraps the user mask with mask[USER_MASK] if it does not already
have one. This makes it slightly easier for users.
:param objectmask: a string-based object mask
"""
objectmask = objectmask.strip()
if (not objectmask.startswith('mask') and
not objectmask.startswith('[')):
objectmask = "mask[%s]" % objectmask
return objectmask