2007-12-09 18:39:12 -04:00
|
|
|
from DocXMLRPCServer import DocXMLRPCServer
|
|
|
|
import httplib
|
2010-02-22 20:24:49 -04:00
|
|
|
import sys
|
2007-12-09 18:39:12 -04:00
|
|
|
from test import test_support
|
2010-04-27 20:55:59 -03:00
|
|
|
threading = test_support.import_module('threading')
|
2007-12-09 18:39:12 -04:00
|
|
|
import unittest
|
|
|
|
|
2010-02-22 20:24:49 -04:00
|
|
|
def make_request_and_skipIf(condition, reason):
|
2014-12-01 12:16:30 -04:00
|
|
|
# If we skip the test, we have to make a request because
|
2010-02-22 20:24:49 -04:00
|
|
|
# the server created in setUp blocks expecting one to come in.
|
|
|
|
if not condition:
|
|
|
|
return lambda func: func
|
|
|
|
def decorator(func):
|
|
|
|
def make_request_and_skip(self):
|
|
|
|
self.client.request("GET", "/")
|
|
|
|
self.client.getresponse()
|
|
|
|
raise unittest.SkipTest(reason)
|
|
|
|
return make_request_and_skip
|
|
|
|
return decorator
|
|
|
|
|
|
|
|
|
2016-08-18 03:12:22 -03:00
|
|
|
def make_server():
|
2008-10-03 13:18:42 -03:00
|
|
|
serv = DocXMLRPCServer(("localhost", 0), logRequests=False)
|
2007-12-09 18:39:12 -04:00
|
|
|
|
2008-10-03 13:18:42 -03:00
|
|
|
try:
|
2007-12-09 18:39:12 -04:00
|
|
|
# Add some documentation
|
|
|
|
serv.set_server_title("DocXMLRPCServer Test Documentation")
|
|
|
|
serv.set_server_name("DocXMLRPCServer Test Docs")
|
|
|
|
serv.set_server_documentation(
|
2010-01-23 19:04:36 -04:00
|
|
|
"This is an XML-RPC server's documentation, but the server "
|
|
|
|
"can be used by POSTing to /RPC2. Try self.add, too.")
|
2007-12-09 18:39:12 -04:00
|
|
|
|
|
|
|
# Create and register classes and functions
|
|
|
|
class TestClass(object):
|
|
|
|
def test_method(self, arg):
|
|
|
|
"""Test method's docs. This method truly does very little."""
|
|
|
|
self.arg = arg
|
|
|
|
|
|
|
|
serv.register_introspection_functions()
|
|
|
|
serv.register_instance(TestClass())
|
|
|
|
|
|
|
|
def add(x, y):
|
|
|
|
"""Add two instances together. This follows PEP008, but has nothing
|
|
|
|
to do with RFC1952. Case should matter: pEp008 and rFC1952. Things
|
|
|
|
that start with http and ftp should be auto-linked, too:
|
|
|
|
http://google.com.
|
|
|
|
"""
|
|
|
|
return x + y
|
|
|
|
|
|
|
|
serv.register_function(add)
|
|
|
|
serv.register_function(lambda x, y: x-y)
|
2016-08-18 03:12:22 -03:00
|
|
|
return serv
|
|
|
|
except:
|
2007-12-09 18:39:12 -04:00
|
|
|
serv.server_close()
|
2016-08-18 03:12:22 -03:00
|
|
|
raise
|
2007-12-09 18:39:12 -04:00
|
|
|
|
|
|
|
class DocXMLRPCHTTPGETServer(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
|
|
# Enable server feedback
|
|
|
|
DocXMLRPCServer._send_traceback_header = True
|
|
|
|
|
2016-08-18 03:12:22 -03:00
|
|
|
self.serv = make_server()
|
|
|
|
self.thread = threading.Thread(target=self.serv.serve_forever)
|
|
|
|
self.thread.start()
|
2007-12-09 18:39:12 -04:00
|
|
|
|
2016-08-18 03:12:22 -03:00
|
|
|
PORT = self.serv.server_address[1]
|
2007-12-09 18:39:12 -04:00
|
|
|
self.client = httplib.HTTPConnection("localhost:%d" % PORT)
|
|
|
|
|
|
|
|
def tearDown(self):
|
|
|
|
self.client.close()
|
|
|
|
|
|
|
|
# Disable server feedback
|
|
|
|
DocXMLRPCServer._send_traceback_header = False
|
2016-08-18 03:12:22 -03:00
|
|
|
self.serv.shutdown()
|
|
|
|
self.thread.join()
|
|
|
|
self.serv.server_close()
|
2007-12-09 18:39:12 -04:00
|
|
|
|
|
|
|
def test_valid_get_response(self):
|
|
|
|
self.client.request("GET", "/")
|
|
|
|
response = self.client.getresponse()
|
|
|
|
|
|
|
|
self.assertEqual(response.status, 200)
|
|
|
|
self.assertEqual(response.getheader("Content-type"), "text/html")
|
|
|
|
|
2012-12-18 15:27:37 -04:00
|
|
|
# Server raises an exception if we don't start to read the data
|
2007-12-09 18:39:12 -04:00
|
|
|
response.read()
|
|
|
|
|
|
|
|
def test_invalid_get_response(self):
|
|
|
|
self.client.request("GET", "/spam")
|
|
|
|
response = self.client.getresponse()
|
|
|
|
|
|
|
|
self.assertEqual(response.status, 404)
|
|
|
|
self.assertEqual(response.getheader("Content-type"), "text/plain")
|
|
|
|
|
|
|
|
response.read()
|
|
|
|
|
|
|
|
def test_lambda(self):
|
|
|
|
"""Test that lambda functionality stays the same. The output produced
|
|
|
|
currently is, I suspect invalid because of the unencoded brackets in the
|
|
|
|
HTML, "<lambda>".
|
|
|
|
|
|
|
|
The subtraction lambda method is tested.
|
|
|
|
"""
|
|
|
|
self.client.request("GET", "/")
|
|
|
|
response = self.client.getresponse()
|
|
|
|
|
2010-01-23 19:04:36 -04:00
|
|
|
self.assertIn('<dl><dt><a name="-<lambda>"><strong>'
|
|
|
|
'<lambda></strong></a>(x, y)</dt></dl>',
|
|
|
|
response.read())
|
2007-12-09 18:39:12 -04:00
|
|
|
|
2010-02-22 20:24:49 -04:00
|
|
|
@make_request_and_skipIf(sys.flags.optimize >= 2,
|
|
|
|
"Docstrings are omitted with -O2 and above")
|
2007-12-09 18:39:12 -04:00
|
|
|
def test_autolinking(self):
|
2010-02-22 20:24:49 -04:00
|
|
|
"""Test that the server correctly automatically wraps references to
|
|
|
|
PEPS and RFCs with links, and that it linkifies text starting with
|
|
|
|
http or ftp protocol prefixes.
|
2007-12-09 18:39:12 -04:00
|
|
|
|
|
|
|
The documentation for the "add" method contains the test material.
|
|
|
|
"""
|
|
|
|
self.client.request("GET", "/")
|
|
|
|
response = self.client.getresponse()
|
|
|
|
|
2010-01-23 19:04:36 -04:00
|
|
|
self.assertIn(
|
|
|
|
('<dl><dt><a name="-add"><strong>add</strong></a>(x, y)</dt><dd>'
|
|
|
|
'<tt>Add two instances together. This '
|
|
|
|
'follows <a href="http://www.python.org/dev/peps/pep-0008/">'
|
|
|
|
'PEP008</a>, but has nothing<br>\nto do '
|
|
|
|
'with <a href="http://www.rfc-editor.org/rfc/rfc1952.txt">'
|
|
|
|
'RFC1952</a>. Case should matter: pEp008 '
|
|
|
|
'and rFC1952. Things<br>\nthat start '
|
|
|
|
'with http and ftp should be '
|
|
|
|
'auto-linked, too:<br>\n<a href="http://google.com">'
|
|
|
|
'http://google.com</a>.</tt></dd></dl>'), response.read())
|
2007-12-09 18:39:12 -04:00
|
|
|
|
2010-02-22 20:24:49 -04:00
|
|
|
@make_request_and_skipIf(sys.flags.optimize >= 2,
|
|
|
|
"Docstrings are omitted with -O2 and above")
|
2007-12-09 18:39:12 -04:00
|
|
|
def test_system_methods(self):
|
2016-07-27 23:37:04 -03:00
|
|
|
"""Test the presence of three consecutive system.* methods.
|
2007-12-09 18:39:12 -04:00
|
|
|
|
2010-02-22 20:24:49 -04:00
|
|
|
This also tests their use of parameter type recognition and the
|
|
|
|
systems related to that process.
|
2007-12-09 18:39:12 -04:00
|
|
|
"""
|
|
|
|
self.client.request("GET", "/")
|
|
|
|
response = self.client.getresponse()
|
|
|
|
|
2010-01-23 19:04:36 -04:00
|
|
|
self.assertIn(
|
|
|
|
('<dl><dt><a name="-system.listMethods"><strong>system.listMethods'
|
|
|
|
'</strong></a>()</dt><dd><tt><a href="#-system.listMethods">system'
|
|
|
|
'.listMethods</a>() => [\'add\', \'subtract\','
|
|
|
|
' \'multiple\']<br>\n <br>\nReturns a list'
|
|
|
|
' of the methods supported by the'
|
|
|
|
' server.</tt></dd></dl>\n <dl><dt><a name="-system.methodHelp">'
|
|
|
|
'<strong>system.methodHelp</strong></a>(method_name)</dt><dd><tt>'
|
|
|
|
'<a href="#-system.methodHelp">system.methodHelp</a>(\'add\') '
|
|
|
|
'=> "Adds two integers together"<br>\n '
|
|
|
|
'<br>\nReturns a string containing documentation'
|
|
|
|
' for the specified method.</tt></dd></dl>\n '
|
|
|
|
'<dl><dt><a name="-system.methodSignature"><strong>system.'
|
|
|
|
'methodSignature</strong></a>(method_name)</dt><dd><tt><a href="#-'
|
|
|
|
'system.methodSignature">system.methodSignature</a>(\'add\') '
|
|
|
|
'=> [double, int, int]<br>\n <br>\nReturns'
|
|
|
|
' a list describing the signature of'
|
|
|
|
' the method. In the<br>\nabove example,'
|
|
|
|
' the add method takes two integers'
|
|
|
|
' as arguments<br>\nand returns a double'
|
|
|
|
' result.<br>\n <br>\nThis server does '
|
|
|
|
'NOT support system.methodSignature.</tt></dd></dl>'),
|
|
|
|
response.read())
|
2007-12-09 18:39:12 -04:00
|
|
|
|
|
|
|
def test_autolink_dotted_methods(self):
|
|
|
|
"""Test that selfdot values are made strong automatically in the
|
|
|
|
documentation."""
|
|
|
|
self.client.request("GET", "/")
|
|
|
|
response = self.client.getresponse()
|
|
|
|
|
2010-01-23 19:04:36 -04:00
|
|
|
self.assertIn("""Try self.<strong>add</strong>, too.""",
|
|
|
|
response.read())
|
2007-12-09 18:39:12 -04:00
|
|
|
|
|
|
|
def test_main():
|
|
|
|
test_support.run_unittest(DocXMLRPCHTTPGETServer)
|
|
|
|
|
|
|
|
if __name__ == '__main__':
|
|
|
|
test_main()
|