server call methods shifted to generic API lczub#7

uploadExecutionAttachment

Author: Luiko Czub

MANIFEST.in

@@ -1,4 +1,5 @@
 include MANIFEST.in LICENSE-2.0.txt README.md
 recursive-include src *.py
 recursive-include example *.py
+recursive-include example *.png
 recursive-include test *.py

example/PyGreat.png

@@ -1,7 +1,5 @@
 #! /usr/bin/python
 # -*- coding: UTF-8 -*-
-from compiler.pycodegen import TRY_FINALLY
-from symbol import except_clause
 
 #  Copyright 2011-2013 Olivier Renault, TestLink-API-Python-client developers
 #
@@ -57,7 +55,7 @@
 """                                       
 from testlink import TestlinkAPIClient, TestLinkHelper
 from testlink.testlinkerrors import TLResponseError
-import sys
+import sys, os.path
 
 # precondition a)
 # SERVER_URL and KEY are defined in environment
@@ -92,6 +90,10 @@
 NEWTESTCASE_B="TESTCASE_B"
 NEWBUILD="Build v0.4.5"
 
+NEWATTACHMENT_PY= os.path.realpath(__file__)
+this_file_dirname=os.path.dirname(NEWATTACHMENT_PY)
+NEWATTACHMENT_PNG=os.path.join(this_file_dirname, 'PyGreat.png')
+
 # -- Start CHANGE v0.4.5 -- 
 # if myTestLink.checkDevKey() != True:
 #     print "Error with the devKey."      
@@ -286,10 +288,27 @@
 newResult = myTestLink.reportTCResult(None, newTestPlanID, None, 'f', '', guess=True,
                                       testcaseexternalid=tc_aa_full_ext_id)
 print newResult
+newResultID_AA = newResult[0]['id']
 # TC_B passed, explicit build and some notes , TC identified with internal id
 newResult = myTestLink.reportTCResult(newTestCaseID_B, newTestPlanID, NEWBUILD,
                                       'p', 'first try')
-print newResult  
+print newResult 
+newResultID_B = newResult[0]['id']
+
+# add this (text) file as Attachemnt to last execution of TC_B  with 
+# different filename 'MyPyExampleApiClient.py'
+a_file=open(NEWATTACHMENT_PY)
+newAttachment = myTestLink.uploadExecutionAttachment(a_file, newResultID_B, 
+            'Textfile Example', 'Text Attachment Example for a TestCase',
+            filename='MyPyExampleApiClient.py')
+print newAttachment
+# add png file as Attachemnt to last execution of TC_AA
+# !Attention - on WINDOWS use binary mode for none text file
+# see http://docs.python.org/2/tutorial/inputoutput.html#reading-and-writing-files
+a_file=open(NEWATTACHMENT_PNG, mode='rb')
+newAttachment = myTestLink.uploadExecutionAttachment(a_file, newResultID_AA, 
+            'PNG Example', 'PNG Attachment Example for a TestCase')
+print newAttachment
 
 print ""
 print "Number of Projects in TestLink: %s " % (myTestLink.countProjects(),)

example/TestLinkExample.py

@@ -44,7 +44,8 @@
                                            --- 5 automated test steps
 """                                       
 from testlink import TestlinkAPIGeneric, TestLinkHelper
-import sys
+from testlink.testlinkerrors import TLResponseError
+import sys, os.path
 
 # precondition a)
 # SERVER_URL and KEY are defined in environment
@@ -79,6 +80,10 @@
 NEWTESTCASE_B="TESTCASE_B"
 NEWBUILD="Build v0.4.5"
 
+NEWATTACHMENT_PY= os.path.realpath(__file__)
+this_file_dirname=os.path.dirname(NEWATTACHMENT_PY)
+NEWATTACHMENT_PNG=os.path.join(this_file_dirname, 'PyGreat.png')
+
 id_cache={}
 
 # example handling Response Error Codes
