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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-robotlog2rqm
-Version: 1.2.3
+Version: 1.4.0
 Summary: Imports robot result(s) to IBM Rational Quality Manager (RQM)
 Home-page: https://github.com/test-fullautomation/robotframework-robotlog2rqm
 Author: Tran Duy Ngoan
@@ -128,33 +128,40 @@ 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]
-                        resultxmlfile host project user password testplan
+    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--testsuite TESTSUITE] [--recursive] 
+                [--createmissing] [--updatetestcase] [--dryrun] [--stream STREAM] [--baseline BASELINE] 
+                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
-                      or directory of result files to be imported.
-    host              RQM host url.
-    project           project on RQM.
-    user              user for RQM login.
-    password          password for RQM login.
-    testplan          testplan ID for this execution.
+    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.
+    user                  user for RQM login.
+    password              password for RQM login.
+    testplan              testplan ID for this execution.
 
     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
-                      log files to be imported.
-    --createmissing   if set, then all testcases without tcid are created
-                      when importing.
-    --updatetestcase  if set, then testcase information on RQM will be updated
-                      bases on robot testfile.
-    --dryrun          if set, then verify all input arguments
-                      (includes RQM authentication) and show what would be done.
+    -h, --help            show this help message and exit
+    -v, --version         Version of the RobotLog2RQM importer.
+    --testsuite TESTSUITE
+                            testsuite ID for this execution. If 'new', then create a new 
+                            testsuite for this execution.
+    --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 
+                          when importing.
+    --updatetestcase      if set, then testcase information on RQM will be updated 
+                          bases on robot testfile.
+    --dryrun              if set, then verify all input arguments 
+                          (includes RQM authentication) and show what would be done.
+    --stream STREAM       project stream. Note, requires Configuration Management (CM) 
+                          to be enabled for the project area.
+    --baseline BASELINE   project baseline. Note, requires Configuration Management (CM), 
+                          or Baselines Only to be enabled for the project area.
 
 The below command is simple usage witth all required arguments to import
 Robot Framework results into RQM:

{robotframework-robotlog2rqm-1.2.3 → robotframework-robotlog2rqm-1.4.0}/README.rst

@@ -112,33 +112,40 @@ The usage should be showed as below:
 
 ::
 
-   usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive]
-                       [--createmissing] [--updatetestcase] [--dryrun]
-                       resultxmlfile host project user password testplan
+   usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--testsuite TESTSUITE] [--recursive] 
+               [--createmissing] [--updatetestcase] [--dryrun] [--stream STREAM] [--baseline BASELINE] 
+               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
-                     or directory of result files to be imported.
-   host              RQM host url.
-   project           project on RQM.
-   user              user for RQM login.
-   password          password for RQM login.
-   testplan          testplan ID for this execution.
+   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.
+   user                  user for RQM login.
+   password              password for RQM login.
+   testplan              testplan ID for this execution.
 
    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
-                     log files to be imported.
-   --createmissing   if set, then all testcases without tcid are created
-                     when importing.
-   --updatetestcase  if set, then testcase information on RQM will be updated
-                     bases on robot testfile.
-   --dryrun          if set, then verify all input arguments
-                     (includes RQM authentication) and show what would be done.
+   -h, --help            show this help message and exit
+   -v, --version         Version of the RobotLog2RQM importer.
+   --testsuite TESTSUITE
+                           testsuite ID for this execution. If 'new', then create a new 
+                           testsuite for this execution.
+   --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 
+                         when importing.
+   --updatetestcase      if set, then testcase information on RQM will be updated 
+                         bases on robot testfile.
+   --dryrun              if set, then verify all input arguments 
+                         (includes RQM authentication) and show what would be done.
+   --stream STREAM       project stream. Note, requires Configuration Management (CM) 
+                         to be enabled for the project area.
+   --baseline BASELINE   project baseline. Note, requires Configuration Management (CM), 
+                         or Baselines Only to be enabled for the project area.
 
 
 The below command is simple usage witth all required arguments to import

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

@@ -195,7 +195,12 @@ Constructor of class ``CRQMClient``.
       self.configuration = None
       self.createmissing = None
       self.updatetestcase= None
-      self.testsuite     = None
+      self.testsuite     = {
+         "id": None,
+         "name": None
+      }
+      self.stream        = None
+      self.baseline      = None
 
    def login(self):
       """
@@ -285,7 +290,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):
+              createmissing=False, updatetestcase=False, suite_id=None, 
+              stream=None, baseline=None):
       """
 Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
