api methode reportTCResult - new optional argument 'user' #24

Author: Luiko Czub

CHANGES.rst

@@ -4,6 +4,15 @@ Changes in TestLink-API-Python-client Source Distribution
 TestLink-API-Python-client UNDER DEVELOP v0.4.9 
 -----------------------------------------------------------
 
+implement 1.9.10 api change - reportTCResult #24
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TestlinkAPIGeneric and TestlinkAPIClient api method reportTCResult() 
+accepts now following additional optional arguments (usable with TL >= 1.9.10) 
+ 
+- user
+
+
 implement missing 1.9.8 api method - CustomField #12
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

doc/usage.rst

@@ -67,7 +67,39 @@ argument. Examples::
  >>> tls.copyTCnewVersion(tc_info[0]['testcase_id'], 1, summary='new summary', 
                                                         importance='1')
                                                        
+Report test results
+-------------------
 
+Using the TestLink API Client - failed test case with none default reporter 
+(argument 'users' usable with TL >= 1.9.10):
+
+ >>> import testlink
+ >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
+ >>> import testlink
+ >>> tls.reportTCResult(a_TestCaseID, a_TestPlanID, 'a build name', 'f', 
+                        'some notes', 
+                        user='a user login name', platformid=a_platformID) 
+                        
+Using the TestLink Generic API Client - passed test case with none default 
+reporter:
+
+ >>> import testlink
+ >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIGeneric)
+ >>> import testlink
+ >>> tls.reportTCResult(a_TestPlanID, 'p', testcaseid=a_TestCaseID, 
+                        buildname='a build name', notes='some notes',
+                        user='a login name', platformid=a_platformID) 
+                        
+Using the TestLink Generic API Client - blocked test case with
+alternative optional args, default reporter (user for devKey)
+
+ >>> import testlink
+ >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIGeneric)
+ >>> exTCID = tls.getTestCase(testcaseid=a_TestCaseID)[0]['full_tc_external_id']
+ >>> tls.reportTCResult(a_TestPlanID, 'b', testcaseexternalid=exTCID, 
+                        buildid='a build name', platformname='a platform name') 
+                        
+                        
 Run examples
 ------------
 

example/TestLinkExample.py

@@ -456,13 +456,16 @@
 newBuildID_B = newBuild[0]['id'] 
 print "New Build '%s' - id: %s" % (NEWBUILD_B, newBuildID_B)
 
-# TC_B blocked (without platform), explicit build and some notes , TC identified with internal id
+# TC_B blocked (without platform), explicit build and some notes , 
+# TC identified with internal id, report by myTestUserName
 newResult = myTestLink.reportTCResult(newTestCaseID_B, newTestPlanID_B, NEWBUILD_B,
-                                      'f', "no birds are singing")
+                                      'f', "no birds are singing", 
+                                      user=myTestUserName)
 print "reportTCResult", newResult
 newResultID_B_f = newResult[0]['id']
 newResult = myTestLink.reportTCResult(newTestCaseID_B, newTestPlanID_B, NEWBUILD_B,
-                                      'b', "hungry birds blocks the execution")
+                                      'b', "hungry birds blocks the execution", 
+                                      user=myTestUserName)
 print "reportTCResult", newResult
 newResultID_B_b = newResult[0]['id']
 

example/TestLinkExampleGenericApi.py

@@ -264,7 +264,9 @@
 # for every test case version 1 is used
 tc_version=1
 # TC AA should be tested with platforms 'Big Bird'+'Small Bird'
-tc_aa_full_ext_id = myTestLink.getTestCase(testcaseid=newTestCaseID_AA)[0]['full_tc_external_id']
+response = myTestLink.getTestCase(testcaseid=newTestCaseID_AA)
+print "getTestCase", response
+tc_aa_full_ext_id = response[0]['full_tc_external_id']
 response = myTestLink.addTestCaseToTestPlan(newProjectID, newTestPlanID_A, 
                     tc_aa_full_ext_id, tc_version, platformid=newPlatFormID_A)
 print "addTestCaseToTestPlan", response
@@ -380,15 +382,15 @@
 print "New Build '%s' - id: %s" % (NEWBUILD_B, newBuildID_B)
 
 # TC_B in test plan b (without platform)
-# first try failed, second blocked
+# first try failed, second blocked - all by user myTestUserName
 newResult = myTestLink.reportTCResult(newTestPlanID_B, 'f', 
                 buildid=newBuildID_B, testcaseid=newTestCaseID_B, 
-                notes="no birds are singing")
+                notes="no birds are singing", user=myTestUserName)
 print "reportTCResult", newResult
 newResultID_B_f = newResult[0]['id']
 newResult = myTestLink.reportTCResult(newTestPlanID_B, 'b', 
                 buildid=newBuildID_B, testcaseid=newTestCaseID_B, 
-                notes="hungry birds blocks the execution")
+                notes="hungry birds blocks the execution", user=myTestUserName)
 print "reportTCResult", newResult
 newResultID_B_b = newResult[0]['id']
 

