server call methods shifted to generic API lczub#7

createTestProject, createTestCase, createTestSuite, createTestPlan,
getProject

Author: Luiko Czub

example/TestLinkExample.py

@@ -1,7 +1,7 @@
 #! /usr/bin/python
 # -*- coding: UTF-8 -*-
 
-#  Copyright 2011-2012 Olivier Renault, TestLink-API-Python-client developers
+#  Copyright 2011-2013 Olivier Renault, TestLink-API-Python-client developers
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -45,6 +45,13 @@
                           --------- Test Case B
                                            |   
                                            --- 5 automated test steps
+                                           
+Update 12. Oct. 2013, L. Czub
+Integrates v0.4.5 changes for  optional arguments 
+The v0.4.0 method calls are still visible as comments (look for CHANGE v0.4.5)
+So this file helps to understand where existing own code needs adjustment.
+-  
+used as behaviour is still                                             
 """                                       
 from testlink import TestlinkAPIClient, TestLinkHelper
 import sys
@@ -90,9 +97,16 @@
 print ""
 
 # Creates the project
+
+# -- Start CHANGE v0.4.5 -- 
+# newProject = myTestLink.createTestProject(NEWPROJECT, "NPROAPI",
+# "notes=This is a Project created with the API", "active=1", "public=1",
+# "options=requirementsEnabled:0,testPriorityEnabled:1,automationEnabled:1,inventoryEnabled:0")
 newProject = myTestLink.createTestProject(NEWPROJECT, "NPROAPI",
-"notes=This is a Project created with the API", "active=1", "public=1",
-"options=requirementsEnabled:0,testPriorityEnabled:1,automationEnabled:1,inventoryEnabled:0")
+    notes='This is a Project created with the API', active=1, public=1,
+    options={'requirementsEnabled' : 0, 'testPriorityEnabled' : 1,
+             'automationEnabled' : 1, 'inventoryEnabled' : 0})
+# -- END CHANGE v0.4.5 -- 
 isOk = newProject[0]['message']
 if isOk=="Success!":
   newProjectID = newProject[0]['id'] 
@@ -102,8 +116,12 @@
   sys.exit(-1)
 
 # Creates the test plan
+# -- Start CHANGE v0.4.5 -- 
+# newTestPlan = myTestLink.createTestPlan(NEWTESTPLAN, NEWPROJECT,
+#             "notes=New TestPlan created with the API","active=1", "public=1")    
 newTestPlan = myTestLink.createTestPlan(NEWTESTPLAN, NEWPROJECT,
-            "notes=New TestPlan created with the API","active=1", "public=1")    
+            notes='New TestPlan created with the API',active=1, public=1)    
+# -- END CHANGE v0.4.5 -- 
 isOk = newTestPlan[0]['message']
 if isOk=="Success!":
   newTestPlanID = newTestPlan[0]['id'] 
@@ -137,8 +155,12 @@
   sys.exit(-1)
 
 #Creates the test Suite AA       
+# -- Start CHANGE v0.4.5 -- 
+# newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_AA,
+#             "Details of the Test Suite AA","parentid="+FirstLevelID)               
 newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_AA,
-            "Details of the Test Suite AA","parentid="+FirstLevelID)               
+            "Details of the Test Suite AA",parentid=FirstLevelID)               
+# -- END CHANGE v0.4.5 -- 
 isOk = newTestSuite[0]['message']
 if isOk=="ok":
   TestSuiteID_AA = newTestSuite[0]['id'] 
@@ -157,9 +179,14 @@
 myTestLink.appendStep("Step action 4", "Step result 4", MANUAL)
 myTestLink.appendStep("Step action 5", "Step result 5", MANUAL)
 
+# -- Start CHANGE v0.4.5 -- 
+# newTestCase = myTestLink.createTestCase(NEWTESTCASE_AA, TestSuiteID_AA, 
+#           newProjectID, "admin", "This is the summary of the Test Case AA", 
+#           "preconditions=these are the preconditions")                 
 newTestCase = myTestLink.createTestCase(NEWTESTCASE_AA, TestSuiteID_AA, 
           newProjectID, "admin", "This is the summary of the Test Case AA", 
-          "preconditions=these are the preconditions")                 
+          preconditions='these are the preconditions')                 
+# -- END CHANGE v0.4.5 -- 
 isOk = newTestCase[0]['message']
 if isOk=="Success!":
   newTestCaseID = newTestCase[0]['id'] 
@@ -175,10 +202,15 @@
 myTestLink.appendStep("Step action 4", "Step result 4", AUTOMATED)
 myTestLink.appendStep("Step action 5", "Step result 5", AUTOMATED)
 
+# -- Start CHANGE v0.4.5 -- 
+# newTestCase = myTestLink.createTestCase(NEWTESTCASE_B, TestSuiteID_B, 
+#           newProjectID, "admin", "This is the summary of the Test Case B", 
+#           "preconditions=these are the preconditions", 
+#           "executiontype=%i" % AUTOMATED)               
 newTestCase = myTestLink.createTestCase(NEWTESTCASE_B, TestSuiteID_B, 
           newProjectID, "admin", "This is the summary of the Test Case B", 
-          "preconditions=these are the preconditions", 
-          "executiontype=%i" % AUTOMATED)               
+          preconditions='these are the preconditions', executiontype=AUTOMATED)               
+# -- END CHANGE v0.4.5 -- 
 isOk = newTestCase[0]['message']
 if isOk=="Success!":
   newTestCaseID = newTestCase[0]['id'] 

example/TestLinkExampleGenericApi.py

@@ -21,7 +21,7 @@
 """
 
 Shows how to use the TestLinkAPIGeneric.
