changed api - createTestProject - link a project with an ITS #69

includes also new api getIssueTrackerSystem

Author: Luiko Czub

Diff for: CHANGES.rst

@@ -5,7 +5,7 @@ TestLink-API-Python-client v0.6.3 - Under Develop
 ------------------------------------------------------------
 support for TL 1.9.15 release
 
-implement 1.9.15 new api interfaces - #54 #67
+implement 1.9.15 new api interfaces - #54 #67 #69
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 new TestlinkAPIGeneric and TestlinkAPIClient api methods
@@ -14,8 +14,9 @@ new TestlinkAPIGeneric and TestlinkAPIClient api methods
   [prefix=<prefix>], [parentid=<parentid>], [testsuitename=<testsuitename>], 
   [details=<details>], [order=<order>], [devKey=<devKey>])
 - getTestSuite(<testsuitename>, <prefix>, [devKey=<devKey>])
-
-implement 1.9.15 changed api interfaces - #68 #70 #72 #71
+- getIssueTrackerSystem(<itsname>, [devKey=<devKey>])
+ 
+implement 1.9.15 changed api interfaces - #68 #70 #72 #71 #69
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 changed TestlinkAPIGeneric and TestlinkAPIClient api methods
@@ -33,6 +34,8 @@ changed TestlinkAPIGeneric and TestlinkAPIClient api methods
   <overwrite> to update linked Test Case Versions
 - createTestCase() is adapted to to support the new optional arguments <status>
   and <estimatedexecduration>
+- createTestProject() is adapted to to support the new optional arguments 
+  <itsname> and <itsenabled> to link a project with an ITS
 
 examples:
 

Diff for: example/TestLinkExample.py

@@ -112,6 +112,7 @@
 
 NEWPROJECT="NEW_PROJECT_API-%s" % myPyVersionShort
 NEWPREFIX="NPROAPI%s" % myPyVersionShort
+ITSNAME="myITS"
 
 # used connection settings
 print(myTestLink.connectionInfo())
@@ -156,12 +157,17 @@
     print("deleteTestProject", response)
 except TLResponseError:
     print("No project with prefix %s exists" % NEWPREFIX)
+    
+# # get IssueTrackerSystem
+# aITS=myTestLink.getIssueTrackerSystem(aITSNAME)
+# print("getIssueTrackerSystem", aITS)    
 
 # Creates the project
 projInfo = 'Example created with Python %s API class %s in TL %s' % \
             ( python_version(), myApiVersion, myTLVersion )
 newProject = myTestLink.createTestProject(NEWPROJECT, NEWPREFIX,
     notes=projInfo, active=1, public=1,
+#    itsname=ITSNAME, itsenabled=1,
     options={'requirementsEnabled' : 0, 'testPriorityEnabled' : 1,
              'automationEnabled' : 1, 'inventoryEnabled' : 0})
 print("createTestProject", newProject)

Diff for: example/TestLinkExampleGenericApi.py

@@ -101,6 +101,7 @@
 
 NEWPROJECT="PROJECT_API_GENERIC-%s" % myPyVersionShort
 NEWPREFIX="GPROAPI%s" % myPyVersionShort
+ITSNAME="myITS"
 
 # used connection settings
 print(myTestLink.connectionInfo())
@@ -146,11 +147,16 @@
 except TLResponseError:
     print("No project with prefix %s exists" % NEWPREFIX)
 
+# # get IssueTrackerSystem
+# aITS=myTestLink.getIssueTrackerSystem(aITSNAME)
+# print("getIssueTrackerSystem", aITS)    
+
 # Creates the project
 projInfo = 'Example created with Python %s API class %s in TL %s' % \
             ( myPyVersion, myApiVersion, myTLVersion )
 newProject = myTestLink.createTestProject(NEWPROJECT, NEWPREFIX, 
     notes=projInfo, active=1, public=1,
+#    itsname=ITSNAME, itsenabled=1,
     options={'requirementsEnabled' : 1, 'testPriorityEnabled' : 1, 
              'automationEnabled' : 1,  'inventoryEnabled' : 1})
 print("createTestProject", newProject)

Diff for: src/testlink/testlinkapigeneric.py

@@ -212,9 +212,32 @@ def getTestSuitesForTestPlan(self):
         
         returns an empty list, if no suite is assigned """
 
+        
+#   /**
+#    * create a test project
+#    * 
+#    * @param struct $args
+#    * @param string $args["devKey"]
+#    * @param string $args["testprojectname"]
+#    * @param string $args["testcaseprefix"]
+#    * @param string $args["notes"] OPTIONAL
+#    * @param map $args["options"] OPTIONAL ALL int treated as boolean
+#    *        keys  requirementsEnabled,testPriorityEnabled,automationEnabled,inventoryEnabled
+#    *
+#    * @param int $args["active"]  OPTIONAL
+#    * @param int $args["public"]  OPTIONAL
+#    * @param string $args["itsname"]  OPTIONAL  
+#    * @param boolean $args["itsEnabled"]  OPTIONAL  
+#    * 
+#    *
+#    * @return mixed $resultInfo
+#    */
+#   public function createTestProject($args)
+        
     @decoApiCallAddDevKey               
     @decoMakerApiCallWithArgs(['testprojectname', 'testcaseprefix'],
-                              ['notes', 'active', 'public', 'options'])
+                              ['notes', 'active', 'public', 'options',
+                               'itsname', 'itsenabled'])
     def createTestProject(self):
         """ Create a test project  
         
