new api method getTestCaseKeywords() #42

Author: Luiko Czub

CHANGES.rst

@@ -36,6 +36,17 @@ new TestlinkAPIGeneric and TestlinkAPIClient api method
 
 examples see `<example/TestLinkExample_CF_KW.py>`_  
 
+implement 1.9.13 new api - getTestCaseKeywords #42 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+new TestlinkAPIGeneric and TestlinkAPIClient api method
+
+- getTestCaseKeywords([testcaseid=<testcaseid>], 
+  [testcaseexternalid=<testcaseexternalid>])
+  
+examples see `<example/TestLinkExample_CF_KW.py>`_  
+
+
 TestLink-API-Python-client release notes v0.6.0 (Dec. 2014) 
 ------------------------------------------------------------
 

example/TestLinkExample.py

@@ -647,7 +647,8 @@
 print("getExecCountersByBuild", response)
 response = myTestLink.getExecCountersByBuild(newTestPlanID_B)
 print("getExecCountersByBuild", response)
-
+response = myTestLink.getTestCaseKeywords(testcaseexternalid=tc_b_full_ext_id)
+print("getTestCaseKeywords noKeyWords", response)
 
 # get information - general 
 response = myTestLink.getFullPath(int(newTestSuiteID_AA))

example/TestLinkExampleGenericApi.py

@@ -565,7 +565,8 @@
 print("getExecCountersByBuild", response)
 response = myTestLink.getExecCountersByBuild(newTestPlanID_B)
 print("getExecCountersByBuild", response)
-
+response = myTestLink.getTestCaseKeywords(testcaseexternalid=tc_b_full_ext_id)
+print("getTestCaseKeywords noKeyWords", response)
 
 # get information - general 
 response = myTestLink.getFullPath(int(newTestSuiteID_AA))

example/TestLinkExample_CF_KW.py

@@ -162,6 +162,8 @@
 # return keyword lists for all test cases of test newTestSuite_B
 response =  myTestLink.listKeywordsForTS(newTestSuiteID_B)
 print( "listKeywordsForTS", response )
+response = myTestLink.getTestCaseKeywords(testcaseid=newTestCaseID_B)
+print("getTestCaseKeywords", response)
 
 # new execution result with custom field data
 # TC_B passed, explicit build and some notes , TC identified with internal id

src/testlink/testlinkapi.py

@@ -311,6 +311,11 @@ def listKeywordsForTC(self, internal_or_external_tc_id):
           links keywords against a test case and not a test case version 
         """
 
+        #ToDo LC 12.01.15 - simplify code with TL 1.9.13 api getTestCaseKeywords
+        # - indirect search via test suite and getTestCasesForTestSuite() isn't 
+        #   necessary any more
+        # - see enhancement issue #45
+        
         a_tc_id = str(internal_or_external_tc_id)
         argsPositional = [a_tc_id]
         argsOptional   = {}

src/testlink/testlinkapigeneric.py

@@ -1207,6 +1207,27 @@ def getProjectKeywords(self):
         returns an empty dictionary, if no keywords are defined """
 
 
+# #   /**
+# #    * Gets list of keywords for a given Test case
+# #    *
+# #    * @param $testcaseid
+# #    *
+# #    * @return map indexed by bug_id
+# #    *
+# #    * @access public
+# #    */
+# #   public function getTestCaseKeywords($args)
+# 
+    @decoMakerApiCallReplaceTLResponseError(replaceValue={})            
+    @decoApiCallAddDevKey
+    @decoMakerApiCallWithArgs([], ['testcaseid', 'testcaseexternalid'])
+    def getTestCaseKeywords(self):
+        """ Gets a dictionary of keywords for a given Test case 
+        
+        args variations: testcaseid - testcaseexternalid  (mandatoy!)
+         
+        returns an empty dictionary, if no keywords are defined """
+ 
     #
     #  public methods for general server calls
     #                                   

src/testlink/version.py

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

test/utest-offline/testlinkapigeneric_offline_test.py

@@ -83,7 +83,11 @@
               'getProjectKeywords' : {
                    'twoKeywords' : {'25': 'KeyWord01', '26': 'KeyWord02'},
                    'noKeyword'   : {}   
-                    }
+                    },              
+              'getTestCaseKeywords' : {
+                   'twoKeywords' : {'25': 'KeyWord01', '26': 'KeyWord02'},
+                   'noKeyword'   : {}
+                   }   
               }
 
 # scenario_tl198 used by test with older responses, changed in TL 1.9.9
@@ -241,6 +245,8 @@ def _callServer(self, methodAPI, argsAPI=None):
                 response = data[argsAPI['testsuiteid']]
             elif methodAPI in ['getTestCaseIDByName']:
                 response = data[argsAPI['testcasename']]
+            elif methodAPI in ['getTestCaseKeywords']:
+                response = data[argsAPI['testcaseid']]
             elif methodAPI in ['testLinkVersion']:
                 response = data
                 if data == 'unknown':
@@ -720,6 +726,18 @@ def test_getProjectKeywords_twoKeywords(self):
         self.assertEqual('KeyWord01', response['25'])
         self.assertEqual('KeyWord02', response['26'])
 
+    def test_getTestCaseKeywords_noKeywords(self):
+        self.api.loadScenario(SCENARIO_A)
+        response = self.api.getTestCaseKeywords(testcaseid='noKeyword')
+        self.assertEqual({}, response)
+        self.assertEqual(self.api.devKey, self.api.callArgs['devKey'])
+        
+    def test_getProjectKeywords_twoKeywords(self):
+        self.api.loadScenario(SCENARIO_A)
+        response = self.api.getTestCaseKeywords(testcaseid='twoKeywords')
+        self.assertEqual('KeyWord01', response['25'])
+        self.assertEqual('KeyWord02', response['26'])
+               
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

test/utest-online/testlinkapi_generic_online_test.py

@@ -390,6 +390,15 @@ def test_unassignTestCaseExecutionTask_unknownID(self):
     def test_getProjectKeywords_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '7000.*4711'):
             self.client.getProjectKeywords(4711) 
+
+    def test_getTestCaseKeywords_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '5000.*4712'):
+            self.client.getTestCaseKeywords(testcaseid=4712) 
+
+    def test_getTestCaseKeywords_unknownID_external(self):
+        with self.assertRaisesRegex(TLResponseError, '5040.*4712'):
+            self.client.getTestCaseKeywords(testcaseexternalid='TC-4712')
+            
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

test/utest-online/testlinkapi_online_test.py

@@ -339,7 +339,17 @@ def test_unassignTestCaseExecutionTask_unknownID(self):
 
     def test_getProjectKeywords_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '7000.*4711'):
-            self.client.getProjectKeywords(4711) 
+            self.client.getProjectKeywords(4711)
+            
+    def test_getTestCaseKeywords_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '5000.*4712'):
+            self.client.getTestCaseKeywords(testcaseid=4712) 
+
+    def test_getTestCaseKeywords_unknownID_external(self):
+        with self.assertRaisesRegex(TLResponseError, '5040.*4712'):
+            self.client.getTestCaseKeywords(testcaseexternalid='TC-4712')
+            
+             
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']