robotframework-robotlog2rqm 1.4.0__tar.gz → 1.4.2__tar.gz

{robotframework-robotlog2rqm-1.4.0 → robotframework-robotlog2rqm-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-robotlog2rqm
-Version: 1.4.0
+Version: 1.4.2
 Summary: Imports robot result(s) to IBM Rational Quality Manager (RQM)
 Home-page: https://github.com/test-fullautomation/robotframework-robotlog2rqm
 Author: Tran Duy Ngoan
@@ -17,8 +17,7 @@ Requires-Python: >=3.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-RobotLog2RQM Description
-========================
+# RobotLog2RQM Description
 
 The Python package **RobotLog2RQM** provides ability to import [Robot
 Framework test
@@ -38,14 +37,13 @@ Manager](https://www.ibm.com/support/knowledgecenter/SSYMRC_6.0.2/com.ibm.ration
 **RobotLog2RQM** tool is operating system independent and only works
 with Python 3.
 
-How to install
---------------
+## How to install
 
 **RobotLog2RQM** can be installed in two different ways.
 
 1.  Installation via PyPi (recommended for users)
 
-    ``` {.}
+    ``` 
     pip install RobotLog2RQM
     ```
 
@@ -57,7 +55,7 @@ How to install
     -   Clone the **robotframework-robotlog2rqm** repository to your
         machine.
 
-        ``` {.}
+        ``` 
         git clone https://github.com/test-fullautomation/robotframework-robotlog2rqm.git
         ```
 
@@ -72,7 +70,7 @@ How to install
         packages you can find in the file `requirements.txt` in the
         repository root folder. Use pip to install them:
 
-        ``` {.}
+        ``` 
         pip install -r ./requirements.txt
         ```
 
@@ -91,7 +89,7 @@ How to install
         to find **LaTeX**. This is defined in the **GenPackageDoc**
         configuration file
 
-        ``` {.}
+        ``` 
         packagedoc\packagedoc_config.json
         ```
 
@@ -103,7 +101,7 @@ How to install
 
     -   Use the following command to install **RobotLog2RQM**:
 
-        ``` {.}
+        ``` 
         python setup.py install
         ```
 
@@ -114,8 +112,7 @@ be available (under *Scripts* folder of Python on Windows and
 In case above location is added to **PATH** environment variable then
 you can run it directly as operation system\'s command.
 
-How to use
-----------
+## How to use
 
 **RobotLog2RQM** tool requires the Robot Framework `output.xml` result
 file(s) which will be imported, RQM information(e.g. host url, project,
@@ -219,8 +216,7 @@ cases and their results are reflected on RQM, please refer to
 [RobotLog2RQM tool's
 Documentation](https://github.com/test-fullautomation/robotframework-robotlog2rqm/blob/develop/RobotLog2RQM/RobotLog2RQM.pdf).
 
-Feedback
---------
+## Feedback
 
 To give us a feedback, you can send an email to [Thomas
 Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com).
@@ -228,15 +224,13 @@ Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com).
 In case you want to report a bug or request any interesting feature,
 please don\'t hesitate to raise a ticket.
 
-Maintainers
------------
+## Maintainers
 
 [Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
 
 [Tran Duy Ngoan](mailto:Ngoan.TranDuy@vn.bosch.com)
 
-Contributors
-------------
+## Contributors
 
 [Nguyen Huynh Tri Cuong](mailto:Cuong.NguyenHuynhTri@vn.bosch.com)
 
@@ -246,8 +240,7 @@ Contributors
 
 [Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
 
-License
--------
+## License
 
 Copyright 2020-2024 Robert Bosch GmbH
 

{robotframework-robotlog2rqm-1.4.0 → robotframework-robotlog2rqm-1.4.2}/RobotLog2RQM/CRQM.py

@@ -15,7 +15,7 @@
 #
 # File: CRQM.py
 #
-# Initialy created by Tran Duy Ngoan(RBVH/ECM11) / January 2021
+# Initially created by Tran Duy Ngoan(RBVH/ECM11) / January 2021
 #
 # This is CRQMClient class which is used to interact with RQM via RQM REST APIs
 #
@@ -78,6 +78,14 @@ Parse xml object from file.
       exit(1)
    return oTree
 
+class Identifier:
+   """
+Identifier class used to identify RQM resource with name and id
+   """
+   def __init__(self, name='', id=None):
+      self.name = name
+      self.id = id
+
 #
 #  IBM Rational Quality Manager
 #
@@ -87,7 +95,7 @@ class CRQMClient():
 CRQMClient class uses RQM REST APIs to get, create and update resources
 (testplan, testcase, test result, ...) on RQM - Rational Quality Manager
 
-Resoure type mapping:
+Resource type mapping:
 
 * buildrecord:          Build Record
 * configuration:        Test Environment
@@ -131,6 +139,17 @@ Resoure type mapping:
       'ns21' : "http://www.w3.org/1999/XSL/Transform"
    }
 
+   # define the convention for naming new RQM resource
+   SUPPORTED_PLACEHOLDER = ["testplan", "build", "environment", "testsuite", "testcase"]
+   NAMING_CONVENTION = {
+      "testcase"    : "{testcase}",
+      "tcer"        : "TCER: {testcase}",
+      "testresult"  : "Execution result: {testcase}",
+      "testsuite"   : "{testsuite}",
+      "tser"        : "TSER: {testsuite}",
+      "suiteresult" : "Testsuite result: {testsuite}"
+   }
+
    def __init__(self, user, password, project, host):
       """
 Constructor of class ``CRQMClient``.
@@ -175,7 +194,7 @@ Constructor of class ``CRQMClient``.
                         'OSLC-Core-Version'  : '2.0'
                      }
 
-      # Templates location which is uesd for importing
+      # Templates location which is used for importing
       self.templatesDir = os.path.join(os.path.dirname(__file__),'RQM_templates')
 
       # Data for mapping and linking
@@ -190,17 +209,17 @@ Constructor of class ``CRQMClient``.
       self.lEndTimes     = list()
 
       # RQM configuration info
-      self.testplan      = None
-      self.build         = None
-      self.configuration = None
       self.createmissing = None
       self.updatetestcase= None
-      self.testsuite     = {
-         "id": None,
-         "name": None
-      }
-      self.stream        = None
-      self.baseline      = None
+      self.testplan      = Identifier()
+      self.build         = Identifier()
+      self.configuration = Identifier()
+      self.testsuite     = Identifier()
+      self.stream        = Identifier()
+      self.baseline      = Identifier()
+
+      # Naming convention
+      self.naming_convention = None
 
    def login(self):
       """
@@ -290,8 +309,8 @@ Disconnect from RQM.
       self.session.close()
 
    def config(self, plan_id, build_name=None, config_name=None,
-              createmissing=False, updatetestcase=False, suite_id=None, 
-              stream=None, baseline=None):
+              createmissing=False, updatetestcase=False, suite_id=None,
+              stream=None, baseline=None, naming_convention=None):
       """
 Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
@@ -344,11 +363,15 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 (*no returns*)
       """
       try:
+         self.naming_convention = self.NAMING_CONVENTION
+         if naming_convention:
+            self.naming_convention.update(naming_convention)
+
          self.createmissing = createmissing
          self.updatetestcase = updatetestcase
-         self.testplan  = plan_id
-         self.testsuite['id'] = suite_id
-         
+         self.testplan.id  = plan_id
+         self.testsuite.id = suite_id
+
          # Add Configuration-Context header information due to given stream or baseline
          if stream:
             res = self.getAllByResource('stream')
@@ -357,12 +380,13 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
                bFoundStream = False
                for stream_id, stream_name in dStreams.items():
                   if stream_name == stream:
-                     self.stream = stream_id
+                     self.stream.id = stream_id
+                     self.stream.name = stream_name
                      bFoundStream = True
                      self.headers['Configuration-Context'] = stream_id
                      self.session.headers = self.headers
                      break
-               
+
                if not bFoundStream:
                   raise Exception(f"Cannot found given stream '{stream}'")
             else:
@@ -374,12 +398,13 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
                bFoundBaseline = False
                for baseline_id, baseline_name in dBaselines.items():
                   if baseline_name == baseline:
-                     self.baseline = baseline_id
+                     self.baseline.id = baseline_id
+                     self.baseline.name = baseline_name
                      bFoundBaseline = True
                      self.headers['Configuration-Context'] = baseline_id
                      self.session.headers = self.headers
                      break
-               
+
                if not bFoundBaseline:
                   raise Exception(f"Cannot found given baseline '{baseline}'")
             else:
@@ -390,6 +415,9 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
          if res_plan.status_code != 200:
             raise Exception('Testplan with ID %s is not existing!'%str(plan_id))
 
+         oTestplan = get_xml_tree(BytesIO(str(res_plan.text).encode()), bdtd_validation=False)
+         self.testplan.name  = oTestplan.find('ns4:title', oTestplan.getroot().nsmap).text
+
          # Verify and create build version if required
          if build_name != None:
             if build_name == '':
@@ -397,7 +425,8 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
             self.getAllBuildRecords()
             res_build = self.createBuildRecord(build_name)
             if res_build['success'] or res_build['status_code'] == "303":
-               self.build = res_build['id']
+               self.build.id = res_build['id']
+               self.build.name = build_name
             else:
                raise Exception("Cannot create build '%s': %s"%
                                (build_name, res_build['message']))
@@ -409,7 +438,8 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
             self.getAllConfigurations()
             res_conf = self.createConfiguration(config_name)
             if res_conf['success'] or res_conf['status_code'] == "303":
-               self.configuration = res_conf['id']
+               self.configuration.id = res_conf['id']
+               self.configuration.name = config_name
             else:
                raise Exception("Cannot create configuration '%s': %s"%
                                (config_name, res_conf['message']))
@@ -420,11 +450,11 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
             if res_suite.status_code != 200:
                raise Exception('Testsuite with ID %s is not existing!'%str(suite_id))
             oTestsuite = get_xml_tree(BytesIO(str(res_suite.text).encode()), bdtd_validation=False)
-            self.testsuite['name']  = oTestsuite.find('ns4:title', oTestsuite.getroot().nsmap).text
+            self.testsuite.name  = oTestsuite.find('ns4:title', oTestsuite.getroot().nsmap).text
 
          # get all team-areas for testcase template
          self.getAllTeamAreas()
-         
+
 
       except Exception as error:
          raise Exception('Configure RQMClient failed: %s'%error)
@@ -454,7 +484,7 @@ Return interaction URL of provided userID
 
    def integrationURL(self, resourceType, id=None, forceinternalID=False):
       """
-Return interaction URL of provided reource and ID.
+Return interaction URL of provided resource and ID.
 The provided ID can be internalID (contains only digits) or externalID.
 
 **Arguments:**
@@ -486,7 +516,7 @@ The provided ID can be internalID (contains only digits) or externalID.
 
    / *Type*: str /
 
-   The interaction URL of provided reource and ID.
+   The interaction URL of provided resource and ID.
       """
       integrationURL = self.host + "/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/" + \
                        self.projectID + '/' + resourceType
@@ -538,7 +568,7 @@ Note:
          raise Exception("Cannot get ID from response. Reason: %s"%str(error))
       return resultId
 
-   def webIDfromGeneratedID(self, resourrceType, generateID):
+   def webIDfromGeneratedID(self, resourceType, generateID):
       """
 Return web ID (ns2:webId) from generate ID by get resource data from RQM.
 
@@ -549,7 +579,7 @@ Note:
 
 **Arguments:**
 
-*  ``resourrceType``
+*  ``resourceType``
 
    / *Condition*: required / *Type*: str /
 
@@ -583,8 +613,8 @@ Note:
                               'testscript',
                               'testsuite',
                               'testsuitelog']
-      if resourrceType in lSupportedResources:
-         resResource = self.getResourceByID(resourrceType, generateID)
+      if resourceType in lSupportedResources:
+         resResource = self.getResourceByID(resourceType, generateID)
          if resResource.status_code == 200:
             oResource = get_xml_tree(BytesIO(str(resResource.text).encode()),
                                      bdtd_validation=False)
@@ -595,6 +625,61 @@ Note:
             raise Exception("Cannot get web ID of generated testcase!")
       return webID
 
+   def __genResourceName(self, resource, name):
+      """
+Return the name for given resource bases on the naming convention
+
+**Arguments:**
+
+*  ``resource``
+
+   / *Condition*: required / *Type*: str /
+
+   The RQM resource type.
+
+*  ``name``
+
+   / *Condition*: required / *Type*: str /
+
+   Relevant resource name.
+
+**Returns:**
+
+*  ``resourceName``
+
+   / *Type*: str /
+
+   Resource name after replacing bases on naming convention.
+      """
+      dPlaceHolders = {
+         "{testplan}": self.testplan.name
+      }
+      testcaseRelevant = ["testcase", "tcer", "testresult"]
+      testsuiteRelevant = ["testsuite", "tser", "suiteresult"]
+
+      # Define scope of place holders
+      if resource in testcaseRelevant:
+         dPlaceHolders.update({
+            "{build}": self.build.name,
+            "{environment}": self.configuration.name,
+            "{testsuite}": self.testsuite.name,
+            "{testcase}": name
+         })
+      elif resource in testsuiteRelevant:
+         dPlaceHolders.update({
+            "{build}": self.build.name,
+            "{environment}": self.configuration.name,
+            "{testsuite}": name,
+         })
+
+      try:
+         resourceName = self.naming_convention[resource]
+         for placeHolder, val in dPlaceHolders.items():
+            resourceName = resourceName.replace(placeHolder, val)
+         return resourceName
+      except:
+         raise Exception(f"Failed to generate name for {resource} '{name}'")
+
    #
    #  Methods to get resources
    #
@@ -605,7 +690,7 @@ Return data of provided resource and ID by GET method
 
 **Arguments:**
 
-*  ``resourrceType``
+*  ``resourceType``
 
    / *Condition*: required / *Type*: str /
 
@@ -635,7 +720,7 @@ Return all entries (in all pages) of provided resource by GET method.
 
 **Arguments:**
 
-*  ``resourrceType``
+*  ``resourceType``
 
    / *Condition*: required / *Type*: str /
 
@@ -897,7 +982,7 @@ Return testcase template from provided information.
       root         = oTree.getroot()
       nsmap        = root.nsmap
       # prepare required data for template
-      testcaseTittle  = testcaseName
+      testcaseTittle  = self.__genResourceName('testcase', testcaseName)
 
       # find nodes to change data
       oTittle      = oTree.find(f'{{{self.NAMESPACES["ns3"]}}}title')
@@ -1010,7 +1095,8 @@ Return testcase execution record template from provided information.
       root = oTree.getroot()
       nsmap = root.nsmap
       # prepare required data for template
-      TCERTittle  = 'TCER: '+testcaseName
+      TCERTittle  = self.__genResourceName('tcer', testcaseName)
+
 
       # Check tcid is internalid or externalid
       testcaseURL = self.integrationURL('testcase', testcaseID)
@@ -1156,7 +1242,7 @@ Return testcase execution result template from provided information.
       nsmap = root.nsmap
       # prepare required data for template
       prefixState  = 'com.ibm.rqm.execution.common.state.'
-      resultTittle = 'Execution result: '+testcaseName
+      resultTittle = self.__genResourceName('testresult', testcaseName)
       testcaseURL  = self.integrationURL('testcase', testcaseID)
       testplanURL  = self.integrationURL('testplan', testplanID)
       TCERURL      = self.integrationURL('executionworkitem', TCERID)
@@ -1339,7 +1425,7 @@ Return testsuite execution record (TSER) template from provided configuration na
       oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
       root = oTree.getroot()
       # prepare required data for template
-      TSERTittle   = 'TSER: ' + testsuiteName
+      TSERTittle   = self.__genResourceName('tser', testsuiteName)
       testsuiteURL = self.integrationURL('testsuite', testsuiteID)
       testplanURL  = self.integrationURL('testplan', testplanID)
       testerURL    = self.userURL(self.userID)
@@ -1376,7 +1462,7 @@ Return testsuite execution record (TSER) template from provided configuration na
 
    def createTestsuiteResultTemplate(self, testsuiteID, testsuiteName, TSERID,
                                      lTCER, lTCResults, resultState, startTime='',
-                                     endTime='', duration='', sOwnerID=''):
+                                     endTime='', duration='', sOwnerID='', buildrecordID=''):
       """
 Return testsuite execution result template from provided configuration name.
 
@@ -1450,7 +1536,7 @@ Return testsuite execution result template from provided configuration name.
       prefixState  = 'com.ibm.rqm.execution.common.state.'
 
       # prepare required data for template
-      resultTittle  = 'Testsuite result: ' + testsuiteName
+      resultTittle  = self.__genResourceName('suiteresult', testsuiteName)
       testsuiteURL  = self.integrationURL('testsuite', testsuiteID)
       TSERURL       = self.integrationURL('suiteexecutionrecord', TSERID)
       testerURL    = self.userURL(self.userID)
@@ -1495,7 +1581,7 @@ Return testsuite execution result template from provided configuration name.
       oState.text              = prefixState + 'inconclusive'
       if resultState.lower() in self.RESULT_STATES:
          oState.text = prefixState +resultState.lower()
-         
+
       for idx, sTCER in enumerate(lTCER):
          sTCERURL = self.integrationURL('executionworkitem', sTCER)
          oSuiteElem = etree.Element('{http://jazz.net/xmlns/alm/qm/v0.1/tsl/v0.1/}suiteelement', nsmap=nsmap)
@@ -1513,6 +1599,12 @@ Return testsuite execution result template from provided configuration name.
          oExecutionResult.set('href', sTCResultURL)
          root.append(oExecutionResult)
 
+      if buildrecordID:
+         oBuildRecord = etree.Element('{http://jazz.net/xmlns/alm/qm/v0.1/}buildrecord', nsmap=nsmap)
+         buildrecordURL = self.integrationURL('buildrecord', buildrecordID)
+         oBuildRecord.set('href', buildrecordURL)
+         root.append(oBuildRecord)
+
       # return xml template as string
       sTSResultxml = etree.tostring(oTree)
       return sTSResultxml
@@ -1576,7 +1668,7 @@ Return testcase template from provided information.
       oOwner       = oTree.find('ns6:owner', nsmap)
 
       # change nodes's data
-      oTittle.text       = testsuiteName
+      oTittle.text       = self.__genResourceName('testsuite', testsuiteName)
       oDescription.text  = sDescription
 
       # Incase not specify owner in template or input data, set it as provided user in cli
@@ -1774,7 +1866,6 @@ Create new configuration - test environment.
       """
       returnObj = {'success' : False, 'id': None, 'message': '', 'status_code': ''}
       # check existing build record in this executioon
-      sConfID = ''
       if (sConfigurationName not in self.dConfiguation.values()) or forceCreate:
          sConfTemplate = self.createConfigurationTemplate(sConfigurationName)
          returnObj  = self.createResource('configuration', sConfTemplate)
@@ -1977,7 +2068,7 @@ Add testsuite ID to provided testplan ID
 
    Testsuite to be linked with given testplan.
 
-   If not provide, `testsuite['id']` value will be used as id of testsuite.
+   If not provide, `testsuite.id` value will be used as id of testsuite.
 
 **Returns:**
 
@@ -1999,7 +2090,7 @@ Add testsuite ID to provided testplan ID
       """
       returnObj = {'success' : False, 'message': ''}
       if testsuiteID == None:
-         testsuiteID = self.testsuite['id']
+         testsuiteID = self.testsuite.id
       if testsuiteID:
          resTestplanData = self.getResourceByID('testplan', testplanID)
          oTree = get_xml_tree(BytesIO(str(resTestplanData.text).encode()),bdtd_validation=False)

{robotframework-robotlog2rqm-1.4.0 → robotframework-robotlog2rqm-1.4.2}/RobotLog2RQM/robotlog2rqm.py

@@ -27,6 +27,7 @@
 #
 # ******************************************************************************
 
+import json
 import re
 import argparse
 import os
@@ -64,6 +65,15 @@ DEFAULT_METADATA = {
    "team-area"    :  "",
 }
 
+NAMING_CONVENTION_SCHEMA = {
+   "testcase"    : str,
+   "tcer"        : str,
+   "testresult"  : str,
+   "testsuite"   : str,
+   "tser"        : str,
+   "suiteresult" : str
+}
+
 #
 #  Logger class
 #
@@ -281,6 +291,108 @@ Convert time string to datetime.
    dt=datetime.datetime(tp[0],tp[1],tp[2],tp[3],tp[4],tp[5],tp[6])
    return dt
 
+def process_config_file(path_file):
+   """
+Parse and validate content of configuration file
+
+**Arguments:**
+
+*  ``path_file``
+
+   / *Condition*: required / *Type*: str /
+
+   Path to the configuration json file.
+
+**Returns:**
+
+*  ``dConfig``
+
+   / *Type*: dict /
+
+   Content of json file.
+   """
+   with open(path_file, encoding='utf-8') as f:
+      try:
+         dConfig = json.load(f)
+      except Exception as reason:
+         Logger.log_error(f"Cannot parse the json file '{path_file}'. Reason: {reason}",
+                          fatal_error=True)
+
+   if not is_valid_config(dConfig, bExitOnFail=False):
+      Logger.log_error(f"Error in naming configuration file '{path_file}'.",
+                       fatal_error=True)
+   return dConfig
+
+def is_valid_config(dConfig, dSchema=NAMING_CONVENTION_SCHEMA, bExitOnFail=True):
+   """
+Validate the json configuration base on given schema.
+
+Default schema supports below information:
+
+.. code:: python
+
+   NAMING_CONVENTION_SCHEMA = {
+      "testcase"    : str,
+      "tcer"        : str,
+      "testresult"  : str,
+      "testsuite"   : str,
+      "tser"        : str,
+      "suiteresult" : str
+   }
+
+**Arguments:**
+
+*  ``dConfig``
+
+   / *Condition*: required / *Type*: dict /
+
+   Json configuration object to be verified.
+
+*  ``dSchema``
+
+   / *Condition*: optional / *Type*: dict / *Default*: CONFIG_SCHEMA /
+
+   Schema for the validation.
+
+*  ``bExitOnFail``
+
+   / *Condition*: optional / *Type*: bool / *Default*: True /
+
+   If True, exit tool in case the validation is fail.
+
+**Returns:**
+
+*  ``bValid``
+
+   / *Type*: bool /
+
+   True if the given json configuration data is valid.
+   """
+   bValid = True
+   for key in dConfig:
+      if key in dSchema.keys():
+         if type(dConfig[key]) != dSchema[key]:
+            bValid = False
+            Logger.log_error(f"Value of '{key}' has wrong type '{type(dConfig[key])}' in configuration json file.",
+                             fatal_error=bExitOnFail)
+            break
+
+         # TESTCASE_NAME is not available for non-testcase relevant resources
+         # TESTSUITE_NAME is not available for `buildrecord` and `configuration` resources
+         # Warning user for using wrong place holders
+         oMatch = re.search(".*\{(.*)\}.*", dConfig[key])
+         if oMatch:
+            if oMatch.group(1) not in CRQMClient.SUPPORTED_PLACEHOLDER:
+               Logger.log_warning(f"Place holder '{{{oMatch.group(1)}}}' is not supported, it will not be replaced when generating {key} resource")
+
+      else:
+         bValid = False
+         Logger.log_error(f"resource '{key}' is not supported in naming conventions json file.",
+                          fatal_error=bExitOnFail)
+         break
+
+   return bValid
+
 def __process_commandline():
    """
 Process provided argument(s) from command line.
@@ -296,6 +408,8 @@ Avalable arguments in command line:
    - `--testsuite` : RQM testsuite ID. If value is 'new', then create a new testsuite for this execution.
    - `--recursive` : if True, then the path is searched recursively for log files to be imported.
    - `--createmissing` : if True, then all testcases without tcid are created when importing.
+   - `--updatetestcase` : if set, then testcase information on RQM will be updated bases on robot testfile.
+   - `--naming_config` : configuration json file for naming conventions when creating RQM resources.
    - `--dryrun` : if True, then verify all input arguments (includes RQM authentication) and show what would be done.
    - `--stream` : project stream. Note, requires Configuration Management (CM) to be enabled for the project area.
    - `--baseline` : project baseline. Note, requires Configuration Management (CM), or Baselines Only to be enabled for the project area.
@@ -327,7 +441,7 @@ Avalable arguments in command line:
    cmdParser.add_argument('password', type=str, help='password for RQM login.')
    cmdParser.add_argument('testplan', type=str,
                           help='testplan ID for this execution.')
-   cmdParser.add_argument('--testsuite', type=str, 
+   cmdParser.add_argument('--testsuite', type=str,
                           help="testsuite ID for this execution. If 'new', then create a new testsuite for this execution.")
    cmdParser.add_argument('--recursive',action="store_true",
                           help='if set, then the path is searched recursively for log files to be imported.')
@@ -335,6 +449,8 @@ Avalable arguments in command line:
                           help='if set, then all testcases without tcid are created when importing.')
    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('--naming_config', type=str,
+                          help='configuration json file for naming conventions when creating RQM resources.')
    cmdParser.add_argument('--dryrun',action="store_true",
                           help='if set, then verify all input arguments (includes RQM authentication) and show what would be done.')
    cmdParser.add_argument('--stream', type=str,
@@ -507,9 +623,9 @@ Process robot test for importing to RQM.
    _tc_cmpt    = metadata_info['component']
    _tc_team    = metadata_info['team-area']
    # from RQMClient
-   _tc_testplan_id = RQMClient.testplan
-   _tc_config_id   = RQMClient.configuration
-   _tc_build_id    = RQMClient.build
+   _tc_testplan_id = RQMClient.testplan.id
+   _tc_config_id   = RQMClient.configuration.id
+   _tc_build_id    = RQMClient.build.id
    _tc_createmissing = RQMClient.createmissing
    _tc_update = RQMClient.updatetestcase
    # from robot result object
@@ -628,7 +744,7 @@ Process robot test for importing to RQM.
    # Append lTestcaseIDs (for linking testplan/testsuite)
    if _tc_id not in RQMClient.lTestcaseIDs:
       RQMClient.lTestcaseIDs.append(_tc_id)
-   
+
    # Collect starttime and endtime for testsuite log creation
    RQMClient.lStartTimes.append(_tc_start_time)
    RQMClient.lEndTimes.append(_tc_end_time)
@@ -663,6 +779,7 @@ Flow to import Robot results to RQM:
    * `recursive` : if True, then the path is searched recursively for log files to be imported.
    * `createmissing` : if True, then all testcases without tcid are created when importing.
    * `updatetestcase` : if True, then testcases information on RQM will be updated bases on robot testfile.
+   * `naming_config` : configuration json file for naming conventions when creating RQM resources.
    * `dryrun` : if True, then verify all input arguments (includes RQM authentication) and show what would be done.
    * `stream` : project stream. Note, requires Configuration Management (CM) to be enabled for the project area.
    * `baseline` : project baseline. Note, requires Configuration Management (CM), or Baselines Only to be enabled for the project area.
@@ -710,6 +827,15 @@ Flow to import Robot results to RQM:
    result = ExecutionResult(*sources)
    result.configure()
 
+   # verify given configuration file
+   dNamingConvention = None
+   if args.naming_config != None:
+      if os.path.isfile(args.naming_config):
+         dNamingConvention = process_config_file(args.naming_config)
+      else:
+         Logger.log_error(f"The given naming configuration file is not existing: '{args.naming_config}'",
+                          fatal_error=True)
+
    # 3. Login Rational Quality Management (RQM)
    RQMClient = CRQMClient(args.user, args.password, args.project, args.host)
    try:
@@ -718,7 +844,7 @@ Flow to import Robot results to RQM:
          Logger.log()
          Logger.log(f"Login RQM as user '{args.user}' successfully!")
       else:
-         Logger.log_error("Could not login to RQM: 'Unkown reason'.")
+         Logger.log_error("Could not login to RQM: 'Unknown reason'.")
    except Exception as reason:
       Logger.log_error(f"Could not login to RQM: '{str(reason)}'.")
 
@@ -734,8 +860,9 @@ Flow to import Robot results to RQM:
          metadata_info['version_sw'] = None
          metadata_info['project'] = None
       RQMClient.config(args.testplan, metadata_info['version_sw'],
-                    metadata_info['project'], args.createmissing, args.updatetestcase, 
-                    args.testsuite, stream=args.stream, baseline=args.baseline)
+                    metadata_info['project'], args.createmissing, args.updatetestcase,
+                    args.testsuite, stream=args.stream, baseline=args.baseline,
+                    naming_convention=dNamingConvention)
 
       if args.testsuite == "new":
          # Create new testsuite
@@ -749,18 +876,18 @@ Flow to import Robot results to RQM:
          if res_testsuite['success']:
             _ts_id = res_testsuite['id']
             Logger.log(f"Create testsuite '{result.suite.name}' with ID '{_ts_id}' successfully!")
-            RQMClient.testsuite['id'] = _ts_id
-            RQMClient.testsuite['name'] = result.suite.name
+            RQMClient.testsuite.id = _ts_id
+            RQMClient.testsuite.name = result.suite.name
          else:
             Logger.log_error(f"Create testsuite '{result.suite.name}' failed. Reason: {res_testsuite['message']}", fatal_error=True)
 
       # Process suite for importing
       process_suite(RQMClient, result.suite)
 
-      if RQMClient.testsuite['id']:
+      if RQMClient.testsuite.id:
          if not args.dryrun:
             # Create testsuite execution record if requires
-            testsuite_record_data = RQMClient.createTSERTemplate(RQMClient.testsuite['id'], RQMClient.testsuite['name'], args.testplan, RQMClient.configuration)
+            testsuite_record_data = RQMClient.createTSERTemplate(RQMClient.testsuite.id, RQMClient.testsuite.name, args.testplan, RQMClient.configuration.id)
             res_TSER = RQMClient.createResource('suiteexecutionrecord', testsuite_record_data)
             sTSERID = res_TSER['id']
             Logger.log()
@@ -769,20 +896,21 @@ Flow to import Robot results to RQM:
             elif (res_TSER['status_code'] == 303 or res_TSER['status_code'] == 200) and res_TSER['id'] != '':
                ### incase executionworkitem is existing, cannot create new one
                ### Use the existing ID for new result
-               Logger.log_warning(f"TSER for testsuite {RQMClient.testsuite['id']} is existing.\nAdd this execution result to existing TSER id: {sTSERID}")
+               Logger.log_warning(f"TSER for testsuite {RQMClient.testsuite.id} is existing.\nAdd this execution result to existing TSER id: {sTSERID}")
             else:
                Logger.log_error(f"Create TSER failed, {res_TSER['message']}")
 
             # Create new testsuite result and link all TCERs
-            testsuite_result_data = RQMClient.createTestsuiteResultTemplate(RQMClient.testsuite['id'],
-                                                                           RQMClient.testsuite['name'],
+            testsuite_result_data = RQMClient.createTestsuiteResultTemplate(RQMClient.testsuite.id,
+                                                                           RQMClient.testsuite.name,
                                                                            sTSERID,
                                                                            RQMClient.lTCERIDs,
                                                                            RQMClient.lTCResultIDs,
-                                                                           DRESULT_MAPPING[result.suite.status]
+                                                                           DRESULT_MAPPING[result.suite.status],
+                                                                           buildrecordID=RQMClient.build.id
                                                                            )
             res_TSLog = RQMClient.createResource('testsuitelog', testsuite_result_data)
-            sSuiteResultID = res_TSLog['id'] 
+            sSuiteResultID = res_TSLog['id']
             if res_TSLog['success']:
                Logger.log(f"Created testsuite result with id {sSuiteResultID} successfully.", indent=2)
             else:
@@ -793,15 +921,15 @@ Flow to import Robot results to RQM:
 
          # Link all imported testcase ID(s) with testsuite
          try:
-            RQMClient.linkListTestcase2Testsuite(RQMClient.testsuite['id'])
-            Logger.log(f"Link all imported test cases with testsuite {RQMClient.testsuite['id']} successfully.")
+            RQMClient.linkListTestcase2Testsuite(RQMClient.testsuite.id)
+            Logger.log(f"Link all imported test cases with testsuite {RQMClient.testsuite.id} successfully.")
          except Exception as reason:
             Logger.log_error(f"Link all imported test cases with testsuite failed.\nReason: {reason}", fatal_error=True)
 
          # Add testsuite to given testplan
          try:
             RQMClient.addTestsuite2Testplan(args.testplan)
-            Logger.log(f"Add testsuite {RQMClient.testsuite['id']} to testplan {args.testplan} successfully.")
+            Logger.log(f"Add testsuite {RQMClient.testsuite.id} to testplan {args.testplan} successfully.")
          except Exception as reason:
             Logger.log_error(f"Add testsuite to testplan failed.\nReason: {reason}", fatal_error=True)
 
@@ -812,7 +940,7 @@ Flow to import Robot results to RQM:
             Logger.log(f"Link all imported test cases with testplan {args.testplan} successfully.")
          except Exception as reason:
             Logger.log_error(f"Link all imported test cases with testplan failed.\nReason: {reason}", fatal_error=True)
-         
+
       # Update testcase(s) with generated ID(s)
       # Under developing
 

{robotframework-robotlog2rqm-1.4.0 → robotframework-robotlog2rqm-1.4.2}/RobotLog2RQM/version.py

@@ -18,6 +18,5 @@
 #
 # Version and date of RobotLog2RQM
 #
-VERSION      = "1.4.0"
-VERSION_DATE = "24.07.2024"
-
+VERSION      = "1.4.2"
+VERSION_DATE = "18.02.2025"

{robotframework-robotlog2rqm-1.4.0 → robotframework-robotlog2rqm-1.4.2}/robotframework_robotlog2rqm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-robotlog2rqm
-Version: 1.4.0
+Version: 1.4.2
 Summary: Imports robot result(s) to IBM Rational Quality Manager (RQM)
 Home-page: https://github.com/test-fullautomation/robotframework-robotlog2rqm
 Author: Tran Duy Ngoan
@@ -17,8 +17,7 @@ Requires-Python: >=3.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-RobotLog2RQM Description
-========================
+# RobotLog2RQM Description
 
 The Python package **RobotLog2RQM** provides ability to import [Robot
 Framework test
@@ -38,14 +37,13 @@ Manager](https://www.ibm.com/support/knowledgecenter/SSYMRC_6.0.2/com.ibm.ration
 **RobotLog2RQM** tool is operating system independent and only works
 with Python 3.
 
-How to install
---------------
+## How to install
 
 **RobotLog2RQM** can be installed in two different ways.
 
 1.  Installation via PyPi (recommended for users)
 
-    ``` {.}
+    ``` 
     pip install RobotLog2RQM
     ```
 
@@ -57,7 +55,7 @@ How to install
     -   Clone the **robotframework-robotlog2rqm** repository to your
         machine.
 
-        ``` {.}
+        ``` 
         git clone https://github.com/test-fullautomation/robotframework-robotlog2rqm.git
         ```
 
@@ -72,7 +70,7 @@ How to install
         packages you can find in the file `requirements.txt` in the
         repository root folder. Use pip to install them:
 
-        ``` {.}
+        ``` 
         pip install -r ./requirements.txt
         ```
 
@@ -91,7 +89,7 @@ How to install
         to find **LaTeX**. This is defined in the **GenPackageDoc**
         configuration file
 
-        ``` {.}
+        ``` 
         packagedoc\packagedoc_config.json
         ```
 
@@ -103,7 +101,7 @@ How to install
 
     -   Use the following command to install **RobotLog2RQM**:
 
-        ``` {.}
+        ``` 
         python setup.py install
         ```
 
@@ -114,8 +112,7 @@ be available (under *Scripts* folder of Python on Windows and
 In case above location is added to **PATH** environment variable then
 you can run it directly as operation system\'s command.
 
-How to use
-----------
+## How to use
 
 **RobotLog2RQM** tool requires the Robot Framework `output.xml` result
 file(s) which will be imported, RQM information(e.g. host url, project,
@@ -219,8 +216,7 @@ cases and their results are reflected on RQM, please refer to
 [RobotLog2RQM tool's
 Documentation](https://github.com/test-fullautomation/robotframework-robotlog2rqm/blob/develop/RobotLog2RQM/RobotLog2RQM.pdf).
 
-Feedback
---------
+## Feedback
 
 To give us a feedback, you can send an email to [Thomas
 Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com).
@@ -228,15 +224,13 @@ Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com).
 In case you want to report a bug or request any interesting feature,
 please don\'t hesitate to raise a ticket.
 
-Maintainers
------------
+## Maintainers
 
 [Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
 
 [Tran Duy Ngoan](mailto:Ngoan.TranDuy@vn.bosch.com)
 
-Contributors
-------------
+## Contributors
 
 [Nguyen Huynh Tri Cuong](mailto:Cuong.NguyenHuynhTri@vn.bosch.com)
 
@@ -246,8 +240,7 @@ Contributors
 
 [Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
 
-License
--------
+## License
 
 Copyright 2020-2024 Robert Bosch GmbH