new api method - updateTestSuiteCustomFieldDesignValue #61

Author: Luiko Czub

CHANGES.rst

@@ -5,17 +5,21 @@ TestLink-API-Python-client v0.6.2 - Under Develop
 ------------------------------------------------------------
 support for TL 1.9.14 release
 
-implement 1.9.14 new api interfaces - #53
+implement 1.9.14 new api interfaces - #53 #61
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api methods
 
 - deleteTestProject(<testprojectprefix>) 
+- updateTestSuiteCustomFieldDesignValue(<testprojectid>, <testsuiteid>, <customfields>)
 
 examples _`<example/TestLinkExample.py>`_  and 
 `<example/TestLinkExampleGenericApi.py>`_ now deletes the sample project, if it
 already exist.
 
+example _`<example/TestLinkExample_CF_KW.py>`_ shows, how to set and get 
+customer field values
+
 implement 1.9.14 changed api interfaces - #48 #49 #54 #59
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -75,6 +79,11 @@ TestlinkAPIClient service method listKeywordsForTC() uses now getTestCaseKeyword
 
 - internal change to reduce code complexity 
 
+Known TL 1.9.14 limitations:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- 7282 updateTestSuiteCustomFieldDesignValue() does change customer field values
+
 TestLink-API-Python-client release notes v0.6.1 (Mar. 2015)  
 ------------------------------------------------------------
 support for TL 1.9.13 release  

example/TestLinkExample_CF_KW.py

@@ -232,7 +232,7 @@
          'testprojectid' : newProjectID,
          'testcaseexternalid' : newTestCase_B['full_tc_external_id'],
          'version' : int(newTestCase_B['version']),
-         'tcversion_id' : lastResult['tcversion_id'],
+         'tcversion_number' : lastResult['tcversion_number'],
          'executionid' : lastResult['id'],
          'linkid' : 779,
          'testsuiteid': newTestSuiteID_B,
@@ -242,7 +242,7 @@
 
 # get CustomField Value - TestCase Execution
 response = myTestLink.getTestCaseCustomFieldExecutionValue(
-                'cf_tc_ex_string', args['testprojectid'], args['tcversion_id'],
+                'cf_tc_ex_string', args['testprojectid'], args['tcversion_number'],
                 args['executionid'] , args['testplanid'] )
 print( "getTestCaseCustomFieldExecutionValue", response )
 
@@ -273,10 +273,16 @@
 
 # get CustomField Value - TestCase Testplan Design
 response = myTestLink.getTestCaseCustomFieldTestPlanDesignValue(
-                'cf_tc_pd_string', args['testprojectid'], args['tcversion_id'],
+                'cf_tc_pd_string', args['testprojectid'], args['tcversion_number'],
                 args['testplanid'], args['linkid'])
 print( "getTestCaseCustomFieldTestPlanDesignValue", response )
 
+# update CustomField Value - TestSuite SpecDesign
+response = myTestLink.updateTestSuiteCustomFieldDesignValue( 
+                 args['testprojectid'], args['testsuiteid'],
+                 {'cf_ts_string' : 'A custom TestSuite value set via api'})
+print( "updateTestSuiteCustomFieldDesignValue", response )
+
 # get CustomField Value - TestSuite
 response = myTestLink.getTestSuiteCustomFieldDesignValue(
                 'cf_ts_string', args['testprojectid'], args['testsuiteid'])

src/testlink/testlinkapigeneric.py

@@ -183,7 +183,7 @@ def getBuildsForTestPlan(self):
     def getTestSuitesForTestPlan(self):
         """ List test suites within a test plan alphabetically
         
-        returns an empty list, if no build is assigned """
+        returns an empty list, if no suite is assigned """
 
     @decoApiCallAddDevKey               
     @decoMakerApiCallWithArgs(['testprojectname', 'testcaseprefix'],
@@ -1407,6 +1407,44 @@ def removeTestCaseKeywords(self):
     def deleteTestProject(self):
         """ Delete a test project and all related link to other items  """ 
 
+#  /**
+#    * Update value of Custom Field with scope='design' 
+#    * for a given Test Suite
+#    *
+#    * @param struct $args
+#    * @param string $args["devKey"]: used to check if operation can be done.
+#    *                                if devKey is not valid => abort.
+#    *
+#    * @param string $args["testsuiteid"]:  
+#    * @param string $args["testprojectid"]: 
+#    * @param string $args["customfields"]
+#    *               contains an map with key:Custom Field Name, value: value for CF.
+#    *               VERY IMPORTANT: value must be formatted in the way it's written to db,
+#    *               this is important for types like:
+#    *
+#    *               DATE: strtotime()
+#    *               DATETIME: mktime()
+#    *               MULTISELECTION LIST / CHECKBOX / RADIO: se multipli selezione ! come separatore
+#    *
+#    *
+#    *               these custom fields must be configured to be writte during execution.
+#    *               If custom field do not meet condition value will not be written
+#    *
+#    * @return mixed null if everything ok, else array of IXR_Error objects
+#    *         
+#    * @access public
+#    */    
+#   public function updateTestSuiteCustomFieldDesignValue($args)
+        
+  
+    @decoApiCallAddDevKey               
+    @decoMakerApiCallWithArgs(['testprojectid', 'testsuiteid', 'customfields'])
+    def updateTestSuiteCustomFieldDesignValue(self):
+        """ Update value of Custom Field with scope='design' for a given Test Suite
+
+        customfields : dictionary with customfields names + values
+            VERY IMPORTANT: value must be formatted in the way it's written to db
+        """
 
     #
     #  internal methods for general server calls

src/testlink/version.py

@@ -17,6 +17,6 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.6.2-dev45'
-TL_RELEASE = '1.9.14 github 2a91690'
+VERSION = '0.6.2-dev61'
+TL_RELEASE = '1.9.14 github 352fd01'
 

test/utest-online/testlinkapi_generic_online_test.py

@@ -468,6 +468,13 @@ def test_createTestPlan_prefix_unknownID(self):
             self.client.createTestPlan('plan 40000713', 
                                        prefix='TProjectPrefix')
 
+    def test_updateTestSuiteCustomFieldDesignValue_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '7000.*40000712'):
+            self.client.updateTestSuiteCustomFieldDesignValue(
+                            '40000712 TP-ID', '40000711 TS-ID',  
+                            {'cf_tc_ex_string' : 'a custom exec value', 
+                             'cf_tc_ex_numeric' : 111} )
+
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

test/utest-online/testlinkapi_online_test.py

@@ -453,6 +453,14 @@ def test_createTestPlan_prefix_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '7013.*TProjectPrefix'):
             self.client.createTestPlan('plan 40000713', 
                                        prefix='TProjectPrefix')
+
+    def test_updateTestSuiteCustomFieldDesignValue_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '7000.*40000712'):
+            self.client.updateTestSuiteCustomFieldDesignValue(
+                            '40000712 TP-ID', '40000711 TS-ID',  
+                            {'cf_tc_ex_string' : 'a custom exec value', 
+                             'cf_tc_ex_numeric' : 111} )
+            
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']