src/testlink/testlinkapigeneric.py

@@ -216,7 +216,7 @@ def createTestCase(self):
     @decoMakerApiCallWithArgs(['testplanid', 'status'], 
                 ['testcaseid', 'testcaseexternalid', 'buildid', 'buildname', 
                  'platformid', 'platformname', 'notes', 'guess', 'bugid', 
-                 'customfields', 'overwrite'])
+                 'customfields', 'overwrite', 'user'])
     def reportTCResult(self):
         """ Reports a result for a single test case
 
@@ -226,7 +226,11 @@ def reportTCResult(self):
         
         customfields : dictionary with customfields names + values
             VERY IMPORTANT: value must be formatted in the way it's written to db
-             """
+        overwrite    : if present and true, then last execution for 
+                       (testcase,testplan,build,platform) will be overwritten. 
+        user : if present and user is a valid login (no other check will be done) 
+               it will be used when writting execution.
+        """
 
 #   /**
 #    * turn on/off testMode

src/testlink/version.py

@@ -17,4 +17,4 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.4.9-dev-12'
+VERSION = '0.4.9-dev-24'

test/utest-offline/testlinkapi_offline_test.py

@@ -144,6 +144,9 @@
                     'is_public': '1', 'id': '2211', 'option_automation': '0'},
                     },
               'createTestCase' : 'dummy response createTestCase',
+              'reportTCResult' :  [{'status': True, 'operation': 'reportTCResult', 
+                                    'message': 'Success!', 'overwrite': False, 'id': '773'}]              
+
               }
 
 SCENARIO_STEPS = {'createTestCase' : ['noRealReponseData - ok for step tests']}
@@ -382,6 +385,18 @@ def test_copyTCnewTestCase_version(self):
         self.assertEqual('V1', self.api.callArgs['preconditions'])
         self.assertEqual('4711', self.api.callArgs['testsuiteid'])
         self.assertEqual('2211', self.api.callArgs['testprojectid'])
+
+    def test_reportTCResult_user(self):
+        self.api.loadScenario(SCENARIO_A)
+        response = self.api.reportTCResult(4711, 4712, 'build 4713', 'p', 
+                                           'note 4714', user='a login name') 
+        self.assertEqual('reportTCResult', response[0]['operation']) 
+        self.assertEqual(self.api.devKey, self.api.callArgs['devKey'])
+        self.assertEqual('a login name', self.api.callArgs['user'])
+        
+    def test_whatArgs_reportTCResult(self):
+        argsDescription = self.api.whatArgs('reportTCResult')
+        self.assertIn('user=<user>', argsDescription)
 
 
 if __name__ == "__main__":

test/utest-offline/testlinkapigeneric_offline_test.py

@@ -62,7 +62,9 @@
                    'twoPlatforms' : {'dutch' : {'id': '1', 'name': 'dutch'}, 
                                      'platt' : {'id': '2', 'name': 'platt'}},
                     'noPlatform'  : {}   
-                    }              
+                    },
+              'reportTCResult' :  [{'status': True, 'operation': 'reportTCResult', 
+                                    'message': 'Success!', 'overwrite': False, 'id': '773'}]              
               }
 
 # scenario_tl198 used by test with older responses, changed in TL 1.9.9
@@ -593,8 +595,23 @@ def test_getRequirementCustomFieldDesignValue_full(self):
         self.assertEqual('a custom Req string', response['value'])           
         self.assertEqual('1', response['enable_on_design']) 
         self.assertEqual('0', response['enable_on_testplan_design']) 
-        self.assertEqual('0', response['enable_on_execution'])           
-
+        self.assertEqual('0', response['enable_on_execution'])   
+        
+    def test_reportTCResult_user(self):
+        self.api.loadScenario(SCENARIO_A)
+        response = self.api.reportTCResult(4712, 'p', testcaseid=4711, 
+                                    buildname='build 4713', notes='note 4714',
+                                    user='a login name') 
+        self.assertEqual('reportTCResult', response[0]['operation']) 
+        self.assertEqual(self.api.devKey, self.api.callArgs['devKey'])
+        self.assertEqual('a login name', self.api.callArgs['user'])
+        
+    def test_whatArgs_reportTCResult(self):
+        argsDescription = self.api.whatArgs('reportTCResult')
+        self.assertIn('user=<user>', argsDescription)
+        
+        
+                
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']
     unittest.main()