robotframework-robotlog2rqm 1.2.1__py3-none-any.whl → 1.2.3__py3-none-any.whl

RobotLog2RQM/CRQM.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -18,9 +18,9 @@
 # Initialy created by Tran Duy Ngoan(RBVH/ECM11) / January 2021
 #
 # This is CRQMClient class which is used to interact with RQM via RQM REST APIs
-#  
+#
 # History:
-# 
+#
 # 2020-01-08:
 #  - initial version
 #
@@ -41,7 +41,7 @@ requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
 #
 #  helper functions for processing xml data
 #
-######################################################################## 
+########################################################################
 
 def get_xml_tree(file_name, bdtd_validation=True):
    """
@@ -81,7 +81,7 @@ Parse xml object from file.
 #
 #  IBM Rational Quality Manager
 #
-########################################################################### 
+###########################################################################
 class CRQMClient():
    """
 CRQMClient class uses RQM REST APIs to get, create and update resources
@@ -99,13 +99,13 @@ Resoure type mapping:
 * executionworkitem:    Test Execution Record (TCER)
 * executionresult:      Execution Result
    """
-   RESULT_STATES = ['paused', 'inprogress', 'notrun', 'passed', 'incomplete', 
-                    'inconclusive', 'part_blocked', 'failed', 'error', 
+   RESULT_STATES = ['paused', 'inprogress', 'notrun', 'passed', 'incomplete',
+                    'inconclusive', 'part_blocked', 'failed', 'error',
                     'blocked', 'perm_failed', 'deferred']
 
    # This namespace definition is used when update resource because the namespace
    # definition is response(get from ETM) maybe different with the using template.
-   # There is a deviation in namespace definition between IBM Rational Quality 
+   # There is a deviation in namespace definition between IBM Rational Quality
    # Manager(RQM) v6 and IBM Engineering Test Management (ETM) v7.
    # (from ns1->ns7, only change values within ns order, no new definition).
    NAMESPACES = {
@@ -146,27 +146,27 @@ Constructor of class ``CRQMClient``.
    / *Condition*: required / *Type*: str /
 
    User password for RQM's authentication.
-   
+
 *  ``project``
 
    / *Condition*: required / *Type*: str /
 
    The RQM project name.
-   
+
 *  ``host``
 
    / *Condition*: required / *Type*: str /
 
    The url that RQM is hosted.
       """
-      # RQM authentication 
+      # RQM authentication
       self.host    = host
       self.userID  = user
       self.pw      = password
       self.projectname = project
       self.projectID = urllib.parse.quote_plus(project) # encode URI for project name
       self.session = requests.Session()