@@ -340,8 +346,45 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
       try:
          self.createmissing = createmissing
          self.updatetestcase = updatetestcase
-         self.testsuite = suite_id
          self.testplan  = plan_id
+         self.testsuite['id'] = suite_id
+         
+         # Add Configuration-Context header information due to given stream or baseline
+         if stream:
+            res = self.getAllByResource('stream')
+            if res['success']:
+               dStreams = res['data']
+               bFoundStream = False
+               for stream_id, stream_name in dStreams.items():
+                  if stream_name == stream:
+                     self.stream = stream_id
+                     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:
+               raise Exception("Get all streams failed. Reason: %s"%res['message'])
+         elif baseline:
+            res = self.getAllByResource('baseline')
+            if res['success']:
+               dBaselines = res['data']
+               bFoundBaseline = False
+               for baseline_id, baseline_name in dBaselines.items():
+                  if baseline_name == baseline:
+                     self.baseline = baseline_id
+                     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:
+               raise Exception("Get all baselines failed. Reason: %s"%res['message'])
+
          # Verify testplan ID
          res_plan = self.getResourceByID('testplan', plan_id)
          if res_plan.status_code != 200:
@@ -371,8 +414,17 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
                raise Exception("Cannot create configuration '%s': %s"%
                                (config_name, res_conf['message']))
 
+         # Verify testsuite if given
+         if (suite_id != None) and (suite_id != "new"):
+            res_suite = self.getResourceByID('testsuite', suite_id)
+            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
+
          # get all team-areas for testcase template
          self.getAllTeamAreas()
+         
 
       except Exception as error:
          raise Exception('Configure RQMClient failed: %s'%error)
