api methods for platforms #10

createPlatform, getProjectPlatforms
addPlatformToTestPlan,removePlatformFromTestPlan

Author: Luiko Czub

Diff for: example/TestLinkExample.py

@@ -395,10 +395,19 @@
 
 
 print ""
-print "Number of Projects in TestLink: %s " % (myTestLink.countProjects(),)
+print "Number of Projects      in TestLink: %s " % myTestLink.countProjects()
+print "Number of Platforms  (in TestPlans): %s " % myTestLink.countPlatforms()
+print "Number of Builds                   : %s " % myTestLink.countBuilds()
+print "Number of TestPlans                : %s " % myTestLink.countTestPlans()
+print "Number of TestSuites               : %s " % myTestLink.countTestSuites()
+print "Number of TestCases (in TestSuites): %s " % myTestLink.countTestCasesTS()
+print "Number of TestCases (in TestPlans) : %s " % myTestLink.countTestCasesTP()
 print ""
 myTestLink.listProjects()
 
+print 
+print ""
+myTestLink.listProjects()
 
 
 

Diff for: example/TestLinkExampleGenericApi.py

@@ -22,6 +22,7 @@
 
 Shows how to use the TestLinkAPIGeneric.
 - does equal things as Example TestLinkAPI in TestLinkExample.py
+  - exception - this test project uses platforms 
 
 => Counts and lists the Projects 
 => Create a new Project with the following structure:
@@ -72,7 +73,10 @@
 
 NEWPROJECT="PROJECT_API_GENERIC-%i" % projNr
 NEWPREFIX="GPROAPI%i" % projNr
-NEWTESTPLAN="TestPlan_API_GENERIC"
+NEWTESTPLAN="TestPlan_API_GENERIC %i" % projNr
+NEWPLATFORM_A='Big Bird %i' % projNr
+NEWPLATFORM_B='Small Bird'
+NEWPLATFORM_C='Ugly Bird'
 NEWTESTSUITE_A="A - First Level"
 NEWTESTSUITE_B="B - First Level"
 NEWTESTSUITE_AA="AA - Second Level"
@@ -123,6 +127,39 @@
 newTestPlanID = newTestPlan[0]['id'] 
 print "New Test Plan '%s' - id: %s" % (NEWTESTPLAN,newTestPlanID)
 
+# Create platform 'Big Bird x' 
+newPlatForm = myTestLink.createPlatform(NEWPROJECT, NEWPLATFORM_A, 
+        notes='Platform for Big Birds, unique name, only used in this project')
+print "createPlatform", newPlatForm
+newPlatFormID_A = newPlatForm['id']
+# Add Platform  'Big Bird x' to platform 
+response = myTestLink.addPlatformToTestPlan(newTestPlanID, NEWPLATFORM_A) 
+print "addPlatformToTestPlan", response
+
+# Create platform 'Small Bird'
+newPlatForm = myTestLink.createPlatform(NEWPROJECT, NEWPLATFORM_B, 
+                notes='Platform for Small Birds, name used in all example projects')
+print "createPlatform", newPlatForm
+newPlatFormID_B = newPlatForm['id']
+# Add Platform  'Small Bird' to platform 
+response = myTestLink.addPlatformToTestPlan(newTestPlanID, NEWPLATFORM_B) 
+print "addPlatformToTestPlan", response
+
+# Create platform 'Ugly Bird'
+newPlatForm = myTestLink.createPlatform(NEWPROJECT, NEWPLATFORM_C, 
+                notes='Platform for Ugly Birds, will be removed from test plan')
+print "createPlatform", newPlatForm
+newPlatFormID_C = newPlatForm['id']
+# Add Platform  'Ugly Bird' to platform 
+response = myTestLink.addPlatformToTestPlan(newTestPlanID, NEWPLATFORM_C) 
+print "addPlatformToTestPlan", response
+
+# looking, which platforms exists
+response = myTestLink.getProjectPlatforms(newProjectID) 
+print "getProjectPlatforms", response
+
+
+ 
 #Creates the test Suite A      
 newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_A,
             "Details of the Test Suite A")  
@@ -191,36 +228,61 @@
 print "New Test Case '%s' - id: %s" % (NEWTESTCASE_B, newTestCaseID_B)
 
 # Add  test cases to test plan - we need the full external id !
+# 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.callServerWithPosArgs('addTestCaseToTestPlan', 
                 devKey=myTestLink.devKey, testprojectid=newProjectID, 
                 testplanid=newTestPlanID, testcaseexternalid=tc_aa_full_ext_id,
-                version=1)
+                platformid=newPlatFormID_A,version=1)
 print "addTestCaseToTestPlan", response