-- does same steps as Example TestLinkAPI in TestLinkExample.py
+- does equal things as Example TestLinkAPI in TestLinkExample.py
 
 => Counts and lists the Projects 
 => Create a new Project with the following structure:
@@ -81,29 +81,17 @@
     print "Error with the devKey."      
     sys.exit(-1)
 
-# NOT GENERIC
-#print "Number of Projects in TestLink: %s " % (myTestLink.countProjects(),)
-# print ""
-# myTestLink.listProjects()
-# print ""
-# GENERIC
 print "Number of Projects in TestLink: %i " % len(myTestLink.getProjects())
 print ""
 for project in myTestLink.getProjects():
     print "Name: %(name)s ID: %(id)s " % project
 print ""
 
-
 # # Creates the project
-# NOT GENERIC
-# newProject = myTestLink.createTestProject(NEWPROJECT, "NPROAPI",
-# "notes=This is a Project created with the API", "active=1", "public=1",
-# "options=requirementsEnabled:0,testPriorityEnabled:1,automationEnabled:1,inventoryEnabled:0")
-# GENERIC
 newProject = myTestLink.createTestProject(NEWPROJECT, 'GPROAPI', 
     notes='This is a Project created with the Generic API', active=1, public=1,
-    options={ 'requirementsEnabled' : 0, 'testPriorityEnabled' : 1, 
-             'automationEnabled' : 1,  'inventoryEnabled' : 0})
+    options={'requirementsEnabled' : 1, 'testPriorityEnabled' : 1, 
+             'automationEnabled' : 1,  'inventoryEnabled' : 1})
 print(newProject)
 isOk = newProject[0]['message']
 if isOk=="Success!":
@@ -113,98 +101,105 @@
   print "Error creating the project '%s': %s " % (NEWPROJECT,isOk)
   sys.exit(-1)
 
