blob: 1c0b7dafd3187fe891ca921e75e1b759b2fa566f [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()
Georg Brandl5c5fe2f2005-07-14 06:40:47 +000043
44 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
48
49class MockOpener:
50 addheaders = []
51 def open(self, req, data=None):
52 self.req, self.data = req, data
53 def error(self, proto, *args):
54 self.proto, self.args = proto, args
55
56class MockFile:
57 def read(self, count=None): pass
58 def readline(self, count=None): pass
59 def close(self): pass
60
Martin v. Löwis2a6ba902004-05-31 18:22:40 +000061class MockHeaders(dict):
62 def getheaders(self, name):
63 return self.values()
64
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000065class MockResponse(StringIO.StringIO):
66 def __init__(self, code, msg, headers, data, url=None):
67 StringIO.StringIO.__init__(self, data)
68 self.code, self.msg, self.headers, self.url = code, msg, headers, url
69 def info(self):
70 return self.headers
71 def geturl(self):
72 return self.url
73
Martin v. Löwis2a6ba902004-05-31 18:22:40 +000074class MockCookieJar:
75 def add_cookie_header(self, request):
76 self.ach_req = request
77 def extract_cookies(self, response, request):
78 self.ec_req, self.ec_r = request, response
79
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +000080class FakeMethod:
81 def __init__(self, meth_name, action, handle):
82 self.meth_name = meth_name
83 self.handle = handle
84 self.action = action
85 def __call__(self, *args):
86 return self.handle(self.meth_name, self.action, *args)
87
88class MockHandler:
89 def __init__(self, methods):
90 self._define_methods(methods)
91 def _define_methods(self, methods):
92 for spec in methods:
93 if len(spec) == 2: name, action = spec
94 else: name, action = spec, None
95 meth = FakeMethod(name, action, self.handle)
96 setattr(self.__class__, name, meth)
97 def handle(self, fn_name, action, *args, **kwds):
98 self.parent.calls.append((self, fn_name, args, kwds))
99 if action is None:
100 return None
101 elif action == "return self":
102 return self
103 elif action == "return response":
104 res = MockResponse(200, "OK", {}, "")
105 return res
106 elif action == "return request":
107 return Request("http://blah/")
108 elif action.startswith("error"):
109 code = action[action.rfind(" ")+1:]
110 try:
111 code = int(code)
112 except ValueError:
113 pass
114 res = MockResponse(200, "OK", {}, "")
115 return self.parent.error("http", args[0], res, code, "", {})
116 elif action == "raise":
117 raise urllib2.URLError("blah")
118 assert False
119 def close(self): pass
120 def add_parent(self, parent):
121 self.parent = parent
122 self.parent.calls = []
123 def __lt__(self, other):
124 if not hasattr(other, "handler_order"):
125 # No handler_order, leave in original order. Yuck.
126 return True
127 return self.handler_order < other.handler_order
128
129def add_ordered_mock_handlers(opener, meth_spec):
130 """Create MockHandlers and add them to an OpenerDirector.
131
132 meth_spec: list of lists of tuples and strings defining methods to define
133 on handlers. eg:
134
135 [["http_error", "ftp_open"], ["http_open"]]
136
137 defines methods .http_error() and .ftp_open() on one handler, and
138 .http_open() on another. These methods just record their arguments and
139 return None. Using a tuple instead of a string causes the method to
140 perform some action (see MockHandler.handle()), eg:
141
142 [["http_error"], [("http_open", "return request")]]
143
144 defines .http_error() on one handler (which simply returns None), and
145 .http_open() on another handler, which returns a Request object.
146
147 """
148 handlers = []
149 count = 0
150 for meths in meth_spec:
151 class MockHandlerSubclass(MockHandler): pass
152 h = MockHandlerSubclass(meths)
153 h.handler_order = count
154 h.add_parent(opener)
155 count = count + 1
156 handlers.append(h)
157 opener.add_handler(h)
158 return handlers
159
160class OpenerDirectorTests(unittest.TestCase):
161
162 def test_handled(self):
163 # handler returning non-None means no more handlers will be called
164 o = OpenerDirector()
165 meth_spec = [
166 ["http_open", "ftp_open", "http_error_302"],
167 ["ftp_open"],
168 [("http_open", "return self")],
169 [("http_open", "return self")],
170 ]
171 handlers = add_ordered_mock_handlers(o, meth_spec)
172
173 req = Request("http://example.com/")
174 r = o.open(req)
175 # Second .http_open() gets called, third doesn't, since second returned
176 # non-None. Handlers without .http_open() never get any methods called
177 # on them.
178 # In fact, second mock handler defining .http_open() returns self
179 # (instead of response), which becomes the OpenerDirector's return
180 # value.
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000181 self.assertEqual(r, handlers[2])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000182 calls = [(handlers[0], "http_open"), (handlers[2], "http_open")]
183 for expected, got in zip(calls, o.calls):
184 handler, name, args, kwds = got
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000185 self.assertEqual((handler, name), expected)
186 self.assertEqual(args, (req,))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000187
188 def test_handler_order(self):
189 o = OpenerDirector()
190 handlers = []
191 for meths, handler_order in [
192 ([("http_open", "return self")], 500),
193 (["http_open"], 0),
194 ]:
195 class MockHandlerSubclass(MockHandler): pass
196 h = MockHandlerSubclass(meths)
197 h.handler_order = handler_order
198 handlers.append(h)
199 o.add_handler(h)
200
201 r = o.open("http://example.com/")
202 # handlers called in reverse order, thanks to their sort order
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000203 self.assertEqual(o.calls[0][0], handlers[1])
204 self.assertEqual(o.calls[1][0], handlers[0])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000205
206 def test_raise(self):
207 # raising URLError stops processing of request
208 o = OpenerDirector()
209 meth_spec = [
210 [("http_open", "raise")],
211 [("http_open", "return self")],
212 ]
213 handlers = add_ordered_mock_handlers(o, meth_spec)
214
215 req = Request("http://example.com/")
216 self.assertRaises(urllib2.URLError, o.open, req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000217 self.assertEqual(o.calls, [(handlers[0], "http_open", (req,), {})])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000218
219## def test_error(self):
220## # XXX this doesn't actually seem to be used in standard library,
221## # but should really be tested anyway...
222
223 def test_http_error(self):
224 # XXX http_error_default
225 # http errors are a special case
226 o = OpenerDirector()
227 meth_spec = [
228 [("http_open", "error 302")],
229 [("http_error_400", "raise"), "http_open"],
230 [("http_error_302", "return response"), "http_error_303",
231 "http_error"],
232 [("http_error_302")],
233 ]
234 handlers = add_ordered_mock_handlers(o, meth_spec)
235
236 class Unknown:
237 def __eq__(self, other): return True
238
239 req = Request("http://example.com/")
240 r = o.open(req)
241 assert len(o.calls) == 2
242 calls = [(handlers[0], "http_open", (req,)),
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000243 (handlers[2], "http_error_302",
244 (req, Unknown(), 302, "", {}))]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000245 for expected, got in zip(calls, o.calls):
246 handler, method_name, args = expected
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000247 self.assertEqual((handler, method_name), got[:2])
248 self.assertEqual(args, got[2])
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000249
250 def test_processors(self):
251 # *_request / *_response methods get called appropriately
252 o = OpenerDirector()
253 meth_spec = [
254 [("http_request", "return request"),
255 ("http_response", "return response")],
256 [("http_request", "return request"),
257 ("http_response", "return response")],
258 ]
259 handlers = add_ordered_mock_handlers(o, meth_spec)
260
261 req = Request("http://example.com/")
262 r = o.open(req)
263 # processor methods are called on *all* handlers that define them,
264 # not just the first handler that handles the request
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000265 calls = [
266 (handlers[0], "http_request"), (handlers[1], "http_request"),
267 (handlers[0], "http_response"), (handlers[1], "http_response")]
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000268
269 for i, (handler, name, args, kwds) in enumerate(o.calls):
270 if i < 2:
271 # *_request
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000272 self.assertEqual((handler, name), calls[i])
273 self.assertEqual(len(args), 1)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000274 self.assert_(isinstance(args[0], Request))
275 else:
276 # *_response
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000277 self.assertEqual((handler, name), calls[i])
278 self.assertEqual(len(args), 2)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000279 self.assert_(isinstance(args[0], Request))
280 # response from opener.open is None, because there's no
281 # handler that defines http_open to handle it
282 self.assert_(args[1] is None or
283 isinstance(args[1], MockResponse))
284
285
Tim Peters58eb11c2004-01-18 20:29:55 +0000286def sanepathname2url(path):
287 import urllib
288 urlpath = urllib.pathname2url(path)
289 if os.name == "nt" and urlpath.startswith("///"):
290 urlpath = urlpath[2:]
291 # XXX don't ask me about the mac...
292 return urlpath
293
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000294class HandlerTests(unittest.TestCase):
295
296 def test_ftp(self):
297 class MockFTPWrapper:
298 def __init__(self, data): self.data = data
299 def retrfile(self, filename, filetype):
300 self.filename, self.filetype = filename, filetype
301 return StringIO.StringIO(self.data), len(self.data)
302
303 class NullFTPHandler(urllib2.FTPHandler):
304 def __init__(self, data): self.data = data
305 def connect_ftp(self, user, passwd, host, port, dirs):
306 self.user, self.passwd = user, passwd
307 self.host, self.port = host, port
308 self.dirs = dirs
309 self.ftpwrapper = MockFTPWrapper(self.data)
310 return self.ftpwrapper
311
312 import ftplib, socket
313 data = "rheum rhaponicum"
314 h = NullFTPHandler(data)
315 o = h.parent = MockOpener()
316
317 for url, host, port, type_, dirs, filename, mimetype in [
318 ("ftp://localhost/foo/bar/baz.html",
319 "localhost", ftplib.FTP_PORT, "I",
320 ["foo", "bar"], "baz.html", "text/html"),
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000321 ("ftp://localhost:80/foo/bar/",
322 "localhost", 80, "D",
323 ["foo", "bar"], "", None),
324 ("ftp://localhost/baz.gif;type=a",
325 "localhost", ftplib.FTP_PORT, "A",
326 [], "baz.gif", None), # XXX really this should guess image/gif
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000327 ]:
328 r = h.ftp_open(Request(url))
329 # ftp authentication not yet implemented by FTPHandler
330 self.assert_(h.user == h.passwd == "")
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000331 self.assertEqual(h.host, socket.gethostbyname(host))
332 self.assertEqual(h.port, port)
333 self.assertEqual(h.dirs, dirs)
334 self.assertEqual(h.ftpwrapper.filename, filename)
335 self.assertEqual(h.ftpwrapper.filetype, type_)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000336 headers = r.info()
Kurt B. Kaiser3f7cb5d2004-07-11 17:14:13 +0000337 self.assertEqual(headers.get("Content-type"), mimetype)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000338 self.assertEqual(int(headers["Content-length"]), len(data))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000339
340 def test_file(self):
341 import time, rfc822, socket
342 h = urllib2.FileHandler()
343 o = h.parent = MockOpener()
344
Tim Peters58eb11c2004-01-18 20:29:55 +0000345 TESTFN = test_support.TESTFN
346 urlpath = sanepathname2url(os.path.abspath(TESTFN))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000347 towrite = "hello, world\n"
348 for url in [
Tim Peters58eb11c2004-01-18 20:29:55 +0000349 "file://localhost%s" % urlpath,
350 "file://%s" % urlpath,
351 "file://%s%s" % (socket.gethostbyname('localhost'), urlpath),
352 "file://%s%s" % (socket.gethostbyname(socket.gethostname()),
353 urlpath),
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000354 ]:
Tim Peters58eb11c2004-01-18 20:29:55 +0000355 f = open(TESTFN, "wb")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000356 try:
357 try:
358 f.write(towrite)
359 finally:
360 f.close()
361
362 r = h.file_open(Request(url))
363 try:
364 data = r.read()
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000365 headers = r.info()
366 newurl = r.geturl()
367 finally:
368 r.close()
Tim Peters58eb11c2004-01-18 20:29:55 +0000369 stats = os.stat(TESTFN)
370 modified = rfc822.formatdate(stats.st_mtime)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000371 finally:
372 os.remove(TESTFN)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000373 self.assertEqual(data, towrite)
374 self.assertEqual(headers["Content-type"], "text/plain")
375 self.assertEqual(headers["Content-length"], "13")
Tim Peters58eb11c2004-01-18 20:29:55 +0000376 self.assertEqual(headers["Last-modified"], modified)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000377
378 for url in [
Tim Peters58eb11c2004-01-18 20:29:55 +0000379 "file://localhost:80%s" % urlpath,
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000380# XXXX bug: these fail with socket.gaierror, should be URLError
381## "file://%s:80%s/%s" % (socket.gethostbyname('localhost'),
382## os.getcwd(), TESTFN),
383## "file://somerandomhost.ontheinternet.com%s/%s" %
384## (os.getcwd(), TESTFN),
385 ]:
386 try:
Tim Peters58eb11c2004-01-18 20:29:55 +0000387 f = open(TESTFN, "wb")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000388 try:
389 f.write(towrite)
390 finally:
391 f.close()
392
393 self.assertRaises(urllib2.URLError,
394 h.file_open, Request(url))
395 finally:
396 os.remove(TESTFN)
397
398 h = urllib2.FileHandler()
399 o = h.parent = MockOpener()
400 # XXXX why does // mean ftp (and /// mean not ftp!), and where
401 # is file: scheme specified? I think this is really a bug, and
402 # what was intended was to distinguish between URLs like:
403 # file:/blah.txt (a file)
404 # file://localhost/blah.txt (a file)
405 # file:///blah.txt (a file)
406 # file://ftp.example.com/blah.txt (an ftp URL)
407 for url, ftp in [
408 ("file://ftp.example.com//foo.txt", True),
409 ("file://ftp.example.com///foo.txt", False),
410# XXXX bug: fails with OSError, should be URLError
411 ("file://ftp.example.com/foo.txt", False),
412 ]:
413 req = Request(url)
414 try:
415 h.file_open(req)
416 # XXXX remove OSError when bug fixed
417 except (urllib2.URLError, OSError):
418 self.assert_(not ftp)
419 else:
420 self.assert_(o.req is req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000421 self.assertEqual(req.type, "ftp")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000422
423 def test_http(self):
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000424 class MockHTTPResponse:
425 def __init__(self, fp, msg, status, reason):
426 self.fp = fp
427 self.msg = msg
428 self.status = status
429 self.reason = reason
Jeremy Hylton5d9c3032004-08-07 17:40:50 +0000430 def read(self):
431 return ''
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000432 class MockHTTPClass:
433 def __init__(self):
434 self.req_headers = []
435 self.data = None
436 self.raise_on_endheaders = False
437 def __call__(self, host):
438 self.host = host
439 return self
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000440 def set_debuglevel(self, level):
441 self.level = level
442 def request(self, method, url, body=None, headers={}):
443 self.method = method
444 self.selector = url
445 self.req_headers += headers.items()
446 if body:
447 self.data = body
448 if self.raise_on_endheaders:
449 import socket
450 raise socket.error()
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000451 def getresponse(self):
452 return MockHTTPResponse(MockFile(), {}, 200, "OK")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000453
454 h = urllib2.AbstractHTTPHandler()
455 o = h.parent = MockOpener()
456
457 url = "http://example.com/"
458 for method, data in [("GET", None), ("POST", "blah")]:
459 req = Request(url, data, {"Foo": "bar"})
460 req.add_unredirected_header("Spam", "eggs")
461 http = MockHTTPClass()
462 r = h.do_open(http, req)
463
464 # result attributes
465 r.read; r.readline # wrapped MockFile methods
466 r.info; r.geturl # addinfourl methods
467 r.code, r.msg == 200, "OK" # added from MockHTTPClass.getreply()
468 hdrs = r.info()
469 hdrs.get; hdrs.has_key # r.info() gives dict from .getreply()
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000470 self.assertEqual(r.geturl(), url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000471
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000472 self.assertEqual(http.host, "example.com")
473 self.assertEqual(http.level, 0)
474 self.assertEqual(http.method, method)
475 self.assertEqual(http.selector, "/")
476 self.assertEqual(http.req_headers,
Jeremy Hyltonb3ee6f92004-02-24 19:40:35 +0000477 [("Connection", "close"),
478 ("Foo", "bar"), ("Spam", "eggs")])
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000479 self.assertEqual(http.data, data)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000480
481 # check socket.error converted to URLError
482 http.raise_on_endheaders = True
483 self.assertRaises(urllib2.URLError, h.do_open, http, req)
484
485 # check adding of standard headers
486 o.addheaders = [("Spam", "eggs")]
487 for data in "", None: # POST, GET
488 req = Request("http://example.com/", data)
489 r = MockResponse(200, "OK", {}, "")
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000490 newreq = h.do_request_(req)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000491 if data is None: # GET
492 self.assert_("Content-length" not in req.unredirected_hdrs)
493 self.assert_("Content-type" not in req.unredirected_hdrs)
494 else: # POST
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000495 self.assertEqual(req.unredirected_hdrs["Content-length"], "0")
496 self.assertEqual(req.unredirected_hdrs["Content-type"],
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000497 "application/x-www-form-urlencoded")
498 # XXX the details of Host could be better tested
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000499 self.assertEqual(req.unredirected_hdrs["Host"], "example.com")
500 self.assertEqual(req.unredirected_hdrs["Spam"], "eggs")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000501
502 # don't clobber existing headers
503 req.add_unredirected_header("Content-length", "foo")
504 req.add_unredirected_header("Content-type", "bar")
505 req.add_unredirected_header("Host", "baz")
506 req.add_unredirected_header("Spam", "foo")
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000507 newreq = h.do_request_(req)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000508 self.assertEqual(req.unredirected_hdrs["Content-length"], "foo")
509 self.assertEqual(req.unredirected_hdrs["Content-type"], "bar")
510 self.assertEqual(req.unredirected_hdrs["Host"], "baz")
511 self.assertEqual(req.unredirected_hdrs["Spam"], "foo")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000512
513 def test_errors(self):
514 h = urllib2.HTTPErrorProcessor()
515 o = h.parent = MockOpener()
516
517 url = "http://example.com/"
518 req = Request(url)
519 # 200 OK is passed through
520 r = MockResponse(200, "OK", {}, "", url)
521 newr = h.http_response(req, r)
522 self.assert_(r is newr)
523 self.assert_(not hasattr(o, "proto")) # o.error not called
524 # anything else calls o.error (and MockOpener returns None, here)
525 r = MockResponse(201, "Created", {}, "", url)
526 self.assert_(h.http_response(req, r) is None)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000527 self.assertEqual(o.proto, "http") # o.error called
528 self.assertEqual(o.args, (req, r, 201, "Created", {}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000529
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000530 def test_cookies(self):
531 cj = MockCookieJar()
532 h = urllib2.HTTPCookieProcessor(cj)
533 o = h.parent = MockOpener()
534
535 req = Request("http://example.com/")
536 r = MockResponse(200, "OK", {}, "")
537 newreq = h.http_request(req)
538 self.assert_(cj.ach_req is req is newreq)
539 self.assertEquals(req.get_origin_req_host(), "example.com")
540 self.assert_(not req.is_unverifiable())
541 newr = h.http_response(req, r)
542 self.assert_(cj.ec_req is req)
543 self.assert_(cj.ec_r is r is newr)
544
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000545 def test_redirect(self):
546 from_url = "http://example.com/a.html"
547 to_url = "http://example.com/b.html"
548 h = urllib2.HTTPRedirectHandler()
549 o = h.parent = MockOpener()
550
551 # ordinary redirect behaviour
552 for code in 301, 302, 303, 307:
553 for data in None, "blah\nblah\n":
554 method = getattr(h, "http_error_%s" % code)
555 req = Request(from_url, data)
556 req.add_header("Nonsense", "viking=withhold")
557 req.add_unredirected_header("Spam", "spam")
558 try:
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000559 method(req, MockFile(), code, "Blah",
560 MockHeaders({"location": to_url}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000561 except urllib2.HTTPError:
562 # 307 in response to POST requires user OK
563 self.assert_(code == 307 and data is not None)
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000564 self.assertEqual(o.req.get_full_url(), to_url)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000565 try:
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000566 self.assertEqual(o.req.get_method(), "GET")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000567 except AttributeError:
568 self.assert_(not o.req.has_data())
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000569 self.assertEqual(o.req.headers["Nonsense"],
570 "viking=withhold")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000571 self.assert_("Spam" not in o.req.headers)
572 self.assert_("Spam" not in o.req.unredirected_hdrs)
573
574 # loop detection
575 req = Request(from_url)
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000576 def redirect(h, req, url=to_url):
577 h.http_error_302(req, MockFile(), 302, "Blah",
578 MockHeaders({"location": url}))
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000579 # Note that the *original* request shares the same record of
580 # redirections with the sub-requests caused by the redirections.
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000581
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000582 # detect infinite loop redirect of a URL to itself
583 req = Request(from_url, origin_req_host="example.com")
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000584 count = 0
585 try:
586 while 1:
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000587 redirect(h, req, "http://example.com/")
588 count = count + 1
589 except urllib2.HTTPError:
590 # don't stop until max_repeats, because cookies may introduce state
591 self.assertEqual(count, urllib2.HTTPRedirectHandler.max_repeats)
592
593 # detect endless non-repeating chain of redirects
594 req = Request(from_url, origin_req_host="example.com")
595 count = 0
596 try:
597 while 1:
598 redirect(h, req, "http://example.com/%d" % count)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000599 count = count + 1
600 except urllib2.HTTPError:
Jeremy Hyltondf38ea92003-12-17 20:42:38 +0000601 self.assertEqual(count,
602 urllib2.HTTPRedirectHandler.max_redirections)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000603
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000604 def test_cookie_redirect(self):
605 class MockHTTPHandler(urllib2.HTTPHandler):
606 def __init__(self): self._count = 0
607 def http_open(self, req):
608 import mimetools
609 from StringIO import StringIO
610 if self._count == 0:
611 self._count = self._count + 1
612 msg = mimetools.Message(
613 StringIO("Location: http://www.cracker.com/\r\n\r\n"))
614 return self.parent.error(
615 "http", req, MockFile(), 302, "Found", msg)
616 else:
617 self.req = req
618 msg = mimetools.Message(StringIO("\r\n\r\n"))
619 return MockResponse(200, "OK", msg, "", req.get_full_url())
620 # cookies shouldn't leak into redirected requests
621 from cookielib import CookieJar
622 from urllib2 import build_opener, HTTPHandler, HTTPError, \
623 HTTPCookieProcessor
624
625 from test_cookielib import interact_netscape
626
627 cj = CookieJar()
628 interact_netscape(cj, "http://www.example.com/", "spam=eggs")
629 hh = MockHTTPHandler()
630 cp = HTTPCookieProcessor(cj)
631 o = build_opener(hh, cp)
632 o.open("http://www.example.com/")
633 self.assert_(not hh.req.has_header("Cookie"))
634
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000635
636class MiscTests(unittest.TestCase):
637
638 def test_build_opener(self):
639 class MyHTTPHandler(urllib2.HTTPHandler): pass
640 class FooHandler(urllib2.BaseHandler):
641 def foo_open(self): pass
642 class BarHandler(urllib2.BaseHandler):
643 def bar_open(self): pass
644
645 build_opener = urllib2.build_opener
646
647 o = build_opener(FooHandler, BarHandler)
648 self.opener_has_handler(o, FooHandler)
649 self.opener_has_handler(o, BarHandler)
650
651 # can take a mix of classes and instances
652 o = build_opener(FooHandler, BarHandler())
653 self.opener_has_handler(o, FooHandler)
654 self.opener_has_handler(o, BarHandler)
655
656 # subclasses of default handlers override default handlers
657 o = build_opener(MyHTTPHandler)
658 self.opener_has_handler(o, MyHTTPHandler)
659
660 # a particular case of overriding: default handlers can be passed
661 # in explicitly
662 o = build_opener()
663 self.opener_has_handler(o, urllib2.HTTPHandler)
664 o = build_opener(urllib2.HTTPHandler)
665 self.opener_has_handler(o, urllib2.HTTPHandler)
666 o = build_opener(urllib2.HTTPHandler())
667 self.opener_has_handler(o, urllib2.HTTPHandler)
668
669 def opener_has_handler(self, opener, handler_class):
670 for h in opener.handlers:
671 if h.__class__ == handler_class:
672 break
673 else:
674 self.assert_(False)
675
Andrew M. Kuchlingbd3200f2004-06-29 13:15:46 +0000676class NetworkTests(unittest.TestCase):
Andrew M. Kuchling85064ff2004-07-10 19:46:40 +0000677 def setUp(self):
678 if 0: # for debugging
679 import logging
680 logger = logging.getLogger("test_urllib2")
681 logger.addHandler(logging.StreamHandler())
682
Andrew M. Kuchlingbd3200f2004-06-29 13:15:46 +0000683 def test_range (self):
684 req = urllib2.Request("http://www.python.org",
685 headers={'Range': 'bytes=20-39'})
686 result = urllib2.urlopen(req)
687 data = result.read()
688 self.assertEqual(len(data), 20)
689
Andrew M. Kuchling85064ff2004-07-10 19:46:40 +0000690 # XXX The rest of these tests aren't very good -- they don't check much.
691 # They do sometimes catch some major disasters, though.
692
693 def test_ftp(self):
694 urls = [
695 'ftp://www.python.org/pub/python/misc/sousa.au',
696 'ftp://www.python.org/pub/tmp/blat',
697 'ftp://gatekeeper.research.compaq.com/pub/DEC/SRC'
698 '/research-reports/00README-Legal-Rules-Regs',
699 ]
700 self._test_urls(urls, self._extra_handlers())
701
702 def test_gopher(self):
703 urls = [
704 # Thanks to Fred for finding these!
705 'gopher://gopher.lib.ncsu.edu/11/library/stacks/Alex',
706 'gopher://gopher.vt.edu:10010/10/33',
707 ]
708 self._test_urls(urls, self._extra_handlers())
709
710 def test_file(self):
711 TESTFN = test_support.TESTFN
712 f = open(TESTFN, 'w')
713 try:
714 f.write('hi there\n')
715 f.close()
716 urls = [
717 'file:'+sanepathname2url(os.path.abspath(TESTFN)),
718
719 # XXX bug, should raise URLError
720 #('file://nonsensename/etc/passwd', None, urllib2.URLError)
721 ('file://nonsensename/etc/passwd', None, (OSError, socket.error))
722 ]
723 self._test_urls(urls, self._extra_handlers())
724 finally:
725 os.remove(TESTFN)
726
727 def test_http(self):
728 urls = [
729 'http://www.espn.com/', # redirect
730 'http://www.python.org/Spanish/Inquistion/',
731 ('http://www.python.org/cgi-bin/faqw.py',
732 'query=pythonistas&querytype=simple&casefold=yes&req=search', None),
733 'http://www.python.org/',
734 ]
735 self._test_urls(urls, self._extra_handlers())
736
737 # XXX Following test depends on machine configurations that are internal
738 # to CNRI. Need to set up a public server with the right authentication
739 # configuration for test purposes.
740
741## def test_cnri(self):
742## if socket.gethostname() == 'bitdiddle':
743## localhost = 'bitdiddle.cnri.reston.va.us'
744## elif socket.gethostname() == 'bitdiddle.concentric.net':
745## localhost = 'localhost'
746## else:
747## localhost = None
748## if localhost is not None:
749## urls = [
750## 'file://%s/etc/passwd' % localhost,
751## 'http://%s/simple/' % localhost,
752## 'http://%s/digest/' % localhost,
753## 'http://%s/not/found.h' % localhost,
754## ]
755
756## bauth = HTTPBasicAuthHandler()
757## bauth.add_password('basic_test_realm', localhost, 'jhylton',
758## 'password')
759## dauth = HTTPDigestAuthHandler()
760## dauth.add_password('digest_test_realm', localhost, 'jhylton',
761## 'password')
762
763## self._test_urls(urls, self._extra_handlers()+[bauth, dauth])
764
765 def _test_urls(self, urls, handlers):
766 import socket
767 import time
768 import logging
769 debug = logging.getLogger("test_urllib2").debug
770
771 urllib2.install_opener(urllib2.build_opener(*handlers))
772
773 for url in urls:
774 if isinstance(url, tuple):
775 url, req, expected_err = url
776 else:
777 req = expected_err = None
778 debug(url)
779 try:
780 f = urllib2.urlopen(url, req)
781 except (IOError, socket.error, OSError), err:
782 debug(err)
783 if expected_err:
784 self.assert_(isinstance(err, expected_err))
785 else:
786 buf = f.read()
787 f.close()
788 debug("read %d bytes" % len(buf))
789 debug("******** next url coming up...")
790 time.sleep(0.1)
791
792 def _extra_handlers(self):
793 handlers = []
794
795 handlers.append(urllib2.GopherHandler)
796
797 cfh = urllib2.CacheFTPHandler()
798 cfh.setTimeout(1)
799 handlers.append(cfh)
800
801## # XXX try out some custom proxy objects too!
802## def at_cnri(req):
803## host = req.get_host()
804## debug(host)
805## if host[-18:] == '.cnri.reston.va.us':
806## return True
807## p = CustomProxy('http', at_cnri, 'proxy.cnri.reston.va.us')
808## ph = CustomProxyHandler(p)
809## handlers.append(ph)
810
811 return handlers
Tim Peters27f88362004-07-08 04:22:35 +0000812
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000813
814def test_main(verbose=None):
Andrew M. Kuchlingbd3200f2004-06-29 13:15:46 +0000815 tests = (TrivialTests,
816 OpenerDirectorTests,
817 HandlerTests,
818 MiscTests)
819 if test_support.is_resource_enabled('network'):
820 tests += (NetworkTests,)
821 test_support.run_unittest(*tests)
Jeremy Hyltonc1be59f2003-12-14 05:27:34 +0000822
823if __name__ == "__main__":
824 test_main(verbose=True)