new api method deleteExecution #14

Author: Luiko Czub

CHANGES.rst

@@ -20,6 +20,7 @@ implement missing 1.9.8 api method - miscellaneous #14
 new TestlinkAPIGeneric and TestlinkAPIClient api methods
 
 - getUserByLogin(), getUserByID()
+- deleteExecution()
 
 TestLink-API-Python-client release notes v0.4.7 (Jan. 2014)
 -----------------------------------------------------------

example/TestLinkExample.py

@@ -466,6 +466,25 @@
 print "reportTCResult", newResult
 newResultID_B_b = newResult[0]['id']
 
+# now we make a mistake and commit the same result a second time
+# and try to delete this mistake 
+newResult = myTestLink.reportTCResult(newTestCaseID_B, newTestPlanID_B, NEWBUILD_B,
+                                      'b', "mistake, commit same result a second time")
+print "reportTCResult", newResult
+newResultID_B_b2 = int(newResult[0]['id'])
+try:
+    # if TL configuration allows deletion of executions, no error will occur
+    response = myTestLink.deleteExecution(newResultID_B_b2)
+    print "deleteExecution", response
+except TLResponseError as tl_err:
+    if tl_err.code == 232:
+        # TL configuration does not allow deletion of executions
+        pass
+    else:
+        # sh..: another problem occurs
+        raise
+
+
 # get information - TestProject
 response = myTestLink.getTestProjectByName(NEWPROJECT)
 print "getTestProjectByName", response

example/TestLinkExampleGenericApi.py

@@ -392,6 +392,24 @@
 print "reportTCResult", newResult
 newResultID_B_b = newResult[0]['id']
 
+# now we make a mistake and commit the same result a second time
+# and try to delete this mistake 
+newResult = myTestLink.reportTCResult(newTestPlanID_B, 'b', 
+                buildid=newBuildID_B, testcaseid=newTestCaseID_B, 
+                notes="mistake, commit same result a second time")
+print "reportTCResult", newResult
+newResultID_B_b2 = int(newResult[0]['id'])
+try:
+    # if TL configuration allows deletion of executions, no error will occur
+    response = myTestLink.deleteExecution(newResultID_B_b2)
+    print "deleteExecution", response
+except TLResponseError as tl_err:
+    if tl_err.code == 232:
+        # TL configuration does not allow deletion of executions
+        pass
+    else:
+        # sh..: another problem occurs
+        raise
 
 # get information - TestProject
 response = myTestLink.getTestProjectByName(NEWPROJECT)

src/testlink/testlinkapigeneric.py

@@ -385,6 +385,15 @@ def getFullPath(self):
 #    */  
 #    public function deleteExecution($args)
 
+    @decoApiCallAddDevKey               
+    @decoMakerApiCallWithArgs(['executionid'])
+    def deleteExecution(self):
+        """ delete an execution 
+        
+        Default TL server configuration does not allow deletion of exections
+        see Installation & Configuration Manual Version 1.9
+            chap. 5.8. Test execution settings 
+            $tlCfg->exec_cfg->can_delete_execution """
 
     @decoApiCallAddDevKey               
     @decoMakerApiCallWithArgs(['testsuiteid'])

test/utest-online/testlinkapi_online_test.py

@@ -266,6 +266,18 @@ def test_getUserByLogin_unknownKey(self):
 #         response = self.client.setTestMode(False)
 #         self.assertTrue(response)
 
+    def test_deleteExecution_unknownKey(self):
+        try:
+            response = self.client.deleteExecution(4711)
+            # case: TL configuration allows deletion of executions
+            # response returns Success, even if executionID is unkown
+            self.assertEqual([{'status': True, 'message': 'Success!', 'id': 4711, 
+                               'operation': 'deleteExecution'}], response)
+        except TLResponseError as tl_err:
+            # case: TL configuration does not allow deletion of executions
+            # Expects: 232: Configuration does not allow delete executions
+            self.assertEqual(232, tl_err.code)
+            
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

test/utest-online/testlinkapigeneric_online_test.py

@@ -282,6 +282,18 @@ def test_getUserByID_unknownKey(self):
 #         self.assertTrue(response)
 #         response = self.client.setTestMode(False)
 #         self.assertTrue(response)
+
+    def test_deleteExecution_unknownKey(self):
+        try:
+            response = self.client.deleteExecution(4711)
+            # case: TL configuration allows deletion of executions
+            # response returns Success, even if executionID is unkown
+            self.assertEqual([{'status': True, 'message': 'Success!', 'id': 4711, 
+                               'operation': 'deleteExecution'}], response)
+        except TLResponseError as tl_err:
+            # case: TL configuration does not allow deletion of executions
+            # Expects: 232: Configuration does not allow delete executions
+            self.assertEqual(232, tl_err.code)
 
 
 if __name__ == "__main__":