blob: 34329f87162a625fbd0d1c987790648c2e2ff302 [file] [log] [blame]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002from test import support
Serhiy Storchakaf54c3502014-09-06 21:41:39 +03003from test import test_urllib
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00004
Christian Heimes05e8be12008-02-23 18:30:17 +00005import os
Guido van Rossum34d19282007-08-09 01:03:29 +00006import io
Georg Brandlf78e02b2008-06-10 17:40:04 +00007import socket
Senthil Kumaran7bc0d872010-12-19 10:49:52 +00008import array
Senthil Kumaran4de00a22011-05-11 21:17:57 +08009import sys
Martin Panter3c0d0ba2016-08-24 06:33:33 +000010import tempfile
11import subprocess
Jeremy Hyltone3e61042001-05-09 15:50:25 +000012
Jeremy Hylton1afc1692008-06-18 20:49:58 +000013import urllib.request
Ronald Oussorene72e1612011-03-14 18:15:25 -040014# The proxy bypass method imported below has logic specific to the OSX
15# proxy config data structure but is testable on all platforms.
R David Murray4c7f9952015-04-16 16:36:18 -040016from urllib.request import (Request, OpenerDirector, HTTPBasicAuthHandler,
17 HTTPPasswordMgrWithPriorAuth, _parse_proxy,
Berker Peksage88dd1c2016-03-06 16:16:40 +020018 _proxy_bypass_macosx_sysconf,
19 AbstractDigestAuthHandler)
Senthil Kumaran83070752013-05-24 09:14:12 -070020from urllib.parse import urlparse
guido@google.coma119df92011-03-29 11:41:02 -070021import urllib.error
Serhiy Storchakaf54c3502014-09-06 21:41:39 +030022import http.client
Jeremy Hyltone3e61042001-05-09 15:50:25 +000023
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000024# XXX
25# Request
26# CacheFTPHandler (hard to write)
Thomas Wouters477c8d52006-05-27 19:21:47 +000027# parse_keqv_list, parse_http_list, HTTPDigestAuthHandler
Jeremy Hyltone3e61042001-05-09 15:50:25 +000028
Facundo Batista244afcf2015-04-22 18:35:54 -030029
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000030class TrivialTests(unittest.TestCase):
Senthil Kumaran6c5bd402011-11-01 23:20:31 +080031
32 def test___all__(self):
33 # Verify which names are exposed
34 for module in 'request', 'response', 'parse', 'error', 'robotparser':
35 context = {}
36 exec('from urllib.%s import *' % module, context)
37 del context['__builtins__']
Florent Xicluna3dbb1f12011-11-04 22:15:37 +010038 if module == 'request' and os.name == 'nt':
39 u, p = context.pop('url2pathname'), context.pop('pathname2url')
40 self.assertEqual(u.__module__, 'nturl2path')
41 self.assertEqual(p.__module__, 'nturl2path')
Senthil Kumaran6c5bd402011-11-01 23:20:31 +080042 for k, v in context.items():
43 self.assertEqual(v.__module__, 'urllib.%s' % module,
44 "%r is exposed in 'urllib.%s' but defined in %r" %
45 (k, module, v.__module__))
46
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000047 def test_trivial(self):
48 # A couple trivial tests
Guido van Rossume2ae77b2001-10-24 20:42:55 +000049
Jeremy Hylton1afc1692008-06-18 20:49:58 +000050 self.assertRaises(ValueError, urllib.request.urlopen, 'bogus url')
Tim Peters861adac2001-07-16 20:49:49 +000051
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000052 # XXX Name hacking to get this to work on Windows.
Serhiy Storchaka5106d042015-01-26 10:26:14 +020053 fname = os.path.abspath(urllib.request.__file__).replace(os.sep, '/')
Senthil Kumarand587e302010-01-10 17:45:52 +000054
Senthil Kumarand587e302010-01-10 17:45:52 +000055 if os.name == 'nt':
56 file_url = "file:///%s" % fname
57 else:
58 file_url = "file://%s" % fname
59
Jeremy Hylton1afc1692008-06-18 20:49:58 +000060 f = urllib.request.urlopen(file_url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000061
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -070062 f.read()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000063 f.close()
Tim Petersf5f32b42005-07-17 23:16:17 +000064
Georg Brandle1b13d22005-08-24 22:20:32 +000065 def test_parse_http_list(self):
Jeremy Hylton1afc1692008-06-18 20:49:58 +000066 tests = [
67 ('a,b,c', ['a', 'b', 'c']),
68 ('path"o,l"og"i"cal, example', ['path"o,l"og"i"cal', 'example']),
69 ('a, b, "c", "d", "e,f", g, h',
70 ['a', 'b', '"c"', '"d"', '"e,f"', 'g', 'h']),
71 ('a="b\\"c", d="e\\,f", g="h\\\\i"',
72 ['a="b"c"', 'd="e,f"', 'g="h\\i"'])]
Georg Brandle1b13d22005-08-24 22:20:32 +000073 for string, list in tests:
Florent Xicluna419e3842010-08-08 16:16:07 +000074 self.assertEqual(urllib.request.parse_http_list(string), list)
Georg Brandle1b13d22005-08-24 22:20:32 +000075
Senthil Kumaran843fae92013-03-19 13:43:42 -070076 def test_URLError_reasonstr(self):
77 err = urllib.error.URLError('reason')
78 self.assertIn(err.reason, str(err))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000079
Facundo Batista244afcf2015-04-22 18:35:54 -030080
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -070081class RequestHdrsTests(unittest.TestCase):
Thomas Wouters00ee7ba2006-08-21 19:07:27 +000082
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -070083 def test_request_headers_dict(self):
84 """
85 The Request.headers dictionary is not a documented interface. It
86 should stay that way, because the complete set of headers are only
87 accessible through the .get_header(), .has_header(), .header_items()
88 interface. However, .headers pre-dates those methods, and so real code
89 will be using the dictionary.
90
91 The introduction in 2.4 of those methods was a mistake for the same
92 reason: code that previously saw all (urllib2 user)-provided headers in
93 .headers now sees only a subset.
94
95 """
96 url = "http://example.com"
97 self.assertEqual(Request(url,
98 headers={"Spam-eggs": "blah"}
99 ).headers["Spam-eggs"], "blah")
100 self.assertEqual(Request(url,
101 headers={"spam-EggS": "blah"}
102 ).headers["Spam-eggs"], "blah")
103
104 def test_request_headers_methods(self):
105 """
106 Note the case normalization of header names here, to
107 .capitalize()-case. This should be preserved for
108 backwards-compatibility. (In the HTTP case, normalization to
109 .title()-case is done by urllib2 before sending headers to
110 http.client).
111
112 Note that e.g. r.has_header("spam-EggS") is currently False, and
113 r.get_header("spam-EggS") returns None, but that could be changed in
114 future.
115
116 Method r.remove_header should remove items both from r.headers and
117 r.unredirected_hdrs dictionaries
118 """
119 url = "http://example.com"
120 req = Request(url, headers={"Spam-eggs": "blah"})
121 self.assertTrue(req.has_header("Spam-eggs"))
122 self.assertEqual(req.header_items(), [('Spam-eggs', 'blah')])
123
124 req.add_header("Foo-Bar", "baz")
125 self.assertEqual(sorted(req.header_items()),
126 [('Foo-bar', 'baz'), ('Spam-eggs', 'blah')])
127 self.assertFalse(req.has_header("Not-there"))
128 self.assertIsNone(req.get_header("Not-there"))
129 self.assertEqual(req.get_header("Not-there", "default"), "default")
130
131 req.remove_header("Spam-eggs")
132 self.assertFalse(req.has_header("Spam-eggs"))
133
134 req.add_unredirected_header("Unredirected-spam", "Eggs")
135 self.assertTrue(req.has_header("Unredirected-spam"))
136
137 req.remove_header("Unredirected-spam")
138 self.assertFalse(req.has_header("Unredirected-spam"))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000139
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700140 def test_password_manager(self):
141 mgr = urllib.request.HTTPPasswordMgr()
142 add = mgr.add_password
143 find_user_pass = mgr.find_user_password
144 add("Some Realm", "http://example.com/", "joe", "password")
145 add("Some Realm", "http://example.com/ni", "ni", "ni")
146 add("c", "http://example.com/foo", "foo", "ni")
147 add("c", "http://example.com/bar", "bar", "nini")
148 add("b", "http://example.com/", "first", "blah")
149 add("b", "http://example.com/", "second", "spam")
150 add("a", "http://example.com", "1", "a")
151 add("Some Realm", "http://c.example.com:3128", "3", "c")
152 add("Some Realm", "d.example.com", "4", "d")
153 add("Some Realm", "e.example.com:3128", "5", "e")
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000154
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700155 self.assertEqual(find_user_pass("Some Realm", "example.com"),
156 ('joe', 'password'))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000157
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700158 #self.assertEqual(find_user_pass("Some Realm", "http://example.com/ni"),
159 # ('ni', 'ni'))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000160
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700161 self.assertEqual(find_user_pass("Some Realm", "http://example.com"),
162 ('joe', 'password'))
163 self.assertEqual(find_user_pass("Some Realm", "http://example.com/"),
164 ('joe', 'password'))
165 self.assertEqual(
166 find_user_pass("Some Realm", "http://example.com/spam"),
167 ('joe', 'password'))
168 self.assertEqual(
169 find_user_pass("Some Realm", "http://example.com/spam/spam"),
170 ('joe', 'password'))
171 self.assertEqual(find_user_pass("c", "http://example.com/foo"),
172 ('foo', 'ni'))
173 self.assertEqual(find_user_pass("c", "http://example.com/bar"),
174 ('bar', 'nini'))
175 self.assertEqual(find_user_pass("b", "http://example.com/"),
176 ('second', 'spam'))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000177
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700178 # No special relationship between a.example.com and example.com:
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000179
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700180 self.assertEqual(find_user_pass("a", "http://example.com/"),
181 ('1', 'a'))
182 self.assertEqual(find_user_pass("a", "http://a.example.com/"),
183 (None, None))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000184
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700185 # Ports:
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000186
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700187 self.assertEqual(find_user_pass("Some Realm", "c.example.com"),
188 (None, None))
189 self.assertEqual(find_user_pass("Some Realm", "c.example.com:3128"),
190 ('3', 'c'))
191 self.assertEqual(
192 find_user_pass("Some Realm", "http://c.example.com:3128"),
193 ('3', 'c'))
194 self.assertEqual(find_user_pass("Some Realm", "d.example.com"),
195 ('4', 'd'))
196 self.assertEqual(find_user_pass("Some Realm", "e.example.com:3128"),
197 ('5', 'e'))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000198
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700199 def test_password_manager_default_port(self):
200 """
201 The point to note here is that we can't guess the default port if
202 there's no scheme. This applies to both add_password and
203 find_user_password.
204 """
205 mgr = urllib.request.HTTPPasswordMgr()
206 add = mgr.add_password
207 find_user_pass = mgr.find_user_password
208 add("f", "http://g.example.com:80", "10", "j")
209 add("g", "http://h.example.com", "11", "k")
210 add("h", "i.example.com:80", "12", "l")
211 add("i", "j.example.com", "13", "m")
212 self.assertEqual(find_user_pass("f", "g.example.com:100"),
213 (None, None))
214 self.assertEqual(find_user_pass("f", "g.example.com:80"),
215 ('10', 'j'))
216 self.assertEqual(find_user_pass("f", "g.example.com"),
217 (None, None))
218 self.assertEqual(find_user_pass("f", "http://g.example.com:100"),
219 (None, None))
220 self.assertEqual(find_user_pass("f", "http://g.example.com:80"),
221 ('10', 'j'))
222 self.assertEqual(find_user_pass("f", "http://g.example.com"),
223 ('10', 'j'))
224 self.assertEqual(find_user_pass("g", "h.example.com"), ('11', 'k'))
225 self.assertEqual(find_user_pass("g", "h.example.com:80"), ('11', 'k'))
226 self.assertEqual(find_user_pass("g", "http://h.example.com:80"),
227 ('11', 'k'))
228 self.assertEqual(find_user_pass("h", "i.example.com"), (None, None))
229 self.assertEqual(find_user_pass("h", "i.example.com:80"), ('12', 'l'))
230 self.assertEqual(find_user_pass("h", "http://i.example.com:80"),
231 ('12', 'l'))
232 self.assertEqual(find_user_pass("i", "j.example.com"), ('13', 'm'))
233 self.assertEqual(find_user_pass("i", "j.example.com:80"),
234 (None, None))
235 self.assertEqual(find_user_pass("i", "http://j.example.com"),
236 ('13', 'm'))
237 self.assertEqual(find_user_pass("i", "http://j.example.com:80"),
238 (None, None))
Andrew Svetlovbff98fe2012-11-27 23:06:19 +0200239
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000240
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000241class MockOpener:
242 addheaders = []
Facundo Batista244afcf2015-04-22 18:35:54 -0300243
Senthil Kumaranfb8cc2f2009-07-19 02:44:19 +0000244 def open(self, req, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
245 self.req, self.data, self.timeout = req, data, timeout
Facundo Batista244afcf2015-04-22 18:35:54 -0300246
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000247 def error(self, proto, *args):
248 self.proto, self.args = proto, args
249
Facundo Batista244afcf2015-04-22 18:35:54 -0300250
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000251class MockFile:
Facundo Batista244afcf2015-04-22 18:35:54 -0300252 def read(self, count=None):
253 pass
254
255 def readline(self, count=None):
256 pass
257
258 def close(self):
259 pass
260
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000261
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000262class MockHeaders(dict):
263 def getheaders(self, name):
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000264 return list(self.values())
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000265
Facundo Batista244afcf2015-04-22 18:35:54 -0300266
Guido van Rossum34d19282007-08-09 01:03:29 +0000267class MockResponse(io.StringIO):
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000268 def __init__(self, code, msg, headers, data, url=None):
Guido van Rossum34d19282007-08-09 01:03:29 +0000269 io.StringIO.__init__(self, data)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000270 self.code, self.msg, self.headers, self.url = code, msg, headers, url
Facundo Batista244afcf2015-04-22 18:35:54 -0300271
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000272 def info(self):
273 return self.headers
Facundo Batista244afcf2015-04-22 18:35:54 -0300274
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000275 def geturl(self):
276 return self.url
277
Facundo Batista244afcf2015-04-22 18:35:54 -0300278
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000279class MockCookieJar:
280 def add_cookie_header(self, request):
281 self.ach_req = request
Facundo Batista244afcf2015-04-22 18:35:54 -0300282
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000283 def extract_cookies(self, response, request):
284 self.ec_req, self.ec_r = request, response
285
Facundo Batista244afcf2015-04-22 18:35:54 -0300286
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000287class FakeMethod:
288 def __init__(self, meth_name, action, handle):
289 self.meth_name = meth_name
290 self.handle = handle
291 self.action = action
Facundo Batista244afcf2015-04-22 18:35:54 -0300292
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000293 def __call__(self, *args):
294 return self.handle(self.meth_name, self.action, *args)
295
Facundo Batista244afcf2015-04-22 18:35:54 -0300296
Senthil Kumaran47fff872009-12-20 07:10:31 +0000297class MockHTTPResponse(io.IOBase):
298 def __init__(self, fp, msg, status, reason):
299 self.fp = fp
300 self.msg = msg
301 self.status = status
302 self.reason = reason
303 self.code = 200
304
305 def read(self):
306 return ''
307
308 def info(self):
309 return {}
310
311 def geturl(self):
312 return self.url
313
314
315class MockHTTPClass:
316 def __init__(self):
317 self.level = 0
318 self.req_headers = []
319 self.data = None
320 self.raise_on_endheaders = False
Nadeem Vawdabd26b542012-10-21 17:37:43 +0200321 self.sock = None
Senthil Kumaran47fff872009-12-20 07:10:31 +0000322 self._tunnel_headers = {}
323
324 def __call__(self, host, timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
325 self.host = host
326 self.timeout = timeout
327 return self
328
329 def set_debuglevel(self, level):
330 self.level = level
331
332 def set_tunnel(self, host, port=None, headers=None):
333 self._tunnel_host = host
334 self._tunnel_port = port
335 if headers:
336 self._tunnel_headers = headers
337 else:
338 self._tunnel_headers.clear()
339
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000340 def request(self, method, url, body=None, headers=None, *,
341 encode_chunked=False):
Senthil Kumaran47fff872009-12-20 07:10:31 +0000342 self.method = method
343 self.selector = url
Benjamin Peterson3d5b8db2009-12-24 01:14:05 +0000344 if headers is not None:
345 self.req_headers += headers.items()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000346 self.req_headers.sort()
347 if body:
348 self.data = body
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000349 self.encode_chunked = encode_chunked
Senthil Kumaran47fff872009-12-20 07:10:31 +0000350 if self.raise_on_endheaders:
Andrew Svetlov0832af62012-12-18 23:10:48 +0200351 raise OSError()
Facundo Batista244afcf2015-04-22 18:35:54 -0300352
Senthil Kumaran47fff872009-12-20 07:10:31 +0000353 def getresponse(self):
354 return MockHTTPResponse(MockFile(), {}, 200, "OK")
355
Victor Stinnera4c45d72011-06-17 14:01:18 +0200356 def close(self):
357 pass
358
Facundo Batista244afcf2015-04-22 18:35:54 -0300359
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000360class MockHandler:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000361 # useful for testing handler machinery
362 # see add_ordered_mock_handlers() docstring
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000363 handler_order = 500
Facundo Batista244afcf2015-04-22 18:35:54 -0300364
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000365 def __init__(self, methods):
366 self._define_methods(methods)
Facundo Batista244afcf2015-04-22 18:35:54 -0300367
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000368 def _define_methods(self, methods):
369 for spec in methods:
Facundo Batista244afcf2015-04-22 18:35:54 -0300370 if len(spec) == 2:
371 name, action = spec
372 else:
373 name, action = spec, None
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000374 meth = FakeMethod(name, action, self.handle)
375 setattr(self.__class__, name, meth)
Facundo Batista244afcf2015-04-22 18:35:54 -0300376
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000377 def handle(self, fn_name, action, *args, **kwds):
378 self.parent.calls.append((self, fn_name, args, kwds))
379 if action is None:
380 return None
381 elif action == "return self":
382 return self
383 elif action == "return response":
384 res = MockResponse(200, "OK", {}, "")
385 return res
386 elif action == "return request":
387 return Request("http://blah/")
388 elif action.startswith("error"):
389 code = action[action.rfind(" ")+1:]
390 try:
391 code = int(code)
392 except ValueError:
393 pass
394 res = MockResponse(200, "OK", {}, "")
395 return self.parent.error("http", args[0], res, code, "", {})
396 elif action == "raise":
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000397 raise urllib.error.URLError("blah")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000398 assert False
Facundo Batista244afcf2015-04-22 18:35:54 -0300399
400 def close(self):
401 pass
402
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000403 def add_parent(self, parent):
404 self.parent = parent
405 self.parent.calls = []
Facundo Batista244afcf2015-04-22 18:35:54 -0300406
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000407 def __lt__(self, other):
408 if not hasattr(other, "handler_order"):
409 # No handler_order, leave in original order. Yuck.
410 return True
411 return self.handler_order < other.handler_order
412
Facundo Batista244afcf2015-04-22 18:35:54 -0300413
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000414def add_ordered_mock_handlers(opener, meth_spec):
415 """Create MockHandlers and add them to an OpenerDirector.
416
417 meth_spec: list of lists of tuples and strings defining methods to define
418 on handlers. eg:
419
420 [["http_error", "ftp_open"], ["http_open"]]
421
422 defines methods .http_error() and .ftp_open() on one handler, and
423 .http_open() on another. These methods just record their arguments and
424 return None. Using a tuple instead of a string causes the method to
425 perform some action (see MockHandler.handle()), eg:
426
427 [["http_error"], [("http_open", "return request")]]
428
429 defines .http_error() on one handler (which simply returns None), and
430 .http_open() on another handler, which returns a Request object.
431
432 """
433 handlers = []
434 count = 0
435 for meths in meth_spec:
Facundo Batista244afcf2015-04-22 18:35:54 -0300436 class MockHandlerSubclass(MockHandler):
437 pass
438
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000439 h = MockHandlerSubclass(meths)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000440 h.handler_order += count
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000441 h.add_parent(opener)
442 count = count + 1
443 handlers.append(h)
444 opener.add_handler(h)
445 return handlers
446
Facundo Batista244afcf2015-04-22 18:35:54 -0300447
Thomas Wouters477c8d52006-05-27 19:21:47 +0000448def build_test_opener(*handler_instances):
449 opener = OpenerDirector()
450 for h in handler_instances:
451 opener.add_handler(h)
452 return opener
453
Facundo Batista244afcf2015-04-22 18:35:54 -0300454
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000455class MockHTTPHandler(urllib.request.BaseHandler):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000456 # useful for testing redirections and auth
457 # sends supplied headers and code as first response
458 # sends 200 OK as second response
459 def __init__(self, code, headers):
460 self.code = code
461 self.headers = headers
462 self.reset()
Facundo Batista244afcf2015-04-22 18:35:54 -0300463
Thomas Wouters477c8d52006-05-27 19:21:47 +0000464 def reset(self):
465 self._count = 0
466 self.requests = []
Facundo Batista244afcf2015-04-22 18:35:54 -0300467
Thomas Wouters477c8d52006-05-27 19:21:47 +0000468 def http_open(self, req):
Martin Panterce6e0682016-05-16 01:07:13 +0000469 import email, copy
Thomas Wouters477c8d52006-05-27 19:21:47 +0000470 self.requests.append(copy.deepcopy(req))
471 if self._count == 0:
472 self._count = self._count + 1
Georg Brandl24420152008-05-26 16:32:26 +0000473 name = http.client.responses[self.code]
Barry Warsaw820c1202008-06-12 04:06:45 +0000474 msg = email.message_from_string(self.headers)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000475 return self.parent.error(
476 "http", req, MockFile(), self.code, name, msg)
477 else:
478 self.req = req
Barry Warsaw820c1202008-06-12 04:06:45 +0000479 msg = email.message_from_string("\r\n\r\n")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000480 return MockResponse(200, "OK", msg, "", req.get_full_url())
481
Facundo Batista244afcf2015-04-22 18:35:54 -0300482
Senthil Kumaran47fff872009-12-20 07:10:31 +0000483class MockHTTPSHandler(urllib.request.AbstractHTTPHandler):
484 # Useful for testing the Proxy-Authorization request by verifying the
485 # properties of httpcon
Benjamin Peterson3d5b8db2009-12-24 01:14:05 +0000486
Senthil Kumaran9642eed2016-05-13 01:32:42 -0700487 def __init__(self, debuglevel=0):
488 urllib.request.AbstractHTTPHandler.__init__(self, debuglevel=debuglevel)
Benjamin Peterson3d5b8db2009-12-24 01:14:05 +0000489 self.httpconn = MockHTTPClass()
490
Senthil Kumaran47fff872009-12-20 07:10:31 +0000491 def https_open(self, req):
492 return self.do_open(self.httpconn, req)
493
R David Murray4c7f9952015-04-16 16:36:18 -0400494
495class MockHTTPHandlerCheckAuth(urllib.request.BaseHandler):
496 # useful for testing auth
497 # sends supplied code response
498 # checks if auth header is specified in request
499 def __init__(self, code):
500 self.code = code
501 self.has_auth_header = False
502
503 def reset(self):
504 self.has_auth_header = False
505
506 def http_open(self, req):
507 if req.has_header('Authorization'):
508 self.has_auth_header = True
509 name = http.client.responses[self.code]
510 return MockResponse(self.code, name, MockFile(), "", req.get_full_url())
511
512
Facundo Batista244afcf2015-04-22 18:35:54 -0300513
Thomas Wouters477c8d52006-05-27 19:21:47 +0000514class MockPasswordManager:
515 def add_password(self, realm, uri, user, password):
516 self.realm = realm
517 self.url = uri
518 self.user = user
519 self.password = password
Facundo Batista244afcf2015-04-22 18:35:54 -0300520
Thomas Wouters477c8d52006-05-27 19:21:47 +0000521 def find_user_password(self, realm, authuri):
522 self.target_realm = realm
523 self.target_url = authuri
524 return self.user, self.password
525
526
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000527class OpenerDirectorTests(unittest.TestCase):
528
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000529 def test_add_non_handler(self):
530 class NonHandler(object):
531 pass
532 self.assertRaises(TypeError,
533 OpenerDirector().add_handler, NonHandler())
534
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000535 def test_badly_named_methods(self):
536 # test work-around for three methods that accidentally follow the
537 # naming conventions for handler methods
538 # (*_open() / *_request() / *_response())
539
540 # These used to call the accidentally-named methods, causing a
541 # TypeError in real code; here, returning self from these mock
542 # methods would either cause no exception, or AttributeError.
543
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000544 from urllib.error import URLError
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000545
546 o = OpenerDirector()
547 meth_spec = [
548 [("do_open", "return self"), ("proxy_open", "return self")],
549 [("redirect_request", "return self")],
550 ]
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700551 add_ordered_mock_handlers(o, meth_spec)
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000552 o.add_handler(urllib.request.UnknownHandler())
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000553 for scheme in "do", "proxy", "redirect":
554 self.assertRaises(URLError, o.open, scheme+"://example.com/")
555
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000556 def test_handled(self):
557 # handler returning non-None means no more handlers will be called
558 o = OpenerDirector()
559 meth_spec = [
560 ["http_open", "ftp_open", "http_error_302"],
561 ["ftp_open"],
562 [("http_open", "return self")],
563 [("http_open", "return self")],
564 ]
565 handlers = add_ordered_mock_handlers(o, meth_spec)
566
567 req = Request("http://example.com/")
568 r = o.open(req)
569 # Second .http_open() gets called, third doesn't, since second returned
570 # non-None. Handlers without .http_open() never get any methods called
571 # on them.
572 # In fact, second mock handler defining .http_open() returns self
573 # (instead of response), which becomes the OpenerDirector's return
574 # value.
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000575 self.assertEqual(r, handlers[2])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000576 calls = [(handlers[0], "http_open"), (handlers[2], "http_open")]
577 for expected, got in zip(calls, o.calls):
578 handler, name, args, kwds = got
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000579 self.assertEqual((handler, name), expected)
580 self.assertEqual(args, (req,))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000581
582 def test_handler_order(self):
583 o = OpenerDirector()
584 handlers = []
Facundo Batista244afcf2015-04-22 18:35:54 -0300585 for meths, handler_order in [([("http_open", "return self")], 500),
586 (["http_open"], 0)]:
587 class MockHandlerSubclass(MockHandler):
588 pass
589
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000590 h = MockHandlerSubclass(meths)
591 h.handler_order = handler_order
592 handlers.append(h)
593 o.add_handler(h)
594
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700595 o.open("http://example.com/")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000596 # handlers called in reverse order, thanks to their sort order
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000597 self.assertEqual(o.calls[0][0], handlers[1])
598 self.assertEqual(o.calls[1][0], handlers[0])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000599
600 def test_raise(self):
601 # raising URLError stops processing of request
602 o = OpenerDirector()
603 meth_spec = [
604 [("http_open", "raise")],
605 [("http_open", "return self")],
606 ]
607 handlers = add_ordered_mock_handlers(o, meth_spec)
608
609 req = Request("http://example.com/")
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000610 self.assertRaises(urllib.error.URLError, o.open, req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000611 self.assertEqual(o.calls, [(handlers[0], "http_open", (req,), {})])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000612
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000613 def test_http_error(self):
614 # XXX http_error_default
615 # http errors are a special case
616 o = OpenerDirector()
617 meth_spec = [
618 [("http_open", "error 302")],
619 [("http_error_400", "raise"), "http_open"],
620 [("http_error_302", "return response"), "http_error_303",
621 "http_error"],
622 [("http_error_302")],
623 ]
624 handlers = add_ordered_mock_handlers(o, meth_spec)
625
626 class Unknown:
Facundo Batista244afcf2015-04-22 18:35:54 -0300627 def __eq__(self, other):
628 return True
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000629
630 req = Request("http://example.com/")
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700631 o.open(req)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000632 assert len(o.calls) == 2
633 calls = [(handlers[0], "http_open", (req,)),
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000634 (handlers[2], "http_error_302",
635 (req, Unknown(), 302, "", {}))]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000636 for expected, got in zip(calls, o.calls):
637 handler, method_name, args = expected
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000638 self.assertEqual((handler, method_name), got[:2])
639 self.assertEqual(args, got[2])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000640
641 def test_processors(self):
642 # *_request / *_response methods get called appropriately
643 o = OpenerDirector()
644 meth_spec = [
645 [("http_request", "return request"),
646 ("http_response", "return response")],
647 [("http_request", "return request"),
648 ("http_response", "return response")],
649 ]
650 handlers = add_ordered_mock_handlers(o, meth_spec)
651
652 req = Request("http://example.com/")
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700653 o.open(req)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000654 # processor methods are called on *all* handlers that define them,
655 # not just the first handler that handles the request
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000656 calls = [
657 (handlers[0], "http_request"), (handlers[1], "http_request"),
658 (handlers[0], "http_response"), (handlers[1], "http_response")]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000659
660 for i, (handler, name, args, kwds) in enumerate(o.calls):
661 if i < 2:
662 # *_request
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000663 self.assertEqual((handler, name), calls[i])
664 self.assertEqual(len(args), 1)
Ezio Melottie9615932010-01-24 19:26:24 +0000665 self.assertIsInstance(args[0], Request)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000666 else:
667 # *_response
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000668 self.assertEqual((handler, name), calls[i])
669 self.assertEqual(len(args), 2)
Ezio Melottie9615932010-01-24 19:26:24 +0000670 self.assertIsInstance(args[0], Request)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000671 # response from opener.open is None, because there's no
672 # handler that defines http_open to handle it
Serhiy Storchaka25d8aea2014-02-08 14:50:08 +0200673 if args[1] is not None:
674 self.assertIsInstance(args[1], MockResponse)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000675
Facundo Batista244afcf2015-04-22 18:35:54 -0300676
Tim Peters58eb11c2004-01-18 20:29:55 +0000677def sanepathname2url(path):
Victor Stinner6c6f8512010-08-07 10:09:35 +0000678 try:
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000679 path.encode("utf-8")
Victor Stinner6c6f8512010-08-07 10:09:35 +0000680 except UnicodeEncodeError:
681 raise unittest.SkipTest("path is not encodable to utf8")
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000682 urlpath = urllib.request.pathname2url(path)
Tim Peters58eb11c2004-01-18 20:29:55 +0000683 if os.name == "nt" and urlpath.startswith("///"):
684 urlpath = urlpath[2:]
685 # XXX don't ask me about the mac...
686 return urlpath
687
Facundo Batista244afcf2015-04-22 18:35:54 -0300688
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000689class HandlerTests(unittest.TestCase):
690
691 def test_ftp(self):
692 class MockFTPWrapper:
Facundo Batista244afcf2015-04-22 18:35:54 -0300693 def __init__(self, data):
694 self.data = data
695
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000696 def retrfile(self, filename, filetype):
697 self.filename, self.filetype = filename, filetype
Guido van Rossum34d19282007-08-09 01:03:29 +0000698 return io.StringIO(self.data), len(self.data)
Facundo Batista244afcf2015-04-22 18:35:54 -0300699
700 def close(self):
701 pass
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000702
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000703 class NullFTPHandler(urllib.request.FTPHandler):
Facundo Batista244afcf2015-04-22 18:35:54 -0300704 def __init__(self, data):
705 self.data = data
706
Georg Brandlf78e02b2008-06-10 17:40:04 +0000707 def connect_ftp(self, user, passwd, host, port, dirs,
708 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000709 self.user, self.passwd = user, passwd
710 self.host, self.port = host, port
711 self.dirs = dirs
712 self.ftpwrapper = MockFTPWrapper(self.data)
713 return self.ftpwrapper
714
Georg Brandlf78e02b2008-06-10 17:40:04 +0000715 import ftplib
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000716 data = "rheum rhaponicum"
717 h = NullFTPHandler(data)
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -0700718 h.parent = MockOpener()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000719
Senthil Kumarandaa29d02010-11-18 15:36:41 +0000720 for url, host, port, user, passwd, type_, dirs, filename, mimetype in [
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000721 ("ftp://localhost/foo/bar/baz.html",
Senthil Kumarandaa29d02010-11-18 15:36:41 +0000722 "localhost", ftplib.FTP_PORT, "", "", "I",
723 ["foo", "bar"], "baz.html", "text/html"),
724 ("ftp://parrot@localhost/foo/bar/baz.html",
725 "localhost", ftplib.FTP_PORT, "parrot", "", "I",
726 ["foo", "bar"], "baz.html", "text/html"),
727 ("ftp://%25parrot@localhost/foo/bar/baz.html",
728 "localhost", ftplib.FTP_PORT, "%parrot", "", "I",
729 ["foo", "bar"], "baz.html", "text/html"),
730 ("ftp://%2542parrot@localhost/foo/bar/baz.html",
731 "localhost", ftplib.FTP_PORT, "%42parrot", "", "I",
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000732 ["foo", "bar"], "baz.html", "text/html"),
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000733 ("ftp://localhost:80/foo/bar/",
Senthil Kumarandaa29d02010-11-18 15:36:41 +0000734 "localhost", 80, "", "", "D",
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000735 ["foo", "bar"], "", None),
736 ("ftp://localhost/baz.gif;type=a",
Senthil Kumarandaa29d02010-11-18 15:36:41 +0000737 "localhost", ftplib.FTP_PORT, "", "", "A",
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000738 [], "baz.gif", None), # XXX really this should guess image/gif
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000739 ]:
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000740 req = Request(url)
741 req.timeout = None
742 r = h.ftp_open(req)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000743 # ftp authentication not yet implemented by FTPHandler
Senthil Kumarandaa29d02010-11-18 15:36:41 +0000744 self.assertEqual(h.user, user)
745 self.assertEqual(h.passwd, passwd)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000746 self.assertEqual(h.host, socket.gethostbyname(host))
747 self.assertEqual(h.port, port)
748 self.assertEqual(h.dirs, dirs)
749 self.assertEqual(h.ftpwrapper.filename, filename)
750 self.assertEqual(h.ftpwrapper.filetype, type_)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000751 headers = r.info()
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000752 self.assertEqual(headers.get("Content-type"), mimetype)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000753 self.assertEqual(int(headers["Content-length"]), len(data))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000754
755 def test_file(self):
Senthil Kumaranbc07ac52014-07-22 00:15:20 -0700756 import email.utils
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000757 h = urllib.request.FileHandler()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000758 o = h.parent = MockOpener()
759
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000760 TESTFN = support.TESTFN
Tim Peters58eb11c2004-01-18 20:29:55 +0000761 urlpath = sanepathname2url(os.path.abspath(TESTFN))
Guido van Rossum6a2ccd02007-07-16 20:51:57 +0000762 towrite = b"hello, world\n"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000763 urls = [
Tim Peters58eb11c2004-01-18 20:29:55 +0000764 "file://localhost%s" % urlpath,
765 "file://%s" % urlpath,
766 "file://%s%s" % (socket.gethostbyname('localhost'), urlpath),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000767 ]
768 try:
769 localaddr = socket.gethostbyname(socket.gethostname())
770 except socket.gaierror:
771 localaddr = ''
772 if localaddr:
773 urls.append("file://%s%s" % (localaddr, urlpath))
774
775 for url in urls:
Tim Peters58eb11c2004-01-18 20:29:55 +0000776 f = open(TESTFN, "wb")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000777 try:
778 try:
779 f.write(towrite)
780 finally:
781 f.close()
782
783 r = h.file_open(Request(url))
784 try:
785 data = r.read()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000786 headers = r.info()
Senthil Kumaran4fbed102010-05-08 03:29:09 +0000787 respurl = r.geturl()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000788 finally:
789 r.close()
Tim Peters58eb11c2004-01-18 20:29:55 +0000790 stats = os.stat(TESTFN)
Benjamin Petersona0c0a4a2008-06-12 22:15:50 +0000791 modified = email.utils.formatdate(stats.st_mtime, usegmt=True)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000792 finally:
793 os.remove(TESTFN)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000794 self.assertEqual(data, towrite)
795 self.assertEqual(headers["Content-type"], "text/plain")
796 self.assertEqual(headers["Content-length"], "13")
Tim Peters58eb11c2004-01-18 20:29:55 +0000797 self.assertEqual(headers["Last-modified"], modified)
Senthil Kumaran4fbed102010-05-08 03:29:09 +0000798 self.assertEqual(respurl, url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000799
800 for url in [
Tim Peters58eb11c2004-01-18 20:29:55 +0000801 "file://localhost:80%s" % urlpath,
Guido van Rossumd8faa362007-04-27 19:54:29 +0000802 "file:///file_does_not_exist.txt",
Senthil Kumaranbc07ac52014-07-22 00:15:20 -0700803 "file://not-a-local-host.com//dir/file.txt",
Guido van Rossumd8faa362007-04-27 19:54:29 +0000804 "file://%s:80%s/%s" % (socket.gethostbyname('localhost'),
805 os.getcwd(), TESTFN),
806 "file://somerandomhost.ontheinternet.com%s/%s" %
807 (os.getcwd(), TESTFN),
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000808 ]:
809 try:
Tim Peters58eb11c2004-01-18 20:29:55 +0000810 f = open(TESTFN, "wb")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000811 try:
812 f.write(towrite)
813 finally:
814 f.close()
815
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000816 self.assertRaises(urllib.error.URLError,
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000817 h.file_open, Request(url))
818 finally:
819 os.remove(TESTFN)
820
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000821 h = urllib.request.FileHandler()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000822 o = h.parent = MockOpener()
823 # XXXX why does // mean ftp (and /// mean not ftp!), and where
824 # is file: scheme specified? I think this is really a bug, and
825 # what was intended was to distinguish between URLs like:
826 # file:/blah.txt (a file)
827 # file://localhost/blah.txt (a file)
828 # file:///blah.txt (a file)
829 # file://ftp.example.com/blah.txt (an ftp URL)
830 for url, ftp in [
Senthil Kumaran383c32d2010-10-14 11:57:35 +0000831 ("file://ftp.example.com//foo.txt", False),
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000832 ("file://ftp.example.com///foo.txt", False),
833# XXXX bug: fails with OSError, should be URLError
834 ("file://ftp.example.com/foo.txt", False),
Senthil Kumaran383c32d2010-10-14 11:57:35 +0000835 ("file://somehost//foo/something.txt", False),
Senthil Kumaran2ef16322010-07-11 03:12:43 +0000836 ("file://localhost//foo/something.txt", False),
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000837 ]:
838 req = Request(url)
839 try:
840 h.file_open(req)
841 # XXXX remove OSError when bug fixed
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000842 except (urllib.error.URLError, OSError):
Florent Xicluna419e3842010-08-08 16:16:07 +0000843 self.assertFalse(ftp)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000844 else:
Florent Xicluna419e3842010-08-08 16:16:07 +0000845 self.assertIs(o.req, req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000846 self.assertEqual(req.type, "ftp")
Łukasz Langad7e81cc2011-01-09 18:18:53 +0000847 self.assertEqual(req.type == "ftp", ftp)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000848
849 def test_http(self):
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000850
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000851 h = urllib.request.AbstractHTTPHandler()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000852 o = h.parent = MockOpener()
853
854 url = "http://example.com/"
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000855 for method, data in [("GET", None), ("POST", b"blah")]:
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000856 req = Request(url, data, {"Foo": "bar"})
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000857 req.timeout = None
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000858 req.add_unredirected_header("Spam", "eggs")
859 http = MockHTTPClass()
860 r = h.do_open(http, req)
861
862 # result attributes
863 r.read; r.readline # wrapped MockFile methods
864 r.info; r.geturl # addinfourl methods
865 r.code, r.msg == 200, "OK" # added from MockHTTPClass.getreply()
866 hdrs = r.info()
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000867 hdrs.get; hdrs.__contains__ # r.info() gives dict from .getreply()
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000868 self.assertEqual(r.geturl(), url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000869
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000870 self.assertEqual(http.host, "example.com")
871 self.assertEqual(http.level, 0)
872 self.assertEqual(http.method, method)
873 self.assertEqual(http.selector, "/")
874 self.assertEqual(http.req_headers,
Jeremy Hyltonb3ee6f92004-02-24 19:40:35 +0000875 [("Connection", "close"),
876 ("Foo", "bar"), ("Spam", "eggs")])
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000877 self.assertEqual(http.data, data)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000878
Andrew Svetlov0832af62012-12-18 23:10:48 +0200879 # check OSError converted to URLError
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000880 http.raise_on_endheaders = True
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000881 self.assertRaises(urllib.error.URLError, h.do_open, http, req)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000882
Senthil Kumaran29333122011-02-11 11:25:47 +0000883 # Check for TypeError on POST data which is str.
884 req = Request("http://example.com/","badpost")
885 self.assertRaises(TypeError, h.do_request_, req)
886
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000887 # check adding of standard headers
888 o.addheaders = [("Spam", "eggs")]
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000889 for data in b"", None: # POST, GET
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000890 req = Request("http://example.com/", data)
891 r = MockResponse(200, "OK", {}, "")
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000892 newreq = h.do_request_(req)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000893 if data is None: # GET
Benjamin Peterson577473f2010-01-19 00:09:57 +0000894 self.assertNotIn("Content-length", req.unredirected_hdrs)
895 self.assertNotIn("Content-type", req.unredirected_hdrs)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000896 else: # POST
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000897 self.assertEqual(req.unredirected_hdrs["Content-length"], "0")
898 self.assertEqual(req.unredirected_hdrs["Content-type"],
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000899 "application/x-www-form-urlencoded")
900 # XXX the details of Host could be better tested
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000901 self.assertEqual(req.unredirected_hdrs["Host"], "example.com")
902 self.assertEqual(req.unredirected_hdrs["Spam"], "eggs")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000903
904 # don't clobber existing headers
905 req.add_unredirected_header("Content-length", "foo")
906 req.add_unredirected_header("Content-type", "bar")
907 req.add_unredirected_header("Host", "baz")
908 req.add_unredirected_header("Spam", "foo")
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000909 newreq = h.do_request_(req)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000910 self.assertEqual(req.unredirected_hdrs["Content-length"], "foo")
911 self.assertEqual(req.unredirected_hdrs["Content-type"], "bar")
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000912 self.assertEqual(req.unredirected_hdrs["Host"], "baz")
913 self.assertEqual(req.unredirected_hdrs["Spam"], "foo")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000914
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000915 def test_http_body_file(self):
Martin Panteref91bb22016-08-27 01:39:26 +0000916 # A regular file - chunked encoding is used unless Content Length is
917 # already set.
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000918
919 h = urllib.request.AbstractHTTPHandler()
920 o = h.parent = MockOpener()
921
922 file_obj = tempfile.NamedTemporaryFile(mode='w+b', delete=False)
923 file_path = file_obj.name
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000924 file_obj.close()
Martin Panteref91bb22016-08-27 01:39:26 +0000925 self.addCleanup(os.unlink, file_path)
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000926
Martin Panteref91bb22016-08-27 01:39:26 +0000927 with open(file_path, "rb") as f:
928 req = Request("http://example.com/", f, {})
929 newreq = h.do_request_(req)
930 te = newreq.get_header('Transfer-encoding')
931 self.assertEqual(te, "chunked")
932 self.assertFalse(newreq.has_header('Content-length'))
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000933
Martin Panteref91bb22016-08-27 01:39:26 +0000934 with open(file_path, "rb") as f:
935 req = Request("http://example.com/", f, {"Content-Length": 30})
936 newreq = h.do_request_(req)
937 self.assertEqual(int(newreq.get_header('Content-length')), 30)
938 self.assertFalse(newreq.has_header("Transfer-encoding"))
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000939
940 def test_http_body_fileobj(self):
Martin Panteref91bb22016-08-27 01:39:26 +0000941 # A file object - chunked encoding is used
942 # unless Content Length is already set.
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000943 # (Note that there are some subtle differences to a regular
944 # file, that is why we are testing both cases.)
945
946 h = urllib.request.AbstractHTTPHandler()
947 o = h.parent = MockOpener()
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000948 file_obj = io.BytesIO()
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000949
Martin Panteref91bb22016-08-27 01:39:26 +0000950 req = Request("http://example.com/", file_obj, {})
951 newreq = h.do_request_(req)
952 self.assertEqual(newreq.get_header('Transfer-encoding'), 'chunked')
953 self.assertFalse(newreq.has_header('Content-length'))
954
955 headers = {"Content-Length": 30}
956 req = Request("http://example.com/", file_obj, headers)
957 newreq = h.do_request_(req)
958 self.assertEqual(int(newreq.get_header('Content-length')), 30)
959 self.assertFalse(newreq.has_header("Transfer-encoding"))
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000960
961 file_obj.close()
962
963 def test_http_body_pipe(self):
964 # A file reading from a pipe.
965 # A pipe cannot be seek'ed. There is no way to determine the
966 # content length up front. Thus, do_request_() should fall
967 # back to Transfer-encoding chunked.
968
969 h = urllib.request.AbstractHTTPHandler()
970 o = h.parent = MockOpener()
971
Martin Panteref91bb22016-08-27 01:39:26 +0000972 cmd = [sys.executable, "-c", r"pass"]
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000973 for headers in {}, {"Content-Length": 30}:
974 with subprocess.Popen(cmd, stdout=subprocess.PIPE) as proc:
975 req = Request("http://example.com/", proc.stdout, headers)
976 newreq = h.do_request_(req)
977 if not headers:
978 self.assertEqual(newreq.get_header('Content-length'), None)
979 self.assertEqual(newreq.get_header('Transfer-encoding'),
980 'chunked')
981 else:
982 self.assertEqual(int(newreq.get_header('Content-length')),
983 30)
984
985 def test_http_body_iterable(self):
986 # Generic iterable. There is no way to determine the content
987 # length up front. Fall back to Transfer-encoding chunked.
988
989 h = urllib.request.AbstractHTTPHandler()
990 o = h.parent = MockOpener()
991
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000992 def iterable_body():
993 yield b"one"
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000994
995 for headers in {}, {"Content-Length": 11}:
996 req = Request("http://example.com/", iterable_body(), headers)
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000997 newreq = h.do_request_(req)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000998 if not headers:
Martin Panter3c0d0ba2016-08-24 06:33:33 +0000999 self.assertEqual(newreq.get_header('Content-length'), None)
1000 self.assertEqual(newreq.get_header('Transfer-encoding'),
1001 'chunked')
Senthil Kumaran7bc0d872010-12-19 10:49:52 +00001002 else:
Martin Panter3c0d0ba2016-08-24 06:33:33 +00001003 self.assertEqual(int(newreq.get_header('Content-length')), 11)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +00001004
Martin Panteref91bb22016-08-27 01:39:26 +00001005 def test_http_body_empty_seq(self):
1006 # Zero-length iterable body should be treated like any other iterable
1007 h = urllib.request.AbstractHTTPHandler()
1008 h.parent = MockOpener()
1009 req = h.do_request_(Request("http://example.com/", ()))
1010 self.assertEqual(req.get_header("Transfer-encoding"), "chunked")
1011 self.assertFalse(req.has_header("Content-length"))
1012
Martin Panter3c0d0ba2016-08-24 06:33:33 +00001013 def test_http_body_array(self):
Senthil Kumaran7bc0d872010-12-19 10:49:52 +00001014 # array.array Iterable - Content Length is calculated
1015
Martin Panter3c0d0ba2016-08-24 06:33:33 +00001016 h = urllib.request.AbstractHTTPHandler()
1017 o = h.parent = MockOpener()
1018
Senthil Kumaran7bc0d872010-12-19 10:49:52 +00001019 iterable_array = array.array("I",[1,2,3,4])
1020
1021 for headers in {}, {"Content-Length": 16}:
1022 req = Request("http://example.com/", iterable_array, headers)
1023 newreq = h.do_request_(req)
1024 self.assertEqual(int(newreq.get_header('Content-length')),16)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +00001025
Senthil Kumaran9642eed2016-05-13 01:32:42 -07001026 def test_http_handler_debuglevel(self):
1027 o = OpenerDirector()
1028 h = MockHTTPSHandler(debuglevel=1)
1029 o.add_handler(h)
1030 o.open("https://www.example.com")
1031 self.assertEqual(h._debuglevel, 1)
1032
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001033 def test_http_doubleslash(self):
1034 # Checks the presence of any unnecessary double slash in url does not
1035 # break anything. Previously, a double slash directly after the host
Ezio Melottie130a522011-10-19 10:58:56 +03001036 # could cause incorrect parsing.
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001037 h = urllib.request.AbstractHTTPHandler()
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001038 h.parent = MockOpener()
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001039
Senthil Kumaran7bc0d872010-12-19 10:49:52 +00001040 data = b""
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001041 ds_urls = [
1042 "http://example.com/foo/bar/baz.html",
1043 "http://example.com//foo/bar/baz.html",
1044 "http://example.com/foo//bar/baz.html",
1045 "http://example.com/foo/bar//baz.html"
1046 ]
1047
1048 for ds_url in ds_urls:
1049 ds_req = Request(ds_url, data)
1050
1051 # Check whether host is determined correctly if there is no proxy
1052 np_ds_req = h.do_request_(ds_req)
Facundo Batista244afcf2015-04-22 18:35:54 -03001053 self.assertEqual(np_ds_req.unredirected_hdrs["Host"], "example.com")
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001054
1055 # Check whether host is determined correctly if there is a proxy
Facundo Batista244afcf2015-04-22 18:35:54 -03001056 ds_req.set_proxy("someproxy:3128", None)
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001057 p_ds_req = h.do_request_(ds_req)
Facundo Batista244afcf2015-04-22 18:35:54 -03001058 self.assertEqual(p_ds_req.unredirected_hdrs["Host"], "example.com")
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001059
Senthil Kumaran52380922013-04-25 05:45:48 -07001060 def test_full_url_setter(self):
1061 # Checks to ensure that components are set correctly after setting the
1062 # full_url of a Request object
1063
1064 urls = [
1065 'http://example.com?foo=bar#baz',
1066 'http://example.com?foo=bar&spam=eggs#bash',
1067 'http://example.com',
1068 ]
1069
1070 # testing a reusable request instance, but the url parameter is
1071 # required, so just use a dummy one to instantiate
1072 r = Request('http://example.com')
1073 for url in urls:
1074 r.full_url = url
Senthil Kumaran83070752013-05-24 09:14:12 -07001075 parsed = urlparse(url)
1076
Senthil Kumaran52380922013-04-25 05:45:48 -07001077 self.assertEqual(r.get_full_url(), url)
Senthil Kumaran83070752013-05-24 09:14:12 -07001078 # full_url setter uses splittag to split into components.
1079 # splittag sets the fragment as None while urlparse sets it to ''
1080 self.assertEqual(r.fragment or '', parsed.fragment)
1081 self.assertEqual(urlparse(r.get_full_url()).query, parsed.query)
Senthil Kumaran52380922013-04-25 05:45:48 -07001082
1083 def test_full_url_deleter(self):
1084 r = Request('http://www.example.com')
1085 del r.full_url
1086 self.assertIsNone(r.full_url)
1087 self.assertIsNone(r.fragment)
1088 self.assertEqual(r.selector, '')
1089
Senthil Kumaranc2958622010-11-22 04:48:26 +00001090 def test_fixpath_in_weirdurls(self):
1091 # Issue4493: urllib2 to supply '/' when to urls where path does not
1092 # start with'/'
1093
1094 h = urllib.request.AbstractHTTPHandler()
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001095 h.parent = MockOpener()
Senthil Kumaranc2958622010-11-22 04:48:26 +00001096
1097 weird_url = 'http://www.python.org?getspam'
1098 req = Request(weird_url)
1099 newreq = h.do_request_(req)
Facundo Batista244afcf2015-04-22 18:35:54 -03001100 self.assertEqual(newreq.host, 'www.python.org')
1101 self.assertEqual(newreq.selector, '/?getspam')
Senthil Kumaranc2958622010-11-22 04:48:26 +00001102
1103 url_without_path = 'http://www.python.org'
1104 req = Request(url_without_path)
1105 newreq = h.do_request_(req)
Facundo Batista244afcf2015-04-22 18:35:54 -03001106 self.assertEqual(newreq.host, 'www.python.org')
1107 self.assertEqual(newreq.selector, '')
Facundo Batista72dc1ea2008-08-16 14:44:32 +00001108
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001109 def test_errors(self):
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001110 h = urllib.request.HTTPErrorProcessor()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001111 o = h.parent = MockOpener()
1112
1113 url = "http://example.com/"
1114 req = Request(url)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001115 # all 2xx are passed through
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001116 r = MockResponse(200, "OK", {}, "", url)
1117 newr = h.http_response(req, r)
Florent Xicluna419e3842010-08-08 16:16:07 +00001118 self.assertIs(r, newr)
1119 self.assertFalse(hasattr(o, "proto")) # o.error not called
Guido van Rossumd8faa362007-04-27 19:54:29 +00001120 r = MockResponse(202, "Accepted", {}, "", url)
1121 newr = h.http_response(req, r)
Florent Xicluna419e3842010-08-08 16:16:07 +00001122 self.assertIs(r, newr)
1123 self.assertFalse(hasattr(o, "proto")) # o.error not called
Guido van Rossumd8faa362007-04-27 19:54:29 +00001124 r = MockResponse(206, "Partial content", {}, "", url)
1125 newr = h.http_response(req, r)
Florent Xicluna419e3842010-08-08 16:16:07 +00001126 self.assertIs(r, newr)
1127 self.assertFalse(hasattr(o, "proto")) # o.error not called
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001128 # anything else calls o.error (and MockOpener returns None, here)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001129 r = MockResponse(502, "Bad gateway", {}, "", url)
Florent Xicluna419e3842010-08-08 16:16:07 +00001130 self.assertIsNone(h.http_response(req, r))
Jeremy Hyltondf38ea92003-12-17 20:42:38 +00001131 self.assertEqual(o.proto, "http") # o.error called
Guido van Rossumd8faa362007-04-27 19:54:29 +00001132 self.assertEqual(o.args, (req, r, 502, "Bad gateway", {}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001133
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001134 def test_cookies(self):
1135 cj = MockCookieJar()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001136 h = urllib.request.HTTPCookieProcessor(cj)
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001137 h.parent = MockOpener()
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001138
1139 req = Request("http://example.com/")
1140 r = MockResponse(200, "OK", {}, "")
1141 newreq = h.http_request(req)
Florent Xicluna419e3842010-08-08 16:16:07 +00001142 self.assertIs(cj.ach_req, req)
1143 self.assertIs(cj.ach_req, newreq)
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001144 self.assertEqual(req.origin_req_host, "example.com")
1145 self.assertFalse(req.unverifiable)
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001146 newr = h.http_response(req, r)
Florent Xicluna419e3842010-08-08 16:16:07 +00001147 self.assertIs(cj.ec_req, req)
1148 self.assertIs(cj.ec_r, r)
1149 self.assertIs(r, newr)
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001150
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001151 def test_redirect(self):
1152 from_url = "http://example.com/a.html"
1153 to_url = "http://example.com/b.html"
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001154 h = urllib.request.HTTPRedirectHandler()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001155 o = h.parent = MockOpener()
1156
1157 # ordinary redirect behaviour
1158 for code in 301, 302, 303, 307:
1159 for data in None, "blah\nblah\n":
1160 method = getattr(h, "http_error_%s" % code)
1161 req = Request(from_url, data)
Senthil Kumaranfb8cc2f2009-07-19 02:44:19 +00001162 req.timeout = socket._GLOBAL_DEFAULT_TIMEOUT
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001163 req.add_header("Nonsense", "viking=withhold")
Christian Heimes77c02eb2008-02-09 02:18:51 +00001164 if data is not None:
1165 req.add_header("Content-Length", str(len(data)))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001166 req.add_unredirected_header("Spam", "spam")
1167 try:
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001168 method(req, MockFile(), code, "Blah",
1169 MockHeaders({"location": to_url}))
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001170 except urllib.error.HTTPError:
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001171 # 307 in response to POST requires user OK
Serhiy Storchaka25d8aea2014-02-08 14:50:08 +02001172 self.assertEqual(code, 307)
1173 self.assertIsNotNone(data)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +00001174 self.assertEqual(o.req.get_full_url(), to_url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001175 try:
Jeremy Hyltondf38ea92003-12-17 20:42:38 +00001176 self.assertEqual(o.req.get_method(), "GET")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001177 except AttributeError:
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001178 self.assertFalse(o.req.data)
Christian Heimes77c02eb2008-02-09 02:18:51 +00001179
1180 # now it's a GET, there should not be headers regarding content
1181 # (possibly dragged from before being a POST)
1182 headers = [x.lower() for x in o.req.headers]
Benjamin Peterson577473f2010-01-19 00:09:57 +00001183 self.assertNotIn("content-length", headers)
1184 self.assertNotIn("content-type", headers)
Christian Heimes77c02eb2008-02-09 02:18:51 +00001185
Jeremy Hyltondf38ea92003-12-17 20:42:38 +00001186 self.assertEqual(o.req.headers["Nonsense"],
1187 "viking=withhold")
Benjamin Peterson577473f2010-01-19 00:09:57 +00001188 self.assertNotIn("Spam", o.req.headers)
1189 self.assertNotIn("Spam", o.req.unredirected_hdrs)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001190
1191 # loop detection
1192 req = Request(from_url)
Senthil Kumaranfb8cc2f2009-07-19 02:44:19 +00001193 req.timeout = socket._GLOBAL_DEFAULT_TIMEOUT
Facundo Batista244afcf2015-04-22 18:35:54 -03001194
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001195 def redirect(h, req, url=to_url):
1196 h.http_error_302(req, MockFile(), 302, "Blah",
1197 MockHeaders({"location": url}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001198 # Note that the *original* request shares the same record of
1199 # redirections with the sub-requests caused by the redirections.
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001200
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001201 # detect infinite loop redirect of a URL to itself
1202 req = Request(from_url, origin_req_host="example.com")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001203 count = 0
Senthil Kumaranfb8cc2f2009-07-19 02:44:19 +00001204 req.timeout = socket._GLOBAL_DEFAULT_TIMEOUT
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001205 try:
1206 while 1:
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001207 redirect(h, req, "http://example.com/")
1208 count = count + 1
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001209 except urllib.error.HTTPError:
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001210 # don't stop until max_repeats, because cookies may introduce state
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001211 self.assertEqual(count, urllib.request.HTTPRedirectHandler.max_repeats)
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001212
1213 # detect endless non-repeating chain of redirects
1214 req = Request(from_url, origin_req_host="example.com")
1215 count = 0
Senthil Kumaranfb8cc2f2009-07-19 02:44:19 +00001216 req.timeout = socket._GLOBAL_DEFAULT_TIMEOUT
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001217 try:
1218 while 1:
1219 redirect(h, req, "http://example.com/%d" % count)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001220 count = count + 1
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001221 except urllib.error.HTTPError:
Jeremy Hyltondf38ea92003-12-17 20:42:38 +00001222 self.assertEqual(count,
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001223 urllib.request.HTTPRedirectHandler.max_redirections)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001224
guido@google.coma119df92011-03-29 11:41:02 -07001225 def test_invalid_redirect(self):
1226 from_url = "http://example.com/a.html"
1227 valid_schemes = ['http','https','ftp']
1228 invalid_schemes = ['file','imap','ldap']
1229 schemeless_url = "example.com/b.html"
1230 h = urllib.request.HTTPRedirectHandler()
1231 o = h.parent = MockOpener()
1232 req = Request(from_url)
1233 req.timeout = socket._GLOBAL_DEFAULT_TIMEOUT
1234
1235 for scheme in invalid_schemes:
1236 invalid_url = scheme + '://' + schemeless_url
1237 self.assertRaises(urllib.error.HTTPError, h.http_error_302,
1238 req, MockFile(), 302, "Security Loophole",
1239 MockHeaders({"location": invalid_url}))
1240
1241 for scheme in valid_schemes:
1242 valid_url = scheme + '://' + schemeless_url
1243 h.http_error_302(req, MockFile(), 302, "That's fine",
1244 MockHeaders({"location": valid_url}))
1245 self.assertEqual(o.req.get_full_url(), valid_url)
1246
Senthil Kumaran6497aa32012-01-04 13:46:59 +08001247 def test_relative_redirect(self):
1248 from_url = "http://example.com/a.html"
1249 relative_url = "/b.html"
1250 h = urllib.request.HTTPRedirectHandler()
1251 o = h.parent = MockOpener()
1252 req = Request(from_url)
1253 req.timeout = socket._GLOBAL_DEFAULT_TIMEOUT
1254
1255 valid_url = urllib.parse.urljoin(from_url,relative_url)
1256 h.http_error_302(req, MockFile(), 302, "That's fine",
1257 MockHeaders({"location": valid_url}))
1258 self.assertEqual(o.req.get_full_url(), valid_url)
1259
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001260 def test_cookie_redirect(self):
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001261 # cookies shouldn't leak into redirected requests
Georg Brandl24420152008-05-26 16:32:26 +00001262 from http.cookiejar import CookieJar
1263 from test.test_http_cookiejar import interact_netscape
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001264
1265 cj = CookieJar()
1266 interact_netscape(cj, "http://www.example.com/", "spam=eggs")
Thomas Wouters477c8d52006-05-27 19:21:47 +00001267 hh = MockHTTPHandler(302, "Location: http://www.cracker.com/\r\n\r\n")
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001268 hdeh = urllib.request.HTTPDefaultErrorHandler()
1269 hrh = urllib.request.HTTPRedirectHandler()
1270 cp = urllib.request.HTTPCookieProcessor(cj)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001271 o = build_test_opener(hh, hdeh, hrh, cp)
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001272 o.open("http://www.example.com/")
Florent Xicluna419e3842010-08-08 16:16:07 +00001273 self.assertFalse(hh.req.has_header("Cookie"))
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001274
Senthil Kumaran26430412011-04-13 07:01:19 +08001275 def test_redirect_fragment(self):
1276 redirected_url = 'http://www.example.com/index.html#OK\r\n\r\n'
1277 hh = MockHTTPHandler(302, 'Location: ' + redirected_url)
1278 hdeh = urllib.request.HTTPDefaultErrorHandler()
1279 hrh = urllib.request.HTTPRedirectHandler()
1280 o = build_test_opener(hh, hdeh, hrh)
1281 fp = o.open('http://www.example.com')
1282 self.assertEqual(fp.geturl(), redirected_url.strip())
1283
Martin Panterce6e0682016-05-16 01:07:13 +00001284 def test_redirect_no_path(self):
1285 # Issue 14132: Relative redirect strips original path
1286 real_class = http.client.HTTPConnection
1287 response1 = b"HTTP/1.1 302 Found\r\nLocation: ?query\r\n\r\n"
1288 http.client.HTTPConnection = test_urllib.fakehttp(response1)
1289 self.addCleanup(setattr, http.client, "HTTPConnection", real_class)
1290 urls = iter(("/path", "/path?query"))
1291 def request(conn, method, url, *pos, **kw):
1292 self.assertEqual(url, next(urls))
1293 real_class.request(conn, method, url, *pos, **kw)
1294 # Change response for subsequent connection
1295 conn.__class__.fakedata = b"HTTP/1.1 200 OK\r\n\r\nHello!"
1296 http.client.HTTPConnection.request = request
1297 fp = urllib.request.urlopen("http://python.org/path")
1298 self.assertEqual(fp.geturl(), "http://python.org/path?query")
1299
Martin Pantere6f06092016-05-16 01:14:20 +00001300 def test_redirect_encoding(self):
1301 # Some characters in the redirect target may need special handling,
1302 # but most ASCII characters should be treated as already encoded
1303 class Handler(urllib.request.HTTPHandler):
1304 def http_open(self, req):
1305 result = self.do_open(self.connection, req)
1306 self.last_buf = self.connection.buf
1307 # Set up a normal response for the next request
1308 self.connection = test_urllib.fakehttp(
1309 b'HTTP/1.1 200 OK\r\n'
1310 b'Content-Length: 3\r\n'
1311 b'\r\n'
1312 b'123'
1313 )
1314 return result
1315 handler = Handler()
1316 opener = urllib.request.build_opener(handler)
1317 tests = (
1318 (b'/p\xC3\xA5-dansk/', b'/p%C3%A5-dansk/'),
1319 (b'/spaced%20path/', b'/spaced%20path/'),
1320 (b'/spaced path/', b'/spaced%20path/'),
1321 (b'/?p\xC3\xA5-dansk', b'/?p%C3%A5-dansk'),
1322 )
1323 for [location, result] in tests:
1324 with self.subTest(repr(location)):
1325 handler.connection = test_urllib.fakehttp(
1326 b'HTTP/1.1 302 Redirect\r\n'
1327 b'Location: ' + location + b'\r\n'
1328 b'\r\n'
1329 )
1330 response = opener.open('http://example.com/')
1331 expected = b'GET ' + result + b' '
1332 request = handler.last_buf
1333 self.assertTrue(request.startswith(expected), repr(request))
1334
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001335 def test_proxy(self):
1336 o = OpenerDirector()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001337 ph = urllib.request.ProxyHandler(dict(http="proxy.example.com:3128"))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001338 o.add_handler(ph)
1339 meth_spec = [
1340 [("http_open", "return response")]
1341 ]
1342 handlers = add_ordered_mock_handlers(o, meth_spec)
1343
1344 req = Request("http://acme.example.com/")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001345 self.assertEqual(req.host, "acme.example.com")
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001346 o.open(req)
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001347 self.assertEqual(req.host, "proxy.example.com:3128")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001348
1349 self.assertEqual([(handlers[0], "http_open")],
1350 [tup[0:2] for tup in o.calls])
1351
Senthil Kumaran7bb04972009-10-11 04:58:55 +00001352 def test_proxy_no_proxy(self):
1353 os.environ['no_proxy'] = 'python.org'
1354 o = OpenerDirector()
1355 ph = urllib.request.ProxyHandler(dict(http="proxy.example.com"))
1356 o.add_handler(ph)
1357 req = Request("http://www.perl.org/")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001358 self.assertEqual(req.host, "www.perl.org")
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001359 o.open(req)
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001360 self.assertEqual(req.host, "proxy.example.com")
Senthil Kumaran7bb04972009-10-11 04:58:55 +00001361 req = Request("http://www.python.org")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001362 self.assertEqual(req.host, "www.python.org")
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001363 o.open(req)
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001364 self.assertEqual(req.host, "www.python.org")
Senthil Kumaran7bb04972009-10-11 04:58:55 +00001365 del os.environ['no_proxy']
1366
Ronald Oussorene72e1612011-03-14 18:15:25 -04001367 def test_proxy_no_proxy_all(self):
1368 os.environ['no_proxy'] = '*'
1369 o = OpenerDirector()
1370 ph = urllib.request.ProxyHandler(dict(http="proxy.example.com"))
1371 o.add_handler(ph)
1372 req = Request("http://www.python.org")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001373 self.assertEqual(req.host, "www.python.org")
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001374 o.open(req)
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001375 self.assertEqual(req.host, "www.python.org")
Ronald Oussorene72e1612011-03-14 18:15:25 -04001376 del os.environ['no_proxy']
1377
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001378 def test_proxy_https(self):
1379 o = OpenerDirector()
1380 ph = urllib.request.ProxyHandler(dict(https="proxy.example.com:3128"))
1381 o.add_handler(ph)
1382 meth_spec = [
1383 [("https_open", "return response")]
1384 ]
1385 handlers = add_ordered_mock_handlers(o, meth_spec)
1386
1387 req = Request("https://www.example.com/")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001388 self.assertEqual(req.host, "www.example.com")
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001389 o.open(req)
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001390 self.assertEqual(req.host, "proxy.example.com:3128")
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001391 self.assertEqual([(handlers[0], "https_open")],
1392 [tup[0:2] for tup in o.calls])
1393
Senthil Kumaran47fff872009-12-20 07:10:31 +00001394 def test_proxy_https_proxy_authorization(self):
1395 o = OpenerDirector()
1396 ph = urllib.request.ProxyHandler(dict(https='proxy.example.com:3128'))
1397 o.add_handler(ph)
1398 https_handler = MockHTTPSHandler()
1399 o.add_handler(https_handler)
1400 req = Request("https://www.example.com/")
Facundo Batista244afcf2015-04-22 18:35:54 -03001401 req.add_header("Proxy-Authorization", "FooBar")
1402 req.add_header("User-Agent", "Grail")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001403 self.assertEqual(req.host, "www.example.com")
Senthil Kumaran47fff872009-12-20 07:10:31 +00001404 self.assertIsNone(req._tunnel_host)
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001405 o.open(req)
Senthil Kumaran47fff872009-12-20 07:10:31 +00001406 # Verify Proxy-Authorization gets tunneled to request.
1407 # httpsconn req_headers do not have the Proxy-Authorization header but
1408 # the req will have.
Facundo Batista244afcf2015-04-22 18:35:54 -03001409 self.assertNotIn(("Proxy-Authorization", "FooBar"),
Senthil Kumaran47fff872009-12-20 07:10:31 +00001410 https_handler.httpconn.req_headers)
Facundo Batista244afcf2015-04-22 18:35:54 -03001411 self.assertIn(("User-Agent", "Grail"),
Ezio Melottib58e0bd2010-01-23 15:40:09 +00001412 https_handler.httpconn.req_headers)
Senthil Kumaran47fff872009-12-20 07:10:31 +00001413 self.assertIsNotNone(req._tunnel_host)
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001414 self.assertEqual(req.host, "proxy.example.com:3128")
Facundo Batista244afcf2015-04-22 18:35:54 -03001415 self.assertEqual(req.get_header("Proxy-authorization"), "FooBar")
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001416
Senthil Kumaran4de00a22011-05-11 21:17:57 +08001417 # TODO: This should be only for OSX
1418 @unittest.skipUnless(sys.platform == 'darwin', "only relevant for OSX")
Ronald Oussorene72e1612011-03-14 18:15:25 -04001419 def test_osx_proxy_bypass(self):
1420 bypass = {
1421 'exclude_simple': False,
1422 'exceptions': ['foo.bar', '*.bar.com', '127.0.0.1', '10.10',
1423 '10.0/16']
1424 }
1425 # Check hosts that should trigger the proxy bypass
1426 for host in ('foo.bar', 'www.bar.com', '127.0.0.1', '10.10.0.1',
1427 '10.0.0.1'):
1428 self.assertTrue(_proxy_bypass_macosx_sysconf(host, bypass),
1429 'expected bypass of %s to be True' % host)
1430 # Check hosts that should not trigger the proxy bypass
R David Murrayfdbe9182014-03-15 12:00:14 -04001431 for host in ('abc.foo.bar', 'bar.com', '127.0.0.2', '10.11.0.1',
1432 'notinbypass'):
Ronald Oussorene72e1612011-03-14 18:15:25 -04001433 self.assertFalse(_proxy_bypass_macosx_sysconf(host, bypass),
1434 'expected bypass of %s to be False' % host)
1435
1436 # Check the exclude_simple flag
1437 bypass = {'exclude_simple': True, 'exceptions': []}
1438 self.assertTrue(_proxy_bypass_macosx_sysconf('test', bypass))
1439
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001440 def test_basic_auth(self, quote_char='"'):
Thomas Wouters477c8d52006-05-27 19:21:47 +00001441 opener = OpenerDirector()
1442 password_manager = MockPasswordManager()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001443 auth_handler = urllib.request.HTTPBasicAuthHandler(password_manager)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001444 realm = "ACME Widget Store"
1445 http_handler = MockHTTPHandler(
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001446 401, 'WWW-Authenticate: Basic realm=%s%s%s\r\n\r\n' %
Facundo Batista244afcf2015-04-22 18:35:54 -03001447 (quote_char, realm, quote_char))
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001448 opener.add_handler(auth_handler)
1449 opener.add_handler(http_handler)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001450 self._test_basic_auth(opener, auth_handler, "Authorization",
1451 realm, http_handler, password_manager,
1452 "http://acme.example.com/protected",
1453 "http://acme.example.com/protected",
1454 )
1455
Christian Heimes4fbc72b2008-03-22 00:47:35 +00001456 def test_basic_auth_with_single_quoted_realm(self):
1457 self.test_basic_auth(quote_char="'")
1458
Senthil Kumaran34f3fcc2012-05-15 22:30:25 +08001459 def test_basic_auth_with_unquoted_realm(self):
1460 opener = OpenerDirector()
1461 password_manager = MockPasswordManager()
1462 auth_handler = urllib.request.HTTPBasicAuthHandler(password_manager)
1463 realm = "ACME Widget Store"
1464 http_handler = MockHTTPHandler(
1465 401, 'WWW-Authenticate: Basic realm=%s\r\n\r\n' % realm)
1466 opener.add_handler(auth_handler)
1467 opener.add_handler(http_handler)
Senthil Kumaran0ea91cb2012-05-15 23:59:42 +08001468 with self.assertWarns(UserWarning):
1469 self._test_basic_auth(opener, auth_handler, "Authorization",
1470 realm, http_handler, password_manager,
1471 "http://acme.example.com/protected",
1472 "http://acme.example.com/protected",
1473 )
Senthil Kumaran34f3fcc2012-05-15 22:30:25 +08001474
Thomas Wouters477c8d52006-05-27 19:21:47 +00001475 def test_proxy_basic_auth(self):
1476 opener = OpenerDirector()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001477 ph = urllib.request.ProxyHandler(dict(http="proxy.example.com:3128"))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001478 opener.add_handler(ph)
1479 password_manager = MockPasswordManager()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001480 auth_handler = urllib.request.ProxyBasicAuthHandler(password_manager)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001481 realm = "ACME Networks"
1482 http_handler = MockHTTPHandler(
1483 407, 'Proxy-Authenticate: Basic realm="%s"\r\n\r\n' % realm)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001484 opener.add_handler(auth_handler)
1485 opener.add_handler(http_handler)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001486 self._test_basic_auth(opener, auth_handler, "Proxy-authorization",
Thomas Wouters477c8d52006-05-27 19:21:47 +00001487 realm, http_handler, password_manager,
1488 "http://acme.example.com:3128/protected",
1489 "proxy.example.com:3128",
1490 )
1491
1492 def test_basic_and_digest_auth_handlers(self):
Andrew Svetlov7bd61cb2012-12-19 22:49:25 +02001493 # HTTPDigestAuthHandler raised an exception if it couldn't handle a 40*
Thomas Wouters477c8d52006-05-27 19:21:47 +00001494 # response (http://python.org/sf/1479302), where it should instead
1495 # return None to allow another handler (especially
1496 # HTTPBasicAuthHandler) to handle the response.
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001497
1498 # Also (http://python.org/sf/14797027, RFC 2617 section 1.2), we must
1499 # try digest first (since it's the strongest auth scheme), so we record
1500 # order of calls here to check digest comes first:
1501 class RecordingOpenerDirector(OpenerDirector):
1502 def __init__(self):
1503 OpenerDirector.__init__(self)
1504 self.recorded = []
Facundo Batista244afcf2015-04-22 18:35:54 -03001505
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001506 def record(self, info):
1507 self.recorded.append(info)
Facundo Batista244afcf2015-04-22 18:35:54 -03001508
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001509 class TestDigestAuthHandler(urllib.request.HTTPDigestAuthHandler):
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001510 def http_error_401(self, *args, **kwds):
1511 self.parent.record("digest")
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001512 urllib.request.HTTPDigestAuthHandler.http_error_401(self,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001513 *args, **kwds)
Facundo Batista244afcf2015-04-22 18:35:54 -03001514
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001515 class TestBasicAuthHandler(urllib.request.HTTPBasicAuthHandler):
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001516 def http_error_401(self, *args, **kwds):
1517 self.parent.record("basic")
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001518 urllib.request.HTTPBasicAuthHandler.http_error_401(self,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001519 *args, **kwds)
1520
1521 opener = RecordingOpenerDirector()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001522 password_manager = MockPasswordManager()
1523 digest_handler = TestDigestAuthHandler(password_manager)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001524 basic_handler = TestBasicAuthHandler(password_manager)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001525 realm = "ACME Networks"
1526 http_handler = MockHTTPHandler(
1527 401, 'WWW-Authenticate: Basic realm="%s"\r\n\r\n' % realm)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001528 opener.add_handler(basic_handler)
1529 opener.add_handler(digest_handler)
1530 opener.add_handler(http_handler)
1531
1532 # check basic auth isn't blocked by digest handler failing
Thomas Wouters477c8d52006-05-27 19:21:47 +00001533 self._test_basic_auth(opener, basic_handler, "Authorization",
1534 realm, http_handler, password_manager,
1535 "http://acme.example.com/protected",
1536 "http://acme.example.com/protected",
1537 )
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001538 # check digest was tried before basic (twice, because
1539 # _test_basic_auth called .open() twice)
1540 self.assertEqual(opener.recorded, ["digest", "basic"]*2)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001541
Senthil Kumaran4de00a22011-05-11 21:17:57 +08001542 def test_unsupported_auth_digest_handler(self):
1543 opener = OpenerDirector()
1544 # While using DigestAuthHandler
1545 digest_auth_handler = urllib.request.HTTPDigestAuthHandler(None)
1546 http_handler = MockHTTPHandler(
1547 401, 'WWW-Authenticate: Kerberos\r\n\r\n')
1548 opener.add_handler(digest_auth_handler)
1549 opener.add_handler(http_handler)
Facundo Batista244afcf2015-04-22 18:35:54 -03001550 self.assertRaises(ValueError, opener.open, "http://www.example.com")
Senthil Kumaran4de00a22011-05-11 21:17:57 +08001551
1552 def test_unsupported_auth_basic_handler(self):
1553 # While using BasicAuthHandler
1554 opener = OpenerDirector()
1555 basic_auth_handler = urllib.request.HTTPBasicAuthHandler(None)
1556 http_handler = MockHTTPHandler(
1557 401, 'WWW-Authenticate: NTLM\r\n\r\n')
1558 opener.add_handler(basic_auth_handler)
1559 opener.add_handler(http_handler)
Facundo Batista244afcf2015-04-22 18:35:54 -03001560 self.assertRaises(ValueError, opener.open, "http://www.example.com")
Senthil Kumaran4de00a22011-05-11 21:17:57 +08001561
Thomas Wouters477c8d52006-05-27 19:21:47 +00001562 def _test_basic_auth(self, opener, auth_handler, auth_header,
1563 realm, http_handler, password_manager,
1564 request_url, protected_url):
Christian Heimes05e8be12008-02-23 18:30:17 +00001565 import base64
Thomas Wouters477c8d52006-05-27 19:21:47 +00001566 user, password = "wile", "coyote"
Thomas Wouters477c8d52006-05-27 19:21:47 +00001567
1568 # .add_password() fed through to password manager
1569 auth_handler.add_password(realm, request_url, user, password)
1570 self.assertEqual(realm, password_manager.realm)
1571 self.assertEqual(request_url, password_manager.url)
1572 self.assertEqual(user, password_manager.user)
1573 self.assertEqual(password, password_manager.password)
1574
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001575 opener.open(request_url)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001576
1577 # should have asked the password manager for the username/password
1578 self.assertEqual(password_manager.target_realm, realm)
1579 self.assertEqual(password_manager.target_url, protected_url)
1580
1581 # expect one request without authorization, then one with
1582 self.assertEqual(len(http_handler.requests), 2)
1583 self.assertFalse(http_handler.requests[0].has_header(auth_header))
Guido van Rossum98b349f2007-08-27 21:47:52 +00001584 userpass = bytes('%s:%s' % (user, password), "ascii")
Guido van Rossum98297ee2007-11-06 21:34:58 +00001585 auth_hdr_value = ('Basic ' +
Georg Brandl706824f2009-06-04 09:42:55 +00001586 base64.encodebytes(userpass).strip().decode())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001587 self.assertEqual(http_handler.requests[1].get_header(auth_header),
1588 auth_hdr_value)
Senthil Kumaranca2fc9e2010-02-24 16:53:16 +00001589 self.assertEqual(http_handler.requests[1].unredirected_hdrs[auth_header],
1590 auth_hdr_value)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001591 # if the password manager can't find a password, the handler won't
1592 # handle the HTTP auth error
1593 password_manager.user = password_manager.password = None
1594 http_handler.reset()
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001595 opener.open(request_url)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001596 self.assertEqual(len(http_handler.requests), 1)
1597 self.assertFalse(http_handler.requests[0].has_header(auth_header))
1598
R David Murray4c7f9952015-04-16 16:36:18 -04001599 def test_basic_prior_auth_auto_send(self):
1600 # Assume already authenticated if is_authenticated=True
1601 # for APIs like Github that don't return 401
1602
1603 user, password = "wile", "coyote"
1604 request_url = "http://acme.example.com/protected"
1605
1606 http_handler = MockHTTPHandlerCheckAuth(200)
1607
1608 pwd_manager = HTTPPasswordMgrWithPriorAuth()
1609 auth_prior_handler = HTTPBasicAuthHandler(pwd_manager)
1610 auth_prior_handler.add_password(
1611 None, request_url, user, password, is_authenticated=True)
1612
1613 is_auth = pwd_manager.is_authenticated(request_url)
1614 self.assertTrue(is_auth)
1615
1616 opener = OpenerDirector()
1617 opener.add_handler(auth_prior_handler)
1618 opener.add_handler(http_handler)
1619
1620 opener.open(request_url)
1621
1622 # expect request to be sent with auth header
1623 self.assertTrue(http_handler.has_auth_header)
1624
1625 def test_basic_prior_auth_send_after_first_success(self):
1626 # Auto send auth header after authentication is successful once
1627
1628 user, password = 'wile', 'coyote'
1629 request_url = 'http://acme.example.com/protected'
1630 realm = 'ACME'
1631
1632 pwd_manager = HTTPPasswordMgrWithPriorAuth()
1633 auth_prior_handler = HTTPBasicAuthHandler(pwd_manager)
1634 auth_prior_handler.add_password(realm, request_url, user, password)
1635
1636 is_auth = pwd_manager.is_authenticated(request_url)
1637 self.assertFalse(is_auth)
1638
1639 opener = OpenerDirector()
1640 opener.add_handler(auth_prior_handler)
1641
1642 http_handler = MockHTTPHandler(
1643 401, 'WWW-Authenticate: Basic realm="%s"\r\n\r\n' % None)
1644 opener.add_handler(http_handler)
1645
1646 opener.open(request_url)
1647
1648 is_auth = pwd_manager.is_authenticated(request_url)
1649 self.assertTrue(is_auth)
1650
1651 http_handler = MockHTTPHandlerCheckAuth(200)
1652 self.assertFalse(http_handler.has_auth_header)
1653
1654 opener = OpenerDirector()
1655 opener.add_handler(auth_prior_handler)
1656 opener.add_handler(http_handler)
1657
1658 # After getting 200 from MockHTTPHandler
1659 # Next request sends header in the first request
1660 opener.open(request_url)
1661
1662 # expect request to be sent with auth header
1663 self.assertTrue(http_handler.has_auth_header)
1664
Serhiy Storchakaf54c3502014-09-06 21:41:39 +03001665 def test_http_closed(self):
1666 """Test the connection is cleaned up when the response is closed"""
1667 for (transfer, data) in (
1668 ("Connection: close", b"data"),
1669 ("Transfer-Encoding: chunked", b"4\r\ndata\r\n0\r\n\r\n"),
1670 ("Content-Length: 4", b"data"),
1671 ):
1672 header = "HTTP/1.1 200 OK\r\n{}\r\n\r\n".format(transfer)
1673 conn = test_urllib.fakehttp(header.encode() + data)
1674 handler = urllib.request.AbstractHTTPHandler()
1675 req = Request("http://dummy/")
1676 req.timeout = None
1677 with handler.do_open(conn, req) as resp:
1678 resp.read()
1679 self.assertTrue(conn.fakesock.closed,
1680 "Connection not closed with {!r}".format(transfer))
1681
1682 def test_invalid_closed(self):
1683 """Test the connection is cleaned up after an invalid response"""
1684 conn = test_urllib.fakehttp(b"")
1685 handler = urllib.request.AbstractHTTPHandler()
1686 req = Request("http://dummy/")
1687 req.timeout = None
1688 with self.assertRaises(http.client.BadStatusLine):
1689 handler.do_open(conn, req)
1690 self.assertTrue(conn.fakesock.closed, "Connection not closed")
1691
Senthil Kumaran4de00a22011-05-11 21:17:57 +08001692
Facundo Batista244afcf2015-04-22 18:35:54 -03001693
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001694class MiscTests(unittest.TestCase):
1695
Senthil Kumarane9853da2013-03-19 12:07:43 -07001696 def opener_has_handler(self, opener, handler_class):
1697 self.assertTrue(any(h.__class__ == handler_class
1698 for h in opener.handlers))
1699
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001700 def test_build_opener(self):
Facundo Batista244afcf2015-04-22 18:35:54 -03001701 class MyHTTPHandler(urllib.request.HTTPHandler):
1702 pass
1703
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001704 class FooHandler(urllib.request.BaseHandler):
Facundo Batista244afcf2015-04-22 18:35:54 -03001705 def foo_open(self):
1706 pass
1707
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001708 class BarHandler(urllib.request.BaseHandler):
Facundo Batista244afcf2015-04-22 18:35:54 -03001709 def bar_open(self):
1710 pass
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001711
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001712 build_opener = urllib.request.build_opener
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001713
1714 o = build_opener(FooHandler, BarHandler)
1715 self.opener_has_handler(o, FooHandler)
1716 self.opener_has_handler(o, BarHandler)
1717
1718 # can take a mix of classes and instances
1719 o = build_opener(FooHandler, BarHandler())
1720 self.opener_has_handler(o, FooHandler)
1721 self.opener_has_handler(o, BarHandler)
1722
1723 # subclasses of default handlers override default handlers
1724 o = build_opener(MyHTTPHandler)
1725 self.opener_has_handler(o, MyHTTPHandler)
1726
1727 # a particular case of overriding: default handlers can be passed
1728 # in explicitly
1729 o = build_opener()
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001730 self.opener_has_handler(o, urllib.request.HTTPHandler)
1731 o = build_opener(urllib.request.HTTPHandler)
1732 self.opener_has_handler(o, urllib.request.HTTPHandler)
1733 o = build_opener(urllib.request.HTTPHandler())
1734 self.opener_has_handler(o, urllib.request.HTTPHandler)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001735
Christian Heimes81ee3ef2008-05-04 22:42:01 +00001736 # Issue2670: multiple handlers sharing the same base class
Facundo Batista244afcf2015-04-22 18:35:54 -03001737 class MyOtherHTTPHandler(urllib.request.HTTPHandler):
1738 pass
1739
Christian Heimes81ee3ef2008-05-04 22:42:01 +00001740 o = build_opener(MyHTTPHandler, MyOtherHTTPHandler)
1741 self.opener_has_handler(o, MyHTTPHandler)
1742 self.opener_has_handler(o, MyOtherHTTPHandler)
1743
Brett Cannon80512de2013-01-25 22:27:21 -05001744 @unittest.skipUnless(support.is_resource_enabled('network'),
1745 'test requires network access')
Andrew Svetlovbff98fe2012-11-27 23:06:19 +02001746 def test_issue16464(self):
Berker Peksagbcdfc6a2015-03-02 06:01:01 +02001747 with support.transient_internet("http://www.example.com/"):
1748 opener = urllib.request.build_opener()
1749 request = urllib.request.Request("http://www.example.com/")
1750 self.assertEqual(None, request.data)
Andrew Svetlovbff98fe2012-11-27 23:06:19 +02001751
Berker Peksagbcdfc6a2015-03-02 06:01:01 +02001752 opener.open(request, "1".encode("us-ascii"))
1753 self.assertEqual(b"1", request.data)
1754 self.assertEqual("1", request.get_header("Content-length"))
Andrew Svetlovbff98fe2012-11-27 23:06:19 +02001755
Berker Peksagbcdfc6a2015-03-02 06:01:01 +02001756 opener.open(request, "1234567890".encode("us-ascii"))
1757 self.assertEqual(b"1234567890", request.data)
1758 self.assertEqual("10", request.get_header("Content-length"))
Andrew Svetlovbff98fe2012-11-27 23:06:19 +02001759
Senthil Kumarane9853da2013-03-19 12:07:43 -07001760 def test_HTTPError_interface(self):
1761 """
1762 Issue 13211 reveals that HTTPError didn't implement the URLError
1763 interface even though HTTPError is a subclass of URLError.
Senthil Kumarane9853da2013-03-19 12:07:43 -07001764 """
Senthil Kumaranfa1b02a2013-04-08 22:24:17 -07001765 msg = 'something bad happened'
1766 url = code = fp = None
1767 hdrs = 'Content-Length: 42'
1768 err = urllib.error.HTTPError(url, code, msg, hdrs, fp)
1769 self.assertTrue(hasattr(err, 'reason'))
1770 self.assertEqual(err.reason, 'something bad happened')
1771 self.assertTrue(hasattr(err, 'headers'))
1772 self.assertEqual(err.headers, 'Content-Length: 42')
1773 expected_errmsg = 'HTTP Error %s: %s' % (err.code, err.msg)
1774 self.assertEqual(str(err), expected_errmsg)
Facundo Batista244afcf2015-04-22 18:35:54 -03001775 expected_errmsg = '<HTTPError %s: %r>' % (err.code, err.msg)
1776 self.assertEqual(repr(err), expected_errmsg)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001777
Senthil Kumarand8e24f12014-04-14 16:32:20 -04001778 def test_parse_proxy(self):
1779 parse_proxy_test_cases = [
1780 ('proxy.example.com',
1781 (None, None, None, 'proxy.example.com')),
1782 ('proxy.example.com:3128',
1783 (None, None, None, 'proxy.example.com:3128')),
1784 ('proxy.example.com', (None, None, None, 'proxy.example.com')),
1785 ('proxy.example.com:3128',
1786 (None, None, None, 'proxy.example.com:3128')),
1787 # The authority component may optionally include userinfo
1788 # (assumed to be # username:password):
1789 ('joe:password@proxy.example.com',
1790 (None, 'joe', 'password', 'proxy.example.com')),
1791 ('joe:password@proxy.example.com:3128',
1792 (None, 'joe', 'password', 'proxy.example.com:3128')),
1793 #Examples with URLS
1794 ('http://proxy.example.com/',
1795 ('http', None, None, 'proxy.example.com')),
1796 ('http://proxy.example.com:3128/',
1797 ('http', None, None, 'proxy.example.com:3128')),
1798 ('http://joe:password@proxy.example.com/',
1799 ('http', 'joe', 'password', 'proxy.example.com')),
1800 ('http://joe:password@proxy.example.com:3128',
1801 ('http', 'joe', 'password', 'proxy.example.com:3128')),
1802 # Everything after the authority is ignored
1803 ('ftp://joe:password@proxy.example.com/rubbish:3128',
1804 ('ftp', 'joe', 'password', 'proxy.example.com')),
1805 # Test for no trailing '/' case
1806 ('http://joe:password@proxy.example.com',
1807 ('http', 'joe', 'password', 'proxy.example.com'))
1808 ]
1809
1810 for tc, expected in parse_proxy_test_cases:
1811 self.assertEqual(_parse_proxy(tc), expected)
1812
1813 self.assertRaises(ValueError, _parse_proxy, 'file:/ftp.example.com'),
1814
Berker Peksage88dd1c2016-03-06 16:16:40 +02001815 def test_unsupported_algorithm(self):
1816 handler = AbstractDigestAuthHandler()
1817 with self.assertRaises(ValueError) as exc:
1818 handler.get_algorithm_impls('invalid')
1819 self.assertEqual(
1820 str(exc.exception),
1821 "Unsupported digest authentication algorithm 'invalid'"
1822 )
1823
Facundo Batista244afcf2015-04-22 18:35:54 -03001824
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001825class RequestTests(unittest.TestCase):
Jason R. Coombs4a652422013-09-08 13:03:40 -04001826 class PutRequest(Request):
Facundo Batista244afcf2015-04-22 18:35:54 -03001827 method = 'PUT'
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001828
1829 def setUp(self):
1830 self.get = Request("http://www.python.org/~jeremy/")
1831 self.post = Request("http://www.python.org/~jeremy/",
1832 "data",
1833 headers={"X-Test": "test"})
Jason R. Coombs4a652422013-09-08 13:03:40 -04001834 self.head = Request("http://www.python.org/~jeremy/", method='HEAD')
1835 self.put = self.PutRequest("http://www.python.org/~jeremy/")
1836 self.force_post = self.PutRequest("http://www.python.org/~jeremy/",
1837 method="POST")
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001838
1839 def test_method(self):
1840 self.assertEqual("POST", self.post.get_method())
1841 self.assertEqual("GET", self.get.get_method())
Senthil Kumaran0b5463f2013-09-09 23:13:06 -07001842 self.assertEqual("HEAD", self.head.get_method())
Jason R. Coombs4a652422013-09-08 13:03:40 -04001843 self.assertEqual("PUT", self.put.get_method())
1844 self.assertEqual("POST", self.force_post.get_method())
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001845
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001846 def test_data(self):
1847 self.assertFalse(self.get.data)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001848 self.assertEqual("GET", self.get.get_method())
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001849 self.get.data = "spam"
1850 self.assertTrue(self.get.data)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001851 self.assertEqual("POST", self.get.get_method())
1852
Andrew Svetlovbff98fe2012-11-27 23:06:19 +02001853 # issue 16464
1854 # if we change data we need to remove content-length header
1855 # (cause it's most probably calculated for previous value)
1856 def test_setting_data_should_remove_content_length(self):
R David Murray9cc7d452013-03-20 00:10:51 -04001857 self.assertNotIn("Content-length", self.get.unredirected_hdrs)
Andrew Svetlovbff98fe2012-11-27 23:06:19 +02001858 self.get.add_unredirected_header("Content-length", 42)
1859 self.assertEqual(42, self.get.unredirected_hdrs["Content-length"])
1860 self.get.data = "spam"
R David Murray9cc7d452013-03-20 00:10:51 -04001861 self.assertNotIn("Content-length", self.get.unredirected_hdrs)
1862
1863 # issue 17485 same for deleting data.
1864 def test_deleting_data_should_remove_content_length(self):
1865 self.assertNotIn("Content-length", self.get.unredirected_hdrs)
1866 self.get.data = 'foo'
1867 self.get.add_unredirected_header("Content-length", 3)
1868 self.assertEqual(3, self.get.unredirected_hdrs["Content-length"])
1869 del self.get.data
1870 self.assertNotIn("Content-length", self.get.unredirected_hdrs)
Andrew Svetlovbff98fe2012-11-27 23:06:19 +02001871
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001872 def test_get_full_url(self):
1873 self.assertEqual("http://www.python.org/~jeremy/",
1874 self.get.get_full_url())
1875
1876 def test_selector(self):
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001877 self.assertEqual("/~jeremy/", self.get.selector)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001878 req = Request("http://www.python.org/")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001879 self.assertEqual("/", req.selector)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001880
1881 def test_get_type(self):
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001882 self.assertEqual("http", self.get.type)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001883
1884 def test_get_host(self):
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001885 self.assertEqual("www.python.org", self.get.host)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001886
1887 def test_get_host_unquote(self):
1888 req = Request("http://www.%70ython.org/")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001889 self.assertEqual("www.python.org", req.host)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001890
1891 def test_proxy(self):
Florent Xicluna419e3842010-08-08 16:16:07 +00001892 self.assertFalse(self.get.has_proxy())
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001893 self.get.set_proxy("www.perl.org", "http")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001894 self.assertTrue(self.get.has_proxy())
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001895 self.assertEqual("www.python.org", self.get.origin_req_host)
1896 self.assertEqual("www.perl.org", self.get.host)
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +00001897
Senthil Kumarand95cc752010-08-08 11:27:53 +00001898 def test_wrapped_url(self):
1899 req = Request("<URL:http://www.python.org>")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001900 self.assertEqual("www.python.org", req.host)
Senthil Kumarand95cc752010-08-08 11:27:53 +00001901
Senthil Kumaran26430412011-04-13 07:01:19 +08001902 def test_url_fragment(self):
Senthil Kumarand95cc752010-08-08 11:27:53 +00001903 req = Request("http://www.python.org/?qs=query#fragment=true")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001904 self.assertEqual("/?qs=query", req.selector)
Senthil Kumarand95cc752010-08-08 11:27:53 +00001905 req = Request("http://www.python.org/#fun=true")
Senthil Kumaran77ebfcc2012-08-20 13:43:59 -07001906 self.assertEqual("/", req.selector)
Senthil Kumarand95cc752010-08-08 11:27:53 +00001907
Senthil Kumaran26430412011-04-13 07:01:19 +08001908 # Issue 11703: geturl() omits fragment in the original URL.
1909 url = 'http://docs.python.org/library/urllib2.html#OK'
1910 req = Request(url)
1911 self.assertEqual(req.get_full_url(), url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001912
Senthil Kumaran83070752013-05-24 09:14:12 -07001913 def test_url_fullurl_get_full_url(self):
1914 urls = ['http://docs.python.org',
1915 'http://docs.python.org/library/urllib2.html#OK',
Facundo Batista244afcf2015-04-22 18:35:54 -03001916 'http://www.python.org/?qs=query#fragment=true']
Senthil Kumaran83070752013-05-24 09:14:12 -07001917 for url in urls:
1918 req = Request(url)
1919 self.assertEqual(req.get_full_url(), req.full_url)
1920
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001921
1922if __name__ == "__main__":
Berker Peksagbcdfc6a2015-03-02 06:01:01 +02001923 unittest.main()