changed api - addTestCaseToTestPlan - paramter overwrite #72

Author: Luiko Czub

CHANGES.rst

@@ -15,18 +15,22 @@ new TestlinkAPIGeneric and TestlinkAPIClient api methods
   [details=<details>], [order=<order>], [devKey=<devKey>])
 - getTestSuite(<testsuitename>, <prefix>, [devKey=<devKey>])
 
-implement 1.9.15 changed api interfaces - #68 #70
+implement 1.9.15 changed api interfaces - #68 #70 #72
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 changed TestlinkAPIGeneric and TestlinkAPIClient api methods
 
 - reportTCResult() is adapted to support the new optional argument <steps>
   for setting test step results
 - createBuild() is adapted to support new optional arguments
+
   - <active> : 1 (default) = activ  0 = inactiv 
   - <open>   : 1 (default) = open   1 = closed
   - <releasedate> : YYYY-MM-DD
   - <copytestersfrombuild> : valid buildid tester assignments will be copied.
+  
+- addTestCaseToTestPlan() is adapted to to support the new optional argument 
+  <overwrite> to update linked Test Case Versions
 
 examples:
 
@@ -40,6 +44,9 @@ examples:
  >>> tls.createBuild(aTPlanID, 'newBuildName',  'a build note', 
  >>>                 active=1, open=1, releasedate='2016-11-30'
  >>>                 copytestersfrombuild=existingBuildID)
+ >>> tls.addTestCaseToTestPlan(aTProjectID, aTPlanID, 'aTCaseFullExID',
+ >>>                           aTCVersion, overwrite=1)
+ 
 
 known TL 1.9.15 issues:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

example/TestLinkExample.py

@@ -674,11 +674,13 @@
 response = myTestLink.getTestCaseAttachments(testcaseid=newTestCaseID_B)
 print("getTestCaseAttachments", response)
 
-# copy test cases
+# copy test case - as a new TC version
 print("create new version of TC B")
 response = myTestLink.copyTCnewVersion(newTestCaseID_B, 
                 summary='new version of TC B', importance='1')
 print('copyTCnewVersion', response)
+
+# copy test case - as new TC in a different TestSuite
 print("copy TC B as TC BA into Test suite A")
 response = myTestLink.copyTCnewTestCase(newTestCaseID_B, 
                 testsuiteid=newTestSuiteID_A, testcasename='%sA' % NEWTESTCASE_B)
@@ -688,6 +690,16 @@
 response = myTestLink.getTestCasesForTestSuite(newTestSuiteID_A, True, 'simple')
 print('getTestCasesForTestSuite A', response)
 
+# sample, how the test plan can be updated to use the new tc version
+# site effect of this step, assigned testers and existing execution results are 
+# not accessible anymore via the TL Web Gui. 
+# That is the reason, why we have uncomment it for the normal sample execution
+# response = myTestLink.addTestCaseToTestPlan(newProjectID, newTestPlanID_B, 
+#                                             tc_b_full_ext_id, tc_version+1,
+#                                             overwrite=1)
+# print("addTestCaseToTestPlan overwrite", response)
+
+
 # no test data
 # response = myTestLink.getTestCaseCustomFieldDesignValue(
 #             tc_aa_full_ext_id, 1, newProjectID, 'cfieldname', 'simple')

src/testlink/testlinkapigeneric.py

@@ -175,7 +175,7 @@ def createBuild(self):
         """ Creates a new build for a specific test plan 
         
         active      : 1 (default) = activ  0 = inactiv 
-        open        : 1 (default) = open   1 = closed
+        open        : 1 (default) = open   0 = closed
         releasedate : YYYY-MM-DD
         copytestersfrombuild : valid buildid tester assignments will be copied.
           """
@@ -465,14 +465,15 @@ def getTestCaseCustomFieldDesignValue(self):
 #     * @param args['platformid'] - OPTIONAL Only if  test plan has no platforms
 #     * @param args['executionorder'] - OPTIONAL
 #     * @param args['urgency'] - OPTIONAL
+#     * @param args['overwrite'] - OPTIONAL
 #     *
 #     */
 #   public function addTestCaseToTestPlan($args)
 
     @decoApiCallAddDevKey               
     @decoMakerApiCallWithArgs(['testprojectid',
                                'testplanid', 'testcaseexternalid', 'version'],
-                              ['platformid', 'executionorder', 'urgency'])
+                    ['platformid', 'executionorder', 'urgency', 'overwrite'])
     def addTestCaseToTestPlan(self):
         """ Add a test case version to a test plan """
 

src/testlink/version.py

@@ -17,6 +17,6 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.6.3-dev070'
+VERSION = '0.6.3-dev072'
 TL_RELEASE = '1.9.15'
 

test/utest-offline/testlinkapi_offline_test.py

@@ -693,6 +693,17 @@ def test_whatArgs_createBuild(self):
         self.assertIn('releasedate=<releasedate>', argsDescription)
         self.assertIn('copytestersfrombuild=<copytestersfrombuild>', argsDescription)
 
+    def test_whatArgs_addTestCaseToTestPlan(self):
+        argsDescription = self.api.whatArgs('addTestCaseToTestPlan')
+        self.assertIn('<testprojectid>,', argsDescription)
+        self.assertIn('<testplanid>,', argsDescription)
+        self.assertIn('<testcaseexternalid>,', argsDescription)
+        self.assertIn('<version>,', argsDescription)
+        self.assertIn('platformid=<platformid>', argsDescription)
+        self.assertIn('executionorder=<executionorder>', argsDescription)
+        self.assertIn('urgency=<urgency>', argsDescription)
+        self.assertIn('overwrite=<overwrite>', argsDescription)
+
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']
     unittest.main()

test/utest-offline/testlinkapigeneric_offline_test.py

@@ -801,6 +801,17 @@ def test_whatArgs_createBuild(self):
         self.assertIn('open=<open>', argsDescription)
         self.assertIn('releasedate=<releasedate>', argsDescription)
         self.assertIn('copytestersfrombuild=<copytestersfrombuild>', argsDescription)
+
+    def test_whatArgs_addTestCaseToTestPlan(self):
+        argsDescription = self.api.whatArgs('addTestCaseToTestPlan')
+        self.assertIn('<testprojectid>,', argsDescription)
+        self.assertIn('<testplanid>,', argsDescription)
+        self.assertIn('<testcaseexternalid>,', argsDescription)
+        self.assertIn('<version>,', argsDescription)
+        self.assertIn('platformid=<platformid>', argsDescription)
+        self.assertIn('executionorder=<executionorder>', argsDescription)
+        self.assertIn('urgency=<urgency>', argsDescription)
+        self.assertIn('overwrite=<overwrite>', argsDescription)
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']