@@ -1673,6 +1696,23 @@ def updateTestSuite(self):
         - details       - if defined test suite details will be changed
         - order         - if defined, order inside parent container is changed
         """
+
+#    /**
+#     * Get Issue Tracker System by name
+#     *
+#     * @param struct $args
+#     * @param string $args["devKey"]
+#     * @param string $args["itsname"] ITS name 
+#     * @return mixed $itsObject      
+#     * @access public
+#     */
+#     public function getIssueTrackerSystem($args,$call=null)
+
+    @decoApiCallAddDevKey               
+    @decoMakerApiCallWithArgs(['itsname'], [])
+    def getIssueTrackerSystem(self):
+        """ Get Issue Tracker System by name """
+
 
     #
     #  internal methods for general server calls

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

@@ -719,6 +719,21 @@ def test_whatArgs_addTestCaseToTestPlan(self):
         self.assertIn('executionorder=<executionorder>', argsDescription)
         self.assertIn('urgency=<urgency>', argsDescription)
         self.assertIn('overwrite=<overwrite>', argsDescription)
+               
+    def test_whatArgs_createTestProject(self):
+        argsDescription = self.api.whatArgs('createTestProject')
+        self.assertIn('<testprojectname>,', argsDescription)
+        self.assertIn('<testcaseprefix>,', argsDescription)
+        self.assertIn('notes=<notes>', argsDescription)
+        self.assertIn('active=<active>', argsDescription)
+        self.assertIn('public=<public>', argsDescription)
+        self.assertIn('options=<options>', argsDescription)
+        self.assertIn('itsname=<itsname>', argsDescription)
+        self.assertIn('itsenabled=<itsenabled>', argsDescription)
+
+    def test_whatArgs_getIssueTrackerSystem(self):
+        argsDescription = self.api.whatArgs('getIssueTrackerSystem')
+        self.assertIn('<itsname>,', argsDescription)
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

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

@@ -827,6 +827,21 @@ def test_whatArgs_addTestCaseToTestPlan(self):
         self.assertIn('urgency=<urgency>', argsDescription)
         self.assertIn('overwrite=<overwrite>', argsDescription)
 
+    def test_whatArgs_createTestProject(self):
+        argsDescription = self.api.whatArgs('createTestProject')
+        self.assertIn('<testprojectname>,', argsDescription)
+        self.assertIn('<testcaseprefix>,', argsDescription)
+        self.assertIn('notes=<notes>', argsDescription)
+        self.assertIn('active=<active>', argsDescription)
+        self.assertIn('public=<public>', argsDescription)
+        self.assertIn('options=<options>', argsDescription)
+        self.assertIn('itsname=<itsname>', argsDescription)
+        self.assertIn('itsenabled=<itsenabled>', argsDescription)
+
+    def test_whatArgs_getIssueTrackerSystem(self):
+        argsDescription = self.api.whatArgs('getIssueTrackerSystem')
+        self.assertIn('<itsname>,', argsDescription)
+
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']
     unittest.main()

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

@@ -94,6 +94,11 @@ def test_createTestProject_unknownID(self):
             self.client.createTestProject(testprojectname='', 
                                                  testcaseprefix='P40000711')
 
+    def test_createTestProject_unknownITS(self):
+        with self.assertRaisesRegex(TLResponseError, '13000.*Unable to find'):
+            self.client.createTestProject(testprojectname='aProject', 
+                                testcaseprefix='aPrefix', itsname='unknownITS')
+ 
     def test_getProjects(self):
         response = self.client.getProjects()
         self.assertIsNotNone(response)
@@ -453,6 +458,10 @@ def test_updateTestSuite_unknownID(self):
                                     details = 'detail 40000713 updated',
                                     order =1)
 
+    def test_getIssueTrackerSystem_unknownITS(self):
+        with self.assertRaisesRegex(TLResponseError, '13000.*Unable to find'):
+            self.client.getIssueTrackerSystem('unknownITS')
+ 
 
 
 if __name__ == "__main__":

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

@@ -178,6 +178,11 @@ def test_createTestProject_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '7001.*Empty name'):
             self.client.createTestProject('', 'P40000711')
 
+    def test_createTestProject_unknownITS(self):
+        with self.assertRaisesRegex(TLResponseError, '13000.*Unable to find'):
+            self.client.createTestProject(testprojectname='aProject', 
+                                testcaseprefix='aPrefix', itsname='unknownITS')
+ 
     def test_createBuild_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '3000.*40000711'):
             self.client.createBuild(40000711, 'Build 40000712', 'note 40000713')
@@ -438,6 +443,10 @@ def test_updateTestSuite_unknownID(self):
                                     testsuitename = 'suite 40000712 updated',
                                     details = 'detail 40000713 updated',
                                     order =1)
+            
+    def test_getIssueTrackerSystem_unknownITS(self):
+        with self.assertRaisesRegex(TLResponseError, '13000.*Unable to find'):
+            self.client.getIssueTrackerSystem('unknownITS')
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']