prepare library

Author: Patrick Dassier

test.py

@@ -0,0 +1,44 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+'''
+ Source file
+ File name: test.py
+ Creation date: 04-10-2012
+ Author: dassier
+
+'''
+
+'''
+Fichier de test pour le module "TestLinkAPI.py"
+'''
+
+import re
+import TestLinkAPI
+from nose.tools import *
+
+class TestClass():
+    def setUp(self):
+        """Initialisation
+        """
+
+        SERVEUR_URL = "http://localhost/testlink/lib/api/xmlrpc.php"
+        KEY = "7ec252ab966ce88fd92c25d08635672b"
+        self.client = TestLinkAPI.TestLinkAPIClient(server_url=SERVEUR_URL, devKey=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) 
+
+

TestLinkAPI.py renamed to testlink.py

@@ -6,13 +6,15 @@
 @author: kereval.com
 Initialy based on the James Stock testlink-api-python-client R7.
 
-Updated by Kereval to support testCase Reporting and File attachment to test execution
-
+Update by pade to provide a user friendly library, with more robustness and error management
 """
 import xmlrpclib
+import sys
+
+class TestLinkAPIClient:        
+ 
+    __VERSION__ = "0.3"
 
-class TestlinkAPIClient:        
-  
     def __init__(self, server_url, devKey):
         self.server = xmlrpclib.Server(server_url)
         self.devKey = devKey
@@ -139,14 +141,52 @@ def getTestCaseCustomFieldDesignValue(self, testcaseexternalid, version,
                 'details' : str(details)}
         return self.server.tl.getTestCaseCustomFieldDesignValue(argsAPI)                                                
 
-    def getTestCaseIDByName(self, testCaseName):
-        """ getTestCaseIDByName :
-        Find a test case by its name   
-        """    
+    def __getTestCaseIDByName(self, testCaseName, testSuiteName=None, testProjectName=None):
+        """ __getTestCaseIDByName :
+        Internal function
+        Find a test case by its name
+        testSuiteName and testProjectName are optionals arguments
+        This function return a list of tests cases
+        """
         argsAPI = {'devKey' : self.devKey,
                 'testcasename':str(testCaseName)}
-        return self.server.tl.getTestCaseIDByName(argsAPI)
+
+        if testSuiteName is not None:
+            argsAPI.update({'testsuitename':str(testSuiteName)})
+    
+        if testProjectName is not None:
+            argsAPI.update({'testprojectname':str(testProjectName)})
+
+        # Server return can be a list or a dictionnary !
+        # This function always return a list
+        ret_srv = self.server.tl.getTestCaseIDByName(argsAPI)
+        if type(ret_srv) == dict:
+            retval = []
+            for value in ret_srv.values():
+                retval.append(value)
+            return retval
+        else:
+            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):
         """ getTestCasesForTestPlan :
         List test cases linked to a test plan    
@@ -329,12 +369,12 @@ def createTestCase(self, *args):
         self.stepsList = []                    
         return ret 
 
-    def reportTCResult(self, testcaseid, testplanid, buildid, status, notes ):
+    def __reportTCResult(self, testcaseid, testplanid, buildname, status, notes ):
     	"""
         Report execution result
         testcaseid: internal testlink id of the test case
         testplanid: testplan associated with the test case
-        buildid: build version of the test case
+        buildname: build name of the test case
         status: test verdict ('p': pass,'f': fail,'b': blocked)
 
         Return : [{'status': True, 'operation': 'reportTCResult', 'message': 'Success!', 'overwrite': False, 'id': '37'}]
@@ -343,11 +383,31 @@ def reportTCResult(self, testcaseid, testplanid, buildid, status, notes ):
         argsAPI = {'devKey' : self.devKey,
                 'testcaseid' : testcaseid,
                 'testplanid' : testplanid,
-                'buildid':buildid,
+                'buildname':buildname,
                 'status': status,
                 'notes' : notes
                 }
         return self.server.tl.reportTCResult(argsAPI)
+
+    def reportResult(self, testCaseName, testSuiteName, testProjectName):
+        pass
+
+    def setReportCtx(self, testProjectName, testPlanName, buildName):
+        """
+        Set project name test plan name and build name for reportResult function
+        """
+        project = getTestProjectByName(testProjectName)
+        if project[0].has_key("message"):
+            sys.exit(project[0]["message"])
+
+        # Check if project is active
+        if project[0]['active'] != '1':
+            sys.exit("(getTestProjectByName) - Test project (name:%s) is not active" % testProjectName)
+
+        # Store project id
+        self.projectId = project[0]['id']
+        #TODO: à finir
+
 
     def uploadExecutionAttachment(self,attachmentfile,executionid,title,description):
         """
@@ -486,35 +546,45 @@ def initStep(self, actions, expected_results, execution_type):
         Initializes the list which stores the Steps of a Test Case to create  
         """
         self.stepsList = []
-        list = {}
-        list['step_number'] = '1'
-        list['actions'] = actions
-        list['expected_results'] = expected_results
-        list['execution_type'] = str(execution_type)
-        self.stepsList.append(list)
+        lst = {}
+        lst['step_number'] = '1'
+        lst['actions'] = actions
+        lst['expected_results'] = expected_results
+        lst['execution_type'] = str(execution_type)
+        self.stepsList.append(lst)
         return True
 
     def appendStep(self, actions, expected_results, execution_type):
         """ appendStep :
         Appends a step to the steps list  
         """
-        list = {}
-        list['step_number'] = str(len(self.stepsList)+1)
-        list['actions'] = actions
-        list['expected_results'] = expected_results
-        list['execution_type'] = str(execution_type)
-        self.stepsList.append(list)
+        lst = {}
+        lst['step_number'] = str(len(self.stepsList)+1)
+        lst['actions'] = actions
+        lst['expected_results'] = expected_results
+        lst['execution_type'] = str(execution_type)
+        self.stepsList.append(lst)
         return True                
 
     def getProjectIDByName(self, projectName):   
-	  	  projects=self.server.tl.getProjects({'devKey' : self.devKey})
-	  	  for project in projects:
-		  	    if (project['name'] == projectName): 
-		    	  	  result = project['id']
-		  	    else:
-		    	  	  result = -1
-	  	  return result
-	  	  
+        projects=self.server.tl.getProjects({'devKey' : self.devKey})
+	for project in projects:
+	    if (project['name'] == projectName): 
+                result = project['id']
+            else:
+                result = -1
+        return result
+
+    def __str__(self):
+        message = """
+TestLinkAPIClient - version %s
+@author: Olivier Renault ([email protected])
+@author: kereval.com
+@author: Patrick Dassier
+
+"""
+        return message % self.__VERSION__
+
 if __name__ == "__main__":    
     myTestLinkServer = "http://YOURSERVER/testlink/lib/api/xmlrpc.php"  #change
     myDevKey = "" # Put here your devKey
@@ -530,3 +600,4 @@ def getProjectIDByName(self, projectName):
         print ""
     else:
         print "Incorrect DevKey."       
+