new api method deleteTestPlan #44

Author: Luiko Czub

CHANGES.rst

@@ -46,6 +46,14 @@ new TestlinkAPIGeneric and TestlinkAPIClient api method
 
 examples see `<example/TestLinkExample_CF_KW.py>`_  
 
+implement 1.9.13 new api - deleteTestPlan #44 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+new TestlinkAPIGeneric and TestlinkAPIClient api method
+
+- deleteTestPlan(<testplanid>)
+
+examples see `<example/TestLinkExample.py>`_ 
 
 TestLink-API-Python-client release notes v0.6.0 (Dec. 2014) 
 ------------------------------------------------------------

example/TestLinkExample.py

@@ -88,6 +88,7 @@
 NEWPREFIX="NPROAPI%i" % projNr
 NEWTESTPLAN_A="TestPlan_API A"
 NEWTESTPLAN_B="TestPlan_API B"
+NEWTESTPLAN_C="TestPlan_API C - DeleteTest"
 NEWPLATFORM_A='Big Birds %i' % projNr
 NEWPLATFORM_B='Small Birds'
 NEWPLATFORM_C='Ugly Birds'
@@ -99,6 +100,7 @@
 myApiVersion='%s v%s' % (myTestLink.__class__.__name__ , myTestLink.__version__)
 NEWBUILD_A='%s' % myApiVersion
 NEWBUILD_B='%s' % myApiVersion
+NEWBUILD_C='%s - DeleteTest' % myApiVersion
 
 this_file_dirname=os.path.dirname(__file__)
 NEWATTACHMENT_PY= os.path.join(this_file_dirname, 'TestLinkExample.py')
@@ -579,6 +581,47 @@
                                                 newProjectID, MANUAL)
 print("setTestCaseExecutionType", response)
 
+# create TestPlan C with Platform, Build , TestCase, assigned TestCase 
+# and delete it 
+newTestPlan = myTestLink.createTestPlan(NEWTESTPLAN_C, NEWPROJECT,
+            notes='TestPlan for delete test.',
+            active=1, public=1)    
+print("createTestPlan for DeleteTest", newTestPlan)
+newTestPlanID_C = newTestPlan[0]['id'] 
+print("Test Plan '%s' - id: %s" % (NEWTESTPLAN_C,newTestPlanID_C))
+newBuild = myTestLink.createBuild(newTestPlanID_C, NEWBUILD_C, 
+                                  'Build for TestPlan delete test')
+print("createBuild for DeleteTest", newBuild)
+newBuildID_C = newBuild[0]['id'] 
+print("Build '%s' - id: %s" % (NEWBUILD_C, newBuildID_C))
+response = myTestLink.addPlatformToTestPlan(newTestPlanID_C, NEWPLATFORM_C) 
+print("addPlatformToTestPlan", response)
+response = myTestLink.addTestCaseToTestPlan(newProjectID, newTestPlanID_C, 
+                    tc_aa_full_ext_id, tc_version, platformid=newPlatFormID_C)
+print("addTestCaseToTestPlan", response)
+response = myTestLink.assignTestCaseExecutionTask( myTestUserName, 
+                        newTestPlanID_C, tc_aa_full_ext_id, buildid=newBuildID_C,
+                        platformid=newPlatFormID_C)  
+print("assignTestCaseExecutionTask", response)
+newResult = myTestLink.reportTCResult(newTestCaseID_AA, newTestPlanID_C, 
+                                      NEWBUILD_C, 'p', "TP delete test",
+                                      platformname=NEWPLATFORM_C)
+print("reportTCResult", newResult)
+newResultID_B = newResult[0]['id']
+newAttachment = myTestLink.uploadExecutionAttachment(NEWATTACHMENT_PY, newResultID_B, 
+        'Textfile Example', 'Attachment Example for a TC Execution and TP delete test',
+        filename='MyPyTPDeleteTest.py')
+print("uploadExecutionAttachment", newAttachment)
+response = myTestLink.getTotalsForTestPlan(newTestPlanID_C)
+print("getTotalsForTestPlan before delete", response)
+response = myTestLink.deleteTestPlan(newTestPlanID_C)
+print("deleteTestPlan", response)
+try:
+    response = myTestLink.getTotalsForTestPlan(newTestPlanID_C)
+    print("getTotalsForTestPlan after delete", response)
+except TLResponseError as tl_err:
+    print(tl_err.message)
+
 # get information - TestProject
 response = myTestLink.getTestProjectByName(NEWPROJECT)
 print("getTestProjectByName", response)

example/TestLinkExampleGenericApi.py

@@ -77,6 +77,7 @@
 NEWPREFIX="GPROAPI%i" % projNr
 NEWTESTPLAN_A="TestPlan_API_GENERIC A"
 NEWTESTPLAN_B="TestPlan_API_GENERIC B"
