server call methods shifted to generic API lczub#7

createBuild, reportTCResult

Author: Luiko Czub

example/TestLinkExample.py

@@ -85,6 +85,7 @@
 NEWTESTSUITE_AA="AA - Second Level"
 NEWTESTCASE_AA="TESTCASE_AA"
 NEWTESTCASE_B="TESTCASE_B"
+NEWBUILD="Build v0.4.5"
 
 
 if myTestLink.checkDevKey() != True:
@@ -237,6 +238,26 @@
                  'testcaseexternalid' : tc_b_full_ext_id, 'version' : 1})
 print response
 
+# -- Create Build
+newBuild = myTestLink.createBuild(newTestPlanID, NEWBUILD, 'Notes for the Build')
+print newBuild
+isOk = newBuild[0]['message']
+if isOk=="Success!":
+  newBuildID = newBuild[0]['id'] 
+  print "New Build '%s' - id: %s" % (NEWBUILD, newBuildID)
+else:
+  print "Error creating the Build '%s': %s " % (NEWBUILD, isOk)
+  sys.exit(-1)
+  
+# report Test Case Results
+# TC_AA failed
+newResult = myTestLink.reportTCResult(newTestPlanID, newTestCaseID_AA, NEWBUILD,
+                                       'f', '')
+print newResult
+# TC_B passed, explicit build and some notes , TC identified with internal id
+newResult = myTestLink.reportTCResult(newTestPlanID, newTestCaseID_B, NEWBUILD,
+                                      'p', 'first try')
+print newResult  
 
 print ""
 print "Number of Projects in TestLink: %s " % (myTestLink.countProjects(),)

example/TestLinkExampleGenericApi.py

@@ -75,6 +75,7 @@
 NEWTESTSUITE_AA="AA - Second Level"
 NEWTESTCASE_AA="TESTCASE_AA"
 NEWTESTCASE_B="TESTCASE_B"
+NEWBUILD="Build v0.4.5"
 
 id_cache={}
 
@@ -105,7 +106,7 @@
 
 # Creates the test plan
 newTestPlan = myTestLink.createTestPlan(NEWTESTPLAN, NEWPROJECT,
-            notes='New TestPlan created with the API',active=1, public=1)    
+            notes='New TestPlan created with the Generic API',active=1, public=1)    
 isOk = newTestPlan[0]['message']
 if isOk=="Success!":
   id_cache[NEWTESTPLAN] = newTestPlan[0]['id'] 
@@ -217,6 +218,29 @@
                  'testcaseexternalid' : tc_b_full_ext_id, 'version' : 1})
 print response
 
+# -- Create Build
+newBuild = myTestLink.createBuild(id_cache[NEWTESTPLAN], NEWBUILD, 
+                                  buildnotes='Notes for the Build')
+print newBuild
+isOk = newBuild[0]['message']
+if isOk=="Success!":
+  id_cache[NEWBUILD] = newBuild[0]['id'] 
+  print "New Build '%s' - id: %s" % (NEWBUILD, id_cache[NEWBUILD])
+else:
+  print "Error creating the Build '%s': %s " % (NEWBUILD, isOk)
+  sys.exit(-1)
+  
+# report Test Case Results
+# TC_AA failed, build should be guessed, TC identified with external id
+newResult = myTestLink.reportTCResult(id_cache[NEWTESTPLAN], 'f', guess=True,
+                                     testcaseexternalid=tc_aa_full_ext_id)
+print newResult
+# TC_B passed, explicit build and some notes , TC identified with internal id
+newResult = myTestLink.reportTCResult(id_cache[NEWTESTPLAN], 'p', 
+                buildid=id_cache[NEWBUILD], testcaseid=id_cache[NEWTESTCASE_B], 
+                notes="first try")
+print newResult
+
 print ""
 print "Number of Projects in TestLink: %i " % len(myTestLink.getProjects())
 print ""

src/testlink/testlinkapi.py

@@ -43,7 +43,11 @@ def _changePositionalArgConfig(self):
                         'testprojectid', 'authorlogin', 'summary'] #, 'steps']
         # getTestCase 
         pos_arg_config['getTestCase'] = ['testcaseid']
