467 lines
17 KiB
Python
467 lines
17 KiB
Python
import base64
|
|
import datetime
|
|
import sys
|
|
import time
|
|
import unittest
|
|
import xmlrpclib
|
|
import SimpleXMLRPCServer
|
|
import threading
|
|
import mimetools
|
|
from test import test_support
|
|
|
|
alist = [{'astring': 'foo@bar.baz.spam',
|
|
'afloat': 7283.43,
|
|
'anint': 2**20,
|
|
'ashortlong': 2,
|
|
'anotherlist': ['.zyx.41'],
|
|
'abase64': xmlrpclib.Binary(b"my dog has fleas"),
|
|
'boolean': False,
|
|
'unicode': '\u4000\u6000\u8000',
|
|
'ukey\u4000': 'regular value',
|
|
'datetime1': xmlrpclib.DateTime('20050210T11:41:23'),
|
|
'datetime2': xmlrpclib.DateTime(
|
|
(2005, 2, 10, 11, 41, 23, 0, 1, -1)),
|
|
'datetime3': xmlrpclib.DateTime(
|
|
datetime.datetime(2005, 2, 10, 11, 41, 23)),
|
|
'datetime4': xmlrpclib.DateTime(
|
|
datetime.date(2005, 2, 10)),
|
|
'datetime5': xmlrpclib.DateTime(
|
|
datetime.time(11, 41, 23)),
|
|
}]
|
|
|
|
class XMLRPCTestCase(unittest.TestCase):
|
|
|
|
def test_dump_load(self):
|
|
dump = xmlrpclib.dumps((alist,))
|
|
load = xmlrpclib.loads(dump)
|
|
self.assertEquals(alist, load[0][0])
|
|
|
|
def test_dump_bare_datetime(self):
|
|
# This checks that an unwrapped datetime.date object can be handled
|
|
# by the marshalling code. This can't be done via test_dump_load()
|
|
# since with use_datetime set to 1 the unmarshaller would create
|
|
# datetime objects for the 'datetime[123]' keys as well
|
|
dt = datetime.datetime(2005, 2, 10, 11, 41, 23)
|
|
s = xmlrpclib.dumps((dt,))
|
|
(newdt,), m = xmlrpclib.loads(s, use_datetime=1)
|
|
self.assertEquals(newdt, dt)
|
|
self.assertEquals(m, None)
|
|
|
|
(newdt,), m = xmlrpclib.loads(s, use_datetime=0)
|
|
self.assertEquals(newdt, xmlrpclib.DateTime('20050210T11:41:23'))
|
|
|
|
def test_dump_bare_date(self):
|
|
# This checks that an unwrapped datetime.date object can be handled
|
|
# by the marshalling code. This can't be done via test_dump_load()
|
|
# since the unmarshaller produces a datetime object
|
|
d = datetime.datetime(2005, 2, 10, 11, 41, 23).date()
|
|
s = xmlrpclib.dumps((d,))
|
|
(newd,), m = xmlrpclib.loads(s, use_datetime=1)
|
|
self.assertEquals(newd.date(), d)
|
|
self.assertEquals(newd.time(), datetime.time(0, 0, 0))
|
|
self.assertEquals(m, None)
|
|
|
|
(newdt,), m = xmlrpclib.loads(s, use_datetime=0)
|
|
self.assertEquals(newdt, xmlrpclib.DateTime('20050210T00:00:00'))
|
|
|
|
def test_dump_bare_time(self):
|
|
# This checks that an unwrapped datetime.time object can be handled
|
|
# by the marshalling code. This can't be done via test_dump_load()
|
|
# since the unmarshaller produces a datetime object
|
|
t = datetime.datetime(2005, 2, 10, 11, 41, 23).time()
|
|
s = xmlrpclib.dumps((t,))
|
|
(newt,), m = xmlrpclib.loads(s, use_datetime=1)
|
|
today = datetime.datetime.now().date().strftime("%Y%m%d")
|
|
self.assertEquals(newt.time(), t)
|
|
self.assertEquals(newt.date(), datetime.datetime.now().date())
|
|
self.assertEquals(m, None)
|
|
|
|
(newdt,), m = xmlrpclib.loads(s, use_datetime=0)
|
|
self.assertEquals(newdt, xmlrpclib.DateTime('%sT11:41:23'%today))
|
|
|
|
def test_bug_1164912 (self):
|
|
d = xmlrpclib.DateTime()
|
|
((new_d,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((d,),
|
|
methodresponse=True))
|
|
self.assert_(isinstance(new_d.value, str))
|
|
|
|
# Check that the output of dumps() is still an 8-bit string
|
|
s = xmlrpclib.dumps((new_d,), methodresponse=True)
|
|
self.assert_(isinstance(s, str))
|
|
|
|
def test_newstyle_class(self):
|
|
class T(object):
|
|
pass
|
|
t = T()
|
|
t.x = 100
|
|
t.y = "Hello"
|
|
((t2,), dummy) = xmlrpclib.loads(xmlrpclib.dumps((t,)))
|
|
self.assertEquals(t2, t.__dict__)
|
|
|
|
def test_dump_big_long(self):
|
|
self.assertRaises(OverflowError, xmlrpclib.dumps, (2**99,))
|
|
|
|
def test_dump_bad_dict(self):
|
|
self.assertRaises(TypeError, xmlrpclib.dumps, ({(1,2,3): 1},))
|
|
|
|
def test_dump_recursive_seq(self):
|
|
l = [1,2,3]
|
|
t = [3,4,5,l]
|
|
l.append(t)
|
|
self.assertRaises(TypeError, xmlrpclib.dumps, (l,))
|
|
|
|
def test_dump_recursive_dict(self):
|
|
d = {'1':1, '2':1}
|
|
t = {'3':3, 'd':d}
|
|
d['t'] = t
|
|
self.assertRaises(TypeError, xmlrpclib.dumps, (d,))
|
|
|
|
def test_dump_big_int(self):
|
|
if sys.maxint > 2**31-1:
|
|
self.assertRaises(OverflowError, xmlrpclib.dumps,
|
|
(int(2**34),))
|
|
|
|
xmlrpclib.dumps((xmlrpclib.MAXINT, xmlrpclib.MININT))
|
|
self.assertRaises(OverflowError, xmlrpclib.dumps, (xmlrpclib.MAXINT+1,))
|
|
self.assertRaises(OverflowError, xmlrpclib.dumps, (xmlrpclib.MININT-1,))
|
|
|
|
def dummy_write(s):
|
|
pass
|
|
|
|
m = xmlrpclib.Marshaller()
|
|
m.dump_int(xmlrpclib.MAXINT, dummy_write)
|
|
m.dump_int(xmlrpclib.MININT, dummy_write)
|
|
self.assertRaises(OverflowError, m.dump_int, xmlrpclib.MAXINT+1, dummy_write)
|
|
self.assertRaises(OverflowError, m.dump_int, xmlrpclib.MININT-1, dummy_write)
|
|
|
|
|
|
def test_dump_none(self):
|
|
value = alist + [None]
|
|
arg1 = (alist + [None],)
|
|
strg = xmlrpclib.dumps(arg1, allow_none=True)
|
|
self.assertEquals(value,
|
|
xmlrpclib.loads(strg)[0][0])
|
|
self.assertRaises(TypeError, xmlrpclib.dumps, (arg1,))
|
|
|
|
|
|
class HelperTestCase(unittest.TestCase):
|
|
def test_escape(self):
|
|
self.assertEqual(xmlrpclib.escape("a&b"), "a&b")
|
|
self.assertEqual(xmlrpclib.escape("a<b"), "a<b")
|
|
self.assertEqual(xmlrpclib.escape("a>b"), "a>b")
|
|
|
|
class FaultTestCase(unittest.TestCase):
|
|
def test_repr(self):
|
|
f = xmlrpclib.Fault(42, 'Test Fault')
|
|
self.assertEqual(repr(f), "<Fault 42: 'Test Fault'>")
|
|
self.assertEqual(repr(f), str(f))
|
|
|
|
def test_dump_fault(self):
|
|
f = xmlrpclib.Fault(42, 'Test Fault')
|
|
s = xmlrpclib.dumps((f,))
|
|
(newf,), m = xmlrpclib.loads(s)
|
|
self.assertEquals(newf, {'faultCode': 42, 'faultString': 'Test Fault'})
|
|
self.assertEquals(m, None)
|
|
|
|
s = xmlrpclib.Marshaller().dumps(f)
|
|
self.assertRaises(xmlrpclib.Fault, xmlrpclib.loads, s)
|
|
|
|
|
|
class DateTimeTestCase(unittest.TestCase):
|
|
def test_default(self):
|
|
t = xmlrpclib.DateTime()
|
|
|
|
def test_time(self):
|
|
d = 1181399930.036952
|
|
t = xmlrpclib.DateTime(d)
|
|
self.assertEqual(str(t), time.strftime("%Y%m%dT%H:%M:%S", time.localtime(d)))
|
|
|
|
def test_time_tuple(self):
|
|
d = (2007,6,9,10,38,50,5,160,0)
|
|
t = xmlrpclib.DateTime(d)
|
|
self.assertEqual(str(t), '20070609T10:38:50')
|
|
|
|
def test_time_struct(self):
|
|
d = time.localtime(1181399930.036952)
|
|
t = xmlrpclib.DateTime(d)
|
|
self.assertEqual(str(t), time.strftime("%Y%m%dT%H:%M:%S", d))
|
|
|
|
def test_datetime_datetime(self):
|
|
d = datetime.datetime(2007,1,2,3,4,5)
|
|
t = xmlrpclib.DateTime(d)
|
|
self.assertEqual(str(t), '20070102T03:04:05')
|
|
|
|
def test_datetime_date(self):
|
|
d = datetime.date(2007,9,8)
|
|
t = xmlrpclib.DateTime(d)
|
|
self.assertEqual(str(t), '20070908T00:00:00')
|
|
|
|
def test_datetime_time(self):
|
|
d = datetime.time(13,17,19)
|
|
# allow for date rollover by checking today's or tomorrow's dates
|
|
dd1 = datetime.datetime.now().date()
|
|
dd2 = dd1 + datetime.timedelta(days=1)
|
|
vals = (dd1.strftime('%Y%m%dT13:17:19'),
|
|
dd2.strftime('%Y%m%dT13:17:19'))
|
|
t = xmlrpclib.DateTime(d)
|
|
self.assertEqual(str(t) in vals, True)
|
|
|
|
def test_repr(self):
|
|
d = datetime.datetime(2007,1,2,3,4,5)
|
|
t = xmlrpclib.DateTime(d)
|
|
val ="<DateTime '20070102T03:04:05' at %x>" % id(t)
|
|
self.assertEqual(repr(t), val)
|
|
|
|
def test_decode(self):
|
|
d = ' 20070908T07:11:13 '
|
|
t1 = xmlrpclib.DateTime()
|
|
t1.decode(d)
|
|
tref = xmlrpclib.DateTime(datetime.datetime(2007,9,8,7,11,13))
|
|
self.assertEqual(t1, tref)
|
|
|
|
t2 = xmlrpclib._datetime(d)
|
|
self.assertEqual(t1, tref)
|
|
|
|
class BinaryTestCase(unittest.TestCase):
|
|
|
|
# XXX What should str(Binary(b"\xff")) return? I'm chosing "\xff"
|
|
# for now (i.e. interpreting the binary data as Latin-1-encoded
|
|
# text). But this feels very unsatisfactory. Perhaps we should
|
|
# only define repr(), and return r"Binary(b'\xff')" instead?
|
|
|
|
def test_default(self):
|
|
t = xmlrpclib.Binary()
|
|
self.assertEqual(str(t), '')
|
|
|
|
def test_string(self):
|
|
d = b'\x01\x02\x03abc123\xff\xfe'
|
|
t = xmlrpclib.Binary(d)
|
|
self.assertEqual(str(t), str(d, "latin-1"))
|
|
|
|
def test_decode(self):
|
|
d = b'\x01\x02\x03abc123\xff\xfe'
|
|
de = base64.encodestring(d)
|
|
t1 = xmlrpclib.Binary()
|
|
t1.decode(de)
|
|
self.assertEqual(str(t1), str(d, "latin-1"))
|
|
|
|
t2 = xmlrpclib._binary(de)
|
|
self.assertEqual(str(t2), str(d, "latin-1"))
|
|
|
|
|
|
PORT = None
|
|
|
|
def http_server(evt, numrequests):
|
|
class TestInstanceClass:
|
|
def div(self, x, y):
|
|
'''This is the div function'''
|
|
return x // y
|
|
|
|
try:
|
|
serv = SimpleXMLRPCServer.SimpleXMLRPCServer(("localhost", 0),
|
|
logRequests=False, bind_and_activate=False)
|
|
serv.server_bind()
|
|
global PORT
|
|
PORT = serv.socket.getsockname()[1]
|
|
serv.server_activate()
|
|
serv.register_introspection_functions()
|
|
serv.register_multicall_functions()
|
|
serv.register_function(pow)
|
|
serv.register_function(lambda x,y: x+y, 'add')
|
|
serv.register_instance(TestInstanceClass())
|
|
|
|
# handle up to 'numrequests' requests
|
|
while numrequests > 0:
|
|
serv.handle_request()
|
|
numrequests -= 1
|
|
|
|
except socket.timeout:
|
|
pass
|
|
finally:
|
|
serv.socket.close()
|
|
PORT = None
|
|
evt.set()
|
|
|
|
|
|
|
|
|
|
class SimpleServerTestCase(unittest.TestCase):
|
|
def setUp(self):
|
|
# enable traceback reporting
|
|
SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
|
|
|
|
self.evt = threading.Event()
|
|
# start server thread to handle requests
|
|
serv_args = (self.evt, 1)
|
|
threading.Thread(target=http_server, args=serv_args).start()
|
|
|
|
# wait for port to be assigned to server
|
|
n = 1000
|
|
while n > 0 and PORT is None:
|
|
time.sleep(0.001)
|
|
n -= 1
|
|
|
|
time.sleep(0.5)
|
|
|
|
def tearDown(self):
|
|
# wait on the server thread to terminate
|
|
self.evt.wait()
|
|
|
|
# disable traceback reporting
|
|
SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
|
|
|
|
def test_simple1(self):
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
self.assertEqual(p.pow(6,8), 6**8)
|
|
except xmlrpclib.ProtocolError as e:
|
|
# protocol error; provide additional information in test output
|
|
self.fail("%s\n%s" % (e, e.headers))
|
|
|
|
def test_introspection1(self):
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
meth = p.system.listMethods()
|
|
expected_methods = set(['pow', 'div', 'add', 'system.listMethods',
|
|
'system.methodHelp', 'system.methodSignature', 'system.multicall'])
|
|
self.assertEqual(set(meth), expected_methods)
|
|
except xmlrpclib.ProtocolError as e:
|
|
# protocol error; provide additional information in test output
|
|
self.fail("%s\n%s" % (e, e.headers))
|
|
|
|
def test_introspection2(self):
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
divhelp = p.system.methodHelp('div')
|
|
self.assertEqual(divhelp, 'This is the div function')
|
|
except xmlrpclib.ProtocolError as e:
|
|
# protocol error; provide additional information in test output
|
|
self.fail("%s\n%s" % (e, e.headers))
|
|
|
|
def test_introspection3(self):
|
|
# the SimpleXMLRPCServer doesn't support signatures, but
|
|
# at least check that we can try making the call
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
divsig = p.system.methodSignature('div')
|
|
self.assertEqual(divsig, 'signatures not supported')
|
|
except xmlrpclib.ProtocolError as e:
|
|
# protocol error; provide additional information in test output
|
|
self.fail("%s\n%s" % (e, e.headers))
|
|
|
|
def test_multicall(self):
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
multicall = xmlrpclib.MultiCall(p)
|
|
multicall.add(2,3)
|
|
multicall.pow(6,8)
|
|
multicall.div(127,42)
|
|
add_result, pow_result, div_result = multicall()
|
|
self.assertEqual(add_result, 2+3)
|
|
self.assertEqual(pow_result, 6**8)
|
|
self.assertEqual(div_result, 127//42)
|
|
except xmlrpclib.ProtocolError as e:
|
|
# protocol error; provide additional information in test output
|
|
self.fail("%s\n%s" % (e, e.headers))
|
|
|
|
|
|
# This is a contrived way to make a failure occur on the server side
|
|
# in order to test the _send_traceback_header flag on the server
|
|
class FailingMessageClass(mimetools.Message):
|
|
def __getitem__(self, key):
|
|
key = key.lower()
|
|
if key == 'content-length':
|
|
return 'I am broken'
|
|
return mimetools.Message.__getitem__(self, key)
|
|
|
|
|
|
class FailingServerTestCase(unittest.TestCase):
|
|
def setUp(self):
|
|
self.evt = threading.Event()
|
|
# start server thread to handle requests
|
|
serv_args = (self.evt, 1)
|
|
threading.Thread(target=http_server, args=serv_args).start()
|
|
|
|
# wait for port to be assigned to server
|
|
n = 1000
|
|
while n > 0 and PORT is None:
|
|
time.sleep(0.001)
|
|
n -= 1
|
|
|
|
time.sleep(0.5)
|
|
|
|
def tearDown(self):
|
|
# wait on the server thread to terminate
|
|
self.evt.wait()
|
|
# reset flag
|
|
SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = False
|
|
# reset message class
|
|
SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = mimetools.Message
|
|
|
|
def test_basic(self):
|
|
# check that flag is false by default
|
|
flagval = SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header
|
|
self.assertEqual(flagval, False)
|
|
|
|
# enable traceback reporting
|
|
SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
|
|
|
|
# test a call that shouldn't fail just as a smoke test
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
self.assertEqual(p.pow(6,8), 6**8)
|
|
except xmlrpclib.ProtocolError as e:
|
|
# protocol error; provide additional information in test output
|
|
self.fail("%s\n%s" % (e, e.headers))
|
|
|
|
def test_fail_no_info(self):
|
|
# use the broken message class
|
|
SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
|
|
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
p.pow(6,8)
|
|
except xmlrpclib.ProtocolError as e:
|
|
# The two server-side error headers shouldn't be sent back in this case
|
|
self.assertTrue(e.headers.get("X-exception") is None)
|
|
self.assertTrue(e.headers.get("X-traceback") is None)
|
|
else:
|
|
self.fail('ProtocolError not raised')
|
|
|
|
def test_fail_with_info(self):
|
|
# use the broken message class
|
|
SimpleXMLRPCServer.SimpleXMLRPCRequestHandler.MessageClass = FailingMessageClass
|
|
|
|
# Check that errors in the server send back exception/traceback
|
|
# info when flag is set
|
|
SimpleXMLRPCServer.SimpleXMLRPCServer._send_traceback_header = True
|
|
|
|
try:
|
|
p = xmlrpclib.ServerProxy('http://localhost:%d' % PORT)
|
|
p.pow(6,8)
|
|
except xmlrpclib.ProtocolError as e:
|
|
# We should get error info in the response
|
|
expected_err = "invalid literal for int() with base 10: 'I am broken'"
|
|
self.assertEqual(e.headers.get("x-exception"), expected_err)
|
|
self.assertTrue(e.headers.get("x-traceback") is not None)
|
|
else:
|
|
self.fail('ProtocolError not raised')
|
|
|
|
|
|
def test_main():
|
|
xmlrpc_tests = [XMLRPCTestCase, HelperTestCase, DateTimeTestCase,
|
|
BinaryTestCase, FaultTestCase]
|
|
|
|
# The test cases against a SimpleXMLRPCServer raise a socket error
|
|
# 10035 (WSAEWOULDBLOCK) in the server thread handle_request call when
|
|
# run on Windows. This only happens on the first test to run, but it
|
|
# fails every time and so these tests are skipped on win32 platforms.
|
|
if sys.platform != 'win32':
|
|
xmlrpc_tests.append(SimpleServerTestCase)
|
|
xmlrpc_tests.append(FailingServerTestCase)
|
|
|
|
test_support.run_unittest(*xmlrpc_tests)
|
|
|
|
if __name__ == "__main__":
|
|
test_main()
|