@@ -205,11 +210,29 @@
 newResult = myTestLink.reportTCResult(id_cache[NEWTESTPLAN], 'f', guess=True,
                                       testcaseexternalid=tc_aa_full_ext_id)
 print newResult
+newResultID_AA = newResult[0]['id']
 # TC_B passed, explicit build and some notes , TC identified with internal id
 newResult = myTestLink.reportTCResult(id_cache[NEWTESTPLAN], 'p', 
                 buildid=id_cache[NEWBUILD], testcaseid=id_cache[NEWTESTCASE_B], 
                 notes="first try")
 print newResult
+newResultID_B = newResult[0]['id']
+
+# add this python file as Attachemnt to last execution of TC_B with 
+# different filename 'MyPyExampleApiGeneric.py'
+a_file=open(NEWATTACHMENT_PY)
+newAttachment = myTestLink.uploadExecutionAttachment(a_file, newResultID_B, 
+        title='Textfile Example', description='Text Attachment Example for a TestCase',
+        filename='MyPyExampleApiGeneric.py')
+print newAttachment
+# add png file as Attachemnt to last execution of TC_AA
+# !Attention - on WINDOWS use binary mode for none text file
+# see http://docs.python.org/2/tutorial/inputoutput.html#reading-and-writing-files
+a_file=open(NEWATTACHMENT_PNG, mode='rb')
+newAttachment = myTestLink.uploadExecutionAttachment(a_file, newResultID_AA, 
+            title='PNG Example', description='PNG Attachment Example for a TestCase')
+print newAttachment
+
 
 print ""
 print "Number of Projects in TestLink: %i " % len(myTestLink.getProjects())

example/TestLinkExampleGenericApi.py

@@ -28,8 +28,17 @@ class TestlinkAPIClient(TestlinkAPIGeneric):
     __slots__ = ['stepsList']
 
     def __init__(self, server_url, devKey):
-        super(TestlinkAPIClient, self).__init__(server_url, devKey,
-                        transport=None, encoding=None, verbose=0, allow_none=1)
+        """ call super for init generell slots, init sepcial slots for teststeps
+            and define special positional arg settings """ 
+        super(TestlinkAPIClient, self).__init__(server_url, devKey, 
+                                                allow_none=1)
+        # allow_none is an argument from xmlrpclib.Server()
+        # with set to True, it is possible to set postional args to None, so 
+        # alternative optional arguments could be set
+        # example - testcaseid is set : 
+        # reportTCResult(None, newTestPlanID, None, 'f', '', guess=True,
+        #                             testcaseexternalid=tc_aa_full_ext_id)
+        # otherwise xmlrpclib raise an error, that None values are not allowed
         self.stepsList = []
         self._changePositionalArgConfig()
 
@@ -49,6 +58,9 @@ def _changePositionalArgConfig(self):
         # reportTCResult
         pos_arg_config['reportTCResult'] = ['testcaseid', 'testplanid', 
                                             'buildname', 'status', 'notes']
+        # uploadExecutionAttachment
+        pos_arg_config['uploadExecutionAttachment'] = ['executionid', 'title', 'description']
+        
     #
     #  BUILT-IN API CALLS
     #
@@ -418,27 +430,27 @@ def createTestCase(self, *argsPositional, **argsOptional):
 
 
 
