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
|
from __future__ import unicode_literals
import socket
import unittest
import warnings
import responses
import six
from mock import Mock, patch, sentinel
from six import StringIO
from six.moves.BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
from six.moves.urllib.error import HTTPError, URLError
from six.moves.urllib.request import BaseHandler, OpenerDirector, install_opener
from six.moves.urllib.response import addinfourl
from openid import fetchers
try:
import requests
except ImportError:
requests = None
else:
from requests.exceptions import ConnectionError, InvalidSchema
class TestHTTPLib2Fetcher(object):
"""Mock of HTTPLib2Fetcher for test of fetcher selection."""
class TestCreateHTTPFetcher(unittest.TestCase):
"""Test default selection of `createHTTPFetcher` function."""
fetcher_selection = {
# (requests, pycurl, httplib2) -> fetcher
(sentinel.requests, sentinel.pycurl, sentinel.httplib2): fetchers.RequestsFetcher,
(sentinel.requests, sentinel.pycurl, None): fetchers.RequestsFetcher,
(sentinel.requests, None, sentinel.httplib2): fetchers.RequestsFetcher,
(sentinel.requests, None, None): fetchers.RequestsFetcher,
(None, sentinel.pycurl, sentinel.httplib2): fetchers.CurlHTTPFetcher,
(None, sentinel.pycurl, None): fetchers.CurlHTTPFetcher,
(None, None, sentinel.httplib2): TestHTTPLib2Fetcher,
(None, None, None): fetchers.Urllib2Fetcher,
}
def test_requests(self):
for (requests, pycurl, httplib2), fetcher_cls in self.fetcher_selection.items():
with patch.multiple(fetchers, requests=requests, pycurl=pycurl, httplib2=httplib2,
# HTTPLib2Fetcher actually calls httplib2 on init.
# Patch it as it's not necessary for selection test.
HTTPLib2Fetcher=TestHTTPLib2Fetcher):
self.assertIsInstance(fetchers.createHTTPFetcher(), fetcher_cls)
# XXX: make these separate test cases
def assertResponse(expected, actual):
assert expected.final_url == actual.final_url, (
"%r != %r" % (expected.final_url, actual.final_url))
assert expected.status == actual.status
assert expected.body == actual.body, "%r != %r" % (expected.body, actual.body)
got_headers = dict(actual.headers)
# TODO: Delete these pops
got_headers.pop('date', None)
got_headers.pop('server', None)
for k, v in expected.headers.items():
assert got_headers[k] == v, (k, v, got_headers[k])
def test_fetcher(fetcher, exc, server):
def geturl(path):
return 'http://%s:%s%s' % (socket.getfqdn(server.server_name),
server.socket.getsockname()[1],
path)
expected_headers = {'content-type': 'text/plain'}
def plain(path, code):
path = '/' + path
expected = fetchers.HTTPResponse(
geturl(path), code, expected_headers, path.encode('utf-8'))
return (path, expected)
expect_success = fetchers.HTTPResponse(
geturl('/success'), 200, expected_headers, b'/success')
cases = [
('/success', expect_success),
('/301redirect', expect_success),
('/302redirect', expect_success),
('/303redirect', expect_success),
('/307redirect', expect_success),
plain('notfound', 404),
plain('badreq', 400),
plain('forbidden', 403),
plain('error', 500),
plain('server_error', 503),
]
for path, expected in cases:
fetch_url = geturl(path)
try:
actual = fetcher.fetch(fetch_url)
except Exception:
print(fetcher, fetch_url)
raise
else:
assertResponse(expected, actual)
for err_url in [geturl('/closed'),
'http://invalid.janrain.com/',
'not:a/url',
'ftp://janrain.com/pub/']:
try:
result = fetcher.fetch(err_url)
except fetchers.HTTPError:
# This is raised by the Curl fetcher for bad cases
# detected by the fetchers module, but it's a subclass of
# HTTPFetchingError, so we have to catch it explicitly.
assert exc
except fetchers.HTTPFetchingError:
assert not exc, (fetcher, exc, server)
except Exception:
assert exc
else:
assert False, 'An exception was expected for %r (%r)' % (fetcher, result)
def run_fetcher_tests(server):
exc_fetchers = []
for klass, library_name in [
(fetchers.CurlHTTPFetcher, 'pycurl'),
(fetchers.HTTPLib2Fetcher, 'httplib2'),
]:
try:
exc_fetchers.append(klass())
except RuntimeError as why:
if six.text_type(why).startswith('Cannot find %s library' % (library_name,)):
try:
__import__(library_name)
except ImportError:
warnings.warn(
'Skipping tests for %r fetcher because '
'the library did not import.' % (library_name,))
pass
else:
assert False, ('%s present but not detected' % (library_name,))
else:
raise
non_exc_fetchers = []
for f in exc_fetchers:
non_exc_fetchers.append(fetchers.ExceptionWrappingFetcher(f))
for f in exc_fetchers:
test_fetcher(f, True, server)
for f in non_exc_fetchers:
test_fetcher(f, False, server)
class FetcherTestHandler(BaseHTTPRequestHandler):
cases = {
'/success': (200, None),
'/301redirect': (301, '/success'),
'/302redirect': (302, '/success'),
'/303redirect': (303, '/success'),
'/307redirect': (307, '/success'),
'/notfound': (404, None),
'/badreq': (400, None),
'/forbidden': (403, None),
'/error': (500, None),
'/server_error': (503, None),
}
def log_request(self, *args):
pass
def do_GET(self):
try:
http_code, location = self.cases[self.path]
except KeyError:
self.errorResponse('Bad path')
else:
extra_headers = [('Content-type', 'text/plain')]
if location is not None:
host, port = self.server.server_address
base = ('http://%s:%s' % (socket.getfqdn(host), port,))
location = base + location
extra_headers.append(('Location', location))
self._respond(http_code, extra_headers, self.path)
def do_POST(self):
try:
http_code, extra_headers = self.cases[self.path]
except KeyError:
self.errorResponse('Bad path')
else:
if http_code in [301, 302, 303, 307]:
self.errorResponse()
else:
content_type = self.headers.get('content-type', 'text/plain')
extra_headers.append(('Content-type', content_type))
content_length = int(self.headers.get('Content-length', '-1'))
body = self.rfile.read(content_length)
self._respond(http_code, extra_headers, body)
def errorResponse(self, message=None):
req = [
('HTTP method', self.command),
('path', self.path),
]
if message:
req.append(('message', message))
body_parts = ['Bad request:\r\n']
for k, v in req:
body_parts.append(' %s: %s\r\n' % (k, v))
body = ''.join(body_parts)
self._respond(400, [('Content-type', 'text/plain')], body)
def _respond(self, http_code, extra_headers, body):
self.send_response(http_code)
for k, v in extra_headers:
self.send_header(k, v)
self.end_headers()
self.wfile.write(body.encode('utf-8'))
def finish(self):
if not self.wfile.closed:
self.wfile.flush()
self.wfile.close()
self.rfile.close()
def parse_request(self):
"""Contain a hook to simulate closed connection."""
# Parse the request first
# BaseHTTPRequestHandler is old style class in 2.7
if type(FetcherTestHandler) == type:
result = super(FetcherTestHandler, self).parse_request()
else:
result = BaseHTTPRequestHandler.parse_request(self)
# If the connection should be closed, do so.
if self.path == '/closed':
self.wfile.close()
return False
else:
# Otherwise continue as usual.
return result
class TestFetchers(unittest.TestCase):
def test(self):
server = HTTPServer(("", 0), FetcherTestHandler)
import threading
server_thread = threading.Thread(target=server.serve_forever)
server_thread.setDaemon(True)
server_thread.start()
run_fetcher_tests(server)
class FakeFetcher(object):
sentinel = object()
def fetch(self, *args, **kwargs):
return self.sentinel
class DefaultFetcherTest(unittest.TestCase):
def setUp(self):
"""reset the default fetcher to None"""
fetchers.setDefaultFetcher(None)
def tearDown(self):
"""reset the default fetcher to None"""
fetchers.setDefaultFetcher(None)
def test_getDefaultNotNone(self):
"""Make sure that None is never returned as a default fetcher"""
self.assertIsNotNone(fetchers.getDefaultFetcher())
fetchers.setDefaultFetcher(None)
self.assertIsNotNone(fetchers.getDefaultFetcher())
def test_setDefault(self):
"""Make sure the getDefaultFetcher returns the object set for
setDefaultFetcher"""
sentinel = object()
fetchers.setDefaultFetcher(sentinel, wrap_exceptions=False)
self.assertEqual(fetchers.getDefaultFetcher(), sentinel)
def test_callFetch(self):
"""Make sure that fetchers.fetch() uses the default fetcher
instance that was set."""
fetchers.setDefaultFetcher(FakeFetcher())
actual = fetchers.fetch('bad://url')
self.assertEqual(actual, FakeFetcher.sentinel)
def test_wrappedByDefault(self):
"""Make sure that the default fetcher instance wraps
exceptions by default"""
default_fetcher = fetchers.getDefaultFetcher()
self.assertIsInstance(default_fetcher, fetchers.ExceptionWrappingFetcher)
self.assertRaises(fetchers.HTTPFetchingError, fetchers.fetch, 'http://invalid.janrain.com/')
def test_notWrapped(self):
"""Make sure that if we set a non-wrapped fetcher as default,
it will not wrap exceptions."""
# A fetcher that will raise an exception when it encounters a
# host that will not resolve
fetcher = fetchers.Urllib2Fetcher()
fetchers.setDefaultFetcher(fetcher, wrap_exceptions=False)
self.assertNotIsInstance(fetchers.getDefaultFetcher(), fetchers.ExceptionWrappingFetcher)
with self.assertRaises(URLError):
fetchers.fetch('http://invalid.janrain.com/')
class TestHandler(BaseHandler):
"""Urllib2 test handler."""
def __init__(self, http_mock):
self.http_mock = http_mock
def http_open(self, req):
return self.http_mock()
class TestUrllib2Fetcher(unittest.TestCase):
"""Test `Urllib2Fetcher` class."""
fetcher = fetchers.Urllib2Fetcher()
invalid_url_error = ValueError
def setUp(self):
self.http_mock = Mock(side_effect=[])
opener = OpenerDirector()
opener.add_handler(TestHandler(self.http_mock))
install_opener(opener)
def tearDown(self):
# Uninstall custom opener
install_opener(None)
def add_response(self, url, status_code, headers, body=None):
response = addinfourl(StringIO(body or ''), headers, url, status_code)
responses = list(self.http_mock.side_effect)
responses.append(response)
self.http_mock.side_effect = responses
def test_success(self):
# Test success response
self.add_response('http://example.cz/success/', 200, {'Content-Type': 'text/plain'}, 'BODY')
response = self.fetcher.fetch('http://example.cz/success/')
expected = fetchers.HTTPResponse('http://example.cz/success/', 200, {'Content-Type': 'text/plain'}, 'BODY')
assertResponse(expected, response)
def test_redirect(self):
# Test redirect response - a final response comes from another URL.
self.add_response('http://example.cz/success/', 200, {'Content-Type': 'text/plain'}, 'BODY')
response = self.fetcher.fetch('http://example.cz/redirect/')
expected = fetchers.HTTPResponse('http://example.cz/success/', 200, {'Content-Type': 'text/plain'}, 'BODY')
assertResponse(expected, response)
def test_error(self):
# Test error responses - returned as obtained
self.add_response('http://example.cz/error/', 500, {'Content-Type': 'text/plain'}, 'BODY')
response = self.fetcher.fetch('http://example.cz/error/')
expected = fetchers.HTTPResponse('http://example.cz/error/', 500, {'Content-Type': 'text/plain'}, 'BODY')
assertResponse(expected, response)
def test_invalid_url(self):
with six.assertRaisesRegex(self, self.invalid_url_error, 'Bad URL scheme:'):
self.fetcher.fetch('invalid://example.cz/')
def test_connection_error(self):
# Test connection error
self.http_mock.side_effect = HTTPError('http://example.cz/error/', 500, 'Error message',
{'Content-Type': 'text/plain'}, StringIO('BODY'))
response = self.fetcher.fetch('http://example.cz/error/')
expected = fetchers.HTTPResponse('http://example.cz/error/', 500, {'Content-Type': 'text/plain'}, 'BODY')
assertResponse(expected, response)
class TestSilencedUrllib2Fetcher(TestUrllib2Fetcher):
"""Test silenced `Urllib2Fetcher` class."""
fetcher = fetchers.ExceptionWrappingFetcher(fetchers.Urllib2Fetcher())
invalid_url_error = fetchers.HTTPFetchingError
@unittest.skipUnless(requests, "Requests are not installed")
class TestRequestsFetcher(unittest.TestCase):
"""Test `RequestsFetcher` class."""
fetcher = fetchers.RequestsFetcher()
def test_get(self):
# Test GET response
with responses.RequestsMock() as rsps:
rsps.add(responses.GET, 'http://example.cz/', status=200, body=b'BODY',
content_type='text/plain')
response = self.fetcher.fetch('http://example.cz/')
expected = fetchers.HTTPResponse('http://example.cz/', 200, {'Content-Type': 'text/plain'}, b'BODY')
assertResponse(expected, response)
def test_post(self):
# Test POST response
with responses.RequestsMock() as rsps:
rsps.add(responses.POST, 'http://example.cz/', status=200, body=b'BODY',
content_type='text/plain')
response = self.fetcher.fetch('http://example.cz/', body=b'key=value')
expected = fetchers.HTTPResponse('http://example.cz/', 200, {'Content-Type': 'text/plain'}, b'BODY')
assertResponse(expected, response)
def test_redirect(self):
# Test redirect response - a final response comes from another URL.
with responses.RequestsMock() as rsps:
rsps.add(responses.GET, 'http://example.cz/redirect/', status=302,
headers={'Location': 'http://example.cz/target/'})
rsps.add(responses.GET, 'http://example.cz/target/', status=200, body=b'BODY',
content_type='text/plain')
response = self.fetcher.fetch('http://example.cz/redirect/')
expected = fetchers.HTTPResponse('http://example.cz/target/', 200, {'Content-Type': 'text/plain'}, b'BODY')
assertResponse(expected, response)
def test_error(self):
# Test error responses - returned as obtained
with responses.RequestsMock() as rsps:
rsps.add(responses.GET, 'http://example.cz/error/', status=500, body=b'BODY',
content_type='text/plain')
response = self.fetcher.fetch('http://example.cz/error/')
expected = fetchers.HTTPResponse('http://example.cz/error/', 500, {'Content-Type': 'text/plain'}, b'BODY')
assertResponse(expected, response)
def test_invalid_url(self):
invalid_url = 'invalid://example.cz/'
expected_message = (
'No connection adapters were found for '
+ ('u' if six.PY2 else '')
+ "'" + invalid_url + "'")
with six.assertRaisesRegex(self, InvalidSchema, expected_message):
self.fetcher.fetch(invalid_url)
def test_connection_error(self):
# Test connection error
with responses.RequestsMock() as rsps:
rsps.add(responses.GET, 'http://example.cz/', body=ConnectionError('Name or service not known'))
with six.assertRaisesRegex(self, ConnectionError, 'Name or service not known'):
self.fetcher.fetch('http://example.cz/')
|