blob: 409a4f0904ba2e4a472037df7fcaeb9758cd482d [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
Barry Warsaw04f357c2002-07-23 19:04:11 +000014from test import test_support
Skip Montanaro419abda2001-10-01 17:47:44 +000015
Fred Drake22c07062005-02-11 17:59:08 +000016try:
17 unicode
18except NameError:
19 have_unicode = False
20else:
21 have_unicode = True
22
Skip Montanaro419abda2001-10-01 17:47:44 +000023alist = [{'astring': 'foo@bar.baz.spam',
24 'afloat': 7283.43,
Skip Montanaro3e7bba92001-10-19 16:06:52 +000025 'anint': 2**20,
26 'ashortlong': 2L,
Skip Montanaro419abda2001-10-01 17:47:44 +000027 'anotherlist': ['.zyx.41'],
28 'abase64': xmlrpclib.Binary("my dog has fleas"),
29 'boolean': xmlrpclib.False,
Andrew M. Kuchlingb12d97c2004-06-05 12:33:27 +000030 'unicode': u'\u4000\u6000\u8000',
31 u'ukey\u4000': 'regular value',
Fred Drakeba613c32005-02-10 18:33:30 +000032 'datetime1': xmlrpclib.DateTime('20050210T11:41:23'),
33 'datetime2': xmlrpclib.DateTime(
34 (2005, 02, 10, 11, 41, 23, 0, 1, -1)),
35 'datetime3': xmlrpclib.DateTime(
36 datetime.datetime(2005, 02, 10, 11, 41, 23)),
Skip Montanaro419abda2001-10-01 17:47:44 +000037 }]
38
39class XMLRPCTestCase(unittest.TestCase):
40
41 def test_dump_load(self):
42 self.assertEquals(alist,
43 xmlrpclib.loads(xmlrpclib.dumps((alist,)))[0][0])
44
Fred Drakeba613c32005-02-10 18:33:30 +000045 def test_dump_bare_datetime(self):
Skip Montanaro174dd222005-05-14 20:54:16 +000046 # This checks that an unwrapped datetime.date object can be handled
47 # by the marshalling code. This can't be done via test_dump_load()
48 # since with use_datetime set to 1 the unmarshaller would create
49 # datetime objects for the 'datetime[123]' keys as well
Fred Drakeba613c32005-02-10 18:33:30 +000050 dt = datetime.datetime(2005, 02, 10, 11, 41, 23)
51 s = xmlrpclib.dumps((dt,))
Skip Montanaro174dd222005-05-14 20:54:16 +000052 (newdt,), m = xmlrpclib.loads(s, use_datetime=1)
53 self.assertEquals(newdt, dt)
Fred Drakeba613c32005-02-10 18:33:30 +000054 self.assertEquals(m, None)
55
Skip Montanaro174dd222005-05-14 20:54:16 +000056 (newdt,), m = xmlrpclib.loads(s, use_datetime=0)
57 self.assertEquals(newdt, xmlrpclib.DateTime('20050210T11:41:23'))
58
Skip Montanarob131f042008-04-18 20:35:46 +000059 def test_datetime_before_1900(self):
Andrew M. Kuchlinga5489d42008-04-21 01:45:57 +000060 # same as before but with a date before 1900
Skip Montanarob131f042008-04-18 20:35:46 +000061 dt = datetime.datetime(1, 02, 10, 11, 41, 23)
62 s = xmlrpclib.dumps((dt,))
63 (newdt,), m = xmlrpclib.loads(s, use_datetime=1)
64 self.assertEquals(newdt, dt)
65 self.assertEquals(m, None)
66
67 (newdt,), m = xmlrpclib.loads(s, use_datetime=0)
68 self.assertEquals(newdt, xmlrpclib.DateTime('00010210T11:41:23'))
69
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +000070 def test_cmp_datetime_DateTime(self):
71 now = datetime.datetime.now()
72 dt = xmlrpclib.DateTime(now.timetuple())
73 self.assert_(dt == now)
74 self.assert_(now == dt)
75 then = now + datetime.timedelta(seconds=4)
76 self.assert_(then >= dt)
77 self.assert_(dt < then)
Skip Montanaro174dd222005-05-14 20:54:16 +000078
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +000079 def test_bug_1164912 (self):
80 d = xmlrpclib.DateTime()
Tim Peters536cf992005-12-25 23:18:31 +000081 ((new_d,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((d,),
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +000082 methodresponse=True))
83 self.assert_(isinstance(new_d.value, str))
84
85 # Check that the output of dumps() is still an 8-bit string
86 s = xmlrpclib.dumps((new_d,), methodresponse=True)
87 self.assert_(isinstance(s, str))
88
Martin v. Löwis07529352006-11-19 18:51:54 +000089 def test_newstyle_class(self):
90 class T(object):
91 pass
92 t = T()
93 t.x = 100
94 t.y = "Hello"
95 ((t2,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((t,)))
96 self.assertEquals(t2, t.__dict__)
97
Skip Montanaro3e7bba92001-10-19 16:06:52 +000098 def test_dump_big_long(self):
99 self.assertRaises(OverflowError, xmlrpclib.dumps, (2L**99,))
100
101 def test_dump_bad_dict(self):
102 self.assertRaises(TypeError, xmlrpclib.dumps, ({(1,2,3): 1},))
103
Facundo Batista5a3b5242007-07-13 10:43:44 +0000104 def test_dump_recursive_seq(self):
105 l = [1,2,3]
106 t = [3,4,5,l]
107 l.append(t)
108 self.assertRaises(TypeError, xmlrpclib.dumps, (l,))
109
110 def test_dump_recursive_dict(self):
111 d = {'1':1, '2':1}
112 t = {'3':3, 'd':d}
113 d['t'] = t
114 self.assertRaises(TypeError, xmlrpclib.dumps, (d,))
115
Skip Montanaro3e7bba92001-10-19 16:06:52 +0000116 def test_dump_big_int(self):
117 if sys.maxint > 2L**31-1:
118 self.assertRaises(OverflowError, xmlrpclib.dumps,
119 (int(2L**34),))
120
Facundo Batista5a3b5242007-07-13 10:43:44 +0000121 xmlrpclib.dumps((xmlrpclib.MAXINT, xmlrpclib.MININT))
122 self.assertRaises(OverflowError, xmlrpclib.dumps, (xmlrpclib.MAXINT+1,))
123 self.assertRaises(OverflowError, xmlrpclib.dumps, (xmlrpclib.MININT-1,))
124
125 def dummy_write(s):
126 pass
127
128 m = xmlrpclib.Marshaller()
129 m.dump_int(xmlrpclib.MAXINT, dummy_write)
130 m.dump_int(xmlrpclib.MININT, dummy_write)
131 self.assertRaises(OverflowError, m.dump_int, xmlrpclib.MAXINT+1, dummy_write)
132 self.assertRaises(OverflowError, m.dump_int, xmlrpclib.MININT-1, dummy_write)
133
134
Andrew M. Kuchling0b852032003-04-25 00:27:24 +0000135 def test_dump_none(self):
136 value = alist + [None]
137 arg1 = (alist + [None],)
138 strg = xmlrpclib.dumps(arg1, allow_none=True)
139 self.assertEquals(value,
140 xmlrpclib.loads(strg)[0][0])
141 self.assertRaises(TypeError, xmlrpclib.dumps, (arg1,))
142
Fred Drake22c07062005-02-11 17:59:08 +0000143 def test_default_encoding_issues(self):
144 # SF bug #1115989: wrong decoding in '_stringify'
145 utf8 = """<?xml version='1.0' encoding='iso-8859-1'?>
146 <params>
147 <param><value>
148 <string>abc \x95</string>
149 </value></param>
150 <param><value>
151 <struct>
152 <member>
153 <name>def \x96</name>
154 <value><string>ghi \x97</string></value>
155 </member>
156 </struct>
157 </value></param>
158 </params>
159 """
Tim Petersf754f5f2005-04-08 18:00:59 +0000160
161 # sys.setdefaultencoding() normally doesn't exist after site.py is
162 # loaded. reload(sys) is the way to get it back.
Fred Drake22c07062005-02-11 17:59:08 +0000163 old_encoding = sys.getdefaultencoding()
Tim Petersf754f5f2005-04-08 18:00:59 +0000164 setdefaultencoding_existed = hasattr(sys, "setdefaultencoding")
Fred Drake22c07062005-02-11 17:59:08 +0000165 reload(sys) # ugh!
166 sys.setdefaultencoding("iso-8859-1")
167 try:
168 (s, d), m = xmlrpclib.loads(utf8)
169 finally:
170 sys.setdefaultencoding(old_encoding)
Tim Petersf754f5f2005-04-08 18:00:59 +0000171 if not setdefaultencoding_existed:
172 del sys.setdefaultencoding
173
Fred Drake22c07062005-02-11 17:59:08 +0000174 items = d.items()
175 if have_unicode:
176 self.assertEquals(s, u"abc \x95")
177 self.assert_(isinstance(s, unicode))
178 self.assertEquals(items, [(u"def \x96", u"ghi \x97")])
179 self.assert_(isinstance(items[0][0], unicode))
180 self.assert_(isinstance(items[0][1], unicode))
181 else:
182 self.assertEquals(s, "abc \xc2\x95")
183 self.assertEquals(items, [("def \xc2\x96", "ghi \xc2\x97")])
184
Facundo Batista5a3b5242007-07-13 10:43:44 +0000185
186class HelperTestCase(unittest.TestCase):
187 def test_escape(self):
188 self.assertEqual(xmlrpclib.escape("a&b"), "a&amp;b")
189 self.assertEqual(xmlrpclib.escape("a<b"), "a&lt;b")
190 self.assertEqual(xmlrpclib.escape("a>b"), "a&gt;b")
191
192class FaultTestCase(unittest.TestCase):
193 def test_repr(self):
194 f = xmlrpclib.Fault(42, 'Test Fault')
195 self.assertEqual(repr(f), "<Fault 42: 'Test Fault'>")
196 self.assertEqual(repr(f), str(f))
197
198 def test_dump_fault(self):
199 f = xmlrpclib.Fault(42, 'Test Fault')
200 s = xmlrpclib.dumps((f,))
201 (newf,), m = xmlrpclib.loads(s)
202 self.assertEquals(newf, {'faultCode': 42, 'faultString': 'Test Fault'})
203 self.assertEquals(m, None)
204
205 s = xmlrpclib.Marshaller().dumps(f)
206 self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, s)
207
208
209class DateTimeTestCase(unittest.TestCase):
210 def test_default(self):
211 t = xmlrpclib.DateTime()
212
213 def test_time(self):
214 d = 1181399930.036952
215 t = xmlrpclib.DateTime(d)
216 self.assertEqual(str(t), time.strftime("%Y%m%dT%H:%M:%S", time.localtime(d)))
217
218 def test_time_tuple(self):
219 d = (2007,6,9,10,38,50,5,160,0)
220 t = xmlrpclib.DateTime(d)
221 self.assertEqual(str(t), '20070609T10:38:50')
222
223 def test_time_struct(self):
224 d = time.localtime(1181399930.036952)
225 t = xmlrpclib.DateTime(d)
226 self.assertEqual(str(t), time.strftime("%Y%m%dT%H:%M:%S", d))
227
228 def test_datetime_datetime(self):
229 d = datetime.datetime(2007,1,2,3,4,5)
230 t = xmlrpclib.DateTime(d)
231 self.assertEqual(str(t), '20070102T03:04:05')
232
Facundo Batista5a3b5242007-07-13 10:43:44 +0000233 def test_repr(self):
234 d = datetime.datetime(2007,1,2,3,4,5)
235 t = xmlrpclib.DateTime(d)
236 val ="<DateTime '20070102T03:04:05' at %x>" % id(t)
237 self.assertEqual(repr(t), val)
238
239 def test_decode(self):
240 d = ' 20070908T07:11:13 '
241 t1 = xmlrpclib.DateTime()
242 t1.decode(d)
243 tref = xmlrpclib.DateTime(datetime.datetime(2007,9,8,7,11,13))
244 self.assertEqual(t1, tref)
245
246 t2 = xmlrpclib._datetime(d)
247 self.assertEqual(t1, tref)
248
249class BinaryTestCase(unittest.TestCase):
250 def test_default(self):
251 t = xmlrpclib.Binary()
252 self.assertEqual(str(t), '')
253
254 def test_string(self):
255 d = '\x01\x02\x03abc123\xff\xfe'
256 t = xmlrpclib.Binary(d)
257 self.assertEqual(str(t), d)
258
259 def test_decode(self):
260 d = '\x01\x02\x03abc123\xff\xfe'
261 de = base64.encodestring(d)
262 t1 = xmlrpclib.Binary()
263 t1.decode(de)
264 self.assertEqual(str(t1), d)
265
266 t2 = xmlrpclib._binary(de)
267 self.assertEqual(str(t2), d)
268
269
Facundo Batistaa53872b2007-08-14 13:35:00 +0000270PORT = None
Skip Montanaro419abda2001-10-01 17:47:44 +0000271
Neal Norwitz653272f2008-01-26 07:26:12 +0000272# The evt is set twice. First when the server is ready to serve.
273# Second when the server has been shutdown. The user must clear
274# the event after it has been set the first time to catch the second set.
Facundo Batistaa53872b2007-08-14 13:35:00 +0000275def http_server(evt, numrequests):
276 class TestInstanceClass:
277 def div(self, x, y):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000278 return x // y
279
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000280 def _methodHelp(self, name):
281 if name == 'div':
282 return 'This is the div function'
283
284 def my_function():
285 '''This is my function'''
286 return True
287
Neal Norwitz70cea582008-03-28 06:34:03 +0000288 class MyXMLRPCServer(SimpleXMLRPCServer.SimpleXMLRPCServer):
289 def get_request(self):
290 # Ensure the socket is always non-blocking. On Linux, socket
291 # attributes are not inherited like they are on *BSD and Windows.
292 s, port = self.socket.accept()
293 s.setblocking(True)
294 return s, port
295
Facundo Batistaa53872b2007-08-14 13:35:00 +0000296 try:
Neal Norwitz70cea582008-03-28 06:34:03 +0000297 serv = MyXMLRPCServer(("localhost", 0),
298 logRequests=False, bind_and_activate=False)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000299 serv.socket.settimeout(3)
300 serv.server_bind()
301 global PORT
302 PORT = serv.socket.getsockname()[1]
303 serv.server_activate()
304 serv.register_introspection_functions()
305 serv.register_multicall_functions()
306 serv.register_function(pow)
307 serv.register_function(lambda x,y: x+y, 'add')
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000308 serv.register_function(my_function)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000309 serv.register_instance(TestInstanceClass())
Neal Norwitz653272f2008-01-26 07:26:12 +0000310 evt.set()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000311
312 # handle up to 'numrequests' requests
313 while numrequests > 0:
314 serv.handle_request()
315 numrequests -= 1
316
317 except socket.timeout:
318 pass
319 finally:
320 serv.socket.close()
321 PORT = None
322 evt.set()
323
Neal Norwitz08b50eb2008-01-26 08:26:00 +0000324# This function prevents errors like:
325# <ProtocolError for localhost:57527/RPC2: 500 Internal Server Error>
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000326def is_unavailable_exception(e):
327 '''Returns True if the given ProtocolError is the product of a server-side
328 exception caused by the 'temporarily unavailable' response sometimes
329 given by operations on non-blocking sockets.'''
Neal Norwitz653272f2008-01-26 07:26:12 +0000330
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000331 # sometimes we get a -1 error code and/or empty headers
Neal Norwitzed444e52008-01-27 18:19:04 +0000332 try:
333 if e.errcode == -1 or e.headers is None:
334 return True
335 exc_mess = e.headers.get('X-exception')
336 except AttributeError:
337 # Ignore socket.errors here.
338 exc_mess = str(e)
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000339
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000340 if exc_mess and 'temporarily unavailable' in exc_mess.lower():
341 return True
342
343 return False
344
345# NOTE: The tests in SimpleServerTestCase will ignore failures caused by
346# "temporarily unavailable" exceptions raised in SimpleXMLRPCServer. This
347# condition occurs infrequently on some platforms, frequently on others, and
348# is apparently caused by using SimpleXMLRPCServer with a non-blocking socket.
349# If the server class is updated at some point in the future to handle this
350# situation more gracefully, these tests should be modified appropriately.
351
Facundo Batista7f686fc2007-08-17 19:16:44 +0000352class SimpleServerTestCase(unittest.TestCase):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000353 def setUp(self):
Facundo Batista7f686fc2007-08-17 19:16:44 +0000354 # enable traceback reporting
355 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
356
Facundo Batistaa53872b2007-08-14 13:35:00 +0000357 self.evt = threading.Event()
Facundo Batista7f686fc2007-08-17 19:16:44 +0000358 # start server thread to handle requests
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000359 serv_args = (self.evt, 1)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000360 threading.Thread(target=http_server, args=serv_args).start()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000361
Neal Norwitz653272f2008-01-26 07:26:12 +0000362 # wait for the server to be ready
363 self.evt.wait()
364 self.evt.clear()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000365
366 def tearDown(self):
367 # wait on the server thread to terminate
368 self.evt.wait()
369
Facundo Batista7f686fc2007-08-17 19:16:44 +0000370 # disable traceback reporting
371 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
372
Facundo Batistaa53872b2007-08-14 13:35:00 +0000373 def test_simple1(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000374 try:
375 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
376 self.assertEqual(p.pow(6,8), 6**8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000377 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000378 # ignore failures due to non-blocking socket 'unavailable' errors
379 if not is_unavailable_exception(e):
380 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000381 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000382
Christian Heimes6c29be52008-01-19 16:39:27 +0000383 # [ch] The test 404 is causing lots of false alarms.
384 def XXXtest_404(self):
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000385 # send POST with httplib, it should return 404 header and
386 # 'Not Found' message.
387 conn = httplib.HTTPConnection('localhost', PORT)
388 conn.request('POST', '/this-is-not-valid')
389 response = conn.getresponse()
390 conn.close()
391
392 self.assertEqual(response.status, 404)
393 self.assertEqual(response.reason, 'Not Found')
394
Facundo Batistaa53872b2007-08-14 13:35:00 +0000395 def test_introspection1(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000396 try:
397 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
398 meth = p.system.listMethods()
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000399 expected_methods = set(['pow', 'div', 'my_function', 'add',
400 'system.listMethods', 'system.methodHelp',
401 'system.methodSignature', 'system.multicall'])
Facundo Batistac65a5f12007-08-21 00:16:21 +0000402 self.assertEqual(set(meth), expected_methods)
Neal Norwitz183c5342008-01-27 17:11:11 +0000403 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000404 # ignore failures due to non-blocking socket 'unavailable' errors
405 if not is_unavailable_exception(e):
406 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000407 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000408
409 def test_introspection2(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000410 try:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000411 # test _methodHelp()
Facundo Batistac65a5f12007-08-21 00:16:21 +0000412 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
413 divhelp = p.system.methodHelp('div')
414 self.assertEqual(divhelp, 'This is the div function')
Neal Norwitz183c5342008-01-27 17:11:11 +0000415 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000416 # ignore failures due to non-blocking socket 'unavailable' errors
417 if not is_unavailable_exception(e):
418 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000419 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000420
421 def test_introspection3(self):
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000422 try:
423 # test native doc
424 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
425 myfunction = p.system.methodHelp('my_function')
426 self.assertEqual(myfunction, 'This is my function')
Neal Norwitz183c5342008-01-27 17:11:11 +0000427 except (xmlrpclib.ProtocolError, socket.error), e:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000428 # ignore failures due to non-blocking socket 'unavailable' errors
429 if not is_unavailable_exception(e):
430 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000431 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000432
433 def test_introspection4(self):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000434 # the SimpleXMLRPCServer doesn't support signatures, but
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000435 # at least check that we can try making the call
Facundo Batistac65a5f12007-08-21 00:16:21 +0000436 try:
437 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
438 divsig = p.system.methodSignature('div')
439 self.assertEqual(divsig, 'signatures not supported')
Neal Norwitz183c5342008-01-27 17:11:11 +0000440 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000441 # ignore failures due to non-blocking socket 'unavailable' errors
442 if not is_unavailable_exception(e):
443 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000444 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000445
446 def test_multicall(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000447 try:
448 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
449 multicall = xmlrpclib.MultiCall(p)
450 multicall.add(2,3)
451 multicall.pow(6,8)
452 multicall.div(127,42)
453 add_result, pow_result, div_result = multicall()
454 self.assertEqual(add_result, 2+3)
455 self.assertEqual(pow_result, 6**8)
456 self.assertEqual(div_result, 127//42)
Neal Norwitz183c5342008-01-27 17:11:11 +0000457 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000458 # ignore failures due to non-blocking socket 'unavailable' errors
459 if not is_unavailable_exception(e):
460 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000461 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000462
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000463 def test_non_existing_multicall(self):
464 try:
465 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
466 multicall = xmlrpclib.MultiCall(p)
467 multicall.this_is_not_exists()
468 result = multicall()
469
470 # result.results contains;
471 # [{'faultCode': 1, 'faultString': '<type \'exceptions.Exception\'>:'
472 # 'method "this_is_not_exists" is not supported'>}]
473
474 self.assertEqual(result.results[0]['faultCode'], 1)
475 self.assertEqual(result.results[0]['faultString'],
476 '<type \'exceptions.Exception\'>:method "this_is_not_exists" '
477 'is not supported')
Neal Norwitz183c5342008-01-27 17:11:11 +0000478 except (xmlrpclib.ProtocolError, socket.error), e:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000479 # ignore failures due to non-blocking socket 'unavailable' errors
480 if not is_unavailable_exception(e):
481 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000482 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000483
484 def test_dotted_attribute(self):
Neal Norwitz162d7192008-03-23 04:08:30 +0000485 # Raises an AttributeError because private methods are not allowed.
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000486 self.assertRaises(AttributeError,
487 SimpleXMLRPCServer.resolve_dotted_attribute, str, '__add')
488
489 self.assert_(SimpleXMLRPCServer.resolve_dotted_attribute(str, 'title'))
Neal Norwitz162d7192008-03-23 04:08:30 +0000490 # Get the test to run faster by sending a request with test_simple1.
491 # This avoids waiting for the socket timeout.
492 self.test_simple1()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000493
Facundo Batista7f686fc2007-08-17 19:16:44 +0000494# This is a contrived way to make a failure occur on the server side
495# in order to test the _send_traceback_header flag on the server
496class FailingMessageClass(mimetools.Message):
497 def __getitem__(self, key):
498 key = key.lower()
499 if key == 'content-length':
500 return 'I am broken'
501 return mimetools.Message.__getitem__(self, key)
502
503
504class FailingServerTestCase(unittest.TestCase):
505 def setUp(self):
506 self.evt = threading.Event()
507 # start server thread to handle requests
Neal Norwitz162d7192008-03-23 04:08:30 +0000508 serv_args = (self.evt, 1)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000509 threading.Thread(target=http_server, args=serv_args).start()
510
Neal Norwitz653272f2008-01-26 07:26:12 +0000511 # wait for the server to be ready
512 self.evt.wait()
513 self.evt.clear()
Facundo Batista7f686fc2007-08-17 19:16:44 +0000514
515 def tearDown(self):
516 # wait on the server thread to terminate
517 self.evt.wait()
518 # reset flag
519 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
520 # reset message class
521 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = mimetools.Message
522
523 def test_basic(self):
524 # check that flag is false by default
525 flagval = SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header
526 self.assertEqual(flagval, False)
527
Facundo Batistac65a5f12007-08-21 00:16:21 +0000528 # enable traceback reporting
529 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
530
531 # test a call that shouldn't fail just as a smoke test
532 try:
533 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
534 self.assertEqual(p.pow(6,8), 6**8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000535 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000536 # ignore failures due to non-blocking socket 'unavailable' errors
537 if not is_unavailable_exception(e):
538 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000539 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batista7f686fc2007-08-17 19:16:44 +0000540
541 def test_fail_no_info(self):
542 # use the broken message class
543 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
544
545 try:
546 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
547 p.pow(6,8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000548 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000549 # ignore failures due to non-blocking socket 'unavailable' errors
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000550 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Facundo Batista492e5922007-08-29 10:28:28 +0000551 # The two server-side error headers shouldn't be sent back in this case
552 self.assertTrue(e.headers.get("X-exception") is None)
553 self.assertTrue(e.headers.get("X-traceback") is None)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000554 else:
555 self.fail('ProtocolError not raised')
556
557 def test_fail_with_info(self):
558 # use the broken message class
559 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
560
561 # Check that errors in the server send back exception/traceback
562 # info when flag is set
563 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
564
565 try:
566 p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
567 p.pow(6,8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000568 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000569 # ignore failures due to non-blocking socket 'unavailable' errors
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000570 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Facundo Batista492e5922007-08-29 10:28:28 +0000571 # We should get error info in the response
572 expected_err = "invalid literal for int() with base 10: 'I am broken'"
573 self.assertEqual(e.headers.get("x-exception"), expected_err)
574 self.assertTrue(e.headers.get("x-traceback") is not None)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000575 else:
576 self.fail('ProtocolError not raised')
577
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000578class CGIHandlerTestCase(unittest.TestCase):
579 def setUp(self):
580 self.cgi = SimpleXMLRPCServer.CGIXMLRPCRequestHandler()
581
582 def tearDown(self):
583 self.cgi = None
584
585 def test_cgi_get(self):
586 os.environ['REQUEST_METHOD'] = 'GET'
587 # if the method is GET and no request_text is given, it runs handle_get
588 # get sysout output
589 tmp = sys.stdout
590 sys.stdout = open(test_support.TESTFN, "w")
591 self.cgi.handle_request()
592 sys.stdout.close()
593 sys.stdout = tmp
594
595 # parse Status header
596 handle = open(test_support.TESTFN, "r").read()
597 status = handle.split()[1]
598 message = ' '.join(handle.split()[2:4])
599
600 self.assertEqual(status, '400')
601 self.assertEqual(message, 'Bad Request')
602
603 os.remove(test_support.TESTFN)
604 os.environ['REQUEST_METHOD'] = ''
605
606 def test_cgi_xmlrpc_response(self):
607 data = """<?xml version='1.0'?>
608<methodCall>
609 <methodName>test_method</methodName>
610 <params>
611 <param>
612 <value><string>foo</string></value>
613 </param>
614 <param>
615 <value><string>bar</string></value>
616 </param>
617 </params>
618</methodCall>
619"""
620 open("xmldata.txt", "w").write(data)
621 tmp1 = sys.stdin
622 tmp2 = sys.stdout
623
624 sys.stdin = open("xmldata.txt", "r")
625 sys.stdout = open(test_support.TESTFN, "w")
626
Georg Brandl9b08e052009-04-05 21:21:05 +0000627 os.environ['CONTENT_LENGTH'] = str(len(data))
628 try:
629 self.cgi.handle_request()
630 finally:
631 del os.environ['CONTENT_LENGTH']
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000632
633 sys.stdin.close()
634 sys.stdout.close()
635 sys.stdin = tmp1
636 sys.stdout = tmp2
637
638 # will respond exception, if so, our goal is achieved ;)
639 handle = open(test_support.TESTFN, "r").read()
640
641 # start with 44th char so as not to get http header, we just need only xml
642 self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, handle[44:])
643
644 os.remove("xmldata.txt")
645 os.remove(test_support.TESTFN)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000646
Georg Brandld2094602008-12-05 08:51:30 +0000647class FakeSocket:
648
649 def __init__(self):
650 self.data = StringIO.StringIO()
651
652 def send(self, buf):
653 self.data.write(buf)
654 return len(buf)
655
656 def sendall(self, buf):
657 self.data.write(buf)
658
659 def getvalue(self):
660 return self.data.getvalue()
661
662 def makefile(self, x, y):
663 raise RuntimeError
664
665class FakeTransport(xmlrpclib.Transport):
666 """A Transport instance that records instead of sending a request.
667
668 This class replaces the actual socket used by httplib with a
669 FakeSocket object that records the request. It doesn't provide a
670 response.
671 """
672
673 def make_connection(self, host):
674 conn = xmlrpclib.Transport.make_connection(self, host)
675 conn._conn.sock = self.fake_socket = FakeSocket()
676 return conn
677
678class TransportSubclassTestCase(unittest.TestCase):
679
680 def issue_request(self, transport_class):
681 """Return an HTTP request made via transport_class."""
682 transport = transport_class()
683 proxy = xmlrpclib.ServerProxy("http://example.com/",
684 transport=transport)
685 try:
686 proxy.pow(6, 8)
687 except RuntimeError:
688 return transport.fake_socket.getvalue()
689 return None
690
691 def test_custom_user_agent(self):
692 class TestTransport(FakeTransport):
693
694 def send_user_agent(self, conn):
695 xmlrpclib.Transport.send_user_agent(self, conn)
696 conn.putheader("X-Test", "test_custom_user_agent")
697
698 req = self.issue_request(TestTransport)
699 self.assert_("X-Test: test_custom_user_agent\r\n" in req)
700
701 def test_send_host(self):
702 class TestTransport(FakeTransport):
703
704 def send_host(self, conn, host):
705 xmlrpclib.Transport.send_host(self, conn, host)
706 conn.putheader("X-Test", "test_send_host")
707
708 req = self.issue_request(TestTransport)
709 self.assert_("X-Test: test_send_host\r\n" in req)
710
711 def test_send_request(self):
712 class TestTransport(FakeTransport):
713
714 def send_request(self, conn, url, body):
715 xmlrpclib.Transport.send_request(self, conn, url, body)
716 conn.putheader("X-Test", "test_send_request")
717
718 req = self.issue_request(TestTransport)
719 self.assert_("X-Test: test_send_request\r\n" in req)
720
721 def test_send_content(self):
722 class TestTransport(FakeTransport):
723
724 def send_content(self, conn, body):
725 conn.putheader("X-Test", "test_send_content")
726 xmlrpclib.Transport.send_content(self, conn, body)
727
728 req = self.issue_request(TestTransport)
729 self.assert_("X-Test: test_send_content\r\n" in req)
730
Facundo Batistaa53872b2007-08-14 13:35:00 +0000731def test_main():
732 xmlrpc_tests = [XMLRPCTestCase, HelperTestCase, DateTimeTestCase,
Georg Brandld2094602008-12-05 08:51:30 +0000733 BinaryTestCase, FaultTestCase, TransportSubclassTestCase]
Facundo Batistaa53872b2007-08-14 13:35:00 +0000734
735 # The test cases against a SimpleXMLRPCServer raise a socket error
736 # 10035 (WSAEWOULDBLOCK) in the server thread handle_request call when
737 # run on Windows. This only happens on the first test to run, but it
738 # fails every time and so these tests are skipped on win32 platforms.
739 if sys.platform != 'win32':
Facundo Batista7f686fc2007-08-17 19:16:44 +0000740 xmlrpc_tests.append(SimpleServerTestCase)
741 xmlrpc_tests.append(FailingServerTestCase)
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000742 xmlrpc_tests.append(CGIHandlerTestCase)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000743
744 test_support.run_unittest(*xmlrpc_tests)
Skip Montanaro419abda2001-10-01 17:47:44 +0000745
746if __name__ == "__main__":
747 test_main()