+tc_aa_full_ext_id = myTestLink.getTestCase(testcaseid=newTestCaseID_AA)[0]['full_tc_external_id']
+response = myTestLink.callServerWithPosArgs('addTestCaseToTestPlan', 
+                devKey=myTestLink.devKey, testprojectid=newProjectID, 
+                testplanid=newTestPlanID, testcaseexternalid=tc_aa_full_ext_id,
+                platformid=newPlatFormID_B,version=1)
+print "addTestCaseToTestPlan", response
+# TC B should be tested with platforms 'Small Bird'
 tc_b_full_ext_id = myTestLink.getTestCase(testcaseid=newTestCaseID_B)[0]['full_tc_external_id']
 response = myTestLink.callServerWithPosArgs('addTestCaseToTestPlan', 
                 devKey=myTestLink.devKey, testprojectid=newProjectID, 
                 testplanid=newTestPlanID, testcaseexternalid=tc_b_full_ext_id,
-                version=1)
+                platformid=newPlatFormID_B,version=1)
 print "addTestCaseToTestPlan", response
 
+# Remove Platform  'Big Bird' from platform 
+response = myTestLink.removePlatformFromTestPlan(newTestPlanID, NEWPLATFORM_C) 
+print "removePlatformFromTestPlan", response
+
+# Remove Platform  'Ugly Bird' from platform 
+response = myTestLink.removePlatformFromTestPlan(newTestPlanID, NEWPLATFORM_C) 
+print "removePlatformFromTestPlan", response
+
+
 # -- Create Build
 newBuild = myTestLink.createBuild(newTestPlanID, NEWBUILD, 
                                   buildnotes='Notes for the Build')
 print "createBuild", newBuild
 newBuildID = newBuild[0]['id'] 
 print "New Build '%s' - id: %s" % (NEWBUILD, newBuildID)
 
-# report Test Case Results
+# report Test Case Results for platform 'Big Bird'
 # TC_AA failed, build should be guessed, TC identified with external id
 newResult = myTestLink.reportTCResult(newTestPlanID, 'f', guess=True,
-                                      testcaseexternalid=tc_aa_full_ext_id)
+                                      testcaseexternalid=tc_aa_full_ext_id,
+                                      platformname=NEWPLATFORM_A)
 print "reportTCResult", newResult
 newResultID_AA = newResult[0]['id']
+# report Test Case Results for platform 'Small Bird'
+# TC_AA passed, build should be guessed, TC identified with external id
+newResult = myTestLink.reportTCResult(newTestPlanID, 'p', guess=True,
+                                      testcaseexternalid=tc_aa_full_ext_id,
+                                      platformid=newPlatFormID_B)
+print "reportTCResult", newResult
+newResultID_AA_p = newResult[0]['id']
 # TC_B passed, explicit build and some notes , TC identified with internal id
 newResult = myTestLink.reportTCResult(newTestPlanID, 'p', 
                 buildid=newBuildID, testcaseid=newTestCaseID_B, 
-                notes="first try")
+                platformname=NEWPLATFORM_B, notes="first try")
 print "reportTCResult", newResult
 newResultID_B = newResult[0]['id']
 

Diff for: src/testlink/testlinkapi.py

@@ -590,7 +590,7 @@ def countTestCasesTS(self):
 
     def countPlatforms(self):
         """ countPlatforms :
-        Count all the Platforms  
+        Count all the Platforms in TestPlans 
         """
         projects=self.getProjects()
         nbPlatforms = 0

Diff for: src/testlink/testlinkapigeneric.py

