Small code review of internal tests (added pydoc)

Author: tcalmant

tests/test_internal.py

@@ -7,16 +7,16 @@
 :license: Apache License 2.0
 """
 
+# Standard library
+import json
+import unittest
+
 # Tests utilities
 from tests.utilities import UtilityServer
 
 # JSON-RPC library
 import jsonrpclib
 
-# Standard library
-import json
-import unittest
-
 # ------------------------------------------------------------------------------
 
 
@@ -41,39 +41,65 @@ def tearDown(self):
         self.server.stop()
 
     def get_client(self):
-        return jsonrpclib.ServerProxy('http://localhost:{0}'.format(self.port),
-                                      history=self.history)
+        """
+        Utility method to get a proxy to the test server
+        """
+        return jsonrpclib.ServerProxy(
+            "http://localhost:{0}".format(self.port),
+            history=self.history
+        )
 
     def get_multicall_client(self):
+        """
+        Utility method to get a multi-call proxy to the test server
+        """
         server = self.get_client()
         return jsonrpclib.MultiCall(server)
 
     def test_connect(self):
+        """
+        Simple Ping() test
+        """
         client = self.get_client()
         result = client.ping()
         self.assertTrue(result)
 
     def test_single_args(self):
+        """
+        Positional arguments test
+        """
         client = self.get_client()
         result = client.add(5, 10)
         self.assertTrue(result == 15)
 
     def test_single_kwargs(self):
+        """
+        Keyword-arguments test
+        """
         client = self.get_client()
         result = client.add(x=5, y=10)
         self.assertTrue(result == 15)
 
     def test_single_kwargs_and_args(self):
+        """
+        Mixed positional/keyword args failure test
+        """
         client = self.get_client()
         self.assertRaises(jsonrpclib.ProtocolError,
                           client.add, (5,), {'y': 10})
 
     def test_single_notify(self):
+        """
+        Notification test
+        """
         client = self.get_client()
         result = client._notify.add(5, 10)
         self.assertTrue(result is None)
 
     def test_single_namespace(self):
+        """
+        Namespace test
+        """
         client = self.get_client()
         client.namespace.sum(1, 2, 4)
         request = json.loads(self.history.request)
@@ -89,6 +115,9 @@ def test_single_namespace(self):
         self.assertTrue(verify_response == response)
 
     def test_multicall_success(self):
+        """
+        Multi-call test
+        """
         multicall = self.get_multicall_client()
         multicall.ping()
         multicall.add(5, 10)
@@ -99,13 +128,19 @@ def test_multicall_success(self):
             self.assertTrue(result == correct[i])
 
     def test_multicall_success_2(self):
+        """
+        Another multi-call test
+        """
         multicall = self.get_multicall_client()
         for i in range(3):
             multicall.add(5, i)
         result = multicall()
         self.assertTrue(result[2] == 7)
 
     def test_multicall_failure(self):
+        """
+        Multi-call test with failures
+        """
         multicall = self.get_multicall_client()
         multicall.ping()
         multicall.add(x=5, y=10, z=10)

tests/utilities.py

@@ -6,12 +6,12 @@
 :license: Apache License 2.0
 """
 
-# JSON-RPC library
-from jsonrpclib.SimpleJSONRPCServer import SimpleJSONRPCServer
-
 # Standard library
 import threading
 
+# JSON-RPC library
+from jsonrpclib.SimpleJSONRPCServer import SimpleJSONRPCServer
+
 # ------------------------------------------------------------------------------
 # Test methods
 
@@ -24,28 +24,53 @@ def subtract(minuend, subtrahend):
 
 
 def add(x, y):
+    """
+    Sample addition, positional arguments
+    """
     return x + y
 
 
 def update(*args):
+    """
+    Sample with a list of optional arguments (returns the list)
+    """
     return args
 
 
 def summation(*args):
+    """
+    Sample with a list of optional arguments (returns the sum of the arguments)
+    """
     return sum(args)
 
 
 def notify_hello(*args):
+    """
+    Sample with a list of optional arguments (returns the list), meant to be
+    called as a notification
+    """
     return args
 
 
 def get_data():
+    """
+    Returns a list with a string and an integer
+    """
     return ['hello', 5]
 
 
 def ping():
+    """
+    No argument, returns a boolean
+    """
     return True
 
+def fail():
+    """
+    No argument, raises an exception
+    """
+    raise ValueError("Everything I do fails")
+
 # ------------------------------------------------------------------------------
 # Server utility class
 
@@ -83,6 +108,7 @@ def start(self, addr, port):
         server.register_function(add)
         server.register_function(ping)
         server.register_function(summation, 'namespace.sum')
+        server.register_function(fail)
 
         # Serve in a thread
         self._thread = threading.Thread(target=server.serve_forever)