blob: b9ac2e79cacbd1e660d78a784da72090c04af14c [file] [log] [blame]
Facundo Batista5a3b5242007-07-13 10:43:44 +00001import base64
Fred Drakeba613c32005-02-10 18:33:30 +00002import datetime
Skip Montanaro3e7bba92001-10-19 16:06:52 +00003import sys
Facundo Batista5a3b5242007-07-13 10:43:44 +00004import time
Skip Montanaro419abda2001-10-01 17:47:44 +00005import unittest
6import xmlrpclib
Facundo Batistaa53872b2007-08-14 13:35:00 +00007import SimpleXMLRPCServer
8import threading
Facundo Batista7f686fc2007-08-17 19:16:44 +00009import mimetools
Georg Brandl5d1b4d42007-12-07 09:07:10 +000010import httplib
11import socket
Georg Brandld2094602008-12-05 08:51:30 +000012import StringIO
Georg Brandl5d1b4d42007-12-07 09:07:10 +000013import os
Ezio Melotti9d196952010-08-03 05:50:57 +000014from imp import reload
Barry Warsaw04f357c2002-07-23 19:04:11 +000015from test import test_support
Skip Montanaro419abda2001-10-01 17:47:44 +000016
Fred Drake22c07062005-02-11 17:59:08 +000017try:
18 unicode
19except NameError:
20 have_unicode = False
21else:
22 have_unicode = True
23
Skip Montanaro419abda2001-10-01 17:47:44 +000024alist = [{'astring': 'foo@bar.baz.spam',
25 'afloat': 7283.43,
Skip Montanaro3e7bba92001-10-19 16:06:52 +000026 'anint': 2**20,
27 'ashortlong': 2L,
Skip Montanaro419abda2001-10-01 17:47:44 +000028 'anotherlist': ['.zyx.41'],
29 'abase64': xmlrpclib.Binary("my dog has fleas"),
30 'boolean': xmlrpclib.False,
Andrew M. Kuchlingb12d97c2004-06-05 12:33:27 +000031 'unicode': u'\u4000\u6000\u8000',
32 u'ukey\u4000': 'regular value',
Fred Drakeba613c32005-02-10 18:33:30 +000033 'datetime1': xmlrpclib.DateTime('20050210T11:41:23'),
34 'datetime2': xmlrpclib.DateTime(
35 (2005, 02, 10, 11, 41, 23, 0, 1, -1)),
36 'datetime3': xmlrpclib.DateTime(
37 datetime.datetime(2005, 02, 10, 11, 41, 23)),
Skip Montanaro419abda2001-10-01 17:47:44 +000038 }]
39
40class XMLRPCTestCase(unittest.TestCase):
41
42 def test_dump_load(self):
43 self.assertEquals(alist,
44 xmlrpclib.loads(xmlrpclib.dumps((alist,)))[0][0])
45
Fred Drakeba613c32005-02-10 18:33:30 +000046 def test_dump_bare_datetime(self):
Skip Montanaro174dd222005-05-14 20:54:16 +000047 # This checks that an unwrapped datetime.date object can be handled
48 # by the marshalling code. This can't be done via test_dump_load()
49 # since with use_datetime set to 1 the unmarshaller would create
50 # datetime objects for the 'datetime[123]' keys as well
Fred Drakeba613c32005-02-10 18:33:30 +000051 dt = datetime.datetime(2005, 02, 10, 11, 41, 23)
52 s = xmlrpclib.dumps((dt,))
Skip Montanaro174dd222005-05-14 20:54:16 +000053 (newdt,), m = xmlrpclib.loads(s, use_datetime=1)
54 self.assertEquals(newdt, dt)
Fred Drakeba613c32005-02-10 18:33:30 +000055 self.assertEquals(m, None)
56
Skip Montanaro174dd222005-05-14 20:54:16 +000057 (newdt,), m = xmlrpclib.loads(s, use_datetime=0)
58 self.assertEquals(newdt, xmlrpclib.DateTime('20050210T11:41:23'))
59
Skip Montanarob131f042008-04-18 20:35:46 +000060 def test_datetime_before_1900(self):
Andrew M. Kuchlinga5489d42008-04-21 01:45:57 +000061 # same as before but with a date before 1900
Skip Montanarob131f042008-04-18 20:35:46 +000062 dt = datetime.datetime(1, 02, 10, 11, 41, 23)
63 s = xmlrpclib.dumps((dt,))
64 (newdt,), m = xmlrpclib.loads(s, use_datetime=1)
65 self.assertEquals(newdt, dt)
66 self.assertEquals(m, None)
67
68 (newdt,), m = xmlrpclib.loads(s, use_datetime=0)
69 self.assertEquals(newdt, xmlrpclib.DateTime('00010210T11:41:23'))
70
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +000071 def test_cmp_datetime_DateTime(self):
72 now = datetime.datetime.now()
73 dt = xmlrpclib.DateTime(now.timetuple())
74 self.assert_(dt == now)
75 self.assert_(now == dt)
76 then = now + datetime.timedelta(seconds=4)
77 self.assert_(then >= dt)
78 self.assert_(dt < then)
Skip Montanaro174dd222005-05-14 20:54:16 +000079
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +000080 def test_bug_1164912 (self):
81 d = xmlrpclib.DateTime()
Tim Peters536cf992005-12-25 23:18:31 +000082 ((new_d,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((d,),
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +000083 methodresponse=True))
84 self.assert_(isinstance(new_d.value, str))
85
86 # Check that the output of dumps() is still an 8-bit string
87 s = xmlrpclib.dumps((new_d,), methodresponse=True)
88 self.assert_(isinstance(s, str))
89
Martin v. Löwis07529352006-11-19 18:51:54 +000090 def test_newstyle_class(self):
91 class T(object):
92 pass
93 t = T()
94 t.x = 100
95 t.y = "Hello"
96 ((t2,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((t,)))
97 self.assertEquals(t2, t.__dict__)
98
Skip Montanaro3e7bba92001-10-19 16:06:52 +000099 def test_dump_big_long(self):
100 self.assertRaises(OverflowError, xmlrpclib.dumps, (2L**99,))
101
102 def test_dump_bad_dict(self):
103 self.assertRaises(TypeError, xmlrpclib.dumps, ({(1,2,3): 1},))
104
Facundo Batista5a3b5242007-07-13 10:43:44 +0000105 def test_dump_recursive_seq(self):
106 l = [1,2,3]
107 t = [3,4,5,l]
108 l.append(t)
109 self.assertRaises(TypeError, xmlrpclib.dumps, (l,))
110
111 def test_dump_recursive_dict(self):
112 d = {'1':1, '2':1}
113 t = {'3':3, 'd':d}
114 d['t'] = t
115 self.assertRaises(TypeError, xmlrpclib.dumps, (d,))
116
Skip Montanaro3e7bba92001-10-19 16:06:52 +0000117 def test_dump_big_int(self):
118 if sys.maxint > 2L**31-1:
119 self.assertRaises(OverflowError, xmlrpclib.dumps,
120 (int(2L**34),))
121
Facundo Batista5a3b5242007-07-13 10:43:44 +0000122 xmlrpclib.dumps((xmlrpclib.MAXINT, xmlrpclib.MININT))
123 self.assertRaises(OverflowError, xmlrpclib.dumps, (xmlrpclib.MAXINT+1,))
124 self.assertRaises(OverflowError, xmlrpclib.dumps, (xmlrpclib.MININT-1,))
125
126 def dummy_write(s):
127 pass
128
129 m = xmlrpclib.Marshaller()
130 m.dump_int(xmlrpclib.MAXINT, dummy_write)
131 m.dump_int(xmlrpclib.MININT, dummy_write)
132 self.assertRaises(OverflowError, m.dump_int, xmlrpclib.MAXINT+1, dummy_write)
133 self.assertRaises(OverflowError, m.dump_int, xmlrpclib.MININT-1, dummy_write)
134
135
Andrew M. Kuchling0b852032003-04-25 00:27:24 +0000136 def test_dump_none(self):
137 value = alist + [None]
138 arg1 = (alist + [None],)
139 strg = xmlrpclib.dumps(arg1, allow_none=True)
140 self.assertEquals(value,
141 xmlrpclib.loads(strg)[0][0])
142 self.assertRaises(TypeError, xmlrpclib.dumps, (arg1,))
143
Fred Drake22c07062005-02-11 17:59:08 +0000144 def test_default_encoding_issues(self):
145 # SF bug #1115989: wrong decoding in '_stringify'
146 utf8 = """<?xml version='1.0' encoding='iso-8859-1'?>
147 <params>
148 <param><value>
149 <string>abc \x95</string>
150 </value></param>
151 <param><value>
152 <struct>
153 <member>
154 <name>def \x96</name>
155 <value><string>ghi \x97</string></value>
156 </member>
157 </struct>
158 </value></param>
159 </params>
160 """
Tim Petersf754f5f2005-04-08 18:00:59 +0000161
162 # sys.setdefaultencoding() normally doesn't exist after site.py is
163 # loaded. reload(sys) is the way to get it back.
Fred Drake22c07062005-02-11 17:59:08 +0000164 old_encoding = sys.getdefaultencoding()
Tim Petersf754f5f2005-04-08 18:00:59 +0000165 setdefaultencoding_existed = hasattr(sys, "setdefaultencoding")
Fred Drake22c07062005-02-11 17:59:08 +0000166 reload(sys) # ugh!
167 sys.setdefaultencoding("iso-8859-1")
168 try:
169 (s, d), m = xmlrpclib.loads(utf8)
170 finally:
171 sys.setdefaultencoding(old_encoding)
Tim Petersf754f5f2005-04-08 18:00:59 +0000172 if not setdefaultencoding_existed:
173 del sys.setdefaultencoding
174
Fred Drake22c07062005-02-11 17:59:08 +0000175 items = d.items()
176 if have_unicode:
177 self.assertEquals(s, u"abc \x95")
178 self.assert_(isinstance(s, unicode))
179 self.assertEquals(items, [(u"def \x96", u"ghi \x97")])
180 self.assert_(isinstance(items[0][0], unicode))
181 self.assert_(isinstance(items[0][1], unicode))
182 else:
183 self.assertEquals(s, "abc \xc2\x95")
184 self.assertEquals(items, [("def \xc2\x96", "ghi \xc2\x97")])
185
Facundo Batista5a3b5242007-07-13 10:43:44 +0000186
187class HelperTestCase(unittest.TestCase):
188 def test_escape(self):
189 self.assertEqual(xmlrpclib.escape("a&b"), "a&amp;b")
190 self.assertEqual(xmlrpclib.escape("a<b"), "a&lt;b")
191 self.assertEqual(xmlrpclib.escape("a>b"), "a&gt;b")
192
193class FaultTestCase(unittest.TestCase):
194 def test_repr(self):
195 f = xmlrpclib.Fault(42, 'Test Fault')
196 self.assertEqual(repr(f), "<Fault 42: 'Test Fault'>")
197 self.assertEqual(repr(f), str(f))
198
199 def test_dump_fault(self):
200 f = xmlrpclib.Fault(42, 'Test Fault')
201 s = xmlrpclib.dumps((f,))
202 (newf,), m = xmlrpclib.loads(s)
203 self.assertEquals(newf, {'faultCode': 42, 'faultString': 'Test Fault'})
204 self.assertEquals(m, None)
205
206 s = xmlrpclib.Marshaller().dumps(f)
207 self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, s)
208
209
210class DateTimeTestCase(unittest.TestCase):
211 def test_default(self):
212 t = xmlrpclib.DateTime()
213
214 def test_time(self):
215 d = 1181399930.036952
216 t = xmlrpclib.DateTime(d)
217 self.assertEqual(str(t), time.strftime("%Y%m%dT%H:%M:%S", time.localtime(d)))
218
219 def test_time_tuple(self):
220 d = (2007,6,9,10,38,50,5,160,0)
221 t = xmlrpclib.DateTime(d)
222 self.assertEqual(str(t), '20070609T10:38:50')
223
224 def test_time_struct(self):
225 d = time.localtime(1181399930.036952)
226 t = xmlrpclib.DateTime(d)
227 self.assertEqual(str(t), time.strftime("%Y%m%dT%H:%M:%S", d))
228
229 def test_datetime_datetime(self):
230 d = datetime.datetime(2007,1,2,3,4,5)
231 t = xmlrpclib.DateTime(d)
232 self.assertEqual(str(t), '20070102T03:04:05')
233
Facundo Batista5a3b5242007-07-13 10:43:44 +0000234 def test_repr(self):
235 d = datetime.datetime(2007,1,2,3,4,5)
236 t = xmlrpclib.DateTime(d)
237 val ="<DateTime '20070102T03:04:05' at %x>" % id(t)
238 self.assertEqual(repr(t), val)
239
240 def test_decode(self):
241 d = ' 20070908T07:11:13 '
242 t1 = xmlrpclib.DateTime()
243 t1.decode(d)
244 tref = xmlrpclib.DateTime(datetime.datetime(2007,9,8,7,11,13))
245 self.assertEqual(t1, tref)
246
247 t2 = xmlrpclib._datetime(d)
248 self.assertEqual(t1, tref)
249
250class BinaryTestCase(unittest.TestCase):
251 def test_default(self):
252 t = xmlrpclib.Binary()
253 self.assertEqual(str(t), '')
254
255 def test_string(self):
256 d = '\x01\x02\x03abc123\xff\xfe'
257 t = xmlrpclib.Binary(d)
258 self.assertEqual(str(t), d)
259
260 def test_decode(self):
261 d = '\x01\x02\x03abc123\xff\xfe'
262 de = base64.encodestring(d)
263 t1 = xmlrpclib.Binary()
264 t1.decode(de)
265 self.assertEqual(str(t1), d)
266
267 t2 = xmlrpclib._binary(de)
268 self.assertEqual(str(t2), d)
269
270
Facundo Batistaa53872b2007-08-14 13:35:00 +0000271PORT = None
Skip Montanaro419abda2001-10-01 17:47:44 +0000272
Neal Norwitz653272f2008-01-26 07:26:12 +0000273# The evt is set twice. First when the server is ready to serve.
274# Second when the server has been shutdown. The user must clear
275# the event after it has been set the first time to catch the second set.
Facundo Batistaa53872b2007-08-14 13:35:00 +0000276def http_server(evt, numrequests):
277 class TestInstanceClass:
278 def div(self, x, y):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000279 return x // y
280
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000281 def _methodHelp(self, name):
282 if name == 'div':
283 return 'This is the div function'
284
285 def my_function():
286 '''This is my function'''
287 return True
288
Neal Norwitz70cea582008-03-28 06:34:03 +0000289 class MyXMLRPCServer(SimpleXMLRPCServer.SimpleXMLRPCServer):
290 def get_request(self):
291 # Ensure the socket is always non-blocking. On Linux, socket
292 # attributes are not inherited like they are on *BSD and Windows.
293 s, port = self.socket.accept()
294 s.setblocking(True)
295 return s, port
296
Facundo Batistaa53872b2007-08-14 13:35:00 +0000297 try:
Neal Norwitz70cea582008-03-28 06:34:03 +0000298 serv = MyXMLRPCServer(("localhost", 0),
299 logRequests=False, bind_and_activate=False)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000300 serv.socket.settimeout(3)
301 serv.server_bind()
302 global PORT
303 PORT = serv.socket.getsockname()[1]
304 serv.server_activate()
305 serv.register_introspection_functions()
306 serv.register_multicall_functions()
307 serv.register_function(pow)
308 serv.register_function(lambda x,y: x+y, 'add')
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000309 serv.register_function(my_function)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000310 serv.register_instance(TestInstanceClass())
Neal Norwitz653272f2008-01-26 07:26:12 +0000311 evt.set()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000312
313 # handle up to 'numrequests' requests
314 while numrequests > 0:
315 serv.handle_request()
316 numrequests -= 1
317
318 except socket.timeout:
319 pass
320 finally:
321 serv.socket.close()
322 PORT = None
323 evt.set()
324
Neal Norwitz08b50eb2008-01-26 08:26:00 +0000325# This function prevents errors like:
326# <ProtocolError for localhost:57527/RPC2: 500 Internal Server Error>
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000327def is_unavailable_exception(e):
328 '''Returns True if the given ProtocolError is the product of a server-side
329 exception caused by the 'temporarily unavailable' response sometimes
330 given by operations on non-blocking sockets.'''
Neal Norwitz653272f2008-01-26 07:26:12 +0000331
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000332 # sometimes we get a -1 error code and/or empty headers
Neal Norwitzed444e52008-01-27 18:19:04 +0000333 try:
334 if e.errcode == -1 or e.headers is None:
335 return True
336 exc_mess = e.headers.get('X-exception')
337 except AttributeError:
338 # Ignore socket.errors here.
339 exc_mess = str(e)
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000340
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000341 if exc_mess and 'temporarily unavailable' in exc_mess.lower():
342 return True
343
344 return False
345
346# NOTE: The tests in SimpleServerTestCase will ignore failures caused by
347# "temporarily unavailable" exceptions raised in SimpleXMLRPCServer. This
348# condition occurs infrequently on some platforms, frequently on others, and
349# is apparently caused by using SimpleXMLRPCServer with a non-blocking socket.
350# If the server class is updated at some point in the future to handle this
351# situation more gracefully, these tests should be modified appropriately.
352
Facundo Batista7f686fc2007-08-17 19:16:44 +0000353class SimpleServerTestCase(unittest.TestCase):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000354 def setUp(self):
Facundo Batista7f686fc2007-08-17 19:16:44 +0000355 # enable traceback reporting
356 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
357
Facundo Batistaa53872b2007-08-14 13:35:00 +0000358 self.evt = threading.Event()
Facundo Batista7f686fc2007-08-17 19:16:44 +0000359 # start server thread to handle requests
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000360 serv_args = (self.evt, 1)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000361 threading.Thread(target=http_server, args=serv_args).start()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000362
Neal Norwitz653272f2008-01-26 07:26:12 +0000363 # wait for the server to be ready
364 self.evt.wait()
365 self.evt.clear()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000366
367 def tearDown(self):
368 # wait on the server thread to terminate
369 self.evt.wait()
370
Facundo Batista7f686fc2007-08-17 19:16:44 +0000371 # disable traceback reporting
372 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
373
Facundo Batistaa53872b2007-08-14 13:35:00 +0000374 def test_simple1(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000375 try:
376 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
377 self.assertEqual(p.pow(6,8), 6**8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000378 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000379 # ignore failures due to non-blocking socket 'unavailable' errors
380 if not is_unavailable_exception(e):
381 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000382 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000383
Christian Heimes6c29be52008-01-19 16:39:27 +0000384 # [ch] The test 404 is causing lots of false alarms.
385 def XXXtest_404(self):
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000386 # send POST with httplib, it should return 404 header and
387 # 'Not Found' message.
388 conn = httplib.HTTPConnection('localhost', PORT)
389 conn.request('POST', '/this-is-not-valid')
390 response = conn.getresponse()
391 conn.close()
392
393 self.assertEqual(response.status, 404)
394 self.assertEqual(response.reason, 'Not Found')
395
Facundo Batistaa53872b2007-08-14 13:35:00 +0000396 def test_introspection1(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000397 try:
398 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
399 meth = p.system.listMethods()
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000400 expected_methods = set(['pow', 'div', 'my_function', 'add',
401 'system.listMethods', 'system.methodHelp',
402 'system.methodSignature', 'system.multicall'])
Facundo Batistac65a5f12007-08-21 00:16:21 +0000403 self.assertEqual(set(meth), expected_methods)
Neal Norwitz183c5342008-01-27 17:11:11 +0000404 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000405 # ignore failures due to non-blocking socket 'unavailable' errors
406 if not is_unavailable_exception(e):
407 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000408 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000409
410 def test_introspection2(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000411 try:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000412 # test _methodHelp()
Facundo Batistac65a5f12007-08-21 00:16:21 +0000413 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
414 divhelp = p.system.methodHelp('div')
415 self.assertEqual(divhelp, 'This is the div function')
Neal Norwitz183c5342008-01-27 17:11:11 +0000416 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000417 # ignore failures due to non-blocking socket 'unavailable' errors
418 if not is_unavailable_exception(e):
419 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000420 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000421
422 def test_introspection3(self):
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000423 try:
424 # test native doc
425 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
426 myfunction = p.system.methodHelp('my_function')
427 self.assertEqual(myfunction, 'This is my function')
Neal Norwitz183c5342008-01-27 17:11:11 +0000428 except (xmlrpclib.ProtocolError, socket.error), e:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000429 # ignore failures due to non-blocking socket 'unavailable' errors
430 if not is_unavailable_exception(e):
431 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000432 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000433
434 def test_introspection4(self):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000435 # the SimpleXMLRPCServer doesn't support signatures, but
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000436 # at least check that we can try making the call
Facundo Batistac65a5f12007-08-21 00:16:21 +0000437 try:
438 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
439 divsig = p.system.methodSignature('div')
440 self.assertEqual(divsig, 'signatures not supported')
Neal Norwitz183c5342008-01-27 17:11:11 +0000441 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000442 # ignore failures due to non-blocking socket 'unavailable' errors
443 if not is_unavailable_exception(e):
444 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000445 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000446
447 def test_multicall(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000448 try:
449 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
450 multicall = xmlrpclib.MultiCall(p)
451 multicall.add(2,3)
452 multicall.pow(6,8)
453 multicall.div(127,42)
454 add_result, pow_result, div_result = multicall()
455 self.assertEqual(add_result, 2+3)
456 self.assertEqual(pow_result, 6**8)
457 self.assertEqual(div_result, 127//42)
Neal Norwitz183c5342008-01-27 17:11:11 +0000458 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000459 # ignore failures due to non-blocking socket 'unavailable' errors
460 if not is_unavailable_exception(e):
461 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000462 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000463
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000464 def test_non_existing_multicall(self):
465 try:
466 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
467 multicall = xmlrpclib.MultiCall(p)
468 multicall.this_is_not_exists()
469 result = multicall()
470
471 # result.results contains;
472 # [{'faultCode': 1, 'faultString': '<type \'exceptions.Exception\'>:'
473 # 'method "this_is_not_exists" is not supported'>}]
474
475 self.assertEqual(result.results[0]['faultCode'], 1)
476 self.assertEqual(result.results[0]['faultString'],
477 '<type \'exceptions.Exception\'>:method "this_is_not_exists" '
478 'is not supported')
Neal Norwitz183c5342008-01-27 17:11:11 +0000479 except (xmlrpclib.ProtocolError, socket.error), e:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000480 # ignore failures due to non-blocking socket 'unavailable' errors
481 if not is_unavailable_exception(e):
482 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000483 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000484
485 def test_dotted_attribute(self):
Neal Norwitz162d7192008-03-23 04:08:30 +0000486 # Raises an AttributeError because private methods are not allowed.
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000487 self.assertRaises(AttributeError,
488 SimpleXMLRPCServer.resolve_dotted_attribute, str, '__add')
489
490 self.assert_(SimpleXMLRPCServer.resolve_dotted_attribute(str, 'title'))
Neal Norwitz162d7192008-03-23 04:08:30 +0000491 # Get the test to run faster by sending a request with test_simple1.
492 # This avoids waiting for the socket timeout.
493 self.test_simple1()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000494
Facundo Batista7f686fc2007-08-17 19:16:44 +0000495# This is a contrived way to make a failure occur on the server side
496# in order to test the _send_traceback_header flag on the server
497class FailingMessageClass(mimetools.Message):
498 def __getitem__(self, key):
499 key = key.lower()
500 if key == 'content-length':
501 return 'I am broken'
502 return mimetools.Message.__getitem__(self, key)
503
504
505class FailingServerTestCase(unittest.TestCase):
506 def setUp(self):
507 self.evt = threading.Event()
508 # start server thread to handle requests
Neal Norwitz162d7192008-03-23 04:08:30 +0000509 serv_args = (self.evt, 1)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000510 threading.Thread(target=http_server, args=serv_args).start()
511
Neal Norwitz653272f2008-01-26 07:26:12 +0000512 # wait for the server to be ready
513 self.evt.wait()
514 self.evt.clear()
Facundo Batista7f686fc2007-08-17 19:16:44 +0000515
516 def tearDown(self):
517 # wait on the server thread to terminate
518 self.evt.wait()
519 # reset flag
520 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
521 # reset message class
522 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = mimetools.Message
523
524 def test_basic(self):
525 # check that flag is false by default
526 flagval = SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header
527 self.assertEqual(flagval, False)
528
Facundo Batistac65a5f12007-08-21 00:16:21 +0000529 # enable traceback reporting
530 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
531
532 # test a call that shouldn't fail just as a smoke test
533 try:
534 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
535 self.assertEqual(p.pow(6,8), 6**8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000536 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000537 # ignore failures due to non-blocking socket 'unavailable' errors
538 if not is_unavailable_exception(e):
539 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000540 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batista7f686fc2007-08-17 19:16:44 +0000541
542 def test_fail_no_info(self):
543 # use the broken message class
544 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
545
546 try:
547 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
548 p.pow(6,8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000549 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000550 # ignore failures due to non-blocking socket 'unavailable' errors
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000551 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Facundo Batista492e5922007-08-29 10:28:28 +0000552 # The two server-side error headers shouldn't be sent back in this case
553 self.assertTrue(e.headers.get("X-exception") is None)
554 self.assertTrue(e.headers.get("X-traceback") is None)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000555 else:
556 self.fail('ProtocolError not raised')
557
558 def test_fail_with_info(self):
559 # use the broken message class
560 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
561
562 # Check that errors in the server send back exception/traceback
563 # info when flag is set
564 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
565
566 try:
567 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
568 p.pow(6,8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000569 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000570 # ignore failures due to non-blocking socket 'unavailable' errors
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000571 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Facundo Batista492e5922007-08-29 10:28:28 +0000572 # We should get error info in the response
573 expected_err = "invalid literal for int() with base 10: 'I am broken'"
574 self.assertEqual(e.headers.get("x-exception"), expected_err)
575 self.assertTrue(e.headers.get("x-traceback") is not None)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000576 else:
577 self.fail('ProtocolError not raised')
578
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000579class CGIHandlerTestCase(unittest.TestCase):
580 def setUp(self):
581 self.cgi = SimpleXMLRPCServer.CGIXMLRPCRequestHandler()
582
583 def tearDown(self):
584 self.cgi = None
585
586 def test_cgi_get(self):
Walter Dörwald536120e2009-04-26 21:04:55 +0000587 with test_support.EnvironmentVarGuard() as env:
588 env.set('REQUEST_METHOD', 'GET')
589 # if the method is GET and no request_text is given, it runs handle_get
590 # get sysout output
591 tmp = sys.stdout
592 sys.stdout = open(test_support.TESTFN, "w")
593 self.cgi.handle_request()
594 sys.stdout.close()
595 sys.stdout = tmp
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000596
Walter Dörwald536120e2009-04-26 21:04:55 +0000597 # parse Status header
598 handle = open(test_support.TESTFN, "r").read()
599 status = handle.split()[1]
600 message = ' '.join(handle.split()[2:4])
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000601
Walter Dörwald536120e2009-04-26 21:04:55 +0000602 self.assertEqual(status, '400')
603 self.assertEqual(message, 'Bad Request')
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000604
Walter Dörwald536120e2009-04-26 21:04:55 +0000605 os.remove(test_support.TESTFN)
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000606
607 def test_cgi_xmlrpc_response(self):
608 data = """<?xml version='1.0'?>
609<methodCall>
610 <methodName>test_method</methodName>
611 <params>
612 <param>
613 <value><string>foo</string></value>
614 </param>
615 <param>
616 <value><string>bar</string></value>
617 </param>
618 </params>
619</methodCall>
620"""
621 open("xmldata.txt", "w").write(data)
622 tmp1 = sys.stdin
623 tmp2 = sys.stdout
624
625 sys.stdin = open("xmldata.txt", "r")
626 sys.stdout = open(test_support.TESTFN, "w")
627
Walter Dörwald536120e2009-04-26 21:04:55 +0000628 with test_support.EnvironmentVarGuard() as env:
629 env.set('CONTENT_LENGTH', str(len(data)))
Georg Brandl9b08e052009-04-05 21:21:05 +0000630 self.cgi.handle_request()
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000631
632 sys.stdin.close()
633 sys.stdout.close()
634 sys.stdin = tmp1
635 sys.stdout = tmp2
636
637 # will respond exception, if so, our goal is achieved ;)
638 handle = open(test_support.TESTFN, "r").read()
639
640 # start with 44th char so as not to get http header, we just need only xml
641 self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, handle[44:])
642
643 os.remove("xmldata.txt")
644 os.remove(test_support.TESTFN)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000645
Georg Brandld2094602008-12-05 08:51:30 +0000646class FakeSocket:
647
648 def __init__(self):
649 self.data = StringIO.StringIO()
650
651 def send(self, buf):
652 self.data.write(buf)
653 return len(buf)
654
655 def sendall(self, buf):
656 self.data.write(buf)
657
658 def getvalue(self):
659 return self.data.getvalue()
660
661 def makefile(self, x, y):
662 raise RuntimeError
663
664class FakeTransport(xmlrpclib.Transport):
665 """A Transport instance that records instead of sending a request.
666
667 This class replaces the actual socket used by httplib with a
668 FakeSocket object that records the request. It doesn't provide a
669 response.
670 """
671
672 def make_connection(self, host):
673 conn = xmlrpclib.Transport.make_connection(self, host)
674 conn._conn.sock = self.fake_socket = FakeSocket()
675 return conn
676
677class TransportSubclassTestCase(unittest.TestCase):
678
679 def issue_request(self, transport_class):
680 """Return an HTTP request made via transport_class."""
681 transport = transport_class()
682 proxy = xmlrpclib.ServerProxy("http://example.com/",
683 transport=transport)
684 try:
685 proxy.pow(6, 8)
686 except RuntimeError:
687 return transport.fake_socket.getvalue()
688 return None
689
690 def test_custom_user_agent(self):
691 class TestTransport(FakeTransport):
692
693 def send_user_agent(self, conn):
694 xmlrpclib.Transport.send_user_agent(self, conn)
695 conn.putheader("X-Test", "test_custom_user_agent")
696
697 req = self.issue_request(TestTransport)
698 self.assert_("X-Test: test_custom_user_agent\r\n" in req)
699
700 def test_send_host(self):
701 class TestTransport(FakeTransport):
702
703 def send_host(self, conn, host):
704 xmlrpclib.Transport.send_host(self, conn, host)
705 conn.putheader("X-Test", "test_send_host")
706
707 req = self.issue_request(TestTransport)
708 self.assert_("X-Test: test_send_host\r\n" in req)
709
710 def test_send_request(self):
711 class TestTransport(FakeTransport):
712
713 def send_request(self, conn, url, body):
714 xmlrpclib.Transport.send_request(self, conn, url, body)
715 conn.putheader("X-Test", "test_send_request")
716
717 req = self.issue_request(TestTransport)
718 self.assert_("X-Test: test_send_request\r\n" in req)
719
720 def test_send_content(self):
721 class TestTransport(FakeTransport):
722
723 def send_content(self, conn, body):
724 conn.putheader("X-Test", "test_send_content")
725 xmlrpclib.Transport.send_content(self, conn, body)
726
727 req = self.issue_request(TestTransport)
728 self.assert_("X-Test: test_send_content\r\n" in req)
729
Facundo Batistaa53872b2007-08-14 13:35:00 +0000730def test_main():
731 xmlrpc_tests = [XMLRPCTestCase, HelperTestCase, DateTimeTestCase,
Georg Brandld2094602008-12-05 08:51:30 +0000732 BinaryTestCase, FaultTestCase, TransportSubclassTestCase]
Facundo Batistaa53872b2007-08-14 13:35:00 +0000733
734 # The test cases against a SimpleXMLRPCServer raise a socket error
735 # 10035 (WSAEWOULDBLOCK) in the server thread handle_request call when
736 # run on Windows. This only happens on the first test to run, but it
737 # fails every time and so these tests are skipped on win32 platforms.
738 if sys.platform != 'win32':
Facundo Batista7f686fc2007-08-17 19:16:44 +0000739 xmlrpc_tests.append(SimpleServerTestCase)
740 xmlrpc_tests.append(FailingServerTestCase)
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000741 xmlrpc_tests.append(CGIHandlerTestCase)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000742
743 test_support.run_unittest(*xmlrpc_tests)
Skip Montanaro419abda2001-10-01 17:47:44 +0000744
745if __name__ == "__main__":
746 test_main()