@@ -375,7 +375,7 @@ def getTestSuiteByID(self):
     def getTestSuitesForTestSuite(self):
         """ get list of TestSuites which are DIRECT children of a given TestSuite
         
-        returns an empty list, if no platform is assigned """
+        returns an empty list, if no TestSuite is assigned """
 
     @decoMakerApiCallReplaceTLResponseError(3041)            
     @decoApiCallAddDevKey               
@@ -778,47 +778,30 @@ def uploadExecutionAttachment(self):
 #    */
 #   public function getExecCountersByBuild($args)
 
-#   /**
-#    * create platform 
-#    * 
-#    * @param struct $args
-#    * @param string $args["devKey"]
-#    * @param int $args["testprojectname"]
-#    * @param map $args["platformname"]
-#    * @param map $args["notes"]
-#    * @return mixed $resultInfo
-#    * @internal revisions
-#    */
-#   public function createPlatform($args)
+    @decoApiCallAddDevKey               
+    @decoMakerApiCallWithArgs(['testprojectname', 'platformname'], 
+                              ['notes'])
+    def createPlatform(self):
+        """ Creates a platform for test project """
 
-#   /**
-#    *
-#    */
-#   public function getProjectPlatforms($args)
 
-#   /**
-#    * addPlatformToTestPlan 
-#    * 
-#    * @param struct $args
-#    * @param string $args["devKey"]
-#    * @param int $args["testplanid"]
-#    * @param map $args["platformname"]
-#    * @return mixed $resultInfo
-#    * @internal revisions
-#    */
-#   public function addPlatformToTestPlan($args)
+    @decoMakerApiCallReplaceTLResponseError(replaceValue={})            
+    @decoApiCallAddDevKey
+    @decoMakerApiCallWithArgs(['testprojectid'])
+    def getProjectPlatforms(self):
+        """ Gets a dictionary of platforms for a project   
+        
+        returns an empty dictionary, if no platform is assigned """
 
-#   /**
-#    * removePlatformFromTestPlan 
-#    * 
-#    * @param struct $args
-#    * @param string $args["devKey"]
-#    * @param int $args["testplanid"]
-#    * @param map $args["platformname"]
-#    * @return mixed $resultInfo
-#    * @internal revisions
-#    */
-#   public function removePlatformFromTestPlan($args)
+    @decoApiCallAddDevKey
+    @decoMakerApiCallWithArgs(['testplanid', 'platformname'])
+    def addPlatformToTestPlan(self):
+        """ Adds a platform to a test plan """
+
+    @decoApiCallAddDevKey
+    @decoMakerApiCallWithArgs(['testplanid', 'platformname'])
+    def removePlatformFromTestPlan(self):
+        """ Removes a platform from a test plan """
 
 #   /**
 #    * if everything ok returns an array on just one element with following user data

Diff for: src/testlink/testlinkdecorators.py

@@ -105,8 +105,8 @@ def wrapperAddDevKey(self, *argsPositional, **argsOptional):
         return methodAPI(self, *argsPositional, **argsOptional)
     return wrapperAddDevKey
 
-def decoMakerApiCallReplaceTLResponseError(replaceCode=None):
-    """ creates a decorator, which replace an TLResponseError with an empty list,
+def decoMakerApiCallReplaceTLResponseError(replaceCode=None, replaceValue=[]):
+    """ creates a decorator, which replace an TLResponseError with a new value
 
      Default (replaceCode=None) handles the cause 'Empty Result'
      - ok for getProjectTestPlans, getBuildsForTestPlan, which returns just ''
@@ -115,6 +115,9 @@ def decoMakerApiCallReplaceTLResponseError(replaceCode=None):
         3041: Test plan (noPlatform) has no platforms linked
         7008: Test Project (noSuite) is empty
       could be handled with replaceCode=3041 / replaceCode=7008
+      
+     Default (replaceValue=[]) new return value is an empty list
+     - could be changed to other things like {}       
 
      """  
     # for understanding, what we are doing here please read
@@ -132,7 +135,7 @@ def wrapperReplaceTLResponseError(self, *argsPositional, **argsOptional):
                 if tl_err.code == replaceCode:
                     # empty result (response == '') -> code == None
                     # special case NoPlatform -> code == 3041
-                    response = []
+                    response = replaceValue
                 else:
                     # seems to be another response failure - we forward it
                     raise  

Diff for: src/testlink/version.py

@@ -17,4 +17,4 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.4.6-DEV-15'
+VERSION = '0.4.6-DEV-10'

Diff for: test/utest-offline/testlinkapigeneric_offline_test.py

@@ -57,7 +57,12 @@
                                        'name': 'TESTCASE_B'}}, 
                 'listResult' : [{'parent_id': '25', 'tc_external_id': '1', 
                                  'id': '26', 'tsuite_name': 'AA - Second Level', 
-                                 'name': 'TESTCASE_AA'}]}
+                                 'name': 'TESTCASE_AA'}]},
+              'getProjectPlatforms' : {
+                   'twoPlatforms' : {'dutch' : {'id': '1', 'name': 'dutch'}, 
+                                     'platt' : {'id': '2', 'name': 'platt'}},
+                    'noPlatform'  : {}   
+                    }
               }
 
 class DummyAPIGeneric(TestlinkAPIGeneric):
@@ -88,7 +93,7 @@ def _callServer(self, methodAPI, argsAPI=None):
             data = self.scenario_data[methodAPI]
             if methodAPI in ['doesUserExist']:
                 response = data[argsAPI['user']]
