changed api getTestCasesForTestPlan - optional arg customfields (TL 1.9.20) #122

Author: Luiko Czub

CHANGES.rst

@@ -3,17 +3,34 @@ Changes in TestLink-API-Python-client Source Distribution
 
 TestLink-API-Python-client v0.8.1 - Under Develop 
 ------------------------------------------------------------
-support for TL 1.9.19 and TL 1.9.20 (dev) api changes related to test case 
-attachments, which will be stored since TL 1.9.19 with a reference to the 
-test case version instead the test case id .
+main topic is to support TL 1.9.19 and TL 1.9.20 (dev) api changes related to 
+test case attachments, which are stored since TL 1.9.19 with a reference to
+the test case version instead the test case id .
 
 Parameter <version> is now mandatory for _uploadTestCaseAttachment_ and optional
  for _getTestCaseAttachments_. 
 
- Cause of the known TL 1.9.19 issue 
- `TL Mantis Ticket 8658 <http://mantis.testlink.org/view.php?id=8658>`_ it is 
- recommended to use the TL 1.9.20 development state with github commit 
- 6a4984164 or later. 
+implement other 1.9.20 (dev) changed api interfaces - #122
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+changed TestlinkAPIGeneric and TestlinkAPIClient api methods
+
+- getTestCasesForTestPlan() is adapted to support the new optional argument <customfields> . 
+  Sample see `<example/TestLinkExample_CF_KW.py>`_ 
+
+known TL 1.9.19 issue:
+~~~~~~~~~~~~~~~~~~~~~~~ 
+API-XMLRPC - getTestCaseAttachments returns no attachment, uploaded with uploadTestCaseAttachment
+
+- see TL Mantis Ticket 8658 <http://mantis.testlink.org/view.php?id=8658>`_
+- recommended to use the TL 1.9.20 development state with github commit 
+ 6a4984164 or later (even for the TL upgrade or installation). 
+ 
+known TL 1.9.20 development state issues (github commit a1c7aca97):
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Calling getTestCasesForTestPlan() with the new optional argument <customfields> returns only internal db values.
+As alternative, loop over all returned test cases and call getTestCaseCustomFieldDesignValue(). 
+Sample see `<example/TestLinkExample_CF_KW.py>`_
 
 TestLink-API-Python-client v0.8.0 (May. 2018)
 ---------------------------------------------

README.rst

@@ -120,4 +120,4 @@ TestLink-API-Python-client developers
 .. _Maberi: https://github.com/Maberi/TestLink-API-Python-client.git
 .. _Brian-Williams: https://github.com/Brian-Williams/TestLink-API-Python-client
 .. _alexei-drozdov: https://github.com/alexei-drozdov/TestLink-API-Python-client
-.. _janLo :https://github.com/janLo/TestLink-API-Python-client.git
+.. _janLo: https://github.com/janLo/TestLink-API-Python-client.git

example/TestLinkExample_CF_KW.py

@@ -25,17 +25,17 @@
 assigned
 
 a) run example TestLinkExample.py
-   - this creates a project like NEW_PROJECT_API-34
+   - this creates a project like NEW_PROJECT_API-37
 b) load custom field definitions customFields_ExampleDefs.xml
    TL - Desktop - System - Define Custom Fields - Import
-c) assign custom fields to project NEW_PROJECT_API-34
+c) assign custom fields to project NEW_PROJECT_API-37
    TL - Desktop - Test Project - Assign Custom Fields
 d) load keyword definitions keywords_ExampleDefs.xml
    TL - Desktop - Test Project - Keyword Management
    
 Script works with:
 
-TestProject NEW_PROJECT_API-34
+TestProject NEW_PROJECT_API-37
 - TestSuite B - First Level
   - TestCase TESTCASE_B
 - TestPlan TestPlan_API A (Platform Small Bird)
@@ -282,6 +282,14 @@
                 args['testplanid'], args['linkid'])
 print( "getTestCaseCustomFieldTestPlanDesignValue", response )
 
+# get CustomFields Values from all test cases of a TestPlan
+response = myTestLink.getTestCasesForTestPlan(args['testplanid'], 
+                                              customfields=True)
+print("getTestCasesForTestPlan with all customfields", response)
+response = myTestLink.getTestCasesForTestPlan(args['testplanid'], 
+                                              customfields=['cf_tc_sd_string'])
+print("getTestCasesForTestPlan with specific customfields", response)
+
 # update CustomField Value - TestSuite SpecDesign
 response = myTestLink.updateTestSuiteCustomFieldDesignValue( 
                  args['testprojectid'], args['testsuiteid'],

src/testlink/testlinkapigeneric.py

@@ -490,6 +490,8 @@ def reportTCResult(self):
 #    *                     'full': (default) get summary,steps,expected_results,test suite name
 #    *                     'simple':
 #    *                     'details':
+#    * @param array $args["customfields"]
+#    *             - optional can be a boolean or an array with the requested fields
 #    * @return mixed $resultInfo
 #    *
 #    * @internal revisions
@@ -503,7 +505,8 @@ def reportTCResult(self):
     @decoMakerApiCallWithArgs(['testplanid'], 
                 ['buildid', 'platformid', 
                  'testcaseid', 'keywordid', 'keywords', 'executed', 'assignedto', 
-                 'executestatus', 'executiontype', 'getstepinfo', 'details'])
+                 'executestatus', 'executiontype', 'getstepinfo', 'details',
+                 'customfields'])
     def getTestCasesForTestPlan(self):
         """ List test cases linked to a test plan
         

src/testlink/version.py

@@ -17,5 +17,5 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.8.1-dev119'
-TL_RELEASE = 'DEV 1.9.20 (github 6a4984164)'
+VERSION = '0.8.1-dev122'
+TL_RELEASE = 'DEV 1.9.20 (github a1c7aca97)'

test/utest-offline/test_apiClients_whatArgs.py

@@ -53,8 +53,14 @@ def test_whatArgs_unknownMethods(api_client):
                         'timestamp=<timestamp>', 'steps=<steps>', 
                         "[{'step_number' : 6,"]),
     ('getLastExecutionResult', ['options=<options>','getBugs']),
-    ('getTestCasesForTestPlan', ['buildid=<buildid>', 'platformid=<platformid>', 
-                                 'keywordid - keywords']),
+    ('getTestCasesForTestPlan', ['<testplanid>,', 
+                        'buildid=<buildid>', 'platformid=<platformid>', 
+                        'testcaseid=<testcaseid>', 'keywordid=<keywordid>', 
+                        'keywords=<keywords>', 'executed=<executed>',
+                        'assignedto=<assignedto>', 'executestatus=<executestatus>',
+                        'executiontype=<executiontype>', 'getstepinfo=<getstepinfo>',
+                        'details=<details>', 'customfields=<customfields>', 
+                        'keywordid - keywords']),
     ('createTestCase', ['<testcasename>,', '<testsuiteid>,', '<testprojectid>,', 
                         '<authorlogin>,', '<summary>,', #'<steps>,', 
                         'preconditions=<preconditions>',