-        
+        # createVuild
+        pos_arg_config['createBuild'] = ['testplanid', 'buildname', 'buildnotes']
+        # reportTCResult
+        pos_arg_config['reportTCResult'] = ['testcaseid', 'testplanid', 
+                                            'buildname', 'status', 'notes']
     #
     #  BUILT-IN API CALLS
     #
@@ -304,15 +308,15 @@ def getTotalsForTestPlan(self, testplanid):
 #                     argsAPI[paramlist[0]] = paramlist[1]  
 #         return self._callServer('createTestProject', argsAPI)
 
-    def createBuild(self, testplanid, buildname, buildnotes):
-        """ createBuild :
-        Creates a new build for a specific test plan     
-        """
-        argsAPI = {'devKey' : self.devKey,
-                'testplanid' : str(testplanid),
-                'buildname' : str(buildname),
-                'buildnotes' : str(buildnotes)}                  
-        return self._callServer('createBuild', argsAPI)        
+#     def createBuild(self, testplanid, buildname, buildnotes):
+#         """ createBuild :
+#         Creates a new build for a specific test plan     
+#         """
+#         argsAPI = {'devKey' : self.devKey,
+#                 'testplanid' : str(testplanid),
+#                 'buildname' : str(buildname),
+#                 'buildnotes' : str(buildnotes)}                  
+#         return self._callServer('createBuild', argsAPI)        
 
 #     def createTestPlan(self, *args):
 #         """ createTestPlan :
@@ -391,25 +395,25 @@ def createTestCase(self, *argsPositional, **argsOptional):
 #         self.stepsList = []                    
 #         return ret 
 
-    def reportTCResult(self, testcaseid, testplanid, buildname, status, notes ):
-        """
-        Report execution result
-        testcaseid: internal testlink id of the test case
-        testplanid: testplan associated with the test case
-        buildname: build name of the test case
-        status: test verdict ('p': pass,'f': fail,'b': blocked)
-
-        Return : [{'status': True, 'operation': 'reportTCResult', 'message': 'Success!', 'overwrite': False, 'id': '37'}]
-        id correspond to the executionID needed to attach files to a test execution
-        """
-        argsAPI = {'devKey' : self.devKey,
-                'testcaseid' : testcaseid,
-                'testplanid' : testplanid,
-                'status': status,
-                'buildname': buildname,
-                'notes': str(notes)
-                }
-        return self._callServer('reportTCResult', argsAPI)
+#     def reportTCResult(self, testcaseid, testplanid, buildname, status, notes ):
+#         """
+#         Report execution result
+#         testcaseid: internal testlink id of the test case
+#         testplanid: testplan associated with the test case
+#         buildname: build name of the test case
+#         status: test verdict ('p': pass,'f': fail,'b': blocked)
+# 
+#         Return : [{'status': True, 'operation': 'reportTCResult', 'message': 'Success!', 'overwrite': False, 'id': '37'}]
+#         id correspond to the executionID needed to attach files to a test execution
+#         """
+#         argsAPI = {'devKey' : self.devKey,
+#                 'testcaseid' : testcaseid,
+#                 'testplanid' : testplanid,
+#                 'status': status,
+#                 'buildname': buildname,
+#                 'notes': str(notes)
+#                 }
+#         return self._callServer('reportTCResult', argsAPI)
 
 
 

src/testlink/testlinkapigeneric.py

@@ -31,13 +31,15 @@
 # subclasses could override this definition, if their (python) method should
 # work with different positional arguments
 positionalArgNamesDefault = {
+            'createBuild' : ['testplanid', 'buildname'],
             'createTestCase' : ['testcasename', 'testsuiteid', 'testprojectid',
                                 'authorlogin', 'summary', 'steps'],
             'createTestPlan' : ['testplanname', 'testprojectname'],
             'createTestProject' : ['testprojectname', 'testcaseprefix'],
             'createTestSuite' : ['testprojectid', 'testsuitename', 'details'],
             'doesUserExist' : ['user'],
-            'repeat' : ['str']
+            'repeat' : ['str'],
+            'reportTCResult' : ['testplanid', 'status']
 }
 
 # decorators for generic api calls