@@ -1323,7 +1375,7 @@ Return testsuite execution record (TSER) template from provided configuration na
       return sTSxml
 
    def createTestsuiteResultTemplate(self, testsuiteID, testsuiteName, TSERID,
-                                     lTCER, lTCResults, startTime='',
+                                     lTCER, lTCResults, resultState, startTime='',
                                      endTime='', duration='', sOwnerID=''):
       """
 Return testsuite execution result template from provided configuration name.
@@ -1395,6 +1447,7 @@ Return testsuite execution result template from provided configuration name.
       sTSResultxml = ''
       sTemplatePath = os.path.join(self.templatesDir, 'testsuitelog.xml')
       oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
+      prefixState  = 'com.ibm.rqm.execution.common.state.'
 
       # prepare required data for template
       resultTittle  = 'Testsuite result: ' + testsuiteName
@@ -1438,6 +1491,11 @@ Return testsuite execution result template from provided configuration name.
       oStarttime.text          = str(startTime).replace(' ', 'T')
       oEndtime.text            = str(endTime).replace(' ', 'T')
       oTotalRunTime.text       = str(duration)
+      # set default RQM state as inconclusive
+      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)
@@ -1459,6 +1517,79 @@ Return testsuite execution result template from provided configuration name.
       sTSResultxml = etree.tostring(oTree)
       return sTSResultxml
 
+   def createTestsuiteTemplate(self, testsuiteName, sDescription='', sOwnerID='', sTStemplate=None):
+      """
+Return testcase template from provided information.
+
+**Arguments:**
+
+*  ``testsuiteName``
+
+   / *Condition*: required / *Type*: str /
+
+   Testsuite name.
+
+*  ``sDescription``
+
+   / *Condition*: optional / *Type*: str / *Default*: '' /
+
+   Testsuite description.
+
+*  ``sOwnerID``
+
+   / *Condition*: optional / *Type*: str / *Default*: '' /
+
+   User ID of testsuite owner.
+
+*  ``sTStemplate``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Existing testsuite template as xml string.
+
+   If not provided, template file under `RQM_templates` is used as default.
+
+**Returns:**
+
+*  ``sTSxml``
+
+   / *Type*: str /
+
+   The xml testsuite template as string.
+      """
+      sTSxml = ''
+      if not sTStemplate:
+         sTemplatePath = os.path.join(self.templatesDir ,'testsuite.xml')
+         oTree         = get_xml_tree(sTemplatePath, bdtd_validation=False)
+      else:
+         oTree = get_xml_tree(BytesIO(sTStemplate.encode()),bdtd_validation=False)
+
+      root = oTree.getroot()
+      nsmap = root.nsmap
+
+      # prepare required data for template
+      testerURL    = self.userURL(self.userID)
+
+      # find nodes to change data
+      oTittle      = oTree.find('ns4:title', nsmap)
+      oDescription = oTree.find('ns4:description', nsmap)
+      oOwner       = oTree.find('ns6:owner', nsmap)
+
+      # change nodes's data
+      oTittle.text       = testsuiteName
+      oDescription.text  = sDescription
+
+      # Incase not specify owner in template or input data, set it as provided user in cli
+      if sOwnerID:
+         oOwner.text = sOwnerID
+         oOwner.attrib['{%s}resource' % nsmap['ns1']] = self.userURL(sOwnerID)
+      elif not oOwner.text:
+         oOwner.text = self.userID
+         oOwner.attrib['{%s}resource' % nsmap['ns1']] = testerURL
+
+      # return xml template as string
+      sTSxml = etree.tostring(oTree)
+      return sTSxml
    #
    #  Methods to create RQM resources
    #
@@ -1827,3 +1958,66 @@ Link list of test cases to provided testsuite ID
       else:
          returnObj['message'] = "No testcase for linking."
       return returnObj
+
+   def addTestsuite2Testplan(self, testplanID, testsuiteID=None):
+      """
+Add testsuite ID to provided testplan ID
+
+**Arguments:**
+
+*  ``testplanID``
+
+   / *Condition*: required / *Type*: str /
+
+   Testplan ID to link given testsuite ID.
+
+*  ``testsuiteID``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Testsuite to be linked with given testplan.
+
+   If not provide, `testsuite['id']` value will be used as id of testsuite.
+
+**Returns:**
+
+*  ``returnObj``
+
+   / *Type*: dict /
+
+   Response dictionary which contains status and error message.
+
+   Example:
+
+   .. code:: python
+
+      {
+         'success' : False,
+         'message': ''
+      }
+
+      """
+      returnObj = {'success' : False, 'message': ''}
+      if testsuiteID == None:
+         testsuiteID = self.testsuite['id']
+      if testsuiteID:
+         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()
+
+         sTestsuiteURL = self.integrationURL('testsuite', testsuiteID)
+         oTS = etree.Element('{http://jazz.net/xmlns/alm/qm/v0.1/}testsuite', nsmap=root.nsmap)
+         oTS.set('href', sTestsuiteURL)
+         root.append(oTS)
+
+         # Update test plan data with linked testsuite and PUT to RQM
+         resUpdateTestplan = self.updateResourceByID('testplan', testplanID, etree.tostring(oTree))
+         if resUpdateTestplan.status_code == 200:
+            returnObj['success'] = True
+         else:
+            returnObj['message'] = str(resUpdateTestplan.reason)
+      else:
+         returnObj['message'] = "No testsuite for adding."
+      return returnObj

robotframework-robotlog2rqm-1.4.0/RobotLog2RQM/RQM_templates/testsuite.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ns2:testsuite xmlns:ns2="http://jazz.net/xmlns/alm/qm/v0.1/" 
+	xmlns:ns1="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
+	xmlns:ns3="http://schema.ibm.com/vega/2008/" 
+	xmlns:ns4="http://purl.org/dc/elements/1.1/" 
+	xmlns:ns5="http://jazz.net/xmlns/prod/jazz/process/0.6/" 
+	xmlns:ns6="http://jazz.net/xmlns/alm/v0.1/" 
+	xmlns:ns7="http://purl.org/dc/terms/" 
+	xmlns:ns8="http://jazz.net/xmlns/alm/qm/v0.1/testscript/v0.1/" 
+	xmlns:ns9="http://jazz.net/xmlns/alm/qm/v0.1/executionworkitem/v0.1" 
+	xmlns:ns10="http://open-services.net/ns/core#" 
+	xmlns:ns11="http://open-services.net/ns/qm#" 
+	xmlns:ns12="http://jazz.net/xmlns/prod/jazz/rqm/process/1.0/" 
+	xmlns:ns13="http://www.w3.org/2002/07/owl#" 
+	xmlns:ns14="http://jazz.net/xmlns/alm/qm/qmadapter/v0.1" 
+	xmlns:ns15="http://jazz.net/xmlns/alm/qm/qmadapter/task/v0.1" 
+	xmlns:ns16="http://jazz.net/xmlns/alm/qm/v0.1/executionresult/v0.1" 
+	xmlns:ns17="http://jazz.net/xmlns/alm/qm/v0.1/catalog/v0.1" 
+	xmlns:ns18="http://jazz.net/xmlns/alm/qm/v0.1/tsl/v0.1/" 
+	xmlns:ns20="http://jazz.net/xmlns/alm/qm/styleinfo/v0.1/" 
+	xmlns:ns21="http://www.w3.org/1999/XSL/Transform">
+	<ns4:title></ns4:title>
+	<ns4:description></ns4:description>
+	<ns4:creator></ns4:creator>
+	<ns6:owner></ns6:owner>
+   <ns2:testplan href=""/>
+</ns2:testsuite>

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

@@ -41,7 +41,8 @@ from RobotLog2RQM.version import VERSION, VERSION_DATE
 DRESULT_MAPPING = {
    "PASS":  "Passed",
    "FAIL":  "Failed",
-   "UNKNOWN": "Inconclusive"
+   "UNKNOWN": "Inconclusive",
+   "SKIP": "Blocked"
 }
 
 DEFAULT_METADATA = {
@@ -157,7 +158,7 @@ Write log message to console/file output.
       return
 
    @classmethod
-   def log_warning(cls, msg):
+   def log_warning(cls, msg, indent=0):
       """
 Write warning message to console/file output.
 
