api change - platform_id as new filter for getTestCasesForTestPlan

Author: Luiko Czub

CHANGES.rst

@@ -15,45 +15,39 @@ 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 - unassignTestCaseExecutionTask #32
+implement 1.9.13 new api methods #32 #41 #42 #44
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-new TestlinkAPIGeneric and TestlinkAPIClient api method
+new TestlinkAPIGeneric and TestlinkAPIClient api methods
 
 - unassignTestCaseExecutionTask(<testplanid>, <testcaseexternalid>, 
   [buildid=<buildid>], [buildname=<buildname>], [platformid=<platformid>], 
   [platformname=<platformname>], [user=<loginname>], 
   [action='unassignAll'|'unassignOne'], [devKey=<devKey>])
   
-examples see `<example/TestLinkExample.py>`_ 
- 
-implement 1.9.13 new api - getProjectKeywords #41
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-new TestlinkAPIGeneric and TestlinkAPIClient api method
-
-- getProjectKeywords(<testprojectid>)
-  
-examples see `<example/TestLinkExample_CF_KW.py>`_  
-
-implement 1.9.13 new api - getTestCaseKeywords #42 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-new TestlinkAPIGeneric and TestlinkAPIClient api method
+- getProjectKeywords(<testprojectid>)  
 
 - getTestCaseKeywords([testcaseid=<testcaseid>], 
   [testcaseexternalid=<testcaseexternalid>])
 
-examples see `<example/TestLinkExample_CF_KW.py>`_  
-
-implement 1.9.13 new api - deleteTestPlan #44 
+- deleteTestPlan(<testplanid>)  
+  
+examples see `<example/TestLinkExample.py>`_ and `<example/TestLinkExample_CF_KW.py>`_
+ 
+implement 1.9.13 api change - getTestCasesForTestPlan #41
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-new TestlinkAPIGeneric and TestlinkAPIClient api method
+TestlinkAPIGeneric and TestlinkAPIClient api method getTestCasesForTestPlan() 
+accepts now the additional optional argument platformid=<platformid>
+
+example:
 
-- deleteTestPlan(<testplanid>)
+ >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
+ >>> tls.getTestCasesForTestPlan(aTPlanID, platformid=aPlatFormID)
+  {'12996': {'949': {'platform_name': 'Small Bird',  ... }}
+  
+Also the optional argument buildid=<buildid> could now be used
 
-examples see `<example/TestLinkExample.py>`_ 
 
 TestLink-API-Python-client release notes v0.6.0 (Dec. 2014) 
 ------------------------------------------------------------

example/TestLinkExample.py

@@ -652,7 +652,10 @@
 #response = myTestLink.getTestCasesForTestPlan(newTestPlanID_A, 'executestatus=f')
 response = myTestLink.getTestCasesForTestPlan(newTestPlanID_A, executestatus='f')
 # -- END CHANGE v0.4.5 -- 
-print("getTestCasesForTestPlan", response)
+print("getTestCasesForTestPlan A failed ", response)
+# get Testcases for Plattform SmallBird
+response = myTestLink.getTestCasesForTestPlan(newTestPlanID_A, platformid=newPlatFormID_B)
+print("getTestCasesForTestPlan A SmallBirds", response)
 
 # get information - TestSuite
 response = myTestLink.getTestSuiteByID(newTestSuiteID_B)

example/TestLinkExampleGenericApi.py

@@ -569,7 +569,10 @@
 print("getTestSuitesForTestPlan", response)
 # get failed Testcases 
 response = myTestLink.getTestCasesForTestPlan(newTestPlanID_A, executestatus='f')
-print("getTestCasesForTestPlan", response)
+print("getTestCasesForTestPlan A failed ", response)
+# get Testcases for Plattform SmallBird
+response = myTestLink.getTestCasesForTestPlan(newTestPlanID_A, platformid=newPlatFormID_B)
+print("getTestCasesForTestPlan A SmallBirds", response)
 
 # get information - TestSuite
 response = myTestLink.getTestSuiteByID(newTestSuiteID_B)

src/testlink/testlinkapigeneric.py

@@ -285,17 +285,49 @@ def reportTCResult(self):
 #         This method is meant primarily for testing and debugging during development
 #         """
 
+#   /**
+#    * getTestCasesForTestPlan
+#    * List test cases linked to a test plan
+#    * 
+#    * @param struct $args
+#    * @param string $args["devKey"]
+#    * @param int $args["testplanid"]
+#    * @param int $args["buildid"] - optional
+#    * @param int $args["platformid"] - optional  
+#    * @param int $args["testcaseid"] - optional
+#    * @param int $args["keywordid"] - optional mutual exclusive with $args["keywords"]
+#    * @param int $args["keywords"] - optional  mutual exclusive with $args["keywordid"]
+#    *
+#    * @param boolean $args["executed"] - optional
+#    * @param int $args["$assignedto"] - optional
+#    * @param string $args["executestatus"] - optional
+#    * @param array $args["executiontype"] - optional
+#    * @param array $args["getstepinfo"] - optional - default false
+#    * @param string $args["details"] - optional 
+#    *                     'full': (default) get summary,steps,expected_results,test suite name
+#    *                     'simple':
+#    *                     'details':
+#    * @return mixed $resultInfo
+#    *
+#    * @internal revisions
+#    * @since 1.9.13
+#    * 20141230 - franciscom - TICKET 6805: platform parameter
+#    */
+#   public function getTestCasesForTestPlan($args)
 
     @decoMakerApiCallReplaceTLResponseError()          
     @decoApiCallAddDevKey               
     @decoMakerApiCallWithArgs(['testplanid'], 
-                ['testcaseid', 'keywordid', 'keywords', 'executed', 'assignedto', 
+                ['buildid', 'platformid', 
+                 'testcaseid', 'keywordid', 'keywords', 'executed', 'assignedto', 
                  'executestatus', 'executiontype', 'getstepinfo', 'details'])
     def getTestCasesForTestPlan(self):
         """ List test cases linked to a test plan
         
         details - default is 'full', 
                   'simple', 'details' ??
+                  
+        args variations:     keywordid - keywords 
         
         returns an empty list, if no build is assigned """
 

src/testlink/version.py

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

test/utest-offline/testlinkapigeneric_offline_test.py

@@ -738,6 +738,11 @@ def test_getProjectKeywords_twoKeywords(self):
         self.assertEqual('KeyWord01', response['25'])
         self.assertEqual('KeyWord02', response['26'])
 
+    def test_whatArgs_getTestCasesForTestPlan(self):
+        argsDescription = self.api.whatArgs('getTestCasesForTestPlan')
+        self.assertIn('buildid=<buildid>', argsDescription)
+        self.assertIn('platformid=<platformid>', argsDescription)
+        self.assertIn('keywordid - keywords', argsDescription)
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']