new api method addTestCaseKeywords #47

Author: Luiko Czub

CHANGES.rst

@@ -3,7 +3,7 @@ Changes in TestLink-API-Python-client Source Distribution
 
 TestLink-API-Python-client v0.6.1 - Under Develop 
 ------------------------------------------------------------
-support for future TL 1.9.13 release
+support for TL 1.9.13 release
 
 Proxy configuration support in TestLinkHelper - pull request #36 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -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
+implement 1.9.13 new api methods #32 #41 #42 #44 #47
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api methods
@@ -30,7 +30,9 @@ new TestlinkAPIGeneric and TestlinkAPIClient api methods
 - getTestCaseKeywords([testcaseid=<testcaseid>], 
   [testcaseexternalid=<testcaseexternalid>])
 
-- deleteTestPlan(<testplanid>)  
+- deleteTestPlan(<testplanid>) 
+
+- addTestCaseKeywords(<testcaseexternalid>, <keywords>)
 
 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 returns keywords from test case TESTCASE_B, if the user has assigned 
-manually some values.
+Script adds keywords KeyWord01 KeyWord02 KeyWord03 to test case TESTCASE_B
+and returns the resulting keyword list
    
 """                                       
 from testlink import TestlinkAPIClient, TestLinkHelper
@@ -139,6 +139,17 @@
 newTestSuiteID_B=response[2]['id']
 newTestSuite = myTestLink.getTestSuiteByID(newTestSuiteID_B)
 print( "getTestSuiteByID", newTestSuite )
+# get informationen - TestCase_B
+response = myTestLink.getTestCaseIDByName(NEWTESTCASE_B, testprojectname=NEWPROJECT)
+print( "getTestCaseIDByName", response )
+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 )
+
 
 # list test cases with assigned keywords
 response = myTestLink.getTestCasesForTestSuite(newTestSuiteID_B, True, 
@@ -148,11 +159,7 @@
                                                'full', getkeywords=True)
 print( "getTestCasesForTestSuite (deep=False)", response )
 
-# get informationen - TestCase_B
-response = myTestLink.getTestCaseIDByName(NEWTESTCASE_B, testprojectname=NEWPROJECT)
-print( "getTestCaseIDByName", response )
-newTestCaseID_B = response[0]['id'] 
-print( "Test Case '%s' - id: %s" % (NEWTESTCASE_B, newTestCaseID_B) )
+# get informationen - TestCase_B again 
 newTestCase_B = myTestLink.getTestCase(testcaseid=newTestCaseID_B)[0]
 print( "getTestCase", newTestCase_B )
 

src/testlink/testlinkapigeneric.py

@@ -1299,6 +1299,26 @@ def callServerWithPosArgs(self, methodNameAPI, *argsPositional, **argsOptional):
         self._checkResponse(response, methodNameAPI, argsOptional) 
         # seams to be ok, so let give them the data
         return response
+    
+#   /**
+#    * addTestCaseKeywords
+#    * @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 addTestCaseKeywords($args)
+
+    @decoApiCallAddDevKey
+    @decoMakerApiCallWithArgs(['testcaseexternalid', 'keywords'], [])
+    def addTestCaseKeywords(self):
+        """ adds a list of keywords to a given Test case  """
+    
 
     #
     #  internal methods for general server calls

src/testlink/version.py

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

test/utest-online/testlinkapi_generic_online_test.py

@@ -396,13 +396,17 @@ def test_getTestCaseKeywords_unknownID(self):
             self.client.getTestCaseKeywords(testcaseid=40000712) 
 
     def test_getTestCaseKeywords_unknownID_external(self):
-        with self.assertRaisesRegex(TLResponseError, '5040.*40000712'):
+        with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
             self.client.getTestCaseKeywords(testcaseexternalid='TC-40000712')
 
     def test_deleteTestPlan_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '3000.*40000711'):
             self.client.deleteTestPlan(40000711) 
 
+    def test_getTestCaseKeywords_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
+            self.client.addTestCaseKeywords('TC-40000712', 
+                                            ['KeyWord01', 'KeyWord03']) 
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

test/utest-online/testlinkapi_online_test.py

@@ -346,12 +346,18 @@ def test_getTestCaseKeywords_unknownID(self):
             self.client.getTestCaseKeywords(testcaseid=40000712) 
 
     def test_getTestCaseKeywords_unknownID_external(self):
-        with self.assertRaisesRegex(TLResponseError, '5040.*40000712'):
+        with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
             self.client.getTestCaseKeywords(testcaseexternalid='TC-40000712')
 
     def test_deleteTestPlan_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '3000.*40000711'):
-            self.client.deleteTestPlan(40000711)              
+            self.client.deleteTestPlan(40000711)
+
+    def test_getTestCaseKeywords_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
+            self.client.addTestCaseKeywords('TC-40000712', 
+                                            ['KeyWord01', 'KeyWord03']) 
+             
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']