-# # Creates the test plan
-# newTestPlan = myTestLink.createTestPlan(NEWTESTPLAN, NEWPROJECT,
-#             "notes=New TestPlan created with the API","active=1", "public=1")    
-# isOk = newTestPlan[0]['message']
-# if isOk=="Success!":
-#   newTestPlanID = newTestPlan[0]['id'] 
-#   print "New Test Plan '%s' - id: %s" % (NEWTESTPLAN,newTestPlanID)
-# else:
-#   print "Error creating the Test Plan '%s': %s " % (NEWTESTPLAN, isOk)
-#   sys.exit(-1)
-# 
-# #Creates the test Suite A      
-# newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_A,
-#             "Details of the Test Suite A")  
-# isOk = newTestSuite[0]['message']
-# if isOk=="ok":
-#   newTestSuiteID = newTestSuite[0]['id'] 
-#   print "New Test Suite '%s' - id: %s" % (NEWTESTSUITE_A, newTestSuiteID)
-# else:
-#   print "Error creating the Test Suite '%s': %s " % (NEWTESTSUITE_A, isOk)
-#   sys.exit(-1)
-# 
-# FirstLevelID = newTestSuiteID 
-#  
-# #Creates the test Suite B      
-# newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_B,
-#             "Details of the Test Suite B")               
-# isOk = newTestSuite[0]['message']
-# if isOk=="ok":
-#   TestSuiteID_B = newTestSuite[0]['id'] 
-#   print "New Test Suite '%s' - id: %s" % (NEWTESTSUITE_B, TestSuiteID_B)
-# else:
-#   print "Error creating the Test Suite '%s': %s " % (NEWTESTSUITE_B, isOk)
-#   sys.exit(-1)
-# 
-# #Creates the test Suite AA       
-# newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_AA,
-#             "Details of the Test Suite AA","parentid="+FirstLevelID)               
-# isOk = newTestSuite[0]['message']
-# if isOk=="ok":
-#   TestSuiteID_AA = newTestSuite[0]['id'] 
-#   print "New Test Suite '%s' - id: %s" % (NEWTESTSUITE_AA, TestSuiteID_AA)
-# else:
-#   print "Error creating the Test Suite '%s': %s " % (NEWTESTSUITE_AA, isOk)
-#   sys.exit(-1)
-# 
-# MANUAL = 1
-# AUTOMATED = 2
-# 
-# #Creates the test case TC_AA  
-# myTestLink.initStep("Step action 1", "Step result 1", MANUAL)
-# myTestLink.appendStep("Step action 2", "Step result 2", MANUAL)
-# myTestLink.appendStep("Step action 3", "Step result 3", MANUAL)
-# myTestLink.appendStep("Step action 4", "Step result 4", MANUAL)
-# myTestLink.appendStep("Step action 5", "Step result 5", MANUAL)
-#      
-# newTestCase = myTestLink.createTestCase(NEWTESTCASE_AA, TestSuiteID_AA, 
-#           newProjectID, "admin", "This is the summary of the Test Case AA", 
-#           "preconditions=these are the preconditions")                 
-# isOk = newTestCase[0]['message']
-# if isOk=="Success!":
-#   newTestCaseID = newTestCase[0]['id'] 
-#   print "New Test Case '%s' - id: %s" % (NEWTESTCASE_AA, newTestCaseID)
-# else:
-#   print "Error creating the Test Case '%s': %s " % (NEWTESTCASE_AA, isOk)
-#   sys.exit(-1)
-# 
-# #Creates the test case TC_B  
-# myTestLink.initStep("Step action 1", "Step result 1", AUTOMATED)
-# myTestLink.appendStep("Step action 2", "Step result 2", AUTOMATED)
-# myTestLink.appendStep("Step action 3", "Step result 3", AUTOMATED)
-# myTestLink.appendStep("Step action 4", "Step result 4", AUTOMATED)
-# myTestLink.appendStep("Step action 5", "Step result 5", AUTOMATED)
-#      
-# newTestCase = myTestLink.createTestCase(NEWTESTCASE_B, TestSuiteID_B, 
-#           newProjectID, "admin", "This is the summary of the Test Case B", 
-#           "preconditions=these are the preconditions", 
-#           "executiontype=%i" % AUTOMATED)               
-# isOk = newTestCase[0]['message']
-# if isOk=="Success!":
-#   newTestCaseID = newTestCase[0]['id'] 
-#   print "New Test Case '%s' - id: %s" % (NEWTESTCASE_B, newTestCaseID)
-# else:
-#   print "Error creating the Test Case '%s': %s " % (NEWTESTCASE_B, isOk)
-#   sys.exit(-1)
+# Creates the test plan
+newTestPlan = myTestLink.createTestPlan(NEWTESTPLAN, NEWPROJECT,
+            notes='New TestPlan created with the API',active=1, public=1)    
+isOk = newTestPlan[0]['message']
+if isOk=="Success!":
+  newTestPlanID = newTestPlan[0]['id'] 
+  print "New Test Plan '%s' - id: %s" % (NEWTESTPLAN,newTestPlanID)
+else:
+  print "Error creating the Test Plan '%s': %s " % (NEWTESTPLAN, isOk)
+  sys.exit(-1)
+ 
+#Creates the test Suite A      
+newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_A,
+            "Details of the Test Suite A")  
+isOk = newTestSuite[0]['message']
+if isOk=="ok":
+  newTestSuiteID = newTestSuite[0]['id'] 
+  print "New Test Suite '%s' - id: %s" % (NEWTESTSUITE_A, newTestSuiteID)
+else:
+  print "Error creating the Test Suite '%s': %s " % (NEWTESTSUITE_A, isOk)
+  sys.exit(-1)
+ 
+FirstLevelID = newTestSuiteID 
+  
+#Creates the test Suite B      
+newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_B,
+            "Details of the Test Suite B")               
+isOk = newTestSuite[0]['message']
+if isOk=="ok":
+  TestSuiteID_B = newTestSuite[0]['id'] 
+  print "New Test Suite '%s' - id: %s" % (NEWTESTSUITE_B, TestSuiteID_B)
+else:
+  print "Error creating the Test Suite '%s': %s " % (NEWTESTSUITE_B, isOk)
+  sys.exit(-1)
+ 
+#Creates the test Suite AA       
+newTestSuite = myTestLink.createTestSuite(newProjectID, NEWTESTSUITE_AA,
+            "Details of the Test Suite AA",parentid=FirstLevelID)               
+isOk = newTestSuite[0]['message']
+if isOk=="ok":
+  TestSuiteID_AA = newTestSuite[0]['id'] 
+  print "New Test Suite '%s' - id: %s" % (NEWTESTSUITE_AA, TestSuiteID_AA)
+else:
+  print "Error creating the Test Suite '%s': %s " % (NEWTESTSUITE_AA, isOk)
+  sys.exit(-1)
+ 
+MANUAL = 1
+AUTOMATED = 2
 # 