+NEWTESTPLAN_C="TestPlan_API_GENERIC C - DeleteTest"
 NEWPLATFORM_A='Big Bird %i' % projNr
 NEWPLATFORM_B='Small Bird'
 NEWPLATFORM_C='Ugly Bird'
@@ -88,6 +89,7 @@
 myApiVersion='%s v%s' % (myTestLink.__class__.__name__ , myTestLink.__version__)
 NEWBUILD_A='%s' % myApiVersion
 NEWBUILD_B='%s' % myApiVersion
+NEWBUILD_C='%s - DeleteTest' % myApiVersion
 
 this_file_dirname=os.path.dirname(__file__)
 NEWATTACHMENT_PY= os.path.join(this_file_dirname, 'TestLinkExampleGenericApi.py')
@@ -499,6 +501,47 @@
                                                 newProjectID, MANUAL)
 print("setTestCaseExecutionType", response)
 
+# create TestPlan C with Platform, Build , TestCase, assigned TestCase 
+# and delete it 
+newTestPlan = myTestLink.createTestPlan(NEWTESTPLAN_C, NEWPROJECT,
+            notes='TestPlan for delete test.',
+            active=1, public=1)    
+print("createTestPlan for DeleteTest", newTestPlan)
+newTestPlanID_C = newTestPlan[0]['id'] 
+print("Test Plan '%s' - id: %s" % (NEWTESTPLAN_C,newTestPlanID_C))
+newBuild = myTestLink.createBuild(newTestPlanID_C, NEWBUILD_C, 
+                                  buildnotes='Build for TestPlan delete test')
+print("createBuild for DeleteTest", newBuild)
+newBuildID_C = newBuild[0]['id'] 
+print("Build '%s' - id: %s" % (NEWBUILD_C, newBuildID_C))
+response = myTestLink.addPlatformToTestPlan(newTestPlanID_C, NEWPLATFORM_C) 
+print("addPlatformToTestPlan", response)
+response = myTestLink.addTestCaseToTestPlan(newProjectID, newTestPlanID_C, 
+                    tc_aa_full_ext_id, tc_version, platformid=newPlatFormID_C)
+print("addTestCaseToTestPlan", response)
+response = myTestLink.assignTestCaseExecutionTask( myTestUserName, 
+                        newTestPlanID_C, tc_aa_full_ext_id, buildid=newBuildID_C,
+                        platformid=newPlatFormID_C)  
+print("assignTestCaseExecutionTask", response)
+newResult = myTestLink.reportTCResult(newTestPlanID_C, 'p', 
+                buildid=newBuildID_C, testcaseid=newTestCaseID_AA, 
+                platformname=NEWPLATFORM_C, notes="TP delete test")
+print("reportTCResult", newResult)
+newResultID_B = newResult[0]['id']
+newAttachment = myTestLink.uploadExecutionAttachment(NEWATTACHMENT_PY, newResultID_B, 
+        title='Textfile Example', filename='MyPyTPDeleteTest.py',
+        description='Attachment Example for a TC Execution and TP delete test')
+print("uploadExecutionAttachment", newAttachment)
+response = myTestLink.getTotalsForTestPlan(newTestPlanID_C)
+print("getTotalsForTestPlan before delete", response)
+response = myTestLink.deleteTestPlan(newTestPlanID_C)
+print("deleteTestPlan", response)
+try:
+    response = myTestLink.getTotalsForTestPlan(newTestPlanID_C)
+    print("getTotalsForTestPlan after delete", response)
+except TLResponseError as tl_err:
+    print(tl_err.message)
+
 # get information - TestProject
 response = myTestLink.getTestProjectByName(NEWPROJECT)
 print("getTestProjectByName", response)

src/testlink/testlinkapigeneric.py

@@ -1227,6 +1227,26 @@ def getTestCaseKeywords(self):
         args variations: testcaseid - testcaseexternalid  (mandatoy!)
          
         returns an empty dictionary, if no keywords are defined """
+        
+#   /**
+#    *  Delete a test plan and all related link to other items
+#    *
+#    * @param struct $args
+#    * @param string $args["devKey"]
+#    * @param int $args["$tplanID"]
+#    *
+#    * @return mixed $resultInfo
+#    *         [status]  => true/false of success
+#    *         [id]      => result id or error code
+#    *         [message]  => optional message for error message string
+#    * @access public
+#    */
+#   public function deleteTestPlan($args)
+        
+    @decoApiCallAddDevKey
+    @decoMakerApiCallWithArgs(['testplanid'])
+    def deleteTestPlan(self):
+        """ Delete a test plan and all related link to other items """
 
     #
     #  public methods for general server calls

src/testlink/version.py

@@ -17,6 +17,6 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.6.1-dev42'
+VERSION = '0.6.1-dev44'
 TL_RELEASE = 'DEV 1.9.13 (gitorious 0be4cb9)'