new method _callServer(methodAPI, argsAPI=None)

calls server method METHODAPI with error handling and returns the
responds
lczub#2

Author: Luiko Czub

src/testlink/testlinkapi.py

@@ -9,19 +9,42 @@
 import xmlrpclib
 
 from testlinkhelper import TestLinkHelper, VERSION
+import testlinkerrors
 
 
 class TestLinkAPIClient(object):    
 
-    __slots__ = ['server', 'devKey', 'stepsList']
+    __slots__ = ['server', 'devKey', 'stepsList', '_server_url']
 
     __VERSION__ = VERSION
 
     def __init__(self, server_url, devKey):
         self.server = xmlrpclib.Server(server_url)
         self.devKey = devKey
         self.stepsList = []
-
+        self._server_url = server_url
+        
+    def _callServer(self, methodAPI, argsAPI=None):
+        """ call server method METHODAPI with error handling and returns the 
+        responds """
+        
+        response = None
+        try:
+            if argsAPI is None:
+                response = getattr(self.server.tl, methodAPI)()
+            else:
+                response = getattr(self.server.tl, methodAPI)(argsAPI)
+        except (IOError, xmlrpclib.ProtocolError), msg:
+            new_msg = 'problems connecting the TestLink Server %s\n%s' %\
+            (self._server_url, msg) 
+            raise testlinkerrors.TLConnectionError(new_msg)
+        except xmlrpclib.Fault, msg:
+            new_msg = 'problems calling the API method %s\n%s' %\
+            (methodAPI, msg) 
+            raise testlinkerrors.TLAPIError(new_msg)
+
+        return response
+        
     #
     #  BUILT-IN API CALLS
     #

src/testlink/testlinkerrors.py

@@ -7,12 +7,21 @@
 #  see https://github.com/orenault/TestLink-API-Python-client/issues/4
 
 class TestLinkError(Exception):
-    """ Basic error handler
+    """ Basic error 
     Return message pass as argument
     """
-    def __init__(self, msg):
-        self.__msg = msg
+#    def __init__(self, msg):
+#        self.__msg = msg
+#
+#    def __str__(self):
+#        return self.__msg
+
+class TLConnectionError(TestLinkError):
+    """ Connection error 
+    - wrong url? - server not reachable? """
+    
+class TLAPIError(TestLinkError):
+    """ API error 
+    - wrong method name ? - misssing required args? """
 
-    def __str__(self):
-        return self.__msg
 

src/testlink/version.py

@@ -6,4 +6,4 @@
 #  Licensed under ???
 #  see https://github.com/orenault/TestLink-API-Python-client/issues/4
 
-VERSION = '0.4.0-Alpha'
+VERSION = '0.4.0-Alpha_error-handling'

test/utest/testlinkapicallservertest.py

@@ -0,0 +1,62 @@
+#! /usr/bin/python
+# -*- coding: UTF-8 -*-
+
+#  Copyright 2012 Luiko Czub, TestLink-API-Python-client developers
+#
+#  Licensed under ???
+#  see https://github.com/orenault/TestLink-API-Python-client/issues/4
+
+# this test requires an online TestLink Server, which connection parameters
+# are defined in environment variables
+#     TESTLINK_API_PYTHON_DEVKEY and TESTLINK_API_PYTHON_DEVKEY
+
+import unittest
+from testlink import TestLinkAPIClient, TestLinkHelper
+from testlink import testlinkerrors
+
+
+class TestLinkAPIcallServerTestCase(unittest.TestCase):
+    """ TestCases for TestLinkAPICleint._callServer()  """
+
+
+    def test_callServer_noArgs(self):
+        """ test _callServer() - calling method with no args """
+        
+        client = TestLinkHelper().connect(TestLinkAPIClient)
+        response = client._callServer('sayHello')
+        self.assertEqual('Hello!', response)
+        
+    def test_callServer_withArgs(self):
+        """ test _callServer() - calling method with args """
+        
+        client = TestLinkHelper().connect(TestLinkAPIClient)
+        response = client._callServer('repeat', {'str' : 'some arg'})
+        self.assertEqual('You said: some arg', response)
+        
+    def test_callServer_ProtocollError(self):
+        """ test _callServer() - Server raises ProtocollError """
+        
+        server_url = TestLinkHelper()._server_url
+        bad_server_url = server_url.split('xmlrpc.php')[0] 
+        client = TestLinkHelper(bad_server_url).connect(TestLinkAPIClient)
+        def a_func(api_client): api_client._callServer('sayHello')
+        self.assertRaises(testlinkerrors.TLConnectionError, a_func, client)
+        
+    def test_callServer_socketError(self):
+        """ test _callServer() - Server raises a socket Error (IOError) """
+        
+        bad_server_url = 'http://111.222.333.4/testlink/lib/api/xmlrpc.php' 
+        client = TestLinkHelper(bad_server_url).connect(TestLinkAPIClient)
+        def a_func(api_client): api_client._callServer('sayHello')
+        self.assertRaises(testlinkerrors.TLConnectionError, a_func, client)
+
+    def test_callServer_FaultError(self):
+        """ test _callServer() - Server raises Fault Error """
+        
+        client = TestLinkHelper().connect(TestLinkAPIClient)
+        def a_func(api_client): api_client._callServer('sayGoodBye')
+        self.assertRaises(testlinkerrors.TLAPIError, a_func, client)
+
+if __name__ == "__main__":
+    #import sys;sys.argv = ['', 'Test.testName']
+    unittest.main()

test/utest/testlinkhelpertest.py

@@ -6,6 +6,9 @@
 #  Licensed under ???
 #  see https://github.com/orenault/TestLink-API-Python-client/issues/4
 
+# this test works WITHOUT an online TestLink Server
+# no calls are send to a TestLink Server
+
 import unittest, os
 from testlink import TestLinkHelper