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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Tests for Requests."""
from concurrent.futures import Future, ProcessPoolExecutor
from os import environ
from sys import version_info
try:
from sys import pypy_version_info
except ImportError:
pypy_version_info = None
import logging
from unittest import TestCase, main, skipIf
import pytest
from requests import Response, session
from requests.adapters import DEFAULT_POOLSIZE
from requests_futures.sessions import FuturesSession
HTTPBIN = environ.get('HTTPBIN_URL', 'https://nghttp2.org/httpbin/')
logging.basicConfig(level=logging.DEBUG)
logging.getLogger('urllib3.connectionpool').level = logging.WARNING
logging.getLogger('FuturesSession').level = logging.ERROR
@pytest.fixture(scope="class", autouse=True)
def httpbin_on_class(request, httpbin):
request.cls.httpbin = httpbin
class RequestsTestCase(TestCase):
def test_futures_session(self):
# basic futures get
sess = FuturesSession()
future = sess.get(self.httpbin.join('get'))
self.assertIsInstance(future, Future)
resp = future.result()
self.assertIsInstance(resp, Response)
self.assertEqual(200, resp.status_code)
# non-200, 404
future = sess.get(self.httpbin.join('status/404'))
resp = future.result()
self.assertEqual(404, resp.status_code)
def cb(s, r):
self.assertIsInstance(s, FuturesSession)
self.assertIsInstance(r, Response)
# add the parsed json data to the response
r.data = r.json()
future = sess.get(self.httpbin.join('get'), background_callback=cb)
# this should block until complete
resp = future.result()
self.assertEqual(200, resp.status_code)
# make sure the callback was invoked
self.assertTrue(hasattr(resp, 'data'))
def rasing_cb(s, r):
raise Exception('boom')
future = sess.get(
self.httpbin.join('get'), background_callback=rasing_cb
)
with self.assertRaises(Exception) as cm:
resp = future.result()
self.assertEqual('boom', cm.exception.args[0])
def test_supplied_session(self):
"""Tests the `session` keyword argument."""
requests_session = session()
requests_session.headers['Foo'] = 'bar'
sess = FuturesSession(session=requests_session)
future = sess.get(self.httpbin.join('headers'))
self.assertIsInstance(future, Future)
resp = future.result()
self.assertIsInstance(resp, Response)
self.assertEqual(200, resp.status_code)
self.assertEqual(resp.json()['headers']['Foo'], 'bar')
def test_max_workers(self):
"""Tests the `max_workers` shortcut."""
from concurrent.futures import ThreadPoolExecutor
session = FuturesSession()
self.assertEqual(session.executor._max_workers, 8)
session = FuturesSession(max_workers=5)
self.assertEqual(session.executor._max_workers, 5)
session = FuturesSession(executor=ThreadPoolExecutor(max_workers=10))
self.assertEqual(session.executor._max_workers, 10)
session = FuturesSession(
executor=ThreadPoolExecutor(max_workers=10), max_workers=5
)
self.assertEqual(session.executor._max_workers, 10)
def test_adapter_kwargs(self):
"""Tests the `adapter_kwargs` shortcut."""
from concurrent.futures import ThreadPoolExecutor
session = FuturesSession()
self.assertFalse(session.get_adapter('http://')._pool_block)
session = FuturesSession(
max_workers=DEFAULT_POOLSIZE + 1,
adapter_kwargs={'pool_block': True},
)
adapter = session.get_adapter('http://')
self.assertTrue(adapter._pool_block)
self.assertEqual(adapter._pool_connections, DEFAULT_POOLSIZE + 1)
self.assertEqual(adapter._pool_maxsize, DEFAULT_POOLSIZE + 1)
session = FuturesSession(
executor=ThreadPoolExecutor(max_workers=10),
adapter_kwargs={'pool_connections': 20},
)
self.assertEqual(session.get_adapter('http://')._pool_connections, 20)
def test_redirect(self):
"""Tests for the ability to cleanly handle redirects."""
sess = FuturesSession()
future = sess.get(self.httpbin.join('redirect-to?url=get'))
self.assertIsInstance(future, Future)
resp = future.result()
self.assertIsInstance(resp, Response)
self.assertEqual(200, resp.status_code)
future = sess.get(self.httpbin.join('redirect-to?url=status/404'))
resp = future.result()
self.assertEqual(404, resp.status_code)
def test_context(self):
class FuturesSessionTestHelper(FuturesSession):
def __init__(self, *args, **kwargs):
super(FuturesSessionTestHelper, self).__init__(*args, **kwargs)
self._exit_called = False
def __exit__(self, *args, **kwargs):
self._exit_called = True
return super(FuturesSessionTestHelper, self).__exit__(
*args, **kwargs
)
passout = None
with FuturesSessionTestHelper() as sess:
passout = sess
future = sess.get(self.httpbin.join('get'))
self.assertIsInstance(future, Future)
resp = future.result()
self.assertIsInstance(resp, Response)
self.assertEqual(200, resp.status_code)
self.assertTrue(passout._exit_called)
# << test process pool executor >>
# see discussion https://github.com/ross/requests-futures/issues/11
def global_cb_modify_response(s, r):
"""add the parsed json data to the response"""
assert s, FuturesSession
assert r, Response
r.data = r.json()
r.__attrs__.append('data') # required for pickling new attribute
def global_cb_return_result(s, r):
"""simply return parsed json data"""
assert s, FuturesSession
assert r, Response
return r.json()
def global_rasing_cb(s, r):
raise Exception('boom')
# pickling instance method supported only from here
unsupported_platform = version_info < (3, 4) and not pypy_version_info
session_required = version_info < (3, 5) and not pypy_version_info
@skipIf(unsupported_platform, 'not supported in python < 3.4')
class RequestsProcessPoolTestCase(TestCase):
def setUp(self):
self.proc_executor = ProcessPoolExecutor(max_workers=2)
self.session = session()
@skipIf(session_required, 'not supported in python < 3.5')
def test_futures_session(self):
self._assert_futures_session()
@skipIf(not session_required, 'fully supported on python >= 3.5')
def test_exception_raised(self):
with self.assertRaises(RuntimeError):
self._assert_futures_session()
def test_futures_existing_session(self):
self.session.headers['Foo'] = 'bar'
self._assert_futures_session(session=self.session)
def _assert_futures_session(self, session=None):
# basic futures get
if session:
sess = FuturesSession(executor=self.proc_executor, session=session)
else:
sess = FuturesSession(executor=self.proc_executor)
future = sess.get(self.httpbin.join('get'))
self.assertIsInstance(future, Future)
resp = future.result()
self.assertIsInstance(resp, Response)
self.assertEqual(200, resp.status_code)
# non-200, 404
future = sess.get(self.httpbin.join('status/404'))
resp = future.result()
self.assertEqual(404, resp.status_code)
future = sess.get(
self.httpbin.join('get'),
background_callback=global_cb_modify_response,
)
# this should block until complete
resp = future.result()
if session:
self.assertEqual(resp.json()['headers']['Foo'], 'bar')
self.assertEqual(200, resp.status_code)
# make sure the callback was invoked
self.assertTrue(hasattr(resp, 'data'))
future = sess.get(
self.httpbin.join('get'),
background_callback=global_cb_return_result,
)
# this should block until complete
resp = future.result()
# make sure the callback was invoked
self.assertIsInstance(resp, dict)
future = sess.get(
self.httpbin.join('get'), background_callback=global_rasing_cb
)
with self.assertRaises(Exception) as cm:
resp = future.result()
self.assertEqual('boom', cm.exception.args[0])
# Tests for the ability to cleanly handle redirects
future = sess.get(self.httpbin.join('redirect-to?url=get'))
self.assertIsInstance(future, Future)
resp = future.result()
self.assertIsInstance(resp, Response)
self.assertEqual(200, resp.status_code)
future = sess.get(self.httpbin.join('redirect-to?url=status/404'))
resp = future.result()
self.assertEqual(404, resp.status_code)
@skipIf(session_required, 'not supported in python < 3.5')
def test_context(self):
self._assert_context()
def test_context_with_session(self):
self._assert_context(session=self.session)
def _assert_context(self, session=None):
if session:
helper_instance = TopLevelContextHelper(
executor=self.proc_executor, session=self.session
)
else:
helper_instance = TopLevelContextHelper(executor=self.proc_executor)
passout = None
with helper_instance as sess:
passout = sess
future = sess.get(self.httpbin.join('get'))
self.assertIsInstance(future, Future)
resp = future.result()
self.assertIsInstance(resp, Response)
self.assertEqual(200, resp.status_code)
self.assertTrue(passout._exit_called)
class TopLevelContextHelper(FuturesSession):
def __init__(self, *args, **kwargs):
super(TopLevelContextHelper, self).__init__(*args, **kwargs)
self._exit_called = False
def __exit__(self, *args, **kwargs):
self._exit_called = True
return super(TopLevelContextHelper, self).__exit__(*args, **kwargs)
@skipIf(not unsupported_platform, 'Exception raised when unsupported')
class ProcessPoolExceptionRaisedTestCase(TestCase):
def test_exception_raised(self):
executor = ProcessPoolExecutor(max_workers=2)
sess = FuturesSession(executor=executor, session=session())
with self.assertRaises(RuntimeError):
sess.get(self.httpbin.join('get'))
if __name__ == '__main__':
main()
|
