blob: 8248967226d278cb303c67140eb26aa8eb35de36 [file] [log] [blame]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00001import unittest
2from test import test_support
3
Andrew M. Kuchling85064ff2004-07-10 19:46:40 +00004import os, socket
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00005import StringIO
Jeremy Hyltone3e61042001-05-09 15:50:25 +00006
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +00007import urllib2
8from urllib2 import Request, OpenerDirector
Jeremy Hyltone3e61042001-05-09 15:50:25 +00009
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000010# XXX
11# Request
12# CacheFTPHandler (hard to write)
13# parse_keqv_list, parse_http_list (I'm leaving this for Anthony Baxter
14# and Greg Stein, since they're doing Digest Authentication)
15# Authentication stuff (ditto)
16# ProxyHandler, CustomProxy, CustomProxyHandler (I don't use a proxy)
17# GopherHandler (haven't used gopher for a decade or so...)
Jeremy Hyltone3e61042001-05-09 15:50:25 +000018
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000019class TrivialTests(unittest.TestCase):
20 def test_trivial(self):
21 # A couple trivial tests
Guido van Rossume2ae77b2001-10-24 20:42:55 +000022
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000023 self.assertRaises(ValueError, urllib2.urlopen, 'bogus url')
Tim Peters861adac2001-07-16 20:49:49 +000024
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000025 # XXX Name hacking to get this to work on Windows.
26 fname = os.path.abspath(urllib2.__file__).replace('\\', '/')
27 if fname[1:2] == ":":
28 fname = fname[2:]
29 # And more hacking to get it to work on MacOS. This assumes
30 # urllib.pathname2url works, unfortunately...
31 if os.name == 'mac':
32 fname = '/' + fname.replace(':', '/')
33 elif os.name == 'riscos':
34 import string
35 fname = os.expand(fname)
36 fname = fname.translate(string.maketrans("/.", "./"))
37
38 file_url = "file://%s" % fname
39 f = urllib2.urlopen(file_url)
40
41 buf = f.read()
42 f.close()
Tim Petersf5f32b42005-07-17 23:16:17 +000043
Georg Brandl5c5fe2f2005-07-14 06:40:47 +000044 def test_statudict(self):
45 # test the new-in-2.5 httpresponses dictionary
46 self.assertEquals(urllib2.httpresponses[404], "Not Found")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000047
Georg Brandle1b13d22005-08-24 22:20:32 +000048 def test_parse_http_list(self):
49 tests = [('a,b,c', ['a', 'b', 'c']),
50 ('path"o,l"og"i"cal, example', ['path"o,l"og"i"cal', 'example']),
51 ('a, b, "c", "d", "e,f", g, h', ['a', 'b', '"c"', '"d"', '"e,f"', 'g', 'h']),
52 ('a="b\\"c", d="e\\,f", g="h\\\\i"', ['a="b"c"', 'd="e,f"', 'g="h\\i"'])]
53 for string, list in tests:
54 self.assertEquals(urllib2.parse_http_list(string), list)
55
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000056
57class MockOpener:
58 addheaders = []
59 def open(self, req, data=None):
60 self.req, self.data = req, data
61 def error(self, proto, *args):
62 self.proto, self.args = proto, args
63
64class MockFile:
65 def read(self, count=None): pass
66 def readline(self, count=None): pass
67 def close(self): pass
68
Martin v. Löwis2a6ba902004-05-31 18:22:40 +000069class MockHeaders(dict):
70 def getheaders(self, name):
71 return self.values()
72
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000073class MockResponse(StringIO.StringIO):
74 def __init__(self, code, msg, headers, data, url=None):
75 StringIO.StringIO.__init__(self, data)
76 self.code, self.msg, self.headers, self.url = code, msg, headers, url
77 def info(self):
78 return self.headers
79 def geturl(self):
80 return self.url
81
Martin v. Löwis2a6ba902004-05-31 18:22:40 +000082class MockCookieJar:
83 def add_cookie_header(self, request):
84 self.ach_req = request
85 def extract_cookies(self, response, request):
86 self.ec_req, self.ec_r = request, response
87
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000088class FakeMethod:
89 def __init__(self, meth_name, action, handle):
90 self.meth_name = meth_name
91 self.handle = handle
92 self.action = action
93 def __call__(self, *args):
94 return self.handle(self.meth_name, self.action, *args)
95
96class MockHandler:
97 def __init__(self, methods):
98 self._define_methods(methods)
99 def _define_methods(self, methods):
100 for spec in methods:
101 if len(spec) == 2: name, action = spec
102 else: name, action = spec, None
103 meth = FakeMethod(name, action, self.handle)
104 setattr(self.__class__, name, meth)
105 def handle(self, fn_name, action, *args, **kwds):
106 self.parent.calls.append((self, fn_name, args, kwds))
107 if action is None:
108 return None
109 elif action == "return self":
110 return self
111 elif action == "return response":
112 res = MockResponse(200, "OK", {}, "")
113 return res
114 elif action == "return request":
115 return Request("http://blah/")
116 elif action.startswith("error"):
117 code = action[action.rfind(" ")+1:]
118 try:
119 code = int(code)
120 except ValueError:
121 pass
122 res = MockResponse(200, "OK", {}, "")
123 return self.parent.error("http", args[0], res, code, "", {})
124 elif action == "raise":
125 raise urllib2.URLError("blah")
126 assert False
127 def close(self): pass
128 def add_parent(self, parent):
129 self.parent = parent
130 self.parent.calls = []
131 def __lt__(self, other):
132 if not hasattr(other, "handler_order"):
133 # No handler_order, leave in original order. Yuck.
134 return True
135 return self.handler_order < other.handler_order
136
137def add_ordered_mock_handlers(opener, meth_spec):
138 """Create MockHandlers and add them to an OpenerDirector.
139
140 meth_spec: list of lists of tuples and strings defining methods to define
141 on handlers. eg:
142
143 [["http_error", "ftp_open"], ["http_open"]]
144
145 defines methods .http_error() and .ftp_open() on one handler, and
146 .http_open() on another. These methods just record their arguments and
147 return None. Using a tuple instead of a string causes the method to
148 perform some action (see MockHandler.handle()), eg:
149
150 [["http_error"], [("http_open", "return request")]]
151
152 defines .http_error() on one handler (which simply returns None), and
153 .http_open() on another handler, which returns a Request object.
154
155 """
156 handlers = []
157 count = 0
158 for meths in meth_spec:
159 class MockHandlerSubclass(MockHandler): pass
160 h = MockHandlerSubclass(meths)
161 h.handler_order = count
162 h.add_parent(opener)
163 count = count + 1
164 handlers.append(h)
165 opener.add_handler(h)
166 return handlers
167
168class OpenerDirectorTests(unittest.TestCase):
169
170 def test_handled(self):
171 # handler returning non-None means no more handlers will be called
172 o = OpenerDirector()
173 meth_spec = [
174 ["http_open", "ftp_open", "http_error_302"],
175 ["ftp_open"],
176 [("http_open", "return self")],
177 [("http_open", "return self")],
178 ]
179 handlers = add_ordered_mock_handlers(o, meth_spec)
180
181 req = Request("http://example.com/")
182 r = o.open(req)
183 # Second .http_open() gets called, third doesn't, since second returned
184 # non-None. Handlers without .http_open() never get any methods called
185 # on them.
186 # In fact, second mock handler defining .http_open() returns self
187 # (instead of response), which becomes the OpenerDirector's return
188 # value.
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000189 self.assertEqual(r, handlers[2])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000190 calls = [(handlers[0], "http_open"), (handlers[2], "http_open")]
191 for expected, got in zip(calls, o.calls):
192 handler, name, args, kwds = got
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000193 self.assertEqual((handler, name), expected)
194 self.assertEqual(args, (req,))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000195
196 def test_handler_order(self):
197 o = OpenerDirector()
198 handlers = []
199 for meths, handler_order in [
200 ([("http_open", "return self")], 500),
201 (["http_open"], 0),
202 ]:
203 class MockHandlerSubclass(MockHandler): pass
204 h = MockHandlerSubclass(meths)
205 h.handler_order = handler_order
206 handlers.append(h)
207 o.add_handler(h)
208
209 r = o.open("http://example.com/")
210 # handlers called in reverse order, thanks to their sort order
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000211 self.assertEqual(o.calls[0][0], handlers[1])
212 self.assertEqual(o.calls[1][0], handlers[0])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000213
214 def test_raise(self):
215 # raising URLError stops processing of request
216 o = OpenerDirector()
217 meth_spec = [
218 [("http_open", "raise")],
219 [("http_open", "return self")],
220 ]
221 handlers = add_ordered_mock_handlers(o, meth_spec)
222
223 req = Request("http://example.com/")
224 self.assertRaises(urllib2.URLError, o.open, req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000225 self.assertEqual(o.calls, [(handlers[0], "http_open", (req,), {})])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000226
227## def test_error(self):
228## # XXX this doesn't actually seem to be used in standard library,
229## # but should really be tested anyway...
230
231 def test_http_error(self):
232 # XXX http_error_default
233 # http errors are a special case
234 o = OpenerDirector()
235 meth_spec = [
236 [("http_open", "error 302")],
237 [("http_error_400", "raise"), "http_open"],
238 [("http_error_302", "return response"), "http_error_303",
239 "http_error"],
240 [("http_error_302")],
241 ]
242 handlers = add_ordered_mock_handlers(o, meth_spec)
243
244 class Unknown:
245 def __eq__(self, other): return True
246
247 req = Request("http://example.com/")
248 r = o.open(req)
249 assert len(o.calls) == 2
250 calls = [(handlers[0], "http_open", (req,)),
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000251 (handlers[2], "http_error_302",
252 (req, Unknown(), 302, "", {}))]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000253 for expected, got in zip(calls, o.calls):
254 handler, method_name, args = expected
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000255 self.assertEqual((handler, method_name), got[:2])
256 self.assertEqual(args, got[2])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000257
258 def test_processors(self):
259 # *_request / *_response methods get called appropriately
260 o = OpenerDirector()
261 meth_spec = [
262 [("http_request", "return request"),
263 ("http_response", "return response")],
264 [("http_request", "return request"),
265 ("http_response", "return response")],
266 ]
267 handlers = add_ordered_mock_handlers(o, meth_spec)
268
269 req = Request("http://example.com/")
270 r = o.open(req)
271 # processor methods are called on *all* handlers that define them,
272 # not just the first handler that handles the request
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000273 calls = [
274 (handlers[0], "http_request"), (handlers[1], "http_request"),
275 (handlers[0], "http_response"), (handlers[1], "http_response")]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000276
277 for i, (handler, name, args, kwds) in enumerate(o.calls):
278 if i < 2:
279 # *_request
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000280 self.assertEqual((handler, name), calls[i])
281 self.assertEqual(len(args), 1)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000282 self.assert_(isinstance(args[0], Request))
283 else:
284 # *_response
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000285 self.assertEqual((handler, name), calls[i])
286 self.assertEqual(len(args), 2)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000287 self.assert_(isinstance(args[0], Request))
288 # response from opener.open is None, because there's no
289 # handler that defines http_open to handle it
290 self.assert_(args[1] is None or
291 isinstance(args[1], MockResponse))
292
293
Tim Peters58eb11c2004-01-18 20:29:55 +0000294def sanepathname2url(path):
295 import urllib
296 urlpath = urllib.pathname2url(path)
297 if os.name == "nt" and urlpath.startswith("///"):
298 urlpath = urlpath[2:]
299 # XXX don't ask me about the mac...
300 return urlpath
301
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000302class HandlerTests(unittest.TestCase):
303
304 def test_ftp(self):
305 class MockFTPWrapper:
306 def __init__(self, data): self.data = data
307 def retrfile(self, filename, filetype):
308 self.filename, self.filetype = filename, filetype
309 return StringIO.StringIO(self.data), len(self.data)
310
311 class NullFTPHandler(urllib2.FTPHandler):
312 def __init__(self, data): self.data = data
313 def connect_ftp(self, user, passwd, host, port, dirs):
314 self.user, self.passwd = user, passwd
315 self.host, self.port = host, port
316 self.dirs = dirs
317 self.ftpwrapper = MockFTPWrapper(self.data)
318 return self.ftpwrapper
319
320 import ftplib, socket
321 data = "rheum rhaponicum"
322 h = NullFTPHandler(data)
323 o = h.parent = MockOpener()
324
325 for url, host, port, type_, dirs, filename, mimetype in [
326 ("ftp://localhost/foo/bar/baz.html",
327 "localhost", ftplib.FTP_PORT, "I",
328 ["foo", "bar"], "baz.html", "text/html"),
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000329 ("ftp://localhost:80/foo/bar/",
330 "localhost", 80, "D",
331 ["foo", "bar"], "", None),
332 ("ftp://localhost/baz.gif;type=a",
333 "localhost", ftplib.FTP_PORT, "A",
334 [], "baz.gif", None), # XXX really this should guess image/gif
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000335 ]:
336 r = h.ftp_open(Request(url))
337 # ftp authentication not yet implemented by FTPHandler
338 self.assert_(h.user == h.passwd == "")
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000339 self.assertEqual(h.host, socket.gethostbyname(host))
340 self.assertEqual(h.port, port)
341 self.assertEqual(h.dirs, dirs)
342 self.assertEqual(h.ftpwrapper.filename, filename)
343 self.assertEqual(h.ftpwrapper.filetype, type_)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000344 headers = r.info()
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000345 self.assertEqual(headers.get("Content-type"), mimetype)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000346 self.assertEqual(int(headers["Content-length"]), len(data))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000347
348 def test_file(self):
349 import time, rfc822, socket
350 h = urllib2.FileHandler()
351 o = h.parent = MockOpener()
352
Tim Peters58eb11c2004-01-18 20:29:55 +0000353 TESTFN = test_support.TESTFN
354 urlpath = sanepathname2url(os.path.abspath(TESTFN))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000355 towrite = "hello, world\n"
356 for url in [
Tim Peters58eb11c2004-01-18 20:29:55 +0000357 "file://localhost%s" % urlpath,
358 "file://%s" % urlpath,
359 "file://%s%s" % (socket.gethostbyname('localhost'), urlpath),
360 "file://%s%s" % (socket.gethostbyname(socket.gethostname()),
361 urlpath),
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000362 ]:
Tim Peters58eb11c2004-01-18 20:29:55 +0000363 f = open(TESTFN, "wb")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000364 try:
365 try:
366 f.write(towrite)
367 finally:
368 f.close()
369
370 r = h.file_open(Request(url))
371 try:
372 data = r.read()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000373 headers = r.info()
374 newurl = r.geturl()
375 finally:
376 r.close()
Tim Peters58eb11c2004-01-18 20:29:55 +0000377 stats = os.stat(TESTFN)
378 modified = rfc822.formatdate(stats.st_mtime)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000379 finally:
380 os.remove(TESTFN)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000381 self.assertEqual(data, towrite)
382 self.assertEqual(headers["Content-type"], "text/plain")
383 self.assertEqual(headers["Content-length"], "13")
Tim Peters58eb11c2004-01-18 20:29:55 +0000384 self.assertEqual(headers["Last-modified"], modified)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000385
386 for url in [
Tim Peters58eb11c2004-01-18 20:29:55 +0000387 "file://localhost:80%s" % urlpath,
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000388# XXXX bug: these fail with socket.gaierror, should be URLError
389## "file://%s:80%s/%s" % (socket.gethostbyname('localhost'),
390## os.getcwd(), TESTFN),
391## "file://somerandomhost.ontheinternet.com%s/%s" %
392## (os.getcwd(), TESTFN),
393 ]:
394 try:
Tim Peters58eb11c2004-01-18 20:29:55 +0000395 f = open(TESTFN, "wb")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000396 try:
397 f.write(towrite)
398 finally:
399 f.close()
400
401 self.assertRaises(urllib2.URLError,
402 h.file_open, Request(url))
403 finally:
404 os.remove(TESTFN)
405
406 h = urllib2.FileHandler()
407 o = h.parent = MockOpener()
408 # XXXX why does // mean ftp (and /// mean not ftp!), and where
409 # is file: scheme specified? I think this is really a bug, and
410 # what was intended was to distinguish between URLs like:
411 # file:/blah.txt (a file)
412 # file://localhost/blah.txt (a file)
413 # file:///blah.txt (a file)
414 # file://ftp.example.com/blah.txt (an ftp URL)
415 for url, ftp in [
416 ("file://ftp.example.com//foo.txt", True),
417 ("file://ftp.example.com///foo.txt", False),
418# XXXX bug: fails with OSError, should be URLError
419 ("file://ftp.example.com/foo.txt", False),
420 ]:
421 req = Request(url)
422 try:
423 h.file_open(req)
424 # XXXX remove OSError when bug fixed
425 except (urllib2.URLError, OSError):
426 self.assert_(not ftp)
427 else:
428 self.assert_(o.req is req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000429 self.assertEqual(req.type, "ftp")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000430
431 def test_http(self):
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000432 class MockHTTPResponse:
433 def __init__(self, fp, msg, status, reason):
434 self.fp = fp
435 self.msg = msg
436 self.status = status
437 self.reason = reason
Jeremy Hylton5d9c3032004-08-07 17:40:50 +0000438 def read(self):
439 return ''
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000440 class MockHTTPClass:
441 def __init__(self):
442 self.req_headers = []
443 self.data = None
444 self.raise_on_endheaders = False
445 def __call__(self, host):
446 self.host = host
447 return self
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000448 def set_debuglevel(self, level):
449 self.level = level
450 def request(self, method, url, body=None, headers={}):
451 self.method = method
452 self.selector = url
453 self.req_headers += headers.items()
454 if body:
455 self.data = body
456 if self.raise_on_endheaders:
457 import socket
458 raise socket.error()
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000459 def getresponse(self):
460 return MockHTTPResponse(MockFile(), {}, 200, "OK")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000461
462 h = urllib2.AbstractHTTPHandler()
463 o = h.parent = MockOpener()
464
465 url = "http://example.com/"
466 for method, data in [("GET", None), ("POST", "blah")]:
467 req = Request(url, data, {"Foo": "bar"})
468 req.add_unredirected_header("Spam", "eggs")
469 http = MockHTTPClass()
470 r = h.do_open(http, req)
471
472 # result attributes
473 r.read; r.readline # wrapped MockFile methods
474 r.info; r.geturl # addinfourl methods
475 r.code, r.msg == 200, "OK" # added from MockHTTPClass.getreply()
476 hdrs = r.info()
477 hdrs.get; hdrs.has_key # r.info() gives dict from .getreply()
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000478 self.assertEqual(r.geturl(), url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000479
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000480 self.assertEqual(http.host, "example.com")
481 self.assertEqual(http.level, 0)
482 self.assertEqual(http.method, method)
483 self.assertEqual(http.selector, "/")
484 self.assertEqual(http.req_headers,
Jeremy Hyltonb3ee6f92004-02-24 19:40:35 +0000485 [("Connection", "close"),
486 ("Foo", "bar"), ("Spam", "eggs")])
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000487 self.assertEqual(http.data, data)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000488
489 # check socket.error converted to URLError
490 http.raise_on_endheaders = True
491 self.assertRaises(urllib2.URLError, h.do_open, http, req)
492
493 # check adding of standard headers
494 o.addheaders = [("Spam", "eggs")]
495 for data in "", None: # POST, GET
496 req = Request("http://example.com/", data)
497 r = MockResponse(200, "OK", {}, "")
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000498 newreq = h.do_request_(req)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000499 if data is None: # GET
500 self.assert_("Content-length" not in req.unredirected_hdrs)
501 self.assert_("Content-type" not in req.unredirected_hdrs)
502 else: # POST
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000503 self.assertEqual(req.unredirected_hdrs["Content-length"], "0")
504 self.assertEqual(req.unredirected_hdrs["Content-type"],
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000505 "application/x-www-form-urlencoded")
506 # XXX the details of Host could be better tested
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000507 self.assertEqual(req.unredirected_hdrs["Host"], "example.com")
508 self.assertEqual(req.unredirected_hdrs["Spam"], "eggs")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000509
510 # don't clobber existing headers
511 req.add_unredirected_header("Content-length", "foo")
512 req.add_unredirected_header("Content-type", "bar")
513 req.add_unredirected_header("Host", "baz")
514 req.add_unredirected_header("Spam", "foo")
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000515 newreq = h.do_request_(req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000516 self.assertEqual(req.unredirected_hdrs["Content-length"], "foo")
517 self.assertEqual(req.unredirected_hdrs["Content-type"], "bar")
518 self.assertEqual(req.unredirected_hdrs["Host"], "baz")
519 self.assertEqual(req.unredirected_hdrs["Spam"], "foo")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000520
521 def test_errors(self):
522 h = urllib2.HTTPErrorProcessor()
523 o = h.parent = MockOpener()
524
525 url = "http://example.com/"
526 req = Request(url)
527 # 200 OK is passed through
528 r = MockResponse(200, "OK", {}, "", url)
529 newr = h.http_response(req, r)
530 self.assert_(r is newr)
531 self.assert_(not hasattr(o, "proto")) # o.error not called
532 # anything else calls o.error (and MockOpener returns None, here)
533 r = MockResponse(201, "Created", {}, "", url)
534 self.assert_(h.http_response(req, r) is None)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000535 self.assertEqual(o.proto, "http") # o.error called
536 self.assertEqual(o.args, (req, r, 201, "Created", {}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000537
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000538 def test_cookies(self):
539 cj = MockCookieJar()
540 h = urllib2.HTTPCookieProcessor(cj)
541 o = h.parent = MockOpener()
542
543 req = Request("http://example.com/")
544 r = MockResponse(200, "OK", {}, "")
545 newreq = h.http_request(req)
546 self.assert_(cj.ach_req is req is newreq)
547 self.assertEquals(req.get_origin_req_host(), "example.com")
548 self.assert_(not req.is_unverifiable())
549 newr = h.http_response(req, r)
550 self.assert_(cj.ec_req is req)
551 self.assert_(cj.ec_r is r is newr)
552
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000553 def test_redirect(self):
554 from_url = "http://example.com/a.html"
555 to_url = "http://example.com/b.html"
556 h = urllib2.HTTPRedirectHandler()
557 o = h.parent = MockOpener()
558
559 # ordinary redirect behaviour
560 for code in 301, 302, 303, 307:
561 for data in None, "blah\nblah\n":
562 method = getattr(h, "http_error_%s" % code)
563 req = Request(from_url, data)
564 req.add_header("Nonsense", "viking=withhold")
565 req.add_unredirected_header("Spam", "spam")
566 try:
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000567 method(req, MockFile(), code, "Blah",
568 MockHeaders({"location": to_url}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000569 except urllib2.HTTPError:
570 # 307 in response to POST requires user OK
571 self.assert_(code == 307 and data is not None)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000572 self.assertEqual(o.req.get_full_url(), to_url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000573 try:
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000574 self.assertEqual(o.req.get_method(), "GET")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000575 except AttributeError:
576 self.assert_(not o.req.has_data())
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000577 self.assertEqual(o.req.headers["Nonsense"],
578 "viking=withhold")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000579 self.assert_("Spam" not in o.req.headers)
580 self.assert_("Spam" not in o.req.unredirected_hdrs)
581
582 # loop detection
583 req = Request(from_url)
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000584 def redirect(h, req, url=to_url):
585 h.http_error_302(req, MockFile(), 302, "Blah",
586 MockHeaders({"location": url}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000587 # Note that the *original* request shares the same record of
588 # redirections with the sub-requests caused by the redirections.
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000589
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000590 # detect infinite loop redirect of a URL to itself
591 req = Request(from_url, origin_req_host="example.com")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000592 count = 0
593 try:
594 while 1:
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000595 redirect(h, req, "http://example.com/")
596 count = count + 1
597 except urllib2.HTTPError:
598 # don't stop until max_repeats, because cookies may introduce state
599 self.assertEqual(count, urllib2.HTTPRedirectHandler.max_repeats)
600
601 # detect endless non-repeating chain of redirects
602 req = Request(from_url, origin_req_host="example.com")
603 count = 0
604 try:
605 while 1:
606 redirect(h, req, "http://example.com/%d" % count)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000607 count = count + 1
608 except urllib2.HTTPError:
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000609 self.assertEqual(count,
610 urllib2.HTTPRedirectHandler.max_redirections)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000611
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000612 def test_cookie_redirect(self):
613 class MockHTTPHandler(urllib2.HTTPHandler):
614 def __init__(self): self._count = 0
615 def http_open(self, req):
616 import mimetools
617 from StringIO import StringIO
618 if self._count == 0:
619 self._count = self._count + 1
620 msg = mimetools.Message(
621 StringIO("Location: http://www.cracker.com/\r\n\r\n"))
622 return self.parent.error(
623 "http", req, MockFile(), 302, "Found", msg)
624 else:
625 self.req = req
626 msg = mimetools.Message(StringIO("\r\n\r\n"))
627 return MockResponse(200, "OK", msg, "", req.get_full_url())
628 # cookies shouldn't leak into redirected requests
629 from cookielib import CookieJar
630 from urllib2 import build_opener, HTTPHandler, HTTPError, \
631 HTTPCookieProcessor
632
633 from test_cookielib import interact_netscape
634
635 cj = CookieJar()
636 interact_netscape(cj, "http://www.example.com/", "spam=eggs")
637 hh = MockHTTPHandler()
638 cp = HTTPCookieProcessor(cj)
639 o = build_opener(hh, cp)
640 o.open("http://www.example.com/")
641 self.assert_(not hh.req.has_header("Cookie"))
642
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000643
644class MiscTests(unittest.TestCase):
645
646 def test_build_opener(self):
647 class MyHTTPHandler(urllib2.HTTPHandler): pass
648 class FooHandler(urllib2.BaseHandler):
649 def foo_open(self): pass
650 class BarHandler(urllib2.BaseHandler):
651 def bar_open(self): pass
652
653 build_opener = urllib2.build_opener
654
655 o = build_opener(FooHandler, BarHandler)
656 self.opener_has_handler(o, FooHandler)
657 self.opener_has_handler(o, BarHandler)
658
659 # can take a mix of classes and instances
660 o = build_opener(FooHandler, BarHandler())
661 self.opener_has_handler(o, FooHandler)
662 self.opener_has_handler(o, BarHandler)
663
664 # subclasses of default handlers override default handlers
665 o = build_opener(MyHTTPHandler)
666 self.opener_has_handler(o, MyHTTPHandler)
667
668 # a particular case of overriding: default handlers can be passed
669 # in explicitly
670 o = build_opener()
671 self.opener_has_handler(o, urllib2.HTTPHandler)
672 o = build_opener(urllib2.HTTPHandler)
673 self.opener_has_handler(o, urllib2.HTTPHandler)
674 o = build_opener(urllib2.HTTPHandler())
675 self.opener_has_handler(o, urllib2.HTTPHandler)
676
677 def opener_has_handler(self, opener, handler_class):
678 for h in opener.handlers:
679 if h.__class__ == handler_class:
680 break
681 else:
682 self.assert_(False)
683
Andrew M. Kuchlingbd3200f2004-06-29 13:15:46 +0000684class NetworkTests(unittest.TestCase):
Andrew M. Kuchling85064ff2004-07-10 19:46:40 +0000685 def setUp(self):
686 if 0: # for debugging
687 import logging
688 logger = logging.getLogger("test_urllib2")
689 logger.addHandler(logging.StreamHandler())
690
Andrew M. Kuchlingbd3200f2004-06-29 13:15:46 +0000691 def test_range (self):
692 req = urllib2.Request("http://www.python.org",
693 headers={'Range': 'bytes=20-39'})
694 result = urllib2.urlopen(req)
695 data = result.read()
696 self.assertEqual(len(data), 20)
697
Andrew M. Kuchling85064ff2004-07-10 19:46:40 +0000698 # XXX The rest of these tests aren't very good -- they don't check much.
699 # They do sometimes catch some major disasters, though.
700
701 def test_ftp(self):
702 urls = [
703 'ftp://www.python.org/pub/python/misc/sousa.au',
704 'ftp://www.python.org/pub/tmp/blat',
705 'ftp://gatekeeper.research.compaq.com/pub/DEC/SRC'
706 '/research-reports/00README-Legal-Rules-Regs',
707 ]
708 self._test_urls(urls, self._extra_handlers())
709
710 def test_gopher(self):
711 urls = [
712 # Thanks to Fred for finding these!
713 'gopher://gopher.lib.ncsu.edu/11/library/stacks/Alex',
714 'gopher://gopher.vt.edu:10010/10/33',
715 ]
716 self._test_urls(urls, self._extra_handlers())
717
718 def test_file(self):
719 TESTFN = test_support.TESTFN
720 f = open(TESTFN, 'w')
721 try:
722 f.write('hi there\n')
723 f.close()
724 urls = [
725 'file:'+sanepathname2url(os.path.abspath(TESTFN)),
726
727 # XXX bug, should raise URLError
728 #('file://nonsensename/etc/passwd', None, urllib2.URLError)
729 ('file://nonsensename/etc/passwd', None, (OSError, socket.error))
730 ]
731 self._test_urls(urls, self._extra_handlers())
732 finally:
733 os.remove(TESTFN)
734
735 def test_http(self):
736 urls = [
737 'http://www.espn.com/', # redirect
738 'http://www.python.org/Spanish/Inquistion/',
739 ('http://www.python.org/cgi-bin/faqw.py',
740 'query=pythonistas&querytype=simple&casefold=yes&req=search', None),
741 'http://www.python.org/',
742 ]
743 self._test_urls(urls, self._extra_handlers())
744
745 # XXX Following test depends on machine configurations that are internal
746 # to CNRI. Need to set up a public server with the right authentication
747 # configuration for test purposes.
748
749## def test_cnri(self):
750## if socket.gethostname() == 'bitdiddle':
751## localhost = 'bitdiddle.cnri.reston.va.us'
752## elif socket.gethostname() == 'bitdiddle.concentric.net':
753## localhost = 'localhost'
754## else:
755## localhost = None
756## if localhost is not None:
757## urls = [
758## 'file://%s/etc/passwd' % localhost,
759## 'http://%s/simple/' % localhost,
760## 'http://%s/digest/' % localhost,
761## 'http://%s/not/found.h' % localhost,
762## ]
763
764## bauth = HTTPBasicAuthHandler()
765## bauth.add_password('basic_test_realm', localhost, 'jhylton',
766## 'password')
767## dauth = HTTPDigestAuthHandler()
768## dauth.add_password('digest_test_realm', localhost, 'jhylton',
769## 'password')
770
771## self._test_urls(urls, self._extra_handlers()+[bauth, dauth])
772
773 def _test_urls(self, urls, handlers):
774 import socket
775 import time
776 import logging
777 debug = logging.getLogger("test_urllib2").debug
778
779 urllib2.install_opener(urllib2.build_opener(*handlers))
780
781 for url in urls:
782 if isinstance(url, tuple):
783 url, req, expected_err = url
784 else:
785 req = expected_err = None
786 debug(url)
787 try:
788 f = urllib2.urlopen(url, req)
789 except (IOError, socket.error, OSError), err:
790 debug(err)
791 if expected_err:
792 self.assert_(isinstance(err, expected_err))
793 else:
794 buf = f.read()
795 f.close()
796 debug("read %d bytes" % len(buf))
797 debug("******** next url coming up...")
798 time.sleep(0.1)
799
800 def _extra_handlers(self):
801 handlers = []
802
803 handlers.append(urllib2.GopherHandler)
804
805 cfh = urllib2.CacheFTPHandler()
806 cfh.setTimeout(1)
807 handlers.append(cfh)
808
809## # XXX try out some custom proxy objects too!
810## def at_cnri(req):
811## host = req.get_host()
812## debug(host)
813## if host[-18:] == '.cnri.reston.va.us':
814## return True
815## p = CustomProxy('http', at_cnri, 'proxy.cnri.reston.va.us')
816## ph = CustomProxyHandler(p)
817## handlers.append(ph)
818
819 return handlers
Tim Peters27f88362004-07-08 04:22:35 +0000820
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000821
822def test_main(verbose=None):
Andrew M. Kuchlingbd3200f2004-06-29 13:15:46 +0000823 tests = (TrivialTests,
824 OpenerDirectorTests,
825 HandlerTests,
826 MiscTests)
827 if test_support.is_resource_enabled('network'):
828 tests += (NetworkTests,)
829 test_support.run_unittest(*tests)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000830
831if __name__ == "__main__":
832 test_main(verbose=True)