-
+      self.session.auth = (self.userID, self.pw)
       # Required request headers for creating new resource
       self.headers = {
                         'Accept'             : 'application/xml',
@@ -214,12 +214,15 @@ Log in RQM by provided user & password.
    Indicates if the computation of the method ``login`` was successful or not.
       """
       bSuccess = False
-      res = self.session.post(self.host + '/qm/j_security_check', allow_redirects=True, verify=False, 
+      # from requests_kerberos import HTTPKerberosAuth, OPTIONAL
+      # kerberos_auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL)
+      # self.session.auth = (self.userID, self.pw)
+      res = self.session.post(self.host + '/qm/j_security_check', allow_redirects=True, verify=False,
                               data={'j_username':self.userID,'j_password':self.pw})
       if res.status_code == 200:
          # verify login
          if self.verifyProjectName():
-            # When the authentication is successful, the JSESSIONID from cookies will 
+            # When the authentication is successful, the JSESSIONID from cookies will
             # be stored as header for later POST method.
             try:
                self.headers['X-Jazz-CSRF-Prevent'] = self.session.cookies['JSESSIONID']
@@ -229,7 +232,7 @@ Log in RQM by provided user & password.
       return bSuccess
 
    def verifyProjectName(self):
-      """ 
+      """
 Verify the project name by searching it in `project-areas` XML response.
 
 **Arguments:**
@@ -249,7 +252,7 @@ Verify the project name by searching it in `project-areas` XML response.
       # The found project ID will be stored and:
       #    - required for `team-areas` request (project name cannot be used)
       #    - used for all later request urls instead of project name
-      resProjects = self.session.get(self.host + '/qm/process/project-areas', 
+      resProjects = self.session.get(self.host + '/qm/process/project-areas',
                                        allow_redirects=True, verify=False)
       if resProjects.status_code == 200:
          oProjects=get_xml_tree(BytesIO(str(resProjects.text).encode()),
@@ -265,7 +268,7 @@ Verify the project name by searching it in `project-areas` XML response.
       if not bSuccess:
          raise Exception(f"Could not find project with name '{self.projectname}'")
 
-      return bSuccess   
+      return bSuccess
 
    def disconnect(self):
       """
@@ -281,7 +284,7 @@ Disconnect from RQM.
       """
       self.session.close()
 
-   def config(self, plan_id, build_name=None, config_name=None, 
+   def config(self, plan_id, build_name=None, config_name=None,
               createmissing=False, updatetestcase=False,suite_id=None):
       """
 Configure RQMClient with testplan ID, build, configuration, createmissing, ...
@@ -300,7 +303,7 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
 *  ``build_name``
 
-   / *Condition*: optional / *Type*: str / *Default*: None / 
+   / *Condition*: optional / *Type*: str / *Default*: None /
 
    The `Build Record` for linking result(s).
    Set it to `None` if not be used, the empty name '' will lead to error.
@@ -315,13 +318,13 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 *  ``createmissing``
 
    / *Condition*: optional / *Type*: bool / *Default*: False /
-   
+
    If `True`, the testcase without `tcid` information will be created on RQM.
 
 *  ``updatetestcase``
 
    / *Condition*: optional / *Type*: bool / *Default*: False /
-   
+
    If `True`, the information of testcase on RQM will be updated bases on robot testfile.
 
 *  ``suite_id (optional)``
@@ -391,7 +394,7 @@ Return interaction URL of provided userID
 *  ``userURL``
 
    / *Type*: str /
-   
+
    The interaction URL of provided userID.
       """
       userURL = self.host + "/jts/resource/itemName/com.ibm.team.repository.Contributor/" + userID
@@ -419,7 +422,7 @@ The provided ID can be internalID (contains only digits) or externalID.
    * If given: the specified url to resource ID is returned.
    * If ``None``: the url to resource type (to get all entity) is returned.
 
-*  ``forceinternalID`` 
+*  ``forceinternalID``
 
    / *Condition*: optional / *Type*: bool / *Default*: False /
 
@@ -434,14 +437,14 @@ The provided ID can be internalID (contains only digits) or externalID.
    The interaction URL of provided reource and ID.
       """
       integrationURL = self.host + "/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/" + \
-                       self.projectID + '/' + resourceType 
+                       self.projectID + '/' + resourceType
       if(id != None):
          ### externalID
          if (not str(id).isdigit()) and (not forceinternalID):
-            integrationURL += '/'+ str(id)  
+            integrationURL += '/'+ str(id)
          else:
             ### internalID
-            integrationURL += "/urn:com.ibm.rqm:" + resourceType + ':' + str(id)  
+            integrationURL += "/urn:com.ibm.rqm:" + resourceType + ':' + str(id)
       return integrationURL
 
    def webIDfromResponse(self, response, tagID='rqm:resultId'):
@@ -470,7 +473,7 @@ Note:
 *  ``resultId``
 
    / *Type*: str /
-   
+
    The internal ID (as number).
       """
       resultId = ''
@@ -511,22 +514,22 @@ Note:
 *  ``webID``
 
    / *Type*: str /
-   
+
    The web ID (as number).
       """
       webID = generateID
       # below resources that have ns2:webId node in response data
-      lSupportedResources = [ 'attachment', 
-                              'executionresult', 
-                              'executionscript', 
-                              'executionworkitem', 
-                              'keyword', 
-                              'remotescript', 
-                              'suiteexecutionrecord', 
-                              'testcase', 
-                              'testplan', 
-                              'testscript', 
-                              'testsuite', 
+      lSupportedResources = [ 'attachment',
+                              'executionresult',
+                              'executionscript',
+                              'executionworkitem',
+                              'keyword',
+                              'remotescript',
+                              'suiteexecutionrecord',
+                              'testcase',
+                              'testplan',
+                              'testscript',
+                              'testsuite',
                               'testsuitelog']
       if resourrceType in lSupportedResources:
          resResource = self.getResourceByID(resourrceType, generateID)
@@ -558,7 +561,7 @@ Return data of provided resource and ID by GET method
 
 *  ``id``
 
-   / *Condition*: required / *Type*: str /      
+   / *Condition*: required / *Type*: str /
 
    ID of resource.
 
@@ -570,7 +573,7 @@ Return data of provided resource and ID by GET method
 
    Response data of GET request.
       """
-      res = self.session.get(self.integrationURL(resourceType, id), 
+      res = self.session.get(self.integrationURL(resourceType, id),
                              allow_redirects=True, verify=False)
       return res
 
@@ -599,14 +602,14 @@ Return all entries (in all pages) of provided resource by GET method.
    .. code:: python
 
       {
-         'success' : False, 
+         'success' : False,
          'message' : '',
          'data'    : {}
       }
 
       """
       dReturn = {
-         'success' : False, 
+         'success' : False,
          'message' : '',
          'data'    : {}
       }
@@ -622,7 +625,7 @@ Return all entries (in all pages) of provided resource by GET method.
             sEntryID = (sURLID.split("/")[-1]).split(":")[-1]
             sEntryName = oEntry.find("./title", nsmap).text
             dReturn['data'][sEntryID] = sEntryName
-         
+
          # Try to get data from next page
          oNextPage = oResData.find('./link[@rel="next"]', nsmap)
          if oNextPage != None:
@@ -679,7 +682,7 @@ Get all available configurations of project on RQM and store them into `dConfigu
       """
 Get all available team-areas of project on RQM and store them into `dTeamAreas` property.
 
-Example: 
+Example:
 
 .. code:: python
 
@@ -708,7 +711,7 @@ Example:
             self.dTeamAreas[sTeamName] = sTeamURL
       else:
          raise Exception(f"Could not get 'team-areas' of project '{self.projectname}'.")
-   
+
 
    #
    #  Methods to create XML template for resources
@@ -718,7 +721,7 @@ Example:
       """
 Append `team-area` node which contains URL to given team-area into xml template.
 
-Note: 
+Note:
    `team-area` information is case-casesensitive
 
 **Arguments:**
@@ -754,8 +757,8 @@ Note:
 
       return root
 
-   def createTestcaseTemplate(self, testcaseName, sDescription='', 
-                              sComponent='', sFID='', sTeam='', sRobotFile='', 
+   def createTestcaseTemplate(self, testcaseName, sDescription='',
+                              sComponent='', sFID='', sTeam='', sRobotFile='',
                               sTestType='', sASIL='', sOwnerID='', sTCtemplate=None):
       """
 Return testcase template from provided information.
@@ -801,25 +804,25 @@ Return testcase template from provided information.
 *  ``sTestType``
 
    / *Condition*: optional / *Type*: str / *Default*: '' /
-   
+
    Test type information.
 
 *  ``sASIL``
 
    / *Condition*: optional / *Type*: str / *Default*: '' /
-   
+
    ASIL information.
 
 *  ``sOwnerID``
 
    / *Condition*: optional / *Type*: str / *Default*: '' /
-   
+
    User ID of testcase owner.
 
 *  ``sTCtemplate``
 
    / *Condition*: optional / *Type*: str / *Default*: None /
-   
+
    Existing testcase template as xml string.
 
    If not provided, template file under `RQM_templates` is used as default.
@@ -844,11 +847,11 @@ Return testcase template from provided information.
       # prepare required data for template
       testcaseTittle  = testcaseName
 
-      # find nodes to change data 
+      # find nodes to change data
       oTittle      = oTree.find(f'{{{self.NAMESPACES["ns3"]}}}title')
       oDescription = oTree.find(f'{{{self.NAMESPACES["ns3"]}}}description')
       oOwner       = oTree.find(f'{{{self.NAMESPACES["ns5"]}}}owner')
-      
+
       # change nodes's data
       oTittle.text       = testcaseTittle
       oDescription.text  = sDescription
@@ -879,7 +882,7 @@ Return testcase template from provided information.
 
       oASIL = oTree.find(f'{{{self.NAMESPACES["ns2"]}}}category[@term="ASIL relevant"]', nsmap)
       if (oASIL != None) and sASIL:
-         oASIL.set('value', sASIL) 
+         oASIL.set('value', sASIL)
 
       # Modify custom attributes
       oRequirementID = oTree.find(f'{{{self.NAMESPACES["ns2"]}}}customAttributes/{{{self.NAMESPACES["ns2"]}}}customAttribute/[{{{self.NAMESPACES["ns2"]}}}name="Requirement ID"]', nsmap)
@@ -920,7 +923,7 @@ Return testcase execution record template from provided information.
 *  ``testplanID``
 
    / *Condition*: required / *Type*: str /
-   
+
    Testplan ID for linking.
 
 *  ``confID``
@@ -932,13 +935,13 @@ Return testcase execution record template from provided information.
 *  ``sTeam``
 
    / *Condition*: optional / *Type*: str / *Default*: '' /
-   
+
    Team name for linking.
 
 *  ``sOwnerID``
 
    / *Condition*: optional / *Type*: str / *Default*: '' /
-   
+
    User ID of testcase owner.
 
 **Returns:**
@@ -962,7 +965,7 @@ Return testcase execution record template from provided information.
       testplanURL = self.integrationURL('testplan', testplanID)
       testerURL   = self.userURL(self.userID)
 
-      # find nodes to change data 
+      # find nodes to change data
       oTittle   = oTree.find('ns3:title', nsmap)
       oTestcase = oTree.find('ns2:testcase', nsmap)
       oTestplan = oTree.find('ns2:testplan', nsmap)
@@ -994,8 +997,8 @@ Return testcase execution record template from provided information.
       sTCERxml = etree.tostring(oTree)
       return sTCERxml
 
-   def createExecutionResultTemplate(self, testcaseID, testcaseName, testplanID, 
-         TCERID, resultState, startTime='', endTime='', duration='',  testPC='', 
+   def createExecutionResultTemplate(self, testcaseID, testcaseName, testplanID,
+         TCERID, resultState, startTime='', endTime='', duration='',  testPC='',
          testBy='', lastlog='', buildrecordID='', sTeam='', sOwnerID=''):
       """
 Return testcase execution result template from provided information.
@@ -1107,7 +1110,7 @@ Return testcase execution result template from provided information.
       TCERURL      = self.integrationURL('executionworkitem', TCERID)
       testerURL    = self.userURL(self.userID)
 
-      # find nodes to change data 
+      # find nodes to change data
       oTittle      = oTree.find('ns3:title', nsmap)
       oMachine     = oTree.find('ns16:machine', nsmap)
       oState       = oTree.find('ns5:state', nsmap)
@@ -1137,9 +1140,9 @@ Return testcase execution result template from provided information.
          oOwner.attrib['{%s}resource' % nsmap['ns7']] = self.userURL(sOwnerID)
       elif oOwner.text == None or oOwner.text == '':
          oOwner.text = self.userID
-         oOwner.attrib['{%s}resource' % nsmap['ns7']] = testerURL 
+         oOwner.attrib['{%s}resource' % nsmap['ns7']] = testerURL
       # currently assign user name is not worked
-      # oTester.text             = testBy 
+      # oTester.text             = testBy
       oTester.text             = self.userID
       oTester.attrib['{%s}resource' % nsmap['ns7']] = testerURL
       oStarttime.text          = str(startTime).replace(' ', 'T')
@@ -1180,7 +1183,7 @@ Return build record template from provided build name.
 *  ``buildName``
 
    / *Condition*: required / *Type*: str /
-   
+
    `Build Record` name.
 
 **Returns:**
@@ -1211,7 +1214,7 @@ Return configuration - Test Environment template from provided configuration nam
 *  ``buildName``
 
    / *Condition*: required / *Type*: str /
-   
+
    Configuration - `Test Environment` name.
 
 **Returns:**
@@ -1219,9 +1222,9 @@ Return configuration - Test Environment template from provided configuration nam
 *  ``sEnvironmentxml``
 
    / *Type*: str /
-   
+
    The xml test environment template as string.
-      """      
+      """
       sEnvironmentxml = ''
       sTemplatePath = os.path.join(self.templatesDir, 'configuration.xml')
       oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
@@ -1233,7 +1236,7 @@ Return configuration - Test Environment template from provided configuration nam
       sEnvironmentxml = etree.tostring(oTree)
       return sEnvironmentxml
 
-   def createTSERTemplate(self, testsuiteID, testsuiteName, testplanID, 
+   def createTSERTemplate(self, testsuiteID, testsuiteName, testplanID,
                           confID='', sOwnerID=''):
       """
 Return testsuite execution record (TSER) template from provided configuration name.
@@ -1277,9 +1280,9 @@ Return testsuite execution record (TSER) template from provided configuration na
    / *Type*: str /
 
    The xml testsuite template as string.
-      """  
+      """
       sTSxml = ''
-      sTemplatePath = os.path.join(self.templatesDir, 
+      sTemplatePath = os.path.join(self.templatesDir,
                                    'suiteexecutionrecord.xml')
       oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
       root = oTree.getroot()
@@ -1289,7 +1292,7 @@ Return testsuite execution record (TSER) template from provided configuration na
       testplanURL  = self.integrationURL('testplan', testplanID)
       testerURL    = self.userURL(self.userID)
 
-      # find nodes to change data 
+      # find nodes to change data
       nsmap      = oTree.getroot().nsmap
       oTittle    = oTree.find('ns4:title', nsmap)
       oTestsuite = oTree.find('ns2:testsuite', nsmap)
@@ -1300,7 +1303,7 @@ Return testsuite execution record (TSER) template from provided configuration na
       oTittle.text              = TSERTittle
       oTestsuite.attrib['href'] = testsuiteURL
       oTestplan.attrib['href']  = testplanURL
-      # Incase not specify owner in template or input data, 
+      # Incase not specify owner in template or input data,
       # set its value as provided user in cli
       if sOwnerID:
          oOwner.text = sOwnerID
@@ -1319,8 +1322,8 @@ Return testsuite execution record (TSER) template from provided configuration na
       sTSxml = etree.tostring(oTree)
       return sTSxml
 
-   def createTestsuiteResultTemplate(self, testsuiteID, testsuiteName, TSERID, 
-                                     lTCER, lTCResults, startTime='', 
+   def createTestsuiteResultTemplate(self, testsuiteID, testsuiteName, TSERID,
+                                     lTCER, lTCResults, startTime='',
                                      endTime='', duration='', sOwnerID=''):
       """
 Return testsuite execution result template from provided configuration name.
@@ -1388,7 +1391,7 @@ Return testsuite execution result template from provided configuration name.
    / *Type*: str /
 
    The xml testsuite result template as string.
-      """  
+      """
       sTSResultxml = ''
       sTemplatePath = os.path.join(self.templatesDir, 'testsuitelog.xml')
       oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
@@ -1405,7 +1408,7 @@ Return testsuite execution result template from provided configuration name.
       if duration == '':
          duration = (time.mktime(endTime.timetuple()) - time.mktime(startTime.timetuple()))*1000
 
-      # find nodes to change data 
+      # find nodes to change data
       root         = oTree.getroot()
       nsmap        = root.nsmap
       oTittle      = oTree.find('ns4:title', nsmap)
@@ -1424,7 +1427,7 @@ Return testsuite execution result template from provided configuration name.
       oTittle.text = resultTittle
       oTestsuite.attrib['href'] = testsuiteURL
       oTSER.attrib['href']      = TSERURL
-      # Incase not specify owner in template or input data, 
+      # Incase not specify owner in template or input data,
       # set its value as provided user in cli
       if sOwnerID:
          oOwner.text = sOwnerID
@@ -1451,7 +1454,7 @@ Return testsuite execution result template from provided configuration name.
          sTCResultURL = self.integrationURL('executionresult', lTCResults[idx])
          oExecutionResult.set('href', sTCResultURL)
          root.append(oExecutionResult)
-         
+
       # return xml template as string
       sTSResultxml = etree.tostring(oTree)
       return sTSResultxml
@@ -1491,25 +1494,25 @@ Create new resource with provided data from template by POST method.
    .. code:: python
 
       {
-         'success' : False, 
-         'id': None, 
-         'message': '', 
+         'success' : False,
+         'id': None,
+         'message': '',
          'status_code': ''
       }
 
       """
       returnObj = {
-         'success' : False, 
-         'id': None, 
-         'message': '', 
+         'success' : False,
+         'id': None,
+         'message': '',
          'status_code': ''
       }
       if(self.headers['X-Jazz-CSRF-Prevent'] == ''):
          returnObj['message'] = "JSESSIONID is missing for RQM resource's creation"
          return returnObj
 
-      res = self.session.post(self.integrationURL(resourceType), 
-                              allow_redirects=True, verify=False, 
+      res = self.session.post(self.integrationURL(resourceType),
+                              allow_redirects=True, verify=False,
                               data=content, headers=self.headers)
       returnObj['status_code'] = res.status_code
       # Check whether successful response
@@ -1521,7 +1524,7 @@ Create new resource with provided data from template by POST method.
             returnObj['id'] = res.headers['Content-Location'].replace(sRemove, '')
 
          # On IBM Engineering Test Management Version: 7.0.2
-         # When trying to create new TCER but it is existing for testcase and testplan, 
+         # When trying to create new TCER but it is existing for testcase and testplan,
          # the response is 200 instead of 303 as previous RQM version 6.x.x
          # Below step is trying to get existing TCER ID from response <200>
          elif res.status_code == 200 and res.text:
@@ -1531,11 +1534,11 @@ Create new resource with provided data from template by POST method.
                returnObj['message'] = "Extract ID information from response failed. Reason: %s" % str(error)
       else:
          ### Get new creation ID from response
-         try: 
+         try:
             # try to get the web ID (internalID) from response of POST method
             if res.text and (res.text != ''):
                returnObj['id'] = self.webIDfromResponse(res.text)
-            # The externalID of new resource is responsed in 'Content-Location' 
+            # The externalID of new resource is responsed in 'Content-Location'
             # from response headers
             elif res.headers['Content-Location'] != '':
                returnObj['id'] = res.headers['Content-Location']
@@ -1578,9 +1581,9 @@ Create new build record.
    .. code:: python
 
       {
-         'success' : False, 
-         'id': None, 
-         'message': '', 
+         'success' : False,
+         'id': None,
+         'message': '',
          'status_code': ''
       }
 
@@ -1589,9 +1592,9 @@ Create new build record.
       returnObj = {'success' : False, 'id': None, 'message': '', 'status_code': ''}
       if (sBuildSWVersion not in self.dBuildVersion.values()) or forceCreate:
          sBuildTemplate = self.createBuildRecordTemplate(sBuildSWVersion)
-         returnObj  = self.createResource('buildrecord', sBuildTemplate) 
+         returnObj  = self.createResource('buildrecord', sBuildTemplate)
          if returnObj['success']:
-            # store existing build ID for next verification   
+            # store existing build ID for next verification
             self.dBuildVersion[returnObj['id']] = sBuildSWVersion
       else:
          idx = list(self.dBuildVersion.values()).index(sBuildSWVersion)
@@ -1631,9 +1634,9 @@ Create new configuration - test environment.
    .. code:: python
 
       {
-         'success' : False, 
-         'id': None, 
-         'message': '', 
+         'success' : False,
+         'id': None,
+         'message': '',
          'status_code': ''
       }
 
@@ -1645,7 +1648,7 @@ Create new configuration - test environment.
          sConfTemplate = self.createConfigurationTemplate(sConfigurationName)
          returnObj  = self.createResource('configuration', sConfTemplate)
          if returnObj['success']:
-            # store existing configuration ID for next verification   
+            # store existing configuration ID for next verification
             self.dConfiguation[returnObj['id']] = sConfigurationName
       else:
          idx = list(self.dConfiguation.values()).index(sConfigurationName)
@@ -1712,13 +1715,13 @@ Link list of test cases to provided testplan ID.
    List of testcase(s) to be linked with given testplan.
 
    If not provide, `lTestcaseIDs` property will be used as list of testcase.
-         
+
 **Returns:**
 
 *  ``returnObj``
 
    / *Type*: dict /
-   
+
    Response dictionary which contains status and error message.
 
    Example:
@@ -1726,7 +1729,7 @@ Link list of test cases to provided testplan ID.
    .. code:: python
 
       {
-         'success' : False, 
+         'success' : False,
          'message': ''
       }
 
@@ -1734,13 +1737,13 @@ Link list of test cases to provided testplan ID.
       returnObj = {'success' : False, 'message': ''}
       if lTestcases == None:
          lTestcases = self.lTestcaseIDs
-      if len(lTestcases): 
+      if len(lTestcases):
          resTestplanData = self.getResourceByID('testplan', testplanID)
          oTree = get_xml_tree(BytesIO(str(resTestplanData.text).encode()),bdtd_validation=False)
          # RQM XML response using namespace for nodes
          # use namespace mapping from root for access response XML
          root = oTree.getroot()
-         
+
          for sTCID in lTestcases:
             sTestcaseURL = self.integrationURL('testcase', sTCID)
             oTC = etree.Element('{http://jazz.net/xmlns/alm/qm/v0.1/}testcase', nsmap=root.nsmap)
@@ -1755,7 +1758,7 @@ Link list of test cases to provided testplan ID.
             returnObj['message'] = str(resUpdateTestplan.reason)
       else:
          returnObj['message'] = "No testcase for linking."
-      return returnObj      
+      return returnObj
 
    def linkListTestcase2Testsuite(self, testsuiteID, lTestcases=None):
       """
@@ -1776,13 +1779,13 @@ Link list of test cases to provided testsuite ID
    List of testcase(s) to be linked with given testplan.
 
    If not provide, `lTestcaseIDs` property will be used as list of testcase.
-         
+
 **Returns:**
 
 *  ``returnObj``
 
    / *Type*: dict /
-   
+
    Response dictionary which contains status and error message.
 
    Example:
@@ -1790,7 +1793,7 @@ Link list of test cases to provided testsuite ID
    .. code:: python
 
       {
-         'success' : False, 
+         'success' : False,
          'message': ''
       }
 
@@ -1798,7 +1801,7 @@ Link list of test cases to provided testsuite ID
       returnObj = {'success' : False, 'message': ''}
       if lTestcases == None:
          lTestcases = self.lTestcaseIDs
-      if len(lTestcases): 
+      if len(lTestcases):
          resTestsuiteData = self.getResourceByID('testsuite', testsuiteID)
          oTree=get_xml_tree(BytesIO(str(resTestsuiteData.text).encode()),bdtd_validation=False)
          # RQM XML response using namespace for nodes
@@ -1823,4 +1826,4 @@ Link list of test cases to provided testsuite ID
             returnObj['message'] = str(resUpdateTestsuite.reason)
       else:
          returnObj['message'] = "No testcase for linking."
-      return returnObj
+      return returnObj

RobotLog2RQM/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

RobotLog2RQM/__main__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -14,4 +14,4 @@
 from .robotlog2rqm import RobotLog2RQM
 
 if __name__ == "__main__":
-   RobotLog2RQM()
+   RobotLog2RQM()

RobotLog2RQM/robotlog2rqm.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -19,9 +19,9 @@
 #
 # This tool is used to parse the robot framework results output.xml
 # then import them into RQM - IBM Rational Quality Manager
-#  
+#
 # History:
-# 
+#
 # 2020-01-08:
 #  - initial version
 #
@@ -142,7 +142,7 @@ Write log message to console/file output.
    / *Condition*: optional / *Type*: int / *Default*: 0 /
 
    Offset indent.
-      
+
 **Returns:**
 
 (*no returns*)
@@ -160,7 +160,7 @@ Write log message to console/file output.
    def log_warning(cls, msg):
       """
 Write warning message to console/file output.
-      
+
 **Arguments:**
 
 *  ``msg``
@@ -210,7 +210,7 @@ def get_from_tags(lTags, reInfo):
    """
 Extract testcase information from tags.
 
-Example: 
+Example:
    TCID-xxxx, FID-xxxx, ...
 
 **Arguments:**
@@ -232,7 +232,7 @@ Example:
 *  ``lInfo``
 
    / *Type*: list /
-   
+
    List of expected information (ID)
    """
    lInfo = []
@@ -266,7 +266,7 @@ Convert time string to datetime.
    tp=re.findall(r"(\d{4})(\d{2})(\d{2})\s(\d+):(\d+):(\d+)\.(\d+)",time)[0]
    tp=list(map(int,tp))
    dt=datetime.datetime(tp[0],tp[1],tp[2],tp[3],tp[4],tp[5],tp[6])
-   return dt 
+   return dt
 
 def __process_commandline():
    """
@@ -300,24 +300,24 @@ Avalable arguments in command line:
 
    cmdParser=argparse.ArgumentParser(prog=PROG_NAME, description=PROG_DESC)
 
-   cmdParser.add_argument('-v', '--version', action='version', 
+   cmdParser.add_argument('-v', '--version', action='version',
                           version=f'v{VERSION} ({VERSION_DATE})',
                           help='Version of the RobotLog2RQM importer.')
-   cmdParser.add_argument('resultxmlfile', type=str, 
+   cmdParser.add_argument('resultxmlfile', type=str,
                           help='absolute or relative path to the xml result file or directory of result files to be imported.')
    cmdParser.add_argument('host', type=str, help='RQM host url.')
    cmdParser.add_argument('project', type=str, help='project on RQM.')
    cmdParser.add_argument('user', type=str, help='user for RQM login.')
    cmdParser.add_argument('password', type=str, help='password for RQM login.')
-   cmdParser.add_argument('testplan', type=str, 
+   cmdParser.add_argument('testplan', type=str,
                           help='testplan ID for this execution.')
-   cmdParser.add_argument('--recursive',action="store_true", 
+   cmdParser.add_argument('--recursive',action="store_true",
                           help='if set, then the path is searched recursively for log files to be imported.')
-   cmdParser.add_argument('--createmissing', action="store_true", 
+   cmdParser.add_argument('--createmissing', action="store_true",
                           help='if set, then all testcases without tcid are created when importing.')
-   cmdParser.add_argument('--updatetestcase', action="store_true", 
+   cmdParser.add_argument('--updatetestcase', action="store_true",
                           help='if set, then testcase information on RQM will be updated bases on robot testfile.')
-   cmdParser.add_argument('--dryrun',action="store_true", 
+   cmdParser.add_argument('--dryrun',action="store_true",
                           help='if set, then verify all input arguments (includes RQM authentication) and show what would be done.')
 
    return cmdParser.parse_args()
@@ -327,7 +327,7 @@ def process_suite_metadata(suite, default_metadata=DEFAULT_METADATA):
 Try to find metadata information from all suite levels.
 
 Metadata at top suite level has a highest priority.
-   
+
 **Arguments:**
 
 *  ``suite``
@@ -357,7 +357,7 @@ Metadata at top suite level has a highest priority.
    # The higher suite level metadata have higher priority
    if suite.metadata != None:
       dMetadata = process_metadata(suite.metadata, dMetadata)
-   
+
    return dMetadata
 
 def process_metadata(metadata, default_metadata=DEFAULT_METADATA):
@@ -381,10 +381,10 @@ Extract metadata from suite result bases on DEFAULT_METADATA.
 **Returns:**
 
 *  ``dMetadata``
-   
+
    / *Type*: dict /
-   
-   Dictionary of Metadata information.   
+
+   Dictionary of Metadata information.
    """
    dMetadata = dict(default_metadata)
    for key in dMetadata.keys():
@@ -414,7 +414,7 @@ Process robot suite for importing to RQM.
 
 **Returns:**
 
-(*no returns*)  
+(*no returns*)
    """
    if len(list(suite.suites)) > 0:
       for subsuite in suite.suites:
@@ -427,7 +427,7 @@ Process robot suite for importing to RQM.
          for key in suite.parent.metadata.keys():
             if key not in suite.metadata:
                suite.metadata[key] = suite.parent.metadata[key]
-      
+
       if len(list(suite.tests)) > 0:
          for test in suite.tests:
             process_test(RQMClient, test)
@@ -452,14 +452,14 @@ Process robot test for importing to RQM.
 
 **Returns:**
 
-(*no returns*)   
+(*no returns*)
    """
    Logger.log(f"Process test: {test.name}")
 
    # Avoid create resources with dryrun
    if Logger.dryrun:
       return
-   
+
    # Parse test case data:
    _tc_fid = ";".join(get_from_tags(test.tags, "fid-(.+)"))
    lTCIDTags = get_from_tags(test.tags, "tcid-(.+)")
@@ -499,9 +499,9 @@ Process robot test for importing to RQM.
       # Create new testcase on RQM
       # Update dMappingTCID (to update *.robot testfile with generated ID - Not implemented yet).
       if _tc_createmissing:
-         oTCTemplate = RQMClient.createTestcaseTemplate( _tc_name, 
+         oTCTemplate = RQMClient.createTestcaseTemplate( _tc_name,
                                                          _tc_desc,
-                                                         _tc_cmpt, 
+                                                         _tc_cmpt,
                                                          _tc_fid,
                                                          _tc_team,
                                                          _tc_link)
@@ -529,9 +529,9 @@ Process robot test for importing to RQM.
       if _tc_update:
          resTC = RQMClient.getResourceByID('testcase', _tc_id)
          if resTC.status_code == 200 and resTC.text:
-            oTCTemplate = RQMClient.createTestcaseTemplate( _tc_name, 
+            oTCTemplate = RQMClient.createTestcaseTemplate( _tc_name,
                                                             _tc_desc,
-                                                            _tc_cmpt, 
+                                                            _tc_cmpt,
                                                             _tc_fid,
                                                             _tc_team,
                                                             _tc_link,
@@ -552,7 +552,7 @@ Process robot test for importing to RQM.
                                                  _tc_config_id,
                                                  _tc_team)
    res = RQMClient.createResource('executionworkitem', oTCERTemplate)
-   _tc_tcer_id = res['id'] 
+   _tc_tcer_id = res['id']
    if res['success']:
       Logger.log(f"Created TCER with ID '{_tc_tcer_id}' successfully.")
    elif (res['status_code'] == 303 or res['status_code'] == 200) and res['id'] != '':
@@ -604,7 +604,7 @@ Flow to import Robot results to RQM:
 1. Process provided arguments from command line
 2. Login Rational Quality Management (RQM)
 3. Parse Robot results
-4. Import results into RQM 
+4. Import results into RQM
 5. Link all executed testcases to provided testplan/testsuite ID
 
 **Arguments:**
@@ -640,7 +640,7 @@ Flow to import Robot results to RQM:
    if os.path.exists(args.resultxmlfile):
       sLogFileType="PATH"
       if os.path.isfile(args.resultxmlfile):
-         sLogFileType="FILE"  
+         sLogFileType="FILE"
    else:
       Logger.log_error(f"Given resultxmlfile is not existing: '{args.resultxmlfile}'.", fatal_error=True)
 
@@ -681,7 +681,7 @@ Flow to import Robot results to RQM:
    except Exception as reason:
       Logger.log_error(f"Could not login to RQM: '{str(reason)}'.")
 
-   # 4. Import results into RQM 
+   # 4. Import results into RQM
    try:
       metadata_info = process_suite_metadata(result.suite)
       if not metadata_info['version_sw']:
@@ -692,9 +692,9 @@ Flow to import Robot results to RQM:
       if args.dryrun:
          metadata_info['version_sw'] = None
          metadata_info['project'] = None
-      RQMClient.config(args.testplan, metadata_info['version_sw'], 
+      RQMClient.config(args.testplan, metadata_info['version_sw'],
                     metadata_info['project'], args.createmissing, args.updatetestcase)
-      # Process suite for importing 
+      # Process suite for importing
       process_suite(RQMClient, result.suite)
 
       # Link all imported testcase ID(s) with testplan
@@ -712,4 +712,4 @@ Flow to import Robot results to RQM:
    Logger.log("All test results have been imported to RQM successfully.!")
 
 if __name__=="__main__":
-   RobotLog2RQM()
+   RobotLog2RQM()

RobotLog2RQM/version.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -18,6 +18,6 @@
 #
 # Version and date of RobotLog2RQM
 #
-VERSION      = "1.2.1"
-VERSION_DATE = "14.06.2023"
+VERSION      = "1.2.3"
+VERSION_DATE = "14.03.2024"
 

{robotframework_robotlog2rqm-1.2.1.dist-info → robotframework_robotlog2rqm-1.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-robotlog2rqm
-Version: 1.2.1
+Version: 1.2.3
 Summary: Imports robot result(s) to IBM Rational Quality Manager (RQM)
 Home-page: https://github.com/test-fullautomation/robotframework-robotlog2rqm
 Author: Tran Duy Ngoan
@@ -132,15 +132,15 @@ Use below command to get tools\'s usage:
 
 The usage should be showed as below:
 
-    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive] 
-                        [--createmissing] [--updatetestcase] [--dryrun] 
+    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive]
+                        [--createmissing] [--updatetestcase] [--dryrun]
                         resultxmlfile host project user password testplan
 
-    RobotLog2RQM imports XML result files (default: output.xml) generated by the 
+    RobotLog2RQM imports XML result files (default: output.xml) generated by the
     Robot Framework into an IBM Rational Quality Manager.
 
     positional arguments:
-    resultxmlfile     absolute or relative path to the xml result file 
+    resultxmlfile     absolute or relative path to the xml result file
                       or directory of result files to be imported.
     host              RQM host url.
     project           project on RQM.
@@ -151,13 +151,13 @@ The usage should be showed as below:
     optional arguments:
     -h, --help        show this help message and exit
     -v, --version     Version of the RobotLog2RQM importer.
-    --recursive       if set, then the path is searched recursively for 
+    --recursive       if set, then the path is searched recursively for
                       log files to be imported.
-    --createmissing   if set, then all testcases without tcid are created 
+    --createmissing   if set, then all testcases without tcid are created
                       when importing.
-    --updatetestcase  if set, then testcase information on RQM will be updated 
+    --updatetestcase  if set, then testcase information on RQM will be updated
                       bases on robot testfile.
-    --dryrun          if set, then verify all input arguments 
+    --dryrun          if set, then verify all input arguments
                       (includes RQM authentication) and show what would be done.
 
 The below command is simple usage witth all required arguments to import
@@ -189,12 +189,12 @@ importing into RQM:
 
     *** Test Cases ***
     Testcase 01
-       [Documentation]   This test is traceable with provided tcid  
+       [Documentation]   This test is traceable with provided tcid
        [Tags]   TCID-1001   FID-112   FID-111    robotfile-https://github.com/test-fullautomation
        Log      This is Testcase 01
 
     Testcase 02
-       [Documentation]  This new testcase will be created if --createmissing argument 
+       [Documentation]  This new testcase will be created if --createmissing argument
                    ...  is provided when importing
        [Tags]   FID-113  robotfile-https://github.com/test-fullautomation
        Log      This is Testcase 02
@@ -246,7 +246,7 @@ Contributors
 License
 -------
 
-Copyright 2020-2022 Robert Bosch GmbH
+Copyright 2020-2024 Robert Bosch GmbH
 
 Licensed under the Apache License, Version 2.0 (the \"License\"); you
 may not use this file except in compliance with the License. You may

robotframework_robotlog2rqm-1.2.3.dist-info/RECORD

@@ -0,0 +1,19 @@
+RobotLog2RQM/CRQM.py,sha256=yj5q-_Mj_cB4vpwn1G5PzAQFTc756CYB1kIN9xAAA84,54877
+RobotLog2RQM/RobotLog2RQM.pdf,sha256=cOyEU5OugYEl0-RiVTMs2wIYdISgrWh1f-5ZMEI6ILs,228956
+RobotLog2RQM/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
+RobotLog2RQM/__main__.py,sha256=JabttEncy80antJWeGVmjoXyiF1DyXxkxdW4xLuHzT0,681
+RobotLog2RQM/robotlog2rqm.py,sha256=PTURVecQY_sgBsRgy22bby2WBb9Iul3hf0Yx7Po0h40,22787
+RobotLog2RQM/version.py,sha256=JcsIHZJXv3cVJ1621sL9t7qO2EenVAFxj-55SpYW0h8,917
+RobotLog2RQM/RQM_templates/buildrecord.xml,sha256=uGot7pNOjPR8do0JsJi0Lz3OCU9NMhODRd428QgvHh4,1498
+RobotLog2RQM/RQM_templates/configuration.xml,sha256=NrFDv51fuGhgeMiZuRhQ5q_UJ0u_pWzdxisIF5AJs74,1378
+RobotLog2RQM/RQM_templates/executionresult.xml,sha256=WTp4qDk29peBc0ll6GHVXX_kF_YBsOVjy9vBzoz7_2k,2160
+RobotLog2RQM/RQM_templates/executionworkitem.xml,sha256=3GYO-nvXcG-HDQZnDzGwYZSQOWAUNckT3_GUa8Ze2Eo,1511
+RobotLog2RQM/RQM_templates/suiteexecutionrecord.xml,sha256=9GAs2WqZMkFJSNEZULm9BJvQy02dl_2JMecpQPHGTPA,1389
+RobotLog2RQM/RQM_templates/testcase.xml,sha256=zovFKj-37QHn2S8mMA_9RnAJ3zBmDJkJj31yelsnFFI,2167
+RobotLog2RQM/RQM_templates/testsuitelog.xml,sha256=l-NlaCyk6Ben76PElXKOHfMlEvyQ-e9MOZ6-F9HvwDQ,1920
+robotframework_robotlog2rqm-1.2.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+robotframework_robotlog2rqm-1.2.3.dist-info/METADATA,sha256=wuajTxw4Hyi3CoWF_bvQ-ydAs5dodXZIBYyTE_crFP4,9332
+robotframework_robotlog2rqm-1.2.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+robotframework_robotlog2rqm-1.2.3.dist-info/entry_points.txt,sha256=-Xug2kDJW2LtcSADEVPtCwa337twCy2iGh5aK7xApHA,73
+robotframework_robotlog2rqm-1.2.3.dist-info/top_level.txt,sha256=jb_Gt6W44FoOLtGfBe7RzqCLaquhihkEWvSI1zjXDHc,13
+robotframework_robotlog2rqm-1.2.3.dist-info/RECORD,,

{robotframework_robotlog2rqm-1.2.1.dist-info → robotframework_robotlog2rqm-1.2.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

robotframework_robotlog2rqm-1.2.1.dist-info/RECORD

@@ -1,19 +0,0 @@
-RobotLog2RQM/CRQM.py,sha256=AeK_jh_oSrcgf7Io8iOl4UdPNWk20G8doh8PN2-aX0c,54873
-RobotLog2RQM/RobotLog2RQM.pdf,sha256=o6aChhMjr3QCGcJ7AZ13leDnfVwUxcsOIImqIdI49l4,227725
-RobotLog2RQM/__init__.py,sha256=Zv7Xsv-DqisEvX7CvIrIBq8K8lvA3ybQBwFFedUB4jY,611
-RobotLog2RQM/__main__.py,sha256=aBgley3H6tcqzP5FxFxckuDuazXHSdzh9V2evliLNEc,695
-RobotLog2RQM/robotlog2rqm.py,sha256=MFN0lTQGiNtWVv0pNoK6WsC84emI9bE45NEdZpGw3Mc,22868
-RobotLog2RQM/version.py,sha256=QD0YG58zY3C1FnWxK8Y_PcG8SZBYjmkXRRqUBDTMf0A,917
-RobotLog2RQM/RQM_templates/buildrecord.xml,sha256=uGot7pNOjPR8do0JsJi0Lz3OCU9NMhODRd428QgvHh4,1498
-RobotLog2RQM/RQM_templates/configuration.xml,sha256=NrFDv51fuGhgeMiZuRhQ5q_UJ0u_pWzdxisIF5AJs74,1378
-RobotLog2RQM/RQM_templates/executionresult.xml,sha256=WTp4qDk29peBc0ll6GHVXX_kF_YBsOVjy9vBzoz7_2k,2160
-RobotLog2RQM/RQM_templates/executionworkitem.xml,sha256=3GYO-nvXcG-HDQZnDzGwYZSQOWAUNckT3_GUa8Ze2Eo,1511
-RobotLog2RQM/RQM_templates/suiteexecutionrecord.xml,sha256=9GAs2WqZMkFJSNEZULm9BJvQy02dl_2JMecpQPHGTPA,1389
-RobotLog2RQM/RQM_templates/testcase.xml,sha256=zovFKj-37QHn2S8mMA_9RnAJ3zBmDJkJj31yelsnFFI,2167
-RobotLog2RQM/RQM_templates/testsuitelog.xml,sha256=l-NlaCyk6Ben76PElXKOHfMlEvyQ-e9MOZ6-F9HvwDQ,1920
-robotframework_robotlog2rqm-1.2.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-robotframework_robotlog2rqm-1.2.1.dist-info/METADATA,sha256=GoswPQLB6ALEe1OZM27Y-Ba3jOlemU5Ic_jCISyQLaQ,9343
-robotframework_robotlog2rqm-1.2.1.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-robotframework_robotlog2rqm-1.2.1.dist-info/entry_points.txt,sha256=-Xug2kDJW2LtcSADEVPtCwa337twCy2iGh5aK7xApHA,73
-robotframework_robotlog2rqm-1.2.1.dist-info/top_level.txt,sha256=jb_Gt6W44FoOLtGfBe7RzqCLaquhihkEWvSI1zjXDHc,13
-robotframework_robotlog2rqm-1.2.1.dist-info/RECORD,,