changed api getTestCaseAttachments - optional arg version (TL 1.9.19) #119

changed api uploadTestCaseAttachment - mandatory arg version (TL 1.9.20 dev)

Author: Luiko Czub

.travis.yml

@@ -3,6 +3,7 @@ language: python
 python:
   - "2.7"
   - "3.6"
+  - "3.7"
 
   # command to install dependencies
 install:

CHANGES.rst

@@ -1,6 +1,20 @@
 Changes in TestLink-API-Python-client Source Distribution
 =========================================================
 
+TestLink-API-Python-client v0.8.1 - Under Develop 
+------------------------------------------------------------
+support for TL 1.9.19 and TL 1.9.20 (dev) api changes related to test case 
+attachments, which will be stored since TL 1.9.19 with a reference to the 
+test case version instead the test case id .
+
+Parameter <version> is now mandatory for _uploadTestCaseAttachment_ and optional
+ for _getTestCaseAttachments_. 
+ 
+ Cause of the known TL 1.9.19 issue 
+ `TL Mantis Ticket 8658 <http://mantis.testlink.org/view.php?id=8658>`_ it is 
+ recommended to use the TL 1.9.20 development state with github commit 
+ 6a4984164 or later. 
+
 TestLink-API-Python-client v0.8.0 (May. 2018)
 ---------------------------------------------
 support for TL 1.9.17 release and py27, py36

example/TestLinkExample.py

@@ -704,17 +704,6 @@
 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, 