+# #Creates the test case TC_AA
+steps_tc_aa = [
+        {'step_number' : 1, 'actions' : "Step action 1 - aa" , 
+         'expected_results' : "Step result 1 - aa", 'execution_type' : MANUAL},
+        {'step_number' : 2, 'actions' : "Step action 2 - aa" , 
+         'expected_results' : "Step result 2 - aa", 'execution_type' : MANUAL},
+        {'step_number' : 3, 'actions' : "Step action 3 - aa" , 
+         'expected_results' : "Step result 3 - aa", 'execution_type' : MANUAL},
+        {'step_number' : 4, 'actions' : "Step action 4 - aa" , 
+         'expected_results' : "Step result 4 - aa", 'execution_type' : MANUAL},
+        {'step_number' : 5, 'actions' : "Step action 5 - aa" , 
+         'expected_results' : "Step result 5 - aa", 'execution_type' : MANUAL}
+               ]  
+newTestCase = myTestLink.createTestCase(NEWTESTCASE_AA, TestSuiteID_AA, 
+          newProjectID, "admin", "This is the summary of the Test Case AA", 
+          steps_tc_aa, preconditions='these are the preconditions')                 
+isOk = newTestCase[0]['message']
+if isOk=="Success!":
+  newTestCaseID = newTestCase[0]['id'] 
+  print "New Test Case '%s' - id: %s" % (NEWTESTCASE_AA, newTestCaseID)
+else:
+  print "Error creating the Test Case '%s': %s " % (NEWTESTCASE_AA, isOk)
+  sys.exit(-1)
+ 
+#Creates the test case TC_B 
+steps_tc_b = [
+        {'step_number' : 1, 'actions' : "Step action 1 -b " , 
+         'expected_results' : "Step result 1 - b", 'execution_type' : AUTOMATED},
+        {'step_number' : 2, 'actions' : "Step action 2 -b " , 
+         'expected_results' : "Step result 2 - b", 'execution_type' : AUTOMATED},
+        {'step_number' : 3, 'actions' : "Step action 3 -b " , 
+         'expected_results' : "Step result 3 - b", 'execution_type' : AUTOMATED},
+        {'step_number' : 4, 'actions' : "Step action 4 -b " , 
+         'expected_results' : "Step result 4 - b", 'execution_type' : AUTOMATED},
+        {'step_number' : 5, 'actions' : "Step action 5 -b " , 
+         'expected_results' : "Step result 5 - b", 'execution_type' : AUTOMATED}]
+      
+newTestCase = myTestLink.createTestCase(NEWTESTCASE_B, TestSuiteID_B, 
+          newProjectID, "admin", "This is the summary of the Test Case B", 
+          steps_tc_b, preconditions='these are the preconditions', 
+          executiontype=AUTOMATED)               
+isOk = newTestCase[0]['message']
+if isOk=="Success!":
+  newTestCaseID = newTestCase[0]['id'] 
+  print "New Test Case '%s' - id: %s" % (NEWTESTCASE_B, newTestCaseID)
+else:
+  print "Error creating the Test Case '%s': %s " % (NEWTESTCASE_B, isOk)
+  sys.exit(-1)
+ 
 print ""
-# NOT GENERIC
-# print "Number of Projects in TestLink: %s " % (myTestLink.countProjects(),)
-# print ""
-# myTestLink.listProjects()
-# GENERIC
 print "Number of Projects in TestLink: %i " % len(myTestLink.getProjects())
 print ""
 for project in myTestLink.getProjects():