-    def uploadExecutionAttachment(self,attachmentfile,executionid,title,description):
-        """
-        Attach a file to a test execution
-        attachmentfile: python file descriptor pointing to the file
-        name : name of the file
-        title : title of the attachment
-        description : description of the attachment
-        content type : mimetype of the file
-        """
-        import mimetypes
-        import base64
-        import os.path
-        argsAPI={'devKey' : self.devKey,
-                 'executionid':executionid,
-                 'title':title,
-                 'filename':os.path.basename(attachmentfile.name),
-                 'description':description,
-                 'filetype':mimetypes.guess_type(attachmentfile.name)[0],
-                 'content':base64.encodestring(attachmentfile.read())
-                 }
-        return self._callServer('uploadExecutionAttachment', argsAPI)
+#     def uploadExecutionAttachment(self,attachmentfile,executionid,title,description):
+#         """
+#         Attach a file to a test execution
+#         attachmentfile: python file descriptor pointing to the file
+#         name : name of the file
+#         title : title of the attachment
+#         description : description of the attachment
+#         content type : mimetype of the file
+#         """
+#         import mimetypes
+#         import base64
+#         import os.path
+#         argsAPI={'devKey' : self.devKey,
+#                  'executionid':executionid,
+#                  'title':title,
+#                  'filename':os.path.basename(attachmentfile.name),
+#                  'description':description,
+#                  'filetype':mimetypes.guess_type(attachmentfile.name)[0],
+#                  'content':base64.encodestring(attachmentfile.read())
+#                  }
+#         return self._callServer('uploadExecutionAttachment', argsAPI)
 
     #
     #  ADDITIONNAL FUNCTIONS

src/testlink/testlinkapi.py

@@ -21,7 +21,7 @@
 
 from testlinkhelper import TestLinkHelper, VERSION
 import testlinkerrors
-from compiler.ast import TryExcept
+
 
 
 # Default Definition which (python) API-Method expects which postional arguments
@@ -40,7 +40,8 @@
             'createTestSuite' : ['testprojectid', 'testsuitename', 'details'],
             'doesUserExist' : ['user'],
             'repeat' : ['str'],
-            'reportTCResult' : ['testplanid', 'status']
+            'reportTCResult' : ['testplanid', 'status'],
+            'uploadExecutionAttachment' : ['executionid']
 }
 
 # decorators for generic api calls
@@ -69,15 +70,33 @@ def wrapper(self, *argsPositional, **argsOptional):
         return methodAPI(self, *argsPositional, **argsOptional)
     return wrapper
 
+def decoApiCallAddAttachment(methodAPI):
+    """ Decorator to expand parameter list with devKey and attachmentfile
+        attachmentfile  is a python file descriptor pointing to the file
+    """  
+    def wrapper(self, attachmentfile, *argsPositional, **argsOptional):
+        if not ('devKey' in argsOptional):
+            argsOptional['devKey'] = self.devKey
+        argsAttachment = self._getAttachmentArgs(attachmentfile)
+        # add additional key/value pairs from argsOptional 
+        # although overwrites filename, filetype, content with user definition
+        # if they exist
+        argsAttachment.update(argsOptional)
+        return methodAPI(self, *argsPositional, **argsAttachment)
+    return wrapper
+
 
 class TestlinkAPIGeneric(object):    
 
     __slots__ = ['server', 'devKey', '_server_url', '_positionalArgNames']
 
     __VERSION__ = VERSION
 
-    def __init__(self, server_url, devKey, 
-                 transport=None, encoding=None, verbose=0, allow_none=0):
+    def __init__(self, server_url, devKey, **args):
+        transport=args.get('transport')
+        encoding=args.get('encoding')
+        verbose=args.get('verbose',0)
+        allow_none=args.get('allow_none',0)
         self.server = xmlrpclib.Server(server_url, transport, encoding, 
                                        verbose, allow_none)
         self.devKey = devKey
@@ -692,26 +711,24 @@ def checkDevKey(self):
 #  */
 # public function uploadTestCaseAttachment($args)
 
-# /**
-#  * Uploads an attachment for an execution.
-#  * 
-#  * 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["executionid"] execution ID
-#  * @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
-#  * 
-#  * @since 1.9beta6
-#  * @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 uploadExecutionAttachment($args)
+
+    @decoApiCallAddAttachment            
+    @decoApiCallWithArgs
+    def uploadExecutionAttachment(self):
+        """ uploadExecutionAttachment: Uploads an attachment for an execution
+        mandatory args: attachmentfile
+        positional args: executionid
+        optional args : title, description, filename, filetype, content
+        
+        attachmentfile: python file descriptor pointing to the file
+        !Attention - on WINDOWS use binary mode for none text file
+        see http://docs.python.org/2/tutorial/inputoutput.html#reading-and-writing-files
+        
+        default values for filename, filetype, content are determine from 
+        ATTACHMENTFILE, but user could overwrite it, if they want to store the
+        attachment with a different name 
+        """
+
 
 # /**
 #  * Uploads an attachment for specified table. You must specify the table that 