@@ -106,18 +108,15 @@ def about(self):
         positional args: ---
         optional args : --- """
 
-#    * Creates a new build for a specific test plan
-#    *
-#    * @param struct $args
-#    * @param string $args["devKey"]
-#    * @param int $args["testplanid"]
-#    * @param string $args["buildname"];
-#    * @param string $args["buildnotes"];
-#    * @return mixed $resultInfo
-#   public function createBuild($args)
-
     @decoApiCallAddDevKey               
     @decoApiCallWithArgs
+    def createBuild(self):
+        """ createBuild: Creates a new build for a specific test plan
+        positional args: testplanid, buildname
+        optional args : buildnotes """
+
+    @decoApiCallAddDevKey            
+    @decoApiCallWithArgs
     def getProjects(self):
         """ getProjects: Gets a list of all projects
         positional args: ---
@@ -277,6 +276,20 @@ def createTestCase(self):
 #    */
 #   public function reportTCResult($args)
 
+    @decoApiCallAddDevKey               
+    @decoApiCallWithArgs
+    def reportTCResult(self):
+        """ reportTCResult : Reports a result for a single test case
+        positional args: testplanid, status
+        optional args (variations): testcaseid - testcaseexternalid
+                                    buildid - buildname
+                                    platformid - platformname
+        optional args : notes, guess, bugid, customfields, overwrite 
+        
+        customfields : dictionary with customfields names + values
+            VERY IMPORTANT: value must be formatted in the way it's written to db
+ """
+
 #   /**
 #    * turn on/off testMode
 #    *
@@ -1128,7 +1141,7 @@ def _convertPostionalArgs(self, methodName, valueList):
         if length_NameList != length_ValueList:
             new_msg = '%s - mismatching number of positional args %i vs %i' %\
             (methodName, length_NameList, length_ValueList)
-            new_msg = '%s\n expected args: %s' % (new_msg, ' - '.join(nameList))
+            new_msg = '%s\n expected args: %s' % (new_msg, ', '.join(nameList))
             raise testlinkerrors.TLArgError(new_msg)
         return {nameList[x] : valueList[x] for x in range(len(nameList)) }
 

test/utest/testlinkapigeneric_online_test.py

@@ -138,7 +138,6 @@ def test_getTestCase_unknownExternalID(self):
         # FAILURE in 1.9.3 API message: replacement does not work
         # The Test Case ID (testcaseid: %s) provided does not exist!
         #self.assertIn('4711', response[0]['message'])
-        print response
         self.assertEqual(5040, response[0]['code'])
 
 #     def test_getTestCaseAttachments_unknownID(self):
@@ -204,19 +203,16 @@ def test_getTestCase_unknownExternalID(self):
 #         self.assertIn('4711', response[0]['message'])
 #         self.assertEqual(3000, response[0]['code'])
 
-#     def test_createBuild_unknownID(self):
-#         response = self.client.createBuild(4711, 'Build 4712', 'note 4713')
-#         self.assertIn('4711', response[0]['message'])
-#         self.assertEqual(3000, response[0]['code'])
-# 
-#     def test_reportTCResult_unknownID(self):
-#         response = self.client.reportTCResult(4711, 4712, 'build 4713', 'p', 
-#                                               'note 4714')
-#         # FAILURE in 1.9.3 API message: replacement does not work
-#         # The Test Case ID (testcaseid: %s) provided does not exist!
-#         #self.assertIn('4711', response[0]['message'])
-#         self.assertEqual(5000, response[0]['code'])
-# 
+    def test_createBuild_unknownID(self):
+        response = self.client.createBuild(4711, 'Build 4712', buildnotes='note 4713')
+        self.assertIn('4711', response[0]['message'])
+        self.assertEqual(3000, response[0]['code'])
+ 
+    def test_reportTCResult_unknownID(self):
+        response = self.client.reportTCResult(4712, 'p', testcaseid=4711, buildname='build 4713', notes='note 4714' )
+        #response = self.client.reportTCResult(538, 'p', testcaseexternalid='GPROAPI-2', guess=True)
+        self.assertEqual(5000, response[0]['code'])
+ 
 # #    def test_uploadExecutionAttachment_unknownID(self):
 # #        response = self.client.uploadExecutionAttachment('file 4711', 4712, 
 # #                        'title 4713', 'descr. 4714')