-            elif methodAPI in ['getProjectTestPlans', 
+            elif methodAPI in ['getProjectTestPlans', 'getProjectPlatforms',
                                'getFirstLevelTestSuitesForTestProject']:
                 response = data[argsAPI['testprojectid']]
             elif methodAPI in ['getBuildsForTestPlan', 'getTestPlanPlatforms', 
@@ -241,6 +246,19 @@ def test_getProjectTestPlans_onePlan(self):
         self.assertEqual('21', response[0]['testproject_id'])
         self.assertEqual(1, len(response))
 
+    def test_getProjectPlatforms_noPlatform(self):
+        self.api.loadScenario(SCENARIO_A)
+        response = self.api.getProjectPlatforms('noPlatform')
+        self.assertEqual({}, response)
+        self.assertEqual(self.api.devKey, self.api.callArgs['devKey'])
+        
+    def test_getProjectPlatforms_twoPlatforms(self):
+        self.api.loadScenario(SCENARIO_A)
+        response = self.api.getProjectPlatforms('twoPlatforms')
+        self.assertEqual('1', response['dutch']['id'])
+        self.assertEqual(2, len(response))
+        
+        
     def test_getBuildsForTestPlan_noBuild(self):
         self.api.loadScenario(SCENARIO_A)
         response = self.api.getBuildsForTestPlan('noBuild')

Diff for: test/utest-offline/testlinkdecoratorstest.py

@@ -152,6 +152,17 @@ def a_func(a_api, *argsPositional, **argsOptional):
         response = a_func(self.api, name='BigBird')
         self.assertEqual({'name' : 'BigBird'}, response)
 
+    def test_decoApiCallReplaceTLResponseError_replaceValue(self):
+        " decorator test: TLResponseError should be replaced with {}"
+        
+        @decoMakerApiCallReplaceTLResponseError(replaceValue={})
+        def a_func(a_api, *argsPositional, **argsOptional):
+            raise TLResponseError('DummyMethod', 
+                                argsOptional, 'Empty Response! ')
+
+        response = a_func(self.api)
+        self.assertEqual({}, response)
+
     def test_noWrapperName_decoApiCallReplaceTLResponseError(self):
         " decorator test: original function name should be unchanged "
 

Diff for: test/utest-online/testlinkapi_online_test.py

@@ -92,6 +92,10 @@ def test_getProjects(self):
     def test_getProjectTestPlans_unknownID(self):
         with self.assertRaisesRegexp(TLResponseError, '7000.*4711'):
             self.client.getProjectTestPlans(4711)
+
+    def test_getProjectPlatforms_unknownID(self):
+        with self.assertRaisesRegexp(TLResponseError, '7000.*4711'):
+            self.client.getProjectPlatforms(4711)
 
     def test_getTestCase_unknownID(self):
         with self.assertRaisesRegexp(TLResponseError, '5000.*4711'):
@@ -185,6 +189,12 @@ def test_uploadExecutionAttachment_unknownID(self):
     def test_getProjectIDByName_unknownID(self):
         response = self.client.getProjectIDByName('project 4711')
         self.assertEqual(-1, response)
+        
+    def test_createPlatform_unknownID(self):
+        with self.assertRaisesRegexp(TLResponseError, '7011.*4711'):
+            self.client.createPlatform('Project 4711', 'Platform 4712', 
+                                       notes='note 4713')
+        
 
 
 if __name__ == "__main__":

Diff for: test/utest-online/testlinkapigeneric_online_test.py

@@ -115,6 +115,10 @@ def test_getProjectTestPlans_unknownID(self):
         with self.assertRaisesRegexp(TLResponseError, '7000.*4711'):
             self.client.getProjectTestPlans(4711)
 
+    def test_getProjectPlatforms_unknownID(self):
+        with self.assertRaisesRegexp(TLResponseError, '7000.*4711'):
+            self.client.getProjectPlatforms(4711)
+        
     def test_getTestCase_unknownID(self):
         with self.assertRaisesRegexp(TLResponseError, '5000.*4711'):
             self.client.getTestCase(testcaseid=4711)
@@ -191,6 +195,19 @@ def test_uploadExecutionAttachment_unknownID(self):
 #         response = self.client.getProjectIDByName('project 4711')
 #         self.assertEqual(-1, response)
 
+    def test_createPlatform_unknownID(self):
+        with self.assertRaisesRegexp(TLResponseError, '7011.*4711'):
+            self.client.createPlatform('Project 4711', 'Platform 4712', 
+                                       notes='note 4713')
+            
+    def test_addPlatformToTestPlan_unknownID(self):
+        with self.assertRaisesRegexp(TLResponseError, '3000.*4711'):
+            self.client.addPlatformToTestPlan(4711, 'Platform 4712')
+            
+    def test_removePlatformFromTestPlan_unknownID(self):
+        with self.assertRaisesRegexp(TLResponseError, '3000.*4711'):
+            self.client.removePlatformFromTestPlan(4711, 'Platform 4712')
+            
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']