-            title='PNG Example', description='PNG Attachment Example for a TestCase')
-print("uploadTestCaseAttachment", newAttachment)
-# get Attachment of test case B 
-# response = myTestLink.getTestCaseAttachments(testcaseexternalid=tc_aa_full_ext_id)
-# print "getTestCaseAttachments", response
-response = myTestLink.getTestCaseAttachments(testcaseid=newTestCaseID_B)
-print("getTestCaseAttachments", response)
-
 # copy test case - as a new TC version
 print("create new version of TC B")
 response = myTestLink.copyTCnewVersion(newTestCaseID_B, 
@@ -729,6 +718,33 @@
 response = myTestLink.getTestCaseByVersion(newTestCaseID_B)
 print('getTestCaseByVersion vNone', response)
 
+# add png file as Attachment to test case B version 1
+a_file=open(NEWATTACHMENT_PNG, mode='rb')
+newAttachment = myTestLink.uploadTestCaseAttachment(a_file, newTestCaseID_B, 1,
+            title='PNG Example v1', description='PNG Attachment Example for a TestCase v1')
+print("uploadTestCaseAttachment v1", newAttachment)
+# add py file as Attachment to test case B version 2
+a_file=open(NEWATTACHMENT_PY, mode='rb')
+newAttachment = myTestLink.uploadTestCaseAttachment(a_file, newTestCaseID_B, 2,
+            title='Textfile Example v2', description='Text Attachment Example for a TestCase v2')
+print("uploadTestCaseAttachment v2", newAttachment)
+
+# get Attachment of test case B v1
+# response = myTestLink.getTestCaseAttachments(testcaseexternalid=tc_aa_full_ext_id)
+# print "getTestCaseAttachments", response
+response = myTestLink.getTestCaseAttachments(testcaseid=newTestCaseID_B, version=1)
+print("getTestCaseAttachments v1", response)
+
+# get Attachment of test case B - last version
+# response = myTestLink.getTestCaseAttachments(testcaseexternalid=tc_aa_full_ext_id)
+# print "getTestCaseAttachments", response
+response = myTestLink.getTestCaseAttachments(testcaseid=newTestCaseID_B, version=2)
+attachment_id = list(response)[0]
+print("getTestCaseAttachments v2", response[attachment_id]['title'])
+response = myTestLink.getTestCaseAttachments(testcaseid=newTestCaseID_B)
+print("getTestCaseAttachments vNone", response[attachment_id]['name'])
+
+
 # copy test case - as new TC in a different TestSuite
 print("copy TC B as TC BA into Test suite A")
 response = myTestLink.copyTCnewTestCase(newTestCaseID_B, 
@@ -739,6 +755,9 @@
 response = myTestLink.getTestCasesForTestSuite(newTestSuiteID_A, True, 'simple')
 print('getTestCasesForTestSuite A', response)
 
+
+
+
 # sample, how the test plan can be updated to use the new tc version
 # site effect of this step, assigned testers and existing execution results are 
 # not accessible anymore via the TL Web Gui. 

example/TestLinkExampleGenericApi.py

@@ -709,14 +709,16 @@
 
 # add png file as Attachment to test case B 
 a_file=open(NEWATTACHMENT_PNG, mode='rb')
-newAttachment = myTestLink.uploadTestCaseAttachment(a_file, newTestCaseID_B, 
+newAttachment = myTestLink.uploadTestCaseAttachment(a_file, newTestCaseID_B, 1,
             title='PNG Example', description='PNG Attachment Example for a TestCase')
 print("uploadTestCaseAttachment", newAttachment)
 # get Attachment of test case B 
 # response = myTestLink.getTestCaseAttachments(testcaseexternalid=tc_aa_full_ext_id)
 # print "getTestCaseAttachments", response
+response = myTestLink.getTestCaseAttachments(testcaseid=newTestCaseID_B, version=1)
+print("getTestCaseAttachments v1", response)
 response = myTestLink.getTestCaseAttachments(testcaseid=newTestCaseID_B)
-print("getTestCaseAttachments", response)
+print("getTestCaseAttachments vNone", response)
 
 # get requirements for the test project - empty result
 response = myTestLink.getRequirements(newProjectID)

src/testlink/testlinkapigeneric.py

@@ -595,10 +595,40 @@ def assignRequirements(self):
         b) requirements with ID 6735 and 6737 of requirement spec 6733
         """
 
+#     /**
+#      * Gets attachments for specified test case VERSION.
+#      * 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["testcaseid"]:
+#      *            optional, if does not is present
+#      *            testcaseexternalid must be present
+#      *
+#      * @param int $args["version"]:
+#      *            optional, if not present, the latest version will be used
+#      *
+#      * @param int $args["testcaseexternalid"]:
+#      *            optional, if does not is present
+#      *            testcaseid must be present
+#      *
+#      * @return mixed $resultInfo
+#      */
+#     public function getTestCaseAttachments($args) {
+
     @decoApiCallAddDevKey               
-    @decoMakerApiCallWithArgs([], ['testcaseid', 'testcaseexternalid'])
+    @decoMakerApiCallWithArgs([], ['testcaseid', 'version', 
+                                   'testcaseexternalid'])
     def getTestCaseAttachments(self):
         """ Gets attachments for specified test case.
+        
+        args variations: testcaseid - testcaseexternalid
+        
+        version - optional, if not present, the latest test case version 
+                  will be used
+        
         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.  """
 
@@ -808,14 +838,44 @@ def uploadTestSuiteAttachment(self):
         ATTACHMENTFILE, but user could overwrite it, if user want to store the
         attachment with a different name 
         """
+#     /**
+#      * Uploads an attachment for a Test Case.
+#      *
+#      * The attachment content must be Base64 encoded by the client before sending it.
+#      *
+#      * @param struct $args
+#      * @param string $args["devKey"]
+#      *            Developer key
+#      * @param int $args["testcaseid"]
+#      *            Test Case INTERNAL ID
+#      * @param int $args["version"]
+#      *            version number
+#      *
+#      * @param string $args["title"]
+#      *           (Optional) The title of the Attachment
+#      * @param string $args["description"]
+#      *           (Optional) The description of the Attachment
+#      * @param string $args["filename"]
+#      *            The file name of the Attachment(e.g.:notes.txt)
+#      * @param string $args["filetype"]
+#      *            The file type of the Attachment(e.g.: text/plain)
+#      * @param string $args["content"]
+#      *            The content(Base64 encoded) of the Attachment
+#      *
+#      * @return mixed $resultInfo an array containing the fk_id, fk_table, title,
+#      *         description, file_name, file_size and file_type. If any errors occur it
+#      *         returns the erros map.
+#      */
+#     public function uploadTestCaseAttachment($args) {
 
     @decoApiCallAddAttachment            
-    @decoMakerApiCallWithArgs(['testcaseid'], 
+    @decoMakerApiCallWithArgs(['testcaseid', 'version'], 
                     ['title', 'description', 'filename', 'filetype', 'content'])
     def uploadTestCaseAttachment(self):
         """ Uploads an attachment for a Test Case.
         
         testcaseid - Test Case INTERNAL ID
+        version    - Test Case version number
         
         mandatory non api args: attachmentfile
         - python file descriptor pointing to the file

src/testlink/version.py

@@ -17,5 +17,5 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.8.0'
-TL_RELEASE = '1.9.17'
+VERSION = '0.8.1-dev119'
+TL_RELEASE = 'DEV 1.9.20 (github 6a4984164)'

test/utest-offline/test_apiClients_whatArgs.py

@@ -96,7 +96,14 @@ def test_whatArgs_unknownMethods(api_client):
     ('getAllExecutionsResults',['<testplanid>,','testcaseid=<testcaseid>', 
                         'testcaseexternalid=<testcaseexternalid>', 
                         'platformid=<platformid>', 'buildid=<buildid>',
-                        'options=<options>'])
+                        'options=<options>']),
+    ('getTestCaseAttachments',['version=<version>', 
+                               'testcaseexternalid=<testcaseexternalid>']),
+    ('uploadTestCaseAttachment',['<testcaseid>,', '<version>,', 
+                               'title=<title>', 'description=<description>',
+                               'filename=<filename>', 'filetype=<filetype>',
+                               'content=<content>']),
+
     ]
 
 @pytest.mark.parametrize("apiCall, descriptions", 
@@ -108,7 +115,8 @@ def test_whatArgs_apiCall_descriptions_equal_all(api_client, apiCall, descriptio
 
 test_data_apiCall_descriptions_only_generic = [
     ('createTestCase', ['<steps>,']),
-    ('createBuild',['buildnotes=<buildnotes>'])
+    ('createBuild',['buildnotes=<buildnotes>']),
+    ('getTestCaseAttachments',['testcaseid=<testcaseid>'])
     ]
 @pytest.mark.parametrize("apiCall, descriptions", 
                          test_data_apiCall_descriptions_only_generic)     
@@ -119,7 +127,8 @@ def test_whatArgs_apiCall_descriptions_only_generic(api_generic_client, apiCall,
 
 test_data_apiCall_descriptions_only_general = [
     ('createTestCase', ['steps=<steps>']),
-    ('createBuild',['<buildnotes>,'])
+    ('createBuild',['<buildnotes>,']),
+    ('getTestCaseAttachments',['<testcaseid>,'])
     ]
 @pytest.mark.parametrize("apiCall, descriptions", 
                          test_data_apiCall_descriptions_only_general)     

test/utest-online/test_apiCall_equalPositionalArgs.py

@@ -245,7 +245,7 @@ def test_uploadTestSuiteAttachment_unknownID(api_client, attachmentFile):
 
 def test_uploadTestCaseAttachment_unknownID(api_client, attachmentFile):
     with pytest.raises(TLResponseError, match='5000.*testcaseid'):
-        api_client.uploadTestCaseAttachment(attachmentFile, 40000712, 
+        api_client.uploadTestCaseAttachment(attachmentFile, 40000712, 1,
                     title='title 40000713', description='descr. 40000714')
 
 def test_uploadAttachment_unknownID(api_client, attachmentFile):

tox.ini

@@ -4,7 +4,7 @@
 #   TESTLINK_API_PYTHON_DEVKEY and TESTLINK_API_PYTHON_SERVER_URL
 #   with your server settings
 [tox]
-envlist = py27,py36
+envlist = py27,py36,py37
 [testenv]
 deps=pytest
 setenv=