blob: ef8ad217eae61fade3d6a4630a8f3fc14f0951ca [file] [log] [blame]
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001import base64
Fred Drakeba613c32005-02-10 18:33:30 +00002import datetime
Serhiy Storchaka352601c2016-09-11 11:23:38 +03003import decimal
Skip Montanaro3e7bba92001-10-19 16:06:52 +00004import sys
Guido van Rossumb5a755e2007-07-18 18:15:48 +00005import time
Skip Montanaro419abda2001-10-01 17:47:44 +00006import unittest
Ezio Melotti31916322013-08-10 18:37:05 +03007from unittest import mock
Georg Brandl38eceaa2008-05-26 11:14:17 +00008import xmlrpc.client as xmlrpclib
9import xmlrpc.server
Georg Brandl24420152008-05-26 16:32:26 +000010import http.client
Martin Pantereae33362016-02-25 11:53:40 +000011import http, http.server
Christian Heimes255f53b2007-12-08 15:33:56 +000012import socket
Senthil Kumaranb3af08f2009-04-01 20:20:43 +000013import re
R. David Murray0548ce02009-10-26 08:24:14 +000014import io
15import contextlib
Benjamin Petersonee8712c2008-05-20 21:35:26 +000016from test import support
Skip Montanaro419abda2001-10-01 17:47:44 +000017
Victor Stinner45df8202010-04-28 22:31:17 +000018try:
Brett Cannon603dcf22013-06-12 20:04:19 -040019 import gzip
Brett Cannon260fbe82013-07-04 18:16:15 -040020except ImportError:
Brett Cannon603dcf22013-06-12 20:04:19 -040021 gzip = None
22try:
Victor Stinner45df8202010-04-28 22:31:17 +000023 import threading
Brett Cannon260fbe82013-07-04 18:16:15 -040024except ImportError:
Victor Stinner45df8202010-04-28 22:31:17 +000025 threading = None
26
Skip Montanaro419abda2001-10-01 17:47:44 +000027alist = [{'astring': 'foo@bar.baz.spam',
28 'afloat': 7283.43,
Skip Montanaro3e7bba92001-10-19 16:06:52 +000029 'anint': 2**20,
Guido van Rossume2a383d2007-01-15 16:59:06 +000030 'ashortlong': 2,
Skip Montanaro419abda2001-10-01 17:47:44 +000031 'anotherlist': ['.zyx.41'],
Guido van Rossum54a40cb2007-08-27 22:27:41 +000032 'abase64': xmlrpclib.Binary(b"my dog has fleas"),
Florent Xicluna61665192011-11-15 20:53:25 +010033 'b64bytes': b"my dog has fleas",
34 'b64bytearray': bytearray(b"my dog has fleas"),
Guido van Rossume7ba4952007-06-06 23:52:48 +000035 'boolean': False,
Guido van Rossumef87d6e2007-05-02 19:09:54 +000036 'unicode': '\u4000\u6000\u8000',
37 'ukey\u4000': 'regular value',
Fred Drakeba613c32005-02-10 18:33:30 +000038 'datetime1': xmlrpclib.DateTime('20050210T11:41:23'),
39 'datetime2': xmlrpclib.DateTime(
Guido van Rossumcd16bf62007-06-13 18:07:49 +000040 (2005, 2, 10, 11, 41, 23, 0, 1, -1)),
Fred Drakeba613c32005-02-10 18:33:30 +000041 'datetime3': xmlrpclib.DateTime(
Guido van Rossumcd16bf62007-06-13 18:07:49 +000042 datetime.datetime(2005, 2, 10, 11, 41, 23)),
Skip Montanaro419abda2001-10-01 17:47:44 +000043 }]
44
45class XMLRPCTestCase(unittest.TestCase):
46
47 def test_dump_load(self):
Guido van Rossum54a40cb2007-08-27 22:27:41 +000048 dump = xmlrpclib.dumps((alist,))
49 load = xmlrpclib.loads(dump)
Ezio Melottib3aedd42010-11-20 19:04:17 +000050 self.assertEqual(alist, load[0][0])
Skip Montanaro419abda2001-10-01 17:47:44 +000051
Fred Drakeba613c32005-02-10 18:33:30 +000052 def test_dump_bare_datetime(self):
Skip Montanaro174dd222005-05-14 20:54:16 +000053 # This checks that an unwrapped datetime.date object can be handled
54 # by the marshalling code. This can't be done via test_dump_load()
Florent Xicluna61665192011-11-15 20:53:25 +010055 # since with use_builtin_types set to 1 the unmarshaller would create
Skip Montanaro174dd222005-05-14 20:54:16 +000056 # datetime objects for the 'datetime[123]' keys as well
Guido van Rossumcd16bf62007-06-13 18:07:49 +000057 dt = datetime.datetime(2005, 2, 10, 11, 41, 23)
Florent Xicluna61665192011-11-15 20:53:25 +010058 self.assertEqual(dt, xmlrpclib.DateTime('20050210T11:41:23'))
Fred Drakeba613c32005-02-10 18:33:30 +000059 s = xmlrpclib.dumps((dt,))
Fred Drakeba613c32005-02-10 18:33:30 +000060
Florent Xicluna61665192011-11-15 20:53:25 +010061 result, m = xmlrpclib.loads(s, use_builtin_types=True)
62 (newdt,) = result
63 self.assertEqual(newdt, dt)
64 self.assertIs(type(newdt), datetime.datetime)
65 self.assertIsNone(m)
66
67 result, m = xmlrpclib.loads(s, use_builtin_types=False)
68 (newdt,) = result
69 self.assertEqual(newdt, dt)
70 self.assertIs(type(newdt), xmlrpclib.DateTime)
71 self.assertIsNone(m)
72
73 result, m = xmlrpclib.loads(s, use_datetime=True)
74 (newdt,) = result
75 self.assertEqual(newdt, dt)
76 self.assertIs(type(newdt), datetime.datetime)
77 self.assertIsNone(m)
78
79 result, m = xmlrpclib.loads(s, use_datetime=False)
80 (newdt,) = result
81 self.assertEqual(newdt, dt)
82 self.assertIs(type(newdt), xmlrpclib.DateTime)
83 self.assertIsNone(m)
84
Skip Montanaro174dd222005-05-14 20:54:16 +000085
Christian Heimesdae2a892008-04-19 00:55:37 +000086 def test_datetime_before_1900(self):
Christian Heimes81ee3ef2008-05-04 22:42:01 +000087 # same as before but with a date before 1900
Christian Heimesdae2a892008-04-19 00:55:37 +000088 dt = datetime.datetime(1, 2, 10, 11, 41, 23)
Florent Xicluna61665192011-11-15 20:53:25 +010089 self.assertEqual(dt, xmlrpclib.DateTime('00010210T11:41:23'))
Christian Heimesdae2a892008-04-19 00:55:37 +000090 s = xmlrpclib.dumps((dt,))
Christian Heimesdae2a892008-04-19 00:55:37 +000091
Florent Xicluna61665192011-11-15 20:53:25 +010092 result, m = xmlrpclib.loads(s, use_builtin_types=True)
93 (newdt,) = result
94 self.assertEqual(newdt, dt)
95 self.assertIs(type(newdt), datetime.datetime)
96 self.assertIsNone(m)
97
98 result, m = xmlrpclib.loads(s, use_builtin_types=False)
99 (newdt,) = result
100 self.assertEqual(newdt, dt)
101 self.assertIs(type(newdt), xmlrpclib.DateTime)
102 self.assertIsNone(m)
Christian Heimesdae2a892008-04-19 00:55:37 +0000103
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +0000104 def test_bug_1164912 (self):
105 d = xmlrpclib.DateTime()
Tim Peters536cf992005-12-25 23:18:31 +0000106 ((new_d,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((d,),
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +0000107 methodresponse=True))
Ezio Melottie9615932010-01-24 19:26:24 +0000108 self.assertIsInstance(new_d.value, str)
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +0000109
110 # Check that the output of dumps() is still an 8-bit string
111 s = xmlrpclib.dumps((new_d,), methodresponse=True)
Ezio Melottie9615932010-01-24 19:26:24 +0000112 self.assertIsInstance(s, str)
Andrew M. Kuchlingbdb39012005-12-04 19:11:17 +0000113
Thomas Wouters89f507f2006-12-13 04:49:30 +0000114 def test_newstyle_class(self):
115 class T(object):
116 pass
117 t = T()
118 t.x = 100
119 t.y = "Hello"
120 ((t2,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((t,)))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000121 self.assertEqual(t2, t.__dict__)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000122
Skip Montanaro3e7bba92001-10-19 16:06:52 +0000123 def test_dump_big_long(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000124 self.assertRaises(OverflowError, xmlrpclib.dumps, (2**99,))
Skip Montanaro3e7bba92001-10-19 16:06:52 +0000125
126 def test_dump_bad_dict(self):
127 self.assertRaises(TypeError, xmlrpclib.dumps, ({(1,2,3): 1},))
128
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000129 def test_dump_recursive_seq(self):
130 l = [1,2,3]
131 t = [3,4,5,l]
132 l.append(t)
133 self.assertRaises(TypeError, xmlrpclib.dumps, (l,))
134
135 def test_dump_recursive_dict(self):
136 d = {'1':1, '2':1}
137 t = {'3':3, 'd':d}
138 d['t'] = t
139 self.assertRaises(TypeError, xmlrpclib.dumps, (d,))
140
Skip Montanaro3e7bba92001-10-19 16:06:52 +0000141 def test_dump_big_int(self):
Christian Heimesa37d4c62007-12-04 23:02:19 +0000142 if sys.maxsize > 2**31-1:
Skip Montanaro3e7bba92001-10-19 16:06:52 +0000143 self.assertRaises(OverflowError, xmlrpclib.dumps,
Guido van Rossume2a383d2007-01-15 16:59:06 +0000144 (int(2**34),))
Skip Montanaro3e7bba92001-10-19 16:06:52 +0000145
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000146 xmlrpclib.dumps((xmlrpclib.MAXINT, xmlrpclib.MININT))
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000147 self.assertRaises(OverflowError, xmlrpclib.dumps,
148 (xmlrpclib.MAXINT+1,))
149 self.assertRaises(OverflowError, xmlrpclib.dumps,
150 (xmlrpclib.MININT-1,))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000151
152 def dummy_write(s):
153 pass
154
155 m = xmlrpclib.Marshaller()
156 m.dump_int(xmlrpclib.MAXINT, dummy_write)
157 m.dump_int(xmlrpclib.MININT, dummy_write)
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000158 self.assertRaises(OverflowError, m.dump_int,
159 xmlrpclib.MAXINT+1, dummy_write)
160 self.assertRaises(OverflowError, m.dump_int,
161 xmlrpclib.MININT-1, dummy_write)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000162
Florent Xicluna1917ea92012-07-07 17:03:25 +0200163 def test_dump_double(self):
164 xmlrpclib.dumps((float(2 ** 34),))
165 xmlrpclib.dumps((float(xmlrpclib.MAXINT),
166 float(xmlrpclib.MININT)))
167 xmlrpclib.dumps((float(xmlrpclib.MAXINT + 42),
168 float(xmlrpclib.MININT - 42)))
169
170 def dummy_write(s):
171 pass
172
173 m = xmlrpclib.Marshaller()
174 m.dump_double(xmlrpclib.MAXINT, dummy_write)
175 m.dump_double(xmlrpclib.MININT, dummy_write)
176 m.dump_double(xmlrpclib.MAXINT + 42, dummy_write)
177 m.dump_double(xmlrpclib.MININT - 42, dummy_write)
178
Andrew M. Kuchling0b852032003-04-25 00:27:24 +0000179 def test_dump_none(self):
180 value = alist + [None]
181 arg1 = (alist + [None],)
182 strg = xmlrpclib.dumps(arg1, allow_none=True)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000183 self.assertEqual(value,
Andrew M. Kuchling0b852032003-04-25 00:27:24 +0000184 xmlrpclib.loads(strg)[0][0])
185 self.assertRaises(TypeError, xmlrpclib.dumps, (arg1,))
186
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200187 def test_dump_encoding(self):
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200188 value = {'key\u20ac\xa4':
189 'value\u20ac\xa4'}
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200190 strg = xmlrpclib.dumps((value,), encoding='iso-8859-15')
191 strg = "<?xml version='1.0' encoding='iso-8859-15'?>" + strg
192 self.assertEqual(xmlrpclib.loads(strg)[0][0], value)
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200193 strg = strg.encode('iso-8859-15', 'xmlcharrefreplace')
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200194 self.assertEqual(xmlrpclib.loads(strg)[0][0], value)
195
196 strg = xmlrpclib.dumps((value,), encoding='iso-8859-15',
197 methodresponse=True)
198 self.assertEqual(xmlrpclib.loads(strg)[0][0], value)
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200199 strg = strg.encode('iso-8859-15', 'xmlcharrefreplace')
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200200 self.assertEqual(xmlrpclib.loads(strg)[0][0], value)
201
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200202 methodname = 'method\u20ac\xa4'
203 strg = xmlrpclib.dumps((value,), encoding='iso-8859-15',
204 methodname=methodname)
205 self.assertEqual(xmlrpclib.loads(strg)[0][0], value)
206 self.assertEqual(xmlrpclib.loads(strg)[1], methodname)
207
Florent Xicluna61665192011-11-15 20:53:25 +0100208 def test_dump_bytes(self):
209 sample = b"my dog has fleas"
210 self.assertEqual(sample, xmlrpclib.Binary(sample))
211 for type_ in bytes, bytearray, xmlrpclib.Binary:
212 value = type_(sample)
213 s = xmlrpclib.dumps((value,))
214
215 result, m = xmlrpclib.loads(s, use_builtin_types=True)
216 (newvalue,) = result
217 self.assertEqual(newvalue, sample)
218 self.assertIs(type(newvalue), bytes)
219 self.assertIsNone(m)
220
221 result, m = xmlrpclib.loads(s, use_builtin_types=False)
222 (newvalue,) = result
223 self.assertEqual(newvalue, sample)
224 self.assertIs(type(newvalue), xmlrpclib.Binary)
225 self.assertIsNone(m)
226
Serhiy Storchaka290fed42016-05-04 11:26:42 +0300227 def test_loads_unsupported(self):
228 ResponseError = xmlrpclib.ResponseError
229 data = '<params><param><value><spam/></value></param></params>'
230 self.assertRaises(ResponseError, xmlrpclib.loads, data)
231 data = ('<params><param><value><array>'
232 '<value><spam/></value>'
233 '</array></value></param></params>')
234 self.assertRaises(ResponseError, xmlrpclib.loads, data)
235 data = ('<params><param><value><struct>'
236 '<member><name>a</name><value><spam/></value></member>'
237 '<member><name>b</name><value><spam/></value></member>'
238 '</struct></value></param></params>')
239 self.assertRaises(ResponseError, xmlrpclib.loads, data)
240
Serhiy Storchaka352601c2016-09-11 11:23:38 +0300241 def check_loads(self, s, value, **kwargs):
242 dump = '<params><param><value>%s</value></param></params>' % s
243 result, m = xmlrpclib.loads(dump, **kwargs)
244 (newvalue,) = result
245 self.assertEqual(newvalue, value)
246 self.assertIs(type(newvalue), type(value))
247 self.assertIsNone(m)
248
249 def test_load_standard_types(self):
250 check = self.check_loads
251 check('string', 'string')
252 check('<string>string</string>', 'string')
253 check('<string>𝔘𝔫𝔦𝔠𝔬𝔡𝔢 string</string>', '𝔘𝔫𝔦𝔠𝔬𝔡𝔢 string')
254 check('<int>2056183947</int>', 2056183947)
255 check('<int>-2056183947</int>', -2056183947)
256 check('<i4>2056183947</i4>', 2056183947)
257 check('<double>46093.78125</double>', 46093.78125)
258 check('<boolean>0</boolean>', False)
259 check('<base64>AGJ5dGUgc3RyaW5n/w==</base64>',
260 xmlrpclib.Binary(b'\x00byte string\xff'))
261 check('<base64>AGJ5dGUgc3RyaW5n/w==</base64>',
262 b'\x00byte string\xff', use_builtin_types=True)
263 check('<dateTime.iso8601>20050210T11:41:23</dateTime.iso8601>',
264 xmlrpclib.DateTime('20050210T11:41:23'))
265 check('<dateTime.iso8601>20050210T11:41:23</dateTime.iso8601>',
266 datetime.datetime(2005, 2, 10, 11, 41, 23),
267 use_builtin_types=True)
268 check('<array><data>'
269 '<value><int>1</int></value><value><int>2</int></value>'
270 '</data></array>', [1, 2])
271 check('<struct>'
272 '<member><name>b</name><value><int>2</int></value></member>'
273 '<member><name>a</name><value><int>1</int></value></member>'
274 '</struct>', {'a': 1, 'b': 2})
275
276 def test_load_extension_types(self):
277 check = self.check_loads
278 check('<nil/>', None)
279 check('<ex:nil/>', None)
280 check('<i1>205</i1>', 205)
281 check('<i2>20561</i2>', 20561)
282 check('<i8>9876543210</i8>', 9876543210)
283 check('<biginteger>98765432100123456789</biginteger>',
284 98765432100123456789)
285 check('<float>93.78125</float>', 93.78125)
286 check('<bigdecimal>9876543210.0123456789</bigdecimal>',
287 decimal.Decimal('9876543210.0123456789'))
288
Georg Brandlc8dcfb62009-02-13 10:50:01 +0000289 def test_get_host_info(self):
290 # see bug #3613, this raised a TypeError
291 transp = xmlrpc.client.Transport()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000292 self.assertEqual(transp.get_host_info("user@host.tld"),
Georg Brandlc8dcfb62009-02-13 10:50:01 +0000293 ('host.tld',
294 [('Authorization', 'Basic dXNlcg==')], {}))
295
Senthil Kumaran8ce1f1f2010-11-18 15:00:53 +0000296 def test_ssl_presence(self):
Senthil Kumaran6a0b5c42010-11-18 17:08:48 +0000297 try:
298 import ssl
Antoine Pitrou98b644f2010-11-19 20:07:52 +0000299 except ImportError:
300 has_ssl = False
Senthil Kumaran8ce1f1f2010-11-18 15:00:53 +0000301 else:
Senthil Kumaran6a0b5c42010-11-18 17:08:48 +0000302 has_ssl = True
Senthil Kumaran8ce1f1f2010-11-18 15:00:53 +0000303 try:
304 xmlrpc.client.ServerProxy('https://localhost:9999').bad_function()
Senthil Kumaran6a0b5c42010-11-18 17:08:48 +0000305 except NotImplementedError:
306 self.assertFalse(has_ssl, "xmlrpc client's error with SSL support")
Andrew Svetlov0832af62012-12-18 23:10:48 +0200307 except OSError:
Senthil Kumaran6a0b5c42010-11-18 17:08:48 +0000308 self.assertTrue(has_ssl)
Ezio Melottie9615932010-01-24 19:26:24 +0000309
Martin Pantereae33362016-02-25 11:53:40 +0000310 @unittest.skipUnless(threading, "Threading required for this test.")
311 def test_keepalive_disconnect(self):
312 class RequestHandler(http.server.BaseHTTPRequestHandler):
313 protocol_version = "HTTP/1.1"
314 handled = False
315
316 def do_POST(self):
317 length = int(self.headers.get("Content-Length"))
318 self.rfile.read(length)
319 if self.handled:
320 self.close_connection = True
321 return
322 response = xmlrpclib.dumps((5,), methodresponse=True)
323 response = response.encode()
324 self.send_response(http.HTTPStatus.OK)
325 self.send_header("Content-Length", len(response))
326 self.end_headers()
327 self.wfile.write(response)
328 self.handled = True
329 self.close_connection = False
330
331 def run_server():
332 server.socket.settimeout(float(1)) # Don't hang if client fails
333 server.handle_request() # First request and attempt at second
334 server.handle_request() # Retried second request
335
336 server = http.server.HTTPServer((support.HOST, 0), RequestHandler)
337 self.addCleanup(server.server_close)
338 thread = threading.Thread(target=run_server)
339 thread.start()
340 self.addCleanup(thread.join)
341 url = "http://{}:{}/".format(*server.server_address)
342 with xmlrpclib.ServerProxy(url) as p:
343 self.assertEqual(p.method(), 5)
344 self.assertEqual(p.method(), 5)
345
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000346class HelperTestCase(unittest.TestCase):
347 def test_escape(self):
348 self.assertEqual(xmlrpclib.escape("a&b"), "a&amp;b")
349 self.assertEqual(xmlrpclib.escape("a<b"), "a&lt;b")
350 self.assertEqual(xmlrpclib.escape("a>b"), "a&gt;b")
351
352class FaultTestCase(unittest.TestCase):
353 def test_repr(self):
354 f = xmlrpclib.Fault(42, 'Test Fault')
355 self.assertEqual(repr(f), "<Fault 42: 'Test Fault'>")
356 self.assertEqual(repr(f), str(f))
357
358 def test_dump_fault(self):
359 f = xmlrpclib.Fault(42, 'Test Fault')
360 s = xmlrpclib.dumps((f,))
361 (newf,), m = xmlrpclib.loads(s)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000362 self.assertEqual(newf, {'faultCode': 42, 'faultString': 'Test Fault'})
363 self.assertEqual(m, None)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000364
365 s = xmlrpclib.Marshaller().dumps(f)
366 self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, s)
367
Christian Heimeseda9e2b2007-12-08 22:32:47 +0000368 def test_dotted_attribute(self):
Florent Xiclunac4fec932011-10-30 20:19:32 +0100369 # this will raise AttributeError because code don't want us to use
Christian Heimeseda9e2b2007-12-08 22:32:47 +0000370 # private methods
371 self.assertRaises(AttributeError,
Georg Brandl38eceaa2008-05-26 11:14:17 +0000372 xmlrpc.server.resolve_dotted_attribute, str, '__add')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000373 self.assertTrue(xmlrpc.server.resolve_dotted_attribute(str, 'title'))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000374
375class DateTimeTestCase(unittest.TestCase):
376 def test_default(self):
Ezio Melotti31916322013-08-10 18:37:05 +0300377 with mock.patch('time.localtime') as localtime_mock:
378 time_struct = time.struct_time(
379 [2013, 7, 15, 0, 24, 49, 0, 196, 0])
380 localtime_mock.return_value = time_struct
381 localtime = time.localtime()
382 t = xmlrpclib.DateTime()
383 self.assertEqual(str(t),
384 time.strftime("%Y%m%dT%H:%M:%S", localtime))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000385
386 def test_time(self):
387 d = 1181399930.036952
388 t = xmlrpclib.DateTime(d)
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000389 self.assertEqual(str(t),
390 time.strftime("%Y%m%dT%H:%M:%S", time.localtime(d)))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000391
392 def test_time_tuple(self):
393 d = (2007,6,9,10,38,50,5,160,0)
394 t = xmlrpclib.DateTime(d)
395 self.assertEqual(str(t), '20070609T10:38:50')
396
397 def test_time_struct(self):
398 d = time.localtime(1181399930.036952)
399 t = xmlrpclib.DateTime(d)
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000400 self.assertEqual(str(t), time.strftime("%Y%m%dT%H:%M:%S", d))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000401
402 def test_datetime_datetime(self):
403 d = datetime.datetime(2007,1,2,3,4,5)
404 t = xmlrpclib.DateTime(d)
405 self.assertEqual(str(t), '20070102T03:04:05')
406
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000407 def test_repr(self):
408 d = datetime.datetime(2007,1,2,3,4,5)
409 t = xmlrpclib.DateTime(d)
Serhiy Storchaka0c937b32014-07-22 12:14:52 +0300410 val ="<DateTime '20070102T03:04:05' at %#x>" % id(t)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000411 self.assertEqual(repr(t), val)
412
413 def test_decode(self):
414 d = ' 20070908T07:11:13 '
415 t1 = xmlrpclib.DateTime()
416 t1.decode(d)
417 tref = xmlrpclib.DateTime(datetime.datetime(2007,9,8,7,11,13))
418 self.assertEqual(t1, tref)
419
420 t2 = xmlrpclib._datetime(d)
Ezio Melotti31916322013-08-10 18:37:05 +0300421 self.assertEqual(t2, tref)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000422
Florent Xicluna3fa29f72011-10-30 20:18:50 +0100423 def test_comparison(self):
424 now = datetime.datetime.now()
425 dtime = xmlrpclib.DateTime(now.timetuple())
426
427 # datetime vs. DateTime
428 self.assertTrue(dtime == now)
429 self.assertTrue(now == dtime)
430 then = now + datetime.timedelta(seconds=4)
431 self.assertTrue(then >= dtime)
432 self.assertTrue(dtime < then)
433
434 # str vs. DateTime
435 dstr = now.strftime("%Y%m%dT%H:%M:%S")
436 self.assertTrue(dtime == dstr)
437 self.assertTrue(dstr == dtime)
438 dtime_then = xmlrpclib.DateTime(then.timetuple())
439 self.assertTrue(dtime_then >= dstr)
440 self.assertTrue(dstr < dtime_then)
441
442 # some other types
443 dbytes = dstr.encode('ascii')
444 dtuple = now.timetuple()
445 with self.assertRaises(TypeError):
446 dtime == 1970
447 with self.assertRaises(TypeError):
448 dtime != dbytes
449 with self.assertRaises(TypeError):
450 dtime == bytearray(dbytes)
451 with self.assertRaises(TypeError):
452 dtime != dtuple
453 with self.assertRaises(TypeError):
454 dtime < float(1970)
455 with self.assertRaises(TypeError):
456 dtime > dbytes
457 with self.assertRaises(TypeError):
458 dtime <= bytearray(dbytes)
459 with self.assertRaises(TypeError):
460 dtime >= dtuple
461
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000462class BinaryTestCase(unittest.TestCase):
Guido van Rossum54a40cb2007-08-27 22:27:41 +0000463
464 # XXX What should str(Binary(b"\xff")) return? I'm chosing "\xff"
465 # for now (i.e. interpreting the binary data as Latin-1-encoded
466 # text). But this feels very unsatisfactory. Perhaps we should
467 # only define repr(), and return r"Binary(b'\xff')" instead?
468
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000469 def test_default(self):
470 t = xmlrpclib.Binary()
471 self.assertEqual(str(t), '')
472
473 def test_string(self):
Guido van Rossum54a40cb2007-08-27 22:27:41 +0000474 d = b'\x01\x02\x03abc123\xff\xfe'
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000475 t = xmlrpclib.Binary(d)
Guido van Rossum54a40cb2007-08-27 22:27:41 +0000476 self.assertEqual(str(t), str(d, "latin-1"))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000477
478 def test_decode(self):
Guido van Rossum54a40cb2007-08-27 22:27:41 +0000479 d = b'\x01\x02\x03abc123\xff\xfe'
Georg Brandlb54d8012009-06-04 09:11:51 +0000480 de = base64.encodebytes(d)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000481 t1 = xmlrpclib.Binary()
482 t1.decode(de)
Guido van Rossum54a40cb2007-08-27 22:27:41 +0000483 self.assertEqual(str(t1), str(d, "latin-1"))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000484
485 t2 = xmlrpclib._binary(de)
Guido van Rossum54a40cb2007-08-27 22:27:41 +0000486 self.assertEqual(str(t2), str(d, "latin-1"))
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000487
488
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000489ADDR = PORT = URL = None
Skip Montanaro419abda2001-10-01 17:47:44 +0000490
Christian Heimesaf98da12008-01-27 15:18:18 +0000491# The evt is set twice. First when the server is ready to serve.
492# Second when the server has been shutdown. The user must clear
493# the event after it has been set the first time to catch the second set.
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200494def http_server(evt, numrequests, requestHandler=None, encoding=None):
Guido van Rossumaf554a02007-08-16 23:48:43 +0000495 class TestInstanceClass:
496 def div(self, x, y):
Guido van Rossumaf554a02007-08-16 23:48:43 +0000497 return x // y
498
Christian Heimes255f53b2007-12-08 15:33:56 +0000499 def _methodHelp(self, name):
500 if name == 'div':
501 return 'This is the div function'
502
R David Murrayaaf17b32013-10-11 12:09:51 -0400503 class Fixture:
504 @staticmethod
505 def getData():
506 return '42'
507
Georg Brandl38eceaa2008-05-26 11:14:17 +0000508 class MyXMLRPCServer(xmlrpc.server.SimpleXMLRPCServer):
Christian Heimesbbe741d2008-03-28 10:53:29 +0000509 def get_request(self):
510 # Ensure the socket is always non-blocking. On Linux, socket
511 # attributes are not inherited like they are on *BSD and Windows.
512 s, port = self.socket.accept()
513 s.setblocking(True)
514 return s, port
515
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000516 if not requestHandler:
517 requestHandler = xmlrpc.server.SimpleXMLRPCRequestHandler
518 serv = MyXMLRPCServer(("localhost", 0), requestHandler,
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200519 encoding=encoding,
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000520 logRequests=False, bind_and_activate=False)
Guido van Rossumaf554a02007-08-16 23:48:43 +0000521 try:
Guido van Rossumaf554a02007-08-16 23:48:43 +0000522 serv.server_bind()
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000523 global ADDR, PORT, URL
524 ADDR, PORT = serv.socket.getsockname()
525 #connect to IP address directly. This avoids socket.create_connection()
Ezio Melottie130a522011-10-19 10:58:56 +0300526 #trying to connect to "localhost" using all address families, which
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000527 #causes slowdown e.g. on vista which supports AF_INET6. The server listens
528 #on AF_INET only.
529 URL = "http://%s:%d"%(ADDR, PORT)
Guido van Rossumaf554a02007-08-16 23:48:43 +0000530 serv.server_activate()
531 serv.register_introspection_functions()
532 serv.register_multicall_functions()
533 serv.register_function(pow)
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200534 serv.register_function(lambda x: x, 'têšt')
Xiang Zhang267b9d22017-02-28 17:12:52 +0800535 @serv.register_function
536 def my_function():
537 '''This is my function'''
538 return True
539 @serv.register_function(name='add')
540 def _(x, y):
541 return x + y
R David Murrayaaf17b32013-10-11 12:09:51 -0400542 testInstance = TestInstanceClass()
543 serv.register_instance(testInstance, allow_dotted_names=True)
Christian Heimesaf98da12008-01-27 15:18:18 +0000544 evt.set()
Guido van Rossumaf554a02007-08-16 23:48:43 +0000545
546 # handle up to 'numrequests' requests
547 while numrequests > 0:
548 serv.handle_request()
549 numrequests -= 1
550
551 except socket.timeout:
552 pass
553 finally:
554 serv.socket.close()
555 PORT = None
556 evt.set()
557
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000558def http_multi_server(evt, numrequests, requestHandler=None):
559 class TestInstanceClass:
560 def div(self, x, y):
561 return x // y
562
563 def _methodHelp(self, name):
564 if name == 'div':
565 return 'This is the div function'
566
567 def my_function():
568 '''This is my function'''
569 return True
570
571 class MyXMLRPCServer(xmlrpc.server.MultiPathXMLRPCServer):
572 def get_request(self):
573 # Ensure the socket is always non-blocking. On Linux, socket
574 # attributes are not inherited like they are on *BSD and Windows.
575 s, port = self.socket.accept()
576 s.setblocking(True)
577 return s, port
578
579 if not requestHandler:
580 requestHandler = xmlrpc.server.SimpleXMLRPCRequestHandler
581 class MyRequestHandler(requestHandler):
582 rpc_paths = []
583
Florent Xicluna3fa29f72011-10-30 20:18:50 +0100584 class BrokenDispatcher:
585 def _marshaled_dispatch(self, data, dispatch_method=None, path=None):
586 raise RuntimeError("broken dispatcher")
587
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000588 serv = MyXMLRPCServer(("localhost", 0), MyRequestHandler,
589 logRequests=False, bind_and_activate=False)
590 serv.socket.settimeout(3)
591 serv.server_bind()
592 try:
593 global ADDR, PORT, URL
594 ADDR, PORT = serv.socket.getsockname()
595 #connect to IP address directly. This avoids socket.create_connection()
Ezio Melottie130a522011-10-19 10:58:56 +0300596 #trying to connect to "localhost" using all address families, which
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000597 #causes slowdown e.g. on vista which supports AF_INET6. The server listens
598 #on AF_INET only.
599 URL = "http://%s:%d"%(ADDR, PORT)
600 serv.server_activate()
601 paths = ["/foo", "/foo/bar"]
602 for path in paths:
603 d = serv.add_dispatcher(path, xmlrpc.server.SimpleXMLRPCDispatcher())
604 d.register_introspection_functions()
605 d.register_multicall_functions()
606 serv.get_dispatcher(paths[0]).register_function(pow)
607 serv.get_dispatcher(paths[1]).register_function(lambda x,y: x+y, 'add')
Florent Xicluna3fa29f72011-10-30 20:18:50 +0100608 serv.add_dispatcher("/is/broken", BrokenDispatcher())
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000609 evt.set()
610
611 # handle up to 'numrequests' requests
612 while numrequests > 0:
613 serv.handle_request()
614 numrequests -= 1
615
616 except socket.timeout:
617 pass
618 finally:
619 serv.socket.close()
620 PORT = None
621 evt.set()
622
Christian Heimesaf98da12008-01-27 15:18:18 +0000623# This function prevents errors like:
624# <ProtocolError for localhost:57527/RPC2: 500 Internal Server Error>
625def is_unavailable_exception(e):
626 '''Returns True if the given ProtocolError is the product of a server-side
627 exception caused by the 'temporarily unavailable' response sometimes
628 given by operations on non-blocking sockets.'''
629
630 # sometimes we get a -1 error code and/or empty headers
Christian Heimes26855632008-01-27 23:50:43 +0000631 try:
632 if e.errcode == -1 or e.headers is None:
633 return True
634 exc_mess = e.headers.get('X-exception')
635 except AttributeError:
Andrew Svetlov0832af62012-12-18 23:10:48 +0200636 # Ignore OSErrors here.
Christian Heimes26855632008-01-27 23:50:43 +0000637 exc_mess = str(e)
Guido van Rossumaf554a02007-08-16 23:48:43 +0000638
Christian Heimes26855632008-01-27 23:50:43 +0000639 if exc_mess and 'temporarily unavailable' in exc_mess.lower():
640 return True
Thomas Woutersed03b412007-08-28 21:37:11 +0000641
R. David Murray378c0cf2010-02-24 01:46:21 +0000642def make_request_and_skipIf(condition, reason):
Serhiy Storchaka56a6d852014-12-01 18:28:43 +0200643 # If we skip the test, we have to make a request because
R. David Murray378c0cf2010-02-24 01:46:21 +0000644 # the server created in setUp blocks expecting one to come in.
645 if not condition:
646 return lambda func: func
647 def decorator(func):
648 def make_request_and_skip(self):
649 try:
650 xmlrpclib.ServerProxy(URL).my_function()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200651 except (xmlrpclib.ProtocolError, OSError) as e:
R. David Murray378c0cf2010-02-24 01:46:21 +0000652 if not is_unavailable_exception(e):
653 raise
654 raise unittest.SkipTest(reason)
655 return make_request_and_skip
656 return decorator
657
Victor Stinner45df8202010-04-28 22:31:17 +0000658@unittest.skipUnless(threading, 'Threading required for this test.')
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000659class BaseServerTestCase(unittest.TestCase):
660 requestHandler = None
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000661 request_count = 1
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000662 threadFunc = staticmethod(http_server)
Victor Stinner45df8202010-04-28 22:31:17 +0000663
Guido van Rossumaf554a02007-08-16 23:48:43 +0000664 def setUp(self):
Guido van Rossum61e21b52007-08-20 19:06:03 +0000665 # enable traceback reporting
Georg Brandl38eceaa2008-05-26 11:14:17 +0000666 xmlrpc.server.SimpleXMLRPCServer._send_traceback_header = True
Guido van Rossum61e21b52007-08-20 19:06:03 +0000667
Guido van Rossumaf554a02007-08-16 23:48:43 +0000668 self.evt = threading.Event()
Guido van Rossum61e21b52007-08-20 19:06:03 +0000669 # start server thread to handle requests
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000670 serv_args = (self.evt, self.request_count, self.requestHandler)
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000671 threading.Thread(target=self.threadFunc, args=serv_args).start()
Guido van Rossumaf554a02007-08-16 23:48:43 +0000672
Christian Heimesaf98da12008-01-27 15:18:18 +0000673 # wait for the server to be ready
674 self.evt.wait()
675 self.evt.clear()
Guido van Rossumaf554a02007-08-16 23:48:43 +0000676
677 def tearDown(self):
678 # wait on the server thread to terminate
Charles-François Natalicd96b4f2012-02-18 14:53:41 +0100679 self.evt.wait()
Guido van Rossumaf554a02007-08-16 23:48:43 +0000680
Guido van Rossum61e21b52007-08-20 19:06:03 +0000681 # disable traceback reporting
Georg Brandl38eceaa2008-05-26 11:14:17 +0000682 xmlrpc.server.SimpleXMLRPCServer._send_traceback_header = False
Guido van Rossum61e21b52007-08-20 19:06:03 +0000683
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000684class SimpleServerTestCase(BaseServerTestCase):
Guido van Rossumaf554a02007-08-16 23:48:43 +0000685 def test_simple1(self):
Guido van Rossum04110fb2007-08-24 16:32:05 +0000686 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000687 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum04110fb2007-08-24 16:32:05 +0000688 self.assertEqual(p.pow(6,8), 6**8)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200689 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +0000690 # ignore failures due to non-blocking socket 'unavailable' errors
691 if not is_unavailable_exception(e):
692 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +0000693 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Guido van Rossumaf554a02007-08-16 23:48:43 +0000694
Senthil Kumaranb3af08f2009-04-01 20:20:43 +0000695 def test_nonascii(self):
696 start_string = 'P\N{LATIN SMALL LETTER Y WITH CIRCUMFLEX}t'
697 end_string = 'h\N{LATIN SMALL LETTER O WITH HORN}n'
698 try:
699 p = xmlrpclib.ServerProxy(URL)
700 self.assertEqual(p.add(start_string, end_string),
701 start_string + end_string)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200702 except (xmlrpclib.ProtocolError, OSError) as e:
Senthil Kumaranb3af08f2009-04-01 20:20:43 +0000703 # ignore failures due to non-blocking socket 'unavailable' errors
704 if not is_unavailable_exception(e):
705 # protocol error; provide additional information in test output
706 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
707
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200708 def test_client_encoding(self):
709 start_string = '\u20ac'
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200710 end_string = '\xa4'
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200711
712 try:
713 p = xmlrpclib.ServerProxy(URL, encoding='iso-8859-15')
714 self.assertEqual(p.add(start_string, end_string),
715 start_string + end_string)
716 except (xmlrpclib.ProtocolError, socket.error) as e:
717 # ignore failures due to non-blocking socket unavailable errors.
718 if not is_unavailable_exception(e):
719 # protocol error; provide additional information in test output
720 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
721
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200722 def test_nonascii_methodname(self):
723 try:
724 p = xmlrpclib.ServerProxy(URL, encoding='ascii')
725 self.assertEqual(p.têšt(42), 42)
726 except (xmlrpclib.ProtocolError, socket.error) as e:
727 # ignore failures due to non-blocking socket unavailable errors.
728 if not is_unavailable_exception(e):
729 # protocol error; provide additional information in test output
730 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
731
Georg Brandlfceab5a2008-01-19 20:08:23 +0000732 # [ch] The test 404 is causing lots of false alarms.
733 def XXXtest_404(self):
Georg Brandl24420152008-05-26 16:32:26 +0000734 # send POST with http.client, it should return 404 header and
Christian Heimes255f53b2007-12-08 15:33:56 +0000735 # 'Not Found' message.
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000736 conn = httplib.client.HTTPConnection(ADDR, PORT)
Christian Heimes99d73f22007-12-08 16:13:06 +0000737 conn.request('POST', '/this-is-not-valid')
Christian Heimes255f53b2007-12-08 15:33:56 +0000738 response = conn.getresponse()
739 conn.close()
740
741 self.assertEqual(response.status, 404)
742 self.assertEqual(response.reason, 'Not Found')
743
Guido van Rossumaf554a02007-08-16 23:48:43 +0000744 def test_introspection1(self):
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200745 expected_methods = set(['pow', 'div', 'my_function', 'add', 'têšt',
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000746 'system.listMethods', 'system.methodHelp',
R David Murrayaaf17b32013-10-11 12:09:51 -0400747 'system.methodSignature', 'system.multicall',
748 'Fixture'])
Guido van Rossum04110fb2007-08-24 16:32:05 +0000749 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000750 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum04110fb2007-08-24 16:32:05 +0000751 meth = p.system.listMethods()
Guido van Rossum04110fb2007-08-24 16:32:05 +0000752 self.assertEqual(set(meth), expected_methods)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200753 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +0000754 # ignore failures due to non-blocking socket 'unavailable' errors
755 if not is_unavailable_exception(e):
756 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +0000757 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Christian Heimes412dc9c2008-01-27 18:55:54 +0000758
Guido van Rossumaf554a02007-08-16 23:48:43 +0000759
760 def test_introspection2(self):
Guido van Rossum04110fb2007-08-24 16:32:05 +0000761 try:
Christian Heimes255f53b2007-12-08 15:33:56 +0000762 # test _methodHelp()
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000763 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum04110fb2007-08-24 16:32:05 +0000764 divhelp = p.system.methodHelp('div')
765 self.assertEqual(divhelp, 'This is the div function')
Andrew Svetlov0832af62012-12-18 23:10:48 +0200766 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +0000767 # ignore failures due to non-blocking socket 'unavailable' errors
768 if not is_unavailable_exception(e):
769 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +0000770 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Guido van Rossumaf554a02007-08-16 23:48:43 +0000771
R. David Murray378c0cf2010-02-24 01:46:21 +0000772 @make_request_and_skipIf(sys.flags.optimize >= 2,
773 "Docstrings are omitted with -O2 and above")
Guido van Rossumaf554a02007-08-16 23:48:43 +0000774 def test_introspection3(self):
Christian Heimes255f53b2007-12-08 15:33:56 +0000775 try:
776 # test native doc
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000777 p = xmlrpclib.ServerProxy(URL)
Christian Heimes255f53b2007-12-08 15:33:56 +0000778 myfunction = p.system.methodHelp('my_function')
779 self.assertEqual(myfunction, 'This is my function')
Andrew Svetlov0832af62012-12-18 23:10:48 +0200780 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes255f53b2007-12-08 15:33:56 +0000781 # ignore failures due to non-blocking socket 'unavailable' errors
782 if not is_unavailable_exception(e):
783 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +0000784 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Christian Heimes255f53b2007-12-08 15:33:56 +0000785
786 def test_introspection4(self):
Guido van Rossumaf554a02007-08-16 23:48:43 +0000787 # the SimpleXMLRPCServer doesn't support signatures, but
Thomas Woutersed03b412007-08-28 21:37:11 +0000788 # at least check that we can try making the call
Guido van Rossum04110fb2007-08-24 16:32:05 +0000789 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000790 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum04110fb2007-08-24 16:32:05 +0000791 divsig = p.system.methodSignature('div')
792 self.assertEqual(divsig, 'signatures not supported')
Andrew Svetlov0832af62012-12-18 23:10:48 +0200793 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +0000794 # ignore failures due to non-blocking socket 'unavailable' errors
795 if not is_unavailable_exception(e):
796 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +0000797 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Guido van Rossumaf554a02007-08-16 23:48:43 +0000798
799 def test_multicall(self):
Guido van Rossum04110fb2007-08-24 16:32:05 +0000800 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000801 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum04110fb2007-08-24 16:32:05 +0000802 multicall = xmlrpclib.MultiCall(p)
803 multicall.add(2,3)
804 multicall.pow(6,8)
805 multicall.div(127,42)
806 add_result, pow_result, div_result = multicall()
807 self.assertEqual(add_result, 2+3)
808 self.assertEqual(pow_result, 6**8)
809 self.assertEqual(div_result, 127//42)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200810 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +0000811 # ignore failures due to non-blocking socket 'unavailable' errors
812 if not is_unavailable_exception(e):
813 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +0000814 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Guido van Rossumaf554a02007-08-16 23:48:43 +0000815
Christian Heimes255f53b2007-12-08 15:33:56 +0000816 def test_non_existing_multicall(self):
817 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000818 p = xmlrpclib.ServerProxy(URL)
Christian Heimes255f53b2007-12-08 15:33:56 +0000819 multicall = xmlrpclib.MultiCall(p)
820 multicall.this_is_not_exists()
821 result = multicall()
822
823 # result.results contains;
Martin v. Löwis250ad612008-04-07 05:43:42 +0000824 # [{'faultCode': 1, 'faultString': '<class \'exceptions.Exception\'>:'
Christian Heimes255f53b2007-12-08 15:33:56 +0000825 # 'method "this_is_not_exists" is not supported'>}]
826
827 self.assertEqual(result.results[0]['faultCode'], 1)
Benjamin Petersonab078e92016-07-13 21:13:29 -0700828 self.assertEqual(result.results[0]['faultString'],
829 '<class \'Exception\'>:method "this_is_not_exists" '
Christian Heimes255f53b2007-12-08 15:33:56 +0000830 'is not supported')
Andrew Svetlov0832af62012-12-18 23:10:48 +0200831 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes255f53b2007-12-08 15:33:56 +0000832 # ignore failures due to non-blocking socket 'unavailable' errors
833 if not is_unavailable_exception(e):
834 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +0000835 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Christian Heimes255f53b2007-12-08 15:33:56 +0000836
Christian Heimesfe337bf2008-03-23 21:54:12 +0000837 def test_dotted_attribute(self):
838 # Raises an AttributeError because private methods are not allowed.
839 self.assertRaises(AttributeError,
Georg Brandl38eceaa2008-05-26 11:14:17 +0000840 xmlrpc.server.resolve_dotted_attribute, str, '__add')
Christian Heimesfe337bf2008-03-23 21:54:12 +0000841
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000842 self.assertTrue(xmlrpc.server.resolve_dotted_attribute(str, 'title'))
Christian Heimesfe337bf2008-03-23 21:54:12 +0000843 # Get the test to run faster by sending a request with test_simple1.
844 # This avoids waiting for the socket timeout.
845 self.test_simple1()
846
R David Murrayaaf17b32013-10-11 12:09:51 -0400847 def test_allow_dotted_names_true(self):
848 # XXX also need allow_dotted_names_false test.
849 server = xmlrpclib.ServerProxy("http://%s:%d/RPC2" % (ADDR, PORT))
850 data = server.Fixture.getData()
851 self.assertEqual(data, '42')
852
Victor Stinnerda6eb532011-09-23 01:29:44 +0200853 def test_unicode_host(self):
854 server = xmlrpclib.ServerProxy("http://%s:%d/RPC2" % (ADDR, PORT))
855 self.assertEqual(server.add("a", "\xe9"), "a\xe9")
856
Charles-François Natalicd96b4f2012-02-18 14:53:41 +0100857 def test_partial_post(self):
858 # Check that a partial POST doesn't make the server loop: issue #14001.
859 conn = http.client.HTTPConnection(ADDR, PORT)
860 conn.request('POST', '/RPC2 HTTP/1.0\r\nContent-Length: 100\r\n\r\nbye')
861 conn.close()
862
Brett Cannon33a40002014-03-21 11:24:40 -0400863 def test_context_manager(self):
864 with xmlrpclib.ServerProxy(URL) as server:
865 server.add(2, 3)
866 self.assertNotEqual(server('transport')._connection,
867 (None, None))
868 self.assertEqual(server('transport')._connection,
869 (None, None))
870
871 def test_context_manager_method_error(self):
872 try:
873 with xmlrpclib.ServerProxy(URL) as server:
874 server.add(2, "a")
875 except xmlrpclib.Fault:
876 pass
877 self.assertEqual(server('transport')._connection,
878 (None, None))
879
Charles-François Natalicd96b4f2012-02-18 14:53:41 +0100880
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200881class SimpleServerEncodingTestCase(BaseServerTestCase):
882 @staticmethod
883 def threadFunc(evt, numrequests, requestHandler=None, encoding=None):
884 http_server(evt, numrequests, requestHandler, 'iso-8859-15')
885
886 def test_server_encoding(self):
887 start_string = '\u20ac'
Serhiy Storchakaaebb6d32016-01-20 10:34:27 +0200888 end_string = '\xa4'
Serhiy Storchaka084f7e42016-01-18 19:39:26 +0200889
890 try:
891 p = xmlrpclib.ServerProxy(URL)
892 self.assertEqual(p.add(start_string, end_string),
893 start_string + end_string)
894 except (xmlrpclib.ProtocolError, socket.error) as e:
895 # ignore failures due to non-blocking socket unavailable errors.
896 if not is_unavailable_exception(e):
897 # protocol error; provide additional information in test output
898 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
899
900
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000901class MultiPathServerTestCase(BaseServerTestCase):
902 threadFunc = staticmethod(http_multi_server)
903 request_count = 2
904 def test_path1(self):
905 p = xmlrpclib.ServerProxy(URL+"/foo")
906 self.assertEqual(p.pow(6,8), 6**8)
907 self.assertRaises(xmlrpclib.Fault, p.add, 6, 8)
Florent Xicluna3fa29f72011-10-30 20:18:50 +0100908
Kristján Valur Jónsson1f2a1ae2009-12-16 10:50:44 +0000909 def test_path2(self):
910 p = xmlrpclib.ServerProxy(URL+"/foo/bar")
911 self.assertEqual(p.add(6,8), 6+8)
912 self.assertRaises(xmlrpclib.Fault, p.pow, 6, 8)
913
Florent Xicluna3fa29f72011-10-30 20:18:50 +0100914 def test_path3(self):
915 p = xmlrpclib.ServerProxy(URL+"/is/broken")
916 self.assertRaises(xmlrpclib.Fault, p.add, 6, 8)
917
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000918#A test case that verifies that a server using the HTTP/1.1 keep-alive mechanism
919#does indeed serve subsequent requests on the same connection
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000920class BaseKeepaliveServerTestCase(BaseServerTestCase):
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000921 #a request handler that supports keep-alive and logs requests into a
922 #class variable
923 class RequestHandler(xmlrpc.server.SimpleXMLRPCRequestHandler):
924 parentClass = xmlrpc.server.SimpleXMLRPCRequestHandler
925 protocol_version = 'HTTP/1.1'
926 myRequests = []
927 def handle(self):
928 self.myRequests.append([])
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000929 self.reqidx = len(self.myRequests)-1
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000930 return self.parentClass.handle(self)
931 def handle_one_request(self):
932 result = self.parentClass.handle_one_request(self)
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000933 self.myRequests[self.reqidx].append(self.raw_requestline)
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000934 return result
935
936 requestHandler = RequestHandler
937 def setUp(self):
938 #clear request log
939 self.RequestHandler.myRequests = []
940 return BaseServerTestCase.setUp(self)
941
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000942#A test case that verifies that a server using the HTTP/1.1 keep-alive mechanism
943#does indeed serve subsequent requests on the same connection
944class KeepaliveServerTestCase1(BaseKeepaliveServerTestCase):
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000945 def test_two(self):
946 p = xmlrpclib.ServerProxy(URL)
Kristján Valur Jónsson1bbb19a2009-07-11 21:57:16 +0000947 #do three requests.
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000948 self.assertEqual(p.pow(6,8), 6**8)
949 self.assertEqual(p.pow(6,8), 6**8)
Kristján Valur Jónsson1bbb19a2009-07-11 21:57:16 +0000950 self.assertEqual(p.pow(6,8), 6**8)
Victor Stinnera935e8f2011-01-03 14:30:44 +0000951 p("close")()
Kristján Valur Jónsson1bbb19a2009-07-11 21:57:16 +0000952
953 #they should have all been handled by a single request handler
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000954 self.assertEqual(len(self.RequestHandler.myRequests), 1)
Kristján Valur Jónsson1bbb19a2009-07-11 21:57:16 +0000955
956 #check that we did at least two (the third may be pending append
957 #due to thread scheduling)
958 self.assertGreaterEqual(len(self.RequestHandler.myRequests[-1]), 2)
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000959
Victor Stinnera935e8f2011-01-03 14:30:44 +0000960
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000961#test special attribute access on the serverproxy, through the __call__
962#function.
963class KeepaliveServerTestCase2(BaseKeepaliveServerTestCase):
964 #ask for two keepalive requests to be handled.
965 request_count=2
966
967 def test_close(self):
968 p = xmlrpclib.ServerProxy(URL)
969 #do some requests with close.
970 self.assertEqual(p.pow(6,8), 6**8)
971 self.assertEqual(p.pow(6,8), 6**8)
972 self.assertEqual(p.pow(6,8), 6**8)
973 p("close")() #this should trigger a new keep-alive request
974 self.assertEqual(p.pow(6,8), 6**8)
975 self.assertEqual(p.pow(6,8), 6**8)
976 self.assertEqual(p.pow(6,8), 6**8)
Victor Stinnera935e8f2011-01-03 14:30:44 +0000977 p("close")()
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000978
979 #they should have all been two request handlers, each having logged at least
980 #two complete requests
981 self.assertEqual(len(self.RequestHandler.myRequests), 2)
982 self.assertGreaterEqual(len(self.RequestHandler.myRequests[-1]), 2)
983 self.assertGreaterEqual(len(self.RequestHandler.myRequests[-2]), 2)
984
Victor Stinnera935e8f2011-01-03 14:30:44 +0000985
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000986 def test_transport(self):
987 p = xmlrpclib.ServerProxy(URL)
988 #do some requests with close.
989 self.assertEqual(p.pow(6,8), 6**8)
990 p("transport").close() #same as above, really.
991 self.assertEqual(p.pow(6,8), 6**8)
Victor Stinnera935e8f2011-01-03 14:30:44 +0000992 p("close")()
Kristján Valur Jónssonf6087ca2009-07-12 22:45:18 +0000993 self.assertEqual(len(self.RequestHandler.myRequests), 2)
994
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000995#A test case that verifies that gzip encoding works in both directions
996#(for a request and the response)
Brett Cannon603dcf22013-06-12 20:04:19 -0400997@unittest.skipIf(gzip is None, 'requires gzip')
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +0000998class GzipServerTestCase(BaseServerTestCase):
999 #a request handler that supports keep-alive and logs requests into a
1000 #class variable
1001 class RequestHandler(xmlrpc.server.SimpleXMLRPCRequestHandler):
1002 parentClass = xmlrpc.server.SimpleXMLRPCRequestHandler
1003 protocol_version = 'HTTP/1.1'
1004
1005 def do_POST(self):
1006 #store content of last request in class
1007 self.__class__.content_length = int(self.headers["content-length"])
1008 return self.parentClass.do_POST(self)
1009 requestHandler = RequestHandler
1010
1011 class Transport(xmlrpclib.Transport):
1012 #custom transport, stores the response length for our perusal
1013 fake_gzip = False
1014 def parse_response(self, response):
1015 self.response_length=int(response.getheader("content-length", 0))
1016 return xmlrpclib.Transport.parse_response(self, response)
1017
1018 def send_content(self, connection, body):
1019 if self.fake_gzip:
1020 #add a lone gzip header to induce decode error remotely
1021 connection.putheader("Content-Encoding", "gzip")
1022 return xmlrpclib.Transport.send_content(self, connection, body)
1023
Victor Stinner45df8202010-04-28 22:31:17 +00001024 def setUp(self):
1025 BaseServerTestCase.setUp(self)
1026
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001027 def test_gzip_request(self):
1028 t = self.Transport()
1029 t.encode_threshold = None
1030 p = xmlrpclib.ServerProxy(URL, transport=t)
1031 self.assertEqual(p.pow(6,8), 6**8)
1032 a = self.RequestHandler.content_length
1033 t.encode_threshold = 0 #turn on request encoding
1034 self.assertEqual(p.pow(6,8), 6**8)
1035 b = self.RequestHandler.content_length
1036 self.assertTrue(a>b)
Victor Stinnera935e8f2011-01-03 14:30:44 +00001037 p("close")()
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001038
1039 def test_bad_gzip_request(self):
1040 t = self.Transport()
1041 t.encode_threshold = None
1042 t.fake_gzip = True
1043 p = xmlrpclib.ServerProxy(URL, transport=t)
Ezio Melottied3a7d22010-12-01 02:32:32 +00001044 cm = self.assertRaisesRegex(xmlrpclib.ProtocolError,
1045 re.compile(r"\b400\b"))
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001046 with cm:
1047 p.pow(6, 8)
Victor Stinnera935e8f2011-01-03 14:30:44 +00001048 p("close")()
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001049
Benjamin Peterson4e9cefa2014-12-05 20:15:15 -05001050 def test_gzip_response(self):
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001051 t = self.Transport()
1052 p = xmlrpclib.ServerProxy(URL, transport=t)
1053 old = self.requestHandler.encode_threshold
1054 self.requestHandler.encode_threshold = None #no encoding
1055 self.assertEqual(p.pow(6,8), 6**8)
1056 a = t.response_length
1057 self.requestHandler.encode_threshold = 0 #always encode
1058 self.assertEqual(p.pow(6,8), 6**8)
Victor Stinnera935e8f2011-01-03 14:30:44 +00001059 p("close")()
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001060 b = t.response_length
1061 self.requestHandler.encode_threshold = old
1062 self.assertTrue(a>b)
1063
Benjamin Peterson4e9cefa2014-12-05 20:15:15 -05001064
Benjamin Petersoneca72d42014-12-05 20:34:56 -05001065@unittest.skipIf(gzip is None, 'requires gzip')
Benjamin Peterson4e9cefa2014-12-05 20:15:15 -05001066class GzipUtilTestCase(unittest.TestCase):
1067
1068 def test_gzip_decode_limit(self):
1069 max_gzip_decode = 20 * 1024 * 1024
1070 data = b'\0' * max_gzip_decode
1071 encoded = xmlrpclib.gzip_encode(data)
1072 decoded = xmlrpclib.gzip_decode(encoded)
1073 self.assertEqual(len(decoded), max_gzip_decode)
1074
1075 data = b'\0' * (max_gzip_decode + 1)
1076 encoded = xmlrpclib.gzip_encode(data)
1077
Brett Cannon92716772014-12-12 12:00:02 -05001078 with self.assertRaisesRegex(ValueError,
Serhiy Storchaka93da9b52015-04-10 12:52:09 +03001079 "max gzipped payload length exceeded"):
Benjamin Peterson4e9cefa2014-12-05 20:15:15 -05001080 xmlrpclib.gzip_decode(encoded)
1081
1082 xmlrpclib.gzip_decode(encoded, max_decode=-1)
1083
1084
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001085#Test special attributes of the ServerProxy object
1086class ServerProxyTestCase(unittest.TestCase):
Victor Stinner45df8202010-04-28 22:31:17 +00001087 def setUp(self):
1088 unittest.TestCase.setUp(self)
1089 if threading:
1090 self.url = URL
1091 else:
1092 # Without threading, http_server() and http_multi_server() will not
1093 # be executed and URL is still equal to None. 'http://' is a just
1094 # enough to choose the scheme (HTTP)
1095 self.url = 'http://'
1096
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001097 def test_close(self):
Victor Stinner45df8202010-04-28 22:31:17 +00001098 p = xmlrpclib.ServerProxy(self.url)
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001099 self.assertEqual(p('close')(), None)
1100
1101 def test_transport(self):
1102 t = xmlrpclib.Transport()
Victor Stinner45df8202010-04-28 22:31:17 +00001103 p = xmlrpclib.ServerProxy(self.url, transport=t)
Kristján Valur Jónsson985fc6a2009-07-01 10:01:31 +00001104 self.assertEqual(p('transport'), t)
1105
Brett Cannon33a40002014-03-21 11:24:40 -04001106
Guido van Rossum61e21b52007-08-20 19:06:03 +00001107# This is a contrived way to make a failure occur on the server side
1108# in order to test the _send_traceback_header flag on the server
Barry Warsaw820c1202008-06-12 04:06:45 +00001109class FailingMessageClass(http.client.HTTPMessage):
1110 def get(self, key, failobj=None):
Guido van Rossum61e21b52007-08-20 19:06:03 +00001111 key = key.lower()
1112 if key == 'content-length':
1113 return 'I am broken'
Barry Warsaw820c1202008-06-12 04:06:45 +00001114 return super().get(key, failobj)
Guido van Rossum61e21b52007-08-20 19:06:03 +00001115
1116
Victor Stinner45df8202010-04-28 22:31:17 +00001117@unittest.skipUnless(threading, 'Threading required for this test.')
Guido van Rossum61e21b52007-08-20 19:06:03 +00001118class FailingServerTestCase(unittest.TestCase):
1119 def setUp(self):
1120 self.evt = threading.Event()
1121 # start server thread to handle requests
Guido van Rossum15c97462007-11-02 16:10:06 +00001122 serv_args = (self.evt, 1)
Guido van Rossum61e21b52007-08-20 19:06:03 +00001123 threading.Thread(target=http_server, args=serv_args).start()
1124
Christian Heimesaf98da12008-01-27 15:18:18 +00001125 # wait for the server to be ready
1126 self.evt.wait()
1127 self.evt.clear()
Guido van Rossum61e21b52007-08-20 19:06:03 +00001128
1129 def tearDown(self):
1130 # wait on the server thread to terminate
1131 self.evt.wait()
1132 # reset flag
Georg Brandl38eceaa2008-05-26 11:14:17 +00001133 xmlrpc.server.SimpleXMLRPCServer._send_traceback_header = False
Guido van Rossum61e21b52007-08-20 19:06:03 +00001134 # reset message class
Barry Warsaw820c1202008-06-12 04:06:45 +00001135 default_class = http.client.HTTPMessage
1136 xmlrpc.server.SimpleXMLRPCRequestHandler.MessageClass = default_class
Guido van Rossum61e21b52007-08-20 19:06:03 +00001137
1138 def test_basic(self):
1139 # check that flag is false by default
Georg Brandl38eceaa2008-05-26 11:14:17 +00001140 flagval = xmlrpc.server.SimpleXMLRPCServer._send_traceback_header
Guido van Rossum61e21b52007-08-20 19:06:03 +00001141 self.assertEqual(flagval, False)
1142
Guido van Rossum04110fb2007-08-24 16:32:05 +00001143 # enable traceback reporting
Georg Brandl38eceaa2008-05-26 11:14:17 +00001144 xmlrpc.server.SimpleXMLRPCServer._send_traceback_header = True
Guido van Rossum04110fb2007-08-24 16:32:05 +00001145
1146 # test a call that shouldn't fail just as a smoke test
1147 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +00001148 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum04110fb2007-08-24 16:32:05 +00001149 self.assertEqual(p.pow(6,8), 6**8)
Andrew Svetlov0832af62012-12-18 23:10:48 +02001150 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +00001151 # ignore failures due to non-blocking socket 'unavailable' errors
1152 if not is_unavailable_exception(e):
1153 # protocol error; provide additional information in test output
Christian Heimes26855632008-01-27 23:50:43 +00001154 self.fail("%s\n%s" % (e, getattr(e, "headers", "")))
Guido van Rossum61e21b52007-08-20 19:06:03 +00001155
1156 def test_fail_no_info(self):
1157 # use the broken message class
Georg Brandl38eceaa2008-05-26 11:14:17 +00001158 xmlrpc.server.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
Guido van Rossum61e21b52007-08-20 19:06:03 +00001159
1160 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +00001161 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum61e21b52007-08-20 19:06:03 +00001162 p.pow(6,8)
Andrew Svetlov0832af62012-12-18 23:10:48 +02001163 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +00001164 # ignore failures due to non-blocking socket 'unavailable' errors
Christian Heimes26855632008-01-27 23:50:43 +00001165 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Christian Heimes412dc9c2008-01-27 18:55:54 +00001166 # The two server-side error headers shouldn't be sent back in this case
1167 self.assertTrue(e.headers.get("X-exception") is None)
1168 self.assertTrue(e.headers.get("X-traceback") is None)
Guido van Rossum61e21b52007-08-20 19:06:03 +00001169 else:
1170 self.fail('ProtocolError not raised')
1171
1172 def test_fail_with_info(self):
1173 # use the broken message class
Georg Brandl38eceaa2008-05-26 11:14:17 +00001174 xmlrpc.server.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
Guido van Rossum61e21b52007-08-20 19:06:03 +00001175
1176 # Check that errors in the server send back exception/traceback
1177 # info when flag is set
Georg Brandl38eceaa2008-05-26 11:14:17 +00001178 xmlrpc.server.SimpleXMLRPCServer._send_traceback_header = True
Guido van Rossum61e21b52007-08-20 19:06:03 +00001179
1180 try:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +00001181 p = xmlrpclib.ServerProxy(URL)
Guido van Rossum61e21b52007-08-20 19:06:03 +00001182 p.pow(6,8)
Andrew Svetlov0832af62012-12-18 23:10:48 +02001183 except (xmlrpclib.ProtocolError, OSError) as e:
Christian Heimes412dc9c2008-01-27 18:55:54 +00001184 # ignore failures due to non-blocking socket 'unavailable' errors
Christian Heimes26855632008-01-27 23:50:43 +00001185 if not is_unavailable_exception(e) and hasattr(e, "headers"):
Christian Heimes412dc9c2008-01-27 18:55:54 +00001186 # We should get error info in the response
1187 expected_err = "invalid literal for int() with base 10: 'I am broken'"
Barry Warsaw820c1202008-06-12 04:06:45 +00001188 self.assertEqual(e.headers.get("X-exception"), expected_err)
1189 self.assertTrue(e.headers.get("X-traceback") is not None)
Guido van Rossum61e21b52007-08-20 19:06:03 +00001190 else:
1191 self.fail('ProtocolError not raised')
1192
R. David Murray0548ce02009-10-26 08:24:14 +00001193
1194@contextlib.contextmanager
1195def captured_stdout(encoding='utf-8'):
1196 """A variation on support.captured_stdout() which gives a text stream
1197 having a `buffer` attribute.
1198 """
R. David Murray0548ce02009-10-26 08:24:14 +00001199 orig_stdout = sys.stdout
1200 sys.stdout = io.TextIOWrapper(io.BytesIO(), encoding=encoding)
1201 try:
1202 yield sys.stdout
1203 finally:
1204 sys.stdout = orig_stdout
1205
1206
Christian Heimes255f53b2007-12-08 15:33:56 +00001207class CGIHandlerTestCase(unittest.TestCase):
1208 def setUp(self):
Georg Brandl38eceaa2008-05-26 11:14:17 +00001209 self.cgi = xmlrpc.server.CGIXMLRPCRequestHandler()
Christian Heimes255f53b2007-12-08 15:33:56 +00001210
1211 def tearDown(self):
1212 self.cgi = None
1213
1214 def test_cgi_get(self):
Walter Dörwaldb525e182009-04-26 21:39:21 +00001215 with support.EnvironmentVarGuard() as env:
Walter Dörwald155374d2009-05-01 19:58:58 +00001216 env['REQUEST_METHOD'] = 'GET'
Walter Dörwaldb525e182009-04-26 21:39:21 +00001217 # if the method is GET and no request_text is given, it runs handle_get
1218 # get sysout output
R. David Murray0548ce02009-10-26 08:24:14 +00001219 with captured_stdout(encoding=self.cgi.encoding) as data_out:
Nick Coghlan6ead5522009-10-18 13:19:33 +00001220 self.cgi.handle_request()
Christian Heimes255f53b2007-12-08 15:33:56 +00001221
Walter Dörwaldb525e182009-04-26 21:39:21 +00001222 # parse Status header
Nick Coghlan6ead5522009-10-18 13:19:33 +00001223 data_out.seek(0)
1224 handle = data_out.read()
Walter Dörwaldb525e182009-04-26 21:39:21 +00001225 status = handle.split()[1]
1226 message = ' '.join(handle.split()[2:4])
Christian Heimes255f53b2007-12-08 15:33:56 +00001227
Walter Dörwaldb525e182009-04-26 21:39:21 +00001228 self.assertEqual(status, '400')
1229 self.assertEqual(message, 'Bad Request')
Christian Heimes255f53b2007-12-08 15:33:56 +00001230
Christian Heimes255f53b2007-12-08 15:33:56 +00001231
1232 def test_cgi_xmlrpc_response(self):
1233 data = """<?xml version='1.0'?>
Nick Coghlan6ead5522009-10-18 13:19:33 +00001234 <methodCall>
1235 <methodName>test_method</methodName>
1236 <params>
1237 <param>
1238 <value><string>foo</string></value>
1239 </param>
1240 <param>
1241 <value><string>bar</string></value>
1242 </param>
1243 </params>
1244 </methodCall>
1245 """
Christian Heimes255f53b2007-12-08 15:33:56 +00001246
Nick Coghlan6ead5522009-10-18 13:19:33 +00001247 with support.EnvironmentVarGuard() as env, \
R. David Murray0548ce02009-10-26 08:24:14 +00001248 captured_stdout(encoding=self.cgi.encoding) as data_out, \
Nick Coghlan6ead5522009-10-18 13:19:33 +00001249 support.captured_stdin() as data_in:
1250 data_in.write(data)
1251 data_in.seek(0)
Walter Dörwald155374d2009-05-01 19:58:58 +00001252 env['CONTENT_LENGTH'] = str(len(data))
Georg Brandlc7485062009-04-01 15:53:15 +00001253 self.cgi.handle_request()
Nick Coghlan6ead5522009-10-18 13:19:33 +00001254 data_out.seek(0)
Christian Heimes255f53b2007-12-08 15:33:56 +00001255
1256 # will respond exception, if so, our goal is achieved ;)
Nick Coghlan6ead5522009-10-18 13:19:33 +00001257 handle = data_out.read()
Christian Heimes255f53b2007-12-08 15:33:56 +00001258
Jeremy Hylton1afc1692008-06-18 20:49:58 +00001259 # start with 44th char so as not to get http header, we just
1260 # need only xml
Christian Heimes255f53b2007-12-08 15:33:56 +00001261 self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, handle[44:])
1262
Senthil Kumaranb3af08f2009-04-01 20:20:43 +00001263 # Also test the content-length returned by handle_request
1264 # Using the same test method inorder to avoid all the datapassing
1265 # boilerplate code.
1266 # Test for bug: http://bugs.python.org/issue5040
1267
1268 content = handle[handle.find("<?xml"):]
1269
Ezio Melottib3aedd42010-11-20 19:04:17 +00001270 self.assertEqual(
R David Murray44b548d2016-09-08 13:59:53 -04001271 int(re.search(r'Content-Length: (\d+)', handle).group(1)),
Senthil Kumaranb3af08f2009-04-01 20:20:43 +00001272 len(content))
1273
Senthil Kumaranb3af08f2009-04-01 20:20:43 +00001274
Florent Xicluna1b7458b2011-12-09 22:35:06 +01001275class UseBuiltinTypesTestCase(unittest.TestCase):
1276
1277 def test_use_builtin_types(self):
1278 # SimpleXMLRPCDispatcher.__init__ accepts use_builtin_types, which
1279 # makes all dispatch of binary data as bytes instances, and all
1280 # dispatch of datetime argument as datetime.datetime instances.
1281 self.log = []
1282 expected_bytes = b"my dog has fleas"
1283 expected_date = datetime.datetime(2008, 5, 26, 18, 25, 12)
1284 marshaled = xmlrpclib.dumps((expected_bytes, expected_date), 'foobar')
1285 def foobar(*args):
1286 self.log.extend(args)
1287 handler = xmlrpc.server.SimpleXMLRPCDispatcher(
1288 allow_none=True, encoding=None, use_builtin_types=True)
1289 handler.register_function(foobar)
1290 handler._marshaled_dispatch(marshaled)
1291 self.assertEqual(len(self.log), 2)
1292 mybytes, mydate = self.log
1293 self.assertEqual(self.log, [expected_bytes, expected_date])
1294 self.assertIs(type(mydate), datetime.datetime)
1295 self.assertIs(type(mybytes), bytes)
1296
1297 def test_cgihandler_has_use_builtin_types_flag(self):
1298 handler = xmlrpc.server.CGIXMLRPCRequestHandler(use_builtin_types=True)
1299 self.assertTrue(handler.use_builtin_types)
1300
1301 def test_xmlrpcserver_has_use_builtin_types_flag(self):
1302 server = xmlrpc.server.SimpleXMLRPCServer(("localhost", 0),
1303 use_builtin_types=True)
1304 server.server_close()
1305 self.assertTrue(server.use_builtin_types)
1306
1307
Brett Cannone382b582013-06-12 21:25:23 -04001308@support.reap_threads
1309def test_main():
1310 support.run_unittest(XMLRPCTestCase, HelperTestCase, DateTimeTestCase,
1311 BinaryTestCase, FaultTestCase, UseBuiltinTypesTestCase,
Serhiy Storchaka084f7e42016-01-18 19:39:26 +02001312 SimpleServerTestCase, SimpleServerEncodingTestCase,
1313 KeepaliveServerTestCase1, KeepaliveServerTestCase2,
1314 GzipServerTestCase, GzipUtilTestCase,
Brett Cannone382b582013-06-12 21:25:23 -04001315 MultiPathServerTestCase, ServerProxyTestCase, FailingServerTestCase,
1316 CGIHandlerTestCase)
1317
1318
Skip Montanaro419abda2001-10-01 17:47:44 +00001319if __name__ == "__main__":
Brett Cannone382b582013-06-12 21:25:23 -04001320 test_main()