blob: 05154cc5b594bd15d719e2f84f8481f165efa5a1 [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
Jeremy Hylton89420112008-11-24 22:00:29 +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
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000270ADDR = PORT = URL = 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
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000296 serv = MyXMLRPCServer(("localhost", 0),
297 logRequests=False, bind_and_activate=False)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000298 try:
299 serv.socket.settimeout(3)
300 serv.server_bind()
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000301 global ADDR, PORT, URL
302 ADDR, PORT = serv.socket.getsockname()
303 #connect to IP address directly. This avoids socket.create_connection()
304 #trying to connect to to "localhost" using all address families, which
305 #causes slowdown e.g. on vista which supports AF_INET6. The server listens
306 #on AF_INET only.
307 URL = "http://%s:%d"%(ADDR, PORT)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000308 serv.server_activate()
309 serv.register_introspection_functions()
310 serv.register_multicall_functions()
311 serv.register_function(pow)
312 serv.register_function(lambda x,y: x+y, 'add')
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000313 serv.register_function(my_function)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000314 serv.register_instance(TestInstanceClass())
Neal Norwitz653272f2008-01-26 07:26:12 +0000315 evt.set()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000316
317 # handle up to 'numrequests' requests
318 while numrequests > 0:
319 serv.handle_request()
320 numrequests -= 1
321
322 except socket.timeout:
323 pass
324 finally:
325 serv.socket.close()
326 PORT = None
327 evt.set()
328
Neal Norwitz08b50eb2008-01-26 08:26:00 +0000329# This function prevents errors like:
330# <ProtocolError for localhost:57527/RPC2: 500 Internal Server Error>
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000331def is_unavailable_exception(e):
332 '''Returns True if the given ProtocolError is the product of a server-side
333 exception caused by the 'temporarily unavailable' response sometimes
334 given by operations on non-blocking sockets.'''
Neal Norwitz653272f2008-01-26 07:26:12 +0000335
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000336 # sometimes we get a -1 error code and/or empty headers
Neal Norwitzed444e52008-01-27 18:19:04 +0000337 try:
338 if e.errcode == -1 or e.headers is None:
339 return True
340 exc_mess = e.headers.get('X-exception')
341 except AttributeError:
342 # Ignore socket.errors here.
343 exc_mess = str(e)
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000344
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000345 if exc_mess and 'temporarily unavailable' in exc_mess.lower():
346 return True
347
348 return False
349
350# NOTE: The tests in SimpleServerTestCase will ignore failures caused by
351# "temporarily unavailable" exceptions raised in SimpleXMLRPCServer. This
352# condition occurs infrequently on some platforms, frequently on others, and
353# is apparently caused by using SimpleXMLRPCServer with a non-blocking socket.
354# If the server class is updated at some point in the future to handle this
355# situation more gracefully, these tests should be modified appropriately.
356
Facundo Batista7f686fc2007-08-17 19:16:44 +0000357class SimpleServerTestCase(unittest.TestCase):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000358 def setUp(self):
Facundo Batista7f686fc2007-08-17 19:16:44 +0000359 # enable traceback reporting
360 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
361
Facundo Batistaa53872b2007-08-14 13:35:00 +0000362 self.evt = threading.Event()
Facundo Batista7f686fc2007-08-17 19:16:44 +0000363 # start server thread to handle requests
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000364 serv_args = (self.evt, 1)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000365 threading.Thread(target=http_server, args=serv_args).start()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000366
Neal Norwitz653272f2008-01-26 07:26:12 +0000367 # wait for the server to be ready
368 self.evt.wait()
369 self.evt.clear()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000370
371 def tearDown(self):
372 # wait on the server thread to terminate
373 self.evt.wait()
374
Facundo Batista7f686fc2007-08-17 19:16:44 +0000375 # disable traceback reporting
376 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
377
Facundo Batistaa53872b2007-08-14 13:35:00 +0000378 def test_simple1(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000379 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000380 p = xmlrpclib.ServerProxy(URL)
Facundo Batistac65a5f12007-08-21 00:16:21 +0000381 self.assertEqual(p.pow(6,8), 6**8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000382 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000383 # ignore failures due to non-blocking socket 'unavailable' errors
384 if not is_unavailable_exception(e):
385 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000386 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000387
Christian Heimes6c29be52008-01-19 16:39:27 +0000388 # [ch] The test 404 is causing lots of false alarms.
389 def XXXtest_404(self):
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000390 # send POST with httplib, it should return 404 header and
391 # 'Not Found' message.
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000392 conn = httplib.HTTPConnection(ADDR, PORT)
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000393 conn.request('POST', '/this-is-not-valid')
394 response = conn.getresponse()
395 conn.close()
396
397 self.assertEqual(response.status, 404)
398 self.assertEqual(response.reason, 'Not Found')
399
Facundo Batistaa53872b2007-08-14 13:35:00 +0000400 def test_introspection1(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000401 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000402 p = xmlrpclib.ServerProxy(URL)
Facundo Batistac65a5f12007-08-21 00:16:21 +0000403 meth = p.system.listMethods()
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000404 expected_methods = set(['pow', 'div', 'my_function', 'add',
405 'system.listMethods', 'system.methodHelp',
406 'system.methodSignature', 'system.multicall'])
Facundo Batistac65a5f12007-08-21 00:16:21 +0000407 self.assertEqual(set(meth), expected_methods)
Neal Norwitz183c5342008-01-27 17:11:11 +0000408 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000409 # ignore failures due to non-blocking socket 'unavailable' errors
410 if not is_unavailable_exception(e):
411 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000412 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000413
414 def test_introspection2(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000415 try:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000416 # test _methodHelp()
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000417 p = xmlrpclib.ServerProxy(URL)
Facundo Batistac65a5f12007-08-21 00:16:21 +0000418 divhelp = p.system.methodHelp('div')
419 self.assertEqual(divhelp, 'This is the div function')
Neal Norwitz183c5342008-01-27 17:11:11 +0000420 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000421 # ignore failures due to non-blocking socket 'unavailable' errors
422 if not is_unavailable_exception(e):
423 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000424 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000425
426 def test_introspection3(self):
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000427 try:
428 # test native doc
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000429 p = xmlrpclib.ServerProxy(URL)
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000430 myfunction = p.system.methodHelp('my_function')
431 self.assertEqual(myfunction, 'This is my function')
Neal Norwitz183c5342008-01-27 17:11:11 +0000432 except (xmlrpclib.ProtocolError, socket.error), e:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000433 # ignore failures due to non-blocking socket 'unavailable' errors
434 if not is_unavailable_exception(e):
435 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000436 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000437
438 def test_introspection4(self):
Facundo Batistaa53872b2007-08-14 13:35:00 +0000439 # the SimpleXMLRPCServer doesn't support signatures, but
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000440 # at least check that we can try making the call
Facundo Batistac65a5f12007-08-21 00:16:21 +0000441 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000442 p = xmlrpclib.ServerProxy(URL)
Facundo Batistac65a5f12007-08-21 00:16:21 +0000443 divsig = p.system.methodSignature('div')
444 self.assertEqual(divsig, 'signatures not supported')
Neal Norwitz183c5342008-01-27 17:11:11 +0000445 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000446 # ignore failures due to non-blocking socket 'unavailable' errors
447 if not is_unavailable_exception(e):
448 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000449 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000450
451 def test_multicall(self):
Facundo Batistac65a5f12007-08-21 00:16:21 +0000452 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000453 p = xmlrpclib.ServerProxy(URL)
Facundo Batistac65a5f12007-08-21 00:16:21 +0000454 multicall = xmlrpclib.MultiCall(p)
455 multicall.add(2,3)
456 multicall.pow(6,8)
457 multicall.div(127,42)
458 add_result, pow_result, div_result = multicall()
459 self.assertEqual(add_result, 2+3)
460 self.assertEqual(pow_result, 6**8)
461 self.assertEqual(div_result, 127//42)
Neal Norwitz183c5342008-01-27 17:11:11 +0000462 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batistaf91ad6a2007-08-27 01:15:34 +0000463 # ignore failures due to non-blocking socket 'unavailable' errors
464 if not is_unavailable_exception(e):
465 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000466 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batistaa53872b2007-08-14 13:35:00 +0000467
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000468 def test_non_existing_multicall(self):
469 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000470 p = xmlrpclib.ServerProxy(URL)
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000471 multicall = xmlrpclib.MultiCall(p)
472 multicall.this_is_not_exists()
473 result = multicall()
474
475 # result.results contains;
476 # [{'faultCode': 1, 'faultString': '<type \'exceptions.Exception\'>:'
477 # 'method "this_is_not_exists" is not supported'>}]
478
479 self.assertEqual(result.results[0]['faultCode'], 1)
480 self.assertEqual(result.results[0]['faultString'],
481 '<type \'exceptions.Exception\'>:method "this_is_not_exists" '
482 'is not supported')
Neal Norwitz183c5342008-01-27 17:11:11 +0000483 except (xmlrpclib.ProtocolError, socket.error), e:
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000484 # ignore failures due to non-blocking socket 'unavailable' errors
485 if not is_unavailable_exception(e):
486 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000487 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000488
489 def test_dotted_attribute(self):
Neal Norwitz162d7192008-03-23 04:08:30 +0000490 # Raises an AttributeError because private methods are not allowed.
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000491 self.assertRaises(AttributeError,
492 SimpleXMLRPCServer.resolve_dotted_attribute, str, '__add')
493
494 self.assert_(SimpleXMLRPCServer.resolve_dotted_attribute(str, 'title'))
Neal Norwitz162d7192008-03-23 04:08:30 +0000495 # Get the test to run faster by sending a request with test_simple1.
496 # This avoids waiting for the socket timeout.
497 self.test_simple1()
Facundo Batistaa53872b2007-08-14 13:35:00 +0000498
Facundo Batista7f686fc2007-08-17 19:16:44 +0000499# This is a contrived way to make a failure occur on the server side
500# in order to test the _send_traceback_header flag on the server
501class FailingMessageClass(mimetools.Message):
502 def __getitem__(self, key):
503 key = key.lower()
504 if key == 'content-length':
505 return 'I am broken'
506 return mimetools.Message.__getitem__(self, key)
507
508
509class FailingServerTestCase(unittest.TestCase):
510 def setUp(self):
511 self.evt = threading.Event()
512 # start server thread to handle requests
Neal Norwitz162d7192008-03-23 04:08:30 +0000513 serv_args = (self.evt, 1)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000514 threading.Thread(target=http_server, args=serv_args).start()
515
Neal Norwitz653272f2008-01-26 07:26:12 +0000516 # wait for the server to be ready
517 self.evt.wait()
518 self.evt.clear()
Facundo Batista7f686fc2007-08-17 19:16:44 +0000519
520 def tearDown(self):
521 # wait on the server thread to terminate
522 self.evt.wait()
523 # reset flag
524 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
525 # reset message class
526 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = mimetools.Message
527
528 def test_basic(self):
529 # check that flag is false by default
530 flagval = SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header
531 self.assertEqual(flagval, False)
532
Facundo Batistac65a5f12007-08-21 00:16:21 +0000533 # enable traceback reporting
534 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
535
536 # test a call that shouldn't fail just as a smoke test
537 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000538 p = xmlrpclib.ServerProxy(URL)
Facundo Batistac65a5f12007-08-21 00:16:21 +0000539 self.assertEqual(p.pow(6,8), 6**8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000540 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000541 # ignore failures due to non-blocking socket 'unavailable' errors
542 if not is_unavailable_exception(e):
543 # protocol error; provide additional information in test output
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000544 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Facundo Batista7f686fc2007-08-17 19:16:44 +0000545
546 def test_fail_no_info(self):
547 # use the broken message class
548 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
549
550 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000551 p = xmlrpclib.ServerProxy(URL)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000552 p.pow(6,8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000553 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000554 # ignore failures due to non-blocking socket 'unavailable' errors
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000555 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Facundo Batista492e5922007-08-29 10:28:28 +0000556 # The two server-side error headers shouldn't be sent back in this case
557 self.assertTrue(e.headers.get("X-exception") is None)
558 self.assertTrue(e.headers.get("X-traceback") is None)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000559 else:
560 self.fail('ProtocolError not raised')
561
562 def test_fail_with_info(self):
563 # use the broken message class
564 SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
565
566 # Check that errors in the server send back exception/traceback
567 # info when flag is set
568 SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
569
570 try:
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000571 p = xmlrpclib.ServerProxy(URL)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000572 p.pow(6,8)
Neal Norwitz183c5342008-01-27 17:11:11 +0000573 except (xmlrpclib.ProtocolError, socket.error), e:
Facundo Batista492e5922007-08-29 10:28:28 +0000574 # ignore failures due to non-blocking socket 'unavailable' errors
Neal Norwitzcf25eb12008-01-27 20:03:13 +0000575 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Facundo Batista492e5922007-08-29 10:28:28 +0000576 # We should get error info in the response
577 expected_err = "invalid literal for int() with base 10: 'I am broken'"
578 self.assertEqual(e.headers.get("x-exception"), expected_err)
579 self.assertTrue(e.headers.get("x-traceback") is not None)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000580 else:
581 self.fail('ProtocolError not raised')
582
Georg Brandl5d1b4d42007-12-07 09:07:10 +0000583class CGIHandlerTestCase(unittest.TestCase):
584 def setUp(self):
585 self.cgi = SimpleXMLRPCServer.CGIXMLRPCRequestHandler()
586
587 def tearDown(self):
588 self.cgi = None
589
590 def test_cgi_get(self):
591 os.environ['REQUEST_METHOD'] = 'GET'
592 # if the method is GET and no request_text is given, it runs handle_get
593 # get sysout output
594 tmp = sys.stdout
595 sys.stdout = open(test_support.TESTFN, "w")
596 self.cgi.handle_request()
597 sys.stdout.close()
598 sys.stdout = tmp
599
600 # parse Status header
601 handle = open(test_support.TESTFN, "r").read()
602 status = handle.split()[1]
603 message = ' '.join(handle.split()[2:4])
604
605 self.assertEqual(status, '400')
606 self.assertEqual(message, 'Bad Request')
607
608 os.remove(test_support.TESTFN)
609 os.environ['REQUEST_METHOD'] = ''
610
611 def test_cgi_xmlrpc_response(self):
612 data = """<?xml version='1.0'?>
613<methodCall>
614 <methodName>test_method</methodName>
615 <params>
616 <param>
617 <value><string>foo</string></value>
618 </param>
619 <param>
620 <value><string>bar</string></value>
621 </param>
622 </params>
623</methodCall>
624"""
625 open("xmldata.txt", "w").write(data)
626 tmp1 = sys.stdin
627 tmp2 = sys.stdout
628
629 sys.stdin = open("xmldata.txt", "r")
630 sys.stdout = open(test_support.TESTFN, "w")
631
632 self.cgi.handle_request()
633
634 sys.stdin.close()
635 sys.stdout.close()
636 sys.stdin = tmp1
637 sys.stdout = tmp2
638
639 # will respond exception, if so, our goal is achieved ;)
640 handle = open(test_support.TESTFN, "r").read()
641
642 # start with 44th char so as not to get http header, we just need only xml
643 self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, handle[44:])
644
645 os.remove("xmldata.txt")
646 os.remove(test_support.TESTFN)
Facundo Batista7f686fc2007-08-17 19:16:44 +0000647
Jeremy Hylton89420112008-11-24 22:00:29 +0000648class FakeSocket:
649
650 def __init__(self):
651 self.data = StringIO.StringIO()
652
653 def send(self, buf):
654 self.data.write(buf)
655 return len(buf)
656
657 def sendall(self, buf):
658 self.data.write(buf)
659
660 def getvalue(self):
661 return self.data.getvalue()
662
Kristján Valur Jónsson3c43fcb2009-01-11 16:23:37 +0000663 def makefile(self, x='r', y=-1):
Jeremy Hylton89420112008-11-24 22:00:29 +0000664 raise RuntimeError
665
666class FakeTransport(xmlrpclib.Transport):
667 """A Transport instance that records instead of sending a request.
668
669 This class replaces the actual socket used by httplib with a
670 FakeSocket object that records the request. It doesn't provide a
671 response.
672 """
673
674 def make_connection(self, host):
675 conn = xmlrpclib.Transport.make_connection(self, host)
676 conn._conn.sock = self.fake_socket = FakeSocket()
677 return conn
678
679class TransportSubclassTestCase(unittest.TestCase):
680
681 def issue_request(self, transport_class):
682 """Return an HTTP request made via transport_class."""
683 transport = transport_class()
684 proxy = xmlrpclib.ServerProxy("http://example.com/",
685 transport=transport)
686 try:
687 proxy.pow(6, 8)
688 except RuntimeError:
689 return transport.fake_socket.getvalue()
690 return None
691
692 def test_custom_user_agent(self):
693 class TestTransport(FakeTransport):
694
695 def send_user_agent(self, conn):
696 xmlrpclib.Transport.send_user_agent(self, conn)
697 conn.putheader("X-Test", "test_custom_user_agent")
698
699 req = self.issue_request(TestTransport)
700 self.assert_("X-Test: test_custom_user_agent\r\n" in req)
701
702 def test_send_host(self):
703 class TestTransport(FakeTransport):
704
705 def send_host(self, conn, host):
706 xmlrpclib.Transport.send_host(self, conn, host)
707 conn.putheader("X-Test", "test_send_host")
708
709 req = self.issue_request(TestTransport)
710 self.assert_("X-Test: test_send_host\r\n" in req)
711
712 def test_send_request(self):
713 class TestTransport(FakeTransport):
714
715 def send_request(self, conn, url, body):
716 xmlrpclib.Transport.send_request(self, conn, url, body)
717 conn.putheader("X-Test", "test_send_request")
718
719 req = self.issue_request(TestTransport)
720 self.assert_("X-Test: test_send_request\r\n" in req)
721
722 def test_send_content(self):
723 class TestTransport(FakeTransport):
724
725 def send_content(self, conn, body):
726 conn.putheader("X-Test", "test_send_content")
727 xmlrpclib.Transport.send_content(self, conn, body)
728
729 req = self.issue_request(TestTransport)
730 self.assert_("X-Test: test_send_content\r\n" in req)
731
Facundo Batistaa53872b2007-08-14 13:35:00 +0000732def test_main():
733 xmlrpc_tests = [XMLRPCTestCase, HelperTestCase, DateTimeTestCase,
Jeremy Hylton89420112008-11-24 22:00:29 +0000734 BinaryTestCase, FaultTestCase, TransportSubclassTestCase]
Kristján Valur Jónsson018760e2009-01-14 10:50:57 +0000735 xmlrpc_tests.append(SimpleServerTestCase)
736 xmlrpc_tests.append(FailingServerTestCase)
737 xmlrpc_tests.append(CGIHandlerTestCase)
Facundo Batistaa53872b2007-08-14 13:35:00 +0000738
739 test_support.run_unittest(*xmlrpc_tests)
Skip Montanaro419abda2001-10-01 17:47:44 +0000740
741if __name__ == "__main__":
742 test_main()