new api - getTestSuiteAttachments #83

Author: Luiko Czub

CHANGES.rst

@@ -5,15 +5,16 @@ TestLink-API-Python-client v0.6.5 (under develop)
 -------------------------------------------------
 support for TL 1.9.17 future release and py27, py34, py35 and py36
 
-implement 1.9.17 new api interfaces - #76, #82
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+implement 1.9.17 new api interfaces - #76, #81, #82, #83
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - getExecutionSet(<testplanid>, [testcaseid=<testcaseid>], [testcaseexternalid=<testcaseexternalid>], 
   [buildid=<buildid>], [buildname=<buildname>], [platformid=<platformid>], 
   [platformname=<platformname>], [options=<options>], [devKey=<devKey>])
 - getRequirements(<testprojectid>, [testplanid=<testplanid>], [platformid=<platformid>], [devKey=<devKey>])
 - getReqCoverage(<testprojectid>, <requirementdocid>, [devKey=<devKey>])
 - setTestCaseTestSuite(<testcaseexternalid>, <testsuiteid>, [devKey=<devKey>])
+- getTestSuiteAttachments(<testsuiteid>, [devKey=<devKey>])
 
 known TL 1.9.17-DEV issues:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

example/TestLinkExample.py

@@ -689,6 +689,10 @@
 newAttachment = myTestLink.uploadTestSuiteAttachment(NEWATTACHMENT_PNG, newTestSuiteID_A, 
             title='PNG Example', description='PNG Attachment Example for a TestSuite')
 print("uploadTestSuiteAttachment", newAttachment)
+# get Attachment of test suite A
+response = myTestLink.getTestSuiteAttachments(newTestSuiteID_A)
+print("getTestSuiteAttachments", response)
+
 # add png file as Attachment to test case B 
 a_file=open(NEWATTACHMENT_PNG, mode='rb')
 newAttachment = myTestLink.uploadTestCaseAttachment(a_file, newTestCaseID_B, 

example/TestLinkExampleGenericApi.py

@@ -695,6 +695,10 @@
 newAttachment = myTestLink.uploadTestSuiteAttachment(NEWATTACHMENT_PNG, newTestSuiteID_A, 
             title='PNG Example', description='PNG Attachment Example for a TestSuite')
 print("uploadTestSuiteAttachment", newAttachment)
+# get Attachment of test suite A
+response = myTestLink.getTestSuiteAttachments(newTestSuiteID_A)
+print("getTestSuiteAttachments", response)
+
 # add png file as Attachment to test case B 
 a_file=open(NEWATTACHMENT_PNG, mode='rb')
 newAttachment = myTestLink.uploadTestCaseAttachment(a_file, newTestCaseID_B, 

src/testlink/testlinkapigeneric.py

@@ -1888,6 +1888,27 @@ def setTestCaseTestSuite(self):
             testsuiteid        - identifies the test suite 
 
         """
+
+#   /**
+#    * Gets attachments for specified test suite.
+#    * The attachment file content is Base64 encoded. To save the file to disk in client,
+#    * Base64 decode the content and write file in binary mode.
+#    *
+#    * @param struct $args
+#    * @param string $args["devKey"] Developer key
+#    * @param int $args["testsuiteid"]: id of the testsuite
+#    *
+#    * @return mixed $resultInfo
+#    * @author dennis@etern-it.de
+#    */
+#   public function getTestSuiteAttachments($args)
+
+    @decoApiCallAddDevKey               
+    @decoMakerApiCallWithArgs(['testsuiteid'], [])
+    def getTestSuiteAttachments(self):
+        """ Gets attachments for specified test suite.
+        The attachment file content is Base64 encoded. To save the file to disk 
+        in client, Base64 decode the content and write file in binary mode.  """
 
     #
     #  internal methods for general server calls

test/utest-offline/testlinkapigeneric_offline_test.py

@@ -923,6 +923,9 @@ def test_whatArgs_setTestCaseTestSuite(self):
         self.assertIn('<testcaseexternalid>,', argsDescription)
         self.assertIn('<testsuiteid>,', argsDescription)
 
+    def test_whatArgs_getTestSuiteAttachments(self):
+        argsDescription = self.api.whatArgs('getTestSuiteAttachments')
+        self.assertIn('<testsuiteid>,', argsDescription)
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']

test/utest-online/testlinkapi_generic_online_test.py

@@ -491,6 +491,10 @@ def test_setTestCaseTestSuite_unknownID(self):
         with self.assertRaisesRegex(TLResponseError, '5040.*TC-40000712'):
             self.client.setTestCaseTestSuite(
                             'TC-40000712', '40000713 suite')
+
+    def test_getTestSuiteAttachments_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '8000.*40000712'):
+            self.client.getTestSuiteAttachments(40000712)
 
 
 if __name__ == "__main__":

test/utest-online/testlinkapi_online_test.py

@@ -478,6 +478,10 @@ def test_setTestCaseTestSuite_unknownID(self):
             self.client.setTestCaseTestSuite(
                             'TC-40000712', '40000713 suite')
 
+    def test_getTestSuiteAttachments_unknownID(self):
+        with self.assertRaisesRegex(TLResponseError, '8000.*40000712'):
+            self.client.getTestSuiteAttachments(40000712)
+         
 
 if __name__ == "__main__":
     #import sys;sys.argv = ['', 'Test.testName']