@@ -169,14 +170,20 @@ Write warning message to console/file output.
 
    Warning message which is written to output.
 
+*  ``indent``
+
+   / *Condition*: optional / *Type*: int / *Default*: 0 /
+
+   Offset indent.
+
 **Returns:**
 
 (*no returns*)
       """
-      cls.log(cls.prefix_warn+str(msg), cls.color_warn)
+      cls.log(cls.prefix_warn+str(msg), cls.color_warn, indent)
 
    @classmethod
-   def log_error(cls, msg, fatal_error=False):
+   def log_error(cls, msg, fatal_error=False, indent=0):
       """
 Write error message to console/file output.
 
@@ -192,6 +199,12 @@ Write error message to console/file output.
 
    If set, tool will terminate after logging error message.
 
+*  ``indent``
+
+   / *Condition*: optional / *Type*: int / *Default*: 0 /
+
+   Offset indent.
+
 **Returns:**
 
 (*no returns*)
@@ -200,7 +213,7 @@ Write error message to console/file output.
       if fatal_error:
          prefix = cls.prefix_fatalerror
 
-      cls.log(prefix+str(msg), cls.color_error)
+      cls.log(prefix+str(msg), cls.color_error, indent)
       if fatal_error:
          cls.log(f"{sys.argv[0]} has been stopped!", cls.color_error)
          exit(1)
@@ -280,9 +293,12 @@ Avalable arguments in command line:
    - `user` : user for RQM login.
    - `password` : user password for RQM login.
    - `testplan` : RQM testplan ID.
+   - `--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.
    - `--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.
 
 **Arguments:**
 
@@ -311,6 +327,8 @@ 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, 
+                          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.')
    cmdParser.add_argument('--createmissing', action="store_true",
@@ -319,6 +337,10 @@ Avalable arguments in command line:
                           help='if set, then testcase information on RQM will be updated bases on robot testfile.')
    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,
+                          help='project stream. Note, requires Configuration Management (CM) to be enabled for the project area.')
+   cmdParser.add_argument('--baseline', type=str,
+                          help='project baseline. Note, requires Configuration Management (CM), or Baselines Only to be enabled for the project area.')
 
    return cmdParser.parse_args()
 
@@ -394,7 +416,7 @@ Extract metadata from suite result bases on DEFAULT_METADATA.
 
    return dMetadata
 
-def process_suite(RQMClient, suite):
+def process_suite(RQMClient, suite, log_indent=0):
    """
 Process robot suite for importing to RQM.
 
@@ -412,15 +434,21 @@ Process robot suite for importing to RQM.
 
    Robot suite object.
 
+*  ``log_indent``
+
+   / *Condition*: optional / *Type*: int / *Default*: 0 /
+
+   Indent for logging message.
+
 **Returns:**
 
 (*no returns*)
    """
    if len(list(suite.suites)) > 0:
       for subsuite in suite.suites:
-         process_suite(RQMClient, subsuite)
+         process_suite(RQMClient, subsuite, log_indent=log_indent+2)
    else:
-      Logger.log(f"Process suite: {suite.name}")
+      Logger.log(f"Process suite: {suite.name}", indent=log_indent)
 
       # update missing metadata from parent suite
       if suite.parent and suite.parent.metadata:
@@ -430,9 +458,9 @@ Process robot suite for importing to RQM.
 
       if len(list(suite.tests)) > 0:
          for test in suite.tests:
-            process_test(RQMClient, test)
+            process_test(RQMClient, test, log_indent=log_indent+2)
 
-def process_test(RQMClient, test):
+def process_test(RQMClient, test, log_indent=0):
    """
 Process robot test for importing to RQM.
 
@@ -450,11 +478,17 @@ Process robot test for importing to RQM.
 
    Robot test object.
 
+*  ``log_indent``
+
+   / *Condition*: optional / *Type*: int / *Default*: 0 /
+
+   Indent for logging message.
+
 **Returns:**
 
 (*no returns*)
    """
-   Logger.log(f"Process test: {test.name}")
+   Logger.log(f"Process test: {test.name}", indent=log_indent)
 
    # Avoid create resources with dryrun
    if Logger.dryrun:
@@ -484,7 +518,7 @@ Process robot test for importing to RQM.
    try:
       _tc_result = DRESULT_MAPPING[test.status]
    except Exception:
-      Logger.log_error(f"Invalid Robotframework result state '{test.status}' of test '{_tc_name}'.")
+      Logger.log_error(f"Invalid Robotframework result state '{test.status}' of test '{_tc_name}'.", indent=log_indent)
       return
    _tc_message = test.message
    _tc_start_time = convert_to_datetime(test.starttime)
@@ -508,19 +542,19 @@ Process robot test for importing to RQM.
          res = RQMClient.createResource('testcase', oTCTemplate)
          if res['success']:
             _tc_id = res['id']
-            Logger.log(f"Create testcase '{_tc_name}' with ID '{_tc_id}' successfully!")
+            Logger.log(f"Create testcase '{_tc_name}' with ID '{_tc_id}' successfully!", indent=log_indent)
             RQMClient.dMappingTCID[_tc_id] = _tc_name
          else:
-            Logger.log_error(f"Create testcase '{_tc_name}' failed. Reason: {res['message']}")
+            Logger.log_error(f"Create testcase '{_tc_name}' failed. Reason: {res['message']}", indent=log_indent)
             return
       else:
-         Logger.log_error(f"There is no 'tcid' information for importing test '{_tc_name}'.")
+         Logger.log_error(f"There is no 'tcid' information for importing test '{_tc_name}'.", indent=log_indent)
          return
    else:
       # If more than 1 tcid are defined in [Tags], the first one is used.
       if len(lTCIDTags) > 1:
          _tc_id = lTCIDTags[0]
-         Logger.log_warning(f"More than 1 'tcid-' tags in test '{_tc_name}', '{_tc_id}' is used.")
+         Logger.log_warning(f"More than 1 'tcid-' tags in test '{_tc_name}', '{_tc_id}' is used.", indent=log_indent)
 
       # If --updatetestcase is set. Test case with provided tcid will be updated on RQM:
       # Get existing resource of testcase from RQM.
@@ -537,9 +571,9 @@ Process robot test for importing to RQM.
                                                             _tc_link,
                                                             sTCtemplate=str(resTC.text))
             RQMClient.updateResourceByID('testcase', _tc_id, oTCTemplate)
-            Logger.log(f"Update testcase '{_tc_name}' with ID '{_tc_id}' successfully!")
+            Logger.log(f"Update testcase '{_tc_name}' with ID '{_tc_id}' successfully!", indent=log_indent)
          else:
-            Logger.log_error(f"Update testcase with ID '{_tc_id}' failed. Please check whether it is existing on RQM.")
+            Logger.log_error(f"Update testcase with ID '{_tc_id}' failed. Please check whether it is existing on RQM.", indent=log_indent)
             return
 
    # Create TCER:
@@ -554,11 +588,11 @@ Process robot test for importing to RQM.
    res = RQMClient.createResource('executionworkitem', oTCERTemplate)
    _tc_tcer_id = res['id']
    if res['success']:
-      Logger.log(f"Created TCER with ID '{_tc_tcer_id}' successfully.")
+      Logger.log(f"Created TCER with ID '{_tc_tcer_id}' successfully.", indent=log_indent+2)
    elif (res['status_code'] == 303 or res['status_code'] == 200) and res['id'] != '':
-      Logger.log_warning(f"TCER for testcase '{_tc_id}' and testplan '{_tc_testplan_id}' is existing with ID: '{_tc_tcer_id}'")
+      Logger.log_warning(f"TCER for testcase '{_tc_id}' and testplan '{_tc_testplan_id}' is existing with ID: '{_tc_tcer_id}'", indent=log_indent+2)
    else:
-      Logger.log_error(f"Create TCER failed. Please check whether test case with ID '{_tc_id}' is existing on RQM or not. Reason: {res['message']}.")
+      Logger.log_error(f"Create TCER failed. Please check whether test case with ID '{_tc_id}' is existing on RQM or not. Reason: {res['message']}.", indent=log_indent+2)
       return
 
    if _tc_tcer_id not in RQMClient.lTCERIDs:
@@ -583,10 +617,10 @@ Process robot test for importing to RQM.
                                                                 _tc_team)
    res = RQMClient.createResource('executionresult', oTCResultTemplate)
    if res['success']:
-      Logger.log(f"Create result for test '{_tc_name}' successfully!")
+      Logger.log(f"Create result for test '{_tc_name}' successfully!", indent=log_indent+4)
       _tc_result_id = res['id']
    else:
-      Logger.log_error(f"Create result for test '{_tc_name}' failed. Reason: {res['message']}.")
+      Logger.log_error(f"Create result for test '{_tc_name}' failed. Reason: {res['message']}.", indent=log_indent+4)
       return
    if _tc_result_id not in RQMClient.lTCResultIDs:
       RQMClient.lTCResultIDs.append(_tc_result_id)
