Add new TestLink class, with error management

Author: pade

test.py

@@ -13,7 +13,7 @@
 '''
 
 import re
-import TestLinkAPI
+from testlink import TestLink, TestLinkErrors
 from nose.tools import *
 
 class TestClass():
@@ -23,22 +23,20 @@ def setUp(self):
 
         SERVEUR_URL = "http://localhost/testlink/lib/api/xmlrpc.php"
         KEY = "7ec252ab966ce88fd92c25d08635672b"
-        self.client = TestLinkAPI.TestLinkAPIClient(server_url=SERVEUR_URL, devKey=KEY)
+        self.client = TestLink(server_url=SERVEUR_URL, key=KEY)
 
     def test_getTestCaseIDByName(self):
         """ getTestCaseIDByName test
         """
-        (val, message) = self.client.getTestCaseIDByName("Fin de programme", "Séquence 2", "Test 2")
-        assert_equal(message, None )
-        (val, message) = self.client.getTestCaseIDByName("Initialisation", "Séquence 1", "Test 2")
-        assert_equal(message, "(getTestCaseIDByName) - Several case test found. Suite name must not be duplicate for the same project") 
-
-    def test___str__(self):
-        """ __str__ test
-        Check that return is a string that contains the version number
-        """
-
-        message = self.client.__str__()
-        assert_not_equal(re.search(self.client.__VERSION__, message), None) 
-
+        val = self.client.getTestCaseIDByName("Fin de programme", "Séquence 2", "Test 2")
+        # 31 is test case id
+        assert_equal(val, '31' )
+
+        try:
+            val = self.client.getTestCaseIDByName("Initialisation", "Séquence 1", "Test 2")
+        except TestLinkErrors, e:
+            assert_equal(str(e), "(getTestCaseIDByName) - Several case test found. Suite name must not be duplicate for the same project") 
+        else:
+            print "An error message is expected !"
+            assert_equal(False, True)
 

testlink.py

@@ -12,7 +12,7 @@
 import xmlrpclib
 import sys
 
-class Errors(Exception):
+class TestLinkErrors(Exception):
     """ Basic error handler
     Return message pass as argument
     """
@@ -22,9 +22,8 @@ def __init__(self, msg):
     def __str__(self):
         return self.__msg
 
-class TestLinkAPIClient:        
+class TestLinkAPIClient(object):        
 
-    __VERSION__ = "0.3"
 
     def __init__(self, server_url, devKey):
         self.server = xmlrpclib.Server(server_url)
@@ -152,9 +151,8 @@ def getTestCaseCustomFieldDesignValue(self, testcaseexternalid, version,
                 'details' : str(details)}
         return self.server.tl.getTestCaseCustomFieldDesignValue(argsAPI)                                                
 
-    def __getTestCaseIDByName(self, testCaseName, testSuiteName=None, testProjectName=None):
-        """ __getTestCaseIDByName :
-        Internal function
+    def getTestCaseIDByName(self, testCaseName, testSuiteName=None, testProjectName=None):
+        """ 
         Find a test case by its name
         testSuiteName and testProjectName are optionals arguments
         This function return a list of tests cases
@@ -180,22 +178,6 @@ def __getTestCaseIDByName(self, testCaseName, testSuiteName=None, testProjectNam
             return ret_srv
 
 
-    def getTestCaseIDByName(self, testCaseName, testSuiteName, testProjectName):
-        """ getTestCaseIDByName :
-        Find a test case by its name, by its suite and its project
-        Suite name must not be duplicate, so only one test case must be found 
-        Return (id, None) if success 
-        or (-1, "error message") in case of error
-        """    
-        results = self.__getTestCaseIDByName(testCaseName, testSuiteName, testProjectName)
-        if results[0].has_key("message"):
-            return (-1, results[0]["message"])
-        elif len(results) > 1:
-            return (-1, "(getTestCaseIDByName) - Several case test found. Suite name must not be duplicate for the same project")
-        else:
-            if results[0]["name"] == testCaseName:
-                    return (results[0]["id"], None)
-            return (-1, "(getTestCaseIDByName) - Internal server error. Return value is not expected one!")
 
 
     def getTestCasesForTestPlan(self, *args):
@@ -596,19 +578,35 @@ def __str__(self):
 """
         return message % self.__VERSION__
 
-if __name__ == "__main__":    
-    myTestLinkServer = "http://YOURSERVER/testlink/lib/api/xmlrpc.php"  #change
-    myDevKey = "" # Put here your devKey
-    myTestLink = TestlinkAPIClient(myTestLinkServer, myDevKey)
-    print "TestLinkAPIClient - v0.2"      
-    print "@author: Olivier Renault ([email protected])"
-    print ""
-    if myTestLink.checkDevKey() == True:      
-        methodList = [method for method in TestlinkAPIClient.__dict__]
-        for method in methodList:
-            if method[0:2] != "__": 
-                print method
-        print ""
-    else:
-        print "Incorrect DevKey."       
+class TestLink(TestLinkAPIClient):
+    """
+    TestLink API library
+    """
+
+    __VERSION__ = "0.1"
+
+    def __init__(self, server_url, key):
+        """
+        Class initialisation
+        """
+
+        super(testlink, self).__init__(server_url, key)
+
+    def getTestCaseIDByName(self, testCaseName, testSuiteName, testProjectName):
+        """
+        Find a test case by its name, by its suite and its project
+        Suite name must not be duplicate, so only one test case must be found 
+        Return test case id if success 
+        or raise TestLinkErrors exception with error message in case of error
+        """    
+        results = super(testlink, self).getTestCaseIDByName(testCaseName, testSuiteName, testProjectName)
+        if results[0].has_key("message"):
+            raise TestLinkErrors(results[0]["message"])
+        elif len(results) > 1:
+            raise TestLinkErrors("(getTestCaseIDByName) - Several case test found. Suite name must not be duplicate for the same project")
+        else:
+            if results[0]["name"] == testCaseName:
+                    return results[0]["id"]
+            raise TestLinkErrors("(getTestCaseIDByName) - Internal server error. Return value is not expected one!")
+