Fixed the CGI request handler and added a test for it

Author: tcalmant

jsonrpclib/SimpleJSONRPCServer.py

@@ -41,6 +41,7 @@
     # variant of this package.
     SimpleXMLRPCDispatcher = xmlrpcserver.SimpleXMLRPCDispatcher
     SimpleXMLRPCRequestHandler = xmlrpcserver.SimpleXMLRPCRequestHandler
+    CGIXMLRPCRequestHandler = xmlrpcserver.CGIXMLRPCRequestHandler
     resolve_dotted_attribute = xmlrpcserver.resolve_dotted_attribute
     import socketserver
 except (ImportError, AttributeError):
@@ -49,6 +50,7 @@
     import SimpleXMLRPCServer as xmlrpcserver
     SimpleXMLRPCDispatcher = xmlrpcserver.SimpleXMLRPCDispatcher
     SimpleXMLRPCRequestHandler = xmlrpcserver.SimpleXMLRPCRequestHandler
+    CGIXMLRPCRequestHandler = xmlrpcserver.CGIXMLRPCRequestHandler
     resolve_dotted_attribute = xmlrpcserver.resolve_dotted_attribute
     import SocketServer as socketserver
 
@@ -585,7 +587,7 @@ def server_close(self):
 # ------------------------------------------------------------------------------
 
 
-class CGIJSONRPCRequestHandler(SimpleJSONRPCDispatcher):
+class CGIJSONRPCRequestHandler(SimpleJSONRPCDispatcher, CGIXMLRPCRequestHandler):
     """
     JSON-RPC CGI handler (and dispatcher)
     """
@@ -597,17 +599,23 @@ def __init__(self, encoding=None, config=jsonrpclib.config.DEFAULT):
         :param config: A JSONRPClib Config instance
         """
         SimpleJSONRPCDispatcher.__init__(self, encoding, config)
+        CGIXMLRPCRequestHandler.__init__(self)
 
     def handle_jsonrpc(self, request_text):
         """
         Handle a JSON-RPC request
         """
+        try:
+            writer = sys.stdout.buffer
+        except AttributeError:
+            writer = sys.stdout
+
         response = self._marshaled_dispatch(request_text)
-        sys.stdout.write('Content-Type: {0}\r\n'
-                         .format(self.json_config.content_type))
-        sys.stdout.write('Content-Length: {0:d}\r\n'.format(len(response)))
-        sys.stdout.write('\r\n')
-        sys.stdout.write(response)
+        print('Content-Type: {0}'.format(self.json_config.content_type))
+        print('Content-Length: {0:d}'.format(len(response)))
+        print()
+        writer.write(response.encode(self.encoding))
+        writer.flush()
 
     # XML-RPC alias
     handle_xmlrpc = handle_jsonrpc

tests/cgi-bin/cgi_server.py

@@ -0,0 +1,22 @@
+#!/usr/bin/python
+"""
+Sample CGI server
+"""
+
+import os
+import sys
+
+current_dir = os.path.dirname(__file__)
+root_dir = os.path.dirname(os.path.dirname(current_dir))
+sys.path.insert(0, root_dir)
+
+from jsonrpclib.SimpleJSONRPCServer import CGIJSONRPCRequestHandler
+
+
+def add(a, b):
+    return a + b
+
+
+handler = CGIJSONRPCRequestHandler()
+handler.register_function(add)
+handler.handle_request()

tests/test_cgi.py

@@ -0,0 +1,66 @@
+#!/usr/bin/python
+# -- Content-Encoding: UTF-8 --
+"""
+Tests the CGI request handler
+
+:license: Apache License 2.0
+"""
+
+# Standard library
+import os
+import random
+import threading
+import unittest
+
+try:
+    from http.server import HTTPServer, CGIHTTPRequestHandler
+except ImportError:
+    from SimpleHTTPServer import HTTPServer
+    from CGIHTTPServer import CGIHTTPRequestHandler
+
+# JSON-RPC library
+from jsonrpclib import ServerProxy
+
+# ------------------------------------------------------------------------------
+
+
+class CGIHandlerTests(unittest.TestCase):
+    """
+    These tests verify that the CGI request handler works correctly
+    """
+
+    def test_server(self):
+        """
+        Tests the CGI request handler
+        """
+        # Move the parent directory of "cgi-bin"
+        old_dir = os.getcwd()
+        try:
+            # Setup server
+            os.chdir(os.path.dirname(__file__))
+            server = HTTPServer(("localhost", 0), CGIHTTPRequestHandler)
+
+            # Serve in a thread
+            thread = threading.Thread(target=server.serve_forever)
+            thread.daemon = True
+            thread.start()
+
+            # Find its port
+            port = server.socket.getsockname()[1]
+
+            # Make the client
+            client = ServerProxy(
+                "http://localhost:{0}/cgi-bin/cgi_server.py".format(port)
+            )
+
+            # Check calls
+            for _ in range(3):
+                a, b = random.random(), random.random()
+                result = client.add(a, b)
+                self.assertEqual(result, a + b)
+
+            # Close server
+            server.server_close()
+            thread.join()
+        finally:
+            os.chdir(old_dir)