1from xmlrpc.server import DocXMLRPCServer 2import http.client 3import sys 4import threading 5from test import support 6import unittest 7 8def make_request_and_skipIf(condition, reason): 9 # If we skip the test, we have to make a request because 10 # the server created in setUp blocks expecting one to come in. 11 if not condition: 12 return lambda func: func 13 def decorator(func): 14 def make_request_and_skip(self): 15 self.client.request("GET", "/") 16 self.client.getresponse() 17 raise unittest.SkipTest(reason) 18 return make_request_and_skip 19 return decorator 20 21 22def make_server(): 23 serv = DocXMLRPCServer(("localhost", 0), logRequests=False) 24 25 try: 26 # Add some documentation 27 serv.set_server_title("DocXMLRPCServer Test Documentation") 28 serv.set_server_name("DocXMLRPCServer Test Docs") 29 serv.set_server_documentation( 30 "This is an XML-RPC server's documentation, but the server " 31 "can be used by POSTing to /RPC2. Try self.add, too.") 32 33 # Create and register classes and functions 34 class TestClass(object): 35 def test_method(self, arg): 36 """Test method's docs. This method truly does very little.""" 37 self.arg = arg 38 39 serv.register_introspection_functions() 40 serv.register_instance(TestClass()) 41 42 def add(x, y): 43 """Add two instances together. This follows PEP008, but has nothing 44 to do with RFC1952. Case should matter: pEp008 and rFC1952. Things 45 that start with http and ftp should be auto-linked, too: 46 http://google.com. 47 """ 48 return x + y 49 50 def annotation(x: int): 51 """ Use function annotations. """ 52 return x 53 54 class ClassWithAnnotation: 55 def method_annotation(self, x: bytes): 56 return x.decode() 57 58 serv.register_function(add) 59 serv.register_function(lambda x, y: x-y) 60 serv.register_function(annotation) 61 serv.register_instance(ClassWithAnnotation()) 62 return serv 63 except: 64 serv.server_close() 65 raise 66 67class DocXMLRPCHTTPGETServer(unittest.TestCase): 68 def setUp(self): 69 # Enable server feedback 70 DocXMLRPCServer._send_traceback_header = True 71 72 self.serv = make_server() 73 self.thread = threading.Thread(target=self.serv.serve_forever) 74 self.thread.start() 75 76 PORT = self.serv.server_address[1] 77 self.client = http.client.HTTPConnection("localhost:%d" % PORT) 78 79 def tearDown(self): 80 self.client.close() 81 82 # Disable server feedback 83 DocXMLRPCServer._send_traceback_header = False 84 self.serv.shutdown() 85 self.thread.join() 86 self.serv.server_close() 87 88 def test_valid_get_response(self): 89 self.client.request("GET", "/") 90 response = self.client.getresponse() 91 92 self.assertEqual(response.status, 200) 93 self.assertEqual(response.getheader("Content-type"), "text/html") 94 95 # Server raises an exception if we don't start to read the data 96 response.read() 97 98 def test_invalid_get_response(self): 99 self.client.request("GET", "/spam") 100 response = self.client.getresponse() 101 102 self.assertEqual(response.status, 404) 103 self.assertEqual(response.getheader("Content-type"), "text/plain") 104 105 response.read() 106 107 def test_lambda(self): 108 """Test that lambda functionality stays the same. The output produced 109 currently is, I suspect invalid because of the unencoded brackets in the 110 HTML, "<lambda>". 111 112 The subtraction lambda method is tested. 113 """ 114 self.client.request("GET", "/") 115 response = self.client.getresponse() 116 117 self.assertIn((b'<dl><dt><a name="-<lambda>"><strong>' 118 b'<lambda></strong></a>(x, y)</dt></dl>'), 119 response.read()) 120 121 @make_request_and_skipIf(sys.flags.optimize >= 2, 122 "Docstrings are omitted with -O2 and above") 123 def test_autolinking(self): 124 """Test that the server correctly automatically wraps references to 125 PEPS and RFCs with links, and that it linkifies text starting with 126 http or ftp protocol prefixes. 127 128 The documentation for the "add" method contains the test material. 129 """ 130 self.client.request("GET", "/") 131 response = self.client.getresponse().read() 132 133 self.assertIn( 134 (b'<dl><dt><a name="-add"><strong>add</strong></a>(x, y)</dt><dd>' 135 b'<tt>Add two instances together. This ' 136 b'follows <a href="http://www.python.org/dev/peps/pep-0008/">' 137 b'PEP008</a>, but has nothing<br>\nto do ' 138 b'with <a href="http://www.rfc-editor.org/rfc/rfc1952.txt">' 139 b'RFC1952</a>. Case should matter: pEp008 ' 140 b'and rFC1952. Things<br>\nthat start ' 141 b'with http and ftp should be ' 142 b'auto-linked, too:<br>\n<a href="http://google.com">' 143 b'http://google.com</a>.</tt></dd></dl>'), response) 144 145 @make_request_and_skipIf(sys.flags.optimize >= 2, 146 "Docstrings are omitted with -O2 and above") 147 def test_system_methods(self): 148 """Test the presence of three consecutive system.* methods. 149 150 This also tests their use of parameter type recognition and the 151 systems related to that process. 152 """ 153 self.client.request("GET", "/") 154 response = self.client.getresponse().read() 155 156 self.assertIn( 157 (b'<dl><dt><a name="-system.methodHelp"><strong>system.methodHelp' 158 b'</strong></a>(method_name)</dt><dd><tt><a href="#-system.method' 159 b'Help">system.methodHelp</a>(\'add\') => "Adds ' 160 b'two integers together"<br>\n <br>\nReturns a' 161 b' string containing documentation for ' 162 b'the specified method.</tt></dd></dl>\n<dl><dt><a name' 163 b'="-system.methodSignature"><strong>system.methodSignature</strong>' 164 b'</a>(method_name)</dt><dd><tt><a href="#-system.methodSignature">' 165 b'system.methodSignature</a>(\'add\') => [double, ' 166 b'int, int]<br>\n <br>\nReturns a list ' 167 b'describing the signature of the method.' 168 b' In the<br>\nabove example, the add ' 169 b'method takes two integers as arguments' 170 b'<br>\nand returns a double result.<br>\n ' 171 b'<br>\nThis server does NOT support system' 172 b'.methodSignature.</tt></dd></dl>'), response) 173 174 def test_autolink_dotted_methods(self): 175 """Test that selfdot values are made strong automatically in the 176 documentation.""" 177 self.client.request("GET", "/") 178 response = self.client.getresponse() 179 180 self.assertIn(b"""Try self.<strong>add</strong>, too.""", 181 response.read()) 182 183 def test_annotations(self): 184 """ Test that annotations works as expected """ 185 self.client.request("GET", "/") 186 response = self.client.getresponse() 187 docstring = (b'' if sys.flags.optimize >= 2 else 188 b'<dd><tt>Use function annotations.</tt></dd>') 189 self.assertIn( 190 (b'<dl><dt><a name="-annotation"><strong>annotation</strong></a>' 191 b'(x: int)</dt>' + docstring + b'</dl>\n' 192 b'<dl><dt><a name="-method_annotation"><strong>' 193 b'method_annotation</strong></a>(x: bytes)</dt></dl>'), 194 response.read()) 195 196 197if __name__ == '__main__': 198 unittest.main() 199