@@ -1152,6 +1169,19 @@ def _convertPostionalArgs(self, methodName, valueList):
             raise testlinkerrors.TLArgError(new_msg)
         return {nameList[x] : valueList[x] for x in range(len(nameList)) }
 
+    def _getAttachmentArgs(self, attachmentfile):
+        """ returns dictionary with key/value pairs needed, to transfer 
+            ATTACHMENTFILE via the api to into TL
+            ATTACHMENTFILE: python file descriptor pointing to the file """
+        import mimetypes
+        import base64
+        import os.path
+        return {'filename':os.path.basename(attachmentfile.name),
+                'filetype':mimetypes.guess_type(attachmentfile.name)[0],
+                'content':base64.encodestring(attachmentfile.read())
+                }
+
+    
     def _checkResponse(self, response, methodNameAPI, argsOptional):
         """ Checks if RESPONSE is empty or includes Error Messages
             Will raise TLRepsonseError in this case """
@@ -1161,10 +1191,14 @@ def _checkResponse(self, response, methodNameAPI, argsOptional):
                     raise testlinkerrors.TLResponseError(
                                     methodNameAPI, argsOptional,
                                     response[0]['message'], response[0]['code'])
-            except TypeError:
-                # some Response like doesUserExist returns boolean
-                # they are not iterable an will raise an TypeError
-                # - this reponses are ok
+            except (TypeError, KeyError):
+                # if the reponse has not a [{..}] structure, the check
+                #    'code' in response[0]
+                # raise an error. Following causes are ok
+                # TypeError: raised from doesUserExist, cause the postiv 
+                #            response is simply 'True'
+                # KeyError: raise from uploadExecutionAttachment, cause the 
+                #           positiv response is directly a dictionary
                 pass
         else:
             raise testlinkerrors.TLResponseError(methodNameAPI, argsOptional,

src/testlink/testlinkapigeneric.py

@@ -163,6 +163,7 @@ def test_countTestCasesTS(self):
         response = self.api.countTestCasesTS()
         self.assertEqual(0, response)
 
+    @unittest.expectedFailure
     def test_countPlatforms(self):
         self.api.loadScenario(SCENARIO_A)
         response = self.api.countPlatforms()

test/utest/testlinkapi_offline_test.py

@@ -27,7 +27,7 @@
 #                   ok to check every implemented server call one time but not
 #                   to cover all possible responses or argument combinations
 
-import unittest
+import unittest, os.path
 from testlink import TestlinkAPIClient, TestLinkHelper
 from testlink.testlinkerrors import TLResponseError
 
@@ -196,10 +196,11 @@ def test_reportTCResult_unknownID(self):
             self.client.reportTCResult(4711, 4712, 'build 4713', 'p', 
                                               'note 4714')
 
-#    def test_uploadExecutionAttachment_unknownID(self):
-#        response = self.client.uploadExecutionAttachment('file 4711', 4712, 
-#                        'title 4713', 'descr. 4714')
-#        self.assertIn('4711', response[0]['message'])
+    def test_uploadExecutionAttachment_unknownID(self):
+        attachemantFile = open(os.path.realpath(__file__), 'r')
+        with self.assertRaisesRegexp(TLResponseError, '6004.*4712'):
+            self.client.uploadExecutionAttachment(attachemantFile, 4712, 
+                        'title 4713', 'descr. 4714')
 
     def test_getProjectIDByName_unknownID(self):
         response = self.client.getProjectIDByName('project 4711')