@@ -594,6 +628,10 @@ 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)
 
 def RobotLog2RQM(args=None):
    """
@@ -621,11 +659,13 @@ Flow to import Robot results to RQM:
    * `user` : user for RQM login.
    * `password` : user password for RQM login.
    * `testplan` : RQM testplan ID.
+   * `testsuite` : testsuite ID for this execution. If '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 True, then testcases information on RQM will be updated bases on robot testfile.
    * `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.
 **Returns:**
 
 (*no returns*)
@@ -675,6 +715,7 @@ Flow to import Robot results to RQM:
    try:
       bSuccess = RQMClient.login()
       if bSuccess:
+         Logger.log()
          Logger.log(f"Login RQM as user '{args.user}' successfully!")
       else:
          Logger.log_error("Could not login to RQM: 'Unkown reason'.")
@@ -693,14 +734,85 @@ 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)
+                    metadata_info['project'], args.createmissing, args.updatetestcase, 
+                    args.testsuite, stream=args.stream, baseline=args.baseline)
+
+      if args.testsuite == "new":
+         # Create new testsuite
+         if not args.dryrun:
+            testsuite_data = RQMClient.createTestsuiteTemplate(result.suite.name, result.suite.doc)
+            res_testsuite = RQMClient.createResource('testsuite', testsuite_data)
+         else:
+            # for dryrun
+            res_testsuite = {'success': True, 'id': 1111}
+
+         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
+         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)
 
-      # Link all imported testcase ID(s) with testplan
-      Logger.log("Linking all imported testcase ID(s) with testplan ...")
-      RQMClient.linkListTestcase2Testplan(args.testplan)
+      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)
+            res_TSER = RQMClient.createResource('suiteexecutionrecord', testsuite_record_data)
+            sTSERID = res_TSER['id']
+            Logger.log()
+            if res_TSER['success']:
+               Logger.log(f"Create TSER with id {sTSERID} successfully!")
+            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}")
+            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'],
+                                                                           sTSERID,
+                                                                           RQMClient.lTCERIDs,
+                                                                           RQMClient.lTCResultIDs,
+                                                                           DRESULT_MAPPING[result.suite.status]
+                                                                           )
+            res_TSLog = RQMClient.createResource('testsuitelog', testsuite_result_data)
+            sSuiteResultID = res_TSLog['id'] 
+            if res_TSLog['success']:
+               Logger.log(f"Created testsuite result with id {sSuiteResultID} successfully.", indent=2)
+            else:
+               Logger.log_error(f"Create testsuite result failed, {res_TSLog['message']}", indent=2)
+         else:
+            Logger.log(f"Create TSER")
+            Logger.log(f"Created testsuite result")
+
+         # 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.")
+         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.")
+         except Exception as reason:
+            Logger.log_error(f"Add testsuite to testplan failed.\nReason: {reason}", fatal_error=True)
 
+      else:
+         # Link all imported testcase ID(s) with testplan
+         try:
+            RQMClient.linkListTestcase2Testplan(args.testplan)
+            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
 
@@ -709,7 +821,15 @@ Flow to import Robot results to RQM:
 
    # 5. Disconnect from RQM
    RQMClient.disconnect()
-   Logger.log("All test results have been imported to RQM successfully.!")
+
+   testcnt_msg = f"All {len(RQMClient.lTestcaseIDs)}"
+   extended_msg = ""
+   if (len(RQMClient.lTestcaseIDs) > len(RQMClient.lTCResultIDs)):
+      testcnt_msg  = f"{len(RQMClient.lTCResultIDs)} of {len(RQMClient.lTestcaseIDs)}"
+      extended_msg = f" {len(RQMClient.lTestcaseIDs)-len(RQMClient.lTCResultIDs)} test results are skipped because of errors."
+
+   Logger.log()
+   Logger.log(f"{testcnt_msg} test results are imported to RQM successfully.{extended_msg}")
 
 if __name__=="__main__":
    RobotLog2RQM()

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

@@ -18,6 +18,6 @@
 #
 # Version and date of RobotLog2RQM
 #
-VERSION      = "1.2.3"
-VERSION_DATE = "14.03.2024"
+VERSION      = "1.4.0"
+VERSION_DATE = "24.07.2024"
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-robotlog2rqm
-Version: 1.2.3
+Version: 1.4.0
 Summary: Imports robot result(s) to IBM Rational Quality Manager (RQM)
 Home-page: https://github.com/test-fullautomation/robotframework-robotlog2rqm
 Author: Tran Duy Ngoan
@@ -128,33 +128,40 @@ 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]
-                        resultxmlfile host project user password testplan
+    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--testsuite TESTSUITE] [--recursive] 
+                [--createmissing] [--updatetestcase] [--dryrun] [--stream STREAM] [--baseline BASELINE] 
+                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
-                      or directory of result files to be imported.
-    host              RQM host url.
-    project           project on RQM.
-    user              user for RQM login.
-    password          password for RQM login.
-    testplan          testplan ID for this execution.
+    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.
+    user                  user for RQM login.
+    password              password for RQM login.
+    testplan              testplan ID for this execution.
 
     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
-                      log files to be imported.
-    --createmissing   if set, then all testcases without tcid are created
-                      when importing.
-    --updatetestcase  if set, then testcase information on RQM will be updated
-                      bases on robot testfile.
-    --dryrun          if set, then verify all input arguments
-                      (includes RQM authentication) and show what would be done.
+    -h, --help            show this help message and exit
+    -v, --version         Version of the RobotLog2RQM importer.
+    --testsuite TESTSUITE
+                            testsuite ID for this execution. If 'new', then create a new 
+                            testsuite for this execution.
+    --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 
+                          when importing.
+    --updatetestcase      if set, then testcase information on RQM will be updated 
+                          bases on robot testfile.
+    --dryrun              if set, then verify all input arguments 
+                          (includes RQM authentication) and show what would be done.
+    --stream STREAM       project stream. Note, requires Configuration Management (CM) 
+                          to be enabled for the project area.
+    --baseline BASELINE   project baseline. Note, requires Configuration Management (CM), 
+                          or Baselines Only to be enabled for the project area.
 
 The below command is simple usage witth all required arguments to import
 Robot Framework results into RQM:

{robotframework-robotlog2rqm-1.2.3 → robotframework-robotlog2rqm-1.4.0}/robotframework_robotlog2rqm.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ RobotLog2RQM/RQM_templates/executionresult.xml
 RobotLog2RQM/RQM_templates/executionworkitem.xml
 RobotLog2RQM/RQM_templates/suiteexecutionrecord.xml
 RobotLog2RQM/RQM_templates/testcase.xml
+RobotLog2RQM/RQM_templates/testsuite.xml
 RobotLog2RQM/RQM_templates/testsuitelog.xml
 robotframework_robotlog2rqm.egg-info/PKG-INFO
 robotframework_robotlog2rqm.egg-info/SOURCES.txt