forked from getsentry/responses
-
Notifications
You must be signed in to change notification settings - Fork 0
/
responses.py
471 lines (375 loc) · 13.5 KB
/
responses.py
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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
from __future__ import (absolute_import, print_function, division,
unicode_literals)
import inspect
import json as json_module
import re
import _io
import six
from collections import namedtuple, Sequence, Sized
from functools import update_wrapper
from cookies import Cookies
from requests.utils import cookiejar_from_dict
from requests.exceptions import ConnectionError
from requests.sessions import REDIRECT_STATI
try:
from requests.packages.urllib3.response import HTTPResponse
except ImportError:
from urllib3.response import HTTPResponse
if six.PY2:
from urlparse import urlparse, parse_qsl, urlsplit, urlunsplit
else:
from urllib.parse import urlparse, parse_qsl, urlsplit, urlunsplit
if six.PY2:
try:
from six import cStringIO as BufferIO
except ImportError:
from six import StringIO as BufferIO
else:
from io import BytesIO as BufferIO
UNSET = object()
Call = namedtuple('Call', ['request', 'response'])
_wrapper_template = """\
def wrapper%(signature)s:
with responses:
return func%(funcargs)s
"""
def _is_string(s):
return isinstance(s, six.string_types)
def _is_redirect(response):
try:
# 2.0.0 <= requests <= 2.2
return response.is_redirect
except AttributeError:
# requests > 2.2
return (
# use request.sessions conditional
response.status_code in REDIRECT_STATI and
'location' in response.headers)
def get_wrapped(func, wrapper_template, evaldict):
# Preserve the argspec for the wrapped function so that testing
# tools such as pytest can continue to use their fixture injection.
args, a, kw, defaults = inspect.getargspec(func)
signature = inspect.formatargspec(args, a, kw, defaults)
is_bound_method = hasattr(func, '__self__')
if is_bound_method:
args = args[1:] # Omit 'self'
callargs = inspect.formatargspec(args, a, kw, None)
ctx = {'signature': signature, 'funcargs': callargs}
six.exec_(wrapper_template % ctx, evaldict)
wrapper = evaldict['wrapper']
update_wrapper(wrapper, func)
if is_bound_method:
wrapper = wrapper.__get__(func.__self__, type(func.__self__))
return wrapper
class CallList(Sequence, Sized):
def __init__(self):
self._calls = []
def __iter__(self):
return iter(self._calls)
def __len__(self):
return len(self._calls)
def __getitem__(self, idx):
return self._calls[idx]
def add(self, request, response):
self._calls.append(Call(request, response))
def reset(self):
self._calls = []
def _ensure_url_default_path(url):
if _is_string(url):
url_parts = list(urlsplit(url))
if url_parts[2] == '':
url_parts[2] = '/'
url = urlunsplit(url_parts)
return url
def _handle_body(body):
if isinstance(body, six.text_type):
body = body.encode('utf-8')
if isinstance(body, _io.BufferedReader):
return body
return BufferIO(body)
class BaseResponse(object):
content_type = None
headers = None
def __init__(self, method, url, match_querystring=False):
self.method = method
self.match_querystring = match_querystring
# ensure the url has a default path set if the url is a string
self.url = _ensure_url_default_path(url)
self.call_count = 0
def _url_matches_strict(self, url, other):
url_parsed = urlparse(url)
other_parsed = urlparse(other)
if url_parsed[:3] != other_parsed[:3]:
return False
url_qsl = sorted(parse_qsl(url_parsed.query))
other_qsl = sorted(parse_qsl(other_parsed.query))
if len(url_qsl) != len(other_qsl):
return False
for (a_k, a_v), (b_k, b_v) in zip(url_qsl, other_qsl):
if not isinstance(a_k, six.text_type):
a_k = a_k.decode('utf-8')
if not isinstance(b_k, six.text_type):
b_k = b_k.decode('utf-8')
if a_k != b_k:
return False
if not isinstance(a_v, six.text_type):
a_v = a_v.decode('utf-8')
if not isinstance(b_v, six.text_type):
b_v = b_v.decode('utf-8')
if a_v != b_v:
return False
return True
def _url_matches(self, url, other, match_querystring=False):
if _is_string(url):
if match_querystring:
return self._url_matches_strict(url, other)
else:
url_without_qs = url.split('?', 1)[0]
other_without_qs = other.split('?', 1)[0]
return url_without_qs == other_without_qs
elif isinstance(url, re._pattern_type) and url.match(other):
return True
else:
return False
def get_headers(self):
headers = {}
if self.content_type is not None:
headers['Content-Type'] = self.content_type
if self.headers:
headers.update(self.headers)
return headers
def get_response(self, request):
raise NotImplementedError
def matches(self, request):
if request.method != self.method:
return False
if not self._url_matches(self.url, request.url,
self.match_querystring):
return False
return True
class Response(BaseResponse):
def __init__(self,
method,
url,
body='',
json=None,
status=200,
headers=None,
stream=False,
content_type=UNSET,
**kwargs):
# if we were passed a `json` argument,
# override the body and content_type
if json is not None:
assert not body
body = json_module.dumps(json)
if content_type is UNSET:
content_type = 'application/json'
if content_type is UNSET:
content_type = 'text/plain'
# body must be bytes
if isinstance(body, six.text_type):
body = body.encode('utf-8')
self.body = body
self.status = status
self.headers = headers
self.stream = stream
self.content_type = content_type
super(Response, self).__init__(method, url, **kwargs)
def get_response(self, request):
if self.body and isinstance(self.body, Exception):
raise self.body
headers = self.get_headers()
status = self.status
body = _handle_body(self.body)
return HTTPResponse(
status=status,
reason=six.moves.http_client.responses.get(status),
body=body,
headers=headers,
preload_content=False, )
class CallbackResponse(BaseResponse):
def __init__(self,
method,
url,
callback,
stream=False,
content_type='text/plain',
**kwargs):
self.callback = callback
self.stream = stream
self.content_type = content_type
super(CallbackResponse, self).__init__(method, url, **kwargs)
def get_response(self, request):
headers = self.get_headers()
result = self.callback(request)
if isinstance(result, Exception):
raise result
status, r_headers, body = result
body = _handle_body(body)
headers.update(r_headers)
return HTTPResponse(
status=status,
reason=six.moves.http_client.responses.get(status),
body=body,
headers=headers,
preload_content=False, )
class RequestsMock(object):
DELETE = 'DELETE'
GET = 'GET'
HEAD = 'HEAD'
OPTIONS = 'OPTIONS'
PATCH = 'PATCH'
POST = 'POST'
PUT = 'PUT'
response_callback = None
def __init__(self,
assert_all_requests_are_fired=True,
response_callback=None):
self._calls = CallList()
self.reset()
self.assert_all_requests_are_fired = assert_all_requests_are_fired
self.response_callback = response_callback
def reset(self):
self._matches = []
self._calls.reset()
def add(self,
method_or_response=None,
url=None,
body='',
adding_headers=None,
*args,
**kwargs):
"""
A basic request:
>>> responses.add(responses.GET, 'http://example.com')
You can also directly pass an object which implements the
``BaseResponse`` interface:
>>> responses.add(Response(...))
A JSON payload:
>>> responses.add(
>>> method='GET',
>>> url='http://example.com',
>>> json={'foo': 'bar'},
>>> )
Custom headers:
>>> responses.add(
>>> method='GET',
>>> url='http://example.com',
>>> headers={'X-Header': 'foo'},
>>> )
Strict query string matching:
>>> responses.add(
>>> method='GET',
>>> url='http://example.com?foo=bar',
>>> match_querystring=True
>>> )
"""
if isinstance(method_or_response, BaseResponse):
self._matches.append(method_or_response)
return
if adding_headers is not None:
kwargs.setdefault('headers', adding_headers)
if method_or_response:
kwargs['method'] = method_or_response
self._matches.append(Response(url=url, body=body, **kwargs))
def add_callback(self,
method,
url,
callback,
match_querystring=False,
content_type='text/plain'):
# ensure the url has a default path set if the url is a string
# url = _ensure_url_default_path(url, match_querystring)
self._matches.append(
CallbackResponse(
url=url,
method=method,
callback=callback,
content_type=content_type,
match_querystring=match_querystring, ))
@property
def calls(self):
return self._calls
def __enter__(self):
self.start()
return self
def __exit__(self, type, value, traceback):
success = type is None
self.stop(allow_assert=success)
self.reset()
return success
def activate(self, func):
evaldict = {'responses': self, 'func': func}
return get_wrapped(func, _wrapper_template, evaldict)
def _find_match(self, request):
found = None
found_match = None
for i, match in enumerate(self._matches):
if match.matches(request):
if found is None:
found = i
found_match = match
else:
# Multiple matches found. Remove & return the first match.
return self._matches.pop(found)
return found_match
def _on_request(self, adapter, request, **kwargs):
match = self._find_match(request)
resp_callback = self.response_callback
if match is None:
error_msg = 'Connection refused: {0} {1}'.format(
request.method, request.url)
response = ConnectionError(error_msg)
response.request = request
self._calls.add(request, response)
response = resp_callback(response) if resp_callback else response
raise response
try:
response = adapter.build_response(
request,
match.get_response(request), )
except Exception as response:
match.call_count += 1
self._calls.add(request, response)
response = resp_callback(response) if resp_callback else response
raise
if not match.stream:
response.content # NOQA
try:
resp_cookies = Cookies.from_request(response.headers['set-cookie'])
response.cookies = cookiejar_from_dict(
dict((v.name, v.value) for _, v in resp_cookies.items()))
except (KeyError, TypeError):
pass
response = resp_callback(response) if resp_callback else response
match.call_count += 1
self._calls.add(request, response)
return response
def start(self):
try:
from unittest import mock
except ImportError:
import mock
def unbound_on_send(adapter, request, *a, **kwargs):
return self._on_request(adapter, request, *a, **kwargs)
self._patcher = mock.patch('requests.adapters.HTTPAdapter.send',
unbound_on_send)
self._patcher.start()
def stop(self, allow_assert=True):
self._patcher.stop()
if not self.assert_all_requests_are_fired:
return
if not allow_assert:
return
not_called = [m for m in self._matches if m.call_count == 0]
if not_called:
raise AssertionError(
'Not all requests have been executed {0!r}'.format([(
match.method, match.url) for match in not_called]))
# expose default mock namespace
mock = _default_mock = RequestsMock(assert_all_requests_are_fired=False)
__all__ = ['CallbackResponse', 'Response', 'RequestsMock']
for __attr in (a for a in dir(_default_mock) if not a.startswith('_')):
__all__.append(__attr)
globals()[__attr] = getattr(_default_mock, __attr)