new api method removeTestCaseKeywords #46

Author: Luiko Czub

CHANGES.rst

@@ -15,7 +15,7 @@ pull request `#36 <https://github.com/lczub/TestLink-API-Python-client/pull/36>`
 - Adds a new --proxy option in command line.
 - Recognizes "http_proxy" environment variable.
 
-implement 1.9.13 new api methods #32 #41 #42 #44 #47
+implement 1.9.13 new api methods #32 #41 #42 #44 #47 #46
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api methods
@@ -33,6 +33,13 @@ new TestlinkAPIGeneric and TestlinkAPIClient api methods
 - deleteTestPlan(<testplanid>) 
 
 - addTestCaseKeywords(<testcaseexternalid>, <keywords>)
+  - Attention: with TL 1.9.14, this api method will change the interface (args)
+    see `TL Mantis Task 6934 <http://mantis.testlink.org/view.php?id=6934>`_ 
+    
+- removeTestCaseKeywords(<testcaseexternalid>, <keywords>)
+  - Attention: with TL 1.9.14, this api method will change the interface (args)
+    see `TL Mantis Task 6907 <http://mantis.testlink.org/view.php?id=6907>`_ 
+
 
 examples see `<example/TestLinkExample.py>`_ and `<example/TestLinkExample_CF_KW.py>`_
 

example/TestLinkExample_CF_KW.py

@@ -54,8 +54,8 @@
 - testplan - testcase link
 could be requested via api, these example does not work currently. 
 
-Script adds keywords KeyWord01 KeyWord02 KeyWord03 to test case TESTCASE_B
-and returns the resulting keyword list
+Script adds keywords KeyWord01 KeyWord02 KeyWord03 to test case TESTCASE_B,
+removes keyword KeyWord02 again and returns the resulting keyword list.
    
 """                                       
 from testlink import TestlinkAPIClient, TestLinkHelper
@@ -145,10 +145,14 @@
 newTestCaseID_B = response[0]['id'] 
 tc_b_full_ext_id = myTestLink.getTestCase(newTestCaseID_B)[0]['full_tc_external_id']
 print( "Test Case '%s' - id: %s - ext-id %s" % (NEWTESTCASE_B, newTestCaseID_B, tc_b_full_ext_id) )
+
 # add keywords to TestCase B
 response = myTestLink.addTestCaseKeywords(tc_b_full_ext_id,
                                         ['KeyWord01', 'KeyWord03', 'KeyWord02'])
 print( "addTestCaseKeywords", response )
+# remove keywords from TestCase B
+response = myTestLink.removeTestCaseKeywords(tc_b_full_ext_id, ['KeyWord02'])
+print( "removeTestCaseKeywords", response )
 
 
 # list test cases with assigned keywords

src/testlink/testlinkapigeneric.py

@@ -1319,7 +1319,26 @@ def callServerWithPosArgs(self, methodNameAPI, *argsPositional, **argsOptional):
     def addTestCaseKeywords(self):
         """ adds a list of keywords to a given Test case  """
 
+#   /**
+#    * removeTestCaseKeywords
+#    * @param struct $args
+#    * @param string $args["devKey"]
+#    * @param string $args["testcaseexternalid"]
+#    * @param array $args["keywords"]: keywords
+#    * 
+#    * @return mixed $resultInfo
+#    *
+#    * @internal revisions
+#    * @since 1.9.13
+#    */
+#   function removeTestCaseKeywords($args)
+
+    @decoApiCallAddDevKey
+    @decoMakerApiCallWithArgs(['testcaseexternalid', 'keywords'], [])
+    def removeTestCaseKeywords(self):
+        """ removes a list of keywords from a given Test case  """
 
+  
     #
     #  internal methods for general server calls
     #                                   

src/testlink/version.py

@@ -17,6 +17,6 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.6.1-dev47'
+VERSION = '0.6.1-dev46'
 TL_RELEASE = '1.9.13'
 

test/utest-online/testlinkapi_generic_online_test.py

@@ -403,10 +403,25 @@ def test_deleteTestPlan_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '3000.*40000711'):
             self.client.deleteTestPlan(40000711) 
 
-    def test_getTestCaseKeywords_unknownID(self):
+    # test might fail during Travis test, cause used TestLink demo application
+    # represents  still a 1.9.13 dev state from 26/12/14
+    # the keyword add method are added later and will be changed with 1.9.14
+    # the interface (see TL Mantis Task 6934)        
+    @unittest.expectedFailure
+    def test_addTestCaseKeywords_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
             self.client.addTestCaseKeywords('TC-40000712', 
                                             ['KeyWord01', 'KeyWord03']) 
+
+    # test might fail during Travis test, cause used TestLink demo application
+    # represents  still a 1.9.13 dev state from 26/12/14
+    # the keyword remove method are added later and will be changed with 1.9.14
+    # the interface (see TL Mantis Task 6907)      
+    @unittest.expectedFailure
+    def test_removeTestCaseKeywords_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
+            self.client.removeTestCaseKeywords('TC-40000712', 
+                                            ['KeyWord01']) 
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

test/utest-online/testlinkapi_online_test.py

@@ -353,10 +353,25 @@ def test_deleteTestPlan_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '3000.*40000711'):
             self.client.deleteTestPlan(40000711)
 
-    def test_getTestCaseKeywords_unknownID(self):
+    # test might fail during Travis test, cause used TestLink demo application
+    # represents  still a 1.9.13 dev state from 26/12/14
+    # the keyword add method are added later and will be changed with 1.9.14
+    # the interface (see TL Mantis Task 6934)        
+    @unittest.expectedFailure
+    def test_addTestCaseKeywords_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
             self.client.addTestCaseKeywords('TC-40000712', 
                                             ['KeyWord01', 'KeyWord03']) 
+
+    # test might fail during Travis test, cause used TestLink demo application
+    # represents  still a 1.9.13 dev state from 26/12/14
+    # the keyword remove method are added later and will be changed with 1.9.14
+    # the interface (see TL Mantis Task 6907)      
+    @unittest.expectedFailure
+    def test_removeTestCaseKeywords_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
+            self.client.removeTestCaseKeywords('TC-40000712', 
+                                            ['KeyWord01']) 
 
 
 if __name__ == "__main__":